/
guard.rb
90 lines (79 loc) · 2.88 KB
/
guard.rb
1
2
3
4
5
6
7
8
9
10
11
12
13
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
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
# frozen_string_literal: true
# Licensed to the Software Freedom Conservancy (SFC) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The SFC licenses this file
# to you 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 Selenium
module WebDriver
module Support
class Guards
#
# Guard derived from RSpec example metadata.
# @api private
#
class Guard
attr_reader :guarded, :type, :messages, :reason
def initialize(guarded, type, guards = nil)
@guarded = guarded
@tracker = guards&.bug_tracker || ''
@messages = guards&.messages || {}
@messages[:unknown] = 'TODO: Investigate why this is failing and file a bug report'
@type = type
@reason = @guarded.delete(:reason)
end
def message
details = case @reason
when Integer
"Bug Filed: #{@tracker}/#{@reason}"
when Symbol
@messages[@reason]
when String
@reason
else
'no reason given'
end
case @type
when :exclude
"Test skipped because it breaks test run; #{details}"
when :flaky
"Test skipped because it is unreliable in this configuration; #{details}"
when :exclusive
"Test does not apply to this configuration; #{details}"
else
"Test guarded; #{details}"
end
end
# Bug is present on all configurations specified
def except?
@type == :except
end
# Bug is present on all configurations not specified
def only?
@type == :only
end
# Bug is present on all configurations specified, but test can not be run because it breaks other tests,
# or it is flaky and unreliable
def exclude?
@type == :exclude || @type == :flaky
end
# Test only applies to configurations specified
def exclusive?
@type == :exclusive
end
end # Guard
end # Guards
end # Support
end # WebDriver
end # Selenium