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.

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

Jump to bottom

Add ability to implement custom logic for version catalog updates #706

Merged
merged 1 commit into from
Jul 2, 2024
Merged

Add ability to implement custom logic for version catalog updates #706

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
75 changes: 45 additions & 30 deletions src/main/java/io/micronaut/build/catalogs/tasks/VersionCatalogUpdate.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,20 +82,30 @@ public abstract class VersionCatalogUpdate extends DefaultTask {
@Input
public abstract MapProperty<String, String> getRejectedVersionsPerModule();

/**
* Subclasses may implement this method to add custom rejection logic
* without breaking up-to-date checking
* @param currentVersion the current version of a module, as found in the catalog
* @param candidateVersion the candidate version of a module, as found in a remote repository
* @return true if the candidate version should be excluded
*/
protected boolean shouldIgnoreVersion(String currentVersion, String candidateVersion) {
return false;
}

@TaskAction
void updateCatalogs() throws IOException, InterruptedException {
Set<File> catalogs = getCatalogsDirectory().getAsFileTree()
.matching(pattern -> pattern.include("*.versions.toml"))
.getFiles();
File outputDir = getOutputDirectory().getAsFile().get();
File logFile = getOutputDirectory().file("updates.log").get().getAsFile();
if (outputDir.isDirectory() || outputDir.mkdirs()) {
if (catalogs.isEmpty()) {
getLogger().info("Didn't find any version catalog to process");
}
for (File catalog : catalogs) {
getLogger().info("Processing {}", catalog);
updateCatalog(catalog, new File(outputDir, catalog.getName()), logFile);
updateCatalog(catalog, new File(outputDir, catalog.getName()), getOutputDirectory().file(catalog.getName() + "-updates.log").get().getAsFile());
}
} else {
throw new GradleException("Unable to create output directory " + outputDir);
Expand Down Expand Up @@ -136,44 +146,49 @@ private void updateCatalog(File inputCatalog, File outputCatalog, File logFile)
var rejectedVersionsPerModule = getRejectedVersionsPerModule().get();
detachedConfiguration.getResolutionStrategy().getComponentSelection().all(rules -> {
ModuleComponentIdentifier candidateModule = rules.getCandidate();
String candidateVersion = candidateModule.getVersion();
var moduleIdentifier = candidateModule.getModuleIdentifier();
rejectedQualifiers.forEach(qualifier -> {
if (qualifier.matcher(candidateVersion).find()) {
rules.reject("Rejecting qualifier " + qualifier);
log.println("Rejecting " + moduleIdentifier + " version " + candidateVersion + " because of qualifier '" + qualifier + "'");
}
});
var rejected = rejectedVersionsPerModule.get(moduleIdentifier.toString());
if (rejected != null) {
var exclusion = Pattern.compile(rejected);
if (exclusion.matcher(candidateVersion).find()) {
rules.reject("Rejecting version " + candidateVersion + " because of configuration. It matches regular expression: " + rejected);
log.println("Rejecting version " + candidateVersion + " because of configuration. It matches regular expression: " + rejected);
}
}
if (!allowMajorUpdate) {
model.findLibrary(
candidateModule.getGroup(), candidateModule.getModule()
).ifPresent(library -> {
model.findLibrary(
candidateModule.getGroup(), candidateModule.getModule()
).ifPresent(library -> {
VersionModel version = library.getVersion();
if (version.getReference() != null) {
version = model.findVersion(version.getReference()).orElse(null);
}
if (version != null) {
String required = version.getVersion().getRequire();
if (required != null) {
String major = majorVersionOf(required);
String candidateMajor = majorVersionOf(candidateVersion);
if (!major.equals(candidateMajor)) {
rules.reject("Rejecting major version " + candidateMajor);
log.println("Rejecting " + candidateModule.getModuleIdentifier() + " version " + candidateVersion + " because it's not the same major version");
var candidateVersion = candidateModule.getVersion();
if (shouldIgnoreVersion(required, candidateVersion)) {
rules.reject("Rejecting version " + candidateVersion + " because of configuration. It was rejected by custom logic");
log.println("Rejecting version " + candidateVersion + " because of configuration. It was rejected by custom logic");
return;
}
var moduleIdentifier = candidateModule.getModuleIdentifier();
rejectedQualifiers.forEach(qualifier -> {
if (qualifier.matcher(candidateVersion).find()) {
rules.reject("Rejecting qualifier " + qualifier);
log.println("Rejecting " + moduleIdentifier + " version " + candidateVersion + " because of qualifier '" + qualifier + "'");
}
});
var rejected = rejectedVersionsPerModule.get(moduleIdentifier.toString());
if (rejected != null) {
var exclusion = Pattern.compile(rejected);
if (exclusion.matcher(candidateVersion).find()) {
rules.reject("Rejecting version " + candidateVersion + " because of configuration. It matches regular expression: " + rejected);
log.println("Rejecting version " + candidateVersion + " because of configuration. It matches regular expression: " + rejected);
}
}
if (!allowMajorUpdate) {
String major = majorVersionOf(required);
String candidateMajor = majorVersionOf(candidateVersion);
if (!major.equals(candidateMajor)) {
rules.reject("Rejecting major version " + candidateMajor);
log.println("Rejecting " + candidateModule.getModuleIdentifier() + " version " + candidateVersion + " because it's not the same major version");
}
}
}
}
});
}

}
);
});

Set<String> ignoredModules = getIgnoredModules().get();
Expand Down
Loading