Skip to content
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.

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

Fix Maven inability to overwrite repository urls by ID #5878

Merged
merged 2 commits into from
Oct 13, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
39 changes: 26 additions & 13 deletions maven/lib/dependabot/maven/file_parser/repositories_finder.rb
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ class RepositoriesFinder
# The Central Repository is included in the Super POM, which is
# always inherited from.
CENTRAL_REPO_URL = "https://repo.maven.apache.org/maven2"
SUPER_POM = { url: CENTRAL_REPO_URL, id: "central" }

def initialize(dependency_files:, evaluate_properties: true)
@dependency_files = dependency_files
Expand All @@ -36,27 +37,39 @@ def initialize(dependency_files:, evaluate_properties: true)

# Collect all repository URLs from this POM and its parents
def repository_urls(pom:, exclude_inherited: false)
repo_urls_in_pom =
entries = gather_repository_urls(pom: pom, exclude_inherited: exclude_inherited)
ids = Set.new
entries.map do |entry|
next if entry[:id] && ids.include?(entry[:id])

ids.add(entry[:id]) unless entry[:id].nil?
entry[:url]
end.uniq.compact
end

private

attr_reader :dependency_files

def gather_repository_urls(pom:, exclude_inherited: false)
repos_in_pom =
Nokogiri::XML(pom.content).
css(REPOSITORY_SELECTOR).
map { |node| node.at_css("url").content.strip.gsub(%r{/$}, "") }.
reject { |url| contains_property?(url) && !evaluate_properties? }.
select { |url| url.start_with?("http") }.
map { |url| evaluated_value(url, pom) }
map { |node| { url: node.at_css("url").content.strip, id: node.at_css("id").content.strip } }.
reject { |entry| contains_property?(entry[:url]) && !evaluate_properties? }.
select { |entry| entry[:url].start_with?("http") }.
map { |entry| { url: evaluated_value(entry[:url], pom).gsub(%r{/$}, ""), id: entry[:id] } }

return repo_urls_in_pom + [CENTRAL_REPO_URL] if exclude_inherited
return repos_in_pom + [SUPER_POM] if exclude_inherited

unless (parent = parent_pom(pom, repo_urls_in_pom))
return repo_urls_in_pom + [CENTRAL_REPO_URL]
urls_in_pom = repos_in_pom.map { |repo| repo[:url] }
unless (parent = parent_pom(pom, urls_in_pom))
return repos_in_pom + [SUPER_POM]
end

repo_urls_in_pom + repository_urls(pom: parent)
repos_in_pom + gather_repository_urls(pom: parent)
end

private

attr_reader :dependency_files

def evaluate_properties?
@evaluate_properties
end
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,18 @@
)
end

context "that overwrites central" do
let(:base_pom_fixture_name) { "overwrite_central_pom.xml" }

it "does not include central" do
expect(repository_urls).to eq(
%w(
https://example.com
)
)
end
end

context "that use properties" do
let(:base_pom_fixture_name) { "property_repo_pom.xml" }

Expand Down
45 changes: 45 additions & 0 deletions maven/spec/fixtures/poms/overwrite_central_pom.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion>

<groupId>com.dependabot</groupId>
<artifactId>basic-pom</artifactId>
<version>0.0.1-RELEASE</version>
<name>Dependabot Basic POM</name>

<packaging>pom</packaging>

<repositories>
<repository>
<id>central</id>
<url>https://example.com</url>
<snapshots>
<enabled>false</enabled>
</snapshots>
</repository>
</repositories>

<dependencies>
<dependency>
<groupId>com.google.guava</groupId>
<artifactId>guava</artifactId>
<version>23.3-jre</version>
<scope>compile</scope>
</dependency>

<dependency>
<groupId>org.apache.httpcomponents</groupId>
<artifactId>httpclient</artifactId>
<version>4.5.3</version>
<scope>test</scope>
</dependency>

<dependency>
<groupId>io.mockk</groupId>
<artifactId>mockk</artifactId>
<version>1.0.0</version>
<classifier>sources</classifier>
</dependency>
</dependencies>
</project>
4 changes: 2 additions & 2 deletions maven/spec/fixtures/projects/invalid_repository_url/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,13 @@

<repositories>
<repository>
<id>central</id>
<id>wrong</id>
<url>http://host:port/content/groups/public</url>
</repository>
</repositories>
<pluginRepositories>
<pluginRepository>
<id>central</id>
<id>wrong</id>
<url>http://host:port/content/groups/public</url>
</pluginRepository>
</pluginRepositories>
Expand Down