rspec-abq 1.0.1 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b166fd4c2ba3722370ca2dad745e0d5e5267de565934dfe5091012b86a41a9b
-  data.tar.gz: 4d493113ceefa919ad5429fbf290373def78fa3eeea9bcc20e13d7c49f17f96c
+  metadata.gz: bc4f520d1b869e03a972436e4b3eeddb42ce1c3a88db2b944e7ce8d654ac6c25
+  data.tar.gz: 8608c3bc156d2789596d3b8606aa7d5a164ddbefce1d58ca1243dddf9a006bb6
 SHA512:
-  metadata.gz: a50ab4b5fdd2e94bcaac06f3947d4ae3116f0182a54e107db90b99c3abb51a24545d063af4ab9b1397c20d3a9df66da14dbb65bed695cd252227180efd866827
-  data.tar.gz: 4d1ad622e266f237285fc18e26b0ad7dc96de1902cb85051555643c26abb6fc8461551a5f834b49f21d3fcf7c7433a2d82ee539a4bf67ef99ab7e9f8b77ac8a4
+  metadata.gz: ac6d181459d36293e661b141f2c0a685ed9a40feb70a877f0fb9b645ba58e4e1d73397c7e1c264545709df3ef610ee42170cf4b1a703d05dc0f50c53f919bb33
+  data.tar.gz: fc5e6cc4d5435fd27552de89b6bfd1cf0a59a077b5f571c20c44788638dbcfb8a9e5cc449338b87a10dc9ccf5b9b8f5b25efb031e16f36d7d8c9de8e887a1203

data/README.md

@@ -16,7 +16,7 @@ end
 
 And then execute:
 
-```
+```bash
 bundle
 ```
 
@@ -24,10 +24,16 @@ bundle
 
 Use the included binary with abq:
 
-```
+```bash
 abq test -- bundle exec rspec
 ```
 
+If abq displays "Worker quit before sending protocol version", try adding this line to your application's `spec/spec_helper.rb`:
+
+```ruby
+require 'rspec/abq'
+```
+
 ## Compatibility
 
 This gem is actively tested against rubies 2.6-3.1 and rspecs 3.5-3.12

data/lib/rspec/abq/extensions.rb

@@ -125,7 +125,16 @@ module RSpec
             end
           end
 
-          exit_code(examples_passed)
+          if Abq.target_test_case != Abq::TestCase.end_marker
+            warn "Hit end of test run without being on end marker. Target test case is #{Abq.target_test_case.inspect}"
+            example_passed = false
+          end
+
+          if Gem::Version.new(RSpec::Core::Version::STRING) >= Gem::Version.new("3.10.0")
+            exit_code(examples_passed)
+          else
+            example_passed ? 0 : @configuration.failure_exit_code
+          end
         end
 
         private

data/lib/rspec/abq/test_case.rb

@@ -37,7 +37,7 @@ module RSpec
       # @param outer [Array<String>] parsed scope
       # @param inner [Array<String>] parsed scope
       def self.scope_leftover(outer, inner)
-        inner[outer.length..-1] || []
+        inner[outer.length..] || []
       end
 
       # @param group [RSpec::Core::ExampleGroup]

data/lib/rspec/abq/version.rb

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

data/lib/rspec/abq.rb

@@ -29,14 +29,35 @@ module RSpec
     ABQ_RSPEC_PID = "ABQ_RSPEC_PID"
 
     # The [ABQ protocol version message](https://www.notion.so/rwx/ABQ-Worker-Native-Test-Runner-IPC-Interface-0959f5a9144741d798ac122566a3d887#8587ee4fd01e41ec880dcbe212562172).
-    # Must be sent to ABQ_SOCKET on startup.
     # @!visibility private
-    PROTOCOL_VERSION_MESSAGE = {
+    PROTOCOL_VERSION = {
       type: "abq_protocol_version",
       major: 0,
       minor: 1
     }
 
+    # The [rspec-abq specification](https://www.notion.so/rwx/ABQ-Worker-Native-Test-Runner-IPC-Interface-0959f5a9144741d798ac122566a3d887#8587ee4fd01e41ec880dcbe212562172).
+    # @!visibility private
+    NATIVE_RUNNER_SPECIFICATION = {
+      type: "abq_native_runner_specification",
+      name: "rspec-abq",
+      version: RSpec::Abq::VERSION,
+      test_framework: "rspec",
+      test_framework_version: RSpec::Core::Version::STRING,
+      language: RUBY_ENGINE,
+      language_version: "#{RUBY_VERSION}p#{RUBY_PATCHLEVEL}",
+      host: RUBY_DESCRIPTION
+    }
+
+    # The [rpsec-abq spawned message](https://www.notion.so/rwx/ABQ-Worker-Native-Test-Runner-IPC-Interface-0959f5a9144741d798ac122566a3d887#8587ee4fd01e41ec880dcbe212562172).
+    # Must be sent to ABQ_SOCKET on startup.
+    # @!visibility private
+    NATIVE_RUNNER_SPAWNED_MESSAGE = {
+      type: "abq_native_runner_spawned",
+      protocol_version: PROTOCOL_VERSION,
+      runner_specification: NATIVE_RUNNER_SPECIFICATION
+    }
+
     # The [ABQ initialization success
     # message](https://www.notion.so/rwx/ABQ-Worker-Native-Test-Runner-IPC-Interface-0959f5a9144741d798ac122566a3d887#538582a3049f4934a5cb563d815c1247)
     # Must be sent after receiving the ABQ initialization message.
@@ -85,14 +106,6 @@ module RSpec
       # before abq can start workers, it asks for a manifest
       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)
-        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
 
@@ -113,10 +126,10 @@ module RSpec
       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
-      unless init_message["fast_exit"]
-        Ordering.setup!(init_message["init_meta"], RSpec.configuration)
-        fetch_next_example
-      end
+      return true if init_message["fast_exit"]
+
+      Ordering.setup!(init_message["init_meta"], RSpec.configuration)
+      fetch_next_example
       nil
     end
 
@@ -127,7 +140,7 @@ module RSpec
         # Messages sent to/received from the ABQ worker should be done so ASAP.
         # Since we're on a local network, we don't care about packet reduction here.
         socket.setsockopt(Socket::IPPROTO_TCP, Socket::TCP_NODELAY, 1)
-        protocol_write(PROTOCOL_VERSION_MESSAGE, socket)
+        protocol_write(NATIVE_RUNNER_SPAWNED_MESSAGE, socket)
       end
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-abq
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.3
 platform: ruby
 authors:
 - Ayaz Hafiz
@@ -31,6 +31,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: 3.13.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.1
 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.