org.wildfly.swarm.plugin.process.ModuleFiller Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of thorntail-fraction-plugin Show documentation
Show all versions of thorntail-fraction-plugin Show documentation
Plugin to create fraction packages for Thorntail proper.
/**
* Copyright 2015-2016 Red Hat, Inc, and individual contributors.
*
* 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.swarm.plugin.process;
import java.io.BufferedReader;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.nio.file.FileVisitResult;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.nio.file.SimpleFileVisitor;
import java.nio.file.StandardCopyOption;
import java.nio.file.attribute.BasicFileAttributes;
import java.text.DecimalFormat;
import java.util.Enumeration;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.function.Function;
import java.util.jar.JarEntry;
import java.util.jar.JarFile;
import java.util.regex.MatchResult;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import java.util.zip.ZipEntry;
import java.util.zip.ZipFile;
import javax.inject.Inject;
import org.apache.maven.model.Resource;
import org.apache.maven.plugin.logging.Log;
import org.apache.maven.plugins.annotations.Parameter;
import org.apache.maven.project.MavenProject;
import org.eclipse.aether.DefaultRepositorySystemSession;
import org.eclipse.aether.artifact.Artifact;
import org.eclipse.aether.artifact.DefaultArtifact;
import org.eclipse.aether.impl.ArtifactResolver;
import org.eclipse.aether.resolution.ArtifactRequest;
import org.eclipse.aether.resolution.ArtifactResult;
import org.jboss.shrinkwrap.descriptor.api.jbossmodule13.ArtifactType;
import org.jboss.shrinkwrap.descriptor.api.jbossmodule13.DependenciesType;
import org.jboss.shrinkwrap.descriptor.api.jbossmodule13.ModuleAliasDescriptor;
import org.jboss.shrinkwrap.descriptor.api.jbossmodule13.ModuleDependencyType;
import org.jboss.shrinkwrap.descriptor.api.jbossmodule13.ModuleDescriptor;
import org.jboss.shrinkwrap.descriptor.api.jbossmodule13.ResourcesType;
import org.jboss.shrinkwrap.descriptor.impl.jbossmodule13.ModuleAliasDescriptorImpl;
import org.jboss.shrinkwrap.descriptor.impl.jbossmodule13.ModuleDescriptorImpl;
import org.jboss.shrinkwrap.descriptor.spi.node.Node;
import org.jboss.shrinkwrap.descriptor.spi.node.NodeImporter;
import org.jboss.shrinkwrap.descriptor.spi.node.dom.XmlDomNodeImporterImpl;
import org.wildfly.swarm.plugin.FractionMetadata;
/**
* @author Bob McWhirter
* @author Ken Finnigan
* @author James R. Perkins
*/
public class ModuleFiller implements Function {
private final Log log;
public ModuleFiller(Log log,
DefaultRepositorySystemSession repositorySystemSession,
ArtifactResolver resolver,
MavenProject project) {
this.log = log;
this.repositorySystemSession = repositorySystemSession;
this.resolver = resolver;
this.project = project;
}
public FractionMetadata apply(FractionMetadata meta) {
try {
this.meta = meta;
loadRewriteRules();
Set requiredModules = new HashSet<>();
Set availableModules = new HashSet<>();
walkProjectModules(requiredModules, availableModules);
walkDependencyModules(availableModules);
Map potentialModules = new HashMap<>();
indexPotentialModules(potentialModules);
if (requiredModules.isEmpty()) {
return meta;
}
locateFillModules(potentialModules, requiredModules, availableModules);
long size = 0;
DecimalFormat fmt = new DecimalFormat("####.00");
for (Artifact artifact : this.allArtifacts) {
ArtifactRequest req = new ArtifactRequest();
req.setArtifact(artifact);
try {
ArtifactResult artifactResult = this.resolver.resolveArtifact(repositorySystemSession, req);
if (artifactResult.isResolved()) {
File file = artifactResult.getArtifact().getFile();
long artifactSize = Files.size(file.toPath());
size += artifactSize;
this.log.info(String.format("%100s %10s mb", toModuleArtifactName(artifact), fmt.format(artifactSize / (1024.0 * 1024.0))));
}
} catch (Exception e) {
this.log.error(e.getMessage(), e);
}
}
this.log.info(this.project.getArtifactId() + ": total size: " + fmt.format(size / (1024.0 * 1024.0)) + " mb");
} catch (IOException e) {
this.log.error(e.getMessage(), e);
}
return meta;
}
private void loadRewriteRules() throws IOException {
Path rewriteConf = Paths.get(this.project.getBasedir().getAbsolutePath(), "module-rewrite.conf");
this.rules = new ModuleRewriteConf(rewriteConf);
}
private void locateFillModules(Map potentialModules, Set requiredModules, Set availableModules) throws IOException {
while (true) {
Set fillModules = new HashSet<>();
fillModules.addAll(requiredModules);
fillModules.removeAll(availableModules);
if (fillModules.isEmpty()) {
break;
}
Set relevantFiles = new HashSet<>();
for (String each : fillModules) {
File file = potentialModules.get(each);
if (file == null) {
throw new IOException("Unable to locate required module: " + each);
}
relevantFiles.add(file);
}
addFillModules(fillModules, relevantFiles, requiredModules, availableModules);
}
}
private void addFillModules(Set fillModules, Set relevantFiles, Set requiredModules, Set availableModules) throws IOException {
for (File each : relevantFiles) {
addFillModules(fillModules, each, requiredModules, availableModules);
}
}
private void addFillModules(Set fillModules, File file, Set requiredModules, Set availableModules) throws IOException {
Map moduleXmls = new HashMap<>();
ZipEntry featurePackXml = null;
try (ZipFile zip = new ZipFile(file)) {
Enumeration entries = zip.entries();
while (entries.hasMoreElements()) {
ZipEntry entry = entries.nextElement();
String name = entry.getName();
String coreName = null;
if (name.equals("wildfly-feature-pack.xml")) {
featurePackXml = entry;
} else if (name.startsWith(MODULES_SYSTEM_PREFIX) && name.endsWith(MODULES_SUFFIX)) {
coreName = name.substring(MODULES_SYSTEM_PREFIX.length(), name.length() - MODULES_SUFFIX.length());
coreName = coreName.substring(coreName.indexOf('/') + 1);
coreName = coreName.substring(coreName.indexOf('/') + 1);
} else if (name.startsWith(MODULES_PREFIX) && name.endsWith(MODULES_SUFFIX)) {
coreName = name.substring(MODULES_PREFIX.length(), name.length() - MODULES_SUFFIX.length());
}
if (coreName != null) {
int lastSlashLoc = coreName.lastIndexOf('/');
String moduleName = coreName.substring(0, lastSlashLoc);
String slot = coreName.substring(lastSlashLoc + 1);
moduleName = moduleName.replace('/', '.');
if (fillModules.contains(moduleName + ":" + slot)) {
moduleXmls.put(moduleName + ":" + slot, entry);
}
}
}
if (featurePackXml == null) {
throw new IOException("Unable to find -feature-pack.xml");
}
Map artifacts = processFeaturePackXml(zip.getInputStream(featurePackXml));
for (String moduleName : moduleXmls.keySet()) {
ZipEntry entry = moduleXmls.get(moduleName);
addFillModule(artifacts, moduleName, zip.getInputStream(entry), requiredModules, availableModules);
addResources(zip, moduleName, entry);
}
}
}
private void addResources(ZipFile zip, String moduleName, ZipEntry moduleXml) {
String moduleXmlPath = moduleXml.getName();
String rootName = moduleXmlPath.substring(0, moduleXmlPath.length() - MODULE_XML.length());
Enumeration entries = zip.entries();
while (entries.hasMoreElements()) {
ZipEntry entry = entries.nextElement();
if (!entry.isDirectory()) {
if (entry.getName().startsWith(rootName) && !entry.getName().equals(moduleXmlPath)) {
String resourceRelative = entry.getName().substring(rootName.length());
resourceRelative = resourceRelative.replace('/', File.separatorChar);
Path classesDir = Paths.get(this.project.getBuild().getOutputDirectory());
Path modulesDir = classesDir.resolve(MODULES);
String[] parts = moduleName.split(":");
String[] moduleParts = parts[0].split("\\.");
Path moduleDir = modulesDir;
for (int i = 0; i < moduleParts.length; ++i) {
moduleDir = moduleDir.resolve(moduleParts[i]);
}
moduleDir = moduleDir.resolve(parts[1]);
Path resourcePath = moduleDir.resolve(resourceRelative);
try {
Files.createDirectories(resourcePath.getParent());
Files.copy(zip.getInputStream(entry), resourcePath, StandardCopyOption.REPLACE_EXISTING);
} catch (IOException e) {
e.printStackTrace();
}
}
}
}
}
private void addFillModule(Map artifacts, String moduleName, InputStream in, Set requiredModules, Set availableModules) throws IOException {
Path classesDir = Paths.get(this.project.getBuild().getOutputDirectory());
Path modulesDir = classesDir.resolve(MODULES);
String[] parts = moduleName.split(":");
String[] moduleParts = parts[0].split("\\.");
Path moduleDir = modulesDir;
for (int i = 0; i < moduleParts.length; ++i) {
moduleDir = moduleDir.resolve(moduleParts[i]);
}
moduleDir = moduleDir.resolve(parts[1]);
Path moduleXml = moduleDir.resolve(MODULE_XML);
processFillModule(artifacts, moduleXml, in);
analyzeModuleXml(modulesDir, moduleXml, requiredModules, availableModules);
}
private void processFillModule(Map artifacts, Path moduleXml, InputStream in) throws IOException {
Files.createDirectories(moduleXml.getParent());
NodeImporter importer = new XmlDomNodeImporterImpl();
Node node = importer.importAsNode(in, true);
String rootName = node.getName();
if (rootName.equals("module")) {
ModuleDescriptor desc = new ModuleDescriptorImpl(null, node);
for (ArtifactType> moduleArtifact : desc.getOrCreateResources().getAllArtifact()) {
String name = moduleArtifact.getName();
if (name.startsWith("${")) {
name = name.substring(2, name.length() - 1);
}
if (name.endsWith("?jandex")) {
name = name.replace("?jandex", "");
}
Artifact artifact = artifacts.get(name);
if (artifact == null) {
String[] parts = name.split(":");
if (parts.length == 3) {
artifacts.put(name, artifact = new DefaultArtifact(parts[0], parts[1], "jar", parts[2]));
} else if (parts.length == 5) {
artifacts.put(name, artifact = new DefaultArtifact(parts[0], parts[1], parts[3], parts[2], parts[4]));
} else {
throw new RuntimeException("Could not resolve module artifact " + name);
}
}
moduleArtifact.name(toModuleArtifactName(artifact));
this.allArtifacts.add(artifact);
}
desc = this.rules.rewrite(desc);
try (FileOutputStream out = new FileOutputStream(moduleXml.toFile())) {
desc.exportTo(out);
}
} else if (rootName.equals("module-alias")) {
ModuleAliasDescriptor desc = new ModuleAliasDescriptorImpl(null, node);
try (FileOutputStream out = new FileOutputStream(moduleXml.toFile())) {
desc.exportTo(out);
}
}
}
private Map processFeaturePackXml(InputStream in) throws IOException {
final Map artifacts = new HashMap<>();
try (BufferedReader reader = new BufferedReader(new InputStreamReader(in))) {
String line = null;
while ((line = reader.readLine()) != null) {
line = line.trim();
Matcher matcher = ARTIFACT_PATTERN.matcher(line);
if (matcher.matches()) {
MatchResult result = matcher.toMatchResult();
String groupId = result.group(1);
String artifactId = result.group(2);
String version = result.group(3);
String classifier = result.group(5);
String expr = groupId + ":" + artifactId + (classifier == null ? "" : "::" + classifier);
artifacts.put(expr, new DefaultArtifact(groupId, artifactId, classifier, "jar", version));
}
}
}
return artifacts;
}
private String toModuleArtifactName(final Artifact artifact) {
final String name = artifact.getGroupId() + ":" + artifact.getArtifactId() + ":" + artifact.getVersion();
return artifact.getClassifier().isEmpty() ? name : name + ":" + artifact.getClassifier();
}
private void indexPotentialModules(Map potentialModules) throws IOException {
Set artifacts = this.project.getArtifacts();
for (org.apache.maven.artifact.Artifact each : artifacts) {
if (each.getType().equals("zip")) {
indexPotentialModules(each.getFile(), potentialModules);
}
}
}
private void indexPotentialModules(File file, Map potentialModules) throws IOException {
try (ZipFile zip = new ZipFile(file)) {
Enumeration entries = zip.entries();
while (entries.hasMoreElements()) {
ZipEntry each = entries.nextElement();
String name = each.getName();
String coreName = null;
if (name.startsWith(MODULES_SYSTEM_PREFIX) && name.endsWith(MODULES_SUFFIX)) {
coreName = name.substring(MODULES_SYSTEM_PREFIX.length(), name.length() - MODULES_SUFFIX.length());
coreName = coreName.substring(coreName.indexOf('/') + 1);
coreName = coreName.substring(coreName.indexOf('/') + 1);
} else if (name.startsWith(MODULES_PREFIX) && name.endsWith(MODULES_SUFFIX)) {
coreName = name.substring(MODULES_PREFIX.length(), name.length() - MODULES_SUFFIX.length());
}
if (coreName != null) {
int lastSlashLoc = coreName.lastIndexOf('/');
String moduleName = coreName.substring(0, lastSlashLoc);
String slot = coreName.substring(lastSlashLoc + 1);
moduleName = moduleName.replace('/', '.');
potentialModules.put(moduleName + ":" + slot, file);
}
}
}
}
private void walkProjectModules(final Set requiredModules, final Set availableModules) throws IOException {
List resources = this.project.getBuild().getResources();
for (Resource each : resources) {
final Path modulesDir = Paths.get(each.getDirectory()).resolve(MODULES);
if (Files.exists(modulesDir)) {
Files.walkFileTree(modulesDir, new SimpleFileVisitor() {
@Override
public FileVisitResult visitFile(Path file, BasicFileAttributes attrs) throws IOException {
if (file.getFileName().toString().equals(MODULE_XML)) {
analyzeModuleXml(modulesDir, file, requiredModules, availableModules);
}
return FileVisitResult.CONTINUE;
}
});
}
}
Path targetModulesDir = Paths.get(this.project.getBuild().getOutputDirectory()).resolve(MODULES);
if (Files.exists(targetModulesDir)) {
Files.walkFileTree(targetModulesDir, new SimpleFileVisitor() {
@Override
public FileVisitResult visitFile(Path file, BasicFileAttributes attrs) throws IOException {
if (file.getFileName().toString().equals(MODULE_XML)) {
analyzeModuleXml(targetModulesDir, file, requiredModules, availableModules);
}
return FileVisitResult.CONTINUE;
}
});
}
}
private void walkDependencyModules(Set availableModules) throws IOException {
Set artifacts = this.project.getArtifacts();
for (org.apache.maven.artifact.Artifact each : artifacts) {
collectAvailableModules(each, availableModules);
}
}
private void collectAvailableModules(org.apache.maven.artifact.Artifact artifact, Set modules) throws IOException {
if (artifact.getType().equals("jar")) {
try (JarFile jar = new JarFile(artifact.getFile())) {
Enumeration entries = jar.entries();
while (entries.hasMoreElements()) {
JarEntry each = entries.nextElement();
String name = each.getName();
if (name.startsWith(MODULES_PREFIX) && name.endsWith(MODULES_SUFFIX)) {
String coreName = name.substring(MODULES_PREFIX.length(), name.length() - MODULES_SUFFIX.length());
int lastSlashLoc = coreName.lastIndexOf('/');
String moduleName = coreName.substring(0, lastSlashLoc);
String slot = coreName.substring(lastSlashLoc + 1);
moduleName = moduleName.replace('/', '.');
modules.add(moduleName + ":" + slot);
}
}
}
}
}
private void analyzeModuleXml(Path root, Path moduleXml, Set requiredModules, Set availableModules) throws IOException {
ModuleAnalyzer analyzer = new ModuleAnalyzer(moduleXml);
this.meta.addTransitiveDependencies(analyzer.getDependencies());
Path modulePath = root.relativize(moduleXml).getParent();
String selfSlot = modulePath.getName(modulePath.getNameCount() - 1).toString();
String selfModuleName = modulePath.getParent().toString().replace(File.separatorChar, '.');
this.log.info("Analyzing: " + selfModuleName + ":" + selfSlot + " (" + moduleXml + ")");
availableModules.add(selfModuleName + ":" + selfSlot);
NodeImporter importer = new XmlDomNodeImporterImpl();
Node node = importer.importAsNode(new FileInputStream(moduleXml.toFile()), true);
String rootName = node.getName();
switch (rootName) {
case "module": {
ModuleDescriptor desc = new ModuleDescriptorImpl(null, node);
desc = this.rules.rewrite(desc);
DependenciesType dependencies = desc.getOrCreateDependencies();
List>> moduleDependencies = dependencies.getAllModule();
for (ModuleDependencyType> moduleDependency : moduleDependencies) {
if (moduleDependency.isOptional()) {
continue;
}
String name = moduleDependency.getName();
String slot = moduleDependency.getSlot();
if (slot == null) {
slot = "main";
}
requiredModules.add(name + ":" + slot);
this.log.info(" - requires: " + name + ":" + slot);
}
break;
}
case "module-alias": {
ModuleAliasDescriptor desc = new ModuleAliasDescriptorImpl(null, node);
String name = desc.getTargetName();
String slot = desc.getTargetSlot();
if (slot == null) {
slot = "main";
}
requiredModules.add(name + ":" + slot);
this.log.info(" - requires: " + name + ":" + slot);
break;
}
default:
}
}
private static final String MODULES = "modules";
private static final String MODULES_PREFIX = MODULES + "/";
private static final String MODULES_SYSTEM_PREFIX = MODULES_PREFIX + "system/";
private static final String MODULE_XML = "module.xml";
private static final String MODULES_SUFFIX = "/" + MODULE_XML;
private static Pattern ARTIFACT_PATTERN = Pattern.compile(" allArtifacts = new HashSet<>();
private FractionMetadata meta;
}