cucumber-create-meta 4.0.0 → 6.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9c0d4c7da171c38558ed7c0809aa059da8161aeeab9fc0f2a788f757712fc953
-  data.tar.gz: 997e930fe502d8a6f58ab7e8489b4b677b077a8f123d4748c40971ac14a235a5
+  metadata.gz: cbeec9c9555758136e2dab0114910c1ee47bab5cd1ddd0c53bab5d36db42b3aa
+  data.tar.gz: 6a740a16b9ab323fc360579ab13259603caa77ee9fc3fb8a0fe2bed07f02fb85
 SHA512:
-  metadata.gz: 2a7eabe5cbfcae7db34f143aec073c0341f91e5e09266ad0b417e0419f10ef5daf9ddc1cedec8dabd12976d7f9b24adff217c5b6226511eac758e30aca880463
-  data.tar.gz: 94c175d39941c886a7e8322a90f618747a5fffb148c06a3523034c0ff676a377efbd049f33fa7094270308690e9ec099c65c4aee180940262962ca5a92aa2b9c
+  metadata.gz: a90d7404c481a3a0da38cad6f44a740982955d43651fb1ffbecec4270aa3e652695879dc8a70e6a6fbd2e05cea5959618788e8de0efe34f5a6975cbd61996a6b
+  data.tar.gz: fafdb21be0d5d8c6b76eed939954b858a60bcec4bc4c84d9e3e54bad6658f36565b30b5a7f11df40aa3c2996d0921c1ed06f2b4d3617a81c43d7f72043de474f

data/lib/cucumber/ciDict.json

@@ -1,24 +1,27 @@
 {
   "Azure Pipelines": {
-    "url": "${BUILD_URI}",
+    "url": "${BUILD_BUILDURI}",
+    "buildNumber": "${BUILD_BUILDNUMBER}",
     "git": {
       "remote": "${BUILD_REPOSITORY_URI}",
       "revision": "${BUILD_SOURCEVERSION}",
-      "branch": "${refbranch BUILD_SOURCEBRANCH}",
-      "tag": "${reftag BUILD_SOURCEBRANCH}"
+      "branch": "${BUILD_SOURCEBRANCH/refs\/heads\/(.*)/\\1}",
+      "tag": "${BUILD_SOURCEBRANCH/refs\/tags\/(.*)/\\1}"
     }
   },
   "Bamboo": {
-    "url": "${bamboo.buildResultsUrl}",
+    "url": "${bamboo_buildResultsUrl}",
+    "buildNumber": "${bamboo_buildNumber}",
     "git": {
-      "remote": "${bamboo.planRepository.1.repositoryUrl}",
-      "revision": "${bamboo.planRepository.1.revision}",
-      "branch": "${bamboo.planRepository.1.branch}",
+      "remote": "${bamboo_planRepository_repositoryUrl}",
+      "revision": "${bamboo_planRepository_revision}",
+      "branch": "${bamboo_planRepository_branch}",
       "tag": null
     }
   },
   "Buddy": {
     "url": "${BUDDY_EXECUTION_URL}",
+    "buildNumber": "${BUDDY_EXECUTION_ID}",
     "git": {
       "remote": "${BUDDY_SCM_URL}",
       "revision": "${BUDDY_EXECUTION_REVISION}",
@@ -26,8 +29,19 @@
       "tag": "${BUDDY_EXECUTION_TAG}"
     }
   },
+  "Bitrise": {
+    "url": "${BITRISE_BUILD_URL}",
+    "buildNumber": "${BITRISE_BUILD_NUMBER}",
+    "git": {
+      "remote": "${GIT_REPOSITORY_URL}",
+      "revision": "${BITRISE_GIT_COMMIT}",
+      "branch": "${BITRISE_GIT_BRANCH}",
+      "tag": "${BITRISE_GIT_TAG}"
+    }
+  },
   "CircleCI": {
     "url": "${CIRCLE_BUILD_URL}",
+    "buildNumber": "${CIRCLE_BUILD_NUM}",
     "git": {
       "remote": "${CIRCLE_REPOSITORY_URL}",
       "revision": "${CIRCLE_SHA1}",
@@ -35,26 +49,39 @@
       "tag": "${CIRCLE_TAG}"
     }
   },
-  "CodeShip": {
+  "CodeFresh": {
     "url": "${CF_BUILD_URL}",
+    "buildNumber": "${CF_BUILD_ID}",
     "git": {
-      "remote": "${CF_COMMIT_URL}",
+      "remote": "${CF_COMMIT_URL/(.*)\\/commit.+$/\\1}.git",
       "revision": "${CF_REVISION}",
       "branch": "${CF_BRANCH}",
       "tag": null
     }
   },
+  "CodeShip": {
+    "url": "${CI_BUILD_URL}",
+    "buildNumber": "${CI_BUILD_NUMBER}",
+    "git": {
+      "remote": "${CI_PULL_REQUEST/(.*)\\/pull\\/\\d+/\\1.git}",
+      "revision": "${CI_COMMIT_ID}",
+      "branch": "${CI_BRANCH}",
+      "tag": null
+    }
+  },
   "GitHub Actions": {
     "url": "${GITHUB_SERVER_URL}/${GITHUB_REPOSITORY}/actions/runs/${GITHUB_RUN_ID}",
+    "buildNumber": "${GITHUB_RUN_ID}",
     "git": {
       "remote": "${GITHUB_SERVER_URL}/${GITHUB_REPOSITORY}.git",
       "revision": "${GITHUB_SHA}",
-      "branch": "${refbranch GITHUB_REF}",
-      "tag": "${reftag GITHUB_REF}"
+      "branch": "${GITHUB_REF/refs\/heads\/(.*)/\\1}",
+      "tag": "${GITHUB_REF/refs\/tags\/(.*)/\\1}"
     }
   },
   "GitLab": {
     "url": "${CI_JOB_URL}",
+    "buildNumber": "${CI_JOB_ID}",
     "git": {
       "remote": "${CI_REPOSITORY_URL}",
       "revision": "${CI_COMMIT_SHA}",
@@ -63,16 +90,28 @@
     }
   },
   "GoCD": {
-    "url": "${GO_SERVER_URL}/???",
+    "url": "${GO_SERVER_URL}/pipelines/${GO_PIPELINE_NAME}/${GO_PIPELINE_COUNTER}/${GO_STAGE_NAME}/${GO_STAGE_COUNTER}",
+    "buildNumber": "${GO_PIPELINE_NAME}/${GO_PIPELINE_COUNTER}/${GO_STAGE_NAME}/${GO_STAGE_COUNTER}",
     "git": {
-      "remote": null,
+      "remote": "${GO_SCM_*_PR_URL/(.*)\\/pull\\/\\d+/\\1.git}",
       "revision": "${GO_REVISION}",
-      "branch": null,
+      "branch": "${GO_SCM_*_PR_BRANCH/.*:(.*)/\\1}",
+      "tag": null
+    }
+  },
+  "Jenkins": {
+    "url": "${BUILD_URL}",
+    "buildNumber": "${BUILD_NUMBER}",
+    "git": {
+      "remote": "${GIT_URL}",
+      "revision": "${GIT_COMMIT}",
+      "branch": "${GIT_LOCAL_BRANCH}",
       "tag": null
     }
   },
   "Semaphore": {
-    "url": "${SEMAPHORE_ORGANIZATION_URL}/${}",
+    "url": "${SEMAPHORE_ORGANIZATION_URL}/jobs/${SEMAPHORE_JOB_ID}",
+    "buildNumber": "${SEMAPHORE_JOB_ID}",
     "git": {
       "remote": "${SEMAPHORE_GIT_URL}",
       "revision": "${SEMAPHORE_GIT_SHA}",
@@ -80,17 +119,9 @@
       "tag": "${SEMAPHORE_GIT_TAG_NAME}"
     }
   },
-  "TeamCity": {
-    "url": "${teamcity.serverUrl}/app/rest/builds/id:${teamcity.build.id}",
-    "git": {
-      "remote": null,
-      "revision": "${build.vcs.number}",
-      "branch": "${teamcity.build.branch}",
-      "tag": null
-    }
-  },
   "Travis CI": {
     "url": "${TRAVIS_BUILD_WEB_URL}",
+    "buildNumber": "${TRAVIS_JOB_NUMBER}",
     "git": {
       "remote": "https://github.com/${TRAVIS_REPO_SLUG}.git",
       "revision": "${TRAVIS_COMMIT}",
@@ -100,6 +131,7 @@
   },
   "Wercker": {
     "url": "${WERCKER_RUN_URL}",
+    "buildNumber": "${WERCKER_RUN_URL/.*\\/([^\\/]+)$/\\1}",
     "git": {
       "remote": "https://${WERCKER_GIT_DOMAIN}/${WERCKER_GIT_OWNER}/${WERCKER_GIT_REPOSITORY}.git",
       "revision": "${WERCKER_GIT_COMMIT}",

data/lib/cucumber/create_meta/variable_expression.rb

@@ -0,0 +1,41 @@
+module Cucumber
+  module CreateMeta
+    module VariableExpression
+      def evaluate(expression, env)
+        return nil if expression.nil?
+        begin
+          expression.gsub(/\${(.*?)(?:(?<!\\)\/(.*)\/(.*))?}/) do
+            variable = $1
+            pattern = $2
+            replacement = $3
+
+            value = get_value(variable, env)
+            raise "Undefined variable #{variable}" if value.nil?
+            if pattern.nil?
+              value
+            else
+              regexp = Regexp.new(pattern.gsub('\/', '/'))
+              match = value.match(regexp)
+              raise "No match for variable #{variable}" if match.nil?
+              match[1..-1].each_with_index do |group, i|
+                replacement = replacement.gsub("\\#{i+1}", group)
+              end
+              replacement
+            end
+          end
+        rescue
+          nil
+        end
+      end
+
+      def get_value(variable, env)
+        if variable.index('*')
+          env.each do |name, value|
+            return value if Regexp.new(variable.gsub('*', '.*')) =~ name
+          end
+        end
+        env[variable]
+      end
+    end
+  end
+end

data/lib/cucumber/create_meta.rb

@@ -1,31 +1,33 @@
 require 'uri'
-require 'cucumber/messages'
 require 'sys/uname'
 require 'json'
+require 'cucumber/messages'
+require 'cucumber/create_meta/variable_expression'
 
 module Cucumber
   module CreateMeta
+    extend Cucumber::CreateMeta::VariableExpression
     CI_DICT = JSON.parse(IO.read(File.join(File.dirname(__FILE__), "ciDict.json")))
 
     def create_meta(tool_name, tool_version, env = ENV)
       Cucumber::Messages::Meta.new(
-          protocol_version: Cucumber::Messages::VERSION,
-          implementation: Cucumber::Messages::Meta::Product.new(
-              name: tool_name,
-              version: tool_version
-          ),
-          runtime: Cucumber::Messages::Meta::Product.new(
-              name: RUBY_ENGINE,
-              version: RUBY_VERSION
-          ),
-          os: Cucumber::Messages::Meta::Product.new(
-              name: RbConfig::CONFIG['target_os'],
-              version: Sys::Uname.uname.version
-          ),
-          cpu: Cucumber::Messages::Meta::Product.new(
-              name: RbConfig::CONFIG['target_cpu']
-          ),
-          ci: detect_ci(env)
+        protocol_version: Cucumber::Messages::VERSION,
+        implementation: Cucumber::Messages::Product.new(
+            name: tool_name,
+            version: tool_version
+        ),
+        runtime: Cucumber::Messages::Product.new(
+            name: RUBY_ENGINE,
+            version: RUBY_VERSION
+        ),
+        os: Cucumber::Messages::Product.new(
+            name: RbConfig::CONFIG['target_os'],
+            version: Sys::Uname.uname.version
+        ),
+        cpu: Cucumber::Messages::Product.new(
+            name: RbConfig::CONFIG['target_cpu']
+        ),
+        ci: detect_ci(env)
       )
     end
 
@@ -41,46 +43,19 @@ module Cucumber
       url = evaluate(ci_system['url'], env)
       return nil if url.nil?
 
-      Cucumber::Messages::Meta::CI.new(
-          url: url,
-          name: ci_name,
-          git: Cucumber::Messages::Meta::CI::Git.new(
-              remote: remove_userinfo_from_url(evaluate(ci_system['git']['remote'], env)),
-              revision: evaluate(ci_system['git']['revision'], env),
-              branch: evaluate(ci_system['git']['branch'], env),
-              tag: evaluate(ci_system['git']['tag'], env),
-          )
+      Cucumber::Messages::Ci.new(
+        url: url,
+        name: ci_name,
+        build_number: evaluate(ci_system['buildNumber'], env),
+        git: Cucumber::Messages::Git.new(
+          remote: remove_userinfo_from_url(evaluate(ci_system['git']['remote'], env)),
+          revision: evaluate(ci_system['git']['revision'], env),
+          branch: evaluate(ci_system['git']['branch'], env),
+          tag: evaluate(ci_system['git']['tag'], env),
+        )
       )
     end
 
-    def evaluate(template, env)
-      return nil if template.nil?
-      begin
-        template.gsub(/\${((refbranch|reftag)\s+)?([^\s}]+)(\s+\|\s+([^}]+))?}/) do
-          func = $2
-          variable = $3
-          default_value = $5 == "" ? nil : $5
-          value = env[variable] || default_value
-
-          if func == 'refbranch'
-            value = group1(value, /^refs\/heads\/(.*)/)
-          elsif func == 'reftag'
-            value = group1(value, /^refs\/tags\/(.*)/)
-          end
-          raise "Undefined variable: #{variable}" if value.nil?
-          value
-        end
-      rescue
-        nil
-      end
-    end
-
-    def group1(value, regexp)
-      m = value.match(regexp)
-      raise "No match" if m.nil?
-      m[1]
-    end
-
     def remove_userinfo_from_url(value)
       return nil if value.nil?
       begin
@@ -92,6 +67,6 @@ module Cucumber
       end
     end
 
-    module_function :create_meta, :detect_ci, :create_ci, :group1, :evaluate, :remove_userinfo_from_url
+    module_function :create_meta, :detect_ci, :create_ci, :remove_userinfo_from_url
   end
 end

data/spec/cucumber/create_meta_spec.rb

@@ -1,8 +1,8 @@
 require 'cucumber/create_meta'
 
-describe 'createMeta' do
+describe 'create_meta' do
   it 'generates a Meta message with platform information' do
-    meta = Cucumber::CreateMeta.create_meta('cucumba-ruby', 'X.Y.Z')
+    meta = Cucumber::CreateMeta.create_meta('cucumba-ruby', 'X.Y.Z', [])
 
     expect(meta.protocol_version).to match(/\d+\.\d+\.\d+/)
     expect(meta.implementation.name).to eq('cucumba-ruby')
@@ -12,5 +12,25 @@ describe 'createMeta' do
     expect(meta.os.name).to match(/.+/)
     expect(meta.os.version).to match(/.+/)
     expect(meta.cpu.name).to match(/.+/)
+    expect(meta.ci).to be_nil
+  end
+
+  it 'generates a Meta message with CI information' do
+    env = {
+      'BUILD_URL' => 'url of the build',
+      'BUILD_NUMBER' => '42',
+      'GIT_URL' => 'url of git',
+      'GIT_COMMIT' => 'git_sha1',
+      'GIT_LOCAL_BRANCH' => 'main'
+    }
+
+    meta = Cucumber::CreateMeta.create_meta('cucumba-ruby', 'X.Y.Z', env)
+
+    expect(meta.ci).not_to be_nil
+    expect(meta.ci.url).to eq env['BUILD_URL']
+    expect(meta.ci.build_number).to eq env['BUILD_NUMBER']
+    expect(meta.ci.git.remote).to eq env['GIT_URL']
+    expect(meta.ci.git.revision).to eq env['GIT_COMMIT']
+    expect(meta.ci.git.branch).to eq env['GIT_LOCAL_BRANCH']
   end
 end

data/spec/cucumber/evaluate_variable_expression_spec.rb

@@ -0,0 +1,38 @@
+require 'cucumber/create_meta'
+
+describe 'Cucumber::CreateMeta::VariableExpression.evaluate' do
+  include Cucumber::CreateMeta::VariableExpression
+
+  it 'returns nil when a variable is undefined' do
+    expression = "hello-${SOME_VAR}";
+    result = evaluate(expression, {});
+    expect(result).to eq(nil)
+  end
+
+  it 'gets a value without replacement' do
+    expression = "${SOME_VAR}";
+    result = evaluate(expression, {'SOME_VAR' => 'some_value'});
+    expect(result).to eq('some_value')
+  end
+
+  it 'captures a group' do
+    expression = "${SOME_REF/refs\/heads\/(.*)/\\1}";
+    result = evaluate(expression, {'SOME_REF' => 'refs/heads/main'});
+    expect(result).to eq('main')
+  end
+
+  it 'works with star wildcard in var' do
+    expression = "${GO_SCM_*_PR_BRANCH/.*:(.*)/\\1}";
+    result = evaluate(expression, {'GO_SCM_MY_MATERIAL_PR_BRANCH' => 'ashwankthkumar:feature-1'});
+    expect(result).to eq('feature-1')
+  end
+
+  it 'evaluates a complex expression' do
+    expression = "hello-${VAR1}-${VAR2/(.*) (.*)/\\2-\\1}-world";
+    result = evaluate(expression, {
+      'VAR1' => 'amazing',
+      'VAR2' => 'gorgeous beautiful'
+    })
+    expect(result).to eq('hello-amazing-beautiful-gorgeous-world')
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cucumber-create-meta
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 6.0.2
 platform: ruby
 authors:
 - Vincent Prêtre
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-29 00:00:00.000000000 Z
+date: 2021-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cucumber-messages
@@ -16,20 +16,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '15.0'
+        version: '17.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 15.0.0
+        version: 17.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '15.0'
+        version: '17.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 15.0.0
+        version: 17.1.1
 - !ruby/object:Gem::Dependency
   name: sys-uname
   requirement: !ruby/object:Gem::Requirement
@@ -59,7 +59,7 @@ dependencies:
         version: '13.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 13.0.3
+        version: 13.0.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -69,7 +69,7 @@ dependencies:
         version: '13.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 13.0.3
+        version: 13.0.6
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -99,18 +99,20 @@ files:
 - LICENSE
 - lib/cucumber/ciDict.json
 - lib/cucumber/create_meta.rb
+- lib/cucumber/create_meta/variable_expression.rb
 - spec/capture_warnings.rb
 - spec/cucumber/create_meta_spec.rb
+- spec/cucumber/evaluate_variable_expression_spec.rb
 - spec/cucumber/remove_userinfo_from_url_spec.rb
 homepage: https://github.com/cucumber/create-meta-ruby
 licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/cucumber/cucumber/issues
-  changelog_uri: https://github.com/cucumber/cucumber/blob/master/gherkin/CHANGELOG.md
+  changelog_uri: https://github.com/cucumber/common/blob/main/gherkin/CHANGELOG.md
   documentation_uri: https://cucumber.io/docs/gherkin/
   mailing_list_uri: https://groups.google.com/forum/#!forum/cukes
-  source_code_uri: https://github.com/cucumber/cucumber/blob/master/gherkin/ruby
+  source_code_uri: https://github.com/cucumber/common/blob/main/gherkin/ruby
 post_install_message: 
 rdoc_options:
 - "--charset=UTF-8"
@@ -130,8 +132,9 @@ requirements: []
 rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
-summary: cucumber-create-meta-4.0.0
+summary: cucumber-create-meta-6.0.2
 test_files:
 - spec/capture_warnings.rb
-- spec/cucumber/create_meta_spec.rb
 - spec/cucumber/remove_userinfo_from_url_spec.rb
+- spec/cucumber/evaluate_variable_expression_spec.rb
+- spec/cucumber/create_meta_spec.rb