Smack's Integration Test Framework
Smack's Integration Test Framework is used to run a set of tests against a real XMPP service. The framework discovers on start-up the available tests by reflection.
You can run the framework against an XMPP service with
$ gradle integrationTest -Dsinttest.service=my.xmppservice.org
Note that the service needs to have In-Band Registration (IBR) enabled.
A better alternative to IBR is using XEP-0133: Service Administration to create the throw away accounts used by the integration test framework. Simply use
$ gradle integrationTest -Dsinttest.service=my.xmppservice.org \ -Dsinttest.adminAccountUsername=admin \ -Dsinttest.adminAccountPassword=aeR0Wuub
to run Smack's integration test framework against
with an admin account named
aeR0Wuub as password.
The framework is configured with a standard Java properties file.
This file simply contains key/value pairs, which are separated by an equals sign ("=").
The most important configuration value is the
service value, it's also the only required setting.
The file properties can be overridden with Java system properties.
The name of a system property that is used by the framework needs to be prefixed with
sinttest. (Smack Integration Test Framework).
For example the
service property becomes
Minimal example properties file
Another example properties file
service=example.org serviceTlsPin=CERTSHA256:2F:92:C9:4D:30:58:E1:05:21:9A:57:59:5F:6E:25:9A:0F:BF:FF:64:1A:C3:4B:EC:06:7D:4A:6F:0A:D5:21:85 debugger=console
|service||XMPP service to run the tests on|
|serviceTlsPin||TLS Pin (used by java-pinning)|
|securityMode||Either 'required' or 'disabled'|
|adminAccountUsername||Username of the XEP-0133 Admin account|
|adminAccountPassword||Password of the XEP-0133 Admin account|
|accountOneUsername||Username of the first XMPP account|
|accountOnePassword||Password of the first XMPP account|
|accountTwoUsername||Username of the second XMPP account|
|accountTwoPassword||Password of the second XMPP account|
|accountThreeUsername||Username of the third XMPP account|
|accountThreePassword||Password of the third XMPP account|
|debugger||'console' for console debugger, 'enhanced' for the enhanced debugger|
|enabledTests||List of enabled tests|
|disabledTests||List of disabled tests|
|defaultConnection||Nickname of the default connection|
|enabledConnections||List of enabled connection's nicknames|
|disabledConnections||List of disabled connection's nicknames|
|testPackages||List of packages with tests|
|dnsResolver||One of 'minidns', 'javax' or 'dnsjava'. Defaults to 'minidns'.|
Where to place the properties file
The framework will first load the properties file from
Running selected tests only
enabledTests is is possible to run only selected tests. The
tests can be selected on a per class base or by specifying concrete
test methods. In the latter case, the methods must be qualified by a
(simple) class name.
$ gradle integrationTest -Dsinttest.enabledTests=SoftwareInfoIntegrationTest.test
will only run the
test() method of
$ gradle integrationTest -Dsinttest.enabledTests=SoftwareInfoIntegrationTest
would run all tests defined in the
Overview of the components
public static void main method, i.e. the entry point for the framework.
Here the available integration tests are discovered by means of reflection, the configuration is read and a
IntegrationTestEnvironment instance created, which includes the XMPPConnections.
The base class that integration tests need to subclass.
Allows low level integration test, i.e. every test method will have its own exclusive XMPPTCPConnection instances.
AbstractSmackLowLevelIntegrationTest on its own
XMPPConnection instances, but is limited to a particular type of
The environment, e.g. the
XMPPConnections provided to the integration tests by the framework. Note that for convenience
AbstractSmackIntegrationTest contains some of those as protected members.
An annotation that needs to be added to all methods that represent a single integration test. Annotated integration test methods must not take any arguments (i.e. their parameter count is 0), and should return void as it's not evaluated in any way. The methods are supposed to throw an exception if their integration test fails.
Can be thrown by test methods or constructors to signal that their test is not possible, e.g. because the service does not support the required feature.
Running the integration tests
Smack's Gradle build system is configured with a special task called
integrationTest, which means you can run the tests simply with
$ gradle integrationTest -Dsinttest.service=my.xmppservice.org
If one of
accountTwoPassword is not configured, then the framework will automatically create the accounts on the service. Of course this requires account registration (IBR) to be enabled.
If the accounts got created automatically by the framework, then they will also be deleted at the end of the test.
Implementing Integration Tests
Create a new class which extends
Every non-static method, including the constructor, of this class will have two XMPPConnections available to perform the integration tests with:
You can use the constructor to check if the XMPP service does provide the required XMPP feature.
If it does not, simply throw a
Test methods must be
public, take zero arguments i.e. declare no parameters and be annoated with
If the test method is not able to perform a test then it should throw a
Rules for integration tests
Tests should not leave any traces on the service if they are finished, i.e. the service state at the end of the test must be equal to the state of the beginning. It must be possible to run the tests in parallel.
Why are there two mechanisms to signal that the test is not possible?
Because the XMPP service may provide a component that is required to perform a certain integration test, but that component may not support all features. For example, the XMPP service may provides a PubSub (XEP-0060) component, but this component may not support all features of XEP-0060.
Low-Level Integration Tests
Classes that implement low-level integration tests need to sublcass
The test methods can declare as many parameters as they need to, but every parameter must be of type
The framework will automatically create, register and login the connections.
After the test is finished, the connections will be unregistered with the XMPP service and terminated.
Debugging Integration Tests
A test, like any other code, may not be perfect on the first attempt, and you may require more information in order to ascertain quite what's wrong.
Smack Debugger options
As listed in the main Smack Debugging doc, there are two built-in debuggers that could surface you more information. Using the 'enhanced' debugger config option listed above, you'll get the Smack Debug Window launching when your tests launch, and you'll get a stanza-by-stanza account of what happened on each connection, hopefully enough to diagnose what went wrong.
Debugging in the IDE
If the output isn't enough, you may need to debug and inspect running code within the IDE. Depending on the IDE, in order to get execution to pause at your breakpoints, you may need to switch your configuration. Instead of running
gradle integrationTest, instead run the
SmackIntegrationTestFramework class directly with the same command-line options.
Running your own integration tests
The framework can be used to run your own tests residing outside of the framework's default package scope.
Simply set the
testPackages property to a comma separated list of package names where the framework should look for integration tests.
$ gradle integrationTest -Dsinttest.service=my.xmppserivce.org -Dsinttest.testPackages=org.mypackage,org.otherpackage