kapnismology 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d27de09be6c9595f860e7054e7a87d8424c616e7
-  data.tar.gz: 0ddb6a39122a5ff180f1aae24f9d407eef5d02eb
+  metadata.gz: 8828ed5a2b362b08e49a35a5b5f5f1ecf583d0c3
+  data.tar.gz: 524fb01922fd668ea33d89e421732bac4c324118
 SHA512:
-  metadata.gz: d7014adec5ead6a8002bc58a34bc021e6f81da4c8fbb3aecb3a9e1ec2ff3280fd44114ed856d69bf0a322d701cde632368f87191211957a8dbcc69c8db64c822
-  data.tar.gz: 8c873c5b0387c083269a05b4a7c0e472daaeb881af725ab5aea8bfdb73650393ada8f698b375a6e5be33989805dac4854bca689adba890657b091271f156c735
+  metadata.gz: f3e9a12ffb0fce5deffe02ee606d9c8379ce5cb36d8a956a70881c6cb1549e505a958d6e4d5b4c17e0ecb2f0b680dba5a257d5adfd512fb731079195a851f37a
+  data.tar.gz: ca3c6fd0ead670fe51c1dafb80fd98787d515c5419f103ca1b6672e7dfddd30d79f4d4b74db799b46e7e4d564cf8723a18e05639f80838cb2ec166239925cc4d

data/README.md

@@ -7,7 +7,7 @@ Kapnismology 'the study of smoke', is a gem which contains an engine to easily c
 Kapnismology only supports Rails.
 In the Gemfile write:
 ```
-gem 'kapnismology', '~> 0.2'
+gem 'kapnismology', '~> 1.1'
 ```
 
 In your config/routes write:
@@ -43,9 +43,51 @@ In this case the result of this class would be added to the result as:
 {'MySmokeTest': { passed: true, data: { connection: 'good' }, message: 'Connected!' }}
 ```
 
-If you want to change the name of the test, define self.name in your
+## Naming
+
+If you want to change the name of the test, define `self.name` in your
 smoke test class.
 
+
+## Tagging and running tags
+
+All smoke tests are tagged by default with 'deployment' and 'runtime'.
+If you want to tag your test with any one of the above or any other tag, just overwrite the `self.categories` method in your smoke test class.
+The following example creates a smoke test tagged with the tags 'slow' and 'integration'.
+
+```Ruby
+class ExpensiveTest < Kapnismology::SmokeTest
+  def result
+  end
+  def self.categories
+    ['slow', 'integration']
+  end
+end
+```
+
+When you call the URL, all smoke tests marked with 'runtime' will be run. As by default all smoke test have the tags 'deployment' and 'runtime' they will all be run.
+
+The above smoke test as it has not the 'runtime' category, it will not be run. To run it you should call your service like this:
+```
+ wget http://myservice.com/smoke_test?tags=integration_
+```
+
+It will run all your integration tests. You can run it together with your runtime tests also:
+```
+ wget http://myservice.com/smoke_test?tags=integration,runtime
+```
+
+
+## Skipping tests
+
+If you want to skip some smoke test when you call the URL then you can add the 'skip' query parameter to the URL indicating the tests you want to skip.
+For instance:
+```
+ wget http://myservice.com/smoke_test?skip=ToNotBeCalled,NeitherCallThis_
+```
+
+
+
 ## TODO
 
 - Automount routes

data/Rakefile

@@ -14,11 +14,9 @@ RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+APP_RAKEFILE = File.expand_path('../test/dummy/Rakefile', __FILE__)
 load 'rails/tasks/engine.rake'
 
-
-
 Bundler::GemHelper.install_tasks
 
 require 'rake/testtask'
@@ -30,5 +28,4 @@ Rake::TestTask.new(:test) do |t|
   t.verbose = false
 end
 
-
 task default: :test

data/app/controllers/kapnismology/smoke_tests_controller.rb

@@ -1,11 +1,22 @@
 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
     def index
-      evaluations = SmokeTest.evaluations
+      evaluations = SmokeTest.evaluations(allowed_tags, blacklist)
       render text: evaluations.to_json, status: status(evaluations)
     end
 
     private
+
+    def allowed_tags
+      params[:tags] ? params[:tags].split(',') : [SmokeTest::RUNTIME_TAG]
+    end
+
+    def blacklist
+      params[:skip].to_s.split(',')
+    end
+
     def status(evaluations)
       if evaluations.passed?
         :ok

data/lib/kapnismology/engine.rb

@@ -1,24 +1,28 @@
+# Rails support, this may need changes if Rails change internals
 module Kapnismology
-begin
-  class Engine < ::Rails::Engine
-    initializer "kapnismology.add_autoload_paths", before: :set_autoload_paths do |app|
-      app.config.eager_load_paths += Dir["#{app.config.root}/lib/**/*"]
-    end
+  begin
+    # Rails engine to automatically load our code and smoke tests libraries
+    class Engine < ::Rails::Engine
+      initializer 'kapnismology.add_autoload_paths', before: :set_autoload_paths do |app|
+        app.config.eager_load_paths += Dir["#{app.config.root}/lib/**/*"]
+      end
 
-    isolate_namespace Kapnismology
-  end
+      isolate_namespace Kapnismology
+    end
 
-  class Routes
-    def self.insert!(path)
-      if defined?(Kapnismology) == false
-        raise 'require kapnismology before trying to insert routes'
-      end
-      Rails.application.routes.draw do
-        mount Kapnismology::Engine, at: path
+    # Inserts the engine (the smoketest_controller) into a given path.
+    # TODO: how to automatically do this without the user needing to insert?
+    class Routes
+      def self.insert!(path)
+        if defined?(Kapnismology) == false
+          raise 'require kapnismology before trying to insert routes'
+        end
+        Rails.application.routes.draw do
+          mount Kapnismology::Engine, at: path
+        end
       end
     end
+  rescue NameError => e
+    puts "Incompatible Rails version #{e}"
   end
-rescue NameError => e
-  puts "Incompatible Rails version #{e}"
 end
-end

data/lib/kapnismology/evaluation.rb

@@ -1,11 +1,10 @@
 require 'json'
 
 module Kapnismology
-
   # Mapping of test_name => result for each smoke test
   class Evaluation
     def initialize(test_class)
-      @name = test_class.name.split("::").last
+      @name = test_class.name.split('::').last
       @result = test_class.new.result || unavailable_result
     end
 
@@ -24,11 +23,11 @@ module Kapnismology
     private
 
     def unavailable_result
-      Result.new(false, {}, "This test has not returned any result.")
+      Result.new(false, {}, 'This test has not returned any result.')
     end
 
     def passed_or_failed_text
-      passed? ? "passed" : "failed"
+      passed? ? 'passed' : 'failed'
     end
   end
-end
+end

data/lib/kapnismology/evaluation_collection.rb

@@ -1,6 +1,7 @@
 require 'json'
 
 module Kapnismology
+  # A collection of the results of the smoke tests
   class EvaluationCollection
     include Enumerable
 
@@ -8,14 +9,14 @@ module Kapnismology
       @smoke_tests_classes = test_classes
     end
 
-    def each(&block)
+    def each(&_block)
       evaluations.each do |member|
-        block.call(member)
+        yield(member)
       end
     end
 
     def passed?
-     evaluations.all?{|evaluation| evaluation.passed?}
+      evaluations.all?(&:passed?)
     end
 
     def to_json
@@ -30,5 +31,4 @@ module Kapnismology
       end
     end
   end
-
 end

data/lib/kapnismology/rake_task.rb

@@ -6,7 +6,7 @@ module Kapnismology
         puts evaluation.to_s
         puts
       end
-      fail 'We have some failures in our smoke tests' unless evaluations.passed?
+      raise 'We have some failures in our smoke tests' unless evaluations.passed?
     end
   end
-end
+end

data/lib/kapnismology/result.rb

@@ -1,17 +1,18 @@
 module Kapnismology
-
   # This is the result of each smoke test.
   # This class makes sense to enforce smoke test to return something known
   # Params of the constructor:
   # * passed : Boolean: true -> test passed, false -> test failed
   # * data   : Typically Array or Hash representing the result of the test
-  # * message: String with an extra message set by the test to provide human readable information
+  # * message: String with an extra message to provide human readable information
   class Result
     attr_reader :data, :message
 
     def initialize(passed, data, message)
-      raise ArgumentError, "passed must be true or false" unless !!passed == passed
-      @passed, @data, @message = passed, data, message
+      raise ArgumentError, 'passed must be true or false' unless !!passed == passed
+      @passed = passed
+      @data = data
+      @message = message
     end
 
     def passed?
@@ -19,7 +20,7 @@ module Kapnismology
     end
 
     def to_hash
-      {passed: passed?, data: @data, message: @message}
+      { passed: passed?, data: @data, message: @message }
     end
   end
 end

data/lib/kapnismology/smoke_test.rb

@@ -1,18 +1,19 @@
 
 module Kapnismology
-
   #
   # This is the base class for all the smoke tests.
   # Inherit from this class and implement the result and self.name method
   #
   class SmokeTest
+    DEPLOYMENT_TAG = 'deployment'.freeze
+    RUNTIME_TAG = 'runtime'.freeze
+    DEFAULT_TAGS = [DEPLOYMENT_TAG, RUNTIME_TAG].freeze
 
     def result
       raise 'this method has to be implemented in inherited classes'
     end
 
     class << self
-
       def inherited(klass)
         smoke_tests << klass
       end
@@ -21,10 +22,20 @@ module Kapnismology
         @smoke_tests ||= []
       end
 
-      def evaluations
-        EvaluationCollection.new(smoke_tests)
+      def evaluations(allowed_tags, blacklist)
+        # We will run any class which categories are in the allowed list
+        # and not blacklisted
+        runable_tests = smoke_tests.select do |test|
+          klass_name = test.name.split('::').last
+          !blacklist.include?(klass_name) &&
+            !(allowed_tags & test.tags).empty?
+        end
+        EvaluationCollection.new(runable_tests)
       end
-    end
 
+      def tags
+        DEFAULT_TAGS
+      end
+    end
   end
-end
+end

data/lib/kapnismology/version.rb

@@ -1,3 +1,3 @@
 module Kapnismology
-  VERSION = "1.0.0"
+  VERSION = '1.1.0'.freeze
 end

data/lib/kapnismology.rb

@@ -1,7 +1,5 @@
-#Engines blow up when being autoloaded by Rails and at the same time loaded by other gems
-unless defined?(Kapnismology::Engine)
-  require "kapnismology/engine"
-end
+# Engines blow up when being autoloaded by Rails and at the same time loaded by other gems
+require 'kapnismology/engine' unless defined?(Kapnismology::Engine)
 require 'kapnismology/result'
 require 'kapnismology/evaluation'
 require 'kapnismology/evaluation_collection'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kapnismology
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Jordi Polo Carres
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-11 00:00:00.000000000 Z
+date: 2016-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -182,9 +182,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Engine for smoke tests.
 test_files: []
-has_rdoc: