org.jboss.cdi.tck.shrinkwrap.ee.EnterpriseArchiveBuilder Maven / Gradle / Ivy
/*
* JBoss, Home of Professional Open Source
* Copyright 2010, Red Hat, Inc., and individual contributors
* by the @authors tag. See the copyright.txt in the distribution for a
* full listing of 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.jboss.cdi.tck.shrinkwrap.ee;
import org.jboss.cdi.tck.TestGroups;
import org.jboss.cdi.tck.shrinkwrap.ArchiveBuilder;
import org.jboss.shrinkwrap.api.ShrinkWrap;
import org.jboss.shrinkwrap.api.asset.StringAsset;
import org.jboss.shrinkwrap.api.spec.EnterpriseArchive;
import org.jboss.shrinkwrap.api.spec.JavaArchive;
import org.jboss.shrinkwrap.api.spec.WebArchive;
import org.jboss.shrinkwrap.descriptor.api.Descriptors;
import org.jboss.shrinkwrap.descriptor.api.spec.se.manifest.ManifestDescriptor;
/**
* ShrinkWrap {@link EnterpriseArchive} builder for CDI TCK Arquillian test. This builder is intended to provide basic
* functionality covering common TCK needs. Use shrinkwrap API to adapt archive to advanced scenarios.
*
* Test classes are added to EJB module.
*
* Default and custom web module
*
* The default web module is defined in order to build portable EE archive - it has to contain Class-Path entry in the
* MANIFEST.MF to state module dependency (see Class Loading Requirements in Java EE spec). Custom web module is not supported
* directly however its possible to build such module with shrinkwrap API and add it to final enterprise archive. It is
* necessary to omit default web module using {@link #noDefaultWebModule()} as long as custom web module is used since
* arquillian cannot handle in-container test packaged as EAR with multiple web modules at the moment (cannot determine which
* web module to enrich).
*
* application.xml
*
* The application.xml descriptor is not supported as it is no longer required (Java EE 5, Java EE 6). Use
* shrinkwrap API to add custom application.xml descriptor.
*
* Use case
*
* Use enterprise archive in TCK tests only while:
*
*
* - explicitly testing EAR structure
* - testing Java EE full profile (e.g. EJB timer service, MDBs)
*
*
* Tests that use {@link EnterpriseArchiveBuilder} must belong to {@link TestGroups#JAVAEE_FULL} group.
*
*
* @author Martin Kouba
*/
public class EnterpriseArchiveBuilder extends ArchiveBuilder {
public static final String DEFAULT_APP_VERSION = "6";
public static final String DEFAULT_EAR_NAME = "test.ear";
public static final String DEFAULT_EJB_MODULE_NAME = "test-ejb.jar";
private boolean hasDefaultWebModule = true;
private String ejbModuleName = null;
/**
* Do not add default web module.
*
* @return self
*/
public EnterpriseArchiveBuilder noDefaultWebModule() {
this.hasDefaultWebModule = false;
return self();
}
public EnterpriseArchiveBuilder withEjbModuleName(String ejbModuleName) {
this.ejbModuleName = ejbModuleName;
return self();
}
@Override
public EnterpriseArchiveBuilder self() {
return this;
}
@Override
protected EnterpriseArchive buildInternal() {
EnterpriseArchive enterpriseArchive = null;
if (getName() == null) {
// Let arquillian generate archive name in order to avoid reload issues in AS7 (AS7-1638)
// enterpriseArchive = ShrinkWrap.create(EnterpriseArchive.class, DEFAULT_EAR_NAME);
String hash = getSha1OfTestClass();
if (hash != null) {
enterpriseArchive = ShrinkWrap.create(EnterpriseArchive.class, hash + ".ear");
} else {
enterpriseArchive = ShrinkWrap.create(EnterpriseArchive.class);
}
} else {
enterpriseArchive = ShrinkWrap.create(EnterpriseArchive.class, getName());
}
// EJB module - contains test package
JavaArchive ejbArchive = null;
if (ejbModuleName == null) {
ejbArchive = ShrinkWrap.create(JavaArchive.class, DEFAULT_EJB_MODULE_NAME);
} else {
ejbArchive = ShrinkWrap.create(JavaArchive.class, ejbModuleName);
}
// CDITCK-56
ejbArchive.addClass(DummySessionBean.class);
processPackages(ejbArchive);
processClasses(ejbArchive);
processManifestResources(ejbArchive);
processResources(ejbArchive);
processLibraries(enterpriseArchive);
// Deployment descriptors
if (includeBeansXml) {
ejbArchive.addAsManifestResource(getBeansDescriptorAsset(), getBeansDescriptorTarget());
}
if (persistenceDescriptor != null) {
ejbArchive.addAsManifestResource(new StringAsset(persistenceDescriptor.exportAsString()), "persistence.xml");
}
if (ejbJarDescriptor != null) {
ejbArchive.addAsManifestResource(new StringAsset(ejbJarDescriptor.exportAsString()), "ejb-jar.xml");
} else if (ejbJarXml != null) {
ejbArchive.addAsManifestResource(ejbJarXml.getSource(), ejbJarXml.getTarget());
}
enterpriseArchive.addAsModule(ejbArchive);
// Default web module
if (this.hasDefaultWebModule) {
WebArchive webArchive = ShrinkWrap.create(WebArchive.class).setManifest(
new StringAsset(Descriptors.create(ManifestDescriptor.class)
.addToClassPath(getName() != null ? getName() : DEFAULT_EJB_MODULE_NAME).exportAsString()));
enterpriseArchive.addAsModule(webArchive);
}
return enterpriseArchive;
}
}