Class: Maze::Client::Appium::BaseClient

Inherits:
Object
  • Object
show all
Defined in:
lib/maze/client/appium/base_client.rb

Direct Known Subclasses

BitBarClient, BrowserStackClient, LocalClient

Constant Summary collapse

FIXTURE_CONFIG = 
'fixture_config.json'

Instance Method Summary collapse

Constructor Details

#initialize ⇒ BaseClient

Returns a new instance of BaseClient.



10
11
12
 
# File 'lib/maze/client/appium/base_client.rb', line 10

def initialize
  @start_attempts = 0
end

Instance Method Details

#attempt_start_driver(config) ⇒ Object 



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/maze/client/appium/base_client.rb', line 71

def attempt_start_driver(config)
  config.capabilities = device_capabilities
  driver = Maze::Driver::Appium.new config.appium_server_url,
                                    config.capabilities,
                                    config.locator

  result = driver.start_driver
  if result
    # Log details of this session
    $logger.info "Created Appium session: #{driver.session_id}"
    @session_metadata = Maze::Client::Appium::SessionMetadata.new
    @session_metadata.id = driver.session_id
    @session_metadata.farm = Maze.config.farm.to_s
  end
  driver
end

#device_capabilities ⇒ Object 



136
137
138
 
# File 'lib/maze/client/appium/base_client.rb', line 136

def device_capabilities
  raise 'Method not implemented by this class'
end

#handle_error(error) ⇒ Object 



127
128
129
 
# File 'lib/maze/client/appium/base_client.rb', line 127

def handle_error(error)
  raise 'Method not implemented by this class'
end

#log_run_intro ⇒ Object 



140
141
142
 
# File 'lib/maze/client/appium/base_client.rb', line 140

def log_run_intro
  raise 'Method not implemented by this class'
end

#log_run_outro ⇒ Object 



144
145
146
 
# File 'lib/maze/client/appium/base_client.rb', line 144

def log_run_outro
  raise 'Method not implemented by this class'
end

#maze_address ⇒ Object 



53
54
55
 
# File 'lib/maze/client/appium/base_client.rb', line 53

def maze_address
  raise 'Method not implemented by this class'
end

#prepare_session ⇒ Object 



49
50
51
 
# File 'lib/maze/client/appium/base_client.rb', line 49

def prepare_session
  raise 'Method not implemented by this class'
end

#report_session ⇒ Object 



164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/maze/client/appium/base_client.rb', line 164

def report_session
  message = @session_metadata.success ? 'Success' : @session_metadata.failure_message
  error = Exception.new(message)

  Bugsnag.notify(error) do |event|
    event.api_key = ENV['MAZE_APPIUM_BUGSNAG_API_KEY']
    event.grouping_hash = event.exceptions.first[:message]

    metadata = {
      'session id': @session_metadata.id,
      'success': @session_metadata.success,
      'device farm': @session_metadata.farm.to_s,
    }
    metadata['device'] = @session_metadata.device if @session_metadata.device

    if @session_metadata.success
      event.severity = 'info'
    else
      event.severity = 'error'
      event.unhandled = true
      metadata['failure message'] = @session_metadata.failure_message
    end

    event.add_metadata(:'Appium Session', metadata)
  end
end

#retry_start_driver? ⇒ Boolean

Returns:

  • (Boolean) 


57
58
59
 
# File 'lib/maze/client/appium/base_client.rb', line 57

def retry_start_driver?
  raise 'Method not implemented by this class'
end

#start_driver(config, max_attempts = 5) ⇒ Object 



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/maze/client/appium/base_client.rb', line 88

def start_driver(config, max_attempts = 5)

  attempts = 0

  while attempts < max_attempts && Maze.driver.nil?
    attempts += 1
    start_error = nil
    begin
      Maze.driver = attempt_start_driver(config)
    rescue => error
      $logger.error "Session creation failed: #{error}"
      start_error = error
    end

    if Maze.driver
      # Infer OS version if necessary when running locally
      if Maze.config.farm == :local && Maze.config.os_version.nil?
        version = case Maze.config.os
                  when 'android'
                    driver.session_capabilities['platformVersion'].to_f
                  when 'ios'
                    driver.session_capabilities['sdkVersion'].to_f
                  end
        $logger.info "Inferred OS version to be #{version}"
        Maze.config.os_version = version
      end
    else
      interval = handle_error(start_error)
      if interval && attempts < max_attempts
        $logger.warn "Failed to create Appium driver, retrying in #{interval} seconds"
        Kernel::sleep interval
      else
        $logger.error 'Failed to create Appium driver, exiting'
        Kernel::exit(::Maze::Api::ExitCode::SESSION_CREATION_FAILURE)
      end
    end
  end
end

#start_scenario ⇒ Object 



131
132
133
134
 
# File 'lib/maze/client/appium/base_client.rb', line 131

def start_scenario
  # Launch the app on macOS
  Maze.driver.get(Maze.config.app) if Maze.config.os == 'macos'
end

#start_session ⇒ Object 



14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/maze/client/appium/base_client.rb', line 14

def start_session
  prepare_session

  start_driver(Maze.config)

  # Set bundle/app id for later use
  Maze.driver.app_id = case Maze::Helper.get_current_platform
                       when 'android'
                         Maze.driver.session_capabilities['appPackage']
                       when 'ios'
                         unless app_id = Maze.driver.session_capabilities['CFBundleIdentifier']
                            app_id = Maze.driver.session_capabilities['bundleId']
                         end
                         app_id
                       end

  if Maze.driver.app_id.nil?
    $logger.error "Failed to determine app id."
    $logger.debug "session_capabilities: #{Maze.driver.session_capabilities.inspect}"
  end

  # Log the device information after it's started
  write_device_info

  # Ensure the device is unlocked
  begin
    Maze::Api::Appium::DeviceManager.new.unlock
  rescue => error
    Bugsnag.notify error
    $logger.warn "Failed to unlock device: #{error}"
  end

  log_run_intro
end

#stop_session ⇒ Object 



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/maze/client/appium/base_client.rb', line 148

def stop_session
  if Maze.driver.failed?
    @session_metadata.success = false
    @session_metadata.failure_message = Maze.driver.failure_reason
  else
    # TODO: The call to quit could also fail
    Maze.driver.driver_quit
    @session_metadata.success = true
  end

  # Report session outcome to Bugsnag
  report_session if ENV['MAZE_APPIUM_BUGSNAG_API_KEY']

  Maze::AppiumServer.stop if Maze::AppiumServer.running
end

#write_device_info ⇒ Object 



61
62
63
64
65
66
67
68
69
 
# File 'lib/maze/client/appium/base_client.rb', line 61

def write_device_info
  info = Maze::Api::Appium::DeviceManager.new.info
  filepath = File.join(Dir.pwd, 'maze_output', 'device_info.json')
  File.open(filepath, 'w+') do |file|
    file.puts(JSON.pretty_generate(info))
  end
rescue => error
  $logger.warn "Could not write device information file, #{error.message}"
end