Class: Kapnismology::SmokeTest

Inherits:
Object
  • Object
show all
Defined in:
lib/kapnismology/smoke_test.rb

Overview

This is the base class for all the smoke tests. Inherit from this class and implement the result and self.name method

Defined Under Namespace

Classes: InfoResult, NullResult, Result, SmokeTestFailed, Success

Constant Summary collapse

DEPLOYMENT_TAG = 
'deployment'.freeze
RUNTIME_TAG = 
'runtime'.freeze
DEFAULT_TAGS = 
[DEPLOYMENT_TAG, RUNTIME_TAG].freeze

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ SmokeTest

Default constructor may be overwritten by child class



16
17
18
 
# File 'lib/kapnismology/smoke_test.rb', line 16

def initialize
  @all_result_messages = []
end

Class Method Details

.inherited(klass) ⇒ Object 



42
43
44
 
# File 'lib/kapnismology/smoke_test.rb', line 42

def inherited(klass)
  SmokeTestCollection.add_smoke_test(klass)
end

.tags ⇒ Object 



46
47
48
 
# File 'lib/kapnismology/smoke_test.rb', line 46

def tags
  DEFAULT_TAGS
end

Instance Method Details

#__result__ ⇒ Object

Internally Kapnismology is calling this method. We are handling exceptions under the hood here



24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
 
# File 'lib/kapnismology/smoke_test.rb', line 24

def __result__
  result_object = result || Result.new(false, {}, 'This test has not returned any result.')
  unless result_object.class.ancestors.include?(Kapnismology::BaseResult)
    message = "Smoke test #{self.class}, returned #{result_object.class} instead of a Result"
    result_object = Result.new(false, { returned_class: result_object.class }, message)
  end
rescue Kapnismology::SmokeTestFailed => e
  result_object = e.result
rescue SmokeTestFailed => e
  result_object = e.result
rescue => e
  message = "Unrescued error happened in #{self.class}"
  result_object = Result.new(false, { exception: e.class, message: e.message }, message)
ensure
  return result_object.add_extra_messages(@all_result_messages)
end

#result ⇒ Object 



20
21
 
# File 'lib/kapnismology/smoke_test.rb', line 20

def result
end