wsdirector-core 1.0.3 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d062f547a78c242ffc0b863fc7cd0e9405fc8b4621791ca2bb30f077a6778885
-  data.tar.gz: c75f03818f180eb0ee202402272189ec23a2d53ad2dd28cc9657971b9abde523
+  metadata.gz: e8f7c80b878147f8ceba30cff3c94398e7cf8196794d3b4b857ade3702b8a97f
+  data.tar.gz: dc767a46dc089ee5cbe7ff90227ddaa2bb23eee835264a436084dd5cf910e77a
 SHA512:
-  metadata.gz: a276cdde656fd94d4e019aa398d1bbce8509e57561bc318e9af681871d3647137f367db714c70eaaeea1b1722c81f19881c6fccb57db123885b4b6c04618ebe7
-  data.tar.gz: d735cf99e4c64f826ce23cf82bd66fbb2469066c3c660d05e30ed4c31610cff3498ea5d58b98558ce60ef007c34a1717326677f2457ac132a8bb43a7af401bc1
+  metadata.gz: c2a1d4aa0e1134344f2e4d94fb132153d90f071e48a541bef57e4ab26bf9d49227a9b646a6e3a226ff86d84995e54297933c9aa755db6374c5a8b107d741d4b8
+  data.tar.gz: cd9e6f0d9f2804fca5c3fff3dbccbcd6cc7cc3f1f4eafb9eba7846bf4c8b81cc96246ed1c0fc9be4721267406a97e6bb3e3173d6f7b0b8995f88a30b21dcb4ee

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 ## master
 
+## 1.1.0 (2024-10-04)
+
+- Support `stream_id`, `offset`, and `epoch` fields in Action Cable `receive`. ([@palkan][])
+
+- Add `print` option to `receive` action to print the received message. ([@palkan][])
+
 ## 1.0.3 (2023-10-03)
 
 - Add `timeout` option to receive to limit the amount of time we wait for the expected message. ([@palkan][])

data/lib/.rbnext/2.7/wsdirector/protocols/base.rb

@@ -94,7 +94,7 @@ module WSDirector
         "an object including #{obj.inspect}"
       end
 
-      def truncate(*__rest__, &__block__) ;  obj.truncate(*__rest__, &__block__); end
+      def truncate(*__rest__, &__block__) ;  obj.truncate(*__rest__, &__block__); end; respond_to?(:ruby2_keywords, true) && (ruby2_keywords :truncate)
     end
 
     # Base protocol describes basic actions
@@ -118,7 +118,7 @@ module WSDirector
         @client = build_client(*__rest__, &__block__)
 
         log(:done) { "Connected" }
-      end
+      end; respond_to?(:ruby2_keywords, true) && (ruby2_keywords :init_client)
 
       def handle_step(step)
         type = step.delete("type")
@@ -160,7 +160,7 @@ module WSDirector
         ordered = step["ordered"]
         timeout = step.fetch("timeout", 5).to_f
 
-        log { "Receive a message in #{timeout}s: #{expected.truncate(100)}" }
+        log { "Receive a message in #{timeout}s: #{expected.inspect.truncate(100)}" }
 
         start = Time.now.to_f
         received = nil
@@ -181,12 +181,16 @@ module WSDirector
           end
         end
 
+        if step["print"]
+          debug({"message" => received})
+        end
+
         log(:done) { "Received a message: #{received&.truncate(100)}" }
       rescue ThreadError, ReceiveTimeoutError
         if received
           raise UnmatchedExpectationError, prepare_receive_error(expected, received)
         else
-          raise NoMessageError, "Expected to receive #{expected} but nothing has been received"
+          raise NoMessageError, "Expected to receive #{expected.inspect} but nothing has been received"
         end
       end
 
@@ -253,7 +257,7 @@ module WSDirector
 
       def build_client(*__rest__, &__block__)
         Client.new(*__rest__, &__block__)
-      end
+      end; respond_to?(:ruby2_keywords, true) && (ruby2_keywords :build_client)
 
       def prepare_receive_error(expected, received)
         <<~MSG

data/lib/.rbnext/2.7/wsdirector/protocols/phoenix.rb

@@ -14,14 +14,14 @@ module WSDirector
         @refs_counter = 3
         @join_refs_counter = 3
         @topics_to_join_ref = {}
-      end
+      end; respond_to?(:ruby2_keywords, true) && (ruby2_keywords :initialize)
 
       def init_client(**options)
         options[:query] ||= {}
         # Make sure we use the v2 of the protocol
         options[:query][:vsn] = "2.0.0"
 
-        super(**options)
+        super
       end
 
       def join(step)

data/lib/.rbnext/3.0/wsdirector/ext/formatting.rb

@@ -5,7 +5,7 @@ module WSDirector
     # Extend Object through refinements
     module Formatting
       refine ::Object do
-        def truncate(*) ;  itself; end
+        def truncate(*__rest__) ;  itself; end
       end
 
       refine ::String do

data/lib/.rbnext/3.0/wsdirector/protocols/base.rb

@@ -94,7 +94,7 @@ module WSDirector
         "an object including #{obj.inspect}"
       end
 
-      def truncate(...) ;  obj.truncate(...); end
+      def truncate(...) ;  obj.truncate(...); end; respond_to?(:ruby2_keywords, true) && (ruby2_keywords :truncate)
     end
 
     # Base protocol describes basic actions
@@ -118,7 +118,7 @@ module WSDirector
         @client = build_client(...)
 
         log(:done) { "Connected" }
-      end
+      end; respond_to?(:ruby2_keywords, true) && (ruby2_keywords :init_client)
 
       def handle_step(step)
         type = step.delete("type")
@@ -160,7 +160,7 @@ module WSDirector
         ordered = step["ordered"]
         timeout = step.fetch("timeout", 5).to_f
 
-        log { "Receive a message in #{timeout}s: #{expected.truncate(100)}" }
+        log { "Receive a message in #{timeout}s: #{expected.inspect.truncate(100)}" }
 
         start = Time.now.to_f
         received = nil
@@ -181,12 +181,16 @@ module WSDirector
           end
         end
 
+        if step["print"]
+          debug({"message" => received})
+        end
+
         log(:done) { "Received a message: #{received&.truncate(100)}" }
       rescue ThreadError, ReceiveTimeoutError
         if received
           raise UnmatchedExpectationError, prepare_receive_error(expected, received)
         else
-          raise NoMessageError, "Expected to receive #{expected} but nothing has been received"
+          raise NoMessageError, "Expected to receive #{expected.inspect} but nothing has been received"
         end
       end
 
@@ -253,7 +257,7 @@ module WSDirector
 
       def build_client(...)
         Client.new(...)
-      end
+      end; respond_to?(:ruby2_keywords, true) && (ruby2_keywords :build_client)
 
       def prepare_receive_error(expected, received)
         <<~MSG

data/lib/.rbnext/3.1/wsdirector/protocols/action_cable.rb

@@ -11,7 +11,7 @@ module WSDirector
         options[:ignore] ||= [PING_IGNORE]
         options[:subprotocol] ||= "actioncable-v1-json"
 
-        super(**options)
+        super
 
         receive("data>" => {"type" => "welcome"})
         log(:done) { "Welcomed" }
@@ -64,7 +64,11 @@ module WSDirector
         key = step.key?("data") ? "data" : "data>"
 
         message = step.fetch(key, {})
-        super(key => {"identifier" => identifier, "message" => message})
+
+        # Move all protocol-level fields to data
+        step[key] = {"identifier" => identifier, "message" => message}.merge(step.slice("offset", "stream_id", "epoch"))
+
+        super
       end
 
       def receive_all(step)
@@ -78,7 +82,7 @@ module WSDirector
 
           key = msg.key?("data") ? "data" : "data>"
 
-          msg[key] = {"identifier" => identifier, "message" => msg[key]}
+          msg[key] = {"identifier" => identifier, "message" => msg[key]}.merge(step.slice("offset", "stream_id", "epoch"))
         end
 
         super
@@ -88,7 +92,7 @@ module WSDirector
 
       def extract_identifier(step)
         channel = step.delete("channel")
-        step.fetch("params", {}).merge(channel: channel).to_json
+        (step.delete("params") || {}).merge(channel: channel).to_json
       end
     end
   end

data/lib/.rbnext/3.1/wsdirector/protocols/phoenix.rb

@@ -14,14 +14,14 @@ module WSDirector
         @refs_counter = 3
         @join_refs_counter = 3
         @topics_to_join_ref = {}
-      end
+      end; respond_to?(:ruby2_keywords, true) && (ruby2_keywords :initialize)
 
       def init_client(**options)
         options[:query] ||= {}
         # Make sure we use the v2 of the protocol
         options[:query][:vsn] = "2.0.0"
 
-        super(**options)
+        super
       end
 
       def join(step)

data/lib/.rbnext/3.2/wsdirector/ext/formatting.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module WSDirector
+  module Ext
+    # Extend Object through refinements
+    module Formatting
+      refine ::Object do
+        def truncate(*__rest__) = itself
+      end
+
+      refine ::String do
+        def truncate(limit)
+          return self if size <= limit
+
+          "#{self[0..(limit - 3)]}..."
+        end
+      end
+
+      refine ::Hash do
+        def truncate(limit)
+          str = to_json
+
+          str.truncate(limit)
+        end
+      end
+
+      refine ::Float do
+        def duration
+          if self > 1
+            "#{truncate(2)}s"
+          else
+            "#{(self * 1000).to_i}ms"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/wsdirector/protocols/action_cable.rb

@@ -11,7 +11,7 @@ module WSDirector
         options[:ignore] ||= [PING_IGNORE]
         options[:subprotocol] ||= "actioncable-v1-json"
 
-        super(**options)
+        super
 
         receive("data>" => {"type" => "welcome"})
         log(:done) { "Welcomed" }
@@ -64,7 +64,11 @@ module WSDirector
         key = step.key?("data") ? "data" : "data>"
 
         message = step.fetch(key, {})
-        super(key => {"identifier" => identifier, "message" => message})
+
+        # Move all protocol-level fields to data
+        step[key] = {"identifier" => identifier, "message" => message}.merge(step.slice("offset", "stream_id", "epoch"))
+
+        super
       end
 
       def receive_all(step)
@@ -78,7 +82,7 @@ module WSDirector
 
           key = msg.key?("data") ? "data" : "data>"
 
-          msg[key] = {"identifier" => identifier, "message" => msg[key]}
+          msg[key] = {"identifier" => identifier, "message" => msg[key]}.merge(step.slice("offset", "stream_id", "epoch"))
         end
 
         super
@@ -88,7 +92,7 @@ module WSDirector
 
       def extract_identifier(step)
         channel = step.delete("channel")
-        step.fetch("params", {}).merge(channel: channel).to_json
+        (step.delete("params") || {}).merge(channel: channel).to_json
       end
     end
   end

data/lib/wsdirector/protocols/base.rb

@@ -160,7 +160,7 @@ module WSDirector
         ordered = step["ordered"]
         timeout = step.fetch("timeout", 5).to_f
 
-        log { "Receive a message in #{timeout}s: #{expected.truncate(100)}" }
+        log { "Receive a message in #{timeout}s: #{expected.inspect.truncate(100)}" }
 
         start = Time.now.to_f
         received = nil
@@ -181,12 +181,16 @@ module WSDirector
           end
         end
 
+        if step["print"]
+          debug({"message" => received})
+        end
+
         log(:done) { "Received a message: #{received&.truncate(100)}" }
       rescue ThreadError, ReceiveTimeoutError
         if received
           raise UnmatchedExpectationError, prepare_receive_error(expected, received)
         else
-          raise NoMessageError, "Expected to receive #{expected} but nothing has been received"
+          raise NoMessageError, "Expected to receive #{expected.inspect} but nothing has been received"
         end
       end
 

data/lib/wsdirector/protocols/phoenix.rb

@@ -21,7 +21,7 @@ module WSDirector
         # Make sure we use the v2 of the protocol
         options[:query][:vsn] = "2.0.0"
 
-        super(**options)
+        super
       end
 
       def join(step)

data/lib/wsdirector/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module WSDirector
-  VERSION = "1.0.3"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wsdirector-core
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.1.0
 platform: ruby
 authors:
 - Vladimir Dementyev
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-03 00:00:00.000000000 Z
+date: 2024-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: websocket-client-simple
@@ -207,6 +207,7 @@ files:
 - lib/.rbnext/3.1/wsdirector/runner.rb
 - lib/.rbnext/3.1/wsdirector/scenario_reader.rb
 - lib/.rbnext/3.1/wsdirector/task.rb
+- lib/.rbnext/3.2/wsdirector/ext/formatting.rb
 - lib/wsdirector-cli.rb
 - lib/wsdirector.rb
 - lib/wsdirector/cli.rb
@@ -245,7 +246,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.8
+rubygems_version: 3.5.18
 signing_key:
 specification_version: 4
 summary: Scenario-based WebSocket black-box testing