rspec-abq 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f99eb724ca058a63aa026b82c6d9bfda4a5aaf98df3d7fc0485025db98e46b43
-  data.tar.gz: bcfa57ca1f21298e63f4feed8e3d845a1304c9db9915360146931eb0c521105f
+  metadata.gz: 2ba8b36702b47a05aa98804502a7050443fb867361e513f638f7c4e9565381d5
+  data.tar.gz: 58c935e604bd8924d47f9a24061e18cf59cdf92930a6f509957a27b65f3c2599
 SHA512:
-  metadata.gz: a95ccc0549bc1d46f79c25fbe7de2f7b3f88cd74474039333d8b72b31858bf4c903169e4b7bbb55cfb277b4844bcc7073a56eb87bc332bac82d41261de31ef6a
-  data.tar.gz: 9b497c0bd97ee1760a18077d88bfa3da9c0340393648d01a1a53d8ec4f91a95303303b5a329b933bd0212a246a83477f7912e1359aca9b5f5aac365ec9dc1cf3
+  metadata.gz: bb7bd9a6ca27be92b253fdaeb48498d8a63a4f700819278c3968221d4b4b0d2f7fdbe8a7e72c0f0af3494705f5b5c2dfbfb67623e4b5866c46bf126454dc8125
+  data.tar.gz: 745195f4be73d7d93499d50757b5f9e837d04b18a3973f6cd61c7c0e8d8721b7a8f3674744da57da004bb256c40c200f1f7fcc50693373d4d8a681e3b1ecf77d

data/LICENSE.md

@@ -0,0 +1,21 @@
+# MIT LICENSE
+
+Copyright (c) 2022 ReadWriteExecute, Inc. and contributors
+
+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

@@ -16,7 +16,9 @@ end
 
 And then execute:
 
-    $ bundle
+```
+bundle
+```
 
 ## Usage
 
@@ -26,6 +28,10 @@ Use the included binary with abq:
 abq test -- bundle exec rspec
 ```
 
+## Compatibility
+
+This gem is actively tested against rubies 2.6-3.1 and rspecs 3.5-3.12
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -38,7 +44,7 @@ use the release script, `./release_gem.rb`
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/rwx-research/rspec-abq. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at <https://github.com/rwx-research/rspec-abq>. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## Code of Conduct
 

data/lib/rspec/abq/extensions.rb

@@ -53,7 +53,9 @@ module RSpec
 
           should_run_context_hooks = descendant_filtered_examples.any?
           begin
-            RSpec.current_scope = :before_context_hook
+            if Gem::Version.new(RSpec::Core::Version::STRING) >= Gem::Version.new("3.11.0")
+              RSpec.current_scope = :before_context_hook
+            end
             run_before_context_hooks(new("before(:context) hook")) if should_run_context_hooks
 
             # If the next example to run is on the surface of this group, scan all
@@ -85,7 +87,9 @@ module RSpec
             RSpec.world.wants_to_quit = true if reporter.fail_fast_limit_met?
             false
           ensure
-            RSpec.current_scope = :after_context_hook
+            if Gem::Version.new(RSpec::Core::Version::STRING) >= Gem::Version.new("3.11.0")
+              RSpec.current_scope = :after_context_hook
+            end
             run_after_context_hooks(new("after(:context) hook")) if should_run_context_hooks
             reporter.example_group_finished(self)
           end

data/lib/rspec/abq/ordering.rb

@@ -4,7 +4,12 @@ module RSpec
     # and reading the ordering from `init_meta` to set up the current processes settings
     module Ordering
       # notably: we don't support custom orderings
-      SUPPORTED_ORDERINGS = [:defined, :recently_modified, :random]
+      SUPPORTED_ORDERINGS =
+        if Gem::Version.new(RSpec::Core::Version::STRING) >= Gem::Version.new("3.11.0")
+          [:defined, :recently_modified, :random]
+        else
+          [:defined, :random]
+        end
 
       # Raised when we experience an ordering that doesn't exist in SUPPORTED_ORDERINGS
       UnsupportedOrderingError = Class.new(StandardError)

data/lib/rspec/abq/version.rb

@@ -1,6 +1,6 @@
 module RSpec
   module Abq
     # current version!
-    VERSION = "0.1.0"
+    VERSION = "0.2.1"
   end
 end

data/lib/rspec/abq.rb

@@ -66,10 +66,16 @@ module RSpec
       Extensions.setup!
     end
 
+    # raised if we try to load rspec-abq twice
+    # perhaps RSpec or a plugin has changed behavior to break assumptions we've made with rspec-abq
+    AbqLoadedTwiceError = Class.new(StandardError)
+
     # @!visibility private
     # @return [Boolean]
     def self.setup_after_specs_loaded!
-      ENV[ABQ_RSPEC_PID] = Process.pid.to_s
+      fail AbqLoadedTwiceError, "tried to setup abq-rspec twice" if ENV[ABQ_RSPEC_PID]
+      ENV[ABQ_RSPEC_PID] ||= Process.pid.to_s
+
       # ABQ doesn't support writing example status to disk yet.
       # in its simple implementation, status persistance write the status of all tests which ends up hanging with under
       # abq because we haven't run most of the tests in this worker. (maybe it's running the tests?). In any case:
@@ -80,9 +86,13 @@ module RSpec
       if !!ENV[ABQ_GENERATE_MANIFEST] # the abq worker will set this env var if it needs a manifest
         RSpec::Abq::Manifest.write_manifest(RSpec.world.ordered_example_groups, RSpec.configuration.seed, RSpec.configuration.ordering_registry)
         # ... Maybe it's fine to just exit(0)
-        RSpec.world.wants_to_quit = true # ask rspec to exit
-        RSpec.configuration.error_exit_code = 0 # exit without error
-        RSpec.world.non_example_failure = true # exit has nothing to do with tests
+        if Gem::Version.new(RSpec::Core::Version::STRING) >= Gem::Version.new("3.10.0")
+          RSpec.world.wants_to_quit = true # ask rspec to exit
+          RSpec.configuration.error_exit_code = 0
+          RSpec.world.non_example_failure = true # exit has nothing to do with tests
+        else
+          exit(0)
+        end
         return true
       end
 
@@ -90,23 +100,22 @@ module RSpec
       # new rspec process
 
       # enabling colors allows us to pass through nicer error messages
-      RSpec.configuration.color_mode = :on
+
+      if Gem::Version.new(RSpec::Core::Version::STRING) >= Gem::Version.new("3.6.0")
+        RSpec.configuration.color_mode = :on
+      else
+        RSpec.configuration.color = true
+      end
 
       # the first message is the init_meta block of the manifest. This is used to share runtime configuration
       # information amongst worker processes. In RSpec, it is used to ensure that random ordering between workers
       # shares the same seed, so can be deterministic.
-      message = protocol_read
-      init_message = message["init_meta"]
-      if init_message
-        protocol_write(INIT_SUCCESS_MESSAGE)
-        # todo: get rid of this unless init_message.empty? as soon as the bug is fixed in abq
-        Ordering.setup!(init_message, RSpec.configuration) unless init_message.empty?
+      init_message = protocol_read
+      protocol_write(INIT_SUCCESS_MESSAGE)
+      # TODO: delete the check for empty init_meta when https://github.com/rwx-research/abq/pull/216 is merged
+      if !init_message["fast_exit"] && init_message["init_meta"].any?
+        Ordering.setup!(init_message["init_meta"], RSpec.configuration)
         fetch_next_example
-      else
-        # to support the old protocol, we don't depend on the initialization method, however we don't support random
-        # ordering via config, only via a shared command line seed. `abq test -- rspec --seed 4` will pass the
-        # deterministic seed to all workers.
-        fetch_next_example(message)
       end
       nil
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-abq
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Ayaz Hafiz
@@ -15,16 +15,22 @@ dependencies:
   name: rspec-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.11.0
+        version: 3.5.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 3.13.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 3.11.0
+        version: 3.13.0
 description: RSpec::Abq is an rspec plugin that replaces its ordering with one that
   is controlled by abq. It allows for parallelization of rspec on a single machine
   or across multiple workers.
@@ -35,6 +41,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE.md
 - README.md
 - lib/rspec/abq.rb
 - lib/rspec/abq/extensions.rb
@@ -44,13 +51,15 @@ files:
 - lib/rspec/abq/test_case.rb
 - lib/rspec/abq/version.rb
 homepage: https://github.com/rwx-research/rspec-abq
-licenses: []
+licenses:
+- MIT
 metadata:
   homepage_uri: https://github.com/rwx-research/rspec-abq
   bug_tracker_uri: https://github.com/rwx-research/rspec-abq/issues
   changelog_uri: https://github.com/rwx-research/rspec-abq/releases
   documentation_uri: https://rwx-research.github.io/rspec-abq/
   source_code_uri: https://github.com/rwx-research/rspec-abq
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths: