anyt 1.2.3 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 98e0ff916d9b26a1c59c1590deaf1991e5b03e9307d9939069d2a7f16360c8a5
-  data.tar.gz: 8e425053f5af7706d9a3ea478d6b08e43ef6b7fe15f58fa0c97800c6aafcaff8
+  metadata.gz: 6565c7892e2d696ae9f572a557be099c8cf3fff66182d65cd5d784916f97e4bd
+  data.tar.gz: 98975a1b4659126da5ba39380cb6ec218dc9c6c38a7970d90d9a6865cab768c5
 SHA512:
-  metadata.gz: ef09aae331254a361fe2f62d5f0d00bcac7c1f353c90f88f225cbff3d3e16b145e1225c28d026c3aabe5bac01bcef52944f6a5a4846d48ff4f0ff0841d5ae1ac
-  data.tar.gz: 06ecdbdf18997b6ed3e7e4d13a8a68069b35bcd1db124c27cbcb11c739e68abbd7e168b655cf0b1c366d3ab0d72b6e9d65394472c5135e9b31d25790e13124a7
+  metadata.gz: ea3d7302dd78f6aeee2de72760cfcb48b53c298109830aac85dace3e5ddc35c191457d7ea846f1f99cc97f4fbf25bc6b6bb7b0284d50d0ff2c5f49f32ce6c734
+  data.tar.gz: 9fdf6962eaa713eb3581359e78f7d2090af6b73dd2997ef7906ba98d0483b17c47dfd55f7866709e56b69ae02eb118d7b494dbc3481c5fce8bf6a230822a2772

data/README.md

@@ -2,9 +2,10 @@
 [![Gem Version](https://badge.fury.io/rb/anyt.svg)](https://rubygems.org/gems/anyt)
 ![Test](https://github.com/anycable/anyt/workflows/Test/badge.svg)
 
-# AnyCable Conformance Testing Tool
+# Action Cable / AnyCable conformance testing tool
+
+AnyT is a command-line tool to test your Action Cable or [AnyCable](http://anycable.io)-compatible WebSocket servers.
 
-AnyT is a command-line tool to test your [AnyCable](http://anycable.io)-compatible WebSocket servers.
 It contains a set of tests to determine which features are supported by the implementation under consideration.
 
 ## Installation

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: anyt
 version: !ruby/object:Gem::Version
-  version: 1.2.3
+  version: 1.3.0
 platform: ruby
 authors:
 - palkan
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-23 00:00:00.000000000 Z
+date: 2024-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rack
+  name: anyt-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 1.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 1.3.0
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -52,34 +52,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.1.0
-- !ruby/object:Gem::Dependency
-  name: rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '6.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '6.0'
-- !ruby/object:Gem::Dependency
-  name: anyway_config
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.2.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.2.0
 - !ruby/object:Gem::Dependency
   name: anycable-rails
   requirement: !ruby/object:Gem::Requirement
@@ -114,48 +86,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
-- !ruby/object:Gem::Dependency
-  name: websocket
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.2.4
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.2.4
-- !ruby/object:Gem::Dependency
-  name: websocket-client-simple
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.3.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.3.0
-- !ruby/object:Gem::Dependency
-  name: concurrent-ruby
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: childprocess
   requirement: !ruby/object:Gem::Requirement
@@ -204,15 +134,15 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: '6.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.6'
-description: Anycable conformance testing tool
+        version: '6.0'
+description: Action Cable / AnyCable conformance testing tool
 email:
 - dementiev.vm@gmail.com
 executables:
@@ -223,42 +153,6 @@ files:
 - MIT-LICENSE
 - README.md
 - bin/anyt
-- bin/console
-- bin/setup
-- lib/anyt.rb
-- lib/anyt/cli.rb
-- lib/anyt/client.rb
-- lib/anyt/command.rb
-- lib/anyt/config.rb
-- lib/anyt/dummy/application.rb
-- lib/anyt/dummy/config.ru
-- lib/anyt/dummy/routes.rb
-- lib/anyt/dummy/tmp/development_secret.txt
-- lib/anyt/ext/minitest.rb
-- lib/anyt/remote_control.rb
-- lib/anyt/rpc.rb
-- lib/anyt/tests.rb
-- lib/anyt/tests/core/ping_test.rb
-- lib/anyt/tests/core/welcome_test.rb
-- lib/anyt/tests/features/channel_state_test.rb
-- lib/anyt/tests/features/remote_disconnect_test.rb
-- lib/anyt/tests/features/server_restart_test.rb
-- lib/anyt/tests/request/channel_test.rb
-- lib/anyt/tests/request/connection_test.rb
-- lib/anyt/tests/request/disconnect_reasons_test.rb
-- lib/anyt/tests/request/disconnection_test.rb
-- lib/anyt/tests/streams/broadcast_test.rb
-- lib/anyt/tests/streams/multiple_clients_test.rb
-- lib/anyt/tests/streams/multiple_test.rb
-- lib/anyt/tests/streams/single_test.rb
-- lib/anyt/tests/streams/stop_test.rb
-- lib/anyt/tests/subscriptions/ack_test.rb
-- lib/anyt/tests/subscriptions/params_test.rb
-- lib/anyt/tests/subscriptions/perform_test.rb
-- lib/anyt/tests/subscriptions/transmissions_test.rb
-- lib/anyt/utils.rb
-- lib/anyt/utils/async_helpers.rb
-- lib/anyt/version.rb
 homepage: http://github.com/anycable/anyt
 licenses:
 - MIT
@@ -271,15 +165,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.8
+rubygems_version: 3.4.20
 signing_key:
 specification_version: 4
-summary: Anycable conformance testing tool
+summary: Action Cable / AnyCable conformance testing tool
 test_files: []

data/bin/console

@@ -1,7 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'bundler/setup'
-require 'anyt'
-require 'irb'
-
-IRB.start

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here

data/lib/anyt/cli.rb

@@ -1,194 +0,0 @@
-# frozen_string_literal: true
-
-require "logger"
-require "optparse"
-
-require "anyt/version"
-require "anyt/remote_control"
-require "anyt/rpc"
-require "anyt/command"
-require "anyt/tests"
-
-$stdout.sync = true
-
-module Anyt
-  module Cli # :nodoc:
-    class << self
-      # CLI entrypoint
-      def run(args = ARGV)
-        parse_options!(args)
-
-        ActionCable.server.config.logger = Rails.logger = AnyCable.logger
-
-        result = 1
-
-        $stdout.puts "Starting AnyT v#{Anyt::VERSION} (pid: #{Process.pid})\n"
-
-        begin
-          # "Enable" AnyCable as early as possible to activate all the features in tests
-          unless Anyt.config.use_action_cable
-            ActionCable.server.config.cable = {"adapter" => "any_cable"}
-            require "anycable-rails"
-          end
-
-          # Load all test scenarios
-          Tests.load_tests unless @skip_tests
-
-          Rails.application.initialize!
-
-          # Start RPC server (unless specified otherwise, e.g. when
-          # we want to test Action Cable itself)
-          unless @skip_rpc
-            RPC.start
-
-            if @only_rpc
-              RPC.server.wait_till_terminated
-              return
-            end
-          end
-
-          # Start webosocket server under test
-          Command.run
-
-          unless @skip_tests
-            # Run tests
-            result = Tests.run ? 0 : 1
-          end
-
-          wait_till_terminated if @only_rails
-        rescue Interrupt => e
-          $stdout.puts "#{e.message}. Good-bye!"
-        ensure
-          RPC.stop unless @skip_rpc
-          Command.stop
-        end
-
-        result
-      end
-
-      private
-
-      def parse_options!(args)
-        parser =
-          OptionParser.new do |cli|
-            cli.banner = <<~BANNER
-              Anyt – AnyCable websocket server conformance tool.
-
-              Usage: anyt [options]
-
-              Options:
-            BANNER
-
-            cli.on("-cCOMMAND", "--command=COMMAND", "Command to run WS server.") do |command|
-              Anyt.config.command = command
-            end
-
-            cli.on("--target-url=TARGET", "URL of target WebSocket server to test.") do |target|
-              Anyt.config.target_url = target
-            end
-
-            cli.on("--redis-url=REDIS_URL", "Redis server URL.") do |redis|
-              AnyCable.config.redis_url = redis
-            end
-
-            cli.on("--skip-rpc", TrueClass, "Do not run RPC server") do |flag|
-              @skip_rpc = flag
-            end
-
-            cli.on("--only-rpc", TrueClass, "Run only RPC server") do |flag|
-              @only_rpc = flag
-            end
-
-            cli.on("--only-rails", TrueClass, "Run only Rails server") do
-              @skip_rpc = true
-              @only_rails = true
-              @skip_tests = true
-
-              configure_rails_command!
-            end
-
-            cli.on("--self-check", "Run tests again Action Cable itself") do
-              @skip_rpc = true
-
-              configure_rails_command!
-            end
-
-            cli.on("--only test1,test2,test3", Array, "Run only specified tests") do |only_tests|
-              Anyt.config.only_tests = only_tests
-            end
-
-            cli.on("--except test1,test2,test3", Array, "Exclude specified tests") do |except_tests|
-              Anyt.config.except_tests = except_tests
-            end
-
-            cli.on("--wait-command=TIMEOUT", Integer,
-              "Number of seconds to wait for WS server initialization") do |timeout|
-              Anyt.config.wait_command = timeout
-            end
-
-            cli.on("--timeout-multiplier=VALUE", Float,
-              "Default exceptation timeouts multiplier") do |val|
-              Anyt.config.timeout_multiplier = val
-            end
-
-            cli.on("-rPATH", "--require=PATH",
-              "Path to additional tests (e.g. features/*.rb") do |path|
-              Anyt.config.tests_relative_path = path
-              ENV["ANYT_TESTS_RELATIVE_PATH"] = path
-            end
-
-            cli.on("--debug", "Enable debug mode.") do
-              AnyCable.config.debug = true
-            end
-
-            cli.on("-h", "--help", "Show this message.") do
-              puts cli
-              exit
-            end
-
-            cli.on("--version", "Print version.") do
-              puts Anyt::VERSION
-              exit
-            end
-          end
-
-        parser.parse!(args)
-      rescue OptionParser::InvalidOption => e
-        unknown_option = e.args.first
-        puts "This option looks unfamiliar: #{unknown_option}. A typo?"
-        puts "Use `anyt --help` to list all available options."
-        exit 1
-      end
-
-      def configure_rails_command!
-        dummy_path = ::File.expand_path(
-          "config.ru",
-          ::File.join(::File.dirname(__FILE__), "dummy")
-        )
-        Anyt.config.command = "bundle exec puma #{dummy_path}"
-        Anyt.config.use_action_cable = true
-      end
-
-      def wait_till_terminated
-        self_read = setup_signals
-
-        while readable_io = IO.select([self_read]) # rubocop:disable Lint/AssignmentInCondition, Lint/IncompatibleIoSelectWithFiberScheduler
-          signal = readable_io.first[0].gets.strip
-          raise Interrupt, "SIG#{signal} received"
-        end
-      end
-
-      def setup_signals
-        self_read, self_write = IO.pipe
-
-        %w[INT TERM].each do |signal|
-          trap signal do
-            self_write.puts signal
-          end
-        end
-
-        self_read
-      end
-    end
-  end
-end

data/lib/anyt/client.rb

@@ -1,112 +0,0 @@
-# frozen_string_literal: true
-
-module Anyt
-  # Synchronous websocket client
-  # Based on https://github.com/rails/rails/blob/v5.0.1/actioncable/test/client_test.rb
-  class Client
-    require "websocket-client-simple"
-    require "concurrent"
-
-    class TimeoutError < StandardError; end
-
-    WAIT_WHEN_EXPECTING_EVENT = 5
-    WAIT_WHEN_NOT_EXPECTING_EVENT = 0.5
-
-    def initialize(
-      ignore: [], url: Anyt.config.target_url, qs: "",
-      cookies: "", headers: {},
-      protocol: "actioncable-v1-json",
-      timeout_multiplier: Anyt.config.timeout_multiplier
-    )
-      ignore_message_types = @ignore_message_types = ignore
-      messages = @messages = Queue.new
-      closed = @closed = Concurrent::Event.new
-      has_messages = @has_messages = Concurrent::Semaphore.new(0)
-
-      @timeout_multiplier = timeout_multiplier
-
-      headers = headers.merge("cookie" => cookies)
-      headers["Sec-WebSocket-Protocol"] = protocol
-
-      open = Concurrent::Promise.new
-
-      @ws = WebSocket::Client::Simple.connect(
-        url + "?#{qs}",
-        headers: headers
-      ) do |ws|
-        ws.on(:error) do |event|
-          event = RuntimeError.new(event.message) unless event.is_a?(Exception)
-
-          if open.pending?
-            open.fail(event)
-          else
-            messages << event
-            has_messages.release
-          end
-        end
-
-        ws.on(:open) do |_event|
-          open.set(true)
-        end
-
-        ws.on(:message) do |event|
-          next if event.type == :ping
-          if event.type == :close
-            closed.set
-          else
-            message = JSON.parse(event.data)
-
-            next if ignore_message_types.include?(message["type"])
-
-            AnyCable.logger.debug "Message received: #{message}"
-
-            messages << message
-            has_messages.release
-          end
-        end
-
-        ws.on(:close) do |_event|
-          closed.set
-        end
-      end
-
-      open.wait!(WAIT_WHEN_EXPECTING_EVENT * @timeout_multiplier)
-    end
-    # rubocop: enable Metrics/BlockLength
-    # rubocop: enable Metrics/AbcSize
-    # rubocop: enable Metrics/MethodLength
-
-    def receive(timeout: WAIT_WHEN_EXPECTING_EVENT)
-      timeout *= @timeout_multiplier
-
-      raise TimeoutError, "Timed out to receive message" unless
-        @has_messages.try_acquire(1, timeout)
-
-      msg = @messages.pop(true)
-      raise msg if msg.is_a?(Exception)
-
-      msg
-    end
-
-    def send(message)
-      @ws.send(JSON.generate(message))
-    end
-
-    def close(allow_messages: false)
-      sleep WAIT_WHEN_NOT_EXPECTING_EVENT * @timeout_multiplier
-
-      raise "#{@messages.size} messages unprocessed" unless allow_messages || @messages.empty?
-
-      @ws.close
-      wait_for_close
-    end
-
-    def wait_for_close
-      @closed.wait(WAIT_WHEN_EXPECTING_EVENT * @timeout_multiplier)
-    end
-
-    def closed?
-      @closed.set?
-    end
-  end
-end

data/lib/anyt/command.rb

@@ -1,63 +0,0 @@
-# frozen_string_literal: true
-
-require "childprocess"
-
-module Anyt
-  # Runs system command (websocket server)
-  module Command
-    class << self
-      def run
-        return if running?
-
-        return unless Anyt.config.command
-
-        AnyCable.logger.debug "Running command: #{Anyt.config.command}"
-
-        @process = ChildProcess.build(*Anyt.config.command.split(/\s+/))
-
-        process.io.inherit! if AnyCable.config.debug
-
-        process.detach = true
-
-        process.environment["ANYCABLE_DEBUG"] = "1" if AnyCable.config.debug?
-        process.environment["ANYT_REMOTE_CONTROL_PORT"] = Anyt.config.remote_control_port
-
-        process.start
-
-        AnyCable.logger.debug "Command PID: #{process.pid}"
-
-        sleep Anyt.config.wait_command
-        raise "Command failed to start" unless running?
-      end
-      # rubocop: enable Metrics/MethodLength
-      # rubocop: enable Metrics/AbcSize
-
-      def restart
-        return unless running?
-
-        AnyCable.logger.debug "Restarting command PID: #{process.pid}"
-
-        stop
-        process.wait
-
-        run
-      end
-
-      def stop
-        return unless running?
-
-        AnyCable.logger.debug "Terminate PID: #{process.pid}"
-
-        process.stop
-      end
-
-      def running?
-        process&.alive?
-      end
-
-      private
-
-      attr_reader :process
-    end
-  end
-end

data/lib/anyt/config.rb

@@ -1,41 +0,0 @@
-# frozen_string_literal: true
-
-require "anyway"
-
-module Anyt
-  # Anyt configuration
-  class Config < Anyway::Config
-    attr_config :command,
-      :only_tests,
-      :except_tests,
-      :tests_relative_path,
-      remote_control_port: 8919,
-      use_action_cable: false,
-      target_url: "ws://localhost:9292/cable",
-      wait_command: 2,
-      timeout_multiplier: 1
-
-    coerce_types only_tests: {type: :string, array: true}
-    coerce_types except_tests: {type: :string, array: true}
-
-    def tests_path
-      return unless tests_relative_path
-
-      File.expand_path(tests_relative_path, Dir.pwd)
-    end
-
-    def filter_tests?
-      only_tests || except_tests
-    end
-
-    def tests_filter
-      only_rxp = /(#{only_tests.join('|')})/ if only_tests
-      except_rxp = /(#{except_tests.join('|')})/ if except_tests
-
-      @tests_filter ||= lambda do |path|
-        (only_rxp.nil? || only_rxp.match?(path)) &&
-          (except_rxp.nil? || !except_rxp.match?(path))
-      end
-    end
-  end
-end