anyt 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e0756730d4647d657a15da9bb7297bc56422b0b7
+  data.tar.gz: 7800b2a9f44d44082c3a210b6b30d599dc7284a6
+SHA512:
+  metadata.gz: 886ca9223f53368f8b673ee4122737efc56656fba24e0dde191ea937994bd9b3023774e34023fe0f753407a884ff6c729341ec66a9ea6581eefd4260937f4565
+  data.tar.gz: a238898763b662e5954689e85ede1605495967d87cf645a9edab68bddbfa1e87433459fce2d71159b740622cb9ba5e424f50af2f1fa8bbbbe62673bf46ca4dc4

data/.gitignore

@@ -0,0 +1,43 @@
+# Numerous always-ignore extensions
+*.diff
+*.err
+*.orig
+*.log
+*.rej
+*.swo
+*.swp
+*.vi
+*~
+*.sass-cache
+*.iml
+.idea/
+
+# Sublime
+*.sublime-project
+*.sublime-workspace
+
+# OS or Editor folders
+.DS_Store
+.cache
+.project
+.settings
+.tmproj
+Thumbs.db
+
+.bundle/
+log/*.log
+*.gz
+pkg/
+spec/dummy/db/*.sqlite3
+spec/dummy/db/*.sqlite3-journal
+spec/dummy/tmp/
+
+Gemfile.local
+Gemfile.lock
+.rspec
+*.gem
+tmp/
+coverage/
+
+# ctags tags
+tags

data/.rubocop.yml

@@ -0,0 +1,68 @@
+AllCops:
+  # Include gemspec and Rakefile
+  Include:
+    - 'lib/**/*.rb'
+    - 'lib/**/*.rake'
+    - 'spec/**/*.rb'
+  Exclude:
+    - 'bin/**/*'
+    - 'spec/dummy/**/*'
+    - 'tmp/**/*'
+    - 'vendor/**/*'
+    - 'bench/**/*'
+    - 'lib/anycable/rpc/**/*'
+    - '*.gemspec'
+    - 'Rakefile'
+    - 'Gemfile'
+  DisplayCopNames: true
+  StyleGuideCopsOnly: false
+  TargetRubyVersion: 2.4
+
+Rails:
+  Enabled: false
+
+Style/AccessorMethodName:
+  Enabled: false
+
+Style/TrivialAccessors:
+  Enabled: false
+
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*.rb'
+    - 'lib/**/*_test.rb'
+    - 'lib/anyt/dummy/**/*'
+
+Style/StringLiterals: 
+  Enabled: false
+
+Style/BlockDelimiters:
+  Exclude:
+    - 'spec/**/*.rb'
+
+Style/PercentLiteralDelimiters:
+  Enabled: false
+
+Style/FormatString:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Lint/AmbiguousRegexpLiteral:
+  Enabled: false
+
+Metrics/MethodLength:
+  Exclude:
+    - 'spec/**/*.rb'
+    - 'lib/**/*_test.rb'
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*.rb'
+    - 'lib/**/*_test.rb'
+
+Metrics/LineLength:
+  Max: 100
+  Exclude:
+    - 'spec/**/*.rb'

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in anyt.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 palkan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 palkan
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Makefile

@@ -0,0 +1,5 @@
+lint:
+	bundle exec rubocop
+
+test:
+	bin/anyt --self-check

data/README.md

@@ -0,0 +1,35 @@
+[![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)
+
+# Anycable Conformance Testing Tool
+
+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
+
+```sh
+gem install anyt
+```
+
+## Usage
+
+You should provide a command to run the server and the target URL for WebSocket clients:
+
+```sh
+anyt -c "anycable-go" --target-url="ws://localhost:8080/cable"
+```
+
+By default it launches gRPC server on `localhost:50051` and use local Redis instance for broadcasts (`localhost:6379`).
+
+For more options run:
+
+```sh
+anyt -h
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/anycable/anyt/issues.
+
+## License
+The library is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/anyt.gemspec

@@ -0,0 +1,41 @@
+# coding: utf-8
+# frozen_string_literal: true
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require "anyt/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "anyt"
+  spec.version       = Anyt::VERSION
+  spec.authors       = ["palkan"]
+  spec.email         = ["dementiev.vm@gmail.com"]
+
+  spec.summary       = "Anycable conformance testing tool"
+  spec.description   = "Anycable conformance testing tool"
+  spec.homepage      = "http://github.com/anycable/anyt"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+
+  spec.executables << "anyt"
+
+  spec.add_dependency "rack", "~> 2"
+  spec.add_dependency "minitest", "~> 5.10.1"
+  spec.add_dependency "minitest-reporters", "~> 1.1.0"
+  spec.add_dependency "rails", "~> 5.0"
+  spec.add_dependency "anycable-rails", "~> 0.4.6"
+  spec.add_dependency "websocket", "~> 1.2.4"
+  spec.add_dependency "websocket-client-simple", "~> 0.3.0"
+  spec.add_dependency "concurrent-ruby", "~> 1.0.0"
+
+  spec.add_development_dependency "bundler", "~> 1"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "simplecov", ">= 0.3.8"
+  spec.add_development_dependency "rubocop", "~> 0.50"
+  spec.add_development_dependency "pry", "~> 0.10.4"
+  spec.add_development_dependency "puma", "~> 3.6"
+  spec.add_development_dependency "pry-byebug"
+end

data/bin/anyt

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+
+require 'anyt'
+require 'anyt/cli'
+
+begin
+  exit_code = Anyt::Cli.run
+rescue => e
+  puts 'Bummer! There is an error:'
+  puts e
+  exit 1
+end
+
+exit exit_code

data/bin/console

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

data/bin/setup

@@ -0,0 +1,8 @@
+#!/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/circle.yml

@@ -0,0 +1,14 @@
+machine:
+  ruby:
+    version: 2.4.2
+  services:
+    - redis
+
+dependencies:
+  pre:
+    - gem install bundler
+  
+test:
+  override:
+    - make lint
+    - make test

data/lib/anyt.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "anyt/version"
+require "anyt/config"
+require "anyt/utils"
+
+# Anycable conformance testing tool
+module Anyt
+  class << self
+    def config
+      @config ||= Config.new
+    end
+  end
+end

data/lib/anyt/cli.rb

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+require "logger"
+require "optparse"
+
+require "anyt/rpc"
+require "anyt/command"
+require "anyt/tests"
+
+# rubocop: disable Metrics/AbcSize
+# rubocop: disable Metrics/MethodLength
+# rubocop: disable Metrics/BlockLength
+module Anyt
+  module Cli # :nodoc:
+    class << self
+      # CLI entrypoint
+      def run
+        parse_options!
+
+        ActionCable.server.config.logger = Rails.logger = Anycable.logger
+
+        result = 1
+
+        begin
+          # Load all test scenarios
+          Tests.load_tests
+
+          # Start RPC server (unless specified otherwise, e.g. when
+          # we want to test Action Cable itself)
+          unless @skip_rpc
+            require "anycable-rails"
+            RPC.start
+          end
+
+          # Start webosocket server under test
+          Command.run
+
+          # Run tests
+          result = Tests.run ? 0 : 1
+        ensure
+          RPC.stop unless @skip_rpc
+          Command.stop
+        end
+
+        result
+      end
+
+      private
+
+      def parse_options!
+        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("--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}"
+            end
+
+            cli.on("--only test1,test2,test3", Array, "Run only specified tests") do |only_tests|
+              Anyt.config.only_tests = only_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("--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!
+      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
+    end
+  end
+end