Class: Assert::Context
- Inherits:
-
Object
- Object
- Assert::Context
- Extended by:
- SetupDSL, SubjectDSL, SuiteDSL, TestDSL
- Includes:
- Assertions, Macros::Methods
- Defined in:
- lib/assert.rb,
lib/assert/context.rb,
lib/assert/context/test_dsl.rb,
lib/assert/context/setup_dsl.rb,
lib/assert/context/suite_dsl.rb,
lib/assert/context/subject_dsl.rb
Overview
unstub all stubs automatically (see stub.rb)
Defined Under Namespace
Modules: SetupDSL, SubjectDSL, SuiteDSL, TestDSL
Constant Summary
Constants included from Assertions
Assertions::IGNORED_ASSERTION_HELPERS
Class Method Summary collapse
-
.method_added(method_name) ⇒ Object
if a test method is added to a context manually (not using a context helper): capture any context info, build a test obj, and add it to the suite.
Instance Method Summary collapse
-
#assert(assertion, desc = nil) ⇒ Object
check if the assertion is a truthy value, if so create a new pass result, otherwise create a new fail result with the desc and what failed msg.
-
#assert_not(assertion, fail_desc = nil) ⇒ Object
(also: #refute)
the opposite of assert, check if the assertion is a false value, if so create a new pass result, otherwise create a new fail result with the desc and it’s what failed msg.
-
#fail(message = nil) ⇒ Object
(also: #flunk)
adds a Fail result to the end of the test’s results break test execution if assert is configured to halt on failures.
-
#ignore(ignore_msg = nil) ⇒ Object
adds an Ignore result to the end of the test’s results does not break test execution.
-
#initialize(running_test, config, result_callback) ⇒ Context
constructor
A new instance of Context.
- #inspect ⇒ Object
-
#pass(pass_msg = nil) ⇒ Object
adds a Pass result to the end of the test’s results does not break test execution.
-
#pending(&block) ⇒ Object
runs block and any fails are skips and any passes are fails.
-
#skip(skip_msg = nil, called_from = nil) ⇒ Object
adds a Skip result to the end of the test’s results breaks test execution.
- #subject ⇒ Object
-
#with_backtrace(bt, &block) ⇒ Object
alter the backtraces of fail/skip results generated in the given block.
Methods included from SetupDSL
around, arounds, run_arounds, run_setups, run_teardowns, setup, setup_once, setups, teardown, teardown_once, teardowns
Methods included from SubjectDSL
Methods included from SuiteDSL
Methods included from TestDSL
should, should_eventually, test, test_eventually
Methods included from Macros::Methods
Methods included from Assertions
#assert_block, #assert_empty, #assert_equal, #assert_false, #assert_file_exists, #assert_includes, #assert_instance_of, #assert_kind_of, #assert_match, #assert_nil, #assert_not_block, #assert_not_empty, #assert_not_equal, #assert_not_false, #assert_not_file_exists, #assert_not_includes, #assert_not_instance_of, #assert_not_kind_of, #assert_not_match, #assert_not_nil, #assert_not_respond_to, #assert_not_same, #assert_not_true, #assert_nothing_raised, #assert_raises, #assert_respond_to, #assert_same, #assert_true, #method_missing
Constructor Details
#initialize(running_test, config, result_callback) ⇒ Context
Returns a new instance of Context.
49 50 51 52 53 54 55 56 57 58 59 60 61 62 |
# File 'lib/assert/context.rb', line 49 def initialize(running_test, config, result_callback) @__assert_running_test__ = running_test @__assert_config__ = config @__assert_with_bt__ = [] @__assert_pending__ = 0 @__assert_result_callback__ = proc do |result| if !@__assert_with_bt__.empty? result.set_with_bt(@__assert_with_bt__.dup) end result_callback.call(result) result end end |
Dynamic Method Handling
This class handles dynamic methods through the method_missing method in the class Assert::Assertions
Class Method Details
.method_added(method_name) ⇒ Object
if a test method is added to a context manually (not using a context helper): capture any context info, build a test obj, and add it to the suite
30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 |
# File 'lib/assert/context.rb', line 30 def self.method_added(method_name) if method_name.to_s =~ Suite::TEST_METHOD_REGEX klass_method_name = "#{self}##{method_name}" if self.suite.test_methods.include?(klass_method_name) puts "WARNING: redefining "#{klass_method_name}"" puts " from: #{caller_locations(1,1)}" else self.suite.test_methods << klass_method_name end self.suite.on_test(Test.for_method( method_name.to_s, ContextInfo.new(self, nil, caller_locations(1,1)), self.suite.config )) end end |
Instance Method Details
#assert(assertion, desc = nil) ⇒ Object
check if the assertion is a truthy value, if so create a new pass result, otherwise create a new fail result with the desc and what failed msg. all other assertion helpers use this one in the end
67 68 69 70 71 72 73 74 75 76 77 78 79 |
# File 'lib/assert/context.rb', line 67 def assert(assertion, desc = nil) if assertion pass else what = if block_given? yield else "Failed assert: assertion was "\ "`#{Assert::U.show(assertion, __assert_config__)}`." end fail((desc, what)) end end |
#assert_not(assertion, fail_desc = nil) ⇒ Object Also known as: refute
the opposite of assert, check if the assertion is a false value, if so create a new pass result, otherwise create a new fail result with the desc and it’s what failed msg
83 84 85 86 87 88 |
# File 'lib/assert/context.rb', line 83 def assert_not(assertion, fail_desc = nil) assert(!assertion, fail_desc) do "Failed assert_not: assertion was "\ "`#{Assert::U.show(assertion, __assert_config__)}`." end end |
#fail(message = nil) ⇒ Object Also known as: flunk
adds a Fail result to the end of the test’s results break test execution if assert is configured to halt on failures
110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 |
# File 'lib/assert/context.rb', line 110 def fail( = nil) if @__assert_pending__ == 0 if halt_on_fail? raise Result::TestFailure, || "" else capture_result(Assert::Result::Fail, || "") end else if halt_on_fail? raise Result::TestSkipped, "Pending fail: #{ || ""}" else capture_result(Assert::Result::Skip, "Pending fail: #{ || ""}") end end end |
#ignore(ignore_msg = nil) ⇒ Object
adds an Ignore result to the end of the test’s results does not break test execution
104 105 106 |
# File 'lib/assert/context.rb', line 104 def ignore(ignore_msg = nil) capture_result(Assert::Result::Ignore, ignore_msg) end |
#inspect ⇒ Object
165 166 167 |
# File 'lib/assert/context.rb', line 165 def inspect "#<#{self.class}>" end |
#pass(pass_msg = nil) ⇒ Object
adds a Pass result to the end of the test’s results does not break test execution
93 94 95 96 97 98 99 100 |
# File 'lib/assert/context.rb', line 93 def pass(pass_msg = nil) if @__assert_pending__ == 0 capture_result(Assert::Result::Pass, pass_msg) else capture_result(Assert::Result::Fail, "Pending pass (make it "\ "not pending)") end end |
#pending(&block) ⇒ Object
runs block and any fails are skips and any passes are fails
134 135 136 137 138 139 140 141 |
# File 'lib/assert/context.rb', line 134 def pending(&block) begin @__assert_pending__ += 1 instance_eval(&block) ensure @__assert_pending__ -= 1 end end |
#skip(skip_msg = nil, called_from = nil) ⇒ Object
adds a Skip result to the end of the test’s results breaks test execution
129 130 131 |
# File 'lib/assert/context.rb', line 129 def skip(skip_msg = nil, called_from = nil) raise Result::TestSkipped, (skip_msg || ""), called_from end |
#subject ⇒ Object
159 160 161 162 163 |
# File 'lib/assert/context.rb', line 159 def subject if subj = self.class.subject instance_eval(&subj) end end |
#with_backtrace(bt, &block) ⇒ Object
alter the backtraces of fail/skip results generated in the given block
144 145 146 147 148 149 150 151 152 153 154 155 156 157 |
# File 'lib/assert/context.rb', line 144 def with_backtrace(bt, &block) bt ||= [] begin @__assert_with_bt__.push(bt.first) instance_eval(&block) rescue Result::TestSkipped, Result::TestFailure => e if e.assert_with_bt.nil? && !@__assert_with_bt__.empty? e.assert_with_bt = @__assert_with_bt__.dup end raise(e) ensure @__assert_with_bt__.pop end end |