reqcord 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b5479eb9ebc313b6b16250eb40692a664c4d7f56eba83a5875a061153714941
-  data.tar.gz: 61a8fa46ddcef53e0e318589d94fd485e25f7666a3042d2050d05138350db83b
+  metadata.gz: 87d47bb7440a886650db640312c804f7889a24420be0e1e2b81806ac4114a63c
+  data.tar.gz: d8198f3e86749a170c144bad28eae898f876c8e4a82ca933fa9d1a320204aaad
 SHA512:
-  metadata.gz: 3794123441aba25e1aa5a0fd5560ef280cda236ce4eee98b939f684d2cb40a6833b82358331cdf5a609b18076112901b7b9cefa623bea10145350a5d6f729205
-  data.tar.gz: 5b416b598625d8f76df50cdce032eafddd6102f0a00f364231f334c7d3939041b2e5d622adb801ee3e04ef00d61936ab0c75b1850c3018445954e78ea8236869
+  metadata.gz: 0f10290846b36da08d91f98998c8ef14c12427bf509bd8fb84d70a8b1f1bbec9dc389765e1b75be13d647f41000a1e295c39ffa89a70847c74ec84bb0e8ce3bf
+  data.tar.gz: e3c55c9f404b54b4ad2d284be04fc89f13ca5922c5ed52667c8ffad84fd808de3ef826e8b7ff97ad4e0dff8066a44af8122140cbfbb311257739c37b9430d088

data/CHANGELOG.md

@@ -1,6 +1,20 @@
 # Changelog
 
-## [0.1.3] - Unreleased
+## [0.1.4] - 2026-09-16
+
+### Changed
+
+* A failing test run no longer discards the output. The docs are generated
+  from what the suite captured, the warning names the exit status and the
+  report points out that routes reached only by failing tests are listed as
+  uncovered. The previous behaviour is `test.strict: true`.
+
+### Added
+
+* `test.strict` (`REQCORD_STRICT=1`): abort on a failing suite instead of
+  documenting what it captured.
+
+## [0.1.3] - 2026-09-16
 
 ### Added
 

data/docs/configuration.md

@@ -52,6 +52,7 @@ before any test runs. YAML aliases are disabled.
 | --- | --- |
 | `REQCORD_TEST_FRAMEWORK` | `test.framework` |
 | `REQCORD_TEST_COMMAND` | `test.command` (and therefore `test.paths`) |
+| `REQCORD_STRICT` | `test.strict` (`1` or `true`) |
 | `REQCORD_OUTPUT` | `output.directory` |
 | `REQCORD_BASE_URL` | `variables.base_url` |
 | `RESOURCE`, `VERSION` | run-time filters, see [Filtering a run](#filtering-a-run) |
@@ -123,9 +124,23 @@ absent.
 
 With neither `paths` nor `command`, Reqcord runs `bin/rails test`.
 
-Whatever runs must exit successfully. A failing suite aborts the run with
-`Reqcord::GenerationError` and nothing is written — documentation is only
-generated from a green suite.
+### `test.strict`
+
+Default `false`. What happens when the suite does not exit successfully:
+
+* `false` — the run continues and documents what the tests captured. A
+  warning names the exit status, and the report reminds you that routes
+  exercised only by failing tests show up as *uncovered*. A test that failed
+  on an assertion after its request got a `2xx` still counts: the request
+  and response are what the application really did.
+* `true` (or `REQCORD_STRICT=1`) — a failing suite aborts the run with
+  `Reqcord::GenerationError` and nothing is written. Use it in CI when the
+  generated docs are an artifact that must come from a green build.
+
+```yaml
+test:
+  strict: true
+```
 
 ---
 

data/examples/reqcord.yml

@@ -19,6 +19,11 @@ test:
   # Or spell the command out yourself; it wins over `paths`. Globs expand.
   # command: bin/rails test test/integration test/api
 
+  # A failing suite still documents what it captured; routes reached only by
+  # failing tests are listed as uncovered. `true` aborts instead
+  # (REQCORD_STRICT=1 per run).
+  # strict: false
+
 routes:
   # Only routes under this prefix are documented; a list works too:
   #   prefix: [/api, /partner]

data/lib/reqcord/configuration.rb

@@ -8,7 +8,11 @@ module Reqcord
       # No default command: with neither `command` nor `paths` the generator
       # falls back to `bin/rails test`, and `paths` alone must be able to win.
       "test" => {
-        "framework" => "minitest"
+        "framework" => "minitest",
+
+        # A red suite still documents what its green tests captured; strict
+        # runs abort instead, for CI that treats the docs as an artifact.
+        "strict" => false
       },
 
       "routes" => {
@@ -123,6 +127,13 @@ module Reqcord
       Array(data.dig("test", "paths")).map(&:to_s)
     end
 
+    # Abort on a failing suite instead of documenting what was captured.
+    def strict_tests?
+      value = ENV.fetch("REQCORD_STRICT") { data.dig("test", "strict") }
+
+      [true, "true", "1"].include?(value)
+    end
+
     # `prefix: /api` or `prefix: [/v1, /v2]`; a route under any of them is
     # documented. Empty means every route.
     def route_prefixes

data/lib/reqcord/generator.rb

@@ -56,6 +56,14 @@ module Reqcord
     # run can say why a request did not turn into documentation.
     attr_reader :unmatched_paths
 
+    # Exit status of the test run, so a caller can tell a fully green run
+    # from documentation generated out of a partly failing suite.
+    attr_reader :test_status
+
+    def tests_passed?
+      test_status.nil? || test_status.success?
+    end
+
     # Routes seen in the table but not documentable, by reason (redirect,
     # mount). Set by collect_routes; exposed so a run can be reconciled.
     attr_accessor :skipped_routes
@@ -161,6 +169,10 @@ module Reqcord
         Reqcord.log("skipped #{skipped_total} route(s) that cannot be documented: #{reasons}")
       end
 
+      unless tests_passed?
+        Reqcord.warn("the test run failed: routes exercised only by failing tests are listed as uncovered")
+      end
+
       return if unmatched_paths.empty?
 
       shown = unmatched_paths.uniq.first(5)
@@ -254,10 +266,19 @@ module Reqcord
           wait_thread.value
         end
 
+      @test_status = status
+
       return if status.success?
 
-      raise GenerationError,
-            "Test suite failed while generating Reqcord documentation"
+      if configuration.strict_tests?
+        raise GenerationError,
+              "Test suite failed while generating Reqcord documentation (test.strict is on)"
+      end
+
+      # A red suite still tells the truth about the requests that passed;
+      # dropping everything would hide the docs behind an unrelated failure.
+      Reqcord.warn("test run exited with status #{status.exitstatus}; documenting what it captured anyway")
+      Reqcord.warn("  set test.strict: true (or REQCORD_STRICT=1) to abort on a failing suite")
     end
 
     def read_exchanges(capture_file)

data/lib/reqcord/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Reqcord
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

data/lib/tasks/reqcord.rake

@@ -27,6 +27,10 @@ namespace :reqcord do
         # Or spell the command out yourself; it wins over `paths`.
         # command: bin/rails test test/integration test/api
 
+        # A failing suite still documents what it captured. Set true to abort
+        # instead (or run with REQCORD_STRICT=1).
+        # strict: false
+
       routes:
         # Only routes under this prefix are documented; a list works too
         # (`prefix: [/v1, /v2]`). Filter a single run with

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reqcord
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Ahmet Saridogan