# frozen_string_literal: true # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. module Appium module Core class Logs def initialize(bridge) @bridge = bridge end # @param [String|Hash] type You can get particular type's logs. # @return [[Selenium::WebDriver::LogEntry]] A list of logs data. # # @example # # @driver.logs.get 'syslog' # [] # @driver.logs.get :syslog # [] # def get(type) @bridge.log type end # Get a list of available log types # # @return [[Hash]] A list of available log types. # @example # # @driver.logs.available_types # [:syslog, :crashlog, :performance] # def available_types @bridge.available_log_types end # @since Appium 1.16.0 # # Logs a custom event. The event is available via {::Appium::Core::Events#get} or # @driver.session_capabilities['events'] with eventTimings capabilities. # # @param [String] vendor The vendor prefix for the event # @param [String] event The name of event # @return [nil] # # @example # # @driver.logs.event vendor: 'appium', event: 'funEvent' # @driver.session_capabilities['events'] #=> {...., 'appium:funEvent' => 1572957315} # # @driver.logs.event = { vendor: 'appium', event: 'anotherEvent' } # @driver.logs.events #=> {...., 'appium:funEvent' => [1572957315, 1572960305], # # 'appium:anotherEvent' => 1572959315} # def event(vendor:, event:) @bridge.log_event vendor, event end def event=(log_event) raise ArgumentError('log_event should be Hash like { vendor: "appium", event: "funEvent"}') unless log_event.is_a?(Hash) event vendor: log_event[:vendor], event: log_event[:event] end # @since Appium 1.16.0 # Returns events with filtering with 'type'. Defaults to all available events. # # @param [String] type The type of events to get # @return [Hash] # # @example # # @driver.logs.events #=> {} # @driver.logs.events #=> {'commands' => [{'cmd' => 123455, ....}], 'startTime' => 1572954894127, } # def events(type = nil) @bridge.log_events(type) end end end # module Core end # module Appium