+ Add metadata lazy accessor to Runnable / Result. (matteeyah)

zenspider · zenspider · commit de802824b3d0 · 2023-07-26T10:10:38.000-08:00
[git-p4: depot-paths = "//src/minitest/dev/": change = 13875]
diff --git a/lib/minitest.rb b/lib/minitest.rb
@@ -446,6 +446,31 @@ def initialize name # :nodoc:
       self.name       = name
       self.failures   = []
       self.assertions = 0
+      # lazy initializer for metadata
+    end
+
+    ##
+    # Metadata you attach to the test results that get sent to the reporter.
+    #
+    # Lazily initializes to a hash, to keep memory down.
+    #
+    # NOTE: this data *must* be plain (read: marshal-able) data!
+    # Hashes! Arrays! Strings!
+
+    def metadata
+      @metadata ||= {}
+    end
+
+    ##
+    # Sets metadata, mainly used for +Result.from+.
+
+    attr_writer :metadata
+
+    ##
+    # Returns true if metadata exists.
+
+    def metadata?
+      defined? @metadata
     end
 
     ##
@@ -566,6 +591,7 @@ def self.from runnable
       r.assertions = o.assertions
       r.failures   = o.failures.dup
       r.time       = o.time
+      r.metadata   = o.metadata if o.metadata?
 
       r.source_location = o.method(o.name).source_location rescue ["unknown", -1]
 
diff --git a/test/minitest/test_minitest_reporter.rb b/test/minitest/test_minitest_reporter.rb
@@ -65,6 +65,12 @@ def passing_test
     @pt ||= Minitest::Result.from Minitest::Test.new(:woot)
   end
 
+  def passing_test_with_metadata
+    test = Minitest::Test.new(:woot)
+    test.metadata[:meta] = :data
+    @pt ||= Minitest::Result.from test
+  end
+
   def skip_test
     unless defined? @st then
       @st = Minitest::Test.new(:woot)
@@ -166,6 +172,29 @@ def test_record_pass
     assert_equal 0, r.assertions
   end
 
+  def test_record_pass_with_metadata
+    reporter = self.r
+
+    def reporter.metadata
+      @metadata
+    end
+
+    def reporter.record result
+      super
+      @metadata = result.metadata if result.metadata?
+    end
+
+    r.record passing_test_with_metadata
+
+    exp = { :meta => :data }
+    assert_equal exp, reporter.metadata
+
+    assert_equal ".", io.string
+    assert_empty r.results
+    assert_equal 1, r.count
+    assert_equal 0, r.assertions
+  end
+
   def test_record_fail
     fail_test = self.fail_test
     r.record fail_test
