rspec-mergify 0.2.0-x86_64-linux

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f780ead2142231a815ead11c224dfaa6755bf705face5454b912a0f6411f3711
+  data.tar.gz: ca7701151c7015707c8a1e9d784844e7a8c939f21dd3c3afd01b61141e1038c5
+SHA512:
+  metadata.gz: f45dc1da3c292a7a5f05a8531ee63bf83fb804d0051beb7667075742522451bb6c36e1f2d99f4e0cdb56bd66e445860c5d9387331ae7ff8ae5b97fd15df70f69
+  data.tar.gz: 4b6295d176645780f74f2aebf3e6162110136163520624c4a274c12e7a06bd089103fc1f9d11712d5a6422e998fb3a4597f46a45830f3c8a74f463420dda3c0e

data/LICENSE

@@ -0,0 +1,176 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+

data/README.md

@@ -0,0 +1,68 @@
+# rspec-mergify
+
+RSpec plugin for [Mergify Test Insights](https://docs.mergify.com/ci-insights/).
+
+## Features
+
+- **Test tracing** — Sends OpenTelemetry traces for every test to Mergify's API
+- **Flaky test detection** — Intelligently reruns tests to detect flakiness with budget constraints
+- **Test quarantine** — Quarantines failing tests so they don't block CI
+
+## Installation
+
+Add to your Gemfile:
+
+```ruby
+gem 'rspec-mergify'
+```
+
+Then run `bundle install`.
+
+## Configuration
+
+Set the `MERGIFY_TOKEN` environment variable with your Mergify API token.
+
+The plugin activates automatically when running in CI (detected via the `CI` environment variable). To enable outside CI, set `RSPEC_MERGIFY_ENABLE=true`.
+
+### Environment Variables
+
+| Variable | Description | Default |
+|---|---|---|
+| `MERGIFY_TOKEN` | Mergify API authentication token | (required) |
+| `MERGIFY_API_URL` | Mergify API endpoint | `https://api.mergify.com` |
+| `RSPEC_MERGIFY_ENABLE` | Force-enable outside CI | `false` |
+| `RSPEC_MERGIFY_DEBUG` | Print spans to console | `false` |
+| `MERGIFY_TRACEPARENT` | W3C distributed trace context | — |
+| `MERGIFY_TEST_JOB_NAME` | Mergify test job name | — |
+
+For detailed documentation, see the [official guide](https://docs.mergify.com/ci-insights/test-frameworks/rspec/).
+
+## Development
+
+### Prerequisites
+
+- Ruby >= 3.1 (`.ruby-version` pins to 4.0.6 — use [rbenv](https://github.com/rbenv/rbenv) or [mise](https://mise.jdx.dev/) to install it)
+- Bundler
+
+### Setup
+
+```bash
+rbenv install          # install the Ruby version from .ruby-version (if needed)
+bundle install
+```
+
+### Running Tests
+
+```bash
+bundle exec rspec
+```
+
+### Linting
+
+```bash
+bundle exec rubocop
+```
+
+## License
+
+Apache-2.0 — see the [LICENSE](../../LICENSE) at the repository root.

data/lib/mergify/rspec/ci_insights.rb

@@ -0,0 +1,167 @@
+# frozen_string_literal: true
+
+require 'securerandom'
+require 'opentelemetry-sdk'
+require_relative 'utils'
+require_relative 'native'
+require_relative 'synchronous_batch_span_processor'
+require_relative 'resources/rspec'
+
+module Mergify
+  module RSpec
+    # Central orchestrator for Mergify Test Insights: sets up OpenTelemetry tracing,
+    # manages the tracer provider, and coordinates flaky detection and quarantine.
+    # rubocop:disable-next Metrics/ClassLength
+    class CIInsights
+      attr_reader :token, :repo_name, :api_url, :test_run_id,
+                  :tracer_provider, :tracer, :exporter,
+                  :branch_name,
+                  :flaky_detector, :flaky_detector_error_message, :quarantined_tests
+
+      # rubocop:disable-next Metrics/MethodLength
+      def initialize
+        @token = ENV.fetch('MERGIFY_TOKEN', nil)
+        @repo_name = Native.detect_repository_name
+        @api_url = ENV.fetch('MERGIFY_API_URL', 'https://api.mergify.com')
+        @test_run_id = SecureRandom.hex(8)
+        @tracer_provider = nil
+        @tracer = nil
+        @exporter = nil
+        @branch_name = nil
+        @flaky_detector = nil
+        @flaky_detector_error_message = nil
+        @quarantined_tests = nil
+
+        setup_tracing if Utils.in_ci?
+      end
+
+      def mark_test_as_quarantined_if_needed(example_id) # rubocop:disable Naming/PredicateMethod
+        return false unless @quarantined_tests&.include?(example_id)
+
+        @quarantined_tests.mark_as_used(example_id)
+        true
+      end
+
+      private
+
+      def setup_tracing
+        processor, exp = build_processor
+        return unless processor
+
+        @exporter = exp
+        resource = build_resource
+        @tracer_provider = OpenTelemetry::SDK::Trace::TracerProvider.new(resource: resource)
+        @tracer_provider.add_span_processor(processor)
+        @tracer = @tracer_provider.tracer('rspec-mergify', Mergify::RSpec::VERSION)
+        @branch_name = extract_branch_name(resource)
+        load_flaky_detector
+        load_quarantine
+      end
+
+      def build_processor
+        if debug_mode? || test_mode?
+          build_in_memory_processor
+        elsif @token && @repo_name
+          build_otlp_processor
+        else
+          [nil, nil]
+        end
+      end
+
+      def debug_mode?
+        ENV.key?('RSPEC_MERGIFY_DEBUG')
+      end
+
+      def test_mode?
+        ENV['_RSPEC_MERGIFY_TEST'] == 'true'
+      end
+
+      def build_in_memory_processor
+        exp = OpenTelemetry::SDK::Trace::Export::InMemorySpanExporter.new
+        processor = OpenTelemetry::SDK::Trace::Export::SimpleSpanProcessor.new(exp)
+        [processor, exp]
+      end
+
+      def build_otlp_processor
+        owner, repo = Utils.split_full_repo_name(@repo_name)
+        endpoint = "#{@api_url}/v1/ci/#{owner}/repositories/#{repo}/traces"
+        exp = create_otlp_exporter(endpoint)
+        processor = SynchronousBatchSpanProcessor.new(exp)
+        [processor, exp]
+      end
+
+      # The cicd.* and vcs.* attributes come from the Rust core, which every
+      # Mergify test client shares, so a provider gains them everywhere at once.
+      # What stays here is what only Ruby knows: the test framework, and the id
+      # this run invented for itself.
+      def build_resource
+        resources = [
+          OpenTelemetry::SDK::Resources::Resource.create(Native.detect_attributes),
+          Resources::RSpec.detect,
+          OpenTelemetry::SDK::Resources::Resource.create('test.run.id' => @test_run_id)
+        ]
+        resources.reduce(OpenTelemetry::SDK::Resources::Resource.create({})) do |merged, r|
+          merged.merge(r)
+        end
+      end
+
+      def extract_branch_name(resource)
+        attrs = resource.attribute_enumerator.to_h
+        @base_branch_name = attrs['vcs.ref.base.name']
+        @base_branch_name || attrs['vcs.ref.head.name']
+      end
+
+      # rubocop:disable-next Metrics/MethodLength
+      def create_otlp_exporter(endpoint)
+        require 'opentelemetry-exporter-otlp'
+        original_env = ENV.fetch('OTEL_EXPORTER_OTLP_TRACES_ENDPOINT', nil)
+        ENV['OTEL_EXPORTER_OTLP_TRACES_ENDPOINT'] = endpoint
+        begin
+          OpenTelemetry::Exporter::OTLP::Exporter.new(
+            endpoint: endpoint,
+            headers: { 'Authorization' => "Bearer #{@token}" },
+            compression: 'gzip'
+          )
+        ensure
+          if original_env
+            ENV['OTEL_EXPORTER_OTLP_TRACES_ENDPOINT'] = original_env
+          else
+            ENV.delete('OTEL_EXPORTER_OTLP_TRACES_ENDPOINT')
+          end
+        end
+      end
+
+      # rubocop:disable-next Metrics/MethodLength
+      def load_flaky_detector
+        return unless @token && @repo_name
+
+        require_relative 'flaky_detection'
+        mode = @base_branch_name ? 'new' : 'unhealthy'
+        @flaky_detector = FlakyDetector.new(
+          token: @token,
+          url: @api_url,
+          full_repository_name: @repo_name,
+          mode: mode
+        )
+      rescue FlakyDetectionDisabledError
+        # The repository has not opted into flaky detection, or has no baseline
+        # yet. Both are expected; skip without surfacing an error.
+        nil
+      rescue StandardError => e
+        @flaky_detector_error_message = "Could not load flaky detector: #{e.message}"
+      end
+
+      def load_quarantine
+        return unless @token && @repo_name && @branch_name
+
+        require_relative 'quarantine'
+        @quarantined_tests = Quarantine.new(
+          api_url: @api_url,
+          token: @token,
+          repo_name: @repo_name,
+          branch_name: @branch_name
+        )
+      end
+    end
+  end
+end

data/lib/mergify/rspec/configuration.rb

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+require 'set'
+
+module Mergify
+  module RSpec
+    # Registers RSpec hooks for quarantine and flaky detection, and adds the
+    # Mergify Test Insights formatter when running inside CI.
+    module Configuration
+      module_function
+
+      # rubocop:disable Metrics/MethodLength,Metrics/BlockLength,Metrics/AbcSize
+      # rubocop:disable-next Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity
+      def setup!
+        ::RSpec.configure do |config|
+          # Add formatter when in CI
+          config.add_formatter(Mergify::RSpec::Formatter) if Utils.in_ci?
+
+          # Flaky detection: prepare session with all example IDs
+          config.before(:suite) do
+            ci = Mergify::RSpec.ci_insights
+            fd = ci&.flaky_detector
+            if fd
+              all_ids = ::RSpec.world.example_groups.flat_map(&:descendants).flat_map(&:examples).map(&:id)
+              fd.prepare_for_session(all_ids)
+            end
+          end
+
+          # Quarantine: mark tests before execution
+          config.before(:each) do |example|
+            ci = Mergify::RSpec.ci_insights
+            next unless ci&.quarantined_tests&.include?(example.id)
+
+            ci.quarantined_tests.mark_as_used(example.id)
+            example.metadata[:mergify_quarantined] = true
+          end
+
+          # Flaky detection: rerun tests within budget
+          config.around(:each) do |example|
+            ci = Mergify::RSpec.ci_insights
+            fd = ci&.flaky_detector
+
+            example.run
+
+            # Feed metrics from the initial run so the detector can evaluate
+            if fd
+              run_time = example.execution_result.run_time || 0.0
+              status = example.execution_result.status
+              fd.fill_metrics_from_report(example.id, 'setup', 0.0, status)
+              fd.fill_metrics_from_report(example.id, 'call', run_time, status)
+              fd.fill_metrics_from_report(example.id, 'teardown', 0.0, status)
+            end
+
+            next unless fd&.rerunning_test?(example.id)
+
+            # Mark as flaky detection candidate (even if too slow to rerun)
+            example.metadata[:mergify_flaky_detection] = true
+            example.metadata[:mergify_new_test] = true if fd.mode == 'new'
+
+            fd.set_test_deadline(example.id)
+            next if fd.test_too_slow?(example.id)
+
+            distinct_outcomes = Set.new
+            distinct_outcomes.add(example.execution_result.status) if example.execution_result.status
+
+            rerun_count = 0
+            # Use a null reporter to prevent reruns from being reported as
+            # individual failures. The final outcome is set after the loop.
+            null_reporter = ::RSpec::Core::NullReporter
+
+            until example.metadata[:is_last_rerun]
+              example.metadata[:is_last_rerun] = fd.last_rerun_for_test?(example.id)
+
+              # Reset example state for rerun
+              example.instance_variable_set(:@exception, nil)
+              if example.example_group_instance
+                memoized = example.example_group_instance.instance_variable_get(:@__memoized)
+                if memoized.respond_to?(:clear)
+                  memoized.clear
+                elsif memoized
+                  # RSpec >= 3.12 uses ThreadsafeMemoized which wraps an internal hash
+                  inner = memoized.instance_variable_get(:@memoized)
+                  inner&.clear
+                end
+              end
+
+              example.run(example.example_group_instance, null_reporter)
+
+              # Feed rerun metrics so budget/deadline tracking stays accurate
+              rerun_time = example.execution_result.run_time || 0.0
+              rerun_status = example.execution_result.status
+              fd.fill_metrics_from_report(example.id, 'call', rerun_time, rerun_status)
+
+              distinct_outcomes.add(rerun_status)
+              rerun_count += 1
+            end
+
+            is_flaky = distinct_outcomes.include?(:passed) &&
+                       distinct_outcomes.include?(:failed)
+            example.metadata[:mergify_flaky] = true if is_flaky
+            example.metadata[:mergify_rerun_count] = rerun_count
+          end
+
+          # Quarantine: override failed quarantined test results
+          config.after(:each) do |example|
+            next unless example.metadata[:mergify_quarantined] && example.exception
+
+            example.instance_variable_set(:@exception, nil)
+            example.execution_result.status = :pending
+            example.execution_result.pending_message = 'Test is quarantined from Mergify Test Insights'
+          end
+        end
+      end
+      # rubocop:enable Metrics/MethodLength,Metrics/BlockLength,Metrics/AbcSize
+    end
+  end
+end