minitest-silence 0.1.0 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f6db18145fa32f96ca4c2f3ca5fe7099949b0603ee5fdff92981564f1b18e606
-  data.tar.gz: 456dcf9fe20ddc6302d1c1a611958c65752d3177f31184ab467a9ff53d9946ff
+  metadata.gz: ba38e3bdb96751df36f3ea01b1e81cf30bd4d0a4368c251ea6e1ddae9b443b2e
+  data.tar.gz: 796edae9f0796115e6ae2695e1c7bde32d587013ce2ac4582f6466fa1151a382
 SHA512:
-  metadata.gz: fa01057df17eb458c34fa559e5b108583cc614b669d85657eb22d254e5ad6b171257f0a39291eb87bb93a93723a8624fbdc8804571fd4c2bd38ab14824be050f
-  data.tar.gz: 6f318bca2ebe5dab21ab5f07ad32ace16b9d02838d25d96d72c8ce843096b1166b03ca79a1f5aa2ccc71944c6f42d7cda6af1a33e3dcacdf6c81433230fa4c55
+  metadata.gz: 324baca320f1db91b0e0a226034626d2fe280a3386c171412bdb6e48ad3a0450eb321304ae9af320f0e2e4163f80faf45b5fc9a821ed4b654fbdcde1aab927c1
+  data.tar.gz: 622f58efbca12b35eb445fccd5f22c2214fdf26536412d85b9b076cac7863e1a8e2bcbd8115ddd8064194762dcf8daa83b3fbb73a8db35e50948fffd30c359d2

data/.gitignore

@@ -6,3 +6,5 @@
 /pkg/
 /spec/reports/
 /tmp/
+.byebug_history
+Gemfile.lock

data/Gemfile

@@ -7,3 +7,4 @@ gemspec
 gem "rake", "~> 12.0"
 gem "minitest", "~> 5.0"
 gem "rubocop-shopify"
+gem "byebug"

data/README.md

@@ -1,6 +1,12 @@
 # Minitest::Silence
 
-Minitest plugin to suppress output from tests. This plugin will buffer any output coming from a test going to STDOUT or STDERR, to make sure it doesn't interfere with the output of the test runner itself. By default, it will discard any output, unless the `--verbose` option is set. It also supports failing a test if it is writing anything to STDOUT or STDERR by setting the `--fail-on-output` command line option.
+Minitest plugin to capture output to stdout and stderr from tests.
+
+It's best practice for tests to not write anything to `STDOUT` or `STDERR` while running. Besides it being an implicit dependency, it interferes with the output from the test runner. Even though this is a best practice, when your test suite grows large enough, it becomes almost impossible to make sure every test conforms to this best practice.
+
+This plugins aims to solve this problem by rebinding `STDOUT` and `STDERR` while a test is running. Any output written will be redirected to a pipe, so it won't interfere with the output of the test runner. The plugin will also bind `STDIN` to `/dev/null`. This codifies the best practice that automated tests should not depend on user input.
+
+This plugin is inspired by [how the Python test runner handles output](https://docs.pytest.org/en/stable/capture.html).
 
 ## Installation
 
@@ -12,11 +18,13 @@ gem 'minitest-silence', require: false
 
 ## Usage
 
-The plugin will be automatically activated by Minitest if it is in your application's bundle.
+The plugin will be automatically loaded by Minitest if it is in your application's bundle.
+
+- By default, output will be written to `STDOUT` and `STDERR` normally for local test runs, and captured for CI runs. In CI (environments with `ENV["CI"]` set), out put will be captured and discarded, so the output of the test runner will look like how it was intended.
+-  If you run tests with the `--verbose` option , it will be nicely included in the test runner's output, inside a box that will tell you what test it originated from.
+- You can also run this plugin in "strict mode": by running tests with the `--fail-on-output` option, tests will fail if they produce any output to `STDOUT` or `STDERR`.
 
-- By default, it will simply discard any output writting to `STDOUT` or `STDERR` by your tests.
-- When specifying `--verbose`, the output will be buffered and written to the `STDOUT` inside a box that makes clear what test the output originated from.
-- When running with the `--fail-on-output` option, a test will fail if it writes anything to either `STDOUT` or `STDERR`.
+You can enable the plugin in any environment by providing the `--enable-silence` command line option to your test invocation. The primary use case for this is when you want to silence output locally.
 
 ## Development
 
@@ -26,7 +34,7 @@ To install this gem onto your local machine, run `bin/rake install`. To release
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/Shopifyminitest-silence. 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-silence/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/Shopify/minitest-silence. 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-silence/blob/master/CODE_OF_CONDUCT.md).
 
 ## License
 

data/lib/minitest/silence/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 module Minitest
   module Silence
-    VERSION = "0.1.0"
+    VERSION = "0.2.4"
   end
 end

data/lib/minitest/silence_plugin.rb

@@ -16,24 +16,30 @@ module Minitest
 
     module RunOneMethodPatch
       def run_one_method(klass, method_name)
+        @original_stdin ||= $stdin.dup
+        @original_stdout ||= $stdout.dup
+        @original_stderr ||= $stderr.dup
+
         output_reader, output_writer = IO.pipe
         output_thread = Thread.new { output_reader.read }
 
-        old_stdout = $stdout.dup
-        old_stderr = $stderr.dup
-
         result = begin
           $stdout.reopen(output_writer)
           $stderr.reopen(output_writer)
+          $stdin.reopen(File::NULL)
+
           super
         ensure
-          $stdout.reopen(old_stdout)
-          $stderr.reopen(old_stderr)
+          $stdout.reopen(@original_stdout)
+          $stderr.reopen(@original_stderr)
+          $stdin.reopen(@original_stdin)
           output_writer.close
         end
 
         result.output = output_thread.value
         result
+      ensure
+        output_reader.close
       end
     end
 
@@ -48,21 +54,26 @@ module Minitest
 
   class << self
     def plugin_silence_options(opts, options)
+      opts.on('--enable-silence', "Rebind standard IO") do
+        options[:enable_silence] = true
+      end
       opts.on('--fail-on-output', "Fail a test when it writes to STDOUT or STDERR") do
         options[:fail_on_output] = true
       end
     end
 
     def plugin_silence_init(options)
-      Minitest::Result.prepend(Minitest::Silence::ResultOutputPatch)
-      Minitest.singleton_class.prepend(Minitest::Silence::RunOneMethodPatch)
+      if options[:enable_silence] || ENV["CI"]
+        Minitest::Result.prepend(Minitest::Silence::ResultOutputPatch)
+        Minitest.singleton_class.prepend(Minitest::Silence::RunOneMethodPatch)
 
-      if options[:fail_on_output]
-        # We have to make sure this reporter runs as the first reporter, so it can still adjust
-        # the result and other reporters will take the change into account.
-        reporter.reporters.unshift(Minitest::Silence::FailOnOutputReporter.new(options[:io], options))
-      elsif options[:verbose]
-        reporter << Minitest::Silence::BoxedOutputReporter.new(options[:io], options)
+        if options[:fail_on_output]
+          # We have to make sure this reporter runs as the first reporter, so it can still adjust
+          # the result and other reporters will take the change into account.
+          reporter.reporters.unshift(Minitest::Silence::FailOnOutputReporter.new(options[:io], options))
+        elsif options[:verbose]
+          reporter << Minitest::Silence::BoxedOutputReporter.new(options[:io], options)
+        end
       end
     end
   end

data/minitest-silence.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |spec|
   DESCRIPTION
   spec.homepage      = "https://github.com/Shopify/minitest-silence"
   spec.license       = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
 
   spec.metadata["allowed_push_host"] = "https://rubygems.org"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: minitest-silence
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.4
 platform: ruby
 authors:
 - Willem van Bergen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-03 00:00:00.000000000 Z
+date: 2021-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -42,7 +42,6 @@ files:
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -70,14 +69,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Minitest plugin to suppress output from tests.

data/Gemfile.lock

@@ -1,42 +0,0 @@
-PATH
-  remote: .
-  specs:
-    minitest-silence (0.1.0)
-      minitest (~> 5.12)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    ast (2.4.0)
-    jaro_winkler (1.5.4)
-    minitest (5.14.1)
-    parallel (1.19.1)
-    parser (2.7.1.3)
-      ast (~> 2.4.0)
-    rainbow (3.0.0)
-    rake (12.3.3)
-    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)
-    ruby-progressbar (1.10.1)
-    unicode-display_width (1.7.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  minitest (~> 5.0)
-  minitest-silence!
-  rake (~> 12.0)
-  rubocop-shopify
-
-BUNDLED WITH
-   2.1.4