The Buttso Blathers: Bare-Bones Example of Using WebLogic and Arquillian

The Arquillian project is proving to be very popular for testing code and applications. It's particularly useful for Java EE projects since it allows for in-container testing to be performed, enabling unit tests to use dependency injection and all the common services provided by the Java EE platform.

Arquillian uses the concept of container adapters to allow it to execute test code with a specific test environment. For the Java EE area, most of the Java EE implementations have an adapter than can be used to perform the deployment of the archive under test and to execute and report on the results of the unit tests.

A handy way to see all the WebLogic Server related content on the Arquillian blog is this URL: http://arquillian.org/blog/tags/wls/

For WebLogic Server the current set of adapters are listed here: http://arquillian.org/blog/2015/01/09/arquillian-container-wls-1-0-0-Alpha3/

There are multiple adapters available for use. Some of them are historical and some are for use with older versions of WebLogic Server (10.3).

We are actively working with the Arquillian team on finalizing the name, version and status of a WebLogic Server adapter.

The preferred adapter set from the WebLogic Server perspective are these:

These adapters utilize the WebLogic Server JMX API to perform their tasks and are the adapters used internally by the development teams when working with Arquillian. They have been tested to work with WebLogic Server [12.1.1, 12.1.2, 12.1.3]. We also have been using them internally with the 12.2.1 version under development to run the CDI TCK and other tests.

To demonstrate WebLogic Server working with Arquillian a bare-bones example is available on GitHub here: https://github.com/buttso/weblogic-with-arquillian

This example has the most basic configuration you can use to employ Arquillian with a Maven project to deploy and execute tests using WebLogic Server 12.1.3.

The README.md file in the project contains more details and a longer description. In summary though:

1. The first step is to add the Arquillian related dependencies in the Maven pom.xml:


	<project>
	...
	<dependencyManagement>
	<dependencies>
	<dependency>
	<groupId>org.jboss.arquillian</groupId>
	<artifactId>arquillian-bom</artifactId>
	<version>1.1.5.Final</version>
	<scope>import</scope>
	<type>pom</type>
	</dependency>
	</dependencies>
	</dependencyManagement>

	<dependencies>
	...
	<!-- ###################################### -->
	<!-- #### Arquillian Test Dependencies ### -->
	<!-- ###################################### -->
	<dependency>
	<groupId>org.jboss.arquillian.junit</groupId>
	<artifactId>arquillian-junit-container</artifactId>
	<scope>test</scope>
	</dependency>
	<dependency>
	<groupId>org.jboss.arquillian.container</groupId>
	<artifactId>arquillian-wls-remote-12.1.2</artifactId>
	<version>1.0.0.Alpha3</version>
	<scope>test</scope>
	</dependency>
	</dependencies>

	...
	</project>

view raw weblogic-with-arquillian-pom.xml hosted with ❤ by GitHub

2. The next step is to create an arquillian.xml file that the container adapter uses to connect to the remote server that is being used as the server to run the tests:

	<?xml version="1.0"?>
	<arquillian
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xmlns="http://jboss.org/schema/arquillian"
	xsi:schemaLocation="http://jboss.org/schema/arquillian
	http://jboss.org/schema/arquillian/arquillian_1_0.xsd">
	<!--
	<engine>
	<property name="deploymentExportPath">target/</property>
	</engine>
	-->

	<container qualifier="weblogic" default="true">
	<defaultProtocol type="Servlet 3.0" />
	<configuration>
	<property name="wlHome">/Users/sbutton/Oracle/Middleware/wlserver</property>
	<property name="adminUrl">t3://localhost:7001</property>
	<property name="adminUserName">weblogic</property>
	<property name="adminPassword">welcome1</property>
	<property name="target">AdminServer</property>
	</configuration>
	</container>
	</arquillian>

view raw weblogic-with-arquillian-arquillian.xml hosted with ❤ by GitHub

3. The last step is to create a unit test which is run with Arquillian. The unit test is responsible for implementing the @Deployment method which constructs an archive to deploy that contains the code to be tested. The unit test then provides @Test methods in which the deployment is tested to verify its behaviour:

	package buttso.demo.weblogic.wlsarq;

	import com.gargoylesoftware.htmlunit.WebClient;
	import com.gargoylesoftware.htmlunit.html.HtmlPage;
	import java.net.URL;
	import java.util.logging.Logger;
	import org.jboss.arquillian.container.test.api.Deployment;
	import org.jboss.arquillian.container.test.api.RunAsClient;
	import org.jboss.arquillian.junit.Arquillian;
	import org.jboss.arquillian.test.api.ArquillianResource;
	import org.jboss.shrinkwrap.api.ShrinkWrap;
	import org.jboss.shrinkwrap.api.spec.WebArchive;
	import org.junit.Assert;
	import org.junit.Test;
	import org.junit.runner.RunWith;

	/**
	* Test case to perform simple verifications of the
	* index.html that is included as part of the @Deployment
	*
	* @author sbutton
	*/
	@RunWith(Arquillian.class)
	public class IndexPageTest {

	private static final Logger LOG = Logger.getLogger(IndexPageTest.class.getName());
	private static final int INDEX_PAGE_LINE_COUNT = 15;
	private static final String INDEX_PAGE_TITLE = "wlsarq";

	@Deployment
	public static WebArchive createDeployment() {
	WebArchive war = ShrinkWrap.create(WebArchive.class)
	.addAsWebResource("index.html");
	return war;
	}

	@Test
	@RunAsClient
	public void test_index_page_present(@ArquillianResource URL testURL) {

	LOG.info("Testing deployment @ " + testURL);

	WebClient webClient = null;
	try {
	webClient = new WebClient();
	HtmlPage page = webClient.getPage(testURL);
	Assert.assertTrue("Line count doesn't match", INDEX_PAGE_LINE_COUNT == page.getEndLineNumber());
	} catch (Exception e) {
	// Swallow me whole
	} finally {
	webClient.closeAllWindows();
	}
	}

	@Test
	@RunAsClient
	public void test_index_title(@ArquillianResource URL testURL) {

	LOG.info("Testing deployment @ " + testURL);

	WebClient webClient = null;

	try {
	webClient = new WebClient();
	final HtmlPage page = webClient.getPage(testURL);
	Assert.assertEquals(INDEX_PAGE_TITLE, page.getTitleText());
	} catch (Exception e) {
	// Swallowed, doh!
	} finally {
	webClient.closeAllWindows();
	}
	}
	}

view raw weblogic-with-arquillian - index_page_test.java hosted with ❤ by GitHub

Executing the unit tests, with the associated archive creation and deployment to the server is performed using the maven test goal:

	[sbutton] wlsarq $ mvn test
	[INFO] Scanning for projects...
	[INFO]
	[INFO] ------------------------------------------------------------------------
	[INFO] Building wlsarq 1.0
	[INFO] ------------------------------------------------------------------------
	[INFO]
	[INFO] --- maven-resources-plugin:2.6:resources (default-resources) @ wlsarq ---
	[INFO] Using 'UTF-8' encoding to copy filtered resources.
	[INFO] Copying 0 resource
	[INFO]
	[INFO] --- maven-compiler-plugin:2.3.2:compile (default-compile) @ wlsarq ---
	[INFO] Nothing to compile - all classes are up to date
	[INFO]
	[INFO] --- maven-resources-plugin:2.6:testResources (default-testResources) @ wlsarq ---
	[INFO] Using 'UTF-8' encoding to copy filtered resources.
	[INFO] Copying 1 resource
	[INFO] Copying 1 resource
	[INFO]
	[INFO] --- maven-compiler-plugin:2.3.2:testCompile (default-testCompile) @ wlsarq ---
	[INFO] Nothing to compile - all classes are up to date
	[INFO]
	[INFO] --- maven-surefire-plugin:2.18:test (default-test) @ wlsarq ---
	[INFO] Surefire report directory: /Users/sbutton/Projects/Java/weblogic-with-arquillian/wlsarq/target/surefire-reports

	-------------------------------------------------------
	T E S T S
	-------------------------------------------------------
	Running buttso.demo.weblogic.wlsarq.IndexPageTest
	Feb 02, 2015 11:34:08 PM buttso.demo.weblogic.wlsarq.IndexPageTest test_index_page_present
	INFO: Testing deployment @ http://192.168.0.13:7001/f6a033f4-07a9-462b-8e0b-2946dd19d577/
	Feb 02, 2015 11:34:09 PM buttso.demo.weblogic.wlsarq.IndexPageTest test_index_title
	INFO: Testing deployment @ http://192.168.0.13:7001/f6a033f4-07a9-462b-8e0b-2946dd19d577/
	Tests run: 2, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 3.201 sec - in buttso.demo.weblogic.wlsarq.IndexPageTest
	Running buttso.demo.weblogic.wlsarq.PingPongBeanTest
	Tests run: 1, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 0.975 sec - in buttso.demo.weblogic.wlsarq.PingPongBeanTest

	Results :

	Tests run: 3, Failures: 0, Errors: 0, Skipped: 0

	[INFO] ------------------------------------------------------------------------
	[INFO] BUILD SUCCESS
	[INFO] ------------------------------------------------------------------------
	[INFO] Total time: 6.772 s
	[INFO] Finished at: 2015-02-02T23:34:11+10:30
	[INFO] Final Memory: 12M/331M
	[INFO] ------------------------------------------------------------------------

view raw weblogic-with-arquillian - test execution hosted with ❤ by GitHub

The tests can be executed directly from IDEs such as NetBeans and Eclipse using the Run Test features:

Executing Tests using NetBeans

The Buttso Blathers

04 February 2015

Bare-Bones Example of Using WebLogic and Arquillian

No comments: