kapnismology 2.4.1 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 432ba59104db7f2e855bcfb9c43d7d82861a13691e3abeeed2da3e1258aa2343
-  data.tar.gz: e61f72fd371176d1d76451ff9b83748668b68ba2a76de6afb8ba16b44f8f9f8f
+  metadata.gz: 8eb5fe1d158d622fa0119a80efe3b816aeddf4cd0c7d0a965140c5889c258ab7
+  data.tar.gz: 3edf154c21c793c78bc53fbcca442409bd7827cd9a2ab78599f0255c9ba179a1
 SHA512:
-  metadata.gz: a6dc6c24e8f5d1218c3731c9774f2c1e2a2318a9b4025fa591de690bd26aa20db8b056cb02537c70d099199fdd81e8951ea21d4e03865b9248b833694eca9cc9
-  data.tar.gz: 436333b7043a832591af145cdfeea106fdfb004a00f91d5d75b53ea0ec442264e052d6ca01d85d47c38325aea70f31fbc0f229317260f62cf03c32ad02d25ccc
+  metadata.gz: a136af17d09e21c00e332b3740ad6678201be581b67dc6950d43163b5863bf5726ba0d5923242501414815c20bf61edb56f1d0a004f1038187498368721081ff
+  data.tar.gz: de593e01436167c00dbb5050cedc65471c29dae5938bbe37d585ad5c70fb2ef42c15b47d984e5ce77336f0e78972ad8a18ab90f3a4773f290ff58e88e2f57fb9

data/README.md

@@ -38,7 +38,6 @@ Sample:
   },
   "passed": false,
   "count": 2,
-  "trace_id": "d93abb9f-e0a2-467b-902f-b78069167e8f",
   "codebase_revision": "7beb617",
   "items": [
     {

data/app/controllers/kapnismology/smoke_tests_controller.rb

@@ -2,7 +2,6 @@ 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
       response = SmokeTestResponse.new(SmokeTestCollection.evaluations(allowed_tags, blacklist))
       render json: response.render(request.original_url), status: response.status
@@ -18,5 +17,4 @@ module Kapnismology
       params[:skip].to_s.split(',')
     end
   end
-
 end

data/lib/kapnismology/application_information.rb

@@ -1,47 +1,54 @@
 require "json"
+require "singleton"
 
 module Kapnismology
   # This class provides information about the running environment the smoketest is being
   # executed under.
   class ApplicationInformation
-    GIT_SHOW_COMMAND = "git show HEAD --abbrev-commit --oneline 2>/dev/null".freeze
+    include Singleton
+
+    GIT_COMMAND = "git rev-parse --short HEAD 2>/dev/null".freeze
     ECS_CONTAINER_METADATA_FILE = ENV["ECS_CONTAINER_METADATA_FILE"].freeze
+    KUBERNETES_ANNOTATIONS_FILE = "/etc/podinfo/annotations".freeze
     INFO_UNKNOWN = "".freeze
 
-    def trace_id
-      Object.const_defined?(:Trace) ? Trace.id.trace_id.to_s : INFO_UNKNOWN
-    end
-
     def codebase_revision
-      ref = latest_commit_info
-      ref ? ref.split(/\s/).first : INFO_UNKNOWN
-    rescue Errno::ENOENT, StandardError
-      INFO_UNKNOWN
+      @codebase_revision ||= begin
+        latest_commit_info[0...7]
+      rescue Errno::ENOENT, StandardError
+        INFO_UNKNOWN
+      end
     end
 
     private
 
     def latest_commit_info
-      latest_ref_from_git || latest_ref_from_ecs_metadata || nil
+      latest_sha_from_ecs_metadata || latest_sha_from_k8s_annotations || latest_sha_from_git || INFO_UNKNOWN
     end
 
-    def latest_ref_from_git
-      result = `#{GIT_SHOW_COMMAND}`
+    def latest_sha_from_git
+      result = `#{GIT_COMMAND}`
       $?.success? ? result : nil
     end
 
-    # This assumes the ImageName features the git ref as the last part of a string delimited by dots.
+    # This assumes the ImageName features the git sha as the last part of a string delimited by dots.
     # See spec/support/ecs_metadata.json as well as
     # https://docs.aws.amazon.com/AmazonECS/latest/developerguide/container-metadata.html
-    def latest_ref_from_ecs_metadata
-      return if ECS_CONTAINER_METADATA_FILE.nil?
-      return unless !ECS_CONTAINER_METADATA_FILE.strip.empty? && File.readable?(ECS_CONTAINER_METADATA_FILE)
+    def latest_sha_from_ecs_metadata
+      return nil if ECS_CONTAINER_METADATA_FILE.nil?
+      return nil unless !ECS_CONTAINER_METADATA_FILE.strip.empty? && File.readable?(ECS_CONTAINER_METADATA_FILE)
 
       begin
-        JSON.parse(File.read(ECS_CONTAINER_METADATA_FILE))["ImageName"].split(".").last[0...7]
+        JSON.parse(File.read(ECS_CONTAINER_METADATA_FILE))["ImageName"].split(".").last
       rescue JSON::ParserError
         nil
       end
     end
+
+    def latest_sha_from_k8s_annotations
+      return nil unless File.readable?(KUBERNETES_ANNOTATIONS_FILE)
+
+      File.read(KUBERNETES_ANNOTATIONS_FILE).scan(/gitSha="(.+)"$/).last&.first
+    end
   end
 end

data/lib/kapnismology/engine.rb

@@ -21,6 +21,7 @@ if defined?(Rails)
           if defined?(Kapnismology) == false
             raise 'require kapnismology before trying to insert routes'
           end
+
           Rails.application.routes.draw do
             mount Kapnismology::Engine, at: path
           end

data/lib/kapnismology/evaluation.rb

@@ -5,6 +5,7 @@ module Kapnismology
   # Mapping of test_name => returned result for each smoke test
   class Evaluation
     attr_reader :result
+
     def initialize(test_class)
       @name = test_class.name.split('::').last
       @result = test_class.new.__result__
@@ -25,6 +26,5 @@ module Kapnismology
     def duration
       @result.duration
     end
-
   end
 end

data/lib/kapnismology/evaluation_collection.rb

@@ -10,9 +10,7 @@ module Kapnismology
     end
 
     def each(&_block)
-      evaluations.each do |member|
-        yield(member)
-      end
+      evaluations.each(&_block)
     end
 
     def passed?
@@ -30,10 +28,9 @@ module Kapnismology
     private
 
     def evaluations
-      @evaluations ||= @smoke_tests_classes.inject([]) do |memo, klass|
+      @evaluations ||= @smoke_tests_classes.each_with_object([]) do |klass, memo|
         evaluation = Evaluation.new(klass)
-        memo << evaluation if !evaluation.result.class.ancestors.include?(Kapnismology::NotApplicableResult)
-        memo
+        memo << evaluation unless evaluation.result.class.ancestors.include?(Kapnismology::NotApplicableResult)
       end
     end
   end

data/lib/kapnismology/rake_task.rb

@@ -2,7 +2,7 @@ require 'kapnismology/terminal'
 module Kapnismology
   class RakeTask
     def output(allowed_tags = [SmokeTest::RUNTIME_TAG], blacklist = [])
-      puts  "Running smoke test for codebase revision #{ApplicationInformation.new.codebase_revision}"
+      puts "Running smoke test for codebase revision #{ApplicationInformation.new.codebase_revision}"
       evaluations = SmokeTestCollection.evaluations(allowed_tags, blacklist)
       puts
       puts

data/lib/kapnismology/result.rb

@@ -4,16 +4,17 @@ module Kapnismology
   # It also have methods to add information and serialize it.
   class BaseResult
     attr_reader :data, :message, :debug_messages, :duration
+
     def to_hash
       { passed: passed?, data: @data, message: @message, debug_messages: @debug_messages, duration: @duration }
     end
 
     def to_s(name)
-      <<-eos
-#{format_passed(passed?)}: #{name}
-#{format_duration(@duration)}#{format_debug_messages(@debug_messages)}#{Terminal.bold(@message)}
-   #{@data}
-eos
+      <<~EOS
+        #{format_passed(passed?)}: #{name}
+        #{format_duration(@duration)}#{format_debug_messages(@debug_messages)}#{Terminal.bold(@message)}
+           #{@data}
+      EOS
     end
 
     def add_debug_messages(messages)
@@ -58,6 +59,7 @@ eos
     def initialize(passed, data, message)
       raise ArgumentError, 'passed argument must be true or false' unless !!passed == passed
       raise ArgumentError, 'data argument must be a hash' unless data.is_a?(Hash)
+
       @passed = passed
       @data = data
       @message = message
@@ -77,10 +79,10 @@ eos
     end
 
     def to_s(name)
-      <<-eos
-#{Terminal.yellow('This test can not be run. Skipping...')}
-#{super(name).chomp}
-eos
+      <<~EOS
+        #{Terminal.yellow('This test can not be run. Skipping...')}
+        #{super(name).chomp}
+      EOS
     end
 
     # Nullresult does not output any data.
@@ -103,6 +105,7 @@ eos
   class Success < BaseResult
     def initialize(data, message)
       raise ArgumentError, 'data argument must be a hash' unless data.is_a?(Hash)
+
       @passed = true
       @data = data
       @message = message

data/lib/kapnismology/smoke_test.rb

@@ -13,13 +13,12 @@ module Kapnismology
     RUNTIME_TAG = 'runtime'.freeze
     DEFAULT_TAGS = [DEPLOYMENT_TAG, RUNTIME_TAG].freeze
 
-    def result
-    end
+    def result; end
 
     # Internally Kapnismology is calling this method. We are handling exceptions under the hood here
     def __result__
       start_time = Time.now
-      execution = Timeout::timeout(self.class.timeout) { result }
+      execution = Timeout.timeout(self.class.timeout) { result }
       result_object = execution || Result.new(false, {}, 'This test has not returned any result')
       unless result_object.class.ancestors.include?(BaseResult)
         message = "Smoke test #{self.class}, returned #{result_object.class} instead of a Result"
@@ -63,12 +62,14 @@ 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 NullResult < Kapnismology::NullResult
     end
+
     class Success < Kapnismology::Success
     end
+
     class SmokeTestFailed < Kapnismology::SmokeTestFailed
     end
-
   end
 end

data/lib/kapnismology/smoke_test_failed.rb

@@ -1,13 +1,12 @@
 module Kapnismology
-
   # This class can be raised to make Kapnismology create a failed result from your smoke test
   class SmokeTestFailed < StandardError
     def initialize(data, message)
       @data = if data.class.ancestors.include?(Exception)
-        { exception: data.class, message: data.message }
-      else
-        data
-      end
+                { exception: data.class, message: data.message }
+              else
+                data
+              end
       @message = message
     end
 

data/lib/kapnismology/smoke_test_response.rb

@@ -1,7 +1,6 @@
 module Kapnismology
   # A summary of a run containing smoke test evaluations
   class SmokeTestResponse
-
     PROFILE_URL = 'http://tbd.mdsol.com'.freeze
 
     def initialize(evaluations)
@@ -21,12 +20,10 @@ module Kapnismology
         },
         passed: @evaluations.passed?,
         count: items.size,
-        trace_id: ApplicationInformation.new.trace_id,
-        codebase_revision: ApplicationInformation.new.codebase_revision,
+        codebase_revision: ApplicationInformation.instance.codebase_revision,
         duration: @evaluations.total_duration,
         items: items
       }.to_json
     end
-
   end
 end

data/lib/kapnismology/spec_helper.rb

@@ -3,6 +3,7 @@ require 'kapnismology/result'
 module Kapnismology
   class RSpecResult < BaseResult
     attr_reader :data, :message, :debug_messages
+
     def initialize(result)
       hash = result.to_hash
       @data = hash[:data]

data/lib/kapnismology/terminal.rb

@@ -16,7 +16,6 @@ module Kapnismology
       colorize(msg, '')
     end
 
-    private
     def self.colorize(msg, color_code)
       # \e[1m adds bold font, \e[0m resets all styles
       $stdout.isatty ? "#{color_code}\e[1m#{msg}\e[0m" : msg

data/lib/kapnismology/version.rb

@@ -1,3 +1,3 @@
 module Kapnismology
-  VERSION = '2.4.1'.freeze
+  VERSION = '2.6.0'.freeze
 end

metadata

@@ -1,71 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: kapnismology
 version: !ruby/object:Gem::Version
-  version: 2.4.1
+  version: 2.6.0
 platform: ruby
 authors:
 - Jordi Polo Carres
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-04-17 00:00:00.000000000 Z
+date: 2023-06-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: actionpack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.22
+        version: '6.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.22
+        version: '6.0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: appraisal
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
-  name: rspec-json_expectations
+  name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '10'
 - !ruby/object:Gem::Dependency
-  name: byebug
+  name: capybara
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10'
+        version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10'
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: combustion
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: mutant
   requirement: !ruby/object:Gem::Requirement
@@ -95,75 +109,75 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.8'
 - !ruby/object:Gem::Dependency
-  name: appraisal
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '3.5'
 - !ruby/object:Gem::Dependency
-  name: combustion
+  name: rspec-json_expectations
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.6
+        version: '1.42'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.6
+        version: '1.42'
 - !ruby/object:Gem::Dependency
-  name: capybara
+  name: rubocop-mdsol
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.10'
+        version: '0.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.10'
+        version: '0.1'
 - !ruby/object:Gem::Dependency
-  name: timecop
+  name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '1.15'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '1.15'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -178,6 +192,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.16'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
 description: Engine for smoke tests and base classes
 email:
 - mumismo@gmail.com
@@ -207,7 +249,7 @@ homepage: https://github.com/JordiPolo/kapnismology
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -215,15 +257,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
-signing_key: 
+rubygems_version: 3.2.15
+signing_key:
 specification_version: 4
 summary: Engine for smoke tests.
 test_files: []