Class: Dependabot::GitCommitChecker

Inherits:
Object
  • Object
show all
Extended by:
T::Sig
Defined in:
lib/dependabot/git_commit_checker.rb

Overview

rubocop:disable Metrics/ClassLength

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, dependency_source_details: nil) ⇒ GitCommitChecker

Returns a new instance of GitCommitChecker.



41
42
43
44
45
46
47
48
49
50
 
# File 'lib/dependabot/git_commit_checker.rb', line 41

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

Instance Method Details

#allowed_version_refs ⇒ Object 



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

def allowed_version_refs
  allowed_versions(local_refs)
end

#allowed_version_tags ⇒ Object 



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

def allowed_version_tags
  allowed_versions(local_tags)
end

#branch_or_ref_in_release?(version) ⇒ Boolean

Returns:

  • (Boolean) 


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

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

#current_version ⇒ Object 



168
169
170
171
172
 
# File 'lib/dependabot/git_commit_checker.rb', line 168

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

  version_from_ref(T.must(dependency.version))
end

#dependency_source_details ⇒ Object 



219
220
221
 
# File 'lib/dependabot/git_commit_checker.rb', line 219

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

#filter_lower_versions(tags) ⇒ Object 



175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/dependabot/git_commit_checker.rb', line 175

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) 


53
54
55
56
57
 
# File 'lib/dependabot/git_commit_checker.rb', line 53

def git_dependency?
  return false if dependency_source_details.nil?

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

#git_repo_reachable? ⇒ Boolean

Returns:

  • (Boolean) 


211
212
213
214
215
216
 
# File 'lib/dependabot/git_commit_checker.rb', line 211

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

#head_commit_for_current_branch ⇒ Object

Raises:



114
115
116
117
118
119
120
121
 
# File 'lib/dependabot/git_commit_checker.rb', line 114

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 



124
125
126
 
# File 'lib/dependabot/git_commit_checker.rb', line 124

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

#head_commit_for_pinned_ref ⇒ Object 



99
100
101
 
# File 'lib/dependabot/git_commit_checker.rb', line 99

def head_commit_for_pinned_ref
  local_repo_git_metadata_fetcher.head_commit_for_ref_sha(T.must(ref))
end

#local_ref_for_latest_version_lower_precision ⇒ Object 



136
137
138
139
140
 
# File 'lib/dependabot/git_commit_checker.rb', line 136

def local_ref_for_latest_version_lower_precision
  allowed_refs = local_tag_for_pinned_sha ? allowed_version_tags : allowed_version_refs

  max_local_tag_for_lower_precision(allowed_refs)
end

#local_ref_for_latest_version_matching_existing_precision ⇒ Object 



129
130
131
132
133
 
# File 'lib/dependabot/git_commit_checker.rb', line 129

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 



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

def local_tag_for_latest_version
  max_local_tag(allowed_version_tags)
end

#local_tag_for_pinned_sha ⇒ Object 



194
195
196
197
198
199
200
201
 
# File 'lib/dependabot/git_commit_checker.rb', line 194

def local_tag_for_pinned_sha
  return unless pinned_ref_looks_like_commit_sha?

  @local_tag_for_pinned_sha = T.let(
    most_specific_version_tag_for_sha(ref),
    T.nilable(String)
  )
end

#local_tags_for_allowed_versions ⇒ Object 



153
154
155
 
# File 'lib/dependabot/git_commit_checker.rb', line 153

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

#local_tags_for_allowed_versions_matching_existing_precision ⇒ Object 



148
149
150
 
# File 'lib/dependabot/git_commit_checker.rb', line 148

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

#most_specific_tag_equivalent_to_pinned_ref ⇒ Object 



188
189
190
191
 
# File 'lib/dependabot/git_commit_checker.rb', line 188

def most_specific_tag_equivalent_to_pinned_ref
  commit_sha = head_commit_for_local_branch(T.must(ref))
  most_specific_version_tag_for_sha(commit_sha)
end

#most_specific_version_tag_for_sha(commit_sha) ⇒ Object 



224
225
226
227
228
229
230
 
# File 'lib/dependabot/git_commit_checker.rb', line 224

def most_specific_version_tag_for_sha(commit_sha)
  tags = local_tags.select { |t| t.commit_sha == commit_sha && version_class.correct?(t.name) }
                   .sort_by { |t| version_class.new(t.name) }
  return if tags.empty?

  tags[-1]&.name
end

#pinned? ⇒ Boolean

Returns:

  • (Boolean) 


61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/dependabot/git_commit_checker.rb', line 61

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?(T.must(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?(T.must(ref))
end

#pinned_ref_looks_like_commit_sha? ⇒ Boolean

Returns:

  • (Boolean) 


90
91
92
93
94
95
96
 
# File 'lib/dependabot/git_commit_checker.rb', line 90

def pinned_ref_looks_like_commit_sha?
  return false unless ref && ref_looks_like_commit_sha?(T.must(ref))

  return false unless pinned?

  local_repo_git_metadata_fetcher.head_commit_for_ref(T.must(ref)).nil?
end

#pinned_ref_looks_like_version? ⇒ Boolean

Returns:

  • (Boolean) 


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

def pinned_ref_looks_like_version?
  return false unless pinned?

  version_tag?(T.must(ref))
end

#ref_looks_like_commit_sha?(ref) ⇒ Boolean

Returns:

  • (Boolean) 


104
105
106
 
# File 'lib/dependabot/git_commit_checker.rb', line 104

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

#version_for_pinned_sha ⇒ Object 



204
205
206
207
208
 
# File 'lib/dependabot/git_commit_checker.rb', line 204

def version_for_pinned_sha
  return unless local_tag_for_pinned_sha && version_class.correct?(local_tag_for_pinned_sha)

  version_class.new(local_tag_for_pinned_sha)
end