minitest-verify 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d86d8652f970d9903ab8669a82deeb240cf98e921142b16478c0b1f3e63f1f74
+  data.tar.gz: b412d10611d8e75e217287896e03fd86d9e34c704aed74c05fbd50526da1a5eb
+SHA512:
+  metadata.gz: a2734af789cb9c1019f5fe1fa18382dcab38f5773647ba4149ca10cb2d39eb57a03f840adb84ced9fa751b69517ea6dcd86a7dd1bfb67067cc0836318143aec7
+  data.tar.gz: 8dc9ca7b532ddfce192c3ed5e7241967dd3f58be678aef9576e087bbf66159ded64de6aa1c37630ec88eebb19cdc0319e27c23fae5a5c43cf79b5bca4d5c0c36

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Thomas Marshall
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,74 @@
+# Minitest::Verify
+
+Avoid false-positive tests by verifying they fail when key setup is removed.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+
+## Usage
+
+This is a false-positive test. It always passes because `post` and `comment` are completely unrelated: there's no reason `post.comments` would ever include `comment`.
+
+```rb
+require "minitest/autorun"
+
+class PostTest < Minitest::Test
+  def test_comments_excludes_hidden_comments
+    post = create(:post)
+    comment = create(:comment, hidden: true)
+
+    refute_includes post.comments, comment
+  end
+end
+```
+
+We can pull out the key setup and wrap it with `verify_fails_without`:
+
+```rb
+require "minitest/autorun"
+require "minitest/verify"
+
+class PostTest < Minitest::Test
+  include Minitest::Verify
+
+  def test_comments_excludes_hidden_comments
+    post = create(:post)
+    comment = create(:comment)
+
+    verify_fails_without { comment.update!(hidden: true) }
+
+    refute_includes post.comments, comment
+  end
+end
+```
+
+Now run the test with the `--verify` argument:
+
+```
+$ ruby post_test.rb --verify
+```
+
+This will cause the test to run twice. First it runs _with_ the contents of the `verify_fails_without` block evaluated (normal run). Then it runs _without_ the contents of the `verify_fails_without` block evaluated (verification run). If the test still passes without having evaluated the code inside the block, it's a false positive and you'll see a verification failure in your test output:
+
+```
+# Running:
+
+V
+
+Finished in 0.000380s, 2631.5783 runs/s, 5263.1565 assertions/s.
+
+  1) Verification Failure:
+PostTest#test_comments_excludes_hidden_comments [post_test.rb:11]:
+Expected at least one assertion to fail.
+
+1 runs, 2 assertions, 0 failures, 0 errors, 0 skips
+```

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/lib/minitest/verify/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Minitest
+  module Verify
+    VERSION = "0.1.0"
+  end
+end

data/lib/minitest/verify.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+require_relative "verify/version"
+
+module Minitest
+  module Verify
+    class VerificationFailedError < StandardError; end
+
+    class VerificationFailure < Minitest::Assertion
+      def result_label
+        "Verification Failure"
+      end
+    end
+
+    class VerificationError < Minitest::UnexpectedError
+      def result_label
+        "Verification Error"
+      end
+    end
+
+    class << self
+      attr_accessor :enabled
+    end
+
+    def verify_fails_without(&block)
+      if @current_caller
+        block.call unless caller[0] == @current_caller[0]
+      else
+        callers << caller
+        block.call
+      end
+    end
+
+    def run
+      super
+
+      return Result.from(self) unless Verify.enabled
+
+      @normal_failures = failures.dup
+      failures.clear
+
+      begin
+        while @current_caller = callers.shift
+          with_verification { super }
+        end
+      rescue VerificationFailedError
+        callers.clear
+      end
+
+      Result.from(self)
+    end
+
+    private
+
+    def callers
+      @callers ||= []
+    end
+
+    def with_verification
+      yield
+
+      assertions = failures.select { |f| f.class == Minitest::Assertion }
+      unexpected_errors = failures.select { |f| f.class == Minitest::UnexpectedError }
+
+      failures.clear
+      failures.concat(@normal_failures)
+
+      if unexpected_errors.any?
+        unexpected_errors.each do |unexpected_error|
+          failures << VerificationError.new(unexpected_error.error)
+        end
+
+        raise VerificationFailedError
+      end
+
+      if assertions.empty?
+        exception = VerificationFailure.new("Expected at least one assertion to fail.")
+        exception.set_backtrace(@current_caller)
+        failures << exception
+
+        raise VerificationFailedError
+      end
+    end
+  end
+end

data/lib/minitest/verify_plugin.rb

@@ -0,0 +1,13 @@
+require "minitest/verify"
+
+module Minitest
+  def self.plugin_verify_options(opts, options)
+    opts.on "--verify", "Verify tests sometimes fail." do
+      options[:enabled] = true
+    end
+  end
+
+  def self.plugin_verify_init(options)
+    Verify.enabled = options.fetch(:enabled, false)
+  end
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: minitest-verify
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Thomas Marshall
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-04-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+description:
+email:
+- thomas@thomasmarshall.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- lib/minitest/verify.rb
+- lib/minitest/verify/version.rb
+- lib/minitest/verify_plugin.rb
+homepage: https://github.com/thomasmarshall/minitest-verify
+licenses: []
+metadata:
+  homepage_uri: https://github.com/thomasmarshall/minitest-verify
+  source_code_uri: https://github.com/thomasmarshall/minitest-verify
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.3
+signing_key:
+specification_version: 4
+summary: A minitest plugin to prevent false positive tests.
+test_files: []