wsdirector-cli 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2baebc5541a7fa47137932138d2605c7d7c7666542ef1967a056b884660d06df
-  data.tar.gz: b1179e52ccc50773d88fae780ce58d6a7038b45ad3ae29ac52427f594301de05
+  metadata.gz: 28d6654bce4665a9d0c1434c33ba359e31adb6680c51aafc3ccb1c5a91b32d56
+  data.tar.gz: 6e9c3fd2cfe938ba5f8a5f3e3519204d93cd56d428fed93be89b4056e53f004e
 SHA512:
-  metadata.gz: 79a5b74d539c88e58932f67e91730652a13f3051d753cd14539c5b55a8a410134e9b16bca26debff21aa51db7943a0263bb859b1ff68c0444d2e7ba0d617312c
-  data.tar.gz: 505976c437539b628b9325a0f3b7f423e55c4df33f29fc00476aaf2bbaf9f5e786cb6dc5bca9fb1cb10e6aca92dec9265e6a8fbfde704ecfc5be2734e6b4ec73
+  metadata.gz: 1ce990e199cd5562bb03760a8678349b74f549014cf997c821b3ad6f4518e7e45e349a26e89fcfb22762f2a775d57604bf84c35511dd5294097590e14389c47a
+  data.tar.gz: 0f4287fedbc4f0488e2a19fe59aa6de276da620345e9024bcd7baa5f04a473c1a5fd36556f9ba49f4a82575101934737df6d1d470069c85fa751436fbea16c0f

data/CHANGELOG.md

@@ -2,6 +2,33 @@
 
 ## master
 
+## 0.4.0 (2020-08-24)
+
+- **Drop Ruby 2.4 support**. ([@palkan][])
+
+- Add sampling support. ([@palkan][])
+
+You can specify a `sample` option for a step to only run this step by specified number of clients from the group:
+
+```yml
+- perform:
+  sample: ":scale / 2"
+  channel: "chat"
+  params:
+    id: 2
+  action: "speak"
+  data:
+    message: "Hello!"
+```
+
+Useful in combination with `:scale`.
+
+**NOTE:** Sample size is always greater or equal to 1.
+
+- Add ERB support. ([@palkan][])
+
+Now you can, for example, access `ENV` from scenarios.
+
 ## 0.3.0 (2018-05-02)
 
 - Add `debug` action and options. ([@palkan][])

data/README.md

@@ -1,5 +1,6 @@
 [![Cult Of Martians](http://cultofmartians.com/assets/badges/badge.svg)](http://cultofmartians.com/tasks/websocket-director.html)
-[![Gem Version](https://badge.fury.io/rb/wsdirector-cli.svg)](https://rubygems.org/gems/wsdirector-cli) [![Build Status](https://travis-ci.org/palkan/wsdirector.svg?branch=master)](https://travis-ci.org/palkan/wsdirector) [![CircleCI](https://circleci.com/gh/palkan/wsdirector.svg?style=svg)](https://circleci.com/gh/palkan/wsdirector) 
+[![Gem Version](https://badge.fury.io/rb/wsdirector-cli.svg)](https://rubygems.org/gems/wsdirector-cli)
+[![Build](https://github.com/palkan/wsdirector/workflows/Build/badge.svg)](https://github.com/palkan/wsdirector/actions)
 
 # WebSocket Director
 
@@ -10,7 +11,7 @@ Suitable for testing any websocket server implementation, like [Action Cable](ht
 ## Installation
 
 ```bash
-  $ gem install wsdirector-cli
+gem install wsdirector-cli
 ```
 
 ## Usage
@@ -61,7 +62,6 @@ You can create more complex scenarios with multiple client groups:
 
 Run with scale factor:
 
-
 ```bash
 wsdirector script.yml ws://websocket.server:9876 -s 10
 
@@ -153,7 +153,6 @@ wsdirector -i '{"receive": "hello"}' localhost:9898/ws
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/palkan/wsdirector.
 
-
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/wsdirector/cli.rb

@@ -9,7 +9,8 @@ require "wsdirector/runner"
 module WSDirector
   # Command line interface for WsDirector
   class CLI
-    def initialize; end
+    def initialize
+    end
 
     def run
       parse_args!
@@ -31,7 +32,7 @@ module WSDirector
         exit 1
       end
     rescue Error => e
-      STDERR.puts e.message
+      warn e.message
       exit 1
     end
 
@@ -55,7 +56,7 @@ module WSDirector
         end
 
         opts.on("-v", "--version", "Print versin") do
-          STDOUT.puts WSDirector::VERSION
+          $stdout.puts WSDirector::VERSION
           exit 0
         end
       end

data/lib/wsdirector/configuration.rb

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

data/lib/wsdirector/ext/deep_dup.rb

@@ -9,10 +9,10 @@ module WSDirector
         def deep_dup
           each_with_object(dup) do |(key, value), hash|
             hash[key] = if value.is_a?(::Hash) || value.is_a?(::Array)
-                          value.deep_dup
-                        else
-                          value
-                        end
+              value.deep_dup
+            else
+              value
+            end
           end
         end
       end

data/lib/wsdirector/protocols/action_cable.rb

@@ -4,7 +4,7 @@ module WSDirector
   module Protocols
     # ActionCable protocol
     class ActionCable < Base
-      WELCOME_MSG = { type: "welcome" }.to_json
+      WELCOME_MSG = {type: "welcome"}.to_json
       PING_IGNORE = /['"]type['"]:\s*['"]ping['"]/
 
       # Add ping ignore and make sure that we receive Welcome message
@@ -19,14 +19,14 @@ module WSDirector
       def subscribe(step)
         identifier = extract_identifier(step)
 
-        client.send({ command: "subscribe", identifier: identifier }.to_json)
+        client.send({command: "subscribe", identifier: identifier}.to_json)
 
         begin
           receive(
-            "data" => { "type" => "confirm_subscription", "identifier" => identifier }
+            "data" => {"type" => "confirm_subscription", "identifier" => identifier}
           )
         rescue UnmatchedExpectationError => e
-          raise unless e.message =~ /reject_subscription/
+          raise unless /reject_subscription/.match?(e.message)
           raise UnmatchedExpectationError, "Subscription rejected to #{identifier}"
         end
       end
@@ -39,7 +39,7 @@ module WSDirector
 
         data = step.fetch("data", {}).merge(action: action).to_json
 
-        client.send({ command: "message", data: data, identifier: identifier }.to_json)
+        client.send({command: "message", data: data, identifier: identifier}.to_json)
       end
 
       def receive(step)
@@ -47,7 +47,7 @@ module WSDirector
 
         identifier = extract_identifier(step)
         message = step.fetch("data", {})
-        super("data" => { "identifier" => identifier, "message" => message })
+        super("data" => {"identifier" => identifier, "message" => message})
       end
 
       def receive_all(step)
@@ -58,7 +58,7 @@ module WSDirector
         messages.each do |msg|
           next unless msg.key?("channel")
           identifier = extract_identifier(msg)
-          msg["data"] = { "identifier" => identifier, "message" => msg["data"] }
+          msg["data"] = {"identifier" => identifier, "message" => msg["data"]}
         end
 
         super

data/lib/wsdirector/protocols/base.rb

@@ -19,6 +19,9 @@ module WSDirector
       def handle_step(step)
         type = step.delete("type")
         raise Error, "Unknown step: #{type}" unless respond_to?(type)
+
+        return unless task.sampled?(step)
+
         public_send(type, step)
       end
 
@@ -83,8 +86,8 @@ module WSDirector
         end
       rescue ThreadError
         raise NoMessageError,
-              "Expected to receive #{total_expected} messages " \
-              "but received only #{total_received}"
+          "Expected to receive #{total_expected} messages " \
+          "but received only #{total_received}"
       end
       # rubocop: enable Metrics/CyclomaticComplexity
 

data/lib/wsdirector/result.rb

@@ -11,6 +11,9 @@ module WSDirector
 
       @all = Concurrent::AtomicFixnum.new(0)
       @failures = Concurrent::AtomicFixnum.new(0)
+
+      @sampling_mutex = Mutex.new
+      @sampling_counter = Hash.new { |h, k| h[k] = 0 }
     end
 
     # Called when client successfully finished it's work
@@ -37,8 +40,17 @@ module WSDirector
       failures.value
     end
 
+    def track_sample(id, max)
+      sampling_mutex.synchronize do
+        return false if sampling_counter[id] >= max
+
+        sampling_counter[id] += 1
+        true
+      end
+    end
+
     private
 
-    attr_reader :all, :success, :failures
+    attr_reader :all, :success, :failures, :sampling_counter, :sampling_mutex
   end
 end

data/lib/wsdirector/runner.rb

@@ -28,7 +28,7 @@ module WSDirector
         Array.new(client.fetch("multiplier")) do
           Thread.new do
             Task.new(client.deep_dup, global_holder: global_holder, result: result)
-                .run
+              .run
           end
         end
       end

data/lib/wsdirector/scenario_reader.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "erb"
+
 module WSDirector
   # Read and parse YAML scenario
   class ScenarioReader
@@ -7,32 +9,35 @@ module WSDirector
       include WSDirector::Utils
 
       def parse(file_path)
-        contents = YAML.load_file(file_path)
+        contents = ::YAML.load(ERB.new(File.read(file_path)).result) # rubocop:disable Security/YAMLLoad
 
         if contents.first.key?("client")
           parse_multiple_scenarios(contents)
         else
-          { "total" => 1, "clients" => [parse_simple_scenario(contents)] }
+          {"total" => 1, "clients" => [parse_simple_scenario(contents)]}
         end
       end
 
       private
 
       def handle_steps(steps)
-        steps.flat_map do |step|
+        steps.flat_map.with_index do |step, id|
           if step.is_a?(Hash)
             type, data = step.to_a.first
+
+            data["sample"] = [1, parse_multiplier(data["sample"])].max if data["sample"]
+
             multiplier = parse_multiplier(data.delete("multiplier") || "1")
-            Array.new(multiplier) { { "type" => type }.merge(data) }
+            Array.new(multiplier) { {"type" => type, "id" => id}.merge(data) }
           else
-            { "type" => step }
+            {"type" => step, "id" => id}
           end
         end
       end
 
       def parse_simple_scenario(
-          steps,
-          multiplier: 1, name: "default", ignore: nil, protocol: "base"
+        steps,
+        multiplier: 1, name: "default", ignore: nil, protocol: "base"
       )
         {
           "multiplier" => multiplier,
@@ -59,7 +64,7 @@ module WSDirector
             protocol: client.fetch("protocol", "base")
           )
         end
-        { "total" => total_count, "clients" => clients }
+        {"total" => total_count, "clients" => clients}
       end
 
       def parse_ingore(str)

data/lib/wsdirector/task.rb

@@ -28,6 +28,14 @@ module WSDirector
       result.failed(e.message)
     end
 
+    def sampled?(step)
+      return true unless step["sample"]
+
+      id, max = step["id"], step["sample"]
+
+      result.track_sample(id, max)
+    end
+
     private
 
     attr_reader :steps, :result, :protocol

data/lib/wsdirector/utils.rb

@@ -2,12 +2,12 @@
 
 module WSDirector
   module Utils # :nodoc:
-    MULTIPLIER_FORMAT = /^[-+*\\\d ]+$/
+    MULTIPLIER_FORMAT = /^[-+*\/\\\d ]+$/
 
     def parse_multiplier(str)
       prepared = str.to_s.gsub(":scale", WSDirector.config.scale.to_s)
       raise WSDirector::Error, "Unknown multiplier format: #{str}" unless
-        prepared =~ MULTIPLIER_FORMAT
+        MULTIPLIER_FORMAT.match?(prepared)
 
       eval(prepared) # rubocop:disable Security/Eval
     end

data/lib/wsdirector/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wsdirector-cli
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Kirill Arkhipov
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-02 00:00:00.000000000 Z
+date: 2020-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: websocket-client-simple
@@ -114,28 +114,28 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '1.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '1.16'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
@@ -166,20 +166,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.9'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.50'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.50'
 description: Command line tool for testing websocket servers using scenarios.
 email:
 - kirillvs@mail.ru
@@ -224,15 +210,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.4
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Command line tool for testing websocket servers using scenarios.