minitest-distributed 0.2.7 → 0.2.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5dae86a5761e82ad0675cb289f945eeb29039bbb55c5be5d9e832e22bd5eb62c
-  data.tar.gz: 56c65bd5817b033a9a912dc24a1dd8ef7276efa75828a9b3a5dd1dfc82387e0c
+  metadata.gz: 1dc9ad4333958d6197869544c8fd47f6bc0f6ccdb5fe2203fe4af1ed348164ed
+  data.tar.gz: fad3b8564ad602cf2209ebff92b1ddeef601f2ae3ccdfc94d67820e077a05943
 SHA512:
-  metadata.gz: 3a48ade567a3e8db5f70b7b2fe0f9b1f19e295eaf457f49df59030b997bf17de3b86253def06ec60741f9b6344447a15239f345b3af4197fe3588851c4e22473
-  data.tar.gz: b2ce6e5bfb8a24a308f4409b4e61b75db00fd3f677e1ea335d8b25e0c0f128eeb49737898fc6f7540923e965239e6bdb76dbdb14c22b42bea12ab06d88a08e7a
+  metadata.gz: 833c450f354affcdab9f7d3939dd5ac5de52de2a586758cf46b8b21a60073712dca466d2847aa6a918eea2e68d8013e6d53dee1fc335fc7dcca97edca7785cce
+  data.tar.gz: 6d35405c22570d2c9c9628e35330ce2e198d77ec8610e88568d07e7b3d7453323872db88e7b99de11148e396e56487be3c98c540110127cbaaa53ab21307da0a

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,43 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: "[BUG]"
+labels: bug
+assignees: ''
+
+---
+
+**Describe the issue**
+A clear and concise description of the issue you're facing.
+
+**To Reproduce**
+Steps to reproduce the behaviour:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behaviour**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**What team are you on?**
+ Please provide the name of your team.
+
+**Helpful links (Logs, Link to Build, Repo, PR etc.)** 
+Please provide any helpful links for investigating the issue.
+
+**Is there a Slack thread related to this bug?** 
+After submitting this issue, you can use: @spy github issues create_comment repo=minitest-distributed issue_id=$NEW_ISSUE_ID on any relevant Slack threads to save that information here.
+
+**Additional context**
+Add any other context about the problem here.
+
+If possible, assign appropriate severity level, priority (high, medium, low) and difficulty (easy, normal, difficult) labels to the issue.
+SEV-1 <24-72h - Critical issue that actively impacts multiple users/products.
+SEV-2 <14 days - Limited impact app or major inconvenience to app users, workarounds available.
+SEV-3 <60 days - Minor issue requiring action, but not affecting a users ability to use the app.
+SEV-4 <180 days - Minimal impact but something the team wants to fix eventually.
+SEV-5 No timeline - Cosmetic issue or bugs, no effect on user's ability to use tooling.

data/.github/workflows/ruby.yml

@@ -10,13 +10,35 @@ name: Ruby
 on: push
 
 jobs:
+  test_32:
+    runs-on: shopify-ubuntu-latest
+    container: ruby:3.2
+
+    services:
+      redis:
+        image: redis
+      toxiproxy:
+        image: ghcr.io/shopify/toxiproxy:2.5.0
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Install dependencies
+      run: gem install bundler && bundle install
+    - name: Run tests
+      run: bin/rake test
+      env:
+        REDIS_URL: redis://toxiproxy:22220
+        TOXIPROXY_HOST: http://toxiproxy:8474
+
   test_31:
-    runs-on: ubuntu-latest
+    runs-on: shopify-ubuntu-latest
     container: ruby:3.1
 
     services:
       redis:
         image: redis
+      toxiproxy:
+        image: ghcr.io/shopify/toxiproxy:2.5.0
 
     steps:
     - uses: actions/checkout@v2
@@ -25,15 +47,18 @@ jobs:
     - name: Run tests
       run: bin/rake test
       env:
-        REDIS_URL: redis://redis:6379
+        REDIS_URL: redis://toxiproxy:22220
+        TOXIPROXY_HOST: http://toxiproxy:8474
 
   test_30:
-    runs-on: ubuntu-latest
+    runs-on: shopify-ubuntu-latest
     container: ruby:3.0
 
     services:
       redis:
         image: redis
+      toxiproxy:
+        image: ghcr.io/shopify/toxiproxy:2.5.0
 
     steps:
     - uses: actions/checkout@v2
@@ -42,15 +67,18 @@ jobs:
     - name: Run tests
       run: bin/rake test
       env:
-        REDIS_URL: redis://redis:6379
+        REDIS_URL: redis://toxiproxy:22220
+        TOXIPROXY_HOST: http://toxiproxy:8474
 
   test_27:
-    runs-on: ubuntu-latest
+    runs-on: shopify-ubuntu-latest
     container: ruby:2.7
 
     services:
       redis:
         image: redis
+      toxiproxy:
+        image: ghcr.io/shopify/toxiproxy:2.5.0
 
     steps:
     - uses: actions/checkout@v2
@@ -59,10 +87,11 @@ jobs:
     - name: Run tests
       run: bin/rake test
       env:
-        REDIS_URL: redis://redis:6379
+        REDIS_URL: redis://toxiproxy:22220
+        TOXIPROXY_HOST: http://toxiproxy:8474
 
   typecheck:
-    runs-on: ubuntu-latest
+    runs-on: shopify-ubuntu-latest
     container: ruby:2.7
     steps:
     - uses: actions/checkout@v2
@@ -72,8 +101,8 @@ jobs:
       run: bin/srb tc
 
   lint:
-    runs-on: ubuntu-latest
-    container: ruby:2.7
+    runs-on: shopify-ubuntu-latest
+    container: ruby:3.2
     steps:
     - uses: actions/checkout@v2
     - name: Install dependencies

data/.rubocop.yml

@@ -14,6 +14,7 @@ AllCops:
   CacheRootDirectory: tmp/rubocop
   Exclude:
     - minitest-distributed.gemspec
+  NewCops: disable
 
 # This cop is broken when using assignments
 Layout/RescueEnsureAlignment:

data/Gemfile

@@ -13,3 +13,4 @@ gem "rubocop-shopify"
 gem "rubocop-sorbet"
 gem "rubocop-minitest"
 gem "rubocop-rake"
+gem "toxiproxy"

data/README.md

@@ -5,7 +5,7 @@
 [About this repo](#about-this-repo) | [Commands](#commands) | [How to use this repo](#how-to-use-this-repo) | [Contribute to this repo](#contribute-to-this-repo) | [License](#license)
 
 ## About this repo
-**Introduction:** 
+**Introduction:**
 
 `minitest-distributed` is a plugin for [minitest](https://github.com/seattlerb/minitest)
 for executing tests on a distributed set of unreliable workers.
@@ -87,11 +87,11 @@ them to fail.
 - `--worker-id=IDENTIFIER` or `ENV[MINITEST_WORKER_ID]`: The ID of the worker,
   which should be unique to the cluster. We will default to a UUID if this is
   not set, which generally is fine.
-- `--exclude-file=PATH_TO_FILE`: Specify a file of tests to be excluded 
-  from running. The file should include test identifiers seperated by 
+- `--exclude-file=PATH_TO_FILE`: Specify a file of tests to be excluded
+  from running. The file should include test identifiers seperated by
   newlines.
 - `--include-file=PATH_TO_FILE`: Specify a file of tests to be included in
-  the test run. The file should include test identifiers seperated by 
+  the test run. The file should include test identifiers seperated by
   newlines.
 
 **Limitations**
@@ -124,7 +124,7 @@ To bootstrap a local development environment:
 - Start a Redis server by running `redis-server`, assuming you have Redis
   installed locally and the binary is on your `PATH`. Alternatively, you can
   set the `REDIS_URL` environment variable to point to a Redis instance running
-  elsewhere.
+  elsewhere. You can also use `docker-compose up` with the provided `docker-compose.yml`.
 - Now, run `bin/rake test` to run the tests, and verify everything is working.
 - You can also run `bin/console` for an interactive prompt that will allow you
   to experiment.

data/bin/rake

@@ -9,8 +9,10 @@
 #
 
 require "pathname"
-ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
-  Pathname.new(__FILE__).realpath)
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path(
+  "../../Gemfile",
+  Pathname.new(__FILE__).realpath,
+)
 
 bundle_binstub = File.expand_path("../bundle", __FILE__)
 

data/bin/rubocop

@@ -9,8 +9,10 @@
 #
 
 require "pathname"
-ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
-  Pathname.new(__FILE__).realpath)
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path(
+  "../../Gemfile",
+  Pathname.new(__FILE__).realpath,
+)
 
 bundle_binstub = File.expand_path("../bundle", __FILE__)
 

data/bin/srb

@@ -9,8 +9,10 @@
 #
 
 require "pathname"
-ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
-  Pathname.new(__FILE__).realpath)
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path(
+  "../../Gemfile",
+  Pathname.new(__FILE__).realpath,
+)
 
 bundle_binstub = File.expand_path("../bundle", __FILE__)
 

data/dev.yml

@@ -0,0 +1,7 @@
+name: minitest-distributed
+
+type: ruby
+
+up:
+  - ruby: 3.2.0
+  - bundler

data/docker-compose.yml

@@ -0,0 +1,11 @@
+version: '2'
+services:
+  redis:
+    image: redis:latest
+    ports:
+      - "6379:6379"
+  toxi-proxy:
+    image: ghcr.io/shopify/toxiproxy:2.5.0
+    ports:
+      - "8474:8474"
+      - "22220:22220"

data/lib/minitest/distributed/configuration.rb

@@ -79,6 +79,10 @@ module Minitest
             configuration.include_file = file_path
           end
 
+          opts.on("--[no-]shuffle-suites", "Shuffle test suites as well") do |enabled|
+            configuration.shuffle_suites = enabled
+          end
+
           configuration
         end
       end
@@ -97,6 +101,7 @@ module Minitest
       prop :progress, T::Boolean, default: false
       prop :exclude_file, T.nilable(String)
       prop :include_file, T.nilable(String)
+      prop :shuffle_suites, T::Boolean, default: true
 
       sig { returns(Coordinators::CoordinatorInterface) }
       def coordinator

data/lib/minitest/distributed/coordinators/redis_coordinator.rb

@@ -83,9 +83,18 @@ module Minitest
         sig { override.returns(ResultAggregate) }
         def combined_results
           @combined_results ||= begin
-            stats_as_string = redis.mget(key("runs"), key("assertions"), key("passes"),
-              key("failures"), key("errors"), key("skips"), key("requeues"), key("discards"),
-              key("acks"), key("size"))
+            stats_as_string = redis.mget(
+              key("runs"),
+              key("assertions"),
+              key("passes"),
+              key("failures"),
+              key("errors"),
+              key("skips"),
+              key("requeues"),
+              key("discards"),
+              key("acks"),
+              key("size"),
+            )
 
             ResultAggregate.new(
               max_failures: configuration.max_failures,
@@ -279,8 +288,14 @@ module Minitest
 
         sig { params(block: Integer).returns(T::Array[EnqueuedRunnable]) }
         def claim_fresh_runnables(block:)
-          result = redis.xreadgroup(group_name, configuration.worker_id, stream_key, ">",
-            block: block, count: configuration.test_batch_size)
+          result = redis.xreadgroup(
+            group_name,
+            configuration.worker_id,
+            stream_key,
+            ">",
+            block: block,
+            count: configuration.test_batch_size,
+          )
           EnqueuedRunnable.from_redis_stream_claim(result.fetch(stream_key, []), configuration: configuration)
         end
 
@@ -293,8 +308,13 @@ module Minitest
         def xclaim_messages(pending_messages, max_idle_time_ms:)
           return [] if pending_messages.empty?
 
-          claimed = redis.xclaim(stream_key, group_name, configuration.worker_id,
-            max_idle_time_ms, pending_messages.keys)
+          claimed = redis.xclaim(
+            stream_key,
+            group_name,
+            configuration.worker_id,
+            max_idle_time_ms,
+            pending_messages.keys,
+          )
 
           EnqueuedRunnable.from_redis_stream_claim(claimed, pending_messages, configuration: configuration)
         end
@@ -421,10 +441,19 @@ module Minitest
             pipeline.incrby(key("size"), results.size)
           end
 
-          @combined_results = ResultAggregate.new(max_failures: configuration.max_failures,
-            runs: updated[0], assertions: updated[1], passes: updated[2],
-            failures: updated[3], errors: updated[4], skips: updated[5], requeues: updated[6], discards: updated[7],
-            acks: updated[8], size: updated[9])
+          @combined_results = ResultAggregate.new(
+            max_failures: configuration.max_failures,
+            runs: updated[0],
+            assertions: updated[1],
+            passes: updated[2],
+            failures: updated[3],
+            errors: updated[4],
+            skips: updated[5],
+            requeues: updated[6],
+            discards: updated[7],
+            acks: updated[8],
+            size: updated[9],
+          )
         end
 
         sig { params(name: String).returns(String) }

data/lib/minitest/distributed/enqueued_runnable.rb

@@ -203,7 +203,7 @@ module Minitest
       sig do
         params(
           initial_result: Minitest::Result,
-          block: T.proc.params(arg0: Minitest::Result).returns(EnqueuedRunnable::Result::Commit)
+          block: T.proc.params(arg0: Minitest::Result).returns(EnqueuedRunnable::Result::Commit),
         ).returns(EnqueuedRunnable::Result)
       end
       def commit_result(initial_result, &block)

data/lib/minitest/distributed/reporters/junitxml_reporter.rb

@@ -78,11 +78,10 @@ module Minitest
         def add_tests_to(testsuites, suite, results)
           # TODO: make path relative to project root
           relative_path = T.must(results.first).source_location.first
-          lineno = T.must(results.first).source_location.last
 
           testsuite = testsuites.add_element(
             "testsuite",
-            { "name" => suite, "filepath" => relative_path }.merge(aggregate_suite_results(results))
+            { "name" => suite, "filepath" => relative_path }.merge(aggregate_suite_results(results)),
           )
 
           results.each do |test|
@@ -93,6 +92,7 @@ module Minitest
               "time" => test.time,
               # 'run-command' => ... # TODO
             }
+            lineno = test.source_location.last
             attributes["lineno"] = lineno if lineno != -1
 
             testcase_tag = testsuite.add_element("testcase", attributes)
@@ -107,9 +107,11 @@ module Minitest
             # noop
           when ResultType::Error, ResultType::Failed
             failure = T.must(result.failure)
-            failure_tag = testcase.add_element("failure",
+            failure_tag = testcase.add_element(
+              "failure",
               "type" => result_type.serialize,
-              "message" => truncate_message(failure.message))
+              "message" => truncate_message(failure.message),
+            )
             failure_tag.add_text(REXML::CData.new(result.to_s))
           else
             T.absurd(result_type)

data/lib/minitest/distributed/reporters/test_order_reporter.rb

@@ -0,0 +1,36 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Minitest
+  module Distributed
+    module Reporters
+      class TestOrderReporter < Minitest::Reporter
+        extend T::Sig
+
+        sig { params(io: IO, options: T::Hash[Symbol, T.untyped]).void }
+        def initialize(io, options)
+          super
+          @path = T.let(options.fetch(:test_order_file), String)
+          @file = T.let(nil, T.nilable(File))
+        end
+
+        sig { void }
+        def start
+          @file = File.open(@path, "w+")
+          super
+        end
+
+        sig { override.params(klass: Class, name: String).void }
+        def prerecord(klass, name)
+          T.must(@file).puts("#{klass}##{name}")
+          T.must(@file).flush
+        end
+
+        sig { override.void }
+        def report
+          T.must(@file).close
+        end
+      end
+    end
+  end
+end

data/lib/minitest/distributed/result_type.rb

@@ -27,7 +27,9 @@ module Minitest
           "\n\nThe test took %0.3fs to run, longer than the test timeout which is configured to be %0.1fs.\n" \
             "Another worker likely claimed ownership of this test, and will commit the result instead.\n" \
             "For best results, make sure that all your tests finish within %0.1fs.",
-          result.time, test_timeout_seconds, test_timeout_seconds
+          result.time,
+          test_timeout_seconds,
+          test_timeout_seconds,
         )
       end
 

data/lib/minitest/distributed/test_selector.rb

@@ -36,11 +36,21 @@ module Minitest
 
       sig { returns(T::Array[Minitest::Runnable]) }
       def discover_tests
-        Minitest::Runnable.runnables.flat_map do |runnable|
+        runnables.flat_map do |runnable|
           runnable.runnable_methods.map { |method_name| runnable.new(method_name) }
         end
       end
 
+      sig { returns(T::Array[T.class_of(Minitest::Runnable)]) }
+      def runnables
+        if options[:distributed].shuffle_suites
+          srand(Minitest.seed)
+          Minitest::Runnable.runnables.shuffle
+        else
+          Minitest::Runnable.runnables
+        end
+      end
+
       sig { params(tests: T::Array[Minitest::Runnable]).returns(T::Array[Minitest::Runnable]) }
       def select_tests(tests)
         return tests if filters.empty?

data/lib/minitest/distributed/version.rb

@@ -3,6 +3,6 @@
 
 module Minitest
   module Distributed
-    VERSION = "0.2.7"
+    VERSION = "0.2.9"
   end
 end

data/lib/minitest/distributed_plugin.rb

@@ -8,10 +8,17 @@ module Minitest
     extend T::Sig
 
     def plugin_distributed_options(opts, options)
+      continuous_integration = ENV.fetch("CI", "false") == "true"
+      options[:disable_distributed] = !continuous_integration
+
       opts.on("--disable-distributed", "Disable the distributed plugin") do
         options[:disable_distributed] = true
       end
 
+      opts.on("--enable-distributed", "Enable the distributed plugin") do
+        options[:disable_distributed] = false
+      end
+
       options[:distributed] = Minitest::Distributed::Configuration.from_command_line_options(opts, options)
     end
 

data/lib/minitest/test_order_plugin.rb

@@ -0,0 +1,21 @@
+# typed: true
+# frozen_string_literal: true
+
+module Minitest
+  class << self
+    def plugin_test_order_options(opts, options)
+      options[:test_order_file] = ENV["MINITEST_TEST_ORDER"]
+
+      opts.on("--test_order=PATH", "Log order of tests executed to provided file.") do |path|
+        options[:test_order_file] = path
+      end
+    end
+
+    def plugin_test_order_init(options)
+      return if options[:test_order_file].nil?
+
+      require_relative "distributed/reporters/test_order_reporter"
+      reporter << Minitest::Distributed::Reporters::TestOrderReporter.new(options[:io], options)
+    end
+  end
+end

data/minitest-distributed.gemspec

@@ -45,6 +45,6 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency('minitest', '~> 5.12')
-  spec.add_dependency('redis', '>= 4.2', '< 6')
+  spec.add_dependency('redis', '>= 5.0.6', '< 6')
   spec.add_dependency('sorbet-runtime')
 end

data/sorbet/config

@@ -1,2 +1,3 @@
 --dir
 .
+--ignore=vendor

data/sorbet/rbi/gems/ast.rbi

@@ -0,0 +1,49 @@
+# This file is autogenerated. Do not edit it by hand. Regenerate it with:
+#   srb rbi gems
+
+# typed: strict
+#
+# If you would like to make changes to this file, great! Please create the gem's shim here:
+#
+#   https://github.com/sorbet/sorbet-typed/new/master?filename=lib/ast/all/ast.rbi
+#
+# ast-2.4.2
+
+module AST
+end
+class AST::Node
+  def +(array); end
+  def <<(element); end
+  def ==(other); end
+  def append(element); end
+  def assign_properties(properties); end
+  def children; end
+  def clone; end
+  def concat(array); end
+  def deconstruct; end
+  def dup; end
+  def eql?(other); end
+  def fancy_type; end
+  def hash; end
+  def initialize(type, children = nil, properties = nil); end
+  def inspect(indent = nil); end
+  def original_dup; end
+  def to_a; end
+  def to_ast; end
+  def to_s(indent = nil); end
+  def to_sexp(indent = nil); end
+  def to_sexp_array; end
+  def type; end
+  def updated(type = nil, children = nil, properties = nil); end
+end
+class AST::Processor
+  include AST::Processor::Mixin
+end
+module AST::Processor::Mixin
+  def handler_missing(node); end
+  def process(node); end
+  def process_all(nodes); end
+end
+module AST::Sexp
+  def s(type, *children); end
+end

data/sorbet/rbi/gems/connection_pool.rbi

@@ -0,0 +1,55 @@
+# This file is autogenerated. Do not edit it by hand. Regenerate it with:
+#   srb rbi gems
+
+# typed: strict
+#
+# If you would like to make changes to this file, great! Please create the gem's shim here:
+#
+#   https://github.com/sorbet/sorbet-typed/new/master?filename=lib/connection_pool/all/connection_pool.rbi
+#
+# connection_pool-2.3.0
+
+class ConnectionPool
+  def available; end
+  def checkin; end
+  def checkout(options = nil); end
+  def initialize(options = nil, &block); end
+  def reload(&block); end
+  def self.wrap(options, &block); end
+  def shutdown(&block); end
+  def size; end
+  def then(options = nil); end
+  def with(options = nil); end
+end
+class ConnectionPool::TimedStack
+  def <<(obj, options = nil); end
+  def connection_stored?(options = nil); end
+  def current_time; end
+  def empty?; end
+  def fetch_connection(options = nil); end
+  def initialize(size = nil, &block); end
+  def length; end
+  def max; end
+  def pop(timeout = nil, options = nil); end
+  def push(obj, options = nil); end
+  def shutdown(reload: nil, &block); end
+  def shutdown_connections(options = nil); end
+  def store_connection(obj, options = nil); end
+  def try_create(options = nil); end
+end
+class ConnectionPool::Wrapper < BasicObject
+  def initialize(options = nil, &block); end
+  def method_missing(name, *args, **kwargs, &block); end
+  def pool_available; end
+  def pool_shutdown(&block); end
+  def pool_size; end
+  def respond_to?(id, *args); end
+  def with(&block); end
+  def wrapped_pool; end
+end
+class ConnectionPool::Error < RuntimeError
+end
+class ConnectionPool::PoolShuttingDownError < ConnectionPool::Error
+end
+class ConnectionPool::TimeoutError < Timeout::Error
+end

data/sorbet/rbi/gems/minitest-distributed.rbi

@@ -0,0 +1,15 @@
+# This file is autogenerated. Do not edit it by hand. Regenerate it with:
+#   srb rbi gems
+
+# typed: strict
+#
+# If you would like to make changes to this file, great! Please create the gem's shim here:
+#
+#   https://github.com/sorbet/sorbet-typed/new/master?filename=lib/minitest-distributed/all/minitest-distributed.rbi
+#
+# minitest-distributed-0.2.8
+
+module Minitest
+  def self.plugin_junitxml_init(options); end
+  def self.plugin_junitxml_options(opts, options); end
+end