# 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.
require_relative 'device/performance'
require_relative 'device/screen'
require_relative 'device/battery'
module Appium
module Core
module Ios
module Xcuitest
module Device
extend Forwardable
# rubocop:disable Layout/LineLength
# @!method hide_keyboard(close_key = nil, strategy = nil)
# Hide the onscreen keyboard
# @param [String] close_key The name of the key which closes the keyboard.
# @param [Symbol] strategy The symbol of the strategy which closes the keyboard.
# XCUITest ignore this argument.
# Default for iOS is +:pressKey+. Default for Android is +:tapOutside+.
#
# @example
#
# @driver.hide_keyboard # Close a keyboard with the 'Done' button
# @driver.hide_keyboard('Finished') # Close a keyboard with the 'Finished' button
#
# @!method background_app(duration = 0)
# Backgrounds the app for a set number of seconds.
# This is a blocking application.
# @param [Integer] duration How many seconds to background the app for.
#
# @example
#
# @driver.background_app
# @driver.background_app(5)
# @driver.background_app(-1) #=> the app never come back. https://github.com/appium/appium/issues/7741
#
# @since Appium 1.9.1
# @!method start_recording_screen(remote_path: nil, user: nil, pass: nil, method: 'PUT', file_field_name: nil, form_fields: nil, headers: nil, force_restart: nil, video_type: 'mjpeg', video_fps: nil, time_limit: '180', video_quality: nil, video_scale: nil, video_filters: nil, pixel_format: nil)
#
# Record the display of devices running iOS Simulator since Xcode 9 or real devices since iOS 11
# (ffmpeg utility is required: 'brew install ffmpeg').
# We would recommend to play the video by VLC or Mplayer if you can not play the video with other video players.
#
# @param [String] remote_path The path to the remote location, where the resulting video should be uploaded.
# The following protocols are supported: http/https, ftp.
# Null or empty string value (the default setting) means the content of resulting
# file should be encoded as Base64 and passed as the endpount response value.
# An exception will be thrown if the generated media file is too big to
# fit into the available process memory.
# This option only has an effect if there is screen recording process in progreess
# and +forceRestart+ parameter is not set to +true+.
# @param [String] user The name of the user for the remote authentication.
# @param [String] pass The password for the remote authentication.
# @param [String] method The http multipart upload method name. The 'PUT' one is used by default.
# @param [String] file_field_name The name of the form field containing the binary payload in multipart/form-data
# requests since Appium 1.18.0. Defaults to 'file'.
# @param [Array<Hash, Array<String>>] form_fields The form fields mapping in multipart/form-data requests since Appium 1.18.0.
# If any entry has the same key in this mapping, then it is going to be ignored.
# @param [Hash] headers The additional headers in multipart/form-data requests since Appium 1.18.0.
# @param [Boolean] force_restart Whether to try to catch and upload/return the currently running screen recording
# (+false+, the default setting on server) or ignore the result of it
# and start a new recording immediately (+true+).
# @param [String] video_type The video codec type used for encoding of the be recorded screen capture.
# Execute +ffmpeg -codecs+ in the terminal to see the list of supported video codecs.
# 'mjpeg' by default.
# @param [String] time_limit Recording time. 180 seconds is by default.
# @param [String] video_quality The video encoding quality (low, medium, high, photo - defaults to medium).
# @param [String] video_fps The Frames Per Second rate of the recorded video. Change this value if the resulting video
# is too slow or too fast. Defaults to 10. This can decrease the resulting file size.
# @param [String] video_filters - @since Appium 1.15.0
# The ffmpeg video filters to apply. These filters allow to scale, flip, rotate and do many
# other useful transformations on the source video stream. The format of the property
# must comply with https://ffmpeg.org/ffmpeg-filters.html
# e.g.: "rotate=90"
# @param [String] video_scale The scaling value to apply. Read https://trac.ffmpeg.org/wiki/Scaling for possible values.
# No scale is applied by default.
# tips: ffmpeg cannot capture video as +libx264+ if the video dimensions is not divisible by 2.
# Then, you can set this scale as +scale=trunc(iw/2)*2:trunc(ih/2)*2+
# - https://github.com/appium/appium/issues/12856
# - https://www.reddit.com/r/linux4noobs/comments/671z6b/width_not_divisible_by_2_error_when_using_ffmpeg/
# @param [String] pixel_format Output pixel format. Run +ffmpeg -pix_fmts+ to list possible values.
# For Quicktime compatibility, set to "yuv420p" along with videoType: "libx264".
# @return [String] Base64 encoded content of the recorded media file or an empty string
# if the file has been successfully uploaded to a remote location (depends on the actual options)
#
# @example
#
# @driver.start_recording_screen
# @driver.start_recording_screen video_type: 'mjpeg', time_limit: '260'
# @driver.start_recording_screen video_type: 'libx264', time_limit: '260' # Can get '.mp4' video
#
# @since Appium 1.3.4
# @!method start_performance_record(timeout: 300000, profile_name: 'Activity Monitor', pid: nil)
#
# This is a blocking application. Read https://help.apple.com/instruments/mac/current/ to understand the profiler.
#
# @param [Integer|String] timeout The maximum count of milliseconds to record the profiling information.
# @param [String] profile_name The name of existing performance profile to apply.
# Execute +instruments -s+ to show the list of available profiles.
# Note, that not all profiles are supported on mobile devices.
# @param [Integer|String] pid The ID of the process to measure the performance for.
# Set it to +current+ in order to measure the performance of
# the process, which belongs to the currently active application.
# All processes running on the device are measured if
# pid is unset (the default setting). Setting process ID while
# device under test is Simulator might require +instruments+ to be launched
# with sudo privileges, which is not supported and will throw a timeout exception.
# @return nil
#
# @example
#
# @driver.start_performance_record # default: (timeout: 300000, profile_name: 'Activity Monitor')
# @driver.start_performance_record(timeout: 300000, profile_name: 'Activity Monitor')
#
# @since Appium 1.3.4
# @!method get_performance_record(save_file_path: './performance', profile_name: 'Activity Monitor', remote_path: nil, user: nil, pass: nil, method: 'PUT')
#
# This is a blocking application.
#
# @param [String] save_file_path A path to save data as zipped .trace file
# @param [String] profile_name The name of existing performance profile to apply.
# Execute +instruments -s+ to show the list of available profiles.
# Note, that not all profiles are supported on mobile devices.
# @param [String] remote_path The path to the remote location, where the resulting zipped .trace file should be uploaded.
# The following protocols are supported: http/https, ftp.
# Null or empty string value (the default setting) means the content of resulting
# file should be zipped, encoded as Base64 and passed as the endpount response value.
# An exception will be thrown if the generated file is too big to
# fit into the available process memory.
# @param [String] user The name of the user for the remote authentication. Only works if +remotePath+ is provided.
# @param [String] pass The password for the remote authentication. Only works if +remotePath+ is provided.
# @param [String] method The http multipart upload method name. Only works if +remotePath+ is provided.
#
# @example
#
# @driver.get_performance_record
# @driver.get_performance_record(save_file_path: './performance', profile_name: 'Activity Monitor')
# @since Appium 1.6.0
# @!method battery_info
#
# Get battery information.
#
# @return [Hash] Return battery level and battery state from the target real device. (Simulator has no battery.)
# https://developer.apple.com/documentation/uikit/uidevice/ 's +batteryLevel+ and +batteryState+.
# Battery level in range [0.0, 1.0], where 1.0 means 100% charge. -1 is returned
# if the actual value cannot be retrieved from the system.
# Battery state. The following symbols are possible
# +:unplugged, :charging, :full+
#
# @example
#
# @driver.battery_info #=> { state: :full, level: 0.7 }
#
# rubocop:enable Layout/LineLength
####
## class << self
####
class << self
def extended(_mod)
# Xcuitest, Override included method in bridge
::Appium::Core::Device.add_endpoint_method(:hide_keyboard) do
def hide_keyboard(close_key = nil, strategy = nil)
option = {}
option[:key] = close_key if close_key
option[:strategy] = strategy if strategy
execute :hide_keyboard, {}, option
end
end
# Xcuitest, Override included method in bridge
::Appium::Core::Device.add_endpoint_method(:background_app) do
def background_app(duration = 0)
# https://github.com/appium/ruby_lib/issues/500, https://github.com/appium/appium/issues/7741
# 'execute :background_app, {}, seconds: { timeout: duration_milli_sec }' works over Appium 1.6.4
duration_milli_sec = duration.nil? ? nil : duration * 1000
execute :background_app, {}, seconds: { timeout: duration_milli_sec }
end
end
Performance.add_methods
Screen.add_methods
Battery.add_methods
end
end # class << self
end # module Device
end # module Xcuitest
end # module Ios
end # module Core
end # module Appium