wsdirector-cli 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 28d6654bce4665a9d0c1434c33ba359e31adb6680c51aafc3ccb1c5a91b32d56
-  data.tar.gz: 6e9c3fd2cfe938ba5f8a5f3e3519204d93cd56d428fed93be89b4056e53f004e
+  metadata.gz: b02895fab166dd2d388f48dda802e02407e5b7866eb508f1b5787e1a4e1976d6
+  data.tar.gz: e0d5af5ae2de5caed7ccd151538e19ad3c49e08db1217e042f36540d69468314
 SHA512:
-  metadata.gz: 1ce990e199cd5562bb03760a8678349b74f549014cf997c821b3ad6f4518e7e45e349a26e89fcfb22762f2a775d57604bf84c35511dd5294097590e14389c47a
-  data.tar.gz: 0f4287fedbc4f0488e2a19fe59aa6de276da620345e9024bcd7baa5f04a473c1a5fd36556f9ba49f4a82575101934737df6d1d470069c85fa751436fbea16c0f
+  metadata.gz: '09af449361f79d80a4848b0851aa96ada36e363e997bba177e5d96b01005d1c241abee2a1a05781f3a5277de08732f3b1d8afaeaea467d2097050347d2ca295c'
+  data.tar.gz: 8deb112a900d7cdbc710be8b86d57aef8aeaa87bbec78595170bf309088bca9bb88fd58de503e2bcfb32b43df5e08903c322791eb10930aa0fb25f00e26afebb

data/CHANGELOG.md

@@ -2,6 +2,53 @@
 
 ## master
 
+## 0.5.0 (2021-10-13)
+
+- Add JSON support. ([@wazzuper][])
+
+- Add new commands to CLI.
+
+You can pass a JSON scenario directly to the CLI without creating a file:
+
+```bash
+wsdirector -i '[{"receive": {"data":"welcome"}},{"send":{"data":"send message"}},{"receive":{"data":"receive message"}}]' -u ws://websocket.server:9876
+```
+
+or you can pass it as a JSON file:
+
+```bash
+wsdirector scenario.json -u ws://websocket.server:9876
+```
+
+- Add loop option support. ([@last-in-japan][])
+
+You can specify a `loop` option to perform a similar set of actions multiple times:
+
+```yml
+  # script.yml
+  - client:
+      name: "listeners"
+      loop:
+        multiplier: ":scale" # :scale take number from -s param, and run :scale number of clients in this group
+        actions:
+          - receive:
+              data:
+                type: "welcome"
+          - send:
+              data:
+                command: "subscribe"
+                identifier: "{\"channel\":\"Channel\"}"
+          - receive:
+              data:
+                identifier: "{\"channel\":\"Channel\"}"
+                type: "confirm_subscription"
+          - wait_all
+          - receive:
+              multiplier: ":scale + 1"
+```
+
+Useful in combination with `:scale`.
+
 ## 0.4.0 (2020-08-24)
 
 - **Drop Ruby 2.4 support**. ([@palkan][])
@@ -64,3 +111,5 @@ Allows to handle multiple messages with unspecified order:
 [@palkan]: https://github.com/palkan
 [@Kirillvs]: https://github.com/Kirillvs
 [@Grandman]: https://github.com/Grandman
+[@wazzuper]: https://github.com/wazzuper
+[@last-in-japan]: https://github.com/last-in-japan

data/README.md

@@ -77,6 +77,45 @@ The simpliest scenario is just checking that socket is succesfully connected:
   # no actions
 ```
 
+Run with loop option:
+
+```yml
+  # script.yml
+  - client:
+      name: "listeners"
+      loop:
+        multiplier: ":scale" # :scale take number from -s param, and run :scale number of clients in this group
+        actions:
+          - receive:
+              data:
+                type: "welcome"
+          - send:
+              data:
+                command: "subscribe"
+                identifier: "{\"channel\":\"Channel\"}"
+          - receive:
+              data:
+                identifier: "{\"channel\":\"Channel\"}"
+                type: "confirm_subscription"
+          - wait_all
+          - receive:
+              multiplier: ":scale + 1"
+```
+
+Also you can pass a JSON file with some testing scripts:
+
+```bash
+wsdirector scenario.json ws://websocket.server:9876
+```
+
+or pass a JSON scenario directly to the CLI without creating a file:
+
+```bash
+wsdirector -i '[{"receive": {"data":"welcome"}},{"send":{"data":"send message"}},{"receive":{"data":"receive message"}}]' ws://websocket.server:9876
+```
+
+Type `wsdirector --help` to check all commands.
+
 ### Protocols
 
 WSDirector uses protocols to handle different actions.

data/lib/wsdirector/cli.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "optparse"
+require "uri"
 
 require "wsdirector"
 require "wsdirector/scenario_reader"
@@ -23,7 +24,7 @@ module WSDirector
       end
 
       scenario = WSDirector::ScenarioReader.parse(
-        WSDirector.config.scenario_path
+        WSDirector.config.scenario_path || WSDirector.config.json_scenario
       )
 
       if WSDirector::Runner.new(scenario).start
@@ -38,6 +39,9 @@ module WSDirector
 
     private
 
+    FILE_FORMAT = /.+.(json|yml)\z/.freeze
+    private_constant :FILE_FORMAT
+
     def parse_args!
       # rubocop: disable Metrics/LineLength
       parser = OptionParser.new do |opts|
@@ -51,6 +55,14 @@ module WSDirector
           WSDirector.config.sync_timeout = v
         end
 
+        opts.on("-i JSON", "--include=JSON", String, "Include JSON to parse") do |v|
+          WSDirector.config.json_scenario = v
+        end
+
+        opts.on("-u URL", "--url=URL", Object, "Websocket server URL") do |v|
+          WSDirector.config.ws_url = v
+        end
+
         opts.on("-c", "--[no-]color", "Colorize output") do |v|
           WSDirector.config.colorize = v
         end
@@ -64,15 +76,25 @@ module WSDirector
 
       parser.parse!
 
-      WSDirector.config.scenario_path = ARGV[0]
-      WSDirector.config.ws_url = ARGV[1]
+      WSDirector.config.scenario_path = ARGV.grep(FILE_FORMAT).last
 
-      raise(Error, "Scenario path is missing") if WSDirector.config.scenario_path.nil?
+      unless WSDirector.config.ws_url
+        WSDirector.config.ws_url = ARGV.grep(URI::DEFAULT_PARSER.make_regexp).last
+      end
 
-      raise(Error, "File doesn't exist #{WSDirector.config.scenario_path}") unless
-        File.file?(WSDirector.config.scenario_path)
+      check_for_errors
+    end
+
+    def check_for_errors
+      if WSDirector.config.json_scenario.nil?
+        raise(Error, "Scenario is missing") unless WSDirector.config.scenario_path
+
+        unless File.file?(WSDirector.config.scenario_path)
+          raise(Error, "File doesn't exist #{WSDirector.config.scenario_path}")
+        end
+      end
 
-      raise(Error, "Websocket server url is missing") if WSDirector.config.ws_url.nil?
+      raise(Error, "Websocket server url is missing") unless WSDirector.config.ws_url
     end
   end
 end

data/lib/wsdirector/client.rb

@@ -60,7 +60,7 @@ module WSDirector
 
     def ignored?(msg)
       return false unless @ignore
-      @ignore.any? { |pattern| msg =~ pattern }
+      @ignore.any? { |pattern| msg =~ Regexp.new(pattern) }
     end
   end
 end

data/lib/wsdirector/configuration.rb

@@ -3,8 +3,7 @@
 module WSDirector
   # WSDirector configuration
   class Configuration
-    attr_accessor :ws_url, :scenario_path, :colorize, :scale,
-      :sync_timeout
+    attr_accessor :ws_url, :scenario_path, :colorize, :scale, :sync_timeout, :json_scenario
 
     def initialize
       reset!

data/lib/wsdirector/ext/deep_dup.rb

@@ -29,6 +29,12 @@ module WSDirector
           end
         end
       end
+
+      refine ::Object do
+        def deep_dup
+          dup
+        end
+      end
     end
   end
 end

data/lib/wsdirector/protocols/base.rb

@@ -63,10 +63,10 @@ module WSDirector
           messages.nil? || messages.empty?
 
         expected =
-          Hash[messages.map do |msg|
+          messages.map do |msg|
             multiplier = parse_multiplier(msg.delete("multiplier") || "1")
             [msg["data"], multiplier]
-          end]
+          end.to_h
 
         total_expected = expected.values.sum
         total_received = 0

data/lib/wsdirector/protocols.rb

@@ -12,8 +12,10 @@ module WSDirector
   module Protocols # :nodoc:
     # Raised when received not expected message
     class UnmatchedExpectationError < WSDirector::Error; end
+
     # Raised when received message is unexpected
     class UnexpectedMessageError < WSDirector::Error; end
+
     # Raised when nothing has been received
     class NoMessageError < WSDirector::Error; end
 

data/lib/wsdirector/scenario_reader.rb

@@ -1,25 +1,47 @@
 # frozen_string_literal: true
 
 require "erb"
+require "json"
+require "wsdirector/ext/deep_dup"
 
 module WSDirector
-  # Read and parse YAML scenario
+  # Read and parse different scenarios
   class ScenarioReader
+    using WSDirector::Ext::DeepDup
+
     class << self
       include WSDirector::Utils
 
-      def parse(file_path)
-        contents = ::YAML.load(ERB.new(File.read(file_path)).result) # rubocop:disable Security/YAMLLoad
+      def parse(scenario)
+        contents =
+          if File.file?(scenario)
+            parse_file(scenario)
+          else
+            [JSON.parse(scenario)]
+          end.flatten
 
         if contents.first.key?("client")
+          contents = transform_with_loop(contents, multiple: true)
           parse_multiple_scenarios(contents)
         else
+          contents = transform_with_loop(contents)
           {"total" => 1, "clients" => [parse_simple_scenario(contents)]}
         end
       end
 
       private
 
+      JSON_FILE_FORMAT = /.+.(json)\z/.freeze
+      private_constant :JSON_FILE_FORMAT
+
+      def parse_file(file)
+        if file.match?(JSON_FILE_FORMAT)
+          JSON.parse(File.read(file))
+        else
+          ::YAML.load(ERB.new(File.read(file)).result) # rubocop:disable Security/YAMLLoad
+        end
+      end
+
       def handle_steps(steps)
         steps.flat_map.with_index do |step, id|
           if step.is_a?(Hash)
@@ -67,6 +89,22 @@ module WSDirector
         {"total" => total_count, "clients" => clients}
       end
 
+      def transform_with_loop(contents, multiple: false)
+        contents.flat_map do |content|
+          loop_data = content.dig("client", "loop") || content.dig("loop")
+          next content unless loop_data
+
+          loop_multiplier = parse_multiplier(loop_data["multiplier"] || "1")
+
+          if multiple
+            content["client"]["actions"] = (loop_data["actions"] * loop_multiplier).map(&:deep_dup)
+            content
+          else
+            loop_data["actions"] * loop_multiplier
+          end
+        end
+      end
+
       def parse_ingore(str)
         return unless str
 

data/lib/wsdirector/version.rb

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

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: wsdirector-cli
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Kirill Arkhipov
 - Grandman
 - palkan
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-24 00:00:00.000000000 Z
+date: 2021-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: websocket-client-simple
@@ -202,7 +202,7 @@ homepage: https://github.com/palkan/wsdirector
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -217,8 +217,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
 summary: Command line tool for testing websocket servers using scenarios.
 test_files: []