kapnismology 1.12.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cc04d3c658e30139dbf0adf893088832ba05706e
-  data.tar.gz: a0b1a9b1050c75aa6907b3cf17a63dd63020ee71
+  metadata.gz: 1cbf3d487a4c5443e4d4cb4fd5cc77f432ed4954
+  data.tar.gz: 1e5c71a2f44f9da570c420ead7ff56e1b2445a4b
 SHA512:
-  metadata.gz: 571e122ee54a4a433f02afc0c1b1d743d36c2eaada3375774dd454c0b0129826616171dfb1bad8862489bdcea4c26d5fadc2f8fc19e1e8b9d3f8f1d95adf32e9
-  data.tar.gz: 126db5d5528ef6b4ec271d63ab5180892db62a7263f9e69b54d6e4d462125d8c77aad047b200c7b38398a99a396456767d2f16dea5115f9c56f94ce4c6da9bad
+  metadata.gz: 4cacad590a7220d64e4194abf8eefa561a550ec5d1d37fd08215ec4795f7e413acba81edd2ce7bb91db2d589f4f07d5ee89c5613a1dc1250769655d032b0bce2
+  data.tar.gz: e011b97bd0d5f35db1fa08bd37e57db69ef7c29097deef445e7e54c31a13d5a57d71045dc010a427d2f6ba03256b9e2575b5b4c519e9d063eb344ec04e52b16d

data/README.md

@@ -5,13 +5,13 @@ Kapnismology 'the study of smoke', is a gem containing a Rails engine to easily
 ## Installation
 
 In the Gemfile write:
-```
+```ruby
 gem 'kapnismology', '~> 1.7'
 ```
 
 In your config/routes write:
 
-```
+```ruby
   Kapnismology::Routes.insert!('/smoke_test')
 ```
 
@@ -19,11 +19,48 @@ In your config/routes write:
 
 Access the path '/smoke_test' to see the results of the smoke_test
 
+## Smoke test output format
+
+The output of the /smoke_test path is a Hypermedia document.
+
+Sample:
+
+```ruby
+{
+  "_links": {
+    "self": "https://www.example.org/smoke_test?tags=runtime",
+    "profile": "http://tbd.mdsol.com"
+  },
+  "passed": false,
+  "count": 2,
+  "trace_id": "d93abb9f-e0a2-467b-902f-b78069167e8f",
+  "items": [
+    {
+      "name": "database_smoke_test",
+      "passed": true,
+      "message": "The database is connected and responding correctly.",
+      "data": {
+          "database_name": "Polybus"
+      }
+    },
+    {
+      "name": "api_smoke_test",
+      "passed": false,
+      "message": "Api failed to respond correctly.",
+      "data": {
+         "exception": "name of exception class (StandardError, NoMethodError)",
+         "message": "exception message",
+         "stack": ["array of strings", "containing the backtrace","one string per backtrace entry"]
+      }
+    }
+  ]
+}
+```
 
 ## Adding more smoke tests
 
 Create a class like this:
-```
+```ruby
 class MySmokeTest < Kapnismology::SmokeTest
 
   def result
@@ -47,8 +84,8 @@ A test fails if it returns:
 
 Any class created this way will be called and its result will be merged with other results.
 In the example above the result of this class would be added to the results as:
-```
-{'MySmokeTest': { passed: true, data: { connection: 'good' }, message: 'Connected!' }}
+```ruby
+{ name: 'my_smoke_test', passed: true, data: { connection: 'good' }, message: 'Connected!' }
 ```
 
 ## Loading tests
@@ -74,24 +111,10 @@ end
 
 Will produce:
 ```ruby
-{'Database smoke test': { passed: true, data: { connection: 'good' }, message: 'Connected!' }}
-
-```
+{ name: 'database smoke test', passed: true, data: { connection: 'good' }, message: 'Connected!' }
 
-## Not runnable tests
-
-If your check finds a situation when it does not make sense to test, you can return a `InfoResult` instead of a `Result`. Like:
-```ruby
-if (File.exist?('necessary file'))
-  Result.new(....)
-else
-  InfoResult.new({}, 'There is no need to run this test')
-end
 ```
 
-Be very careful of not returning InfoResult when you should be returning a failing Result.
-
-
 ## Tagging and running tags
 
 All smoke tests are tagged by default with 'deployment' and 'runtime'.
@@ -147,7 +170,7 @@ For instance:
 
 Hopefully Kapnismology is flexible enough so you can code your smoke test as you prefer, our recommended style is this:
 
-```
+```ruby
 def result
   user = user_from_remote
   puts_to_result('User successfully retrieved')
@@ -178,7 +201,7 @@ You can pass your own data to SmokeTestFailed or you can pass an exception which
 
 There is a Kapnismology::SpecHelper which can be useful when running your tests.
 Usage:
-```
+```ruby
   RSpec.describe DatabaseSmokeTest do
     let(:result) { Kapnismology::SpecHelper.result_for(described_class.new) }
   ...

data/app/controllers/kapnismology/smoke_tests_controller.rb

@@ -2,9 +2,11 @@ module Kapnismology
   # This is called when the user goes to the /smoke_test URL. This calls all the
   # smoke tests registered in the application and gather the results
   class SmokeTestsController < ApplicationController
+    PROFILE_URL = 'http://tbd.mdsol.com'.freeze
+
     def index
       evaluations = SmokeTestCollection.evaluations(allowed_tags, blacklist)
-      render json: evaluations.to_json, status: status(evaluations)
+      render json: results(evaluations).to_json, status: status(evaluations)
     end
 
     private
@@ -24,5 +26,19 @@ module Kapnismology
         :service_unavailable
       end
     end
+
+    def results(evaluations)
+      items = evaluations.as_json.select { |e| e.has_key?(:passed) }
+      {
+        _links: {
+          self: CGI.unescape(request.original_url),
+          profile: PROFILE_URL
+        },
+        passed: evaluations.passed?,
+        count: items.size,
+        trace_id: Object.const_defined?(:Trace) ? Trace.id.trace_id.to_s : nil,
+        items: items
+      }
+    end
   end
 end

data/lib/kapnismology/evaluation.rb

@@ -15,7 +15,7 @@ module Kapnismology
     end
 
     def as_json(_options = nil)
-      { @name => @result.to_hash }
+      { name: @name.underscore }.merge(@result.to_hash)
     end
 
     def to_s

data/lib/kapnismology/result.rb

@@ -3,21 +3,21 @@ module Kapnismology
   # It is useful to be able to test if the object is of a correct result type.
   # It also have methods to add information and serialize it.
   class BaseResult
-    attr_reader :data, :message, :extra_messages # Deprecated but many users test on these properties
+    attr_reader :data, :message, :debug_messages
     def to_hash
-      { passed: passed?, data: @data, message: @message, extra_messages: @extra_messages }
+      { passed: passed?, data: @data, message: @message, debug_messages: @debug_messages }
     end
 
     def to_s(name)
       <<-eos
 #{format_passed(passed?)}: #{name}
-#{format_extra_messages(@extra_messages)}#{Terminal.bold(@message)}
+#{format_debug_messages(@debug_messages)}#{Terminal.bold(@message)}
    #{@data}
 eos
     end
 
-    def add_extra_messages(messages)
-      @extra_messages = (messages || []).compact.flatten
+    def add_debug_messages(messages)
+      @debug_messages = (messages || []).compact.flatten
       self
     end
 
@@ -27,11 +27,11 @@ eos
 
     private
 
-    def format_extra_messages(extra_messages)
-      if extra_messages.empty?
+    def format_debug_messages(debug_messages)
+      if debug_messages.empty?
         ''
       else
-        extra_messages.join("\n") + "\n"
+        debug_messages.join("\n") + "\n"
       end
     end
 
@@ -52,23 +52,29 @@ eos
       @passed = passed
       @data = data
       @message = message
-      @extra_messages = []
+      @debug_messages = []
     end
   end
 
-  # This class can be returned when a check do not want to assert if it passed or not.
-  # Instead it can return certain information about the check or the system.
-  class InfoResult < BaseResult
+  # Deprecated NullResult class provided for compatibility.
+  class NullResult < BaseResult
     def initialize(data, message = 'The result could not be determined')
       @passed = true
       @data = data
       @message = message
-      @extra_messages = []
+      @debug_messages = []
     end
 
-    # Redefining to have our own unique output
+    def to_s(name)
+      <<-eos
+#{Terminal.yellow('This test can not be run. Skipping...')}
+#{super(name).chomp}
+eos
+    end
+
+    # Nullresult does not output any data.
     def to_hash
-      { data: @data, message: @message, extra_messages: @extra_messages }
+      {}
     end
 
     private
@@ -78,10 +84,6 @@ eos
     end
   end
 
-  # Deprecated NullResult class provided for compatibility.
-  class NullResult < InfoResult
-  end
-
   class NotApplicableResult < BaseResult
   end
 
@@ -92,7 +94,7 @@ eos
       @passed = true
       @data = data
       @message = message
-      @extra_messages = []
+      @debug_messages = []
     end
   end
 end

data/lib/kapnismology/smoke_test.rb

@@ -32,7 +32,7 @@ module Kapnismology
       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)
+      return result_object.add_debug_messages(@all_result_messages)
     end
 
     class << self
@@ -59,8 +59,6 @@ module Kapnismology
     # These classes makes it very simple to implementors of results to use them without the module name
     class Result < Kapnismology::Result
     end
-    class InfoResult < Kapnismology::InfoResult
-    end
     class NullResult < Kapnismology::NullResult
     end
     class Success < Kapnismology::Success

data/lib/kapnismology/spec_helper.rb

@@ -2,13 +2,13 @@ require 'kapnismology/result'
 
 module Kapnismology
   class RSpecResult < BaseResult
-    attr_reader :data, :message, :extra_messages # Deprecated but many users test on these properties
+    attr_reader :data, :message, :debug_messages
     def initialize(result)
       hash = result.to_hash
       @data = hash[:data]
       @message = hash[:message]
       @passed = hash[:passed]
-      @extra_messages = hash[:extra_messages]
+      @debug_messages = hash[:debug_messages]
     end
   end
 

data/lib/kapnismology/version.rb

@@ -1,3 +1,3 @@
 module Kapnismology
-  VERSION = '1.12.0'.freeze
+  VERSION = '2.0.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kapnismology
 version: !ruby/object:Gem::Version
-  version: 1.12.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Jordi Polo Carres
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-28 00:00:00.000000000 Z
+date: 2016-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails