constable-rails 1.4.1 → 1.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 807163563a2d149b1f1267c2dd873ebc19e9948664b8311f4185676ac9698753
-  data.tar.gz: d7c59c367bf69908c0909b2bda248f2d5d0c320a8238bbea628ac203134105a5
+  metadata.gz: 04f058e6367c5b8a7739a80141601c3db8fc4f088ff1a040353cad17c435e4f8
+  data.tar.gz: 18ab049c33174d1028c94352c20612fb79c39ed6aee70bce6a462321a4916d32
 SHA512:
-  metadata.gz: 16458c866e5975ed485a03793c52c4d918b1191f8760ee45fd814d824857c943f5a848d268888e2d29334850b360d6f1df56e4cc1f619ad347f79c94a2bec0ae
-  data.tar.gz: 0e7fc08cf6105a1fea100ebbda9dc3d316444982fe5ed467b09e45c27f8d36577711f8f175dc020773724f1973f2748b9a0fd76b0d791d24f48e1afb15a31ed7
+  metadata.gz: 3f1e99fc5bbf329fc0bff1bfd9b35afb396ae1ac2f23a1db8f75be493507dce586ff604bf016749975e384f764637c79dfa53e44092f417f582fd63d6009e38f
+  data.tar.gz: 18ff4465d65894ee18dbe1e5d116ae1a4128798ed759d41dd894135dd0b30554ab95329301c2559079e35066ce8cfc489ec88fe40760ef6eeedcbfa7f547972c

data/CHANGELOG.md

@@ -5,6 +5,39 @@ All notable changes to this project are documented here. This project adheres to
 
 ## [Unreleased]
 
+## [1.4.2]
+
+### Cold cases run inside a parallel worker
+
+The defect recorded as known in 1.4.1, now understood and fixed. Two bugs, stacked, and
+the second one hid the first.
+
+**RSpec swallows errors in required files.** `Configuration#requires=` routes through
+`load_file_handling_errors`, which rescues anything raised while loading, reports it
+through a formatter, and sets `world.wants_to_quit = true`. Every later
+`ExampleGroup.run` then returns immediately. Constable points RSpec's streams at a
+throwaway `StringIO` — stdout belongs to the reporter — so that report went nowhere: the
+file loaded, the examples registered, and none of them ran. A forked worker produced no
+results, no error and no exception, and exited 0. Requires are now loaded directly, where
+an exception carries its own message and backtrace, and the quit flag is checked and
+surfaced if anything sets it anyway.
+
+**Not every database can be sharded.** With the error visible, the real cause was one
+line: worker setup renamed *every* database config to `<database>_<index>`, including
+connections that are not per-worker test data at all. Caseflow talks to a legacy Oracle
+system (VACOLS) alongside its own Postgres databases, and appending `_3` to an Oracle TNS
+service name produces:
+
+```
+OCIError: ORA-12162: TNS:net service name is incorrectly specified
+```
+
+raised inside a `before(:suite)` hook — which is exactly what RSpec was swallowing. Only
+adapters that per-worker copies make sense for are renamed now (postgresql, postgis,
+mysql2, trilogy, sqlite3). An external system stays shared by every worker, which is what
+it is for.
+
+
 ## [1.4.1]
 
 ### A parallel run that ran nothing is no longer a pass
@@ -712,7 +745,8 @@ Initial release.
 - Diff-based coverage gate — only lines changed in the current diff are held to the
   threshold. `constable beat` for the full picture, `--html` for a browsable report.
 
-[Unreleased]: https://github.com/Ray-Hughes/constable/compare/v1.4.1...HEAD
+[Unreleased]: https://github.com/Ray-Hughes/constable/compare/v1.4.2...HEAD
+[1.4.2]: https://github.com/Ray-Hughes/constable/compare/v1.4.1...v1.4.2
 [1.4.1]: https://github.com/Ray-Hughes/constable/compare/v1.4.0...v1.4.1
 [1.4.0]: https://github.com/Ray-Hughes/constable/compare/v1.3.3...v1.4.0
 [1.3.3]: https://github.com/Ray-Hughes/constable/compare/v1.3.2...v1.3.3

data/lib/constable/cold_case/rspec.rb

@@ -120,6 +120,7 @@ module Constable
             with_engine do
               collector  = Collector.new
               load_error = capture_load(path)
+              load_error ||= quit_flag_error(path)
               unless load_error
                 # After the file has loaded -- that load is what registers them -- and
                 # before its examples run. See #run_pending_before_suite_hooks.
@@ -306,10 +307,22 @@ module Constable
           requires = rspec_option_requires
           return if requires.empty?
 
-          # `requires=` rather than plain Kernel#require: it is RSpec's own accessor, and
-          # it puts `lib` and the default path (`spec`) on the load path first, which is
-          # what makes a bare `require "rails_helper"` resolve.
-          configuration.requires = requires
+          # Deliberately NOT `configuration.requires =`, which is RSpec's own accessor.
+          # That routes through Configuration#load_file_handling_errors, which rescues
+          # anything raised while loading, reports it through a formatter, and sets
+          # `world.wants_to_quit`. Since stdout belongs to Constable's reporter, RSpec's
+          # streams are a throwaway StringIO, so that report goes nowhere -- and every
+          # later ExampleGroup.run returns immediately. The file loads, the examples
+          # register, and none of them run. A forked worker produced no results, no error
+          # and no exception, and exited 0.
+          #
+          # So the load path is set up the same way and the requires are done here, where
+          # an exception is an exception and carries its own message and backtrace.
+          add_spec_load_paths!(configuration)
+          requires.each { |path| require path }
+          configuration.instance_variable_set(:@requires, requires)
+        rescue Constable::Error
+          raise
         rescue StandardError => e
           # A helper that will not load is the suite's problem to fix, and it will say so
           # loudly on the first file. Constable's job here is not to disappear.
@@ -317,6 +330,53 @@ module Constable
                           "Cold cases will run without it.", kind: :cold_case)
         end
 
+        # What `configuration.requires=` does before requiring anything: puts `lib` and the
+        # default path (`spec`) on the load path, which is what makes a bare
+        # `require "rails_helper"` resolve at all.
+        def add_spec_load_paths!(configuration)
+          default_path = configuration.default_path if configuration.respond_to?(:default_path)
+          ["lib", default_path].compact.uniq.each do |dir|
+            absolute = File.expand_path(dir, Constable.root)
+            $LOAD_PATH.unshift(absolute) if File.directory?(absolute) && !$LOAD_PATH.include?(absolute)
+          end
+        end
+
+        # RSpec does not let an error in a required file reach you.
+        # Configuration#load_file_handling_errors rescues anything raised while loading,
+        # reports it through `notify_non_example_exception`, and sets
+        # `world.wants_to_quit = true`. Every later ExampleGroup.run then returns
+        # immediately, so the file loads, the examples register, and none of them run.
+        #
+        # We point RSpec's output at a throwaway StringIO -- stdout belongs to the
+        # reporter -- so that report goes nowhere. The result was a forked worker that
+        # produced no results, no error and no exception, and exited 0. It took a probe
+        # inside the child to find that `wants_to_quit` was the difference.
+        #
+        # So: ask, and put the swallowed message back in front of the user.
+        def raise_if_loading_failed!(configuration, requires)
+          return unless ::RSpec.world.wants_to_quit
+
+          # Clear it, or every later file in this session inherits the flag and runs
+          # nothing either.
+          ::RSpec.world.wants_to_quit = false
+
+          raise Constable::Error,
+                "RSpec could not load #{requires.join(", ")} (from .rspec). " \
+                "#{swallowed_output(configuration)}".strip
+        end
+
+        # Whatever RSpec wrote about it before we could ask. Its streams are ours, so this
+        # is the only copy in existence.
+        def swallowed_output(configuration)
+          [configuration.error_stream, configuration.output_stream, configuration.deprecation_stream]
+            .uniq
+            .filter_map { |io| io.string.to_s.strip if io.respond_to?(:string) }
+            .reject(&:empty?)
+            .first.to_s
+        rescue StandardError
+          ""
+        end
+
         # Parsed by RSpec itself, so `.rspec`, `~/.rspec`, `.rspec-local` and SPEC_OPTS are
         # all read with its precedence rather than a guess at the format.
         def rspec_option_requires
@@ -372,6 +432,18 @@ module Constable
           configuration.start_time = ::RSpec::Core::Time.now if configuration.respond_to?(:start_time=)
         end
 
+        # Same swallowing, one level down: a `require` inside the spec file that fails is
+        # rescued by RSpec, flagged, and never surfaced. Without this the file reports as
+        # a clean run of zero tests.
+        def quit_flag_error(path)
+          return nil unless ::RSpec.world.wants_to_quit
+
+          ::RSpec.world.wants_to_quit = false
+          Constable::Error.new(
+            "RSpec stopped while loading #{path}. #{swallowed_output(::RSpec.configuration)}".strip
+          )
+        end
+
         # A file that won't even parse is news, not a crash. Report it as one errored
         # result so the run keeps going and the summary names the file.
         def capture_load(path)

data/lib/constable/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Constable
-  VERSION = "1.4.1"
+  VERSION = "1.4.2"
 end

data/lib/constable/worker_databases.rb

@@ -236,13 +236,32 @@ module Constable
     # Every database config for this environment, renamed to its per-worker sibling.
     # `_database=` is exactly how Rails' own TestDatabases does the renaming, and this
     # runs in a forked child, so the mutation dies with the worker.
+    # Adapters where "give each worker its own copy" is a thing that can be done at all.
+    #
+    # An app can hold connections Constable has no business renaming. Caseflow talks to a
+    # legacy Oracle system (VACOLS) alongside its own Postgres databases; appending `_3` to
+    # an Oracle TNS service name produces `ORA-12162: TNS:net service name is incorrectly
+    # specified`, and since that surfaces inside a `before(:suite)` hook, RSpec swallowed
+    # it and the worker ran nothing at all.
+    #
+    # An external system like that is shared by every worker on purpose: it is not
+    # per-worker test data, and there is no per-worker copy of it to make.
+    SHARDABLE_ADAPTERS = %w[postgresql postgis mysql2 trilogy sqlite3].freeze
+
+    def shardable_adapter?(db_config)
+      return false unless db_config.respond_to?(:adapter)
+
+      SHARDABLE_ADAPTERS.include?(db_config.adapter.to_s)
+    end
+
     def each_worker_config(index)
       configs = ::ActiveRecord::Base.configurations.configs_for(env_name: env_name,
                                                                 include_hidden: true)
       configs.each do |db_config|
-        db_config._database = "#{db_config.database}_#{index}"
         next unless db_config.database_tasks?
+        next unless shardable_adapter?(db_config)
 
+        db_config._database = "#{db_config.database}_#{index}"
         yield db_config
       end
     end

data/lib/generators/constable/templates/case_helper.rb.tt

@@ -180,6 +180,72 @@ end
 # -----------------------------------------------------------------------------
 
 Constable.configure do |c|
+  # --- Settings. Uncomment what you want; each is shown at its default. --------
+
+  # Workers default to `auto` -- processor count minus a little headroom, so the
+  # machine stays usable while the suite runs. Pin it when a CI container lies
+  # about its core count, or to rule parallelism out while debugging.
+  #
+  # c.parallel_workers = 4
+
+  # How a parallel worker gets a database of its own. Sharing one is not a
+  # speed/safety trade, it is a correctness bug: on SQLite the run dissolves into
+  # "database is locked", and on a client/server database tests quietly see each
+  # other's rows, which is worse because it looks like it worked.
+  #
+  #   :schema   rebuild <database>_<index> from schema.rb every run. What Rails
+  #             does for `rails test`, and correct by construction -- the
+  #             databases cannot drift, because they are thrown away each time.
+  #             The default, and the wrong choice only when it is slow or
+  #             impossible.
+  #   :reuse    keep them between runs. Faster (a big schema is not replayed per
+  #             worker), and the ONLY option that works when your schema cannot
+  #             rebuild the database by itself -- true of any app with Postgres
+  #             custom types, since CREATE TYPE has no schema.rb representation.
+  #             Run `constable prepare` once to build them, and again after a
+  #             migration; keeping them current is your job.
+  #   :off      do not shard, so do not fork. An explicit serial run: no attempt,
+  #             no warning. Correct, and as slow as one core.
+  #
+  # c.worker_databases = :reuse
+
+  # The live stream while the suite runs. The summary is identical either way.
+  #   :concise   one glyph per test, grouped per case (default)
+  #   :expanded  a line per test: glyph, description, duration -- so you can see
+  #              which test is hanging while it hangs, not afterwards
+  #
+  # c.output = :expanded
+
+  # Put a test on the docket by itself when it passed last run and failed this
+  # one. Off by default, and the reason is what jailing does: a jailed test is
+  # SKIPPED on every later run. On automatically, a suite with order-dependent
+  # tests quietly stops running things nobody chose to stop running.
+  #
+  # c.jail_flakes = true
+
+  # Rerun a failure in isolation before believing it. A test that then passes is
+  # flaky rather than broken: it gets a warrant instead of failing the build, and
+  # stays loudly visible until someone deals with it.
+  #
+  # c.warrants = true
+
+  # CI: fail the build when the warning count is not trending down. Warnings are
+  # cold-case files and `unsafe` blocks -- allowed, but visible.
+  #
+  # c.fail_on_warnings = true
+
+  # Diff-based coverage: only lines changed in the current diff are held to it.
+  #
+  # c.coverage           = true
+  # c.coverage_threshold = 90
+
+  # Your existing RSpec/Minitest files, run verbatim as cold cases through their
+  # own engine. `constable import --from=rspec` writes this for you.
+  #
+  # c.cold_cases = ["spec/**/*_spec.rb"]
+
+  # --- Code. This can only be written here. -----------------------------------
+
   # One-time global setup, run once per process before the whole suite. For
   # configuring the world -- drivers, adapters, formats -- and deliberately not
   # for creating records that tests then share. See the note at the bottom of

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: constable-rails
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 1.4.2
 platform: ruby
 authors:
 - Ray Hughes