Class: Applitools::EyesBase
- Inherits:
-
Object
- Object
- Applitools::EyesBase
- Extended by:
- Helpers, Forwardable
- Defined in:
- lib/applitools/core/eyes_base.rb
Direct Known Subclasses
Defined Under Namespace
Classes: UserInputArray
Constant Summary collapse
- DEFAULT_MATCH_TIMEOUT =
seconds
2
- USE_DEFAULT_TIMEOUT =
-1
- SCREENSHOT_AS_IS =
Applitools::EyesScreenshot::COORDINATE_TYPES[:screenshot_as_is].freeze
- CONTEXT_RELATIVE =
Applitools::EyesScreenshot::COORDINATE_TYPES[:context_relative].freeze
Instance Attribute Summary collapse
-
#agent_id ⇒ Object
Returns the value of attribute agent_id.
-
#app_name ⇒ Object
Returns the value of attribute app_name.
-
#base_line_name ⇒ Object
Returns the value of attribute base_line_name.
-
#baseline_name ⇒ Object
Returns the value of attribute baseline_name.
-
#batch ⇒ Object
Returns the value of attribute batch.
-
#branch_name ⇒ Object
Returns the value of attribute branch_name.
-
#cut_provider ⇒ Object
Returns the value of attribute cut_provider.
-
#default_match_settings ⇒ Object
Returns the value of attribute default_match_settings.
-
#failure_reports ⇒ Object
Returns the value of attribute failure_reports.
-
#host_app ⇒ Object
Returns the value of attribute host_app.
-
#host_os ⇒ Object
Returns the value of attribute host_os.
-
#inferred_environment ⇒ Object
Returns the value of attribute inferred_environment.
-
#match_timeout ⇒ Object
Returns the value of attribute match_timeout.
-
#parent_branch_name ⇒ Object
Returns the value of attribute parent_branch_name.
-
#position_provider ⇒ Object
Returns the value of attribute position_provider.
-
#save_failed_tests ⇒ Object
Returns the value of attribute save_failed_tests.
-
#save_new_tests ⇒ Object
Returns the value of attribute save_new_tests.
-
#scale_ratio ⇒ Object
Returns the value of attribute scale_ratio.
-
#verbose_results ⇒ boolean
If set to true it will display test results in verbose format, including all fields returned by the server Default value is false.
-
#viewport_size ⇒ Object
Returns the value of attribute viewport_size.
Instance Method Summary collapse
- #abort_if_not_closed ⇒ Object
- #check_single_base(region_provider, retry_timeout, match_window_data) ⇒ Object
- #check_window_base(region_provider, retry_timeout, match_window_data) ⇒ Object
-
#close(throw_exception = true) ⇒ Object
Closes eyes otherwise the test will pass.
- #disabled=(value) ⇒ Object
- #disabled? ⇒ Boolean
-
#initialize(server_url = nil) ⇒ EyesBase
constructor
A new instance of EyesBase.
- #match_level ⇒ Object
- #match_level=(level) ⇒ Object
- #open? ⇒ Boolean
- #open_base(options) ⇒ Object
Methods included from Helpers
abstract_attr_accessor, abstract_method
Constructor Details
#initialize(server_url = nil) ⇒ EyesBase
Returns a new instance of EyesBase.
44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 |
# File 'lib/applitools/core/eyes_base.rb', line 44 def initialize(server_url = nil) self.server_connector = Applitools::Connectivity::ServerConnector.new(server_url) self.disabled = false @viewport_size = nil self.match_timeout = DEFAULT_MATCH_TIMEOUT self.running_session = nil self.save_new_tests = true self.save_failed_tests = false self.agent_id = nil self.last_screenshot = nil @user_inputs = UserInputArray.new self.app_output_provider = Object.new self.verbose_results = false self.failed = false @inferred_environment = nil get_app_output_method = ->(r, s) { get_app_output_with_screenshot r, s } app_output_provider.instance_eval do define_singleton_method :app_output do |r, s| get_app_output_method.call(r, s) end end @default_match_settings = { match_level: Applitools::MATCH_LEVEL[:strict], exact: nil } end |
Instance Attribute Details
#agent_id ⇒ Object
Returns the value of attribute agent_id.
33 34 35 |
# File 'lib/applitools/core/eyes_base.rb', line 33 def agent_id @agent_id end |
#app_name ⇒ Object
Returns the value of attribute app_name.
33 34 35 |
# File 'lib/applitools/core/eyes_base.rb', line 33 def app_name @app_name end |
#base_line_name ⇒ Object
Returns the value of attribute base_line_name.
33 34 35 |
# File 'lib/applitools/core/eyes_base.rb', line 33 def base_line_name @base_line_name end |
#baseline_name ⇒ Object
Returns the value of attribute baseline_name.
33 34 35 |
# File 'lib/applitools/core/eyes_base.rb', line 33 def baseline_name @baseline_name end |
#batch ⇒ Object
Returns the value of attribute batch.
33 34 35 |
# File 'lib/applitools/core/eyes_base.rb', line 33 def batch @batch end |
#branch_name ⇒ Object
Returns the value of attribute branch_name.
33 34 35 |
# File 'lib/applitools/core/eyes_base.rb', line 33 def branch_name @branch_name end |
#cut_provider ⇒ Object
Returns the value of attribute cut_provider.
33 34 35 |
# File 'lib/applitools/core/eyes_base.rb', line 33 def cut_provider @cut_provider end |
#default_match_settings ⇒ Object
Returns the value of attribute default_match_settings.
33 34 35 |
# File 'lib/applitools/core/eyes_base.rb', line 33 def default_match_settings @default_match_settings end |
#failure_reports ⇒ Object
Returns the value of attribute failure_reports.
33 34 35 |
# File 'lib/applitools/core/eyes_base.rb', line 33 def failure_reports @failure_reports end |
#host_app ⇒ Object
Returns the value of attribute host_app.
33 34 35 |
# File 'lib/applitools/core/eyes_base.rb', line 33 def host_app @host_app end |
#host_os ⇒ Object
Returns the value of attribute host_os.
33 34 35 |
# File 'lib/applitools/core/eyes_base.rb', line 33 def host_os @host_os end |
#inferred_environment ⇒ Object
Returns the value of attribute inferred_environment.
33 34 35 |
# File 'lib/applitools/core/eyes_base.rb', line 33 def inferred_environment @inferred_environment end |
#match_timeout ⇒ Object
Returns the value of attribute match_timeout.
33 34 35 |
# File 'lib/applitools/core/eyes_base.rb', line 33 def match_timeout @match_timeout end |
#parent_branch_name ⇒ Object
Returns the value of attribute parent_branch_name.
33 34 35 |
# File 'lib/applitools/core/eyes_base.rb', line 33 def parent_branch_name @parent_branch_name end |
#position_provider ⇒ Object
Returns the value of attribute position_provider.
33 34 35 |
# File 'lib/applitools/core/eyes_base.rb', line 33 def position_provider @position_provider end |
#save_failed_tests ⇒ Object
Returns the value of attribute save_failed_tests.
33 34 35 |
# File 'lib/applitools/core/eyes_base.rb', line 33 def save_failed_tests @save_failed_tests end |
#save_new_tests ⇒ Object
Returns the value of attribute save_new_tests.
33 34 35 |
# File 'lib/applitools/core/eyes_base.rb', line 33 def save_new_tests @save_new_tests end |
#scale_ratio ⇒ Object
Returns the value of attribute scale_ratio.
33 34 35 |
# File 'lib/applitools/core/eyes_base.rb', line 33 def scale_ratio @scale_ratio end |
#verbose_results ⇒ boolean
If set to true it will display test results in verbose format, including all fields returned by the server Default value is false.
33 34 35 36 |
# File 'lib/applitools/core/eyes_base.rb', line 33 attr_accessor :app_name, :baseline_name, :branch_name, :parent_branch_name, :batch, :agent_id, :full_agent_id, :match_timeout, :save_new_tests, :save_failed_tests, :failure_reports, :default_match_settings, :cut_provider, :scale_ratio, :host_os, :host_app, :base_line_name, :position_provider, :viewport_size, :verbose_results, :inferred_environment |
#viewport_size ⇒ Object
Returns the value of attribute viewport_size.
33 34 35 |
# File 'lib/applitools/core/eyes_base.rb', line 33 def @viewport_size end |
Instance Method Details
#abort_if_not_closed ⇒ Object
111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 |
# File 'lib/applitools/core/eyes_base.rb', line 111 def abort_if_not_closed if disabled? logger.info "#{__method__} Ignored" return end self.open = false self.last_screenshot = nil clear_user_inputs if running_session.nil? logger.info 'Closed' return end logger.info 'Aborting server session...' server_connector.stop_session(running_session, true, false) logger.info '---Test aborted' rescue Applitools::EyesError => e logger.error e. ensure self.running_session = nil end |
#check_single_base(region_provider, retry_timeout, match_window_data) ⇒ Object
240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 |
# File 'lib/applitools/core/eyes_base.rb', line 240 def check_single_base(region_provider, retry_timeout, match_window_data) if disabled? logger.info "#{__method__} Ignored" result = Applitools::MatchResults.new result.as_expected = true return result end raise Applitools::EyesError.new 'Eyes not open' unless open? Applitools::ArgumentGuard.not_nil region_provider, 'region_provider' logger.info( "check_single_base(#{region_provider}, #{match_window_data.tag}, #{match_window_data.ignore_mismatch}," \ " #{retry_timeout})" ) tag = '' if tag.nil? session_start_info = SessionStartInfo.new agent_id: base_agent_id, app_id_or_name: app_name, scenario_id_or_name: test_name, batch_info: batch, env_name: baseline_name, environment: app_environment, default_match_settings: default_match_settings, branch_name: branch_name, parent_branch_name: parent_branch_name match_window_data.start_info = session_start_info match_window_data.update_baseline_if_new = save_new_tests match_window_data.update_baseline_if_different = save_failed_tests match_window_task = Applitools::MatchSingleTask.new( logger, match_timeout, app_output_provider, server_connector ) logger.info 'Calling match_window...' result = match_window_task.match_window( match_window_data, last_screenshot: last_screenshot, region_provider: region_provider, should_match_window_run_once_on_timeout: should_match_window_run_once_on_timeout, retry_timeout: retry_timeout ) do |match_results| results = match_results.original_results not_aborted = !results['isAborted'] new_and_saved = results['isNew'] && save_new_tests different_and_saved = results['isDifferent'] && save_failed_tests not_a_mismatch = !results['isDifferent'] && !results['isNew'] not_aborted && (new_and_saved || different_and_saved || not_a_mismatch) end logger.info 'match_window done!' if result.as_expected? clear_user_inputs self.last_screenshot = result.screenshot else unless match_window_data.ignore_mismatch clear_user_inputs self.last_screenshot = result.screenshot end self.should_match_window_run_once_on_timeout = true logger.info "Mistmatch! #{tag}" if failure_reports == :immediate raise Applitools::TestFailedException.new "Mistmatch found in #{session_start_info.scenario_id_or_name}" \ " of #{session_start_info.app_id_or_name}" end end logger.info 'Done!' result.original_results end |
#check_window_base(region_provider, retry_timeout, match_window_data) ⇒ Object
176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 |
# File 'lib/applitools/core/eyes_base.rb', line 176 def check_window_base(region_provider, retry_timeout, match_window_data) if disabled? logger.info "#{__method__} Ignored" result = Applitools::MatchResults.new result.as_expected = true return result end raise Applitools::EyesError.new 'Eyes not open' unless open? Applitools::ArgumentGuard.not_nil region_provider, 'region_provider' logger.info( "check_window_base(#{region_provider}, #{match_window_data.tag}, #{match_window_data.ignore_mismatch}," \ " #{retry_timeout})" ) tag = '' if tag.nil? if running_session.nil? logger.info 'No running session, calling start session..' start_session logger.info 'Done!' @match_window_task = Applitools::MatchWindowTask.new( logger, running_session, match_timeout, app_output_provider, server_connector ) end logger.info 'Calling match_window...' result = @match_window_task.match_window( match_window_data, last_screenshot: last_screenshot, region_provider: region_provider, should_match_window_run_once_on_timeout: should_match_window_run_once_on_timeout, retry_timeout: retry_timeout ) logger.info 'match_window done!' if result.as_expected? clear_user_inputs self.last_screenshot = result.screenshot else unless match_window_data.ignore_mismatch clear_user_inputs self.last_screenshot = result.screenshot end self.should_match_window_run_once_on_timeout = true self.failed = true logger.info "Mistmatch! #{tag}" unless running_session.new_session? if failure_reports == :immediate raise Applitools::TestFailedException.new "Mistmatch found in #{session_start_info.scenario_id_or_name}" \ " of #{session_start_info.app_id_or_name}" end end logger.info 'Done!' result end |
#close(throw_exception = true) ⇒ Object
Closes eyes otherwise the test will pass. Default is true
319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 |
# File 'lib/applitools/core/eyes_base.rb', line 319 def close(throw_exception = true) if disabled? logger.info "#{__method__} Ignored" return end logger.info "close(#{throw_exception})" raise Applitools::EyesError.new 'Eyes not open' unless open? self.open = false self.last_screenshot = nil clear_user_inputs unless running_session logger.info 'Server session was not started' logger.info '--- Empty test ended' return Applitools::TestResults.new end is_new_session = running_session.new_session? session_results_url = running_session.url logger.info 'Ending server session...' save = is_new_session && save_new_tests || !is_new_session && failed && save_failed_tests logger.info "Automatically save test? #{save}" results = server_connector.stop_session running_session, false, save results.is_new = is_new_session results.url = session_results_url logger.info results.to_s(verbose_results) if results.failed? logger.error "--- Failed test ended. see details at #{session_results_url}" = "#{session_start_info.scenario_id_or_name} of #{session_start_info.app_id_or_name}. " \ "See details at #{session_results_url}." raise Applitools::TestFailedError.new , results if throw_exception return results end if results.new? instructions = "Please approve the new baseline at #{session_results_url}" logger.info "--- New test ended. #{instructions}" = "#{session_start_info.scenario_id_or_name} of #{session_start_info.app_id_or_name}. " \ "#{instructions}" raise Applitools::TestFailedError.new , results if throw_exception return results end logger.info '--- Test passed' return results ensure self.running_session = nil self.current_app_name = nil end |
#disabled=(value) ⇒ Object
95 96 97 |
# File 'lib/applitools/core/eyes_base.rb', line 95 def disabled=(value) @disabled = Applitools::Utils.boolean_value value end |
#disabled? ⇒ Boolean
99 100 101 |
# File 'lib/applitools/core/eyes_base.rb', line 99 def disabled? @disabled end |
#match_level ⇒ Object
91 92 93 |
# File 'lib/applitools/core/eyes_base.rb', line 91 def match_level @default_match_settings[:match_level] end |
#match_level=(level) ⇒ Object
87 88 89 |
# File 'lib/applitools/core/eyes_base.rb', line 87 def match_level=(level) @default_match_settings[:match_level] = level end |
#open? ⇒ Boolean
103 104 105 |
# File 'lib/applitools/core/eyes_base.rb', line 103 def open? @open end |
#open_base(options) ⇒ Object
137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 |
# File 'lib/applitools/core/eyes_base.rb', line 137 def open_base() if disabled? logger.info "#{__method__} Ignored" return end Applitools::ArgumentGuard.hash , 'open_base parameter', [:test_name] = { session_type: 'SEQUENTIAL' } = .merge if app_name.nil? Applitools::ArgumentGuard.not_nil [:app_name], 'options[:app_name]' self.current_app_name = [:app_name] else self.current_app_name = app_name end Applitools::ArgumentGuard.not_nil [:test_name], 'options[:test_name]' self.test_name = [:test_name] logger.info "Agent = #{full_agent_id}" logger.info "openBase(app_name: #{[:app_name]}, test_name: #{[:test_name]}," \ " viewport_size: #{[:viewport_size]})" raise Applitools::EyesError.new 'API key is missing! Please set it using api_key=' if api_key.nil? if open? abort_if_not_closed raise Applitools::EyesError.new 'A test is already running' end self. = [:viewport_size] self.session_type = [:session_type] self.open = true rescue Applitools::EyesError => e logger.error e. raise e end |