minitest-distributed 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 829613fe27e895208e49a116fd8f72e3685e1e91eb95209db170ad51707d2115
-  data.tar.gz: 1e0932553fe7d007e40392f53f80dd49eb6dafd533077d8234d4feb86629e8d4
+  metadata.gz: 6a8b0499822e88334b7ce7d06210c43d3054485d4dbbc3170f97e485c5d78c3d
+  data.tar.gz: 2e4c720af2bf722152ace13867b0cf66c58aafbf712ac1a5d4b9e308f0c2fd8f
 SHA512:
-  metadata.gz: 71dbe335df12886c11af8f438dec954678ad9d5841847e44521e492dfc641eddc76da66e73c0f5d96840f75746e027f3304d08ed46171817a0541d773495b32f
-  data.tar.gz: fb5a8f6f781c71944df6228e4da980b29f2bd01fd9733aebe10437ac8eaa867d7d55b49397ad2d4f1acca9d503e8b2a8191fcfc8f935675a78f9d75208e0a39f
+  metadata.gz: 8c974a610c8770a9a0ff8c944780182a178fbe1d22737a53a474b9f8f2abcd90765aac1f6a0ee9134cddb1e19dca235bb124b7950585337579b7dba5d4ebf956
+  data.tar.gz: 8337bf3b5c849d386ccbdb13e4cba6d725a274ead9893c60f3d60f9599e5ba7cde0e12ceea035219483ebd9aee0fc06ee9cc9e6a4747c08663f133dab30fd4d0

data/Gemfile

@@ -4,7 +4,7 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in minitest-distributed.gemspec
 gemspec
 
-gem "rake", "~> 12.0"
+gem "rake"
 gem "minitest", "~> 5.0"
 gem "sorbet"
 gem "rubocop"

data/README.md

@@ -80,6 +80,12 @@ 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 
+  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 
+  newlines.
 
 ## Limitations
 

data/lib/minitest/distributed/configuration.rb

@@ -71,12 +71,21 @@ module Minitest
             configuration.progress = enabled
           end
 
+          opts.on('--exclude-file=FILE_PATH', "Specify a file of tests to be excluded from running") do |file_path|
+            configuration.exclude_file = file_path
+          end
+
+          opts.on('--include-file=FILE_PATH', "Specify a file of tests to be included in the test run") do |file_path|
+            configuration.include_file = file_path
+          end
+
           configuration
         end
       end
 
       extend T::Sig
 
+      # standard minitest options don't need to be specified
       prop :coordinator_uri, URI::Generic, default: URI('memory:')
       prop :run_id, String, factory: -> { SecureRandom.uuid }
       prop :worker_id, String, factory: -> { SecureRandom.uuid }
@@ -86,6 +95,8 @@ module Minitest
       prop :max_failures, T.nilable(Integer)
       prop :retry_failures, T::Boolean, default: true
       prop :progress, T::Boolean, default: false
+      prop :exclude_file, T.nilable(String)
+      prop :include_file, T.nilable(String)
 
       sig { returns(Coordinators::CoordinatorInterface) }
       def coordinator

data/lib/minitest/distributed/filters/exclude_file_filter.rb

@@ -0,0 +1,18 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Minitest
+  module Distributed
+    module Filters
+      class ExcludeFileFilter < FileFilterBase
+        extend T::Sig
+        include FilterInterface
+
+        sig { override.params(runnable: Minitest::Runnable).returns(T::Array[Runnable]) }
+        def call(runnable)
+          tests.include?(DefinedRunnable.identifier(runnable)) ? [] : [runnable]
+        end
+      end
+    end
+  end
+end

data/lib/minitest/distributed/filters/file_filter_base.rb

@@ -0,0 +1,29 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Minitest
+  module Distributed
+    module Filters
+      class FileFilterBase
+        extend T::Sig
+
+        sig { returns(Pathname) }
+        attr_reader :file
+
+        sig { params(file: Pathname).void }
+        def initialize(file)
+          @file = file
+          @tests = T.let(nil, T.nilable(T::Set[String]))
+        end
+
+        sig { returns(T::Set[String]) }
+        def tests
+          @tests ||= begin
+            tests = File.readlines(@file, chomp: true)
+            Set.new(tests)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/minitest/distributed/filters/include_file_filter.rb

@@ -0,0 +1,18 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Minitest
+  module Distributed
+    module Filters
+      class IncludeFileFilter < FileFilterBase
+        extend T::Sig
+        include FilterInterface
+
+        sig { override.params(runnable: Minitest::Runnable).returns(T::Array[Runnable]) }
+        def call(runnable)
+          tests.include?(DefinedRunnable.identifier(runnable)) ? [runnable] : []
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,150 @@
+# typed: strict
+# frozen_string_literal: true
+
+require 'rexml/document'
+require 'fileutils'
+
+module Minitest
+  module Distributed
+    module Reporters
+      # Reporter that generates a JUnit XML report of the results it is presented.
+      #
+      # The JUnitXML schema is not very well standardized, and many implementations deviate
+      # from the schema (see https://www.ibm.com/support/knowledgecenter/SSQ2R2_14.2.0/com.ibm.rsar.analysis.codereview.cobol.doc/topics/cac_useresults_junit.html).
+      #
+      # This JunitXML importer embraces this flexibility, and extends the format with some additional
+      # information that we can use to create more meaningful annotations. For instance, the information
+      # can be use to set annotations on your build system or for annotations using the GitHub checks API.
+      #
+      # For the implementation, we use REXML to prevent the need of additional dependencies on this gem.
+      # We also use XML 1.1, which allows more characters to be valid. We are primarily interested in
+      # this so \e is an allowed character, which is used for ANSI color coding.
+      class JUnitXMLReporter < Minitest::Reporter
+        extend T::Sig
+
+        sig { returns(T::Hash[String, T::Array[Minitest::Result]]) }
+        attr_reader :results
+
+        sig { params(io: IO, options: T::Hash[Symbol, T.untyped]).void }
+        def initialize(io, options)
+          @io = io
+          @report_path = T.let(options.fetch(:junitxml), String)
+          @results = T.let(Hash.new { |hash, key| hash[key] = [] }, T::Hash[String, T::Array[Minitest::Result]])
+        end
+
+        sig { override.params(result: Minitest::Result).void }
+        def record(result)
+          case (result_type = ResultType.of(result))
+          when ResultType::Passed, ResultType::Failed, ResultType::Error
+            T.must(results[result.klass]) << result
+          when ResultType::Skipped, ResultType::Requeued, ResultType::Discarded
+            # We will not include skipped, requeued, and discarded tests in JUnitXML reports,
+            # because they will not fail builds, but also didn't pass.
+          else
+            T.absurd(result_type)
+          end
+        end
+
+        sig { override.void }
+        def report
+          FileUtils.mkdir_p(File.dirname(@report_path))
+          File.open(@report_path, 'w+') do |file|
+            format_document(generate_document, file)
+          end
+        end
+
+        sig { returns(REXML::Document) }
+        def generate_document
+          doc = REXML::Document.new(nil, prologue_quote: :quote, attribute_quote: :quote)
+          doc << REXML::XMLDecl.new('1.1', 'utf-8')
+
+          testsuites = doc.add_element('testsuites')
+          results.each do |suite, tests|
+            add_tests_to(testsuites, suite, tests)
+          end
+          doc
+        end
+
+        sig { params(doc: REXML::Document, io: IO).void }
+        def format_document(doc, io)
+          formatter = REXML::Formatters::Pretty.new
+          formatter.write(doc, io)
+          io << "\n"
+        end
+
+        private
+
+        sig { params(testsuites: REXML::Element, suite: String, results: T::Array[Minitest::Result]).void }
+        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))
+          )
+
+          results.each do |test|
+            attributes = {
+              'name' => test.name,
+              'classname' => suite,
+              'assertions' => test.assertions,
+              'time' => test.time,
+              # 'run-command' => ... # TODO
+            }
+            attributes['lineno'] = lineno if lineno != -1
+
+            testcase_tag = testsuite.add_element('testcase', attributes)
+            add_failure_tag_if_needed(testcase_tag, test)
+          end
+        end
+
+        sig { params(testcase: REXML::Element, result: Minitest::Result).void }
+        def add_failure_tag_if_needed(testcase, result)
+          case (result_type = ResultType.of(result))
+          when ResultType::Passed, ResultType::Skipped, ResultType::Requeued, ResultType::Discarded
+            # noop
+          when ResultType::Error, ResultType::Failed
+            failure = T.must(result.failure)
+            failure_tag = testcase.add_element('failure',
+              'type' => result_type.serialize,
+              'message' => truncate_message(failure.message))
+            failure_tag.add_text(REXML::CData.new(result.to_s))
+          else
+            T.absurd(result_type)
+          end
+        end
+
+        sig { params(message: String).returns(String) }
+        def truncate_message(message)
+          T.must(message.lines.first).chomp.gsub(/\e\[[^m]+m/, '')
+        end
+
+        sig { params(results: T::Array[Minitest::Result]).returns(T::Hash[String, Numeric]) }
+        def aggregate_suite_results(results)
+          aggregate = Hash.new(0)
+          results.each do |result|
+            aggregate['assertions'] += result.assertions
+            aggregate['failures'] += 1 if failure?(ResultType.of(result))
+            aggregate['tests'] += 1
+            aggregate['time'] += result.time
+          end
+          aggregate
+        end
+
+        sig { params(result_type: ResultType).returns(T::Boolean) }
+        def failure?(result_type)
+          case result_type
+          when ResultType::Failed, ResultType::Error
+            true
+          when ResultType::Passed, ResultType::Skipped, ResultType::Discarded, ResultType::Requeued
+            false
+          else
+            T.absurd(result_type)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/minitest/distributed/test_selector.rb

@@ -1,6 +1,8 @@
 # typed: strict
 # frozen_string_literal: true
 
+require 'pathname'
+
 module Minitest
   module Distributed
     class TestSelector
@@ -24,6 +26,12 @@ module Minitest
       def initialize_filters
         @filters << Filters::IncludeFilter.new(options[:filter]) if options[:filter]
         @filters << Filters::ExcludeFilter.new(options[:exclude]) if options[:exclude]
+
+        exclude_file = options[:distributed].exclude_file
+        @filters << Filters::ExcludeFileFilter.new(Pathname.new(exclude_file)) if exclude_file
+
+        include_file = options[:distributed].include_file
+        @filters << Filters::IncludeFileFilter.new(Pathname.new(include_file)) if include_file
       end
 
       sig { returns(T::Array[Minitest::Runnable]) }

data/lib/minitest/distributed/version.rb

@@ -3,6 +3,6 @@
 
 module Minitest
   module Distributed
-    VERSION = "0.2.1"
+    VERSION = "0.2.2"
   end
 end

data/lib/minitest/distributed.rb

@@ -13,6 +13,9 @@ require "minitest/distributed/result_aggregate"
 require "minitest/distributed/filters/filter_interface"
 require "minitest/distributed/filters/include_filter"
 require "minitest/distributed/filters/exclude_filter"
+require "minitest/distributed/filters/file_filter_base"
+require "minitest/distributed/filters/exclude_file_filter"
+require "minitest/distributed/filters/include_file_filter"
 require "minitest/distributed/coordinators/coordinator_interface"
 require "minitest/distributed/coordinators/memory_coordinator"
 require "minitest/distributed/coordinators/redis_coordinator"

data/lib/minitest/junitxml_plugin.rb

@@ -0,0 +1,21 @@
+# typed: true
+# frozen_string_literal: true
+
+module Minitest
+  class << self
+    def plugin_junitxml_options(opts, options)
+      options[:junitxml] = ENV['MINITEST_JUNITXML']
+
+      opts.on('--junitxml=PATH', "Generate a JUnitXML report at the specified path") do |path|
+        options[:junitxml] = path
+      end
+    end
+
+    def plugin_junitxml_init(options)
+      return if options[:junitxml].nil?
+
+      require 'minitest/distributed/reporters/junitxml_reporter'
+      reporter << Minitest::Distributed::Reporters::JUnitXMLReporter.new(options[:io], options)
+    end
+  end
+end

data/sorbet/rbi/minitest.rbi

@@ -1,11 +1,4 @@
-# This file is autogenerated. Do not edit it by hand. Regenerate it with:
-#   srb rbi sorbet-typed
-#
-# If you would like to make changes to this file, great! Please upstream any changes you make here:
-#
-#   https://github.com/sorbet/sorbet-typed/edit/master/lib/minitest/all/minitest.rbi
-#
-# typed: strong
+# typed: true
 
 module Minitest
   class Runnable
@@ -19,6 +12,8 @@ module Minitest
     def time=(duration); end
     def failures; end
     def failures=(failures); end
+    def assertions; end
+    def assertions=(assertions); end
     def source_location; end
     def source_location=(value); end
     def klass; end
@@ -70,6 +65,11 @@ module Minitest
   end
 
   class UnexpectedError < Assertion
+    sig { params(error: Exception).void }
+    def initialize(error); end
+
+    sig { returns(Exception) }
+    def error; end
   end
 
   class AbstractReporter
@@ -131,6 +131,9 @@ module Minitest
 
   sig { returns(Float) }
   def self.clock_time; end
+
+  def self.backtrace_filter; end
+  def self.backtrace_filter=(filter); end
 end
 
 module Minitest::Assertions

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: minitest-distributed
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Willem van Bergen
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-26 00:00:00.000000000 Z
+date: 2022-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -77,7 +77,6 @@ files:
 - ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rubocop.yml"
-- ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -94,11 +93,15 @@ files:
 - lib/minitest/distributed/coordinators/memory_coordinator.rb
 - lib/minitest/distributed/coordinators/redis_coordinator.rb
 - lib/minitest/distributed/enqueued_runnable.rb
+- lib/minitest/distributed/filters/exclude_file_filter.rb
 - lib/minitest/distributed/filters/exclude_filter.rb
+- lib/minitest/distributed/filters/file_filter_base.rb
 - lib/minitest/distributed/filters/filter_interface.rb
+- lib/minitest/distributed/filters/include_file_filter.rb
 - lib/minitest/distributed/filters/include_filter.rb
 - lib/minitest/distributed/reporters/distributed_progress_reporter.rb
 - lib/minitest/distributed/reporters/distributed_summary_reporter.rb
+- lib/minitest/distributed/reporters/junitxml_reporter.rb
 - lib/minitest/distributed/reporters/redis_coordinator_warnings_reporter.rb
 - lib/minitest/distributed/result_aggregate.rb
 - lib/minitest/distributed/result_type.rb
@@ -106,6 +109,7 @@ files:
 - lib/minitest/distributed/test_selector.rb
 - lib/minitest/distributed/version.rb
 - lib/minitest/distributed_plugin.rb
+- lib/minitest/junitxml_plugin.rb
 - minitest-distributed.gemspec
 - sorbet/config
 - sorbet/rbi/minitest.rbi
@@ -120,7 +124,7 @@ metadata:
   allowed_push_host: https://rubygems.org
   homepage_uri: https://github.com/Shopify/minitest-distributed
   source_code_uri: https://github.com/Shopify/minitest-distributed
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -135,8 +139,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key:
+rubygems_version: 3.2.20
+signing_key: 
 specification_version: 4
 summary: Distributed test executor plugin for Minitest
 test_files: []

data/.travis.yml

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