cucumber-ci-environment 8.1.0 → 9.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3d3ea98e767664065044ea095d2b3d12d3f8c8a63f02af5e2881f9fff82b64df
-  data.tar.gz: 9f5da9baf7e74e81d6ec5f02dbaa0601457d8e22f81eeba355b07a4105ab4b26
+  metadata.gz: 1fa280ae7a64a91f8851d28e4419f2d391ba080e0e511ed045594175d58c8225
+  data.tar.gz: 9bbe09efed429d2bcad1852c934357d0706a663f6450c33a9dadc62e990e005f
 SHA512:
-  metadata.gz: ab82395b61fcdfcb5c65f75fbc2aee237a4d699cb1aed9344e99f38ff90d40ecef5e8bec88b3ca787c5b3e8096e23fa05e786a2ed43efb83a2bdc87d236a089e
-  data.tar.gz: ca131069f18511eb234ff5f91465119a1451a176440841d191041b4eccd6c0b4661afe239e7c0ba43843edea281c82e417d5520d3d83302bf02e72d96d68f889
+  metadata.gz: 7fde55b617bd13cfbdc6766dcf75d67cc6f4cfe0ac9e67d906194ff8b5f7ca1422227dce609435ee420a95fd24048a5d606861c5e4d5a1659f257c88a63439d5
+  data.tar.gz: 0c26bd5ec292118386175d6a2aa707fc025d2994cd516184cdced9aadcbd215d259c3c442181decdf7c781ac34dcbd10b1b8bf8f2a15c049e8f4411ae0437337

data/lib/cucumber/ci_environment/CiEnvironments.json

@@ -17,8 +17,7 @@
     "git": {
       "remote": "${bamboo_planRepository_repositoryUrl}",
       "revision": "${bamboo_planRepository_revision}",
-      "branch": "${bamboo_planRepository_branch}",
-      "tag": null
+      "branch": "${bamboo_planRepository_branch}"
     }
   },
   {
@@ -61,8 +60,7 @@
     "git": {
       "remote": "${CF_COMMIT_URL/(.*)\\/commit.+$/\\1}.git",
       "revision": "${CF_REVISION}",
-      "branch": "${CF_BRANCH}",
-      "tag": null
+      "branch": "${CF_BRANCH}"
     }
   },
   {
@@ -72,8 +70,7 @@
     "git": {
       "remote": "${CI_PULL_REQUEST/(.*)\\/pull\\/\\d+/\\1.git}",
       "revision": "${CI_COMMIT_ID}",
-      "branch": "${CI_BRANCH}",
-      "tag": null
+      "branch": "${CI_BRANCH}"
     }
   },
   {
@@ -83,7 +80,7 @@
     "git": {
       "remote": "${GITHUB_SERVER_URL}/${GITHUB_REPOSITORY}.git",
       "revision": "${GITHUB_SHA}",
-      "branch": "${GITHUB_REF/refs\/heads\/(.*)/\\1}",
+      "branch": "${GITHUB_HEAD_REF}",
       "tag": "${GITHUB_REF/refs\/tags\/(.*)/\\1}"
     }
   },
@@ -105,8 +102,7 @@
     "git": {
       "remote": "${GO_SCM_*_PR_URL/(.*)\\/pull\\/\\d+/\\1.git}",
       "revision": "${GO_REVISION}",
-      "branch": "${GO_SCM_*_PR_BRANCH/.*:(.*)/\\1}",
-      "tag": null
+      "branch": "${GO_SCM_*_PR_BRANCH/.*:(.*)/\\1}"
     }
   },
   {
@@ -116,8 +112,7 @@
     "git": {
       "remote": "${GIT_URL}",
       "revision": "${GIT_COMMIT}",
-      "branch": "${GIT_LOCAL_BRANCH}",
-      "tag": null
+      "branch": "${GIT_LOCAL_BRANCH}"
     }
   },
   {
@@ -149,8 +144,7 @@
     "git": {
       "remote": "https://${WERCKER_GIT_DOMAIN}/${WERCKER_GIT_OWNER}/${WERCKER_GIT_REPOSITORY}.git",
       "revision": "${WERCKER_GIT_COMMIT}",
-      "branch": "${WERCKER_GIT_BRANCH}",
-      "tag": null
+      "branch": "${WERCKER_GIT_BRANCH}"
     }
   }
 ]

data/lib/cucumber/ci_environment.rb

@@ -7,17 +7,17 @@ module Cucumber
     extend VariableExpression
     CI_ENVIRONMENTS_PATH = File.join(File.dirname(__FILE__), 'ci_environment/CiEnvironments.json')
 
-    def detect_ci_environment(env)
-      ci_environments = JSON.parse(IO.read(CI_ENVIRONMENTS_PATH))
+    def detect_ci_environment(env, file_reader = IO.method(:read))
+      ci_environments = JSON.parse(file_reader.call(CI_ENVIRONMENTS_PATH))
       ci_environments.each do |ci_environment|
-        detected = detect(ci_environment, env)
+        detected = detect(ci_environment, env, file_reader)
         return detected unless detected.nil?
       end
 
       nil
     end
 
-    def detect(ci_environment, env)
+    def detect(ci_environment, env, file_reader)
       url = evaluate(ci_environment['url'], env)
       return nil if url.nil?
 
@@ -27,13 +27,13 @@ module Cucumber
         buildNumber: evaluate(ci_environment['buildNumber'], env),
       }
 
-      detected_git = detect_git(ci_environment, env)
+      detected_git = detect_git(ci_environment, env, file_reader)
       result[:git] = detected_git if detected_git
       result
     end
 
-    def detect_git(ci_environment, env)
-      revision = evaluate(ci_environment['git']['revision'], env)
+    def detect_git(ci_environment, env, file_reader)
+      revision = detect_revision(ci_environment, env, file_reader)
       return nil if revision.nil?
 
       remote = evaluate(ci_environment['git']['remote'], env)
@@ -51,6 +51,17 @@ module Cucumber
       git_info
     end
 
+    def detect_revision(ci_environment, env, file_reader)
+      if env['GITHUB_EVENT_NAME'] == 'pull_request'
+        raise StandardError('GITHUB_EVENT_PATH not set') unless env['GITHUB_EVENT_PATH']
+        event = JSON.parse(file_reader.call(env['GITHUB_EVENT_PATH']))
+        raise StandardError("No after property in #{env['GITHUB_EVENT_PATH']}:\n#{JSON.pretty_generate(event)}") unless event['after']
+        return event['after']
+      end
+
+      return evaluate(ci_environment['git']['revision'], env)
+    end
+
     def remove_userinfo_from_url(value)
       return nil if value.nil?
 
@@ -63,6 +74,6 @@ module Cucumber
       end
     end
 
-    module_function :detect_ci_environment, :detect, :detect_git, :remove_userinfo_from_url
+    module_function :detect_ci_environment, :detect, :detect_git, :detect_revision, :remove_userinfo_from_url
   end
 end

data/spec/cucumber/ci_environment/ci_environment_spec.rb

@@ -8,7 +8,12 @@ describe 'detect_ci_environment' do
     context "with #{File.basename(test_data_file, '.txt')}" do
       subject { JSON.parse(ci_environment.to_json) }
 
-      let(:ci_environment) { Cucumber::CiEnvironment.detect_ci_environment(env) }
+      def mock_reader(path)
+        return '{"after": "2436f28fad432a895bfc595bce16e907144b0dc3"}' if path.end_with?('_github_workflow/event.json')
+        IO.read(path)
+      end
+
+      let(:ci_environment) { Cucumber::CiEnvironment.detect_ci_environment(env, method(:mock_reader)) }
       let(:env) { Hash[entries] }
       let(:entries) { env_data.split(/\n/).map { |line| line.split(/=/) } }
       let(:env_data) { IO.read(test_data_file) }

data/spec/cucumber/ci_environment/github_pull_request_integration_spec.rb

@@ -0,0 +1,10 @@
+describe 'GitHub' do
+  if (ENV['GITHUB_EVENT_NAME'] == 'pull_request')
+    it 'detects the correct revision for pull requests' do
+      ci_environment = Cucumber::CiEnvironment.detect_ci_environment(ENV)
+      expect(ci_environment).to be_truthy
+      puts ("Manually verify that the revision is correct");
+      p ci_environment
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cucumber-ci-environment
 version: !ruby/object:Gem::Version
-  version: 8.1.0
+  version: 9.0.2
 platform: ruby
 authors:
 - Vincent Prêtre
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-02 00:00:00.000000000 Z
+date: 2022-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -36,20 +36,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.10'
+        version: '3.11'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.10.0
+        version: 3.11.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.10'
+        version: '3.11'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.10.0
+        version: 3.11.0
 description: Detect CI Environment from environment variables
 email: cukes@googlegroups.com
 executables: []
@@ -63,6 +63,7 @@ files:
 - spec/capture_warnings.rb
 - spec/cucumber/ci_environment/ci_environment_spec.rb
 - spec/cucumber/ci_environment/evaluate_variable_expression_spec.rb
+- spec/cucumber/ci_environment/github_pull_request_integration_spec.rb
 - spec/cucumber/ci_environment/remove_userinfo_from_url_spec.rb
 homepage: https://github.com/cucumber/ci-environment
 licenses:
@@ -92,9 +93,10 @@ requirements: []
 rubygems_version: 3.2.32
 signing_key: 
 specification_version: 4
-summary: cucumber-ci-environment-8.1.0
+summary: cucumber-ci-environment-9.0.2
 test_files:
 - spec/capture_warnings.rb
 - spec/cucumber/ci_environment/ci_environment_spec.rb
 - spec/cucumber/ci_environment/evaluate_variable_expression_spec.rb
+- spec/cucumber/ci_environment/github_pull_request_integration_spec.rb
 - spec/cucumber/ci_environment/remove_userinfo_from_url_spec.rb