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.
-
#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
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 |
# File 'lib/beaker/dsl/structure.rb', line 201 def confine(type, criteria, host_array = nil, &block) hosts_to_modify = Array( host_array || hosts ) hosts_not_modified = hosts - hosts_to_modify #we aren't examining these hosts case type when :except if criteria and ( not criteria.empty? ) hosts_to_modify = hosts_to_modify - select_hosts(criteria, hosts_to_modify, &block) + hosts_not_modified else # confining to all hosts *except* provided array of hosts hosts_to_modify = hosts_not_modified end if hosts_to_modify.empty? logger.warn "No suitable hosts without: #{criteria.inspect}" skip_test "No suitable hosts found without #{criteria.inspect}" end when :to if criteria and ( not criteria.empty? ) hosts_to_modify = select_hosts(criteria, hosts_to_modify, &block) + hosts_not_modified else # confining to only hosts in provided array of hosts end if hosts_to_modify.empty? logger.warn "No suitable hosts with: #{criteria.inspect}" skip_test "No suitable hosts found with #{criteria.inspect}" end else raise "Unknown option #{type}" 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.
238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 |
# File 'lib/beaker/dsl/structure.rb', line 238 def confine_block(type, criteria, host_array = nil, &block) host_array = Array( host_array || hosts ) original_hosts = self.hosts.dup confine(type, criteria, host_array) yield rescue Beaker::DSL::Outcomes::SkipTest => e # I don't like this much, but adding options to confine is a breaking change # to the DSL that would involve a major version bump if e. !~ /No suitable hosts found/ # a skip generated from the provided block, pass it up the chain raise e end ensure self.hosts = original_hosts 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).
124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 |
# File 'lib/beaker/dsl/structure.rb', line 124 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
274 275 276 277 278 279 280 281 282 283 284 285 286 287 |
# File 'lib/beaker/dsl/structure.rb', line 274 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 43 44 45 46 47 48 49 50 51 52 53 54 55 |
# 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) if block_given? logger.step_in() begin yield rescue Exception => e if(@options.has_key?(:debug_errors) && @options[:debug_errors] == true) logger.info("Exception raised during step execution and debug-errors option is set, entering pry. Exception was: #{e.inspect}") logger.info("HINT: Use the pry 'backtrace' and 'up' commands to navigate to the test code") binding.pry end raise e end logger.step_out() end end |
#teardown(&block) ⇒ Object
Declare a teardown process that will be called after a test case is complete.
81 82 83 |
# File 'lib/beaker/dsl/structure.rb', line 81 def teardown &block @teardown_procs << block end |
#test_name(my_name, &block) ⇒ Object
Provides a method to name tests.
62 63 64 65 66 67 68 69 70 |
# File 'lib/beaker/dsl/structure.rb', line 62 def test_name my_name, &block logger.notify "\n#{my_name}\n" set_current_test_name(my_name) if block_given? logger.step_in() yield logger.step_out() end end |