anyt 0.8.3 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dc11a5ff81965c5f58e9fa188dc50b77c922b55b6ebd4bb37e7f008619b7ebdd
-  data.tar.gz: 11dba8960b7d37b7220451a2bf3b2b6ca611c91e48a19a1a9c719af72527b942
+  metadata.gz: cc9f527d5ead1058291854236f7b011c64df27da0be2559bb27893c1dbb471fc
+  data.tar.gz: 0dce342de8720db9d2208e4fc44c7c1ba3b489c0d82bce7b936152df2c70ccca
 SHA512:
-  metadata.gz: 5f81a9f004d643dd129b601026bf25981b6ad769970cff6bd00cbd74f3fa278bc258798e5a4ac7875c61ed9b0c3dffe312ebade12d0c514f6ffac8984612e5d4
-  data.tar.gz: 9d79a8212dc54a3b9230b71bfb469232a4e71f03c4df0a9844dab8a30f3fdc809a503270d0ab8e64242b5a9b1b5b963366e7e8d089aa952804373d170c050f68
+  metadata.gz: 6237b496a2cfb034d4b0d83eff127be84c360a124039bf14c32e4886732f9b9cff9def7e1515168dc87027ca85bcc64b78dfdd4d10988a1e84206b9fc4be7b3a
+  data.tar.gz: 9cd9d41ebdaf1321d13a08685b1955fe92875fb86fda8c4a230b1df9d30e7e39e5564a2614fb1693666a203926770cbdf3d9a0fda7265f3893524baa7cb8f89a

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,14 +25,26 @@ 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
 
+          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
@@ -77,6 +89,10 @@ module Anyt
               @skip_rpc = flag
             end
 
+            cli.on("--only-rpc", TrueClass, "Run only RPC server") do |flag|
+              @only_rpc = flag
+            end
+
             cli.on("--self-check", "Run tests again Action Cable itself") do
               @skip_rpc = true
               dummy_path = ::File.expand_path(
@@ -84,19 +100,29 @@ module Anyt
                 ::File.join(::File.dirname(__FILE__), "dummy")
               )
               Anyt.config.command = "bundle exec puma #{dummy_path}"
+              Anyt.config.use_action_cable = true
             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

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
 
@@ -48,6 +51,7 @@ module Anyt
         end
 
         ws.on(:message) do |event|
+          next if event.type == :ping
           if event.type == :close
             closed.set
           else
@@ -67,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)
 
@@ -87,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,63 @@
 # 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?
 
         AnyCable.logger.debug "Running command: #{Anyt.config.command}"
 
-        out = AnyCable.config.debug ? STDOUT : IO::NULL
+        @process = ChildProcess.build(*Anyt.config.command.split(/\s+/))
+
+        process.io.inherit! if AnyCable.config.debug
 
-        @pid = Process.spawn(
-          Anyt.config.command,
-          out: out,
-          err: out
-        )
+        process.detach = true
 
-        Process.detach(@pid)
+        process.environment["ANYCABLE_DEBUG"] = "1" if AnyCable.config.debug?
+        process.environment["ANYT_REMOTE_CONTROL_PORT"] = Anyt.config.remote_control_port
 
-        AnyCable.logger.debug "Command PID: #{@pid}"
+        process.start
 
-        @running = true
+        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 "Terminate PID: #{@pid}"
+        AnyCable.logger.debug "Restarting command PID: #{process.pid}"
 
-        Process.kill("SIGKILL", @pid)
+        stop
+        process.wait
 
-        @running = false
+        run
+      end
+
+      def stop
+        return unless running?
+
+        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,31 +10,29 @@ 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
 
-  initializer "routes" do
-    Rails.application.routes.draw do
-      mount ActionCable.server => "/cable"
-    end
-  end
+  config.paths["config/routes.rb"] << File.join(__dir__, "routes.rb")
 end
 
 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
@@ -44,8 +42,8 @@ module ApplicationCable
   end
 end
 
-ActionCable.server.config.cable = { "adapter" => "redis" }
+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/routes.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+Rails.application.routes.draw do
+end

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)
+      @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

data/lib/anyt/remote_control.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require "drb/drb"
+
+module Anyt
+  # Invoke commands within the running Ruby (Action Cable) server
+  module RemoteControl
+    class Server
+      class << self
+        alias start new
+      end
+
+      def initialize(port)
+        DRb.start_service(
+          "druby://localhost:#{port}",
+          Client.new
+        )
+      end
+    end
+
+    class Client
+      def self.connect(port)
+        DRb.start_service
+
+        DRbObject.new_with_uri("druby://localhost:#{port}")
+      end
+
+      def restart_action_cable
+        ActionCable.server.restart
+      end
+    end
+  end
+end