rspec-abq 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 29210d070dba423ba2bb9aad82deb1df9e4a4fb01e70bec05b1d728d20e29d5e
-  data.tar.gz: 1771fe5b152192dd256b29cc412526fc275c381c1c697cec4a51b6ae5a4b0174
+  metadata.gz: 03b2ac40b5bb4d24a54abbaeb06c9e3705641cc27b5c247aa86972bf04095af4
+  data.tar.gz: 4d3095d28da6d63731dcd0a64c1c8968033f02155cf0755230e0ebc50854db57
 SHA512:
-  metadata.gz: 8f89f037b50d88458b443c534ec78e20d9bbf4661d81cf68774f2bd7438a588cace8a991dfe101d1a4424a98956e186ba20f65d51f47d837ff5237dbf4b00a4f
-  data.tar.gz: 22bf4931dc4ee3639334e1e91451e0577591c215ad279802560d8ae7256b56a31a93fcb495b932f9e490658aa2e1bc23e1100c29ed735b0515312f1e9dae2c6f
+  metadata.gz: 84005f5d7672dcbc96152d183fe5597f3da8da8d29ed88dc9c83ef5dbd6a70bda68c74589aa24e5e7bb191b43f156760cf4a095457a6059ba19adefe1fa86480
+  data.tar.gz: 493eb56209f8bc6049883a67122fb1ddc55818d7ef326d8d46cd8d40525a4c8003b92b897d36b10d3e3cc11a13112b0cfce9b50f3a63b36e21115be9eca1044f

data/lib/rspec/abq/version.rb

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

data/lib/rspec/abq.rb

@@ -148,8 +148,20 @@ module RSpec
       Extensions.setup!
     end
 
+    # Base ABQ error.
+    Error = Class.new(StandardError)
+
     # raised when check_configuration fails
-    UnsupportedConfigurationError = Class.new(StandardError)
+    UnsupportedConfigurationError = Class.new(Error)
+
+    # Failed to connect and initialize handshake.
+    ConnectionFailed = Class.new(Error)
+
+    # Communication between abq sockets follows the following protocol:
+    #   - The first 4 bytes an unsigned 32-bit integer (big-endian) representing
+    #     the size of the rest of the message.
+    #   - The rest of the message is a JSON-encoded payload.
+    ConnectionBroken = Class.new(Error)
 
     # raises if RSpec is configured in a way that's incompatible with rspec-abq
     def self.check_configuration!(config)
@@ -214,12 +226,16 @@ module RSpec
 
     # Creates the socket to communicate with the worker and sends the worker the protocol
     # @!visibility private
-    def self.socket
-      @socket ||= TCPSocket.new(*ENV[ABQ_SOCKET].split(":")).tap do |socket|
-        # 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(NATIVE_RUNNER_SPAWNED_MESSAGE, socket)
+    def self.socket(connect_timeout: 5)
+      @socket ||= begin
+        Socket.tcp(*ENV[ABQ_SOCKET].split(":"), connect_timeout: connect_timeout).tap do |socket|
+          # 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(NATIVE_RUNNER_SPAWNED_MESSAGE, socket)
+        end
+      rescue
+        raise ConnectionFailed, "Unable to connect to ABQ socket #{ENV[ABQ_SOCKET]}"
       end
     end
 
@@ -245,25 +261,18 @@ module RSpec
         end
     end
 
-    # Communication between abq sockets follows the following protocol:
-    #   - The first 4 bytes an unsigned 32-bit integer (big-endian) representing
-    #     the size of the rest of the message.
-    #   - The rest of the message is a JSON-encoded payload.
-    class AbqConnBroken < StandardError
-    end
-
     # Writes a message to an Abq socket using the 4-byte header protocol.
     #
     # @param socket [TCPSocket]
     # @param msg
     def self.protocol_write(msg, socket = Abq.socket)
       json_msg = JSON.dump msg
-      begin
-        socket.write [json_msg.bytesize].pack("N")
-        socket.write json_msg
-      rescue
-        raise AbqConnBroken
-      end
+      socket.write [json_msg.bytesize].pack("N")
+      socket.write json_msg
+    rescue SystemCallError, IOError
+      raise ConnectionBroken
+    rescue
+      raise Error
     end
 
     # Writes a message to an Abq socket using the 4-byte header protocol.
@@ -273,10 +282,16 @@ module RSpec
     def self.protocol_read(socket = Abq.socket)
       len_bytes = socket.read 4
       return :abq_done if len_bytes.nil?
+
       len = len_bytes.unpack1("N")
       json_msg = socket.read len
       return :abq_done if json_msg.nil?
+
       JSON.parse json_msg
+    rescue SystemCallError, IOError
+      raise ConnectionBroken
+    rescue
+      raise Error
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-abq
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Ayaz Hafiz
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-10 00:00:00.000000000 Z
+date: 2023-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-core