Add syslog websocket ios re (#777)

* add syslog broadcast for ios

* make websocker wrapper common commands

* update changelog

Author: KazuCocoa

CHANGELOG.md

@@ -5,6 +5,7 @@ Release tags are https://github.com/appium/ruby_lib/releases .
 
 ## Unreleased
 ### 1. Enhancements
+- Support `start_logs_broadcast` and `stop_logs_broadcast` for iOS
 
 ### 2. Bug fixes
 

ios_tests/lib/ios/specs/common/command/command.rb

@@ -0,0 +1,15 @@
+# rake ios[common/command/command]
+describe 'common/command/command' do
+  t 'command' do
+    File.delete 'syslog.log' if File.exist? 'syslog.log'
+
+    # A number of systemlog is quite small than Android.
+    # It only checks the commands works fine.
+    start_logs_broadcast
+    sleep 5
+    assert stop_logs_broadcast.nil?
+
+    assert File.exist?('syslog.log') if File.exist? 'syslog.log'
+    assert File.size?('syslog.log') if File.exist? 'syslog.log'
+  end
+end

lib/appium_lib/android/common/command/command.rb

@@ -1,5 +1,3 @@
-require_relative 'ws_logcat'
-
 module Appium
   module Android
     module Command
@@ -31,7 +29,7 @@ def start_logs_broadcast(logcat_file = 'logcat.log')
         @driver.execute_script 'mobile: startLogsBroadcast'
 
         socket_url = "ws://#{URI.parse(server_url).host}:#{@core.port}/ws/session/#{@driver.session_id}/appium/device/logcat"
-        @logcat_client = Command::WsLogcat.new(url: socket_url, output_file: logcat_file)
+        @logcat_client = ::Appium::Common::Command::WsLogcat.new(url: socket_url, output_file: logcat_file)
       end
 
       # Stop Android logcat broadcast websocket

lib/appium_lib/appium.rb

@@ -16,6 +16,7 @@
 require_relative 'common/touch_actions'
 require_relative 'common/http_client'
 require_relative 'common/device'
+require_relative 'common/command'
 
 # ios
 require_relative 'ios/ios'

lib/appium_lib/common/command.rb

@@ -0,0 +1,9 @@
+require_relative 'command/ws_logcat'
+
+module Appium
+  module Common
+    module Command
+      # parent
+    end
+  end
+end

lib/appium_lib/android/common/command/ws_logcat.rb lib/appium_lib/common/command/ws_logcat.rb

@@ -1,5 +1,5 @@
 module Appium
-  module Android
+  module Common
     module Command
       class WsLogcat < ::Appium::Core::WebSocket
         def initialize(url:, output_file: 'logcat.log')

lib/appium_lib/ios/xcuitest/bridge.rb

@@ -14,6 +14,7 @@ def self.for(target)
           target.extend Appium::Ios::Xcuitest::Gesture
           target.extend Appium::Ios::Xcuitest::MultiAppHandler
           target.extend Appium::Ios::Xcuitest::Element
+          target.extend Appium::Ios::Xcuitest::Command
         end
       end
     end

lib/appium_lib/ios/xcuitest/command.rb

@@ -7,6 +7,32 @@ module Appium
   module Ios
     module Xcuitest
       module Command
+        # Starts iOS syslog broadcast websocket
+        #
+        # @param [String] syslog_file A file path to write messages from a syslog WebSocket client
+        #
+        # @example
+        #
+        #   start_logs_broadcast 'outputfile.log' #=> #<Appium::Android::Command::WsLogcat:...>
+        #
+        def start_logs_broadcast(syslog_file = 'syslog.log')
+          @driver.execute_script 'mobile: startLogsBroadcast'
+
+          socket_url = "ws://#{URI.parse(server_url).host}:#{@core.port}/ws/session/#{@driver.session_id}/appium/device/syslog"
+          @logcat_client = ::Appium::Common::Command::WsLogcat.new(url: socket_url, output_file: syslog_file)
+        end
+
+        # Stop iOS syslog broadcast websocket
+        #
+        # @example
+        #
+        #   stop_logs_broadcast #=> nil
+        #
+        def stop_logs_broadcast
+          @logcat_client.close
+
+          @driver.execute_script 'mobile: stopLogsBroadcast'
+        end
       end
     end
   end