Module: EmergeCLI::Git

Defined in:
lib/utils/git.rb

Class Method Summary collapse

Class Method Details

.base_sha ⇒ Object 



50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/utils/git.rb', line 50

def self.base_sha
  Logger.debug 'Getting base SHA'
  current_branch = branch
  remote_head = remote_head_branch
  return nil if current_branch.nil? || remote_head.nil?

  command = "git merge-base #{remote_head} #{current_branch}"
  Logger.debug command
  stdout, _, status = Open3.capture3(command)
  return nil if stdout.strip.empty? || !status.success?
  current_sha = sha
  stdout.strip == current_sha ? nil : stdout.strip
end

.branch ⇒ Object 



5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'lib/utils/git.rb', line 5

def self.branch
  Logger.debug 'Getting current branch name'
  command = 'git rev-parse --abbrev-ref HEAD'
  Logger.debug command
  stdout, _, status = Open3.capture3(command)
  unless status.success?
    Logger.error 'Failed to get the current branch name'
    return nil
  end

  branch_name = stdout.strip
  if branch_name == 'HEAD'
    # We're in a detached HEAD state
    # Find all branches that contains the current HEAD commit
    #
    # Example output:
    # * (HEAD detached at dec13a5)
    # telkins/detached-test
    # remotes/origin/telkins/detached-test
    #
    # So far I've seen this output be fairly stable
    # If the input is invalid for whatever reason, sed/awk will return an empty string
    command = "git branch -a --contains HEAD | sed -n 2p | awk '{ printf $1 }'"
    Logger.debug command
    head_stdout, _, head_status = Open3.capture3(command)

    unless head_status.success?
      Logger.error 'Failed to get the current branch name for detached HEAD'
      return nil
    end

    branch_name = head_stdout.strip
  end

  branch_name == 'HEAD' ? nil : branch_name
end

.previous_sha ⇒ Object 



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/utils/git.rb', line 64

def self.previous_sha
  Logger.debug 'Getting previous SHA'
  command = 'git rev-list --count HEAD'
  Logger.debug command
  count_stdout, _, count_status = Open3.capture3(command)

  if !count_status.success? || count_stdout.strip.to_i <= 1
    Logger.error 'Detected shallow clone while trying to get the previous commit. ' \
                 'Please clone with full history using: git clone --no-single-branch ' \
                 'or configure CI with fetch-depth: 0'
    return nil
  end

  command = 'git rev-parse HEAD^'
  Logger.debug command
  stdout, stderr, status = Open3.capture3(command)
  Logger.error "Failed to get previous SHA: #{stdout}, #{stderr}" if !status.success?
  stdout.strip if status.success?
end

.primary_remote ⇒ Object 



84
85
86
87
88
89
 
# File 'lib/utils/git.rb', line 84

def self.primary_remote
  Logger.debug 'Getting primary remote'
  remote = remote()
  return nil if remote.nil?
  remote.include?('origin') ? 'origin' : remote.first
end

.remote ⇒ Object 



115
116
117
118
119
120
121
 
# File 'lib/utils/git.rb', line 115

def self.remote
  Logger.debug 'Getting remote'
  command = 'git remote'
  Logger.debug command
  stdout, _, status = Open3.capture3(command)
  stdout.split("\n") if status.success?
end

.remote_head_branch(remote = primary_remote) ⇒ Object 



91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/utils/git.rb', line 91

def self.remote_head_branch(remote = primary_remote)
  Logger.debug 'Getting remote head branch'
  return nil if remote.nil?
  command = "git remote show #{remote}"
  Logger.debug command
  stdout, _, status = Open3.capture3(command)
  return nil if stdout.nil? || !status.success?
  stdout
    .split("\n")
    .map(&:strip)
    .find { |line| line.start_with?('HEAD branch: ') }
    &.split
    &.last
end

.remote_url(remote = primary_remote) ⇒ Object 



106
107
108
109
110
111
112
113
 
# File 'lib/utils/git.rb', line 106

def self.remote_url(remote = primary_remote)
  Logger.debug 'Getting remote URL'
  return nil if remote.nil?
  command = "git config --get remote.#{remote}.url"
  Logger.debug command
  stdout, _, status = Open3.capture3(command)
  stdout if status.success?
end

.sha ⇒ Object 



42
43
44
45
46
47
48
 
# File 'lib/utils/git.rb', line 42

def self.sha
  Logger.debug 'Getting current SHA'
  command = 'git rev-parse HEAD'
  Logger.debug command
  stdout, _, status = Open3.capture3(command)
  stdout.strip if status.success?
end