Module: PactBroker::Client::Git
- Defined in:
- lib/pact_broker/client/git.rb
Constant Summary collapse
- COMMAND =
'git rev-parse --abbrev-ref HEAD'.freeze
- BRANCH_ENV_VAR_NAMES =
%w{GITHUB_HEAD_REF GITHUB_REF BUILDKITE_BRANCH CIRCLE_BRANCH TRAVIS_BRANCH GIT_BRANCH GIT_LOCAL_BRANCH APPVEYOR_REPO_BRANCH CI_COMMIT_REF_NAME BITBUCKET_BRANCH BUILD_SOURCEBRANCHNAME}.freeze
- COMMIT_ENV_VAR_NAMES =
%w{GITHUB_SHA BUILDKITE_COMMIT CIRCLE_SHA1 TRAVIS_COMMIT GIT_COMMIT APPVEYOR_REPO_COMMIT CI_COMMIT_ID BITBUCKET_COMMIT BUILD_SOURCEVERSION}
- BUILD_URL_ENV_VAR_NAMES =
%w{BUILDKITE_BUILD_URL CIRCLE_BUILD_URL TRAVIS_BUILD_WEB_URL BUILD_URL }
Class Method Summary collapse
- .branch(options) ⇒ Object
- .branch_from_git_command(raise_error) ⇒ Object
- .build_url ⇒ Object
- .commit ⇒ Object
- .execute_and_parse_command(raise_error) ⇒ Object
- .execute_git_command ⇒ Object
- .find_branch_from_env_var_ending_with_branch ⇒ Object
- .find_branch_from_known_env_vars ⇒ Object
-
.find_commit_from_env_vars ⇒ Object
private.
- .github_build_url ⇒ Object
- .validate_branch_names(branch_names) ⇒ Object
- .value_from_env_var(env_var_name) ⇒ Object
Class Method Details
.branch(options) ⇒ Object
36 37 38 |
# File 'lib/pact_broker/client/git.rb', line 36 def self.branch() find_branch_from_known_env_vars || find_branch_from_env_var_ending_with_branch || branch_from_git_command([:raise_error]) end |
.branch_from_git_command(raise_error) ⇒ Object
75 76 77 78 79 |
# File 'lib/pact_broker/client/git.rb', line 75 def self.branch_from_git_command(raise_error) branch_names = execute_and_parse_command(raise_error) validate_branch_names(branch_names) if raise_error branch_names.size == 1 ? branch_names[0] : nil end |
.build_url ⇒ Object
40 41 42 |
# File 'lib/pact_broker/client/git.rb', line 40 def self.build_url github_build_url || BUILD_URL_ENV_VAR_NAMES.collect{ | name | value_from_env_var(name) }.compact.first end |
.commit ⇒ Object
32 33 34 |
# File 'lib/pact_broker/client/git.rb', line 32 def self.commit find_commit_from_env_vars end |
.execute_and_parse_command(raise_error) ⇒ Object
95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 |
# File 'lib/pact_broker/client/git.rb', line 95 def self.execute_and_parse_command(raise_error) execute_git_command .split("\n") .collect(&:strip) .reject(&:empty?) .collect(&:split) .collect(&:first) .collect{ |line| line.gsub(/^origin\//, '') } .reject{ |line| line == "HEAD" } rescue StandardError => e if raise_error raise PactBroker::Client::Error, "Could not determine current git branch using command `#{COMMAND}`. #{e.class} #{e.}" else return [] end end |
.execute_git_command ⇒ Object
91 92 93 |
# File 'lib/pact_broker/client/git.rb', line 91 def self.execute_git_command `#{COMMAND}` end |
.find_branch_from_env_var_ending_with_branch ⇒ Object
55 56 57 58 59 60 61 62 63 64 |
# File 'lib/pact_broker/client/git.rb', line 55 def self.find_branch_from_env_var_ending_with_branch values = ENV.keys .select{ |env_var_name| env_var_name.end_with?("_BRANCH") } .collect{ |env_var_name| value_from_env_var(env_var_name) }.compact if values.size == 1 values.first else nil end end |
.find_branch_from_known_env_vars ⇒ Object
50 51 52 53 |
# File 'lib/pact_broker/client/git.rb', line 50 def self.find_branch_from_known_env_vars val = BRANCH_ENV_VAR_NAMES.collect { |env_var_name| value_from_env_var(env_var_name) }.compact.first val.gsub(%r{^refs/heads/}, "") if val end |
.find_commit_from_env_vars ⇒ Object
private
46 47 48 |
# File 'lib/pact_broker/client/git.rb', line 46 def self.find_commit_from_env_vars COMMIT_ENV_VAR_NAMES.collect { |env_var_name| value_from_env_var(env_var_name) }.compact.first end |
.github_build_url ⇒ Object
112 113 114 115 116 117 |
# File 'lib/pact_broker/client/git.rb', line 112 def self.github_build_url parts = %w{GITHUB_SERVER_URL GITHUB_REPOSITORY GITHUB_RUN_ID}.collect{ | name | value_from_env_var(name) } if parts.all? [parts[0], parts[1], "actions", "runs", parts[2]].join("/") end end |
.validate_branch_names(branch_names) ⇒ Object
81 82 83 84 85 86 87 88 89 |
# File 'lib/pact_broker/client/git.rb', line 81 def self.validate_branch_names(branch_names) if branch_names.size == 0 raise PactBroker::Client::Error, "Command `#{COMMAND}` didn't return anything that could be identified as the current branch." end if branch_names.size > 1 raise PactBroker::Client::Error, "Command `#{COMMAND}` returned multiple branches: #{branch_names.join(", ")}. You will need to get the branch name another way." end end |
.value_from_env_var(env_var_name) ⇒ Object
66 67 68 69 70 71 72 73 |
# File 'lib/pact_broker/client/git.rb', line 66 def self.value_from_env_var(env_var_name) val = ENV[env_var_name] if val && val.strip.size > 0 val else nil end end |