rspec_tesults_formatter 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 02a30026af9171664e0344a6c0283ff4cf02900ba159017ad0d3f96638b4088b
-  data.tar.gz: 60c7028ab4b359a6bc397da85eb5ec6f2cbbac636c2da0b903f5f95ae6bfe237
+  metadata.gz: 201197e6528781ab2dd686a59df2f23b25fad36a8adf3689d9ae7e7eadb56404
+  data.tar.gz: 12d131612fbe6f1c63474c04719237440ec8748b277851c06032001797d5a3c5
 SHA512:
-  metadata.gz: 843da58d0942071fbcc8832f095fd0cb33b3896bacda5a6a820c0af42dac719c94b731a50286d8eaccf04a515738118c92bc85e39024c61f70da91a9dfab4412
-  data.tar.gz: af0138d0206582685fffcc4a21646e88aef60f066f9c7acd19b77691d59bb24bb4b85fa280c7dfa9af1ee21e921f92ee6b890ef7ffbd87b1ccd213c350861e06
+  metadata.gz: 37aac9ed077de613d4750f84705481951aba5f0bef11734d78df6f7ae3246dd44d506be662241403379014963b9a4a95ccac42d783fe72cf544ff5245b93e733
+  data.tar.gz: dd7d4d2ac57360c3fe2345677e5e453bbb978487daebbda79a5d41a83892f106cbd1f827f510f153eb94deca3fd689b56e4b85f9a7f1cfd9aea3c251196ed381

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Tesults
+
+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,49 @@
+# Tesults
+
+Tesults is a test automation results reporting service. https://www.tesults.com
+
+RSpec Tesults Formatter makes it easy to push test results data to Tesults from your RSpec tests.
+
+## Installation
+
+`gem install rspec_tesults_formatter`
+
+## Configuration
+
+ ```rb
+rspec --format TesultsFormatter spec
+```
+
+## Documentation
+
+View https://www.tesults.com/docs/rspec for comprehensive documentation on the RSpec Tesults Formatter including detailed usage instructions and explanations on the arguments that you can supply.
+
+## GitHub Actions
+
+`rspec_tesults_formatter` can produce a local results file for the Tesults Test
+Automation Reporting action. No Tesults target token is required for this mode.
+
+Install `rspec_tesults_formatter` 1.2.0 or later, add the action before the test
+step, and run RSpec with the formatter as usual:
+
+```yaml
+- uses: tesults/test-automation-reporting@v1
+- run: rspec --format TesultsFormatter spec
+```
+
+The action sets `TESULTS_OUTPUT_FILE` automatically. You can also set a path in
+RSpec configuration with `tesults_output_file`; the environment variable takes
+precedence when both are present:
+
+```rb
+RSpec.configure do |config|
+  config.add_setting :tesults_output_file, :default => "/path/to/results.json"
+end
+```
+
+If both local output and `tesults_target` are configured, the formatter writes
+the local results file and uploads the same run to Tesults.
+
+## Support
+
+help@tesults.com

data/lib/rspec_tesults_formatter/version.rb

@@ -0,0 +1,3 @@
+class TesultsFormatter
+  VERSION = '1.2.0'.freeze
+end

data/lib/rspec_tesults_formatter.rb

@@ -1,75 +1,53 @@
+require 'fileutils'
+require 'json'
 require 'tesults'
+require_relative 'rspec_tesults_formatter/version'
 
 class TesultsFormatter
   RSpec::Core::Formatters.register self, :example_started, :example_finished, :dump_summary
 
   def filesForCase(suite, name)
     files = []
-    if (@files == nil)
-      return files
-    end
+    return files if @files.nil?
+
     path = File.join(@files, suite, name)
-    if (File.directory?(path) != true)
-      return files
-    else 
-      Dir.foreach(path) do |filename|
-        next if filename == '.' or filename == '..' or filename == '.DS_Store'
-        files.push(File.join(path, filename))
-      end
+    return files unless File.directory?(path)
+
+    Dir.foreach(path) do |filename|
+      next if filename == '.' || filename == '..' || filename == '.DS_Store'
+
+      files.push(File.expand_path(File.join(path, filename)))
     end
-    return files
+    files
   end
 
   def initialize(output)
     @output = output
 
-    # args
-    @disabled = true
-    begin
-      @target = RSpec.configuration.tesults_target
-    rescue
-      @target = nil
-    end
-    begin
-      @files = RSpec.configuration.tesults_files
-    rescue
-      @files = nil
-    end
-    begin
-      @buildName = RSpec.configuration.tesults_build_name
-    rescue
-      @buildName = nil
-    end
-    begin 
-      @buildDesc = RSpec.configuration.tesults_build_desc
-    rescue
-      @buildDesc = nil
-    end
-    begin
-      @buildResult = RSpec.configuration.tesults_build_result
-      if (@buildResult != "pass" && @buildResult != "fail")
-        @buildResult = "unknown"
-      end
-    rescue
-      @buildResult = "unknown"
-    end
-    begin 
-      @buildReason = RSpec.configuration.tesults_build_reason
-    rescue
-      @buildReason = nil
-    end
+    @target = configuration_value(:tesults_target)
+    @files = configuration_value(:tesults_files)
+    @buildName = configuration_value(:tesults_build_name)
+    @buildDesc = configuration_value(:tesults_build_desc)
+    @buildResult = configuration_value(:tesults_build_result, 'unknown')
+    @buildResult = 'unknown' unless ['pass', 'fail'].include?(@buildResult)
+    @buildReason = configuration_value(:tesults_build_reason)
+    @outputFile = configuration_value(:tesults_output_file)
 
-    if (@target != nil)
-      @disabled = false
-    end
-    if (@disabled == true)
-      puts 'Tesults disabled. No target supplied.'
-    end
+    environmentOutputFile = ENV['TESULTS_OUTPUT_FILE']
+    @outputFile = environmentOutputFile unless blank?(environmentOutputFile)
+
+    @disabled = @target.nil? && blank?(@outputFile)
+    puts 'Tesults disabled. No target supplied.' if @disabled
 
     @data = {
       :target => @target,
       :results => {
         :cases => []
+      },
+      :metadata => {
+        :integration_name => 'rspec_tesults_formatter',
+        :integration_version => TesultsFormatter::VERSION,
+        :test_framework => 'rspec'
       }
     }
 
@@ -77,77 +55,106 @@ class TesultsFormatter
   end
 
   def example_started(notification)
-    if (@disabled == true) 
-      return
-    end
+    return if @disabled
+
     example = notification.example
     @starttimes[example.id] = (Time.now.to_f * 1000).to_i
   end
 
   def example_finished(notification)
-    if (@disabled == true) 
-      return
-    end
+    return if @disabled
+
     example = notification.example
     result = example.execution_result.status.to_s
-    if result == "passed"
-      result = "pass"
-    elsif result == "failed"
-      result = "fail"
+    if result == 'passed'
+      result = 'pass'
+    elsif result == 'failed'
+      result = 'fail'
     else
-      result = "unknown"
+      result = 'unknown'
     end
 
-    name = example.description
-    desc = example.metadata[:example_group][:description]
-    suite = example.metadata[:example_group][:parent_example_group][:description]
-    reason = example.exception
+    group = example.metadata[:example_group] || {}
+    parentGroup = group[:parent_example_group] || {}
+    desc = group[:description]
+    suite = parentGroup[:description] || ''
+    reason = example.exception.nil? ? '' : example.exception.to_s
 
-    if reason == nil
-      reason = ""
-    else
-      reason = reason.to_s
-    end
-
-    @data[:results][:cases].push({
+    testCase = {
       :name => example.description,
       :result => result,
       :desc => desc,
       :suite => suite,
       :reason => reason,
       :files => filesForCase(suite, example.description),
-      :start =>  @starttimes[example.id],
+      :start => @starttimes[example.id],
       :end => (Time.now.to_f * 1000).to_i
-    })
+    }
+
+    source = example.metadata[:file_path]
+    line = example.metadata[:line_number]
+    unless source.nil?
+      location = { :file => File.expand_path(source) }
+      location[:line] = line.to_i unless line.nil?
+      testCase[:_Location] = JSON.generate(location)
+    end
 
-    #@output.puts name + ": " + result
+    @data[:results][:cases].push(testCase)
   end
 
-  def dump_summary (message)
-    if (@disabled == true) 
-      return
-    end
-    if (@buildName != nil && @buildResult != nil)
+  def dump_summary(_message)
+    return if @disabled
+
+    if !@buildName.nil? && !@buildResult.nil?
       buildCase = {
         :name => @buildName,
-        :suite => "[build]",
+        :suite => '[build]',
         :result => @buildResult
       }
-      if (@buildDesc != nil)
-        buildCase[:desc] = @buildDesc
-      end
-      if (@buildReason != nil)
-        buildCase[:reason] = @buildReason
-      end
-      buildCase[:files] = filesForCase("[build]", @buildName)
+      buildCase[:desc] = @buildDesc unless @buildDesc.nil?
+      buildCase[:reason] = @buildReason unless @buildReason.nil?
+      buildCase[:files] = filesForCase('[build]', @buildName)
       @data[:results][:cases].push(buildCase)
     end
-    # Use this puts for debugging: puts(@data)
+
+    writeOutputFile
+    return if @target.nil?
+
     puts 'Uploading results to Tesults...'
     res = Tesults.upload(@data)
-    puts 'Success: ' + (res[:success] ? "true" : "false")
+    puts 'Success: ' + (res[:success] ? 'true' : 'false')
     puts 'Message: ' + res[:message]
     puts 'Warnings: ' + res[:warnings].length.to_s
     puts 'Errors: ' + res[:errors].length.to_s
   end
-end
+
+  private
+
+  def blank?(value)
+    value.nil? || value.to_s.empty?
+  end
+
+  def configuration_value(name, default = nil)
+    RSpec.configuration.public_send(name)
+  rescue StandardError
+    default
+  end
+
+  def writeOutputFile
+    return false if blank?(@outputFile)
+
+    begin
+      outputFile = File.expand_path(@outputFile)
+      FileUtils.mkdir_p(File.dirname(outputFile))
+      localData = @data.merge(:target => '')
+      File.open(outputFile, 'w') do |file|
+        file.write(JSON.generate(localData))
+      end
+      puts 'Tesults results written to ' + outputFile
+      true
+    rescue StandardError => error
+      puts 'Error writing Tesults results file: ' + error.to_s
+      false
+    end
+  end
+end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: rspec_tesults_formatter
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
-- Ajeet Dhaliwal
-autorequire: 
+- ajeetd
 bindir: bin
 cert_chain: []
-date: 2020-05-19 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tesults
@@ -24,6 +23,40 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 1.1.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.9'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.9'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.25.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.25.0
 - !ruby/object:Gem::Dependency
   name: tesults
   requirement: !ruby/object:Gem::Requirement
@@ -46,12 +79,14 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE.txt
+- README.md
 - lib/rspec_tesults_formatter.rb
-homepage: https://www.tesults.com
+- lib/rspec_tesults_formatter/version.rb
+homepage: https://www.tesults.com/docs/rspec
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -66,9 +101,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.6.9
 specification_version: 4
 summary: RSpec Tesults Formatter
 test_files: []