megatest 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b3e0e26b309c6dc9a83268b28c18cb4d47b0faec34fe15f6fb5914a694350ae7
-  data.tar.gz: bcfe062aa918605ef748d2bf5464a95a46f99ed84b3d2e7881877f68de96cf01
+  metadata.gz: 5ef5044b5a70005d87f32c0da4add1e5270d3a298b20a12f4da2fefcb3b64781
+  data.tar.gz: 273e19eed16d3ad7ade77b297ee8e5819629e48d4c106808d52fbf0572538643
 SHA512:
-  metadata.gz: afa34f618e96539d243b93c08f51b8e431c90eba33d253c90ae0ead4bfcd8e87ba20f5a484a62211d160eeefd9017bcf24a5a8299b744013e210350e3adb99d9
-  data.tar.gz: c6ae412861315e06207a462ae528230778075e9fec55b7e4f91860b90feea5bad4a784a44fa0034c81d69c77be4b7d27821703810162d5367f537f0380a3df44
+  metadata.gz: 1179b7d68e1bfd7fd614404ef3ab4e9c724af6be4944a68160de44ec0857c120f08ba363acacee46efed133d532cc9aec27d8b8432831d61373a8c845df54a33
+  data.tar.gz: 81950c2704d1553a4f6239c3bf45b96213b1418c79293d8dd9070405f884c0514e2851cb8b528ce12e84525cd96b7e0eb59a76a3a24d25abe958a56ec5f142cd

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## [Unreleased]
 
+- Make the VerboseReporter work with concurrent executors.
+- Fix isolated tests on forkless platforms when the config contains procs.
+- Add a `job_teardown callback` to to stand off for at_exit.
+- Add `stub`, `stub_const` and `stub_any_instance_of`.
+- Add support for `-I` in the CLI.
+
 ## [0.1.1] - 2024-08-20
 
 - Fix `$PATH` prefix detection.

data/TODO.md

@@ -1,5 +1,7 @@
 ### Wants
 
+- Improve run by line number: if no exact match fallback to the previous one.
+
 - Test leak bisect
   - See ci-queue bisect.
 

data/lib/megatest/cli.rb

@@ -196,6 +196,12 @@ module Megatest
         opts.separator "Options:"
         opts.separator ""
 
+        opts.on("-I PATHS", "specify $LOAD_PATH directory (may be used more than once)") do |paths|
+          paths.split(":").each do |path|
+            $LOAD_PATH.unshift(path)
+          end
+        end
+
         opts.on("-b", "--backtrace", "Print full backtraces") do
           @config.backtrace.full!
         end

data/lib/megatest/config.rb

@@ -158,6 +158,7 @@ module Megatest
       @before_fork_callbacks = []
       @global_setup_callbacks = []
       @job_setup_callbacks = []
+      @job_teardown_callbacks = []
       @heartbeat_frequency = 5
       @backtrace = Backtrace.new
       @program_name = nil
@@ -264,6 +265,14 @@ module Megatest
       @job_setup_callbacks << block
     end
 
+    def run_job_teardown_callbacks(job_index)
+      @job_teardown_callbacks.each { |c| c.call(self, job_index) }
+    end
+
+    def job_teardown(&block)
+      @job_teardown_callbacks << block
+    end
+
     def retries?
       @max_retries.positive?
     end
@@ -275,6 +284,19 @@ module Megatest
         @max_retries * size
       end
     end
+
+    NOT_SERIALIZED = %i(@job_teardown_callbacks @job_setup_callbacks @global_setup_callbacks).freeze
+    def marshal_dump
+      instance_variables.reject { |k| NOT_SERIALIZED.include?(k) }.to_h do |name|
+        [name, instance_variable_get(name)]
+      end
+    end
+
+    def marshal_load(hash)
+      hash.each do |name, value|
+        instance_variable_set(name, value)
+      end
+    end
   end
 
   @config = Config.new({})

data/lib/megatest/executor.rb

@@ -53,6 +53,10 @@ module Megatest
       @out = Output.new(out, colors: @config.colors)
     end
 
+    def concurrent?
+      false
+    end
+
     def run(queue, reporters)
       start_time = Megatest.now
 
@@ -98,6 +102,8 @@ module Megatest
         @out.error("Exited early because too many failures were encountered")
       end
 
+      @config.run_job_teardown_callbacks(nil)
+
       queue.cleanup
     end
   end

data/lib/megatest/multi_process.rb

@@ -27,7 +27,7 @@ module Megatest
       def <<(message)
         begin
           @socket.write(Marshal.dump(message))
-        rescue Errno::EPIPE
+        rescue Errno::EPIPE, Errno::ENOTCONN
           return nil # Other side was closed
         end
         self
@@ -113,6 +113,7 @@ module Megatest
 
           # We don't want to run at_exit hooks the app may have
           # installed.
+          @config.run_job_teardown_callbacks(@index)
           Process.exit!(0)
         end
         @child_socket.close
@@ -157,15 +158,17 @@ module Megatest
           @parent_socket.close
         when :pop
           if @assigned_test = queue.pop_test
+            reporters.each { |r| r.before_test_case(queue, @assigned_test) }
             @parent_socket << @assigned_test&.id
           else
             @idle = true
           end
         when :record
           result = queue.record_result(*args)
+          test_case = @assigned_test
           @assigned_test = nil
           @parent_socket << result
-          reporters.each { |r| r.after_test_case(queue, nil, result) }
+          reporters.each { |r| r.after_test_case(queue, test_case, result) }
           @config.circuit_breaker.record_result(result)
         else
           raise "Unexpected message: #{message.inspect}"
@@ -208,6 +211,10 @@ module Megatest
         @out = Output.new(out, colors: config.colors)
       end
 
+      def concurrent?
+        true
+      end
+
       def after_fork_in_child(active_job)
         @jobs.each do |job|
           job.close unless job == active_job
@@ -217,6 +224,7 @@ module Megatest
       def run(queue, reporters)
         start_time = Megatest.now
         @config.run_global_setup_callbacks
+        reporters.each { |r| r.start(self, queue) }
         @jobs = @config.jobs_count.times.map { |index| Job.new(@config, index) }
 
         @config.before_fork_callbacks.each(&:call)

data/lib/megatest/reporters.rb

@@ -125,12 +125,37 @@ module Megatest
     end
 
     class VerboseReporter < SimpleReporter
+      def start(executor, _queue)
+        @concurrent = executor.concurrent?
+      end
+
       def before_test_case(_queue, test_case)
-        @out.print("#{test_case.id} = ")
+        unless @concurrent
+          @out.print("#{test_case.id} = ")
+        end
       end
 
-      def after_test_case(_queue, _test_case, result)
-        super
+      def after_test_case(_queue, test_case, result)
+        if @concurrent
+          @out.print("#{test_case.id} = ")
+        end
+
+        if result.skipped?
+          @out.print(@out.yellow("SKIPPED"))
+        elsif result.retried?
+          @out.print(@out.yellow("RETRIED"))
+        elsif result.error?
+          @out.print(@out.red("ERROR"))
+        elsif result.failed?
+          @out.print(@out.red("FAILED"))
+        else
+          @out.print(@out.green("SUCCESS"))
+        end
+
+        if result.duration
+          @out.print " (in #{result.duration.round(3)}s)"
+        end
+
         @out.puts
         if result.bad?
           @out.puts @out.colored(render_failure(result))

data/lib/megatest/runner.rb

@@ -88,6 +88,8 @@ module Megatest
 
           result.ensure_assertions unless @config.minitest_compatibility
         ensure
+          runtime.teardown
+
           runtime.record_failures do
             instance.before_teardown
           end

data/lib/megatest/runtime.rb

@@ -4,13 +4,14 @@
 
 module Megatest
   class Runtime
-    attr_reader :test_case, :result
+    attr_reader :config, :test_case, :result, :on_teardown
 
     def initialize(config, test_case, result)
       @config = config
       @test_case = test_case
       @result = result
       @asserting = false
+      @on_teardown = []
     end
 
     support_locations = begin
@@ -150,6 +151,14 @@ module Megatest
       @config.diff(expected, actual)
     end
 
+    def teardown
+      until @on_teardown.empty?
+        record_failures do
+          @on_teardown.pop.call
+        end
+      end
+    end
+
     def record_failures(downlevel: 1, &block)
       expect_no_failures(&block)
     rescue Assertion => assertion

data/lib/megatest/selector.rb

@@ -106,6 +106,10 @@ module Megatest
         @loader = loader
       end
 
+      def path
+        nil
+      end
+
       def partial?
         @loader.partial?
       end

data/lib/megatest/state.rb

@@ -232,7 +232,7 @@ module Megatest
     class SharedSuite < Suite
       def initialize(registry, test_suite)
         super(registry)
-        @mod = test_suite
+        @klass = test_suite
         @test_cases = {}
         test_suite.instance_methods.each do |name|
           if name.start_with?("test_")

data/lib/megatest/stubs.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+module Megatest
+  class Stubber < Module
+    DEFAULT = ->(*) {}
+    DEFAULT.ruby2_keywords if DEFAULT.respond_to?(:ruby2_keywords)
+
+    class << self
+      def for(object)
+        for_class(class << object; self; end)
+      end
+
+      def for_class(klass)
+        unless stubber = klass.included_modules.find { |m| Stubber === m }
+          stubber = Stubber.new
+          klass.prepend(stubber)
+        end
+        stubber
+      end
+    end
+
+    def stub_method(method, proc)
+      proc ||= DEFAULT
+
+      if method_defined?(method, false) # Already stubbed that method
+        old_method = instance_method(method)
+        alias_method(method, method) # Silence redefinition warnings
+        define_method(method, &proc)
+        -> do
+          alias_method(method, method) # Silence redefinition warnings
+          define_method(method, old_method)
+        end
+      else
+        define_method(method, &proc)
+        -> { remove_method(method) }
+      end
+    end
+  end
+
+  module Stubs
+    def stub(object, method, proc = nil)
+      stubber = ::Megatest::Stubber.for(object)
+      teardown = stubber.stub_method(method, proc)
+
+      if block_given?
+        begin
+          yield
+        ensure
+          teardown.call
+        end
+      else
+        @__m.on_teardown << teardown
+      end
+    end
+
+    def stub_any_instance_of(klass, method, proc = nil)
+      raise ArgumentError, "stub_any_instance_of expects a Module or Class" unless Module === klass
+
+      stubber = ::Megatest::Stubber.for_class(klass)
+      teardown = stubber.stub_method(method, proc)
+
+      if block_given?
+        begin
+          yield
+        ensure
+          teardown.call
+        end
+      else
+        @__m.on_teardown << teardown
+      end
+    end
+
+    def stub_const(mod, constant, new_value, exists: true)
+      if exists
+        old_value = mod.const_get(constant, false)
+        teardown = -> do
+          mod.send(:remove_const, constant) if mod.const_defined?(constant, false)
+          mod.const_set(constant, old_value)
+        end
+      else
+        if mod.const_defined?(constant)
+          raise NameError, "already defined constant #{constant} in #{mod.name || mod.inspect}"
+        end
+
+        teardown = -> do
+          mod.send(:remove_const, constant) if mod.const_defined?(constant, false)
+        end
+      end
+
+      apply = -> do
+        mod.send(:remove_const, constant) if exists
+        mod.const_set(constant, new_value)
+      end
+
+      if block_given?
+        begin
+          apply.call
+          yield
+        ensure
+          teardown.call
+        end
+      else
+        begin
+          apply.call
+        rescue
+          teardown.call
+          raise
+        end
+        @__m.on_teardown << teardown
+      end
+    end
+  end
+end

data/lib/megatest/test.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "megatest/assertions"
+require "megatest/stubs"
 
 module Megatest
   ##
@@ -99,6 +100,7 @@ module Megatest
     # :startdoc:
     extend DSL
     include Assertions
+    include Stubs
 
     # Returns the current Megatest::State::TestCase instance
     # Can be used for self introspection
@@ -106,6 +108,11 @@ module Megatest
       @__m.test_case
     end
 
+    # Returns the global megatest config object.
+    def __config__
+      @__m.config
+    end
+
     # Returns the current Megatest::TestCaseResult instance
     # Can be used for self introspection during teardown
     def __result__

data/lib/megatest/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Megatest
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: megatest
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Jean Boussier
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-08-20 00:00:00.000000000 Z
+date: 2024-08-26 00:00:00.000000000 Z
 dependencies: []
 description: Largely API compatible with test-unit / minitest, but with lots of extra
   modern niceties like a proper CLI, test distribution, etc.
@@ -45,6 +45,7 @@ files:
 - lib/megatest/runtime.rb
 - lib/megatest/selector.rb
 - lib/megatest/state.rb
+- lib/megatest/stubs.rb
 - lib/megatest/subprocess.rb
 - lib/megatest/subprocess/main.rb
 - lib/megatest/test.rb
@@ -73,7 +74,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: Modern test-unit style test framework