Merge pull request #29 from DataDog/refactor-specs

Refactor specs

.vscode/launch.json

@@ -0,0 +1,28 @@
+{
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "type": "ruby_lsp",
+            "name": "Debug script",
+            "request": "launch",
+            "program": "bundle exec ruby ${file}"
+        },
+        {
+            "type": "ruby_lsp",
+            "name": "Debug test",
+            "request": "launch",
+            "program": "bundle exec ruby -Itest ${relativeFile}"
+        },
+        {
+            "type": "ruby_lsp",
+            "name": "Debug spec",
+            "request": "launch",
+            "program": "bundle exec ruby -Ispec ${relativeFile}"
+        },
+        {
+            "type": "ruby_lsp",
+            "name": "Attach debugger",
+            "request": "attach"
+        }
+    ]
+}

.vscode/tasks.json

@@ -0,0 +1,39 @@
+{
+    "version": "2.0.0",
+    "tasks": [
+      {
+        "type": "shell",
+        "group": {
+          "kind": "test",
+          "isDefault": true
+        },
+        "presentation": {
+            "panel": "dedicated",
+            "clear": true,
+            "reveal": "always",
+            "revealProblems": "onProblem",
+        },
+        "problemMatcher": [
+            {
+                "owner": "ruby",
+                "fileLocation": "absolute",
+                "pattern": [
+                    {
+                        "regexp": "^\\s+\\d+\\s+(ERROR|FAIL|SKIP)\\s+(\\S+) (.*) - (\\S+):([0-9]+)$",
+                        "severity": 2,
+                        "message": 3,
+                        "file": 4,
+                        "line": 5
+                    },
+                    {
+                        "regexp": "^\\s+# (.*)$",
+                        "message": 1
+                    }
+                ]
+            },
+        ],
+        "label": "rake: spec",
+        "command": "env MINITEST_REPORTER=VSCodeReporter bundle exec rake spec"
+      }
+    ]
+  }

gemfiles/jruby-9.2.gemfile

@@ -7,5 +7,5 @@ gem "rake", "~> 13.1.0"
 group :test do
   # Ruby 2.5 is dropped in version 5.16.0
   gem "minitest", "~> 5.15.0"
-  gem "rspec", "~> 3.13"
+  gem "minitest-reporters", "~> 1.7.1"
 end

gemfiles/jruby-9.3.gemfile

@@ -6,5 +6,5 @@ gem "rake", "~> 13.1.0"
 
 group :test do
   gem "minitest", "~> 5.22.3"
-  gem "rspec", "~> 3.13"
+  gem "minitest-reporters", "~> 1.7.1"
 end

gemfiles/jruby-9.4.gemfile

@@ -6,5 +6,5 @@ gem "rake", "~> 13.1.0"
 
 group :test do
   gem "minitest", "~> 5.22.3"
-  gem "rspec", "~> 3.13"
+  gem "minitest-reporters", "~> 1.7.1"
 end

gemfiles/ruby-2.5.gemfile

@@ -7,7 +7,7 @@ gem "rake", "~> 13.1.0"
 group :test do
   # Ruby 2.5 is dropped in version 5.16.0
   gem "minitest", "~> 5.15.0"
-  gem "rspec", "~> 3.13"
+  gem "minitest-reporters", "~> 1.7.1"
 end
 
 group :debug do

gemfiles/ruby-2.6.gemfile

@@ -6,7 +6,7 @@ gem "rake", "~> 13.1.0"
 
 group :test do
   gem "minitest", "~> 5.22.3"
-  gem "rspec", "~> 3.13"
+  gem "minitest-reporters", "~> 1.7.1"
 end
 
 group :debug do

gemfiles/ruby-2.7.gemfile

@@ -6,7 +6,7 @@ gem "rake", "~> 13.1.0"
 
 group :test do
   gem "minitest", "~> 5.22.3"
-  gem "rspec", "~> 3.13"
+  gem "minitest-reporters", "~> 1.7.1"
 end
 
 group :debug do

gemfiles/ruby-3.0.gemfile

@@ -6,7 +6,7 @@ gem "rake", "~> 13.1.0"
 
 group :test do
   gem "minitest", "~> 5.22.3"
-  gem "rspec", "~> 3.13"
+  gem "minitest-reporters", "~> 1.7.1"
 end
 
 group :debug do

gemfiles/ruby-3.1.gemfile

@@ -6,7 +6,7 @@ gem "rake", "~> 13.1.0"
 
 group :test do
   gem "minitest", "~> 5.22.3"
-  gem "rspec", "~> 3.13"
+  gem "minitest-reporters", "~> 1.7.1"
 end
 
 group :debug do

gemfiles/ruby-3.2.gemfile

@@ -6,7 +6,7 @@ gem "rake", "~> 13.1.0"
 
 group :test do
   gem "minitest", "~> 5.22.3"
-  gem "rspec", "~> 3.13"
+  gem "minitest-reporters", "~> 1.7.1"
 end
 
 group :debug do

gemfiles/ruby-3.3.gemfile

@@ -6,7 +6,7 @@ gem "rake", "~> 13.1.0"
 
 group :test do
   gem "minitest", "~> 5.22.3"
-  gem "rspec", "~> 3.13"
+  gem "minitest-reporters", "~> 1.7.1"
 end
 
 group :debug do

gemfiles/ruby-3.4.gemfile

@@ -6,7 +6,7 @@ gem "rake", "~> 13.1.0"
 
 group :test do
   gem "minitest", "~> 5.22.3"
-  gem "rspec", "~> 3.13"
+  gem "minitest-reporters", "~> 1.7.1"
 end
 
 group :debug do

test/graft/callback_test.rb → spec/graft/callback_spec.rb

@@ -1,5 +1,8 @@
+# frozen_string_literal: true
+
 require "minitest/spec"
 require "minitest/autorun"
+require "spec_helper"
 
 require "graft/callback"
 

test/graft/hook_point_test.rb → spec/graft/hook_point_spec.rb

@@ -1,5 +1,8 @@
+# frozen_string_literal: true
+
 require "minitest/spec"
 require "minitest/autorun"
+require "spec_helper"
 
 require "graft/hook_point"
 

test/graft/hook_test.rb → spec/graft/hook_spec.rb

@@ -1,5 +1,8 @@
+# frozen_string_literal: true
+
 require "minitest/spec"
 require "minitest/autorun"
+require "spec_helper"
 
 require "graft/hook"
 

test/graft/stack_test.rb → spec/graft/stack_spec.rb

@@ -1,5 +1,8 @@
+# frozen_string_literal: true
+
 require "minitest/spec"
 require "minitest/autorun"
+require "spec_helper"
 
 require "graft/stack"
 

spec/spec_helper.rb

@@ -1,96 +1,3 @@
-# This file was generated by the `rspec --init` command. Conventionally, all
-# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
-# The generated `.rspec` file contains `--require spec_helper` which will cause
-# this file to always be loaded, without a need to explicitly require it in any
-# files.
-#
-# Given that it is always loaded, you are encouraged to keep this file as
-# light-weight as possible. Requiring heavyweight dependencies from this file
-# will add to the boot time of your test suite on EVERY test run, even for an
-# individual file that may not need all of that loaded. Instead, consider making
-# a separate helper file that requires the additional dependencies and performs
-# the additional setup, and require it from the spec files that actually need
-# it.
-#
-# See https://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
-RSpec.configure do |config|
-  # rspec-expectations config goes here. You can use an alternate
-  # assertion/expectation library such as wrong or the stdlib/minitest
-  # assertions if you prefer.
-  config.expect_with :rspec do |expectations|
-    # This option will default to `true` in RSpec 4. It makes the `description`
-    # and `failure_message` of custom matchers include text for helper methods
-    # defined using `chain`, e.g.:
-    #     be_bigger_than(2).and_smaller_than(4).description
-    #     # => "be bigger than 2 and smaller than 4"
-    # ...rather than:
-    #     # => "be bigger than 2"
-    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
-  end
+# frozen_string_literal: true
 
-  # rspec-mocks config goes here. You can use an alternate test double
-  # library (such as bogus or mocha) by changing the `mock_with` option here.
-  config.mock_with :rspec do |mocks|
-    # Prevents you from mocking or stubbing a method that does not exist on
-    # a real object. This is generally recommended, and will default to
-    # `true` in RSpec 4.
-    mocks.verify_partial_doubles = true
-  end
-
-  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
-  # have no way to turn it off -- the option exists only for backwards
-  # compatibility in RSpec 3). It causes shared context metadata to be
-  # inherited by the metadata hash of host groups and examples, rather than
-  # triggering implicit auto-inclusion in groups with matching metadata.
-  config.shared_context_metadata_behavior = :apply_to_host_groups
-
-  # The settings below are suggested to provide a good initial experience
-  # with RSpec, but feel free to customize to your heart's content.
-  #   # This allows you to limit a spec run to individual examples or groups
-  #   # you care about by tagging them with `:focus` metadata. When nothing
-  #   # is tagged with `:focus`, all examples get run. RSpec also provides
-  #   # aliases for `it`, `describe`, and `context` that include `:focus`
-  #   # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
-  #   config.filter_run_when_matching :focus
-  #
-  #   # Allows RSpec to persist some state between runs in order to support
-  #   # the `--only-failures` and `--next-failure` CLI options. We recommend
-  #   # you configure your source control system to ignore this file.
-  #   config.example_status_persistence_file_path = "spec/examples.txt"
-  #
-  #   # Limits the available syntax to the non-monkey patched syntax that is
-  #   # recommended. For more details, see:
-  #   # https://rspec.info/features/3-12/rspec-core/configuration/zero-monkey-patching-mode/
-  #   config.disable_monkey_patching!
-  #
-  #   # This setting enables warnings. It's recommended, but in some cases may
-  #   # be too noisy due to issues in dependencies.
-  #   config.warnings = true
-  #
-  #   # Many RSpec users commonly either run the entire suite or an individual
-  #   # file, and it's useful to allow more verbose output when running an
-  #   # individual spec file.
-  #   if config.files_to_run.one?
-  #     # Use the documentation formatter for detailed output,
-  #     # unless a formatter has already been configured
-  #     # (e.g. via a command-line flag).
-  #     config.default_formatter = "doc"
-  #   end
-  #
-  #   # Print the 10 slowest examples and example groups at the
-  #   # end of the spec run, to help surface which specs are running
-  #   # particularly slow.
-  #   config.profile_examples = 10
-  #
-  #   # Run specs in random order to surface order dependencies. If you find an
-  #   # order dependency and want to debug it, you can fix the order by providing
-  #   # the seed, which is printed after each run.
-  #   #     --seed 1234
-  #   config.order = :random
-  #
-  #   # Seed global randomization in this process using the `--seed` CLI option.
-  #   # Setting this allows you to use `--seed` to deterministically reproduce
-  #   # test failures related to randomization by passing the same `--seed` value
-  #   # as the one that triggered the failure.
-  #   Kernel.srand config.seed
-end
+require_relative "spec_helper/minitest/reporter"

spec/spec_helper/minitest/reporter.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "minitest/reporters"
+
+require_relative "reporters/default_reporter"
+require_relative "reporters/vscode_reporter"
+
+Minitest::Reporters.use! Minitest::Reporters::SpecReporter.new unless %w[n no false 0].include?(ENV.fetch("MINITEST_REPORTER", "").downcase)

spec/spec_helper/minitest/reporters/default_reporter.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+# Minitest::Reporters::DefaultReporter misreports `skip` location
+# as being in Minitest source instead of actual `skip` location
+# See: https://github.com/minitest-reporters/minitest-reporters/issues/356
+module Minitest::Reporters::DefaultReporter::FixSkipLocation
+  def location(exception)
+    exception.location
+  end
+end
+
+Minitest::Reporters::DefaultReporter.prepend Minitest::Reporters::DefaultReporter::FixSkipLocation

spec/spec_helper/minitest/reporters/vscode_reporter.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Minitest
+  module Reporters
+    # A reporter that emits one line per test, for VSCode
+    class VSCodeReporter < DefaultReporter
+      def report
+        require "json"
+
+        $stdout.write "\n"
+        tests.each_with_index do |test, index|
+          index += 1
+          name = [test.klass, test.name].join("#").gsub(/#test_\d+_anonymous$/, "")
+
+          if test.passed?
+            status = "PASS"
+            severity = ""
+          elsif test.skipped?
+            status = "SKIP"
+
+            message = test.failure.to_s
+            severity = "info"
+          elsif test.failure
+            status = test.failure.is_a?(Minitest::UnexpectedError) ? "ERROR" : "FAIL"
+            severity = "error"
+
+            message = if test.failure.is_a?(Minitest::UnexpectedError)
+              "#{test.failure.error.class}: #{test.failure.error.message}"
+            else
+              test.failure.message.each_line.to_a.map(&:lstrip).map(&:chomp).join(" ")
+            end
+          end
+
+          row = {
+            index: index,
+            status: status,
+            name: name,
+            time: test.time,
+            assertions: test.assertions,
+            source_location: test.source_location[0, 2].join(":")
+          }
+
+          row[:location] = test.failure.location if test.failure
+
+          row[:severity] = severity unless severity.nil?
+          row[:message] = message unless message.nil?
+
+          # rendering
+          $stdout.write printf("%<index> 5d %<status> 5s %<severity> 5s %<name>s", row)
+          $stdout.write printf(" - %<location>s", row) if row.key?(:location)
+          $stdout.write printf("\n")
+          if row.key?(:message)
+            row[:message].each_line { |l| $stdout.write printf("                  # %s\n", l.chomp) }
+          end
+        end
+      end
+    end
+  end
+end

tasks/bundler.rake

@@ -1 +1,10 @@
-require "bundler/gem_tasks"
+# frozen_string_literal: true
+
+# @type self: Rake::DSL
+
+if Gem.loaded_specs["bundler"]
+  require "bundler/gem_tasks"
+else
+  warn "'bundler' gem not loaded: skipping tasks..." if Rake.verbose == true
+  return
+end