minitest-proptest 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0596e6f6a66614dba0199eccc4e18a5bf6b869fd0db46dff7636a8772eacb75b'
-  data.tar.gz: a956c579c5bb355a5b687f64109917918870dd7dac1323a18a72d44e4ca623a6
+  metadata.gz: 236dabad0376379b518d9c29fc12f1bca0a17343c9dc85c6ff19ef94419698e8
+  data.tar.gz: dbe3075e50971bac885e3fcc6d3c607c9edb4a9e5bac4cc9dc1863a874ac2d5a
 SHA512:
-  metadata.gz: d6206c7a778b9b55e0674e204afea71721eb8b6e4fe2257691cc1cefd5e76885eff08d648f9a61172806872f1abe5f1b232186fcc803e6fcc560241fd71fac8c
-  data.tar.gz: 1ca1d04ddcdecb9f661e0af6cffc87dda30af6a9b06bb6fe406a5f27ec445a0cf3cd9ac4d9050b4a243ab40d76d066358f6cf9612181cc546a2076b76a7d9041
+  metadata.gz: 70f655e9358ce5e198b5489e94a8cdb32d0a58b0d88393482f7faf8e911ab81a50bdc5514add06cb168f13a2c687a825725e00e59c0497937bd076ba8279bc91
+  data.tar.gz: 9dde2177e0f6a9458f1226abd43c5bd1b7048c3c69c6f746043fb02a4c5e9de1f5e8082bad699001f238b478528da350a63ede6d84b6058f011f9d6960217c88

data/lib/minitest/proptest/gen/value_generator.rb

@@ -98,7 +98,11 @@ module Minitest
         def shrink_candidates
           fs = @type_parameters.map { |x| x.method(:shrink_function) }
           os = score
-          candidates = shrink_function(*fs, value)
+          # Ensure that the end of the shrink attempt will contain the original
+          # value.  This is necessary to guarantee that the shrink process
+          # produces at least one failure for the purpose of capturing variable
+          # assignment.
+          candidates = shrink_function(*fs, value) + [value]
           candidates
             .map    { |c| [force(c).score, c] }
             .reject { |(s, _)| s > os }

data/lib/minitest/proptest/gen.rb

@@ -287,47 +287,27 @@ module Minitest
 
       generator_for(Int8) do
         r = sized(0xff)
-        (r & 0x80).zero? ? r : -(((r & 0x7f) - 1) ^ 0x7f)
-      end.with_shrink_function do |i|
-        j = (i & 0x80).zero? ? i : -(((i & 0x7f) - 1) ^ 0x7f)
-        integral_shrink.call(j)
-      end
+        (r & 0x80).zero? ? r : -((r ^ 0x7f) - 0x7f)
+      end.with_shrink_function(&integral_shrink)
 
       generator_for(Int16) do
         r = sized(0xffff)
-        (r & 0x8000).zero? ? r : -(((r & 0x7fff) - 1) ^ 0x7fff)
-      end.with_shrink_function do |i|
-        j = (i & 0x8000).zero? ? i : -(((i & 0x7fff) - 1) ^ 0x7fff)
-        integral_shrink.call(j)
-      end
+        (r & 0x8000).zero? ? r : -((r ^ 0x7fff) - 0x7fff)
+      end.with_shrink_function(&integral_shrink)
 
       generator_for(Int32) do
         r = sized(0xffffffff)
-        (r & 0x80000000).zero? ? r : -(((r & 0x7fffffff) - 1) ^ 0x7fffffff)
-      end.with_shrink_function do |i|
-        j = if (i & 0x80000000).zero?
-              i
-            else
-              -(((i & 0x7fffffff) - 1) ^ 0x7fffffff)
-            end
-        integral_shrink.call(j)
-      end
+        (r & 0x80000000).zero? ? r : -((r ^ 0x7fffffff) - 0x7fffffff)
+      end.with_shrink_function(&integral_shrink)
 
       generator_for(Int64) do
         r = sized(0xffffffffffffffff)
         if (r & 0x8000000000000000).zero?
           r
         else
-          -(((r & 0x7fffffffffffffff) - 1) ^ 0x7fffffffffffffff)
+          -((r ^ 0x7fffffffffffffff) - 0x7fffffffffffffff)
         end
-      end.with_shrink_function do |i|
-        j = if (i & 0x8000000000000000).zero?
-              i
-            else
-              -(((i & 0x7fffffffffffffff) - 1) ^ 0x7fffffffffffffff)
-            end
-        integral_shrink.call(j)
-      end
+      end.with_shrink_function(&integral_shrink)
 
       generator_for(UInt8) do
         sized(0xff)
@@ -471,6 +451,15 @@ module Minitest
       end.with_score_function do |_|
         1
       end
+
+      generator_for(Time) do
+        r = sized(0xffffffff)
+        Time.at((r & 0x80000000).zero? ? r : -((r ^ 0x7fffffff) - 0x7fffffff))
+      end.with_shrink_function do |t|
+        integral_shrink.call(t.to_i).map(&Time.method(:at))
+      end.with_score_function do |t|
+        t.to_i.abs
+      end
     end
   end
 end

data/lib/minitest/proptest/property.rb

@@ -7,6 +7,8 @@ module Minitest
       require 'minitest/assertions'
       include Minitest::Assertions
 
+      class InvalidProperty < StandardError; end
+
       attr_reader :calls, :result, :status, :trivial
 
       attr_accessor :assertions
@@ -14,6 +16,10 @@ module Minitest
       def initialize(
         # The function which proves the property
         test_proc,
+        # The file in which our property lives
+        filename,
+        # The method containing our property
+        methodname,
         # Any class which provides `rand` accepting both an Integer and a Range
         # is acceptable.  The default value is Ruby's standard Mersenne Twister
         # implementation.
@@ -33,6 +39,8 @@ module Minitest
         previous_failure: []
       )
         @test_proc         = test_proc
+        @filename          = filename
+        @methodname        = methodname
         @random            = random.call
         @generator         = ::Minitest::Proptest::Gen.new(@random)
         @max_success       = max_success
@@ -41,7 +49,6 @@ module Minitest
         @max_shrinks       = max_shrinks
         @status            = Status.unknown
         @trivial           = false
-        @valid_test_case   = true
         @result            = nil
         @exception         = nil
         @calls             = 0
@@ -50,6 +57,7 @@ module Minitest
         @generated         = []
         @arbitrary         = nil
         @previous_failure  = previous_failure.to_a
+        @local_variables   = {}
       end
 
       def run!
@@ -58,21 +66,6 @@ module Minitest
         shrink!
       end
 
-      def arbitrary(*classes)
-        if @arbitrary
-          @arbitrary.call(*classes)
-        else
-          a = @generator.for(*classes)
-          @generated << a
-          @status = Status.overrun unless @generated.length <= @max_size
-          a.value
-        end
-      end
-
-      def where(&b)
-        @valid_test_case &= b.call
-      end
-
       def explain
         prop = if @status.valid?
                  'The property was proved to satsfaction across ' \
@@ -88,10 +81,20 @@ module Minitest
                elsif @status.unknown?
                  'The property has not yet been tested.'
                elsif @status.interesting?
-                 'The property has found the following counterexample after ' \
-                   "#{@valid_test_cases} valid " \
-                   "example#{@valid_test_cases == 1 ? '' : 's'}:\n" \
-                   "#{@generated.map(&:value).inspect}"
+                 info = 'A counterexample to a property has been found after ' \
+                        "#{@valid_test_cases} valid " \
+                        "example#{@valid_test_cases == 1 ? '' : 's'}.\n"
+                 var_info = if @local_variables.empty?
+                              'Variables local to the property were unable ' \
+                                'to be determined.  This is usually a bug.'
+                            else
+                              "The values at the time of the failure were:\n"
+                            end
+                 vars = @local_variables
+                        .map { |k, v| "\t#{k}: #{v.inspect}" }
+                        .join("\n")
+
+                 info + var_info + vars
                elsif @status.exhausted?
                  "The property was unable to generate #{@max_success} test " \
                    'cases before generating ' \
@@ -112,37 +115,47 @@ module Minitest
 
       private
 
+      def arbitrary(*classes)
+        if @arbitrary
+          @arbitrary.call(*classes)
+        else
+          a = @generator.for(*classes)
+          @generated << a
+          @status = Status.overrun unless @generated.length <= @max_size
+          a.value
+        end
+      end
+
+      def where(&b)
+        raise InvalidProperty unless b.call
+      end
+
       def iterate!
         while continue_iterate? && @result.nil? && @valid_test_cases <= @max_success
-          @valid_test_case = true
           @generated = []
           @generator = ::Minitest::Proptest::Gen.new(@random)
           @calls += 1
 
-          success = begin
-                      instance_eval(&@test_proc)
-                    rescue Minitest::Assertion
-                      if @valid_test_case
-                        @result = @generated
-                        @status = Status.interesting
-                      end
-                    rescue => e
-                      raise e if @valid_test_case
-                    end
-          if @valid_test_case && success
-            @status = Status.valid if @status.unknown?
-            @valid_test_cases += 1
-          elsif @valid_test_case
+          begin
+            if instance_eval(&@test_proc)
+              @status = Status.valid if @status.unknown?
+              @valid_test_cases += 1
+            else
+              @result = @generated
+              @status = Status.interesting
+            end
+          rescue Minitest::Assertion
             @result = @generated
             @status = Status.interesting
+          rescue InvalidProperty
+          rescue => e
+            @status = Status.invalid
+            @exception = e
           end
 
           @status = Status.exhausted if @calls >= @max_success * (@max_discard_ratio + 1)
           @trivial = true if @generated.empty?
         end
-      rescue => e
-        @status = Status.invalid
-        @exception = e
       end
 
       def rerun!
@@ -164,22 +177,22 @@ module Minitest
         end
 
         @generator = ::Minitest::Proptest::Gen.new(@random)
-        success = begin
-                    instance_eval(&@test_proc)
-                  rescue Minitest::Assertion
-                    !@valid_test_case
-                  rescue => e
-                    if @valid_test_case
-                      @status = Status.invalid
-                      @exception = e
-                      false
-                    end
-                  end
-        if success || !@valid_test_case
-          @generated = []
-        elsif @valid_test_case
+        begin
+          if instance_eval(&@test_proc)
+            @generated = []
+          else
+            @result = @generated
+            @status = Status.interesting
+          end
+        rescue Minitest::Assertion
           @result = @generated
           @status = Status.interesting
+        rescue InvalidProperty
+          @generated = []
+        rescue => e
+          @result = @generated
+          @status = Status.invalid
+          @exception = e
         end
 
         # Clean up after we're done
@@ -198,6 +211,23 @@ module Minitest
         candidates     = @generated.map(&:shrink_candidates)
         old_arbitrary  = @arbitrary
 
+        # Using a TracePoint to determine variable assignments at the time of
+        # the failure only occurs within shrink! - this is a deliberate decision
+        # which eliminates all time lost in iterate! to optimize for the success
+        # case.  The tradeoff is that if all shrinking fails, one additional
+        # cycle (with the values which produced the original failure) will be
+        # required.
+        local_variables = {}
+        tracepoint = TracePoint.new(:b_return) do |trace|
+          if trace.path == @filename && trace.method_id.to_s == @methodname
+            b     = trace.binding
+            vs    = b.local_variables
+            known = vs.to_h { |lv| [lv.to_s, b.local_variable_get(lv)] }
+            local_variables.delete_if { true }
+            local_variables.merge!(known)
+          end
+        end
+
         to_test = candidates
                   .map    { |x| x.map { |y| [y] } }
                   .reduce { |c, e| c.flat_map { |a| e.map { |b| a + b } } }
@@ -221,36 +251,42 @@ module Minitest
           @valid_test_case = true
 
           @generator = ::Minitest::Proptest::Gen.new(@random)
-          if to_test[run[:run]].map(&:first).reduce(&:+) < best_score
-            success = begin
-                        instance_eval(&@test_proc)
-                      rescue Minitest::Assertion
-                        false
-                      rescue => e
-                        next unless @valid_test_case
-
-                        @status = Status.invalid
-                        @excption = e
-                        break
-                      end
-
-            if !success && @valid_test_case
-              # The first hit is guaranteed to be the best scoring due to the
-              # shrink candidates are pre-sorted.
+          if to_test[run[:run]].map(&:first).reduce(&:+) <= best_score
+            begin
+              tracepoint.enable
+              unless instance_eval(&@test_proc)
+                # The first hit is guaranteed to be the best scoring since the
+                # shrink candidates are pre-sorted.
+                best_generated = @generated
+                break
+              end
+            rescue Minitest::Assertion
               best_generated = @generated
               break
+            rescue InvalidProperty
+              # Invalid test case generated- continue
+            rescue => e
+              next unless @valid_test_case
+
+              @status = Status.invalid
+              @excption = e
+              break
+            ensure
+              tracepoint.disable
             end
           end
 
           @calls    += 1
           run[:run] += 1
         end
+
         # Clean up after we're done
-        @generated = best_generated
-        @result    = best_generated
-        @generator = old_generator
-        @random    = old_random
-        @arbitrary = old_arbitrary
+        @generated       = best_generated
+        @result          = best_generated
+        @generator       = old_generator
+        @random          = old_random
+        @arbitrary       = old_arbitrary
+        @local_variables = local_variables
       end
 
       def continue_iterate?

data/lib/minitest/proptest/version.rb

@@ -2,6 +2,6 @@
 
 module Minitest
   module Proptest
-    VERSION = '0.2.0'
+    VERSION = '0.3.0'
   end
 end

data/lib/minitest/proptest_plugin.rb

@@ -63,6 +63,8 @@ module Minitest
 
       prop = Minitest::Proptest::Property.new(
         f,
+        file,
+        methodname,
         random: random_thunk,
         max_success: Proptest.max_success,
         max_discard_ratio: Proptest.max_discard_ratio,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: minitest-proptest
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Tina Wuest
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-21 00:00:00.000000000 Z
+date: 2024-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest