cucumber-ci-environment 7.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '08f1292f1769293e6a36074f11d1561867548ea7ab0b022a79a2fb8b498fb216'
+  data.tar.gz: 62e9581ab78df2ce86fa985e8707f2ab917b6bbe749ea5f37d30c39584dae175
+SHA512:
+  metadata.gz: 4431d3d58c2765b18dedd19a923da52a8ddc14cc357c88b6d0aae02bda31fbd78bdf868144cd04fd12f0ccc47766ca3a75e8957aed45d8ef352ba27a1beae613
+  data.tar.gz: '09d0faa39b92ebe95301e16c30b3bce2a03ed11cc94458b789a4be2e087d060bfa963428f2990472cfda27fc6ac9c6dbc5585c7906e5638537236e93f0346b60'

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) Cucumber Ltd
+
+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/lib/cucumber/ci_environment/CiEnvironments.json

@@ -0,0 +1,156 @@
+[
+  {
+    "name": "Azure Pipelines",
+    "url": "${BUILD_BUILDURI}",
+    "buildNumber": "${BUILD_BUILDNUMBER}",
+    "git": {
+      "remote": "${BUILD_REPOSITORY_URI}",
+      "revision": "${BUILD_SOURCEVERSION}",
+      "branch": "${BUILD_SOURCEBRANCH/refs\/heads\/(.*)/\\1}",
+      "tag": "${BUILD_SOURCEBRANCH/refs\/tags\/(.*)/\\1}"
+    }
+  },
+  {
+    "name": "Bamboo",
+    "url": "${bamboo_buildResultsUrl}",
+    "buildNumber": "${bamboo_buildNumber}",
+    "git": {
+      "remote": "${bamboo_planRepository_repositoryUrl}",
+      "revision": "${bamboo_planRepository_revision}",
+      "branch": "${bamboo_planRepository_branch}",
+      "tag": null
+    }
+  },
+  {
+    "name": "Buddy",
+    "url": "${BUDDY_EXECUTION_URL}",
+    "buildNumber": "${BUDDY_EXECUTION_ID}",
+    "git": {
+      "remote": "${BUDDY_SCM_URL}",
+      "revision": "${BUDDY_EXECUTION_REVISION}",
+      "branch": "${BUDDY_EXECUTION_BRANCH}",
+      "tag": "${BUDDY_EXECUTION_TAG}"
+    }
+  },
+  {
+    "name": "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}"
+    }
+  },
+  {
+    "name": "CircleCI",
+    "url": "${CIRCLE_BUILD_URL}",
+    "buildNumber": "${CIRCLE_BUILD_NUM}",
+    "git": {
+      "remote": "${CIRCLE_REPOSITORY_URL}",
+      "revision": "${CIRCLE_SHA1}",
+      "branch": "${CIRCLE_BRANCH}",
+      "tag": "${CIRCLE_TAG}"
+    }
+  },
+  {
+    "name": "CodeFresh",
+    "url": "${CF_BUILD_URL}",
+    "buildNumber": "${CF_BUILD_ID}",
+    "git": {
+      "remote": "${CF_COMMIT_URL/(.*)\\/commit.+$/\\1}.git",
+      "revision": "${CF_REVISION}",
+      "branch": "${CF_BRANCH}",
+      "tag": null
+    }
+  },
+  {
+    "name": "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
+    }
+  },
+  {
+    "name": "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": "${GITHUB_REF/refs\/heads\/(.*)/\\1}",
+      "tag": "${GITHUB_REF/refs\/tags\/(.*)/\\1}"
+    }
+  },
+  {
+    "name": "GitLab",
+    "url": "${CI_JOB_URL}",
+    "buildNumber": "${CI_JOB_ID}",
+    "git": {
+      "remote": "${CI_REPOSITORY_URL}",
+      "revision": "${CI_COMMIT_SHA}",
+      "branch": "${CI_COMMIT_BRANCH}",
+      "tag": "${CI_COMMIT_TAG}"
+    }
+  },
+  {
+    "name": "GoCD",
+    "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": "${GO_SCM_*_PR_URL/(.*)\\/pull\\/\\d+/\\1.git}",
+      "revision": "${GO_REVISION}",
+      "branch": "${GO_SCM_*_PR_BRANCH/.*:(.*)/\\1}",
+      "tag": null
+    }
+  },
+  {
+    "name": "Jenkins",
+    "url": "${BUILD_URL}",
+    "buildNumber": "${BUILD_NUMBER}",
+    "git": {
+      "remote": "${GIT_URL}",
+      "revision": "${GIT_COMMIT}",
+      "branch": "${GIT_LOCAL_BRANCH}",
+      "tag": null
+    }
+  },
+  {
+    "name": "Semaphore",
+    "url": "${SEMAPHORE_ORGANIZATION_URL}/jobs/${SEMAPHORE_JOB_ID}",
+    "buildNumber": "${SEMAPHORE_JOB_ID}",
+    "git": {
+      "remote": "${SEMAPHORE_GIT_URL}",
+      "revision": "${SEMAPHORE_GIT_SHA}",
+      "branch": "${SEMAPHORE_GIT_BRANCH}",
+      "tag": "${SEMAPHORE_GIT_TAG_NAME}"
+    }
+  },
+  {
+    "name": "Travis CI",
+    "url": "${TRAVIS_BUILD_WEB_URL}",
+    "buildNumber": "${TRAVIS_JOB_NUMBER}",
+    "git": {
+      "remote": "https://github.com/${TRAVIS_REPO_SLUG}.git",
+      "revision": "${TRAVIS_COMMIT}",
+      "branch": "${TRAVIS_BRANCH}",
+      "tag": "${TRAVIS_TAG}"
+    }
+  },
+  {
+    "name": "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}",
+      "branch": "${WERCKER_GIT_BRANCH}",
+      "tag": null
+    }
+  }
+]

data/lib/cucumber/ci_environment/variable_expression.rb

@@ -0,0 +1,41 @@
+module Cucumber
+  module CiEnvironment
+    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/ci_environment.rb

@@ -0,0 +1,53 @@
+require 'uri'
+require 'json'
+require 'cucumber/ci_environment/variable_expression'
+
+module Cucumber
+  module CiEnvironment
+    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))
+      ci_environments.each do |ci_environment|
+        detected = detect(ci_environment, env)
+        return detected unless detected.nil?
+      end
+    end
+
+    def detect(ci_environment, env)
+      url = evaluate(ci_environment['url'], env)
+      return nil if url.nil?
+
+      result = {
+        name: ci_environment['name'],
+        url: url,
+        buildNumber: evaluate(ci_environment['buildNumber'], env),
+        git: {
+          remote: remove_userinfo_from_url(evaluate(ci_environment['git']['remote'], env)),
+          revision: evaluate(ci_environment['git']['revision'], env),
+          branch: evaluate(ci_environment['git']['branch'], env),
+        }
+      }
+      tag = evaluate(ci_environment['git']['tag'], env)
+      if tag
+        result[:git][:tag] = tag
+      end
+      result
+    end
+
+    def remove_userinfo_from_url(value)
+      return nil if value.nil?
+
+      begin
+        uri = URI(value)
+        uri.userinfo = ''
+        uri.to_s
+      rescue StandardError
+        value
+      end
+    end
+
+    module_function :detect_ci_environment, :detect, :remove_userinfo_from_url
+  end
+end

data/spec/capture_warnings.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+# With thanks to @myronmarston
+# https://github.com/vcr/vcr/blob/master/spec/capture_warnings.rb
+
+module CaptureWarnings
+  def report_warnings(&block)
+    current_dir = Dir.pwd
+    warnings, errors = capture_error(&block).partition { |line| line.include?('warning') }
+    project_warnings, other_warnings = warnings.uniq.partition { |line| line.include?(current_dir) }
+
+    if errors.any?
+      puts errors.join("\n")
+    end
+
+    if other_warnings.any?
+      puts "#{ other_warnings.count } warnings detected, set VIEW_OTHER_WARNINGS=true to see them."
+      print_warnings('other', other_warnings) if ENV['VIEW_OTHER_WARNINGS']
+    end
+
+    # Until they fix https://bugs.ruby-lang.org/issues/10661
+    if RUBY_VERSION == "2.2.0"
+      project_warnings = project_warnings.reject { |w| w =~ /warning: possible reference to past scope/ }
+    end
+
+    if project_warnings.any?
+      puts "#{ project_warnings.count } warnings detected"
+      print_warnings('cucumber-expressions', project_warnings)
+      fail "Please remove all cucumber-expressions warnings."
+    end
+
+    ensure_system_exit_if_required
+  end
+
+  def capture_error(&block)
+    old_stderr = STDERR.clone
+    pipe_r, pipe_w = IO.pipe
+    pipe_r.sync    = true
+    error          = String.new
+    reader = Thread.new do
+      begin
+        loop do
+          error << pipe_r.readpartial(1024)
+        end
+      rescue EOFError
+      end
+    end
+    STDERR.reopen(pipe_w)
+    block.call
+  ensure
+    capture_system_exit
+    STDERR.reopen(old_stderr)
+    pipe_w.close
+    reader.join
+    return error.split("\n")
+  end
+
+  def print_warnings(type, warnings)
+    puts
+    puts "-" * 30 + " #{type} warnings: " + "-" * 30
+    puts
+    puts warnings.join("\n")
+    puts
+    puts "-" * 75
+    puts
+  end
+
+  def ensure_system_exit_if_required
+    raise @system_exit if @system_exit
+  end
+
+  def capture_system_exit
+    @system_exit = $!
+  end
+end

data/spec/cucumber/ci_environment/ci_environment_spec.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'cucumber/ci_environment'
+require 'json'
+
+describe 'detect_ci_environment' do
+  Dir.glob("../testdata/*.txt") do |test_data_file|
+    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) }
+      let(:env) { Hash[entries] }
+      let(:entries) { env_data.split(/\n/).map { |line| line.split(/=/) } }
+      let(:env_data) { IO.read(test_data_file) }
+
+      let(:expected_json) { File.read("#{test_data_file}.json") }
+
+      it { is_expected.to eq JSON.parse(expected_json) }
+    end
+  end
+end

data/spec/cucumber/ci_environment/evaluate_variable_expression_spec.rb

@@ -0,0 +1,38 @@
+require 'cucumber/ci_environment'
+
+describe 'Cucumber::CiEnvironment::VariableExpression.evaluate' do
+  include Cucumber::CiEnvironment::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

data/spec/cucumber/ci_environment/remove_userinfo_from_url_spec.rb

@@ -0,0 +1,29 @@
+require 'cucumber/ci_environment'
+
+describe 'remove_user_info_from_url' do
+  it 'returns nil for nil' do
+    expect(Cucumber::CiEnvironment.remove_userinfo_from_url(nil)).to be_nil
+  end
+
+  it 'returns empty string for empty string' do
+    expect(Cucumber::CiEnvironment.remove_userinfo_from_url('')).to eq('')
+  end
+
+  it 'leaves the data intact when no sensitive information is detected' do
+    expect(Cucumber::CiEnvironment.remove_userinfo_from_url('pretty safe')).to eq('pretty safe')
+  end
+
+  context 'with URLs' do
+    it 'leaves intact when no password is found' do
+      expect(Cucumber::CiEnvironment.remove_userinfo_from_url('https://example.com/git/repo.git')).to eq('https://example.com/git/repo.git')
+    end
+
+    it 'removes credentials when found' do
+      expect(Cucumber::CiEnvironment.remove_userinfo_from_url('http://login@example.com/git/repo.git')).to eq('http://example.com/git/repo.git')
+    end
+
+    it 'removes credentials and passwords when found' do
+      expect(Cucumber::CiEnvironment.remove_userinfo_from_url('ssh://login:password@example.com/git/repo.git')).to eq('ssh://example.com/git/repo.git')
+    end
+  end
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: cucumber-ci-environment
+version: !ruby/object:Gem::Version
+  version: 7.0.1
+platform: ruby
+authors:
+- Vincent Prêtre
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-12-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.0.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.0.6
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.10.0
+description: Detect CI Environment from environment variables
+email: cukes@googlegroups.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- lib/cucumber/ci_environment.rb
+- lib/cucumber/ci_environment/CiEnvironments.json
+- lib/cucumber/ci_environment/variable_expression.rb
+- 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/remove_userinfo_from_url_spec.rb
+homepage: https://github.com/cucumber/ci-environment
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/cucumber/ci-environment/issues
+  changelog_uri: https://github.com/cucumber/ci-environment/blob/main/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/ci-environment/tree/main/ruby
+post_install_message: 
+rdoc_options:
+- "--charset=UTF-8"
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.32
+signing_key: 
+specification_version: 4
+summary: cucumber-ci-environment-7.0.1
+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/remove_userinfo_from_url_spec.rb