wsdirector-core 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9f1fd8da87e97c9a82a6f0505a8d4a7ef28a9dabb0a75809ee60b1739481e08c
-  data.tar.gz: 77f4c9ab2836f8f1e407c6376ee1b2d73b07ed1963770f5d38837bd24c5a598c
+  metadata.gz: d062f547a78c242ffc0b863fc7cd0e9405fc8b4621791ca2bb30f077a6778885
+  data.tar.gz: c75f03818f180eb0ee202402272189ec23a2d53ad2dd28cc9657971b9abde523
 SHA512:
-  metadata.gz: 935e69a837cf42cb0bb3121a8f3f9b415534c492245b350549cf2f0f6a839f382a9e8167179c7db00c0157e4312d0a7efc6480fa9e5bac65076a3a20d9a26cd9
-  data.tar.gz: 61b7ee833e4a236167ef4ede04354b46d44bbc29cdc56b6caa05d3d28f5f0588131c933f3f5ab59833b1d74dfaca509b6a30f1b0bc3280591784b7cd211a448e
+  metadata.gz: a276cdde656fd94d4e019aa398d1bbce8509e57561bc318e9af681871d3647137f367db714c70eaaeea1b1722c81f19881c6fccb57db123885b4b6c04618ebe7
+  data.tar.gz: d735cf99e4c64f826ce23cf82bd66fbb2469066c3c660d05e30ed4c31610cff3498ea5d58b98558ce60ef007c34a1717326677f2457ac132a8bb43a7af401bc1

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 ## master
 
+## 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

@@ -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.truncate(100)}" }
 
+        start = Time.now.to_f
         received = nil
 
         client.each_message do |msg, id|
@@ -170,10 +175,14 @@ 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
+        log(:done) { "Received a message: #{received&.truncate(100)}" }
+      rescue ThreadError, ReceiveTimeoutError
         if received
           raise UnmatchedExpectationError, prepare_receive_error(expected, received)
         else

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/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.truncate(100)}" }
 
+        start = Time.now.to_f
         received = nil
 
         client.each_message do |msg, id|
@@ -170,10 +175,14 @@ 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
+        log(:done) { "Received a message: #{received&.truncate(100)}" }
+      rescue ThreadError, ReceiveTimeoutError
         if received
           raise UnmatchedExpectationError, prepare_receive_error(expected, received)
         else

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/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.truncate(100)}" }
 
+        start = Time.now.to_f
         received = nil
 
         client.each_message do |msg, id|
@@ -170,10 +175,14 @@ 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
+        log(:done) { "Received a message: #{received&.truncate(100)}" }
+      rescue ThreadError, ReceiveTimeoutError
         if received
           raise UnmatchedExpectationError, prepare_receive_error(expected, received)
         else

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.0.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wsdirector-core
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 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: 2023-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: websocket-client-simple
@@ -245,7 +245,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.11
+rubygems_version: 3.4.8
 signing_key:
 specification_version: 4
 summary: Scenario-based WebSocket black-box testing