minitest-distributed 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c7cdf0e712969711ce22cfa2f7344b112177eff46d2e632a447b71830a248761
+  data.tar.gz: 5c4e0ebdaf02176ad90d4ae6f907f5fc619c6335f4df64f4667eaaf54e7e657e
+SHA512:
+  metadata.gz: 1858ec3fa36a8f31e2210999d4b5db0d361d6e01169946ecd2f9aec2af19028502d908301dd19e9657be8171001479a0914650a195013c6672f54305f639df87
+  data.tar.gz: e720806c0fefa3958adb4c8170226913eb5c587819eef3666dde63018aacd882355d816384291029c260fc39681bf37ad4140f72cdabb2028303e259d8229c4d

data/.github/workflows/ruby.yml

@@ -0,0 +1,48 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on: push
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    container: ruby:2.6
+
+    services:
+      redis:
+        image: redis
+
+    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://redis:6379
+
+  typecheck:
+    runs-on: ubuntu-latest
+    container: ruby:2.6
+    steps:
+    - uses: actions/checkout@v2
+    - name: Install dependencies
+      run: gem install bundler && bundle install
+    - name: Typecheck Ruby code
+      run: bin/srb tc
+
+  lint:
+    runs-on: ubuntu-latest
+    container: ruby:2.6
+    steps:
+    - uses: actions/checkout@v2
+    - name: Install dependencies
+      run: gem install bundler && bundle install
+    - name: Lint Ruby code
+      run: bin/rubocop

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rubocop.yml

@@ -0,0 +1,63 @@
+inherit_gem:
+  rubocop-shopify: rubocop.yml
+
+require:
+  - rubocop-sorbet
+
+AllCops:
+  TargetRubyVersion: 2.6
+  UseCache: true
+  CacheRootDirectory: tmp/rubocop
+  Exclude:
+    - minitest-distributed.gemspec
+
+Style/MethodCallWithArgsParentheses:
+  IgnoredMethods:
+    - require
+    - require_relative
+    - raise
+    - assert
+    - refute
+    - assert_equal
+    - refute_equal
+    - assert_nil
+    - refute_nil
+    - assert_predicate
+    - refute_predicate
+    - assert_empty
+    - refute_empty
+    - assert_includes
+    - refute_includes
+    - flunk
+
+##### Sorbet cops
+
+Sorbet:
+  Enabled: true
+  Exclude:
+    - bin/*
+    - test/fixtures/*
+    - Gemfile
+    - Rakefile
+    - minitest-distributed.gemspec
+
+Sorbet/ValidSigil:
+  Enabled: true
+
+Sorbet/TrueSigil:
+  Enabled: true
+
+Sorbet/EnforceSigilOrder:
+  Enabled: true
+
+Sorbet/SignatureBuildOrder:
+  Enabled: true
+
+Sorbet/KeywordArgumentOrdering:
+  Enabled: true
+
+Sorbet/ConstantsFromStrings:
+  Enabled: true
+
+Sorbet/ForbidIncludeConstLiteral:
+  Enabled: true

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.5
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at willem@vanbergen.org. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in minitest-stateful.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "minitest", "~> 5.0"
+gem "sorbet"
+gem "rubocop"
+gem "rubocop-shopify"
+gem "rubocop-sorbet"

data/Gemfile.lock

@@ -0,0 +1,53 @@
+PATH
+  remote: .
+  specs:
+    minitest-distributed (0.1.0)
+      minitest (~> 5.12)
+      redis (~> 4.1)
+      sorbet-runtime
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    jaro_winkler (1.5.4)
+    minitest (5.14.0)
+    parallel (1.19.1)
+    parser (2.7.1.2)
+      ast (~> 2.4.0)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    redis (4.2.1)
+    rexml (3.2.4)
+    rubocop (0.82.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      rexml
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-shopify (1.0.2)
+      rubocop (~> 0.82.0)
+    rubocop-sorbet (0.3.7)
+    ruby-progressbar (1.10.1)
+    sorbet (0.5.5605)
+      sorbet-static (= 0.5.5605)
+    sorbet-runtime (0.5.5765)
+    sorbet-static (0.5.5605-universal-darwin-14)
+    unicode-display_width (1.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  minitest (~> 5.0)
+  minitest-distributed!
+  rake (~> 12.0)
+  rubocop
+  rubocop-shopify
+  rubocop-sorbet
+  sorbet
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Willem van Bergen, Shopify Inc.
+
+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/README.md

@@ -0,0 +1,115 @@
+# minitest-distributed
+
+`minitest-distributed` is a plugin for [minitest](https://github.com/seattlerb/minitest)
+for executing tests on a distributed set of unreliable workers.
+
+When a test suite grows large enough, it inevitable gets too slow to run on a
+single machine to give timely feedback to developers. This plugins combats
+this issue by distributing the full test suite to a set of workers. Every
+worker is a consuming from a single queue, so the tests get evenly distributed
+and all workers will finish around the same time. Redis is used as
+coordinator, but when using this plugin without having access to Redis, it
+will use an in-memory coordinator.
+
+Using multiple (virtual) machines for a test run is an (additional) source of
+flakiness. To combat flakiness, minitest-distributed implements resiliency
+patterns, like re-running a test on a different worker on failure, and a
+circuit breaker for misbehaving workers.
+
+## Usage
+
+Add `minitest-distributed` to your `Gemfile`, and run `bundle install`. The
+plugin will be loaded by minitest automatically. The plugin exposes some
+command line arguments that you can use to influence its behavior. They can
+also be set using environment variables.
+
+### Distributed invocation
+
+To actually run tests with multiple workers, you have to point every worker to
+a Redis coordinator, and use the same run identifier.
+
+``` sh
+ruby -Itest --coordinator=redis://localhost/1 --run-id=<BUILD_NUMBER> test/my_test.rb
+```
+
+We recommend using the build number or identifier form your CI system as run
+identifier, but it will work with any value that is shared between all
+workers. You can also set these values by setting the `MINITEST_COORDINATOR`
+and `MINITEST_RUN_ID` environment variables, respectively.
+
+If you are using a Rails project, the Rails test runner (`bin/rails test`)
+will also support these command line arguments and environment variables.
+
+If you are using a `Rake::TestTask` to invoke your test suite, you can set
+these command line arguments using `options`:
+
+``` ruby
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test" << "lib"
+  t.warning = false
+  t.options = "--coordinator=redis://localhost/1 --run-id=<BUILD_NUMBER>"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+```
+
+### Worker retries
+
+Many CI systems offer the options to retry jobs that fail. When jobs are
+retried that were previously part of a worker cluster, all the retried jobs
+together will form a new cluster, and will only run the tests that failed
+during the previous run attempt. This is to make it faster to re-run tests
+that failed due to flakiness, or confirm that it was not flakiness that caused
+them to fail.
+
+### Other optional command line arguments
+
+- `--test-timeout=SECONDS` or `ENV[MINITEST_TEST_TIMEOUT]` (default: 30s): the
+  maximum amount a test is allowed to run before it times out. In a distributed
+  system, it's impossible to differentiate between a worker being slow and a
+  worker being broken. When the timeout passes, the other workers will assume
+  that the worker running the test has crashed, and will attempt to claim this
+  test. This value should be comfortably higher than your slowest test.
+- `--max-attempts=NUMBER` or `ENV[MINITEST_MAX_ATTEMPTS]` (default: 3). The
+  maximum number of times a test is attempted to be run, before considering
+  it failed. Higher values will prevent more flakiness, but will make the full
+  test run slower.
+- `--test-batch-size=NUMBER` or `ENV[MINITEST_TEST_BATCH_SIZE]` (default: 10).
+  The amount of tests to process per batch. Lower numbers will make the
+  distribution of tests more granular and even, but increase the load on the
+  coordinator.
+- `--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.
+
+## Limitations
+
+**Parallel tests not supported:** Minitest comes bundled with a parallel test
+executor, which will run tests that are specifically tagged as such in
+parallel in the same process. `minitest-distributed` is designed to run tests
+in parallel  using separate processes, generally on different VMs. For this
+reason, tests marked as `parallel` will not be treated any differently than
+other tests.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then,
+run `rake test` to run the tests. You can also run `bin/console` for an
+interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+To release a new version, update the version number in `version.rb`, and then
+run `bundle exec rake release`, which will create a git tag for the version,
+push git commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Shopify/minitest-distributed. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/Shopify/minitest-distributed/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Minitest::Stateful project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/Shopify/minitest-distributed/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test" << "lib"
+  t.warning = false
+  t.test_files = FileList["test/**/*_test.rb"] -
+    FileList["test/fixtures/**/*_test.rb"] - FileList["test/lib/**/*_test.rb"]
+end
+
+task(default: :test)

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "minitest/distributed"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)