Skip to content

Revert "Refactor branch naming strategy for docker dependencies with digests." #12145

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 25, 2025
Merged

Revert "Refactor branch naming strategy for docker dependencies with digests." #12145

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 5 additions & 40 deletions common/lib/dependabot/pull_request_creator/branch_namer/solo_strategy.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,27 +142,16 @@ def new_version(dependency)
return new_ref(dependency) if ref_changed?(dependency) && new_ref(dependency)

T.must(dependency.version)[0..6]
elsif dependency.version != dependency.previous_version && package_manager == "docker"
handle_docker_version_change(dependency)
elsif dependency.version == dependency.previous_version &&
package_manager == "docker"
dependency.requirements
.filter_map { |r| r.dig(:source, "digest") || r.dig(:source, :digest) }
.first.split(":").last[0..6]
else
dependency.version
end
end

sig { params(dependency: Dependabot::Dependency).returns(T.nilable(String)) }
def handle_docker_version_change(dependency)
current_tag, current_digest = extract_tag_and_digest(dependency.requirements)
previous_tag, previous_digest = extract_tag_and_digest(dependency.previous_requirements)

if current_tag == previous_tag && current_digest != previous_digest
format_digest_branch_name(current_tag, current_digest)
elsif current_tag != previous_tag
current_tag
else
format_digest_branch_name(current_tag, current_digest)
end
end

sig { params(dependency: Dependabot::Dependency).returns(T.nilable(String)) }
def previous_ref(dependency)
previous_refs = T.must(dependency.previous_requirements).filter_map do |r|
Expand Down Expand Up @@ -232,30 +221,6 @@ def dependency_digest
T.nilable(String)
)
end

sig do
params(requirements: T.nilable(T::Array[T::Hash[Symbol, T.untyped]]))
.returns([T.nilable(String), T.nilable(String)])
end
def extract_tag_and_digest(requirements)
return [nil, nil] unless requirements

tag = requirements.filter_map { |r| r.dig(:source, "tag") || r.dig(:source, :tag) }.first
digest = requirements.filter_map { |r| r.dig(:source, "digest") || r.dig(:source, :digest) }.first
[tag, digest]
end

sig { params(tag: T.nilable(String), digest: T.nilable(String)).returns(T.nilable(String)) }
def format_digest_branch_name(tag, digest)
return tag if digest.nil?

digest_parts = digest.split(":")
if tag && !tag.empty?
"#{tag}-#{digest_parts.first}-#{digest_parts.last&.slice(0, 6)}"
else
"#{digest_parts.first}-#{digest_parts.last&.slice(0, 6)}"
end
end
end
end
end
Expand Down
58 changes: 17 additions & 41 deletions common/spec/dependabot/pull_request_creator/branch_namer/solo_strategy_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -487,68 +487,44 @@
end

context "with a Docker digest update" do
let(:source) do
{
digest: "sha256:18305429afa14ea462f810146ba44d4363ae76e4c8dfc38288cf73aa07485005"
}
end
let(:previous_source) do
{
digest: "sha256:2167a21baaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}
end
let(:dependency) do
Dependabot::Dependency.new(
name: "ubuntu",
version: "sha256:18305429afa14ea462f810146ba44d4363ae76e4c8dfc38288cf73aa07485005",
version: "17.10",
previous_version: previous_version,
package_manager: "docker",
requirements: [{
file: "Dockerfile",
requirement: nil,
groups: [],
source: source
source: {
type: "digest",
digest: "sha256:18305429afa14ea462f810146ba44d4363ae76e4c8d" \
"fc38288cf73aa07485005"
}
}],
previous_requirements: [{
file: "Dockerfile",
requirement: nil,
groups: [],
source: previous_source
source: {
type: "digest",
digest: "sha256:2167a21baaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" \
"aaaaaaaaaaaaaaaaaaaaa"
}
}]
)
end
let(:previous_version) { "sha256:2167a21baaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" }

it "truncates the version to just the digest when no tag is present" do
expect(new_branch_name).to eq("dependabot/docker/ubuntu-sha256-183054")
end
let(:previous_version) { "17.10" }

context "when there is a tag present with only a digest change" do
let(:version) { "17.10@sha256:18305429afa14ea462f810146ba44d4363ae76e4c8dfc38288cf73aa07485005" }
let(:previous_version) { "17.10@sha256:2167a21baaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" }
let(:source) do
{ tag: "17.10", digest: "sha256:18305429afa14ea462f810146ba44d4363ae76e4c8dfc38288cf73aa07485005" }
end
let(:previous_source) do
{ tag: "17.10", digest: "sha256:2167a21baaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" }
end

it "includes the tag and digest" do
expect(new_branch_name).to eq("dependabot/docker/ubuntu-17.10-sha256-183054")
end
it "truncates the version" do
expect(new_branch_name).to eq("dependabot/docker/ubuntu-1830542")
end

context "when there is a tag and digest change" do
let(:version) { "17.10@sha256:18305429afa14ea462f810146ba44d4363ae76e4c8dfc38288cf73aa07485005" }
let(:previous_version) { "17.10@sha256:2167a21baaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" }
let(:source) do
{ tag: "17.10", digest: "sha256:18305429afa14ea462f810146ba44d4363ae76e4c8dfc38288cf73aa07485005" }
end
let(:previous_source) do
{ tag: "17.04", digest: "sha256:2167a21baaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" }
end
context "when there is a tag change" do
let(:previous_version) { "17.04" }

it "includes the tag without the digest" do
it "includes the tag rather than the SHA" do
expect(new_branch_name).to eq("dependabot/docker/ubuntu-17.10")
end
end
Expand Down
58 changes: 17 additions & 41 deletions common/spec/dependabot/pull_request_creator/branch_namer_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -487,68 +487,44 @@
end

context "with a Docker digest update" do
let(:source) do
{
digest: "sha256:18305429afa14ea462f810146ba44d4363ae76e4c8dfc38288cf73aa07485005"
}
end
let(:previous_source) do
{
digest: "sha256:2167a21baaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}
end
let(:dependency) do
Dependabot::Dependency.new(
name: "ubuntu",
version: "sha256:18305429afa14ea462f810146ba44d4363ae76e4c8dfc38288cf73aa07485005",
version: "17.10",
previous_version: previous_version,
package_manager: "docker",
requirements: [{
file: "Dockerfile",
requirement: nil,
groups: [],
source: source
source: {
type: "digest",
digest: "sha256:18305429afa14ea462f810146ba44d4363ae76e4c8d" \
"fc38288cf73aa07485005"
}
}],
previous_requirements: [{
file: "Dockerfile",
requirement: nil,
groups: [],
source: previous_source
source: {
type: "digest",
digest: "sha256:2167a21baaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" \
"aaaaaaaaaaaaaaaaaaaaa"
}
}]
)
end
let(:previous_version) { "sha256:2167a21baaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" }

it "truncates the version to just the digest when no tag is present" do
expect(new_branch_name).to eq("dependabot/docker/ubuntu-sha256-183054")
end
let(:previous_version) { "17.10" }

context "when there is a tag present with only a digest change" do
let(:version) { "17.10@sha256:18305429afa14ea462f810146ba44d4363ae76e4c8dfc38288cf73aa07485005" }
let(:previous_version) { "17.10@sha256:2167a21baaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" }
let(:source) do
{ tag: "17.10", digest: "sha256:18305429afa14ea462f810146ba44d4363ae76e4c8dfc38288cf73aa07485005" }
end
let(:previous_source) do
{ tag: "17.10", digest: "sha256:2167a21baaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" }
end

it "includes the tag and digest" do
expect(new_branch_name).to eq("dependabot/docker/ubuntu-17.10-sha256-183054")
end
it "truncates the version" do
expect(new_branch_name).to eq("dependabot/docker/ubuntu-1830542")
end

context "when there is a tag and digest change" do
let(:version) { "17.10@sha256:18305429afa14ea462f810146ba44d4363ae76e4c8dfc38288cf73aa07485005" }
let(:previous_version) { "17.10@sha256:2167a21baaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" }
let(:source) do
{ tag: "17.10", digest: "sha256:18305429afa14ea462f810146ba44d4363ae76e4c8dfc38288cf73aa07485005" }
end
let(:previous_source) do
{ tag: "17.04", digest: "sha256:2167a21baaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" }
end
context "when there is a tag change" do
let(:previous_version) { "17.04" }

it "includes the tag without the digest" do
it "includes the tag rather than the SHA" do
expect(new_branch_name).to eq("dependabot/docker/ubuntu-17.10")
end
end
Expand Down
4 changes: 2 additions & 2 deletions docker/spec/dependabot/docker/update_checker_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -261,9 +261,9 @@ def stub_tag_with_no_digest(tag)
it { is_expected.to eq("artful") }

context "when the version starts with a number" do
let(:version) { "309403913c7f0848e6616446edec909b55d53571" }
let(:version) { "sha256:309403913c7f0848e6616446edec909b55d53571" }

it { is_expected.to eq("309403913c7f0848e6616446edec909b55d53571") }
it { is_expected.to eq("sha256:309403913c7f0848e6616446edec909b55d53571") }
end
end

Expand Down
Loading