Module: Beaker::DSL::Structure
- Included in:
- Beaker::DSL
- Defined in:
- lib/beaker/dsl/structure.rb
Overview
These are simple structural elements necessary for writing understandable tests and ensuring cleanup actions happen. If using a third party test runner they are unnecessary.
To include this in your own test runner a method #logger should be available to yield a logger that implements Logger‘s interface. As well as a method #teardown_procs that yields an array.
Instance Method Summary collapse
-
#confine(type, criteria, host_array = nil, &block) ⇒ Array<Host>
Limit the hosts a test case is run against.
-
#confine_block(type, criteria, host_array = nil, &block) ⇒ Object
Ensures that host restrictions as specifid by type, criteria and host_array are confined to activity within the passed block.
-
#expect_failure(explanation, &block) ⇒ Object
Wrap an assert that is supposed to fail due to a product bug, an undelivered feature, or some similar situation.
-
#select_hosts(criteria, host_array = nil, &block) ⇒ Array<Host>
Return a set of hosts that meet the given criteria.
-
#step(step_name, &block) ⇒ Object
Provides a method to help structure tests into coherent steps.
-
#tag(*tags) ⇒ Object
Sets tags on the current TestCase, and skips testing if necessary after checking this case’s tags against the ones that are being included or excluded.
-
#teardown(&block) ⇒ Object
Declare a teardown process that will be called after a test case is complete.
-
#test_name(my_name, &block) ⇒ Object
Provides a method to name tests.
Instance Method Details
#confine(type, criteria, host_array = nil, &block) ⇒ Array<Host>
This will modify the TestCase#hosts member in place unless an array of hosts is passed into it and TestCase#logger yielding an object that responds like Logger#warn, as well as Outcomes#skip_test, and optionally TestCase#hosts.
Limit the hosts a test case is run against
174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 |
# File 'lib/beaker/dsl/structure.rb', line 174 def confine(type, criteria, host_array = nil, &block) hosts_to_modify = host_array || hosts case type when :except hosts_to_modify = hosts_to_modify - select_hosts(criteria, hosts_to_modify, &block) when :to if criteria and ( not criteria.empty? ) hosts_to_modify = select_hosts(criteria, hosts_to_modify, &block) end else raise "Unknown option #{type}" end if hosts_to_modify.empty? logger.warn "No suitable hosts with: #{criteria.inspect}" skip_test 'No suitable hosts found' end self.hosts = hosts_to_modify hosts_to_modify end |
#confine_block(type, criteria, host_array = nil, &block) ⇒ Object
Ensures that host restrictions as specifid by type, criteria and host_array are confined to activity within the passed block. TestCase#hosts is reset after block has executed.
199 200 201 202 203 204 205 206 207 208 209 210 |
# File 'lib/beaker/dsl/structure.rb', line 199 def confine_block(type, criteria, host_array = nil, &block) begin host_array ||= hosts original_hosts = self.hosts.dup confine(type, criteria, host_array) yield ensure self.hosts = original_hosts end end |
#expect_failure(explanation, &block) ⇒ Object
Wrap an assert that is supposed to fail due to a product bug, an undelivered feature, or some similar situation.
This converts failing asserts into passing asserts (so we can continue to run the test even though there are underlying product bugs), and converts passing asserts into failing asserts (so we know when the underlying product bug has been fixed).
Pass an assert as a code block, and pass an explanatory message as a parameter. The assert’s logic will be inverted (so passes turn into fails and fails turn into passes).
107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 |
# File 'lib/beaker/dsl/structure.rb', line 107 def expect_failure(explanation, &block) begin yield if block_given? # code block should contain an assert that you expect to fail rescue Beaker::DSL::Assertions, Minitest::Assertion => failed_assertion # Yay! The assert in the code block failed, as expected. # Swallow the failure so the test passes. logger.notify 'An assertion was expected to fail, and did. ' + 'This is probably due to a known product bug, ' + 'and is probably not a problem. ' + "Additional info: '#{explanation}' " + "Failed assertion: '#{failed_assertion}'" return end # Uh-oh! The assert in the code block unexpectedly passed. fail('An assertion was expected to fail, but passed. ' + 'This is probably because a product bug was fixed, and ' + '"expect_failure()" needs to be removed from this test. ' + "Additional info: '#{explanation}'") end |
#select_hosts(criteria, host_array = nil, &block) ⇒ Array<Host>
Return a set of hosts that meet the given criteria
265 266 267 268 269 270 271 272 273 274 275 276 277 278 |
# File 'lib/beaker/dsl/structure.rb', line 265 def select_hosts(criteria, host_array = nil, &block) hosts_to_select_from = host_array || hosts criteria.each_pair do |property, value| hosts_to_select_from = hosts_to_select_from.select do |host| inspect_host host, property, value end end if block_given? hosts_to_select_from = hosts_to_select_from.select do |host| yield host end end hosts_to_select_from end |
#step(step_name, &block) ⇒ Object
Provides a method to help structure tests into coherent steps.
38 39 40 41 42 |
# File 'lib/beaker/dsl/structure.rb', line 38 def step step_name, &block logger.notify "\n * #{step_name}\n" set_current_step_name(step_name) yield if block_given? end |
#tag(*tags) ⇒ Object
Sets tags on the current TestCase, and skips testing if necessary after checking this case’s tags against the ones that are being included or excluded.
220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 |
# File 'lib/beaker/dsl/structure.rb', line 220 def tag(*) [:case] ||= {} [:case][:tags] = [] .each do |tag| [:case][:tags] << tag.downcase end @options[:tag_includes] ||= [] @options[:tag_excludes] ||= [] = [] @options[:tag_includes].each do |tag_to_include| << tag_to_include \ unless [:case][:tags].include?(tag_to_include) end skip_test "#{self.path} does not include necessary tag(s): #{}" \ if .length > 0 = [] @options[:tag_excludes].each do |tag_to_exclude| << tag_to_exclude \ if [:case][:tags].include?(tag_to_exclude) end skip_test "#{self.path} includes excluded tag(s): #{}" \ if .length > 0 end |
#teardown(&block) ⇒ Object
Declare a teardown process that will be called after a test case is complete.
64 65 66 |
# File 'lib/beaker/dsl/structure.rb', line 64 def teardown &block @teardown_procs << block end |
#test_name(my_name, &block) ⇒ Object
Provides a method to name tests.
49 50 51 52 53 |
# File 'lib/beaker/dsl/structure.rb', line 49 def test_name my_name, &block logger.notify "\n#{my_name}\n" set_current_test_name(my_name) yield if block_given? end |