renovate/renovate
1
0
Fork 0
mirror of https://github.com/renovatebot/renovate.git synced 2025-01-13 07:26:26 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 6

refactor(maven): move createUrlForDependencyPom from index.ts to util.ts (#15381)

Browse source
This commit is contained in:
Craig Andrews 2022-04-30 10:45:09 -04:00 committed by GitHub
parent 0ebee7d1bf
commit 295cf29a59
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 81 additions and 79 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

82
lib/modules/datasource/maven/index.ts
View file

@ -15,6 +15,7 @@ import { MAVEN_REPO } from './common';
import type { MavenDependency, ReleaseMap } from './types';
import {
checkHttpResource,
createUrlForDependencyPom,
downloadHttpProtocol,
downloadMavenXml,
getDependencyInfo,
@ -49,37 +50,6 @@ const mavenCentralHtmlVersionRegex = regEx(
'i'
);
function isSnapshotVersion(version: string): boolean {
if (version.endsWith('-SNAPSHOT')) {
return true;
}
return false;
}
function extractSnapshotVersion(metadata: XmlDocument): string | null {
// Parse the maven-metadata.xml for the snapshot version and determine
// the fixed version of the latest deployed snapshot.
// The metadata descriptor can be found at
// https://maven.apache.org/ref/3.3.3/maven-repository-metadata/repository-metadata.html
//
// Basically, we need to replace -SNAPSHOT with the artifact timestanp & build number,
// so for example 1.0.0-SNAPSHOT will become 1.0.0-<timestamp>-<buildNumber>
const version = metadata
.descendantWithPath('version')
?.val?.replace('-SNAPSHOT', '');
const snapshot = metadata.descendantWithPath('versioning.snapshot');
const timestamp = snapshot?.childNamed('timestamp')?.val;
const build = snapshot?.childNamed('buildNumber')?.val;
// If we weren't able to parse out the required 3 version elements,
// return null because we can't determine the fixed version of the latest snapshot.
if (!version || !timestamp || !build) {
return null;
}
return `${version}-${timestamp}-${build}`;
}
export const defaultRegistryUrls = [MAVEN_REPO];
export class MavenDatasource extends Datasource {
@ -190,53 +160,6 @@ export class MavenDatasource extends Datasource {
return releaseMap;
}
async getSnapshotFullVersion(
version: string,
dependency: MavenDependency,
repoUrl: string
): Promise<string | null> {
// To determine what actual files are available for the snapshot, first we have to fetch and parse
// the metadata located at http://<repo>/<group>/<artifact>/<version-SNAPSHOT>/maven-metadata.xml
const metadataUrl = getMavenUrl(
dependency,
repoUrl,
`${version}/maven-metadata.xml`
);
const { xml: mavenMetadata } = await downloadMavenXml(
this.http,
metadataUrl
);
if (!mavenMetadata) {
return null;
}
return extractSnapshotVersion(mavenMetadata);
}
async createUrlForDependencyPom(
version: string,
dependency: MavenDependency,
repoUrl: string
): Promise<string> {
if (isSnapshotVersion(version)) {
// By default, Maven snapshots are deployed to the repository with fixed file names.
// Resolve the full, actual pom file name for the version.
const fullVersion = await this.getSnapshotFullVersion(
version,
dependency,
repoUrl
);
// If we were able to resolve the version, use that, otherwise fall back to using -SNAPSHOT
if (fullVersion !== null) {
return `${version}/${dependency.name}-${fullVersion}.pom`;
}
}
return `${version}/${dependency.name}-${version}.pom`;
}
/**
*
* Double-check releases using HEAD request and
@ -317,7 +240,8 @@ export class MavenDatasource extends Datasource {
// Update cached data with freshly discovered versions
if (freshVersions.length) {
const queue = freshVersions.map((version) => async (): Promise<void> => {
const pomUrl = await this.createUrlForDependencyPom(
const pomUrl = await createUrlForDependencyPom(
this.http,
version,
dependency,
repoUrl

78
lib/modules/datasource/maven/util.ts
View file

@ -199,6 +199,84 @@ export function getDependencyParts(packageName: string): MavenDependency {
};
}
function extractSnapshotVersion(metadata: XmlDocument): string | null {
// Parse the maven-metadata.xml for the snapshot version and determine
// the fixed version of the latest deployed snapshot.
// The metadata descriptor can be found at
// https://maven.apache.org/ref/3.3.3/maven-repository-metadata/repository-metadata.html
//
// Basically, we need to replace -SNAPSHOT with the artifact timestanp & build number,
// so for example 1.0.0-SNAPSHOT will become 1.0.0-<timestamp>-<buildNumber>
const version = metadata
.descendantWithPath('version')
?.val?.replace('-SNAPSHOT', '');
const snapshot = metadata.descendantWithPath('versioning.snapshot');
const timestamp = snapshot?.childNamed('timestamp')?.val;
const build = snapshot?.childNamed('buildNumber')?.val;
// If we weren't able to parse out the required 3 version elements,
// return null because we can't determine the fixed version of the latest snapshot.
if (!version || !timestamp || !build) {
return null;
}
return `${version}-${timestamp}-${build}`;
}
async function getSnapshotFullVersion(
http: Http,
version: string,
dependency: MavenDependency,
repoUrl: string
): Promise<string | null> {
// To determine what actual files are available for the snapshot, first we have to fetch and parse
// the metadata located at http://<repo>/<group>/<artifact>/<version-SNAPSHOT>/maven-metadata.xml
const metadataUrl = getMavenUrl(
dependency,
repoUrl,
`${version}/maven-metadata.xml`
);
const { xml: mavenMetadata } = await downloadMavenXml(http, metadataUrl);
if (!mavenMetadata) {
return null;
}
return extractSnapshotVersion(mavenMetadata);
}
function isSnapshotVersion(version: string): boolean {
if (version.endsWith('-SNAPSHOT')) {
return true;
}
return false;
}
export async function createUrlForDependencyPom(
http: Http,
version: string,
dependency: MavenDependency,
repoUrl: string
): Promise<string> {
if (isSnapshotVersion(version)) {
// By default, Maven snapshots are deployed to the repository with fixed file names.
// Resolve the full, actual pom file name for the version.
const fullVersion = await getSnapshotFullVersion(
http,
version,
dependency,
repoUrl
);
// If we were able to resolve the version, use that, otherwise fall back to using -SNAPSHOT
if (fullVersion !== null) {
return `${version}/${dependency.name}-${fullVersion}.pom`;
}
}
return `${version}/${dependency.name}-${version}.pom`;
}
export async function getDependencyInfo(
http: Http,
dependency: MavenDependency,