kanoah_rspec_formatter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 932338c5673f6b2056a561c94971375a8ffbf9c3
+  data.tar.gz: be779697dc4946efb91dbfe9c0a40db32024a3fb
+SHA512:
+  metadata.gz: aea6417b8834988f8554ab8ff2440ed06c78cf0d8e7f8d092cf841ae73e4deea47c46356fb9b876607c2f14db59b8e66519aa7c9be7a75a84fd8fd34d34f136f
+  data.tar.gz: 6d3dfd77d13f351e10415a208d9d0c44ed9b5aa6c0a9490ef8cd54e3a343450e2b04ef57c9c0d3a34bceba6aa7c94dde8285788907639a99ae746b22d62920fe

data/.gitignore

@@ -0,0 +1,3 @@
+.DS_Store
+.idea/
+*.gem

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,38 @@
+PATH
+  remote: .
+  specs:
+    kanoah_rspec_formatter (0.1.0)
+      kanoah_ruby (>= 0.1.0)
+      rspec (>= 3.5.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    httparty (0.14.0)
+      multi_xml (>= 0.5.2)
+    kanoah_ruby (0.1.0)
+      httparty (>= 0.13.7)
+    multi_xml (0.6.0)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.4)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  kanoah_rspec_formatter!
+
+BUNDLED WITH
+   1.13.6

data/LICENCE

@@ -0,0 +1,21 @@
+MIT LICENSE
+
+Copyright (c)  Justin Commu <Justin.Commu@loblaw.ca>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,36 @@
+# Koanoah RSpec Formatter
+
+Welcome to kanoah_rspec_formatter, a highly opinionated RSpec formatter which communicates test results in realtime to Kanoah
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'kanoah_rpsec_formatter'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install kanoah_rpsec_formatter
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/test. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/kanoah_rspec_formatter.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+
+Gem::Specification.new do |spec|
+  spec.name          = 'kanoah_rspec_formatter'
+  spec.version       = '0.1.0'
+  spec.authors       = ['Automation Wizards']
+  spec.email         = ['Justin.Commu@loblaw.ca']
+
+  spec.summary       = ''
+  spec.description   = 'A RSpec formatter for Kanoah'
+  spec.homepage      = 'https://loblawdigital.ca'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.platform      = Gem::Platform::RUBY
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency      'rspec',                  '>= 3.5.0'
+  spec.add_runtime_dependency      'kanoah_ruby',            '>= 0.1.0'
+
+end

data/lib/kanoah_formatter/base_formatter.rb

@@ -0,0 +1,15 @@
+require 'rspec/core/formatters/base_formatter'
+module KanoahRSpecFormatter
+  class BaseFormatter < RSpec::Core::Formatters::BaseFormatter
+    NOTIFICATIONS = [:start, :example_started, :example_passed, :example_failed, :example_pending]
+
+    def start(_notification)
+      @api = Kanoah::Client.new(base_url: KanoahRSpecFormatter::Config.config.base_url,
+                                project_id: KanoahRSpecFormatter::Config.config.project_id,
+                                test_run_id: KanoahRSpecFormatter::Config.config.test_run_id,
+                                environment: KanoahRSpecFormatter::Config.config.environment,
+                                username: KanoahRSpecFormatter::Config.config.username,
+                                password: KanoahRSpecFormatter::Config.config.password)
+    end
+  end
+end

data/lib/kanoah_result_formatter.rb

@@ -0,0 +1,67 @@
+require_relative 'kanoah_formatter/base_formatter'
+class KanoahResultFormatter < KanoahRSpecFormatter::BaseFormatter
+
+  RSpec::Core::Formatters.register self, *NOTIFICATIONS
+
+  def start(notification)
+    super(notification)
+  end
+
+  def example_passed(notification)
+    proccess_result(notification.example) if notification.example.metadata.has_key?(:test_id) && !test_id(notification.example).empty?
+  end
+
+  def example_failed(notification)
+    proccess_result(notification.example) if notification.example.metadata.has_key?(:test_id) && !test_id(notification.example).empty?
+  end
+
+  def example_pending(notification)
+    proccess_result(notification.example) if notification.example.metadata.has_key?(:test_id) && !test_id(notification.example).empty?
+  end
+
+  def example_started(notification)
+    notification.example.metadata[:step_index] = 0
+  end
+
+  private
+
+  def proccess_result(example)
+    body = {
+        test_case: test_id(example),
+        status: status(example.metadata[:execution_result]),
+        comment: comment(example.metadata),
+        execution_time: run_time(example.metadata[:execution_result]),
+        script_results: steps(example.metadata)
+    }
+    @api.test_run_id ? @api.post_new_result_to_run(body) : @api.post_new_result(body)
+  end
+
+  def test_id(example)
+    example.metadata[:test_id]
+  end
+
+  def status(scenario)
+    status_code(scenario.status)
+  end
+
+  def run_time(scenario)
+    scenario.run_time.to_i * 1000
+  end
+
+  def comment(scenario)
+    scenario[:kanoah_evidence][:title] + "\n" + scenario[:kanoah_evidence][:path] unless scenario[:kanoah_evidence].nil?
+  end
+
+  def steps(scenario)
+    scenario[:steps]
+  end
+
+  def status_code(status)
+    case status
+      when :failed, :passed then
+        status.to_s.gsub('ed', '').capitalize
+      when :pending then
+        'Blocked'
+    end
+  end
+end

data/lib/kanoah_rspec_formatter/adapter.rb

@@ -0,0 +1,6 @@
+module KanoahRSpecFormatter
+  module Adaptor
+    RSpec::Core::Example.send :include, KanoahRSpecFormatter::Example
+  end
+end
+

data/lib/kanoah_rspec_formatter/configuration.rb

@@ -0,0 +1,25 @@
+module KanoahRSpecFormatter
+  module Config
+    class << self
+      attr_accessor :config
+    end
+
+    def self.configure
+      self.config ||= Configuration.new
+      yield(config)
+    end
+
+    class Configuration
+      attr_accessor :base_url, :test_run_id, :environment, :username, :password, :project_id
+
+      def initialize
+        @base_url    = nil
+        @test_run_id = nil
+        @project_id  = nil
+        @environment = nil
+        @username    = nil
+        @password    = nil
+      end
+    end
+  end
+end

data/lib/kanoah_rspec_formatter/rspec_steps.rb

@@ -0,0 +1,15 @@
+module KanoahRSpecFormatter
+  module Example
+    def step(_step, options = {}, &block)
+      @metadata[:steps] = [] if @metadata[:steps].nil?
+      begin
+        yield block
+        @metadata[:steps].push({ index: @metadata[:step_index], status: 'Pass' })
+      rescue Exception => e
+        @exception = e
+        @metadata[:steps].push({ index: @metadata[:step_index], status: 'Fail', comment: e })
+      end
+      @metadata[:step_index] += 1 if @metadata.has_key?(:step_index)
+    end
+  end
+end

data/lib/kanoah_rspec_formatter.rb

@@ -0,0 +1,5 @@
+require 'kanoah_ruby'
+require 'rspec'
+require_relative 'kanoah_rspec_formatter/configuration'
+require_relative 'kanoah_rspec_formatter/rspec_steps'
+require_relative 'kanoah_rspec_formatter/adapter'

data/lib/kanoah_testcase_formatter.rb

@@ -0,0 +1,79 @@
+require_relative 'kanoah_formatter/base_formatter'
+class KanoahTestcaseFormatter < KanoahRSpecFormatter::BaseFormatter
+
+  RSpec::Core::Formatters.register self, *NOTIFICATIONS
+
+  def start(notification)
+    super(notification)
+  end
+
+  def example_passed(notification)
+    proccess_result(notification.example)
+  end
+
+  def example_pending(notification)
+    proccess_result(notification.example)
+  end
+
+  private
+
+  def proccess_result(example)
+
+    test_id = @api.post_new_test_case(testcase_body(example))
+    # @api.post_new_result_to_run(body)
+    update_exomple(example, test_id)
+  end
+
+  def testcase_body(example)
+    {
+        projectKey: project_key(example),
+        name: description(example),
+        folder: '',
+        status: '',
+        priority: '',
+        component: '',
+        labels: '',
+        testScript: ''
+    }
+  end
+
+  def project_key(example)
+    example[:project]
+  end
+
+  def description(example)
+    example[:description]
+  end
+
+  def update_example(example, test_id)
+
+  end
+end
+
+# def post_new_test_case(body)
+#   @response = self.class.post("/rest/kanoahtests/1.0/testcase", body: body.to_json, headers: @header)
+#   self
+# end
+
+# {
+#     "projectKey": "JQA",
+#     "name": "Ensure the axial-flow pump is enabled",
+#     "precondition": "The precondition.",
+#     "objective": "The objective.",
+#     "folder": "/Orbiter/Cargo Bay",
+#     "status": "Approved",
+#     "priority": "Low",
+#     "component": "Valves",
+#     "owner": "vitor.pelizza",
+#     "estimatedTime": 138000,
+#     "labels": ["Smoke", "Functional"],
+#     "testScript": {
+#         "type": "STEP_BY_STEP",
+#         "steps": [
+#             {
+#                 "description": "Ignite the secondary propulsion engines.",
+#                 "expectedResult": "Ensure the high-pressure combustion chamber's pressure is around 3000 psi."
+#             }
+#         ]
+#     }
+# }

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: kanoah_rspec_formatter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Automation Wizards
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-02-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+- !ruby/object:Gem::Dependency
+  name: kanoah_ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+description: A RSpec formatter for Kanoah
+email:
+- Justin.Commu@loblaw.ca
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENCE
+- README.md
+- kanoah_rspec_formatter.gemspec
+- lib/kanoah_formatter/base_formatter.rb
+- lib/kanoah_result_formatter.rb
+- lib/kanoah_rspec_formatter.rb
+- lib/kanoah_rspec_formatter/adapter.rb
+- lib/kanoah_rspec_formatter/configuration.rb
+- lib/kanoah_rspec_formatter/rspec_steps.rb
+- lib/kanoah_testcase_formatter.rb
+homepage: https://loblawdigital.ca
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.7
+signing_key: 
+specification_version: 4
+summary: ''
+test_files: []