selective-ruby-rspec 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c3d785a9a11a8a066d3aed92bcdecda6f1cb52aa08eebc726c3697d194fb9205
+  data.tar.gz: 83ebdde2f7d64514c3465ed69981b576ab0bbe8cbeb0a9aea38b2dfa9d34b09e
+SHA512:
+  metadata.gz: f7b08bb3a657876e3bff4699d555769eba60e2ebd144ed7b25f765aa235463bb17173eacf456f6422f97d0e082f5f4c6c692eaa5237c8cac1f15ce64e43135f6
+  data.tar.gz: 8e59c41dba74ba550001d117d717d04e0b20e7f02f57040e3bb176040c3a92c5db1fb843aea2baf0ebbd6c7a64ef94e31c64d2dd31238c87efa0797516c120aa

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Selective
+
+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/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "standard/rake"
+
+task default: %i[spec standard]

data/lib/selective/ruby/rspec/monkeypatches.rb

@@ -0,0 +1,130 @@
+module Selective
+  module Ruby
+    module RSpec
+      module Monkeypatches
+        MAP = {
+          "BaseTextFormatter" => [:message, :dump_pending, :seed, :close],
+          "ProgressFormatter" => [:start_dump],
+          "DocumentationFormatter" => [:message]
+        }
+
+        MAP.each do |module_name, methods|
+          m = Selective::Ruby::RSpec::Monkeypatches.const_set(module_name, Module.new)
+          methods.each do |method|
+            m.define_method(method) do |*args|
+            end
+          end
+        end
+
+        module Reporter
+          def finish
+            return if Selective::Ruby::Core::Controller.suppress_reporting?
+            # This handles the scenario of no tests to run
+            start(nil) if @start.nil?
+            if ::RSpec.configuration.profile_examples
+              puts "\n\nExample group profiling is not supported with Selective and is now disabled.\n\n"
+              ::RSpec.configuration.profile_examples = nil
+            end
+
+            super
+          end
+
+          def start(*args)
+            return if Selective::Ruby::Core::Controller.suppress_reporting?
+
+            super
+          end
+
+          def register_listener(listener, *notifications)
+            # Prevent double registration of listeners with
+            # the same output path.
+            filtered_notifications = notifications.reject do |n|
+              @listeners[n.to_sym].any? do |l|
+                next false unless [l, listener].all? do |x|
+                  x.respond_to?(:output) && x.output.respond_to?(:path)
+                end
+
+                # :nocov:
+                l.output.path == listener.output.path
+                # :nocov:
+              end
+            end
+
+            super(listener, *filtered_notifications)
+          end
+        end
+
+        module Configuration
+          attr_accessor :currently_loading_spec_file
+
+          def load_file_handling_errors(method, file)
+            self.currently_loading_spec_file = file
+            super
+          ensure
+            self.currently_loading_spec_file = nil
+          end
+
+          def get_files_to_run(*args)
+            super.reject { |f| loaded_spec_files.member?(f) }
+          end
+        end
+
+        module World
+          attr_accessor :example_map
+
+          def initialize(*args)
+            super
+            @example_map = {}
+          end
+        end
+
+        module Runner
+          attr_writer :options
+        end
+
+        module Example
+          def initialize(*args)
+            super
+            ::RSpec.world.example_map[id] = example_group
+          end
+
+          def run(*args)
+            @exception = nil
+            super
+          end
+        end
+
+        module MetaHashPopulator
+          def populate_location_attributes
+            user_metadata[:caller] ||= caller unless ::RSpec.configuration.currently_loading_spec_file.nil?
+            super
+          end
+
+          def file_path_and_line_number_from(backtrace)
+            return super if ::RSpec.configuration.currently_loading_spec_file.nil?
+
+            filtered = backtrace.find { |l| l.include? ::RSpec.configuration.currently_loading_spec_file }
+            filtered.nil? ? super : super([filtered])
+          end
+        end
+
+        def self.apply
+          ::RSpec::Support.require_rspec_core("formatters/base_text_formatter")
+
+          MAP.each do |module_name, _methods|
+            ::RSpec::Core::Formatters
+              .const_get(module_name)
+              .prepend(Selective::Ruby::RSpec::Monkeypatches.const_get(module_name))
+          end
+
+          ::RSpec::Core::Reporter.prepend(Selective::Ruby::RSpec::Monkeypatches::Reporter)
+          ::RSpec::Core::Configuration.prepend(Selective::Ruby::RSpec::Monkeypatches::Configuration)
+          ::RSpec::Core::World.prepend(Selective::Ruby::RSpec::Monkeypatches::World)
+          ::RSpec::Core::Runner.prepend(Selective::Ruby::RSpec::Monkeypatches::Runner)
+          ::RSpec::Core::Example.prepend(Selective::Ruby::RSpec::Monkeypatches::Example)
+          ::RSpec::Core::Metadata::HashPopulator.prepend(Selective::Ruby::RSpec::Monkeypatches::MetaHashPopulator)
+        end
+      end
+    end
+  end
+end

data/lib/selective/ruby/rspec/runner_wrapper.rb

@@ -0,0 +1,140 @@
+require "tempfile"
+require "json"
+
+module Selective
+  module Ruby
+    module RSpec
+      class RunnerWrapper
+        class TestManifestError < StandardError; end
+
+        attr_reader :args, :rspec_runner, :config
+
+        DEFAULT_SPEC_PATH = "./spec"
+
+        def initialize(args)
+          require "rspec/core"
+
+          Selective::Ruby::RSpec::Monkeypatches.apply
+          apply_rspec_configuration
+
+          args << "--format=progress" unless args.any? { |e| e.start_with?("--format") }
+          @args = args
+
+          @config = ::RSpec::Core::ConfigurationOptions.new(args)
+          if config.options[:files_or_directories_to_run].empty?
+            config.options[:files_or_directories_to_run] = [DEFAULT_SPEC_PATH]
+          end
+
+          @rspec_runner = ::RSpec::Core::Runner.new(@config)
+          @rspec_runner.setup($stderr, $stdout)
+        end
+
+        def manifest
+          output = nil
+          Tempfile.create("selective-rspec-dry-run") do |f|
+            quoted_paths = config.options[:files_or_directories_to_run].map { |path| "'#{path}'" }.join(" ")
+            output = `bundle exec selective exec rspec #{quoted_paths} --format=json --out=#{f.path} --dry-run`
+            JSON.parse(f.read).tap do |content|
+              if content["examples"].empty?
+                message = content["messages"]&.first
+                raise_test_manifest_error(message || "No examples found")
+              end
+            end
+          end
+        rescue JSON::ParserError => e
+          raise_test_manifest_error(e.message)
+        end
+
+        def run_test_cases(test_case_ids, callback)
+          ::RSpec.world.reporter.send(:start, nil)
+          Selective::Ruby::Core::Controller.suppress_reporting!
+          test_case_ids.flatten.each do |test_case_id|
+            run_test_case(test_case_id, callback)
+          end
+        end
+
+        def exec
+          rspec_runner.run($stderr, $stdout)
+        end
+
+        def remove_failed_test_case_result(test_case_id)
+          failure = ::RSpec.world.reporter.failed_examples.detect { |e| e.id == test_case_id }
+          if (failed_example_index = ::RSpec.world.reporter.failed_examples.index(failure))
+            ::RSpec.world.reporter.failed_examples.delete_at(failed_example_index)
+          end
+          example = get_example_from_reporter(test_case_id)
+          ::RSpec.world.reporter.examples.delete_at(::RSpec.world.reporter.examples.index(example))
+        end
+
+        def base_test_path
+          file = config.options[:files_or_directories_to_run].first
+          Pathname(normalize_path(file)).each_filename.first
+        end
+
+        def exit_status
+          ::RSpec.world.reporter.failed_examples.any? ? 1 : 0
+        end
+
+        def finish
+          ::RSpec.world.reporter.finish
+        end
+
+        private
+
+        def run_test_case(test_case_id, callback)
+          ::RSpec.configuration.reset_filters
+          ::RSpec.world.prepare_example_filtering
+          config.options[:files_or_directories_to_run] = test_case_id
+          rspec_runner.options = config
+          rspec_runner.setup($stderr, $stdout)
+
+          # $rspec_rerun_debug = true if test_case == './spec/selective_spec.rb[1:2]' && ::RSpec.world.reporter.examples.length == 5
+          rspec_runner.run_specs([::RSpec.world.example_map[test_case_id]])
+          callback.call(format_example(get_example_from_reporter(test_case_id)))
+        end
+
+        def get_example_from_reporter(test_case_id)
+          ::RSpec.world.reporter.examples.detect { |e| e.id == test_case_id }
+        end
+
+        def normalize_path(path)
+          Pathname.new(path).relative_path_from("./")
+        end
+
+        def format_example(example)
+          {
+            id: example.id,
+            description: example.description,
+            full_description: example.full_description,
+            status: example.execution_result.status.to_s,
+            file_path: example.metadata[:file_path],
+            line_number: example.metadata[:line_number],
+            run_time: example.execution_result.run_time,
+            pending_message: example.execution_result.pending_message
+          }.tap { |h| h.merge!(failure_formatter(example)) if h[:status] == "failed" }
+        end
+
+        def failure_formatter(example)
+          presenter = ::RSpec::Core::Formatters::ExceptionPresenter::Factory.new(example).build
+
+          {
+            failure_message_lines: presenter.message_lines,
+            failure_formatted_backtrace: presenter.formatted_backtrace
+            # failure_full_backtrace: example.exception.backtrace
+          }
+        end
+
+        def apply_rspec_configuration
+          ::RSpec.configure do |config|
+            config.backtrace_exclusion_patterns = config.backtrace_exclusion_patterns | [/lib\/selective/]
+            config.silence_filter_announcements = true
+          end
+        end
+
+        def raise_test_manifest_error(output)
+          raise TestManifestError.new("Selective could not generate a test manifest. The output was:\n#{output}")
+        end
+      end
+    end
+  end
+end

data/lib/selective/ruby/rspec/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Selective
+  module Ruby
+    module RSpec
+      VERSION = "0.1.0"
+    end
+  end
+end

data/lib/selective-ruby-rspec.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "zeitwerk"
+
+loader = Zeitwerk::Loader.for_gem(warn_on_extra_files: false)
+loader.inflector.inflect("rspec" => "RSpec")
+loader.ignore("#{__dir__}/selective-ruby-rspec.rb")
+loader.setup
+
+require "selective-ruby-core"
+
+module Selective
+  module Ruby
+    module RSpec
+      class Error < StandardError; end
+
+      def self.register
+        Selective::Ruby::Core.register_runner(
+          "rspec", Selective::Ruby::RSpec::RunnerWrapper
+        )
+      end
+    end
+  end
+end
+
+Selective::Ruby::RSpec.register

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: selective-ruby-rspec
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Benjamin Wood
+- Nate Vick
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-11-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.6.12
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.6.12
+- !ruby/object:Gem::Dependency
+  name: selective-ruby-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Selective is an intelligent test runner for your current CI provider.
+  Get real-time test results, intelligent ordering based on code changes, shorter
+  run times, automatic flake detection, the ability to re-enqueue failed tests, and
+  more.
+email:
+- ben@hint.io
+- nate@hint.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- Rakefile
+- lib/selective-ruby-rspec.rb
+- lib/selective/ruby/rspec/monkeypatches.rb
+- lib/selective/ruby/rspec/runner_wrapper.rb
+- lib/selective/ruby/rspec/version.rb
+homepage: https://www.selective.ci
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://www.selective.ci
+  source_code_uri: http://github.com/selectiveci/selective-ruby-rspec
+  changelog_uri: https://github.com/selectiveci/selective-ruby-rspec/blob/main/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key: 
+specification_version: 4
+summary: Selective Ruby RSpec Client
+test_files: []