All Downloads are FREE. Search and download functionalities are using the official Maven repository.
Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
org.wildfly.plugins.bootablejar.maven.goals.MavenUpgrade Maven / Gradle / Ivy
/*
* Copyright 2021 Red Hat, Inc. and/or its affiliates
* and other contributors as indicated by the @author tags.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.wildfly.plugins.bootablejar.maven.goals;
import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import org.apache.maven.artifact.Artifact;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.artifact.versioning.DefaultArtifactVersion;
import org.jboss.galleon.ProvisioningDescriptionException;
import org.jboss.galleon.ProvisioningException;
import org.jboss.galleon.api.GalleonFeaturePackDescription;
import org.jboss.galleon.api.Provisioning;
import org.jboss.galleon.api.config.GalleonFeaturePackConfig;
import org.jboss.galleon.api.config.GalleonProvisioningConfig;
import org.jboss.galleon.universe.Channel;
import org.jboss.galleon.universe.FeaturePackLocation;
import org.jboss.galleon.universe.FeaturePackLocation.FPID;
import org.jboss.galleon.universe.FeaturePackLocation.ProducerSpec;
import org.jboss.galleon.universe.maven.MavenChannel;
import org.jboss.galleon.universe.maven.MavenUniverseException;
import org.wildfly.plugins.bootablejar.maven.common.FeaturePack;
import org.wildfly.plugins.bootablejar.maven.common.OverriddenArtifact;
final class MavenUpgrade {
private final Map dependencies = new LinkedHashMap<>();
private final Map topLevels = new LinkedHashMap<>();
private final AbstractBuildBootableJarMojo mojo;
private final Map producerToGAC = new HashMap<>();
private ScannedModules modules;
private final GalleonProvisioningConfig originalConfig;
private final Provisioning provisioning;
MavenUpgrade(AbstractBuildBootableJarMojo mojo, Provisioning provisioning, GalleonProvisioningConfig originalConfig)
throws MavenUniverseException, ProvisioningException, MojoExecutionException {
this.mojo = mojo;
this.provisioning = provisioning;
this.originalConfig = originalConfig;
for (GalleonFeaturePackConfig cfg : originalConfig.getFeaturePackDeps()) {
FeaturePack fp = toFeaturePack(cfg.getLocation());
if (fp == null) {
throw new ProvisioningException("Invalid location " + cfg.getLocation());
}
topLevels.put(fp.getGAC(), fp);
}
// Resolve the FP to retrieve dependencies as expressed in fp spec.
Map resolvedFeaturePacks = new LinkedHashMap<>();
for (FeaturePack fp : topLevels.values()) {
resolvedFeaturePacks.put(fp.getGAC(), mojo.resolveMaven(fp));
}
mojo.debug("Top level feature-packs: %s", topLevels);
mojo.debug("Resolved feature-packs: %s", resolvedFeaturePacks);
for (Entry entry : resolvedFeaturePacks.entrySet()) {
GalleonFeaturePackDescription spec = Provisioning.getFeaturePackDescription(entry.getValue());
producerToGAC.put(spec.getProducer().getProducer(), entry.getKey());
List allDeps = new ArrayList<>();
for (FPID cfg : spec.getDependencies()) {
allDeps.add(cfg);
}
for (FPID cfg : spec.getTransitives()) {
allDeps.add(cfg);
}
for (FPID cfg : allDeps) {
FeaturePack fp = toFeaturePack(cfg.getLocation());
if (fp != null) {
String gac = fp.getGAC();
// Only add the dep if not already seen. The first installed FP dep wins.
if (!topLevels.containsKey(gac) && !dependencies.containsKey(gac)) {
// Resolve to retrieve the actual producer and map to GAC
Path p = mojo.resolveMaven(fp);
GalleonFeaturePackDescription depSpec = Provisioning.getFeaturePackDescription(p);
producerToGAC.put(depSpec.getProducer().getProducer(), gac);
dependencies.put(gac, fp);
}
}
}
}
mojo.debug("FP dependencies %s", dependencies);
}
private Map getOriginalVersions() throws ProvisioningException, MojoExecutionException {
return getScannedModules().getProvisionedArtifacts();
}
private ScannedModules getScannedModules() throws ProvisioningException, MojoExecutionException {
if (modules == null) {
modules = ScannedModules.scanProvisionedArtifacts(provisioning, originalConfig);
}
return modules;
}
void dumpArtifacts(Path file) throws ProvisioningException, MojoExecutionException, IOException {
Map> perModules = getScannedModules().getPerModuleArtifacts();
StringBuilder builder = new StringBuilder();
builder.append("").append(System.lineSeparator());
// Add feature-pack dependencies
builder.append(" ").append(System.lineSeparator());
for (FeaturePack fp : dependencies.values()) {
builder.append(" ").append(System.lineSeparator());
builder.append(" ").append(fp.getGroupId()).append(" ").append(System.lineSeparator());
builder.append(" ").append(fp.getArtifactId()).append(" ").append(System.lineSeparator());
if (fp.getClassifier() != null && !fp.getClassifier().isEmpty()) {
builder.append(" ").append(fp.getClassifier()).append(" ").append(System.lineSeparator());
}
builder.append(" ").append(fp.getVersion()).append(" ").append(System.lineSeparator());
builder.append(" ").append(fp.getType()).append(" ").append(System.lineSeparator());
builder.append(" ").append(System.lineSeparator());
}
builder.append(" ").append(System.lineSeparator());
builder.append(" ").append(System.lineSeparator());
Artifact jbossModules = AbstractBuildBootableJarMojo.getArtifact(getScannedModules().getModuleRuntime());
builder.append(" ").append(jbossModules.getGroupId()).append(" ").append(System.lineSeparator());
builder.append(" ").append(jbossModules.getArtifactId()).append(" ").append(System.lineSeparator());
if (jbossModules.getClassifier() != null && !jbossModules.getClassifier().isEmpty()) {
builder.append(" ").append(jbossModules.getClassifier()).append(" ").append(System.lineSeparator());
}
builder.append(" ").append(jbossModules.getVersion()).append(" ").append(System.lineSeparator());
builder.append(" ").append(jbossModules.getType()).append(" ").append(System.lineSeparator());
builder.append(" ").append(System.lineSeparator());
if (!getScannedModules().getCopiedArtifacts().isEmpty()) {
builder.append(" ").append(System.lineSeparator());
for (String gav : getScannedModules().getCopiedArtifacts().values()) {
Artifact a = AbstractBuildBootableJarMojo.getArtifact(gav);
builder.append(" ").append(System.lineSeparator());
builder.append(" ").append(a.getGroupId()).append(" ").append(System.lineSeparator());
builder.append(" ").append(a.getArtifactId()).append(" ").append(System.lineSeparator());
if (a.getClassifier() != null && !a.getClassifier().isEmpty()) {
builder.append(" ").append(a.getClassifier()).append(" ").append(System.lineSeparator());
}
builder.append(" ").append(a.getVersion()).append(" ").append(System.lineSeparator());
builder.append(" ").append(a.getType()).append(" ").append(System.lineSeparator());
builder.append(" ").append(System.lineSeparator());
}
builder.append(" ").append(System.lineSeparator());
}
builder.append(" ").append(System.lineSeparator());
for (Entry> module : perModules.entrySet()) {
builder.append(" ").append(System.lineSeparator());
for (String s : module.getValue().values()) {
Artifact a = AbstractBuildBootableJarMojo.getArtifact(s);
builder.append(" ").append(System.lineSeparator());
builder.append(" ").append(a.getGroupId()).append(" ").append(System.lineSeparator());
builder.append(" ").append(a.getArtifactId()).append(" ").append(System.lineSeparator());
if (a.getClassifier() != null && !a.getClassifier().isEmpty()) {
builder.append(" ").append(a.getClassifier()).append(" ").append(System.lineSeparator());
}
builder.append(" ").append(a.getVersion()).append(" ").append(System.lineSeparator());
builder.append(" ").append(a.getType()).append(" ").append(System.lineSeparator());
builder.append(" ").append(System.lineSeparator());
}
builder.append(" ").append(System.lineSeparator());
}
builder.append(" ").append(System.lineSeparator());
builder.append(" ").append(System.lineSeparator());
Files.write(file, builder.toString().getBytes("UTF-8"));
}
private static String getOriginalArtifactVersion(OverriddenArtifact a, Map originalArtifactVersions) {
StringBuilder keyBuilder = new StringBuilder();
keyBuilder.append(a.getGroupId()).append(":").append(a.getArtifactId());
if (a.getClassifier() != null && !a.getClassifier().isEmpty()) {
keyBuilder.append("::").append(a.getClassifier());
}
String key = keyBuilder.toString();
String value = originalArtifactVersions.get(key);
if (value == null) {
return null;
}
Artifact artifact = AbstractBuildBootableJarMojo.getArtifact(value);
return artifact.getVersion();
}
GalleonProvisioningConfig upgrade() throws MojoExecutionException, ProvisioningDescriptionException, ProvisioningException {
if (mojo.overriddenServerArtifacts.isEmpty()) {
return originalConfig;
}
Map originalVersions = getOriginalVersions();
List featurePackDependencies = new ArrayList<>();
List artifactDependencies = new ArrayList<>();
Map allArtifacts = new HashMap<>();
for (OverriddenArtifact a : mojo.overriddenServerArtifacts) {
if (a.getGroupId() == null || a.getArtifactId() == null) {
throw new MojoExecutionException("Invalid overridden artifact " + a.getGAC() + ". GroupId and ArtifactId are required.");
}
String key = a.getGAC();
if (allArtifacts.containsKey(key)) {
throw new MojoExecutionException("Artifact " + key + " is present more than once in the overridden artifacts. Must be unique.");
} else {
allArtifacts.put(key, a);
}
// Is it a potential feature-pack
if (dependencies.containsKey(key)) {
Artifact fpArtifact = mojo.artifactVersions.getFeaturePackArtifact(a.getGroupId(), a.getArtifactId(), a.getClassifier());
if (fpArtifact == null) {
throw new MojoExecutionException("No version for Galleon feature-pack " + a.getGAC());
} else {
checkScope(fpArtifact);
if (a.getVersion() != null) {
fpArtifact.setVersion(a.getVersion());
}
FeaturePack dep = dependencies.get(key);
DefaultArtifactVersion orig = new DefaultArtifactVersion(dep.getVersion());
DefaultArtifactVersion overriddenVersion = new DefaultArtifactVersion(fpArtifact.getVersion());
int compared = orig.compareTo(overriddenVersion);
if (compared > 0) {
if (!mojo.disableWarnForArtifactDowngrade) {
mojo.getLog().warn("[UPDATE] Downgrading dependency " + key + " from " + dep.getVersion() + " to " + fpArtifact.getVersion());
}
} else {
if (compared == 0) {
mojo.getLog().warn("[UPDATE] Dependency " + key + " will be not upgraded, already at version: " + fpArtifact.getVersion());
}
}
if (compared != 0) {
FeaturePack fp = new FeaturePack();
fp.setGroupId(a.getGroupId());
fp.setArtifactId(a.getArtifactId());
fp.setClassifier(fpArtifact.getClassifier());
fp.setExtension(fpArtifact.getType());
fp.setVersion(fpArtifact.getVersion());
featurePackDependencies.add(fp);
}
}
} else {
Artifact mavenArtifact = mojo.artifactVersions.getArtifact(a);
if (mavenArtifact == null) {
// It could be a wrong FP not present in the list of dependencies
Artifact fpArtifact = mojo.artifactVersions.getFeaturePackArtifact(a.getGroupId(), a.getArtifactId(), a.getClassifier());
if (fpArtifact != null) {
throw new MojoExecutionException("Zip artifact " + a.getGAC() + " not found in dependencies. "
+ " Could be a wrong Galleon feature-pack used to override a feature-pack dependency.");
}
throw new MojoExecutionException("No version for artifact " + a.getGAC());
} else {
checkScope(mavenArtifact);
if (a.getVersion() == null) {
a.setVersion(mavenArtifact.getVersion());
}
if (a.getType() == null) {
a.setType(mavenArtifact.getType());
}
String originalVersion = getOriginalArtifactVersion(a, originalVersions);
if (originalVersion == null) {
throw new MojoExecutionException("Overridden artifact " + a.getGAC() + " not know in provisioned feature-packs");
}
DefaultArtifactVersion orig = new DefaultArtifactVersion(originalVersion);
DefaultArtifactVersion overriddenVersion = new DefaultArtifactVersion(a.getVersion());
int compared = orig.compareTo(overriddenVersion);
if (compared > 0) {
if (!mojo.disableWarnForArtifactDowngrade) {
mojo.getLog().warn("[UPDATE] Downgrading artifact " + a.getGAC() + " from " + originalVersion + " to " + a.getVersion());
}
} else {
if (compared == 0) {
mojo.getLog().warn("[UPDATE] Artifact " + a.getGAC() + " is already at version " + a.getVersion() + ", will be not upgraded.");
}
}
if (compared != 0) {
artifactDependencies.add(a);
}
}
}
}
if (!artifactDependencies.isEmpty() || !featurePackDependencies.isEmpty()) {
GalleonProvisioningConfig original = originalConfig;
GalleonProvisioningConfig.Builder c = GalleonProvisioningConfig.builder(original);
if (!featurePackDependencies.isEmpty()) {
mojo.getLog().info("[UPDATE] Overriding Galleon feature-pack dependency with: ");
for (FeaturePack fp : featurePackDependencies) {
mojo.getLog().info("[UPDATE] " + fp.getGroupId() + ":" + fp.getArtifactId() + ":"
+ (fp.getClassifier() == null ? "" : fp.getClassifier() + ":")
+ fp.getVersion() + (fp.getExtension() == null ? "" : ":" + fp.getExtension()));
c.addTransitiveDep(FeaturePackLocation.fromString(fp.getMavenCoords()));
}
}
if (!artifactDependencies.isEmpty()) {
mojo.getLog().info("[UPDATE] Overriding server artifacts with:");
if (!mojo.pluginOptions.containsKey("jboss-overridden-artifacts")) {
String updates = toOptionValue(artifactDependencies);
for (OverriddenArtifact update : artifactDependencies) {
mojo.getLog().info("[UPDATE] " + update.getGroupId() + ":" + update.getArtifactId() + ":"
+ (update.getClassifier() == null ? "" : update.getClassifier() + ":")
+ update.getVersion() + (update.getType() == null ? "" : ":" + update.getType()));
}
Map allOptions = new HashMap<>();
allOptions.putAll(original.getOptions());
allOptions.put("jboss-overridden-artifacts", updates);
c.addOptions(allOptions);
}
}
return c.build();
} else {
return originalConfig;
}
}
void checkScope(Artifact a) {
if (!"provided".equals(a.getScope())) {
mojo.getLog().warn("[UPDATE] Overridden artifact " + a.getGroupId() +":"+ a.getArtifactId()+
(a.getClassifier() == null ? "" : ":" + a.getClassifier()) + ":" + a.getVersion() + " is not of provided scope.");
}
}
static String locationWithVersion(String featurePackLocation, MavenProjectArtifactVersions artifactVersions) throws MojoExecutionException {
FeaturePackLocation location = FeaturePackLocation.fromString(featurePackLocation);
if (location.getUniverse() == null || location.getUniverse().getLocation() == null) {
FeaturePack fp = getFeaturePack(featurePackLocation);
if (fp.getVersion() == null) {
Artifact fpArtifact = artifactVersions.getFeaturePackArtifact(fp.getGroupId(), fp.getArtifactId(), null);
if (fpArtifact == null) {
throw new MojoExecutionException("No version found for " + featurePackLocation);
}
fp.setVersion(fpArtifact.getVersion());
featurePackLocation = fp.getMavenCoords();
}
}
return featurePackLocation;
}
private FeaturePack toFeaturePack(FeaturePackLocation fpl) throws MojoExecutionException {
FeaturePack fp;
validateFPL(fpl);
if (fpl.isMavenCoordinates()) {
fp = getFeaturePack(fpl.toString());
} else {
fp = getFeaturePack(fpl);
}
return fp;
}
private static void validateFPL(FeaturePackLocation fpl) throws MojoExecutionException {
if (fpl.getUniverse() == null || fpl.getProducer() == null) {
throw new MojoExecutionException("Invalid feature-pack location format: " + fpl);
}
}
String getMavenFeaturePack(FeaturePackLocation.FPID location) {
String gac = producerToGAC.get(location.getProducer());
if (gac == null) {
return location.toString();
} else {
return gac + ":" + location.getBuild();
}
}
private FeaturePack getFeaturePack(FeaturePackLocation fpl) {
try {
Channel channel = provisioning.getUniverseResolver().getChannel(fpl);
if (channel instanceof MavenChannel) {
MavenChannel mavenChannel = (MavenChannel) channel;
FeaturePack fp = new FeaturePack();
fp.setGroupId(mavenChannel.getFeaturePackGroupId());
fp.setArtifactId(mavenChannel.getFeaturePackArtifactId());
String build = fpl.getBuild();
if (build == null) {
build = mavenChannel.getLatestBuild(fpl);
}
fp.setVersion(build);
return fp;
}
} catch (ProvisioningException ex) {
// OK, invalid channel, can occurs for non registered FP that are referenced from GAV.
mojo.debug("Invalid channel for %s, the feature-pack is not known in the universe, skipping it.", fpl);
}
return null;
}
//groupId:artifactid[:classfier:extension:][:version]
static FeaturePack getFeaturePack(String str) throws MojoExecutionException {
if (str == null) {
throw new MojoExecutionException("Null feature-pack coords");
}
final String[] parts = str.split(":");
if (parts.length < 2 || parts.length > 5) {
throw new MojoExecutionException("Invalid feature-pack location format: " + str);
}
FeaturePack fp = new FeaturePack();
fp.setGroupId(parts[0]);
fp.setArtifactId(parts[1]);
String classifier;
String extension;
String version = null;
if (parts.length >= 4) {
classifier = parts[2] == null || parts[2].isEmpty() ? null : parts[2];
extension = parts[3] == null || parts[3].isEmpty() ? null : parts[3];
fp.setClassifier(classifier);
if (extension != null) {
fp.setExtension(extension);
}
if (parts.length == 5) {
version = parts[4] == null || parts[4].isEmpty() ? null : parts[4];
}
} else if (parts.length == 3) {
version = parts[2];
}
fp.setVersion(version);
return fp;
}
static String toOptionValue(List lst) throws ProvisioningException {
StringBuilder builder = new StringBuilder();
for (int i = 0; i < lst.size(); i++) {
OverriddenArtifact artifact = lst.get(i);
validate(artifact);
builder.append(artifact.getGroupId()).append(":").append(artifact.getArtifactId()).
append(":").append(artifact.getVersion()).append(":");
String classifier = artifact.getClassifier() == null ? "" : artifact.getClassifier();
builder.append(classifier).append(":").append(artifact.getType());
if (i < lst.size() - 1) {
builder.append("|");
}
}
return builder.toString();
}
private static void validate(OverriddenArtifact artifact) throws ProvisioningException {
if (artifact.getGroupId() == null) {
throw new ProvisioningException("No groupId set for overridden artifact");
}
if (artifact.getArtifactId() == null) {
throw new ProvisioningException("No artifactId set for overridden artifact");
}
if (artifact.getVersion() == null) {
throw new ProvisioningException("No version set for overridden artifact");
}
if (artifact.getType() == null) {
throw new ProvisioningException("No type set for overridden artifact");
}
}
}
