Class: Dependabot::GitCommitChecker

Inherits:
Object
  • Object
show all
Defined in:
lib/dependabot/git_commit_checker.rb

Constant Summary collapse

VERSION_REGEX = 
/
  (?<version>
    (?<=^v)[0-9]+(?:\-[a-z0-9]+)?
    |
    [0-9]+\.[0-9]+(?:\.[a-z0-9\-]+)*
  )$
/ix

Instance Method Summary collapse

Constructor Details

#initialize(dependency:, credentials:, ignored_versions: [], raise_on_ignored: false, consider_version_branches_pinned: false) ⇒ GitCommitChecker

Returns a new instance of GitCommitChecker.



25
26
27
28
29
30
31
32
33
 
# File 'lib/dependabot/git_commit_checker.rb', line 25

def initialize(dependency:, credentials:,
               ignored_versions: [], raise_on_ignored: false,
               consider_version_branches_pinned: false)
  @dependency = dependency
  @credentials = credentials
  @ignored_versions = ignored_versions
  @raise_on_ignored = raise_on_ignored
  @consider_version_branches_pinned = consider_version_branches_pinned
end

Instance Method Details

#allowed_version_refs ⇒ Object 



122
123
124
 
# File 'lib/dependabot/git_commit_checker.rb', line 122

def allowed_version_refs
  allowed_versions(local_refs)
end

#allowed_version_tags ⇒ Object 



118
119
120
 
# File 'lib/dependabot/git_commit_checker.rb', line 118

def allowed_version_tags
  allowed_versions(local_tags)
end

#branch_or_ref_in_release?(version) ⇒ Boolean

Returns:

  • (Boolean) 


83
84
85
 
# File 'lib/dependabot/git_commit_checker.rb', line 83

def branch_or_ref_in_release?(version)
  pinned_ref_in_release?(version) || branch_behind_release?(version)
end

#current_version ⇒ Object 



126
127
128
129
130
 
# File 'lib/dependabot/git_commit_checker.rb', line 126

def current_version
  return unless dependency.version && version_tag?(dependency.version)

  version_from_ref(dependency.version)
end

#dependency_source_details ⇒ Object 



162
163
164
 
# File 'lib/dependabot/git_commit_checker.rb', line 162

def dependency_source_details
  dependency.source_details(allowed_types: ["git"])
end

#filter_lower_versions(tags) ⇒ Object 



132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/dependabot/git_commit_checker.rb', line 132

def filter_lower_versions(tags)
  return tags unless current_version

  versions = tags.map do |t|
    version_from_tag(t)
  end

  versions.select do |version|
    version > current_version
  end
end

#git_dependency? ⇒ Boolean

Returns:

  • (Boolean) 


35
36
37
38
39
 
# File 'lib/dependabot/git_commit_checker.rb', line 35

def git_dependency?
  return false if dependency_source_details.nil?

  dependency_source_details.fetch(:type) == "git"
end

#git_repo_reachable? ⇒ Boolean

Returns:

  • (Boolean) 


155
156
157
158
159
160
 
# File 'lib/dependabot/git_commit_checker.rb', line 155

def git_repo_reachable?
  local_upload_pack
  true
rescue Dependabot::GitDependenciesNotReachable
  false
end

#head_commit_for_current_branch ⇒ Object

Raises:



87
88
89
90
91
92
93
94
 
# File 'lib/dependabot/git_commit_checker.rb', line 87

def head_commit_for_current_branch
  ref = ref_or_branch || "HEAD"

  sha = head_commit_for_local_branch(ref)
  return sha if pinned? || sha

  raise Dependabot::GitDependencyReferenceNotFound, dependency.name
end

#head_commit_for_local_branch(name) ⇒ Object 



96
97
98
 
# File 'lib/dependabot/git_commit_checker.rb', line 96

def head_commit_for_local_branch(name)
  local_repo_git_metadata_fetcher.head_commit_for_ref(name)
end

#head_commit_for_pinned_ref ⇒ Object 



71
72
73
 
# File 'lib/dependabot/git_commit_checker.rb', line 71

def head_commit_for_pinned_ref
  local_repo_git_metadata_fetcher.head_commit_for_ref_sha(ref)
end

#local_ref_for_latest_version_matching_existing_precision ⇒ Object 



100
101
102
103
104
 
# File 'lib/dependabot/git_commit_checker.rb', line 100

def local_ref_for_latest_version_matching_existing_precision
  allowed_refs = local_tag_for_pinned_sha ? allowed_version_tags : allowed_version_refs

  max_local_tag_for_current_precision(allowed_refs)
end

#local_tag_for_latest_version ⇒ Object 



106
107
108
 
# File 'lib/dependabot/git_commit_checker.rb', line 106

def local_tag_for_latest_version
  max_local_tag(allowed_version_tags)
end

#local_tag_for_pinned_sha ⇒ Object 



149
150
151
152
153
 
# File 'lib/dependabot/git_commit_checker.rb', line 149

def local_tag_for_pinned_sha
  return @local_tag_for_pinned_sha if defined?(@local_tag_for_pinned_sha)

  @local_tag_for_pinned_sha = most_specific_version_tag_for_sha(ref) if pinned_ref_looks_like_commit_sha?
end

#local_tags_for_allowed_versions ⇒ Object 



114
115
116
 
# File 'lib/dependabot/git_commit_checker.rb', line 114

def local_tags_for_allowed_versions
  allowed_version_tags.map { |t| to_local_tag(t) }
end

#local_tags_for_allowed_versions_matching_existing_precision ⇒ Object 



110
111
112
 
# File 'lib/dependabot/git_commit_checker.rb', line 110

def local_tags_for_allowed_versions_matching_existing_precision
  select_matching_existing_precision(allowed_version_tags).map { |t| to_local_tag(t) }
end

#most_specific_tag_equivalent_to_pinned_ref ⇒ Object 



144
145
146
147
 
# File 'lib/dependabot/git_commit_checker.rb', line 144

def most_specific_tag_equivalent_to_pinned_ref
  commit_sha = head_commit_for_local_branch(ref)
  most_specific_version_tag_for_sha(commit_sha)
end

#pinned? ⇒ Boolean

Returns:

  • (Boolean) 


41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/dependabot/git_commit_checker.rb', line 41

def pinned?
  raise "Not a git dependency!" unless git_dependency?

  branch = dependency_source_details.fetch(:branch)

  return false if ref.nil?
  return false if branch == ref
  return true if branch
  return true if dependency.version&.start_with?(ref)

  # If the specified `ref` is actually a tag, we're pinned
  return true if local_upload_pack.match?(%r{ refs/tags/#{ref}$})

  # Assume we're pinned unless the specified `ref` is actually a branch
  return true unless local_upload_pack.match?(%r{ refs/heads/#{ref}$})

  # TODO: Research whether considering branches that look like versions pinned makes sense for all ecosystems
  @consider_version_branches_pinned && version_tag?(ref)
end

#pinned_ref_looks_like_commit_sha? ⇒ Boolean

Returns:

  • (Boolean) 


67
68
69
 
# File 'lib/dependabot/git_commit_checker.rb', line 67

def pinned_ref_looks_like_commit_sha?
  ref_looks_like_commit_sha?(ref)
end

#pinned_ref_looks_like_version? ⇒ Boolean

Returns:

  • (Boolean) 


61
62
63
64
65
 
# File 'lib/dependabot/git_commit_checker.rb', line 61

def pinned_ref_looks_like_version?
  return false unless pinned?

  version_tag?(ref)
end

#ref_looks_like_commit_sha?(ref) ⇒ Boolean

Returns:

  • (Boolean) 


75
76
77
78
79
80
81
 
# File 'lib/dependabot/git_commit_checker.rb', line 75

def ref_looks_like_commit_sha?(ref)
  return false unless ref&.match?(/^[0-9a-f]{6,40}$/)

  return false unless pinned?

  local_repo_git_metadata_fetcher.head_commit_for_ref(ref).nil?
end