wsdirector-cli 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 12469915784ca778073f50ab6b6157c73c014bee
-  data.tar.gz: '09f32425b8005d8cade46678259222286f4eff8b'
+SHA256:
+  metadata.gz: 2baebc5541a7fa47137932138d2605c7d7c7666542ef1967a056b884660d06df
+  data.tar.gz: b1179e52ccc50773d88fae780ce58d6a7038b45ad3ae29ac52427f594301de05
 SHA512:
-  metadata.gz: 1985ee2404b98a54e9a63f40b35db59e139738f9d4d3f3eeb79bc451533f97f3a85c0f2abebdb5aa473e8a7f836a4597bdf058d6bd8cf8c016d85226545606b4
-  data.tar.gz: 55994d15c789a8f8c3bad3b2847a9d274a7ed581081e5928c071c6daeb6f4a1e2d225e844e7499364bf051982dca87cd28e4e9f4f563deb52c22bbe9087e1be6
+  metadata.gz: 79a5b74d539c88e58932f67e91730652a13f3051d753cd14539c5b55a8a410134e9b16bca26debff21aa51db7943a0263bb859b1ff68c0444d2e7ba0d617312c
+  data.tar.gz: 505976c437539b628b9325a0f3b7f423e55c4df33f29fc00476aaf2bbaf9f5e786cb6dc5bca9fb1cb10e6aca92dec9265e6a8fbfde704ecfc5be2734e6b4ec73

data/CHANGELOG.md

@@ -1,5 +1,35 @@
 # Change log
 
+## master
+
+## 0.3.0 (2018-05-02)
+
+- Add `debug` action and options. ([@palkan][])
+
+Allows to print arbitrary messages during the execution.
+
+- Add `sleep` action. ([@palkan][])
+
+- Add `receive_all` action. ([@palkan][])
+
+Allows to handle multiple messages with unspecified order:
+
+```yml
+- receive_all:
+    messages:
+      - data:
+          text: "Hello!"
+        multiplier: ":scale + :scale"
+        channel: "chat"
+        params:
+          id: 2
+      - data:
+          text: "message sent"
+        channel: "chat"
+        params:
+          id: 2
+```
+
 ## 0.2.0 (2017-11-05)
 
 - Initial version. ([@palkan][], [@Kirillvs][], [@Grandman][])

data/README.md

@@ -1,4 +1,5 @@
-[![Gem Version](https://badge.fury.io/rb/wsdirector-cli.svg)](https://rubygems.org/gems/wsdirector-cli) [![CircleCI](https://circleci.com/gh/palkan/wsdirector.svg?style=svg)](https://circleci.com/gh/palkan/wsdirector) 
+[![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) 
 
 # WebSocket Director
 
@@ -6,9 +7,6 @@ Command line tool for testing websocket servers using scenarios.
 
 Suitable for testing any websocket server implementation, like [Action Cable](https://github.com/rails/rails/tree/master/actioncable), [Websocket Eventmachine Server](https://github.com/imanel/websocket-eventmachine-server), [Litecable](https://github.com/palkan/litecable) and so on.
 
-<a href="https://evilmartians.com/">
-<img src="https://evilmartians.com/badges/sponsored-by-evil-martians.svg" alt="Sponsored by Evil Martians" width="236" height="54"></a>
-
 ## Installation
 
 ```bash
@@ -17,7 +15,7 @@ Suitable for testing any websocket server implementation, like [Action Cable](ht
 
 ## Usage
 
-Create YAML file with simle testing script:
+Create YAML file with simple testing script:
 
 ```yml
   # script.yml
@@ -43,7 +41,7 @@ You can create more complex scenarios with multiple client groups:
   - client: # first clients group
       name: "publisher" # optional group name
       multiplier: ":scale" # :scale take number from -s param, and run :scale number of clients in this group
-      actions: # 
+      actions:
         - receive:
             data: "Welcome"
         - wait_all # makes all clients in all groups wait untill every client get this point (global barrier)
@@ -133,6 +131,24 @@ Scenario:
             text: "hello"
 ```
 
+## Future Ideas
+
+- Report timings (per-client and aggregates)
+
+- File-less scenarios (JSON-encoded?), e.g.
+
+```shell
+wsdirector -i '{"receive": "hello"}' localhost:9898/ws
+```
+
+- Connection parameters (headers, query params, etc)
+
+- Testing frameworks integrations
+
+- Loading protocols dynamically
+
+- What else? [Submit an issue!](https://github.com/palkan/wsdirector/issues/new)
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/palkan/wsdirector.

data/lib/wsdirector-cli.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "wsdirector/cli"

data/lib/wsdirector.rb

@@ -6,6 +6,7 @@ require "json"
 
 require "wsdirector/version"
 require "wsdirector/configuration"
+require "wsdirector/utils"
 
 # Command line tool for testing websocket servers using scenarios.
 module WSDirector

data/lib/wsdirector/client.rb

@@ -1,13 +1,14 @@
 # frozen_string_literal: true
 
 require "websocket-client-simple"
+require "securerandom"
 
 module WSDirector
   # WebSocket client
   class Client
     WAIT_WHEN_EXPECTING_EVENT = 5
 
-    attr_reader :ws
+    attr_reader :ws, :id
 
     # Create new WebSocket client and connect to WSDirector
     # ws URL.
@@ -22,6 +23,7 @@ module WSDirector
       open = Concurrent::Promise.new
       client = self
 
+      @id = SecureRandom.hex(6)
       @ws = WebSocket::Client::Simple.connect(path) do |ws|
         ws.on(:open) do |_event|
           open.set(true)

data/lib/wsdirector/protocols.rb

@@ -12,6 +12,8 @@ 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/protocols/action_cable.rb

@@ -50,6 +50,20 @@ module WSDirector
         super("data" => { "identifier" => identifier, "message" => message })
       end
 
+      def receive_all(step)
+        messages = step["messages"]
+
+        return super if messages.nil? || messages.empty?
+
+        messages.each do |msg|
+          next unless msg.key?("channel")
+          identifier = extract_identifier(msg)
+          msg["data"] = { "identifier" => identifier, "message" => msg["data"] }
+        end
+
+        super
+      end
+
       private
 
       def extract_identifier(step)

data/lib/wsdirector/protocols/base.rb

@@ -1,9 +1,13 @@
 # frozen_string_literal: true
 
+require "time"
+
 module WSDirector
   module Protocols
     # Base protocol describes basic actions
     class Base
+      include WSDirector::Utils
+
       def initialize(task)
         @task = task
       end
@@ -18,14 +22,72 @@ module WSDirector
         public_send(type, step)
       end
 
+      # Sleeps for a specified number of seconds.
+      #
+      # If "shift" is provided than the initial value is
+      # shifted by random number from (-shift, shift).
+      #
+      # Set "debug" to true to print the delay time.
+      def sleep(step)
+        delay = step.fetch("time").to_f
+        shift = step.fetch("shift", 0).to_f
+
+        delay = delay - shift * rand + shift * rand
+
+        print("Sleep for #{delay}s") if step.fetch("debug", false)
+
+        Kernel.sleep delay if delay > 0
+      end
+
+      # Prints provided message
+      def debug(step)
+        print(step.fetch("message"))
+      end
+
       def receive(step)
         expected = step.fetch("data")
         received = client.receive
-        receive_matches?(expected, received)
+        raise UnmatchedExpectationError, prepare_receive_error(expected, received) unless
+          receive_matches?(expected, received)
       rescue ThreadError
         raise NoMessageError, "Expected to receive #{expected} but nothing has been received"
       end
 
+      # rubocop: disable Metrics/CyclomaticComplexity
+      def receive_all(step)
+        messages = step.delete("messages")
+        raise ArgumentError, "Messages array must be specified" if
+          messages.nil? || messages.empty?
+
+        expected =
+          Hash[messages.map do |msg|
+            multiplier = parse_multiplier(msg.delete("multiplier") || "1")
+            [msg["data"], multiplier]
+          end]
+
+        total_expected = expected.values.sum
+        total_received = 0
+
+        total_expected.times do
+          received = client.receive
+
+          total_received += 1
+
+          match = expected.find { |k, _| receive_matches?(k, received) }
+
+          raise UnexpectedMessageError, "Unexpected message received: #{received}" if
+            match.nil?
+
+          expected[match.first] -= 1
+          expected.delete(match.first) if expected[match.first].zero?
+        end
+      rescue ThreadError
+        raise NoMessageError,
+              "Expected to receive #{total_expected} messages " \
+              "but received only #{total_received}"
+      end
+      # rubocop: enable Metrics/CyclomaticComplexity
+
       def send(step)
         data = step.fetch("data")
         data = JSON.generate(data) if data.is_a?(Hash)
@@ -51,8 +113,7 @@ module WSDirector
       def receive_matches?(expected, received)
         received = JSON.parse(received) if expected.is_a?(Hash)
 
-        raise UnmatchedExpectationError, prepare_receive_error(expected, received) if
-          received != expected
+        received == expected
       end
 
       def prepare_receive_error(expected, received)
@@ -62,6 +123,10 @@ module WSDirector
              ++ got: #{received}
         MSG
       end
+
+      def print(msg)
+        $stdout.puts "DEBUG #{Time.now.iso8601}  client=#{client.id} #{msg}\n"
+      end
     end
   end
 end

data/lib/wsdirector/scenario_reader.rb

@@ -3,9 +3,9 @@
 module WSDirector
   # Read and parse YAML scenario
   class ScenarioReader
-    MULTIPLIER_FORMAT = /^[-+*\\\d ]+$/
-
     class << self
+      include WSDirector::Utils
+
       def parse(file_path)
         contents = YAML.load_file(file_path)
 
@@ -62,14 +62,6 @@ module WSDirector
         { "total" => total_count, "clients" => clients }
       end
 
-      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
-
-        eval(prepared) # rubocop:disable Security/Eval
-      end
-
       def parse_ingore(str)
         return unless str
 

data/lib/wsdirector/utils.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module WSDirector
+  module Utils # :nodoc:
+    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
+
+      eval(prepared) # rubocop:disable Security/Eval
+    end
+  end
+end

data/lib/wsdirector/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wsdirector-cli
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Kirill Arkhipov
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-05 00:00:00.000000000 Z
+date: 2018-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: websocket-client-simple
@@ -194,6 +194,7 @@ files:
 - LICENSE.txt
 - README.md
 - bin/wsdirector
+- lib/wsdirector-cli.rb
 - lib/wsdirector.rb
 - lib/wsdirector/cli.rb
 - lib/wsdirector/client.rb
@@ -209,6 +210,7 @@ files:
 - lib/wsdirector/runner.rb
 - lib/wsdirector/scenario_reader.rb
 - lib/wsdirector/task.rb
+- lib/wsdirector/utils.rb
 - lib/wsdirector/version.rb
 homepage: https://github.com/palkan/wsdirector
 licenses:
@@ -222,7 +224,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -230,7 +232,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.4
 signing_key: 
 specification_version: 4
 summary: Command line tool for testing websocket servers using scenarios.