rspec-ctrf 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9d0a53813aa0abbea29ef8568f6d15a5e8ea8b8db9a64152823218f302317eab
+  data.tar.gz: 4d9036e2272ff15f74cb5bd5f9e4c1cfe10e51d9e92319e8563083143e7b2d58
+SHA512:
+  metadata.gz: bbbabb7f07561c6c484c43010f3a6c11d8b2ed1fdd380be3c09107fe7dae88b4b7c9014bb37ee0c0655c3ec20ea65bda92abaffba66f826c28f34797365a2281
+  data.tar.gz: 663087ca68280ad727006f0bcb0bbbac66ffd929e23582a2f6b63adcf5058ebe74511bb339a836f08b980f06ee8e531fcb3c55f44f01affd61be5435a5399f17

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 @@
+# RSpec-CTRF
+
+RSpec formatter to output test results in CTRF (https://www.ctrf.io/) JSON format.
+
+## Usage
+
+Add to Gemfile:
+
+```ruby
+gem "rspec-ctrf"
+```
+
+Add formatter to either `.rspec` or CLI:
+
+```
+rspec --format Ctrf::RSpecFormatter --out <path>.ctrf.json
+```

data/lib/ctrf/r_spec_formatter.rb

@@ -0,0 +1,102 @@
+require 'json'
+
+module Ctrf
+  class RSpecFormatter
+    RSpec::Core::Formatters.register self, :start, :stop, :example_started, :example_finished
+
+    attr_reader :output
+
+    def initialize(output)
+      @output = output
+    end
+
+    def start(_notification)
+      @tests = {}
+      @run_start = Time.now.to_i
+    end
+
+    def example_started(notification)
+      @retries = 0
+
+      # Set up the object for use if it doesn't exist already
+      # It might, if retries
+      return if @tests.key?(notification.example.hash)
+
+      @tests[notification.example.hash] = {
+        name: notification.example.full_description,
+        suite: notification.example.example_group.name,
+        # We use id here because it's location + test scope, e.g. what we need to rerun the test
+        # Otherwise, this could is the location of the `it` - even if that's in a helper file unrelated to the test
+        filePath: notification.example.id,
+        extra: {
+          hash: notification.example.hash
+        }
+      }
+    end
+
+    # Gets hit if rspec-retry is enabled, for flaky support
+    def retry(example)
+      @retries += 1
+
+      # We add the previous traces here, because we only hit example_finished once
+      test = @tests[example.hash]
+      test[:extra][:previous_traces] = [] unless test[:extra].key?(:previous_traces)
+      backtrace_formatter = RSpec.configuration.backtrace_formatter
+      return unless example.exception
+
+      test[:extra][:previous_traces].push("#{example.exception.detailed_message}\n" + backtrace_formatter.format_backtrace(
+        example.exception.backtrace, example.metadata
+      ).join("\n"))
+    end
+
+    def example_finished(notification)
+      test = @tests[notification.example.hash]
+
+      test[:duration] = notification.example.execution_result.run_time * 1000
+      test[:start] = notification.example.execution_result.started_at.to_i
+      test[:stop] = notification.example.execution_result.finished_at.to_i
+
+      test[:status] = notification.example.execution_result.status.to_s
+      test[:rawStatus] = notification.example.execution_result.status
+
+      # If we passed but retries is >0, the test is flaky
+      test[:flaky] = test[:status] == 'passed' && @retries > 0
+      test[:retries] = @retries
+
+      # Attach error information, if any
+      exception = notification.example.exception
+      test[:message] = exception.detailed_message if exception
+
+      # 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.delete(:trace)
+      end
+      test[:trace] = notification.formatted_backtrace.join("\n") if exception
+    end
+
+    def stop(_notification)
+      # Build the final result object
+      result = {
+        results: {
+          tool: {
+            name: 'rspec'
+          },
+          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
+        }
+      }
+
+      @output.write(JSON.pretty_generate(result))
+    end
+  end
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: rspec-ctrf
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- James Meneghello
+- DUSC
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-01-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.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !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 RSpec 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/ctrf/r_spec_formatter.rb
+homepage: https://github.com/dusc-dev/rspec-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: RSpec formatter to output test results in CTRF (https://www.ctrf.io/) JSON
+  format.
+test_files: []