run.rb

# 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 'rubygems'
require 'minitest/autorun'
require 'minitest/reporters'
require 'minitest'
require 'hashdiff'
require_relative '../../lib/appium_lib'

Appium::Logger.level = ::Logger::ERROR # Show Logger logs only they are error

Minitest::Test.i_suck_and_my_tests_are_order_dependent!

begin
  Minitest::Reporters.use! [Minitest::Reporters::ProgressReporter.new]
rescue Errno::ENOENT
  # Ignore since Minitest::Reporters::JUnitReporter.new fails in deleting files, sometimes
end

# Run all Android tests:
#   ruby run.rb android

# Run only the view album test:
#   ruby run.rb ios view_album

def start_driver(caps)
  driver = Appium::Driver.new(caps, true)
  # Tests expect methods defined on the minispec object
  Appium.promote_appium_methods Minitest::Test, driver

  # Use bounded HTTP timeouts in tests to avoid CI hangs on stuck requests.
  open_timeout = Integer(ENV.fetch('APPIUM_TEST_OPEN_TIMEOUT', '120'))
  read_timeout = Integer(ENV.fetch('APPIUM_TEST_READ_TIMEOUT', '300'))

  driver.start_driver(open_timeout: open_timeout, read_timeout: read_timeout)
end

dir = File.expand_path(File.join(Dir.pwd, 'lib'))
appium_txt = File.join(Dir.pwd, 'appium.txt')
device = ARGV[0].downcase.strip
devices = %w(android ios)
raise 'Expected android or ios as first argument' unless devices.include? device

one_test = ARGV[1]
test_dir = "/#{device}/"

caps = Appium.load_settings file: appium_txt, verbose: true
caps = if caps[:appium_lib]
         appium_lib = caps[:appium_lib]
         appium_lib = appium_lib.merge(debug: true) unless appium_lib[:debug]
         appium_lib = appium_lib.merge(wait: 1) unless appium_lib[:wait]
         caps.merge(appium_lib: appium_lib)
       else
         caps.merge(appium_lib: { debug: true, wait: 1 })
       end
caps[:app] = ENV.fetch('SAUCE_PATH', nil) if ENV.fetch('SAUCE_USERNAME', nil) && ENV.fetch('SAUCE_ACCESS_KEY', nil)

trace_files = []

if one_test
  if File.exist? one_test
    one_test = File.expand_path one_test
  else
    # ensure ext is .rb
    one_test = File.join(File.dirname(one_test),
                         "#{File.basename(one_test, '.*')}.rb")
    one_test = File.join(dir, "#{test_dir}specs/#{one_test}")
  end

  raise "\nTest #{one_test} does not exist.\n" unless File.exist?(one_test)

  start_driver(caps)

  # Ruby 3.0 sorts the Dir.glob order
  # require support (common.rb)
  file_name = File.join dir, "#{test_dir}/*.rb"
  Dir.glob(file_name) do |test|
    require test
    trace_files << test
  end
  puts "Loading one test: #{one_test}"
  require one_test
  trace_files << one_test
else
  # require all
  file_names = File.join(dir, "#{test_dir}**/*.rb")
  Dir.glob(file_names) do |test|
    # load all tests
    trace_files << test
    puts "  #{File.basename(test, '.*')}"
    require test
  end

  start_driver(caps)
end

trace_files.map! do |f|
  f = File.expand_path f
  # ensure all traced files end in .rb
  f = File.join(File.dirname(f), "#{File.basename(f, '.*')}.rb")
  f
end

# Exit after tests.
Minitest.after_run { $driver&.x }