rspec-mergify 0.1.3 → 0.2.0

data/lib/mergify/rspec/utils.rb

@@ -1,24 +1,21 @@
 # frozen_string_literal: true
 
-require 'open3'
-
 module Mergify
   module RSpec
     # Utility methods shared across the rspec-mergify gem.
+    #
+    # CI detection used to live here -- the provider table, the git shelling
+    # out, the per-provider environment mappings. It is the Rust core's now, via
+    # the extension in Mergify::RSpec::Native, so that every Mergify test client
+    # detects identically. What is left is what is genuinely Ruby's: parsing a
+    # repository name the API needs split, and deciding whether the plugin
+    # should switch itself on at all.
     module Utils
       module_function
 
       # Raised when a repository full name (owner/repo) is malformed.
       class InvalidRepositoryFullNameError < StandardError; end
 
-      SUPPORTED_CIS = {
-        'GITHUB_ACTIONS' => :github_actions,
-        'CIRCLECI' => :circleci,
-        'JENKINS_URL' => :jenkins,
-        'BUILDKITE' => :buildkite,
-        '_RSPEC_MERGIFY_TEST' => :rspec_mergify_suite
-      }.freeze
-
       TRUTHY_STRINGS = %w[y yes t true on 1].freeze
       FALSY_STRINGS  = %w[n no f false off 0].freeze
 
@@ -40,45 +37,14 @@ module Mergify
 
       # Returns true when the suite is running inside CI or when
       # RSPEC_MERGIFY_ENABLE is set to a truthy value.
+      #
+      # Deliberately not the core's provider detection: this asks whether the
+      # plugin should run, which an unrecognised CI or a developer setting
+      # RSPEC_MERGIFY_ENABLE both answer yes to.
       def in_ci?
         env_truthy?('CI') || env_truthy?('RSPEC_MERGIFY_ENABLE')
       end
 
-      # Evaluates whether a CI environment variable should be considered enabled.
-      # rubocop:disable Metrics/MethodLength
-      def ci_provider
-        SUPPORTED_CIS.each do |envvar, name|
-          next unless ENV.key?(envvar)
-
-          enabled =
-            begin
-              strtobool(ENV.fetch(envvar, ''))
-            rescue ArgumentError
-              !ENV.fetch(envvar, '').strip.empty?
-            end
-
-          return name if enabled
-        end
-        nil
-      end
-      # rubocop:enable Metrics/MethodLength
-
-      # Parse a git remote URL (SSH or HTTPS) into "owner/repo" form.
-      # Returns nil when the URL cannot be recognised.
-      def repository_name_from_url(url)
-        # SSH: git@github.com:owner/repo.git
-        if (m = url.match(%r{\Agit@[\w.-]+:(?<full_name>[\w.-]+/[\w.-]+?)(?:\.git)?/?$}))
-          return m[:full_name]
-        end
-
-        # HTTPS/HTTP with optional host (and optional port)
-        if (m = url.match(%r{\A(?:https?://[\w.-]+(?::\d+)?/)?(?<full_name>[\w.-]+/[\w.-]+)/?\z}))
-          return m[:full_name]
-        end
-
-        nil
-      end
-
       # Split "owner/repo" into [owner, repo].
       # Raises InvalidRepositoryFullNameError when the format is wrong.
       def split_full_repo_name(full_repo_name)
@@ -87,56 +53,6 @@ module Mergify
 
         raise InvalidRepositoryFullNameError, "Invalid repository name: #{full_repo_name}"
       end
-
-      # Run a git subcommand via Open3.
-      # Returns stripped stdout on success, nil on failure.
-      def git(*args)
-        stdout, status = Open3.capture2('git', *args, err: File::NULL)
-        status.success? ? stdout.strip : nil
-      rescue StandardError
-        nil
-      end
-
-      # Build an attribute hash from a mapping of
-      # { attr_name => [cast_method_symbol, env_var_name_or_callable] }.
-      # Attributes whose env var is unset or whose callable returns nil are omitted.
-      def get_attributes(mapping)
-        mapping.each_with_object({}) do |(attr, (cast, env_or_callable)), result|
-          value = env_or_callable.respond_to?(:call) ? env_or_callable.call : ENV.fetch(env_or_callable, nil)
-
-          next if value.nil?
-          next if value.respond_to?(:empty?) && value.empty?
-
-          result[attr] = value.public_send(cast)
-        end
-      end
-
-      # Detect the repository name using CI environment variables or a git
-      # remote fallback.
-      # rubocop:disable Metrics/MethodLength,Metrics/CyclomaticComplexity
-      def repository_name
-        provider = ci_provider
-
-        case provider
-        when :jenkins
-          url = ENV.fetch('GIT_URL', nil)
-          return repository_name_from_url(url) if url
-        when :github_actions
-          return ENV.fetch('GITHUB_REPOSITORY', nil)
-        when :circleci
-          url = ENV.fetch('CIRCLE_REPOSITORY_URL', nil)
-          return repository_name_from_url(url) if url
-        when :buildkite
-          url = ENV.fetch('BUILDKITE_REPO', nil)
-          return repository_name_from_url(url) if url
-        when :rspec_mergify_suite
-          return 'Mergifyio/rspec-mergify'
-        end
-
-        url = git('config', '--get', 'remote.origin.url')
-        repository_name_from_url(url) if url
-      end
-      # rubocop:enable Metrics/MethodLength,Metrics/CyclomaticComplexity
     end
   end
 end

data/lib/mergify/rspec/version.rb

@@ -2,17 +2,12 @@
 
 module Mergify
   module RSpec
-    VERSION = begin
-      v = `git describe --tags 2>/dev/null`.strip.delete_prefix('v')
-      if v.empty?
-        '0.0.0.dev'
-      elsif v.include?('-')
-        # e.g. "0.1.0-3-gabc123" -> "0.1.0.dev3"
-        parts = v.split('-')
-        "#{parts[0]}.dev#{parts[1]}"
-      else
-        v
-      end
-    end
+    # Placeholder: the release workflow stamps the real version from the git tag
+    # at build time, as it does for pytest-mergify's pyproject.toml and the TS
+    # packages' package.json. This used to shell out to `git describe --tags`,
+    # which resolved against whatever repository happened to be the working
+    # directory at load time -- the monorepo's namespaced tags here, the user's
+    # own tags once the gem was installed.
+    VERSION = '0.2.0'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-mergify
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Mergify
@@ -66,24 +66,19 @@ files:
 - lib/mergify/rspec/configuration.rb
 - lib/mergify/rspec/flaky_detection.rb
 - lib/mergify/rspec/formatter.rb
+- lib/mergify/rspec/native.rb
 - lib/mergify/rspec/quarantine.rb
-- lib/mergify/rspec/resources/buildkite.rb
-- lib/mergify/rspec/resources/ci.rb
-- lib/mergify/rspec/resources/git.rb
-- lib/mergify/rspec/resources/github_actions.rb
-- lib/mergify/rspec/resources/jenkins.rb
-- lib/mergify/rspec/resources/mergify.rb
 - lib/mergify/rspec/resources/rspec.rb
 - lib/mergify/rspec/synchronous_batch_span_processor.rb
 - lib/mergify/rspec/utils.rb
 - lib/mergify/rspec/version.rb
 - lib/rspec_mergify.rb
-homepage: https://github.com/Mergifyio/rspec-mergify
+homepage: https://github.com/Mergifyio/mergify-ci-integrations
 licenses:
-- GPL-3.0-only
+- Apache-2.0
 metadata:
-  homepage_uri: https://github.com/Mergifyio/rspec-mergify
-  source_code_uri: https://github.com/Mergifyio/rspec-mergify
+  homepage_uri: https://github.com/Mergifyio/mergify-ci-integrations
+  source_code_uri: https://github.com/Mergifyio/mergify-ci-integrations/tree/main/clients/rspec-mergify
   rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
@@ -99,7 +94,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.16
 specification_version: 4
 summary: RSpec plugin for Mergify CI Insights
 test_files: []

data/lib/mergify/rspec/resources/buildkite.rb

@@ -1,54 +0,0 @@
-# frozen_string_literal: true
-
-require 'opentelemetry-sdk'
-require_relative '../utils'
-require_relative 'git'
-
-module Mergify
-  module RSpec
-    module Resources
-      # Detects OpenTelemetry Resource attributes for Buildkite.
-      module Buildkite
-        module_function
-
-        BUILDKITE_MAPPING = {
-          'cicd.pipeline.name' => [:to_s, 'BUILDKITE_PIPELINE_SLUG'],
-          'cicd.pipeline.task.name' => [
-            :to_s,
-            lambda {
-              label = ENV.fetch('BUILDKITE_LABEL', nil)
-              label && !label.empty? ? label : ENV.fetch('BUILDKITE_STEP_KEY', nil)
-            }
-          ],
-          'cicd.pipeline.run.id' => [:to_s, 'BUILDKITE_BUILD_ID'],
-          'cicd.pipeline.run.url' => [:to_s, 'BUILDKITE_BUILD_URL'],
-          'cicd.pipeline.run.attempt' => [
-            :to_i,
-            -> { ENV.fetch('BUILDKITE_RETRY_COUNT', '0').to_i + 1 }
-          ],
-          'cicd.pipeline.runner.name' => [:to_s, 'BUILDKITE_AGENT_NAME'],
-          'vcs.ref.head.name' => [:to_s, 'BUILDKITE_BRANCH'],
-          'vcs.ref.base.name' => [:to_s, 'BUILDKITE_PULL_REQUEST_BASE_BRANCH'],
-          'vcs.ref.head.revision' => [:to_s, 'BUILDKITE_COMMIT'],
-          'vcs.repository.url.full' => [:to_s, 'BUILDKITE_REPO'],
-          'vcs.repository.name' => [
-            :to_s,
-            lambda {
-              url = ENV.fetch('BUILDKITE_REPO', nil)
-              Utils.repository_name_from_url(url) if url
-            }
-          ]
-        }.freeze
-
-        def detect
-          return OpenTelemetry::SDK::Resources::Resource.create({}) if Utils.ci_provider != :buildkite
-
-          git_attrs = Utils.get_attributes(Git::GIT_MAPPING)
-          buildkite_attrs = Utils.get_attributes(BUILDKITE_MAPPING)
-          merged = git_attrs.merge(buildkite_attrs)
-          OpenTelemetry::SDK::Resources::Resource.create(merged)
-        end
-      end
-    end
-  end
-end

data/lib/mergify/rspec/resources/ci.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-require 'opentelemetry-sdk'
-require_relative '../utils'
-
-module Mergify
-  module RSpec
-    module Resources
-      # Detects OpenTelemetry Resource attributes for the CI provider.
-      module CI
-        module_function
-
-        def detect
-          provider = Utils.ci_provider
-          return OpenTelemetry::SDK::Resources::Resource.create({}) if provider.nil?
-
-          OpenTelemetry::SDK::Resources::Resource.create(
-            'cicd.provider.name' => provider.to_s
-          )
-        end
-      end
-    end
-  end
-end

data/lib/mergify/rspec/resources/git.rb

@@ -1,35 +0,0 @@
-# frozen_string_literal: true
-
-require 'opentelemetry-sdk'
-require_relative '../utils'
-
-module Mergify
-  module RSpec
-    module Resources
-      # Detects OpenTelemetry Resource attributes from git.
-      module Git
-        module_function
-
-        GIT_MAPPING = {
-          'vcs.ref.head.name' => [:to_s, -> { Utils.git('rev-parse', '--abbrev-ref', 'HEAD') }],
-          'vcs.ref.head.revision' => [:to_s, -> { Utils.git('rev-parse', 'HEAD') }],
-          'vcs.repository.url.full' => [:to_s, -> { Utils.git('config', '--get', 'remote.origin.url') }],
-          'vcs.repository.name' => [
-            :to_s,
-            lambda {
-              url = Utils.git('config', '--get', 'remote.origin.url')
-              Utils.repository_name_from_url(url) if url
-            }
-          ]
-        }.freeze
-
-        def detect
-          return OpenTelemetry::SDK::Resources::Resource.create({}) if Utils.ci_provider.nil?
-
-          attributes = Utils.get_attributes(GIT_MAPPING)
-          OpenTelemetry::SDK::Resources::Resource.create(attributes)
-        end
-      end
-    end
-  end
-end

data/lib/mergify/rspec/resources/github_actions.rb

@@ -1,60 +0,0 @@
-# frozen_string_literal: true
-
-require 'json'
-require 'opentelemetry-sdk'
-require_relative '../utils'
-
-module Mergify
-  module RSpec
-    module Resources
-      # Detects OpenTelemetry Resource attributes for GitHub Actions.
-      module GitHubActions
-        module_function
-
-        def detect
-          return OpenTelemetry::SDK::Resources::Resource.create({}) if Utils.ci_provider != :github_actions
-
-          attributes = Utils.get_attributes(GHA_MAPPING)
-          OpenTelemetry::SDK::Resources::Resource.create(attributes)
-        end
-
-        GHA_MAPPING = {
-          'cicd.pipeline.name' => [:to_s, 'GITHUB_WORKFLOW'],
-          'cicd.pipeline.task.name' => [:to_s, 'GITHUB_JOB'],
-          'cicd.pipeline.run.id' => [:to_i, 'GITHUB_RUN_ID'],
-          'cicd.pipeline.run.attempt' => [:to_i, 'GITHUB_RUN_ATTEMPT'],
-          'cicd.pipeline.runner.name' => [:to_s, 'RUNNER_NAME'],
-          'vcs.ref.head.name' => [:to_s, -> { head_ref_name }],
-          'vcs.ref.head.type' => [:to_s, 'GITHUB_REF_TYPE'],
-          'vcs.ref.base.name' => [:to_s, 'GITHUB_BASE_REF'],
-          'vcs.repository.name' => [:to_s, 'GITHUB_REPOSITORY'],
-          'vcs.repository.id' => [:to_i, 'GITHUB_REPOSITORY_ID'],
-          'vcs.repository.url.full' => [:to_s, -> { repository_url }],
-          'vcs.ref.head.revision' => [:to_s, -> { head_sha }]
-        }.freeze
-
-        def head_ref_name
-          ref = ENV.fetch('GITHUB_HEAD_REF', '')
-          ref.empty? ? ENV.fetch('GITHUB_REF_NAME', nil) : ref
-        end
-
-        def repository_url
-          server = ENV.fetch('GITHUB_SERVER_URL', nil)
-          repo = ENV.fetch('GITHUB_REPOSITORY', nil)
-          "#{server}/#{repo}" if server && repo
-        end
-
-        def head_sha
-          if ENV.fetch('GITHUB_EVENT_NAME', nil) == 'pull_request'
-            event_path = ENV.fetch('GITHUB_EVENT_PATH', nil)
-            if event_path && File.file?(event_path)
-              event = JSON.parse(File.read(event_path))
-              return event.dig('pull_request', 'head', 'sha').to_s
-            end
-          end
-          ENV.fetch('GITHUB_SHA', nil)
-        end
-      end
-    end
-  end
-end

data/lib/mergify/rspec/resources/jenkins.rb

@@ -1,55 +0,0 @@
-# frozen_string_literal: true
-
-require 'opentelemetry-sdk'
-require_relative '../utils'
-require_relative 'git'
-
-module Mergify
-  module RSpec
-    module Resources
-      # Detects OpenTelemetry Resource attributes for Jenkins.
-      module Jenkins
-        module_function
-
-        GIT_BRANCH_PREFIXES = %w[origin/ refs/heads/].freeze
-
-        JENKINS_MAPPING = {
-          'cicd.pipeline.name' => [:to_s, 'JOB_NAME'],
-          'cicd.pipeline.task.name' => [:to_s, 'JOB_NAME'],
-          'cicd.pipeline.run.id' => [:to_s, 'BUILD_ID'],
-          'cicd.pipeline.run.url' => [:to_s, 'BUILD_URL'],
-          'cicd.pipeline.runner.name' => [:to_s, 'NODE_NAME'],
-          'vcs.ref.head.name' => [:to_s, -> { branch }],
-          'vcs.ref.head.revision' => [:to_s, 'GIT_COMMIT'],
-          'vcs.repository.url.full' => [:to_s, 'GIT_URL'],
-          'vcs.repository.name' => [
-            :to_s,
-            lambda {
-              url = ENV.fetch('GIT_URL', nil)
-              Utils.repository_name_from_url(url) if url
-            }
-          ]
-        }.freeze
-
-        def detect
-          return OpenTelemetry::SDK::Resources::Resource.create({}) if Utils.ci_provider != :jenkins
-
-          git_attrs = Utils.get_attributes(Git::GIT_MAPPING)
-          jenkins_attrs = Utils.get_attributes(JENKINS_MAPPING)
-          merged = git_attrs.merge(jenkins_attrs)
-          OpenTelemetry::SDK::Resources::Resource.create(merged)
-        end
-
-        def branch
-          raw = ENV.fetch('GIT_BRANCH', nil)
-          return nil unless raw
-
-          GIT_BRANCH_PREFIXES.each do |prefix|
-            return raw[prefix.length..] if raw.start_with?(prefix)
-          end
-          raw
-        end
-      end
-    end
-  end
-end

data/lib/mergify/rspec/resources/mergify.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-require 'opentelemetry-sdk'
-require_relative '../utils'
-
-module Mergify
-  module RSpec
-    module Resources
-      # Detects OpenTelemetry Resource attributes for Mergify-specific fields.
-      module Mergify
-        module_function
-
-        MERGIFY_MAPPING = {
-          'mergify.test.job.name' => [:to_s, 'MERGIFY_TEST_JOB_NAME']
-        }.freeze
-
-        def detect
-          attributes = Utils.get_attributes(MERGIFY_MAPPING)
-          OpenTelemetry::SDK::Resources::Resource.create(attributes)
-        end
-      end
-    end
-  end
-end