org.wildfly.testing.tools.deployments.DeploymentDescriptors Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of wildfly-testing-tools Show documentation
Show all versions of wildfly-testing-tools Show documentation
Testing utilities for using Arquillian with WildFly. These include add deployment descriptors and
modules to WildFly for testing.
The newest version!
/*
* Copyright The WildFly Authors
* SPDX-License-Identifier: Apache-2.0
*/
package org.wildfly.testing.tools.deployments;
import java.io.ByteArrayOutputStream;
import java.io.File;
import java.io.FilePermission;
import java.io.IOException;
import java.io.InputStream;
import java.io.UncheckedIOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.security.Permission;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Set;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.stream.XMLStreamException;
import javax.xml.stream.XMLStreamWriter;
import org.jboss.shrinkwrap.api.Archive;
import org.jboss.shrinkwrap.api.asset.Asset;
import org.jboss.shrinkwrap.api.asset.ByteArrayAsset;
import org.jboss.shrinkwrap.api.container.WebContainer;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.wildfly.testing.tools.xml.CloseableXMLStreamWriter;
import org.xml.sax.SAXException;
/**
* A utility to generate various deployment descriptors.
*
* @author James R. Perkins
*/
@SuppressWarnings("unused")
public class DeploymentDescriptors {
private DeploymentDescriptors() {
}
/**
* Adds a {@code jboss-deployment-structure.xml} file to a deployment with optional dependency additions or
* exclusions.
*
* @param archive the archive to add the {@code jboss-deployment-structure.xml} to
* @param addedModules the modules to add to an archive or an empty set
* @param excludedModules the modules to exclude from an archive or an empty set
* @param the archive type
*
* @return the archive
*/
public static & Archive> T addJBossDeploymentStructure(final T archive,
final Set addedModules, final Set excludedModules) {
return archive.addAsWebInfResource(createJBossDeploymentStructureAsset(addedModules, excludedModules),
"jboss-deployment-structure.xml");
}
/**
* Creates a {@code jboss-deployment-structure.xml} file with the optional dependency additions or exclusions.
*
* @param addedModules the modules to add or an empty set
* @param excludedModules the modules to exclude or an empty set
*
* @return a {@code jboss-deployment-structure.xml} asset
*/
public static Asset createJBossDeploymentStructureAsset(final Set addedModules, final Set excludedModules) {
return new ByteArrayAsset(createJBossDeploymentStructure(addedModules, excludedModules));
}
/**
* Creates a {@code jboss-deployment-structure.xml} file with the optional dependency additions or exclusions.
*
* @param addedModules the modules to add or an empty set
* @param excludedModules the modules to exclude or an empty set
*
* @return a {@code jboss-deployment-structure.xml} in a byte array
*/
public static byte[] createJBossDeploymentStructure(final Set addedModules, final Set excludedModules) {
try (
ByteArrayOutputStream out = new ByteArrayOutputStream();
CloseableXMLStreamWriter writer = CloseableXMLStreamWriter.of(out);) {
writer.writeStartDocument("utf-8", "1.0");
writer.writeStartElement("jboss-deployment-structure");
writer.writeStartElement("deployment");
if (!addedModules.isEmpty()) {
writer.writeStartElement("dependencies");
for (String module : addedModules) {
writer.writeEmptyElement("module");
writer.writeAttribute("name", module);
}
writer.writeEndElement();
}
if (!excludedModules.isEmpty()) {
writer.writeStartElement("exclusions");
for (String module : excludedModules) {
writer.writeEmptyElement("module");
writer.writeAttribute("name", module);
}
writer.writeEndElement();
}
writer.writeEndElement();
writer.writeEndElement();
writer.writeEndDocument();
writer.flush();
return out.toByteArray();
} catch (IOException | XMLStreamException e) {
throw new RuntimeException("Failed to create the jboss-deployment-structure.xml file.", e);
}
}
/**
* Creates a {@code jboss-web.xml} with the context root provided.
*
* @param contextRoot the context root to use for the deployment
*
* @return a {@code jboss-web.xml}
*/
public static Asset createJBossWebContextRoot(final String contextRoot) {
return createJBossWebXmlAsset(Map.of("context-root", contextRoot));
}
/**
* Creates a {@code jboss-web.xml} with the security domain for the deployment.
*
* @param securityDomain the security domain to use for the deployment
*
* @return a {@code jboss-web.xml}
*/
public static Asset createJBossWebSecurityDomain(final String securityDomain) {
return createJBossWebXmlAsset(Map.of("security-domain", securityDomain));
}
/**
* Creates a {@code jboss-web.xml} with simple attributes.
*
* @param elements the elements to add where the key is the element name and the value is the elements value
*
* @return a {@code jboss-web.xml}
*/
public static Asset createJBossWebXmlAsset(final Map elements) {
return new ByteArrayAsset(createJBossWebXml(elements));
}
/**
* Creates a {@code jboss-web.xml} with simple attributes.
*
* @param elements the elements to add where the key is the element name and the value is the elements value
*
* @return a {@code jboss-web.xml}
*/
public static byte[] createJBossWebXml(final Map elements) {
try (
ByteArrayOutputStream out = new ByteArrayOutputStream();
CloseableXMLStreamWriter writer = CloseableXMLStreamWriter.of(out);) {
writer.writeStartDocument("utf-8", "1.0");
writer.writeStartElement("jboss-web");
for (var element : elements.entrySet()) {
writer.writeStartElement(element.getKey());
writer.writeCharacters(element.getValue());
writer.writeEndElement();
}
writer.writeEndElement();
writer.writeEndDocument();
writer.flush();
return out.toByteArray();
} catch (IOException | XMLStreamException e) {
throw new RuntimeException("Failed to create the jboss-deployment-structure.xml file.", e);
}
}
/**
* Creates a new asset with the given contents for a {@code permissions.xml} file.
*
* @param permissions the permissions to add to the file
*
* @return an asset with the given contents for a {@code permissions.xml} file
*/
public static Asset createPermissionsXmlAsset(Permission... permissions) {
return new ByteArrayAsset(createPermissionsXml(permissions));
}
/**
* Creates a new asset with the given contents for a {@code permissions.xml} file.
*
* @param permissions the permissions to add to the file
* @param additionalPermissions any additional permissions to add to the file
*
* @return an asset with the given contents for a {@code permissions.xml} file
*/
public static Asset createPermissionsXmlAsset(final Iterable permissions,
final Permission... additionalPermissions) {
return new ByteArrayAsset(createPermissionsXml(permissions, additionalPermissions));
}
/**
* Creates a new asset with the given contents for a {@code permissions.xml} file.
*
* @param permissions the permissions to add to the file
*
* @return an asset with the given contents for a {@code permissions.xml} file
*/
public static Asset createPermissionsXmlAsset(final Iterable permissions) {
return new ByteArrayAsset(createPermissionsXml(permissions));
}
/**
* Creates a new asset with the given contents for a {@code permissions.xml} file.
*
* @param permissions the permissions to add to the file
*
* @return an asset with the given contents for a {@code permissions.xml} file
*/
public static byte[] createPermissionsXml(Permission... permissions) {
return createPermissionsXml(List.of(permissions));
}
/**
* Creates a new asset with the given contents for a {@code permissions.xml} file.
*
* @param permissions the permissions to add to the file
* @param additionalPermissions any additional permissions to add to the file
*
* @return an asset with the given contents for a {@code permissions.xml} file
*/
public static byte[] createPermissionsXml(final Iterable permissions,
final Permission... additionalPermissions) {
final Set allPermissions = new LinkedHashSet<>();
permissions.forEach(permission -> allPermissions.add(PermissionDescription.of(permission)));
allPermissions.addAll(Stream.of(additionalPermissions)
.map(PermissionDescription::of)
.collect(Collectors.toSet()));
return createPermissionsXml(allPermissions);
}
/**
* Creates a new asset with the new permissions appended to the current permissions. Note that duplicates will not
* be added. A duplicates is considered a {@link Permission} with the same {@linkplain Class#getName() class name},
* same {@linkplain Permission#getName() name} and same {@linkplain Permission#getActions() actions}.
*
* @param currentPermissions the current permissions, must be valid XML content
* @param permissions the permissions to add
*
* @return a new asset to replace the current {@code permissions.xml} file
*/
public static Asset appendPermissions(final Asset currentPermissions, final Permission... permissions) {
final Set orderedPermissions = new LinkedHashSet<>();
Collections.addAll(orderedPermissions, permissions);
return appendPermissions(currentPermissions, orderedPermissions);
}
/**
* Creates a new asset with the new permissions appended to the current permissions. Note that duplicates will not
* be added. A duplicates is considered a {@link Permission} with the same {@linkplain Class#getName() class name},
* same {@linkplain Permission#getName() name} and same {@linkplain Permission#getActions() actions}.
*
* @param currentPermissions the current permissions, must be valid XML content
* @param permissions the permissions to add
*
* @return a new asset to replace the current {@code permissions.xml} file
*/
public static Asset appendPermissions(final Asset currentPermissions, final Iterable permissions) {
final Set allPermissions = new LinkedHashSet<>();
try {
final DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
final DocumentBuilder builder = factory.newDocumentBuilder();
try (InputStream in = currentPermissions.openStream()) {
final Document doc = builder.parse(in);
final Element root = doc.getDocumentElement();
final NodeList xmlPermissions = root.getElementsByTagName("permission");
for (int i = 0; i < xmlPermissions.getLength(); i++) {
final Node permission = xmlPermissions.item(i);
String className = null;
String name = null;
String actions = null;
if (permission.hasChildNodes()) {
final NodeList children = permission.getChildNodes();
for (int j = 0; j < children.getLength(); j++) {
final Node child = children.item(j);
if (child.getNodeType() == Node.ELEMENT_NODE) {
if (child.getNodeName().equals("class-name")) {
className = child.getTextContent();
} else if (child.getNodeName().equals("name")) {
name = child.getTextContent();
} else if (child.getNodeName().equals("actions")) {
actions = child.getTextContent();
}
}
}
}
if (className != null) {
allPermissions.add(new PermissionDescription(className, name, actions));
}
}
}
} catch (ParserConfigurationException | SAXException | IOException e) {
throw new RuntimeException("Failed to append permissions.xml file.", e);
}
permissions.forEach(p -> allPermissions.add(PermissionDescription.of(p)));
return new ByteArrayAsset(createPermissionsXml(allPermissions));
}
/**
* This should only be used as a workaround for issues with API's where something like a
* {@link java.util.ServiceLoader} needs access to an implementation.
*
* Adds file permissions for every JAR in the modules directory. The {@code module.jar.path} system property
* must be set.
*
*
* @param moduleNames the module names to add file permissions for
*
* @return a collection of permissions required
*/
public static Collection addModuleFilePermission(final String... moduleNames) {
final String value = System.getProperty("module.jar.path");
if (value == null || value.isBlank()) {
return Collections.emptySet();
}
// Get the module path
final Path moduleDir = Path.of(value);
final Collection result = new ArrayList<>();
for (String moduleName : moduleNames) {
final Path definedModuleDir = moduleDir.resolve(moduleName.replace('.', File.separatorChar))
.resolve("main");
// Find all the JAR's
try (Stream stream = Files.walk(definedModuleDir)) {
stream
.filter((path) -> path.getFileName().toString().endsWith(".jar"))
.map((path) -> new FilePermission(path.toAbsolutePath().toString(), "read"))
.forEach(result::add);
} catch (IOException e) {
throw new UncheckedIOException(e);
}
}
return result;
}
/**
* Creates the permissions required for the {@code java.io.tmpdir}. This adds permissions to read the directory, then
* adds permissions for all files and subdirectories of the temporary directory. The actions are used for the latter
* permission.
*
* @param actions the actions required for the temporary directory
*
* @return the permissions required
*/
public static Collection createTempDirPermission(final String actions) {
String tempDir = System.getProperty("java.io.tmpdir");
// This should never happen, but it's a better error message than an NPE
if (tempDir.charAt(tempDir.length() - 1) != File.separatorChar) {
tempDir += File.separatorChar;
}
return List.of(new FilePermission(tempDir, "read"), new FilePermission(tempDir + "-", actions));
}
private static void addPermissionXml(final XMLStreamWriter writer,
final Iterable permissions)
throws XMLStreamException {
for (PermissionDescription permission : permissions) {
writer.writeStartElement("permission");
writer.writeStartElement("class-name");
writer.writeCharacters(permission.className);
writer.writeEndElement();
writer.writeStartElement("name");
writer.writeCharacters(permission.name);
writer.writeEndElement();
final String actions = permission.actions;
if (actions != null && !actions.isEmpty()) {
writer.writeStartElement("actions");
writer.writeCharacters(actions);
writer.writeEndElement();
}
writer.writeEndElement();
}
}
private static byte[] createPermissionsXml(final Set permissions) {
try (
ByteArrayOutputStream out = new ByteArrayOutputStream();
CloseableXMLStreamWriter writer = CloseableXMLStreamWriter.of(out);) {
writer.writeStartDocument("utf-8", "1.0");
writer.writeStartElement("permissions");
writer.writeNamespace(null, "https://jakarta.ee/xml/ns/jakartaee");
writer.writeAttribute("version", "10");
addPermissionXml(writer, permissions);
writer.writeEndElement();
writer.writeEndDocument();
writer.flush();
return out.toByteArray();
} catch (IOException | XMLStreamException e) {
throw new RuntimeException("Failed to create the permissions.xml file.", e);
}
}
private static class PermissionDescription {
private final String className;
private final String name;
private final String actions;
private PermissionDescription(final String className, final String name, final String actions) {
this.className = className;
this.name = name;
this.actions = actions;
}
static PermissionDescription of(final Permission permission) {
return new PermissionDescription(permission.getClass()
.getName(), permission.getName(), permission.getActions());
}
@Override
public boolean equals(final Object obj) {
if (this == obj) {
return true;
}
if (!(obj instanceof PermissionDescription)) {
return false;
}
final PermissionDescription other = (PermissionDescription) obj;
return Objects.equals(className, other.className)
&& Objects.equals(name, other.name)
&& Objects.equals(actions, other.actions);
}
@Override
public int hashCode() {
return Objects.hash(className, name, actions);
}
@Override
public String toString() {
return "PermissionDescription[className=" + className + ", name=" + name + ", actions=" + actions + "]";
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy