cucumber-ctrf 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 65c9e6bd454526a478362c473e6a5370e6ff45e8bd962fa35e33cd59f9f81389
+  data.tar.gz: 450e1a0d44651ff61527f7d6757318b8fddf69da8e91ffac0380ff41d62cfe67
+SHA512:
+  metadata.gz: 14d81dafc51dac4f63d8dfdaf2de2365fca07a96452a3f1042dfe1e226dde8266d6673a7b11629ea938001b672dffc33363c2b58dad81c98ad89fc510aa60625
+  data.tar.gz: 2763aacb0c0d28bc7b377722c273e3e5be247f765f34983a1c03e38e6f9607484324ca6e9e0a82ff66913c6d65772bf8e98698d262c9c7c8ff481a963c5e5927

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Down Under Software Consulting
+
+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,17 @@
+# Cucumber-CTRF
+
+Cucumber formatter to output test results in CTRF (https://www.ctrf.io/) JSON format.
+
+## Usage
+
+Add to Gemfile:
+
+```ruby
+gem "cucumber-ctrf"
+```
+
+Add formatter to either a Cucumber profile or CLI:
+
+```
+cucumber --format Ctrf::Formatter --out <path>.ctrf.json
+```

data/lib/cucumber-ctrf.rb

@@ -0,0 +1,147 @@
+require 'json'
+require 'base64'
+require 'cucumber/formatter/backtrace_filter'
+require 'cucumber/formatter/io'
+require 'cucumber/formatter/ast_lookup'
+
+module Ctrf
+  class Formatter
+    include Cucumber::Formatter::Io
+
+    def initialize(config)
+      @io = ensure_io(config.out_stream, config.error_stream)
+      @ast_lookup = Cucumber::Formatter::AstLookup.new(config)
+      @tests = {}
+      begin
+        @bc = Rails::ActiveSupport::BacktraceCleaner.new
+      rescue StandardError
+        @bc = nil
+      end
+
+      @run_start = Time.now.to_i
+      config.on_event :test_case_started, &method(:on_test_case_started)
+      config.on_event :test_case_finished, &method(:on_test_case_finished)
+      config.on_event :test_step_started, &method(:on_test_step_started)
+      config.on_event :test_step_finished, &method(:on_test_step_finished)
+      config.on_event :test_run_finished, &method(:on_test_run_finished)
+    end
+
+    def on_test_case_started(event)
+      # Set up the object for use if it doesn't exist already
+      # It might, if retries
+      return if @tests.key?(event.test_case.hash)
+
+      @tests[event.test_case.hash] = {
+        name: event.test_case.name,
+        suite: event.test_case.location.file,
+        filePath: event.test_case.location.to_s,
+        extra: {
+          hash: event.test_case.hash
+        }
+      }
+    end
+
+    def on_test_step_started(event)
+      # Don't care about steps rn
+    end
+
+    def on_test_step_finished(event)
+      # Don't care about steps rn
+    end
+
+    def on_test_case_finished(event)
+      test = @tests[event.test_case.hash]
+      test[:duration] = event.result.duration.nanoseconds / 1_000_000
+
+      # Pull existing status, if any
+      existing_status = test[:status]
+      test[:status] = sym_to_status(event.result.to_sym)
+      test[:rawStatus] = event.result.to_sym
+
+      # If this is a retry, we failed last time and passed this time, it's flaky
+      test[:flaky] = !existing_status.nil? && existing_status = 'failed' && test[:status] == 'passed'
+      unless existing_status.nil?
+        test[:retries] = 0 unless test.key?(:retries)
+        test[:retries] += 1
+      end
+
+      # Attach error information, if any
+      test[:message] = event.result.to_message.message
+      exception = get_backtrace_object(event.result) unless event.result.passed?
+
+      # If this wasn't the first run, move the trace to extra
+      if test.key?(:trace)
+        test[:extra][:previous_traces] = [] unless test[:extra].key?(:previous_traces)
+        test[:extra][:previous_traces].push(test[:trace])
+        test.delete(:trace)
+      end
+      test[:trace] = format_exception(exception) if exception
+    end
+
+    def on_test_run_finished(_event)
+      # Build the final result object
+      result = {
+        results: {
+          tool: {
+            name: 'Cucumber-Ruby'
+          },
+          summary: {
+            tests: @tests.count,
+            passed: @tests.values.select { |test| test[:status] == 'passed' }.count,
+            failed: @tests.values.select { |test| test[:status] == 'failed' }.count,
+            pending: @tests.values.select { |test| test[:status] == 'pending' }.count,
+            skipped: @tests.values.select { |test| test[:status] == 'skipped' }.count,
+            other: @tests.values.select { |test| test[:status] == 'other' }.count,
+            start: @run_start,
+            stop: Time.now.to_i
+          },
+          tests: @tests.values
+        }
+      }
+
+      @io.write(JSON.pretty_generate(result))
+    end
+
+    def attach(src, mime_type, _filename)
+      if mime_type == 'text/x.cucumber.log+plain'
+        test_step_output << src
+        return
+      end
+      if mime_type =~ /;base64$/
+        mime_type = mime_type[0..-8]
+        data = src
+      else
+        data = encode64(src)
+      end
+      test_step_embeddings << { mime_type: mime_type, data: data }
+    end
+
+    def get_backtrace_object(result)
+      if result.failed?
+        result.exception
+      elsif result.backtrace
+        result
+      end
+    end
+
+    def format_exception(exception)
+      backtrace = @bc.nil? ? exception.backtrace : @bc.clean(exception.backtrace)
+      (["#{exception.message} (#{exception.class})"] + backtrace[..10]).join("\n")
+    end
+
+    def sym_to_status(sym)
+      case sym
+      when :failed
+        'failed'
+      when :passed
+        'passed'
+      when :skipped
+        'skipped'
+      when :pending
+        'pending'
+      else
+        'other'
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: cucumber-ctrf
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- James Meneghello
+- DUSC
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-01-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '8'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+- !ruby/object:Gem::Dependency
+  name: rspec-json_matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.61.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.61.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.25.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.25.0
+description: A custom Cucumber formatter that supports outputting of test results
+  in CTRF (https://www.ctrf.io/) JSON format, including support for flaky tests.
+email: james@dusc.dev
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/cucumber-ctrf.rb
+homepage: https://github.com/dusc-dev/cucumber-ctrf
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.23
+signing_key:
+specification_version: 4
+summary: Cucumber formatter to output test results in CTRF (https://www.ctrf.io/)
+  JSON format.
+test_files: []