Before putting any application out for public access, it’s always worth testing that it works how you expect it to (and also how you don’t expect it to!). Effective testing of applications is something you can spend a week being taught, but for this blog I’ll just cover the basics of running JUnit and TestNG tests against Payara Server using Arquillian.
Arquillian is a testing platform that can be used to perform unit, functional, and integration tests of applications being deployed to Java Application Servers. You can find more information on what it can be used for on their website here.
Arquillian is probably easiest to integrate into your projects using Maven, a build dependency tool used in many projects – Payara Server included!
In your Maven POM, include the following dependencies, excluding the JUnit or TestNG dependency as per your preference or requirements:
If you’re not using Maven though, you can still find and download the artefact libraries from Maven Central manually here.
If you don’t already have it included in your tests, you’ll also need to include the Java EE API in your dependencies. This can have its scope set to provided, as Payara Server will have the required implementation:
The last thing to set up is your container, namely Payara Server. Include the following dependencies in your POM for testing against an Embedded Payara Server instance:
Or instead just include the following dependency if you want to test your applications against a remote Payara Server instance (as in, a standalone Payara Server instance that you’ve started yourself):
Running your Tests against Payara Server
To run tests with Arquillian against Payara Server, test classes must be annotated with
@RunWith(Arquillian.class) or extend the
Arquillian class (
public class x extends Arquillian) for JUnit or TestNG tests respectively, and have a method annotated with
@Deployment to create and deploy a test archive.
Arquillian uses test archives to specify the classes and resources required for the test to deploy and run. These test archives use the ShrinkWrap API to define a JAR, WAR, or EAR deployment, allowing your tests to range from basic unit tests, to complicated integration and functional tests.
Then you just need to annotate your test methods with
@Test or @Test() for JUnit or TestNG respectively, and run them!
To help put things into context, I’ll demonstrate a very basic test using TestNG, Maven, and embedded Payara Server (I’ll assume you already know how to create a Maven project, otherwise check out Maven’s documentation: https://maven.apache.org/guides/getting-started/). First, fill out your POM with the required dependencies I described before so it looks like this:
Next, you need an application to test. Below is a basic application containing just a single method:
Then, you need a test class. This test class simply creates the deployment for Arquillian, and checks that the message being returned by the sayHello() method is correct:
And finally, you can then run the test with one command: mvn clean test
This will compile your application and test, before starting an embedded Payara Server instance, deploying it, and running the test method.
Hopefully this should give you enough of a start to begin running your own tests against Payara Server. If you still need some extra help though, the Arquillian website hosts some decent guides which covers what I have, and then some.