wsdirector-core 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9f1fd8da87e97c9a82a6f0505a8d4a7ef28a9dabb0a75809ee60b1739481e08c
-  data.tar.gz: 77f4c9ab2836f8f1e407c6376ee1b2d73b07ed1963770f5d38837bd24c5a598c
+  metadata.gz: e8f7c80b878147f8ceba30cff3c94398e7cf8196794d3b4b857ade3702b8a97f
+  data.tar.gz: dc767a46dc089ee5cbe7ff90227ddaa2bb23eee835264a436084dd5cf910e77a
 SHA512:
-  metadata.gz: 935e69a837cf42cb0bb3121a8f3f9b415534c492245b350549cf2f0f6a839f382a9e8167179c7db00c0157e4312d0a7efc6480fa9e5bac65076a3a20d9a26cd9
-  data.tar.gz: 61b7ee833e4a236167ef4ede04354b46d44bbc29cdc56b6caa05d3d28f5f0588131c933f3f5ab59833b1d74dfaca509b6a30f1b0bc3280591784b7cd211a448e
+  metadata.gz: c2a1d4aa0e1134344f2e4d94fb132153d90f071e48a541bef57e4ab26bf9d49227a9b646a6e3a226ff86d84995e54297933c9aa755db6374c5a8b107d741d4b8
+  data.tar.gz: cd9e6f0d9f2804fca5c3fff3dbccbcd6cc7cc3f1f4eafb9eba7846bf4c8b81cc96246ed1c0fc9be4721267406a97e6bb3e3173d6f7b0b8995f88a30b21dcb4ee

data/CHANGELOG.md

@@ -2,6 +2,18 @@
 
 ## 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][])
+
+- Add `loop` action to multiply several actions. ([@palkan][])
+
 ## 1.0.2 (2023-01-12)
 
 - Fix adding transpiled files to releases. ([@palkan][])

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

@@ -94,11 +94,14 @@ 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
     class Base
+      class ReceiveTimeoutError < StandardError
+      end
+
       include WSDirector::Utils
 
       def initialize(task, scale: 1, logger: nil, id: nil, color: nil)
@@ -115,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")
@@ -155,9 +158,11 @@ module WSDirector
       def receive(step)
         expected = step["data"] || PartialMatcher.new(step["data>"])
         ordered = step["ordered"]
+        timeout = step.fetch("timeout", 5).to_f
 
-        log { "Receive a message: #{expected.truncate(50)}" }
+        log { "Receive a message in #{timeout}s: #{expected.inspect.truncate(100)}" }
 
+        start = Time.now.to_f
         received = nil
 
         client.each_message do |msg, id|
@@ -170,14 +175,22 @@ module WSDirector
           if ordered
             raise UnmatchedExpectationError, prepare_receive_error(expected, received)
           end
+
+          if Time.now.to_f - start > timeout
+            raise ReceiveTimeoutError
+          end
         end
 
-        log(:done) { "Received a message: #{received&.truncate(50)}" }
-      rescue ThreadError
+        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
 
@@ -244,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/2.7/wsdirector/scenario_reader.rb

@@ -92,7 +92,12 @@ module WSDirector
           data["sample"] = [1, parse_multiplier(data["sample"])].max if data["sample"]
 
           multiplier = parse_multiplier(data.delete("multiplier") || "1")
-          Array.new(multiplier) { {"type" => type, "id" => id}.merge(data) }
+
+          if type == "loop"
+            handle_steps(data.fetch("actions")) * multiplier
+          else
+            Array.new(multiplier) { {"type" => type, "id" => id}.merge(data) }
+          end
         else
           {"type" => step, "id" => id}
         end

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,11 +94,14 @@ 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
     class Base
+      class ReceiveTimeoutError < StandardError
+      end
+
       include WSDirector::Utils
 
       def initialize(task, scale: 1, logger: nil, id: nil, color: nil)
@@ -115,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")
@@ -155,9 +158,11 @@ module WSDirector
       def receive(step)
         expected = step["data"] || PartialMatcher.new(step["data>"])
         ordered = step["ordered"]
+        timeout = step.fetch("timeout", 5).to_f
 
-        log { "Receive a message: #{expected.truncate(50)}" }
+        log { "Receive a message in #{timeout}s: #{expected.inspect.truncate(100)}" }
 
+        start = Time.now.to_f
         received = nil
 
         client.each_message do |msg, id|
@@ -170,14 +175,22 @@ module WSDirector
           if ordered
             raise UnmatchedExpectationError, prepare_receive_error(expected, received)
           end
+
+          if Time.now.to_f - start > timeout
+            raise ReceiveTimeoutError
+          end
         end
 
-        log(:done) { "Received a message: #{received&.truncate(50)}" }
-      rescue ThreadError
+        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
 
@@ -244,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.1/wsdirector/scenario_reader.rb

@@ -92,7 +92,12 @@ module WSDirector
           data["sample"] = [1, parse_multiplier(data["sample"])].max if data["sample"]
 
           multiplier = parse_multiplier(data.delete("multiplier") || "1")
-          Array.new(multiplier) { {"type" => type, "id" => id}.merge(data) }
+
+          if type == "loop"
+            handle_steps(data.fetch("actions")) * multiplier
+          else
+            Array.new(multiplier) { {"type" => type, "id" => id}.merge(data) }
+          end
         else
           {"type" => step, "id" => id}
         end

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

@@ -99,6 +99,9 @@ module WSDirector
 
     # Base protocol describes basic actions
     class Base
+      class ReceiveTimeoutError < StandardError
+      end
+
       include WSDirector::Utils
 
       def initialize(task, scale: 1, logger: nil, id: nil, color: nil)
@@ -155,9 +158,11 @@ module WSDirector
       def receive(step)
         expected = step["data"] || PartialMatcher.new(step["data>"])
         ordered = step["ordered"]
+        timeout = step.fetch("timeout", 5).to_f
 
-        log { "Receive a message: #{expected.truncate(50)}" }
+        log { "Receive a message in #{timeout}s: #{expected.inspect.truncate(100)}" }
 
+        start = Time.now.to_f
         received = nil
 
         client.each_message do |msg, id|
@@ -170,14 +175,22 @@ module WSDirector
           if ordered
             raise UnmatchedExpectationError, prepare_receive_error(expected, received)
           end
+
+          if Time.now.to_f - start > timeout
+            raise ReceiveTimeoutError
+          end
         end
 
-        log(:done) { "Received a message: #{received&.truncate(50)}" }
-      rescue ThreadError
+        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/scenario_reader.rb

@@ -92,7 +92,12 @@ module WSDirector
           data["sample"] = [1, parse_multiplier(data["sample"])].max if data["sample"]
 
           multiplier = parse_multiplier(data.delete("multiplier") || "1")
-          Array.new(multiplier) { {"type" => type, "id" => id}.merge(data) }
+
+          if type == "loop"
+            handle_steps(data.fetch("actions")) * multiplier
+          else
+            Array.new(multiplier) { {"type" => type, "id" => id}.merge(data) }
+          end
         else
           {"type" => step, "id" => id}
         end

data/lib/wsdirector/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module WSDirector
-  VERSION = "1.0.2"
+  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.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Vladimir Dementyev
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-12 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.3.11
+rubygems_version: 3.5.18
 signing_key:
 specification_version: 4
 summary: Scenario-based WebSocket black-box testing