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

Exclude pre-releases from NuGet latest version check #3468

Merged
merged 5 commits into from
Sep 30, 2024
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
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,7 @@ private boolean performVersionCheck(final MetaModel meta, final Component compon
String responseString = EntityUtils.toString(response.getEntity());
var jsonObject = new JSONObject(responseString);
final JSONArray versions = jsonObject.getJSONArray("versions");

final String latest = findLatestVersion(versions); // get the last version in the array
meta.setLatestVersion(latest);
}
Expand All @@ -127,15 +128,17 @@ private boolean performVersionCheck(final MetaModel meta, final Component compon
return false;
}

private String findLatestVersion(JSONArray versions) {
if (versions.length() < 1) {
private String findLatestVersion(JSONArray versions) {
JSONArray filteredVersions = filterPreReleaseVersions(versions);

if (filteredVersions.length() < 1) {
return null;
}

ComparableVersion latestVersion = new ComparableVersion(versions.getString(0));
ComparableVersion latestVersion = new ComparableVersion(filteredVersions.getString(0));

for (int i = 1; i < versions.length(); i++) {
ComparableVersion version = new ComparableVersion(versions.getString(i));
for (int i = 1; i < filteredVersions.length(); i++) {
ComparableVersion version = new ComparableVersion(filteredVersions.getString(i));
if (version.compareTo(latestVersion) > 0) {
latestVersion = version;
}
Expand All @@ -144,6 +147,16 @@ private String findLatestVersion(JSONArray versions) {
return latestVersion.toString();
}

private JSONArray filterPreReleaseVersions(JSONArray versions) {
JSONArray filteredVersions = new JSONArray();
for (int i = 0; i < versions.length(); i++) {
if (!versions.getString(i).contains("-")) {
filteredVersions.put(versions.getString(i));
}
}
return filteredVersions;
}

private boolean performLastPublishedCheck(final MetaModel meta, final Component component) {
final String url = String.format(registrationUrl, urlEncode(component.getPurl().getName().toLowerCase()), urlEncode(meta.getLatestVersion()));
try (final CloseableHttpResponse response = processHttpRequest(url)) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,47 @@ public void testAnalyzer() throws Exception {
Assert.assertNotNull(metaModel.getPublishedTimestamp());
}


// This test is to check if the analyzer is excluding pre-release versions
// The test is transitent depending on the current version of the package
// retrieved from the repository at the time of running.
// When it was created, the latest release version was 9.0.0-preview.1.24080.9
@Test
public void testAnalyzerExcludingPreRelease() throws Exception {
Component component = new Component();
component.setPurl(new PackageURL("pkg:nuget/[email protected]"));
NugetMetaAnalyzer analyzer = new NugetMetaAnalyzer();

analyzer.setRepositoryBaseUrl("https://api.nuget.org");
MetaModel metaModel = analyzer.analyze(component);

Assert.assertTrue(analyzer.isApplicable(component));
Assert.assertEquals(RepositoryType.NUGET, analyzer.supportedRepositoryType());
Assert.assertNotNull(metaModel.getLatestVersion());

Assert.assertFalse(metaModel.getLatestVersion().contains("-"));
}

// This test is to check if the analyzer is including pre-release versions
// The test is transitent depending on the current version of the package
// retrieved from the repository at the time of running.
// When it was created, the latest release version was 9.0.0-preview.1.24080.9
@Test
public void testAnalyzerIncludingPreRelease() throws Exception {
Component component = new Component();
component.setPurl(new PackageURL("pkg:nuget/[email protected]"));
NugetMetaAnalyzer analyzer = new NugetMetaAnalyzer();

analyzer.setRepositoryBaseUrl("https://api.nuget.org");
MetaModel metaModel = analyzer.analyze(component);

Assert.assertTrue(analyzer.isApplicable(component));
Assert.assertEquals(RepositoryType.NUGET, analyzer.supportedRepositoryType());
Assert.assertNotNull(metaModel.getLatestVersion());

Assert.assertFalse(metaModel.getLatestVersion().contains("-"));
}
nscuro marked this conversation as resolved.
Show resolved Hide resolved

@Test
public void testAnalyzerWithPrivatePackageRepository() throws Exception {
String mockIndexResponse = readResourceFileToString("/unit/tasks/repositories/https---localhost-1080-v3-index.json");
Expand Down
Loading