anyt 0.8.5 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b45eb7502a2f6155788228c055c05232ad0ab7baf47509e70cb783479047eb07
-  data.tar.gz: 62266da53d1c2f5a58376fd64b340b7e6b94dac05af6ca16c1580f84723bf177
+  metadata.gz: ae6e9315f47d249825321f25325b732f6c772c038897e276be2808c67a6a825c
+  data.tar.gz: 0561047ee5e30ee0ad01dd39963d6b637c813fb2edc0a1661314b3079e5ce605
 SHA512:
-  metadata.gz: 764bf51ba64a579c4906633cf19d46d156e143b66a642c96a285e6fb862cc34357da75f8c3ec2627afc4cedc3d72ca38d95a69990b53d42fbbfc9d8280b0521b
-  data.tar.gz: 57611bdee9877c384c651c8e45c928ecc85af77c888cb985c794fe9903735aed4660d3619afc5dd8ff0d191cf8509327baeeda65bfff9a8d73c33357607103c7
+  metadata.gz: 8ecf5301765607d5e4b724f77754bd37e0ec8e870a29e5e5e881db1bec7ec2ee14b7715512b5d84fee2e454035da2ae8c4661675d08d49107b7bf59f5b37bc95
+  data.tar.gz: 2a660e68240cf6a295873eb099b635d756482419703034074fcd00fe934a7cb8ca7e26b6d8e850c8eb95e0a1cefe2d8183bde53d4a97641d3b43a416f62bb3a5

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright 2016 palkan
+Copyright 2016-2020 palkan
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,4 +1,7 @@
-[![Gem Version](https://badge.fury.io/rb/anyt.svg)](https://rubygems.org/gems/anyt) [![Circle CI](https://circleci.com/gh/anycable/anycablebility/tree/master.svg?style=svg)](https://circleci.com/gh/anycable/anycablebility/tree/master) [![Gitter](https://img.shields.io/badge/gitter-join%20chat%20%E2%86%92-brightgreen.svg)](https://gitter.im/anycable/anycablebility)
+[![Cult Of Martians](http://cultofmartians.com/assets/badges/badge.svg)](https://cultofmartians.com/tasks/anycable-conformance-tool.html#task)
+[![Gem Version](https://badge.fury.io/rb/anyt.svg)](https://rubygems.org/gems/anyt)
+![Test](https://github.com/anycable/anyt/workflows/Test/badge.svg)
+[![Gitter](https://img.shields.io/badge/gitter-join%20chat%20%E2%86%92-brightgreen.svg)](https://gitter.im/anycable/anycablebility)
 
 # AnyCable Conformance Testing Tool
 

data/lib/anyt/cli.rb

@@ -4,13 +4,13 @@ require "logger"
 require "optparse"
 
 require "anyt/version"
+require "anyt/remote_control"
 require "anyt/rpc"
 require "anyt/command"
 require "anyt/tests"
 
-# rubocop: disable Metrics/AbcSize
-# rubocop: disable Metrics/MethodLength
-# rubocop: disable Metrics/BlockLength
+$stdout.sync = true
+
 module Anyt
   module Cli # :nodoc:
     class << self
@@ -25,21 +25,39 @@ module Anyt
         $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
+          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
-            require "anycable-rails"
             RPC.start
+
+            if @only_rpc
+              RPC.server.wait_till_terminated
+              return
+            end
           end
 
           # Start webosocket server under test
           Command.run
 
-          # Run tests
-          result = Tests.run ? 0 : 1
+          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
@@ -77,26 +95,45 @@ module Anyt
               @skip_rpc = flag
             end
 
+            cli.on("--only-rpc", TrueClass, "Run only RPC server") do |flag|
+              @only_rpc = flag
+              @skip_tests = true
+            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
-              dummy_path = ::File.expand_path(
-                "config.ru",
-                ::File.join(::File.dirname(__FILE__), "dummy")
-              )
-              Anyt.config.command = "bundle exec puma #{dummy_path}"
+
+              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|
+              "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|
+              "Path to additional tests (e.g. features/*.rb") do |path|
               Anyt.config.tests_relative_path = path
               ENV["ANYT_TESTS_RELATIVE_PATH"] = path
             end
@@ -123,6 +160,36 @@ module Anyt
         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
+          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

@@ -17,14 +17,17 @@ module Anyt
     # rubocop: disable Metrics/BlockLength
     def initialize(
       ignore: [], url: Anyt.config.target_url, qs: "",
-      cookies: "", headers: {}
+      cookies: "", headers: {},
+      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)
 
-      headers = headers.merge('cookie' => cookies)
+      @timeout_multiplier = timeout_multiplier
+
+      headers = headers.merge("cookie" => cookies)
 
       open = Concurrent::Promise.new
 
@@ -68,13 +71,15 @@ module Anyt
         end
       end
 
-      open.wait!(WAIT_WHEN_EXPECTING_EVENT)
+      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)
 
@@ -88,17 +93,17 @@ module Anyt
       @ws.send(JSON.generate(message))
     end
 
-    def close
-      sleep WAIT_WHEN_NOT_EXPECTING_EVENT
+    def close(allow_messages: false)
+      sleep WAIT_WHEN_NOT_EXPECTING_EVENT * @timeout_multiplier
 
-      raise "#{@messages.size} messages unprocessed" unless @messages.empty?
+      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)
+      @closed.wait(WAIT_WHEN_EXPECTING_EVENT * @timeout_multiplier)
     end
 
     def closed?

data/lib/anyt/command.rb

@@ -1,50 +1,65 @@
 # frozen_string_literal: true
 
+require "childprocess"
+
 module Anyt
   # Runs system command (websocket server)
   module Command
     class << self
-      attr_accessor :running
-
       # rubocop: disable Metrics/MethodLength
       # rubocop: disable Metrics/AbcSize
       def run
-        return if @running
+        return if running?
+
+        raise "Please, specify command via -c (--command) option" unless Anyt.config.command
 
         AnyCable.logger.debug "Running command: #{Anyt.config.command}"
 
-        out = AnyCable.config.debug ? STDOUT : IO::NULL
+        @process = ChildProcess.build(*Anyt.config.command.split(/\s+/))
 
-        @pid = Process.spawn(
-          Anyt.config.command,
-          out: out,
-          err: out
-        )
+        process.io.inherit! if AnyCable.config.debug
 
-        Process.detach(@pid)
+        process.detach = true
 
-        AnyCable.logger.debug "Command PID: #{@pid}"
+        process.environment["ANYCABLE_DEBUG"] = "1" if AnyCable.config.debug?
+        process.environment["ANYT_REMOTE_CONTROL_PORT"] = Anyt.config.remote_control_port
 
-        @running = true
+        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 stop
-        return unless @running
+      def restart
+        return unless running?
+
+        AnyCable.logger.debug "Restarting command PID: #{process.pid}"
 
-        AnyCable.logger.debug "Terminate PID: #{@pid}"
+        stop
+        process.wait
 
-        Process.kill("SIGKILL", @pid)
+        run
+      end
+
+      def stop
+        return unless running?
 
-        @running = false
+        AnyCable.logger.debug "Terminate PID: #{process.pid}"
+
+        process.stop
       end
 
       def running?
-        @running == true
+        process&.alive?
       end
+
+      private
+
+      attr_reader :process
     end
   end
 end

data/lib/anyt/config.rb

@@ -6,10 +6,14 @@ module Anyt
   # Anyt configuration
   class Config < Anyway::Config
     attr_config :command,
-                :only_tests,
-                :tests_relative_path,
-                target_url: "ws://localhost:9292/cable",
-                wait_command: 2
+      :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
 
     def tests_path
       return unless tests_relative_path
@@ -18,12 +22,16 @@ module Anyt
     end
 
     def filter_tests?
-      !only_tests.nil?
+      only_tests || except_tests
     end
 
     def tests_filter
-      @tests_filter ||= begin
-        /(#{only_tests.join('|')})/
+      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

data/lib/anyt/dummy/application.rb

@@ -10,11 +10,11 @@ require "anycable-rails"
 require "action_dispatch/middleware/cookies"
 
 class TestApp < Rails::Application
-  secrets.secret_token    = "secret_token"
+  secrets.secret_token = "secret_token"
   secrets.secret_key_base = "secret_key_base"
 
   config.logger = Logger.new(STDOUT)
-  config.log_level = :fatal
+  config.log_level = AnyCable.config.log_level
   config.eager_load = true
 
   config.paths["config/routes.rb"] << File.join(__dir__, "routes.rb")
@@ -24,13 +24,15 @@ module ApplicationCable
   class Connection < ActionCable::Connection::Base
     delegate :params, to: :request
 
+    identified_by :uid
+
     def connect
-      logger.info "Connected"
+      logger.debug "Connected"
       Anyt::ConnectHandlers.call(self)
     end
 
     def disconnect
-      logger.info "Disconnected"
+      logger.debug "Disconnected"
     end
   end
 end
@@ -40,8 +42,31 @@ module ApplicationCable
   end
 end
 
-ActionCable.server.config.cable = { "adapter" => "redis" }
+# BenchmarkChannel is useful when running Rails app only or RPC only
+class BenchmarkChannel < ApplicationCable::Channel
+  def subscribed
+    stream_from "all#{stream_id}"
+  end
+
+  def echo(data)
+    transmit data
+  end
+
+  def broadcast(data)
+    ActionCable.server.broadcast "all#{stream_id}", data
+    data["action"] = "broadcastResult"
+    transmit data
+  end
+
+  private
+
+  def stream_id
+    params[:id] || ""
+  end
+end
+
+ActionCable.server.config.cable = {"adapter" => "redis"}
 ActionCable.server.config.connection_class = -> { ApplicationCable::Connection }
 ActionCable.server.config.disable_request_forgery_protection = true
 ActionCable.server.config.logger =
-  Rails.logger = Logger.new(STDOUT).tap { |l| l.level = Logger::DEBUG }
+  Rails.logger

data/lib/anyt/dummy/config.ru

@@ -3,6 +3,10 @@
 require_relative "./application"
 
 require_relative "../tests"
+require_relative "../remote_control"
+
+# Start remote control
+Anyt::RemoteControl::Server.start(Anyt.config.remote_control_port)
 
 # Load channels from tests
 Anyt::Tests.load_all_tests

data/lib/anyt/dummy/tmp/development_secret.txt

@@ -0,0 +1 @@
+fe2ecbcf229d5547a64bcdaa9ef4e543404ca3fc9d4ee83aaa7ddab34b6a378fe090c2b1836c9ebd3e5ebbf01c239ddac95e219358baaefc1afaa04cd07bf78c

data/lib/anyt/ext/minitest.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+ENV["TERM"] = "#{ENV["TERM"]}color" unless ENV["TERM"]&.match?(/color/)
 require "minitest/spec"
 require "minitest/reporters"
 
@@ -8,10 +9,26 @@ module Anyt
   module TestHelpers
     def self.included(base)
       base.let(:client) { build_client(ignore: %w[ping welcome]) }
+      base.after { @clients&.each { |client| client.close(allow_messages: true) } }
     end
 
-    def build_client(*args)
-      Anyt::Client.new(*args)
+    def build_client(**args)
+      @clients ||= []
+      Anyt::Client.new(**args).tap do |client|
+        @clients << client
+      end
+    end
+
+    def restart_server!
+      if Anyt.config.use_action_cable
+        remote_client.restart_action_cable
+      else
+        Command.restart
+      end
+    end
+
+    def remote_client
+      @remote_client ||= RemoteControl::Client.connect(Anyt.config.remote_control_port)
     end
   end
 end
@@ -38,7 +55,7 @@ module Anyt
 
       def handlers_for(connection)
         handlers.select do |(tag, _)|
-          connection.params['test'] == tag
+          connection.params["test"] == tag
         end
       end
 
@@ -74,7 +91,7 @@ module Minitest::Spec::DSL
   # Generates Channel class dynamically and
   # add memoized helper to access its name
   def channel(id = nil, &block)
-    class_name = @name.gsub(/\s+/, '_')
+    class_name = @name.gsub(/\s+/, "_")
     class_name += "_#{id}" if id
     class_name += "_channel"
 
@@ -99,15 +116,15 @@ module Anyt
   module MinitestPatch
     def load_plugins
       super
-      extensions.delete('rails')
+      extensions.delete("rails")
     end
   end
 
   # Patch Spec reporter
   module ReporterPatch # :nodoc:
     def record_print_status(test)
-      test_name = test.name.gsub(/^test_/, '').strip
-      print pad_test(test_name)
+      test_name = test.name.gsub(/^test_/, "").strip
+      print(magenta { pad_test(test_name) })
       print_colored_status(test)
       print(" (%.2fs)" % test.time) unless test.time.nil?
       puts