atlas-integration-test

This page describes the shell script atlas-integration-test, part of the Atlassian Plugin SDK.

Basic Usage

atlas-integration-test [options] – Runs the integration tests for the plugin. (Runs mvn integration-test.) Interpreted parameters: version, container, http-port, context-path, server, jvmargs, log4j, test-version, sal-version, rest-version, plugins,lib-plugins, bundled-plugins, product, no-webapp, skip-tests.

Parameters

This shell script supports some interpreted parameters, specified below. All other parameters are passed straight through to Maven.

Explaining the table columns:

  • 'Full Parameter' and 'Shortened' – Some parameters allow you to choose a full or a shortened version of the parameter, others just support the full version.
  • 'Accepts a Value?' – 'Yes' means that you should specify a value in addition to the parameter, e.g. for the 'version' parameter you should specify the version number. 'No' means that the parameter does not accept a value.

Interpreted parameters:

Full Parameter

Description

--version

Version of the application to run. Default is RELEASE. Examples:

  • 3.1
  • 3.1-m7

Shortened: -v

--container

Container to run in. Default is tomcat6x. Other available values are tomcat5x, resin3x and jboss42x.

Shortened: -c

--http-port

HTTP port for the servlet container. The defaults are as described in the SDK overview. You may need to change this if you already have a process listed for the default port, such as when you want to bring up two instances of Confluence.

Shortened: -p

--context-path

The
application context path. You will need to include the leading forward
slash. For example, if your application is running at {{

http://localhost:1990/confluence

}} then you should enter /confluence.
To run your application in the root web application context (eg. {{

http://localhost:1990

}}), then you should enter ROOT.

--server

Host name of the application server. The default is localhost.

--jvmargs

Additional JVM arguments if required.

--log4j

Log4j properties file.

--test-version

Version to use for test resources. Default is LATEST.

--sal-version

Version of SAL (Shared Access Layer) to use.

--rest-version

Version of the Atlassian REST module to use.

--plugins

A list of plugin artifacts, separated by commas, in the form GROUP_ID:ARTIFACT_ID:VERSION. Version is optional. Default is LATEST. These plugins will be installed into your local version of your plugin's host application.

--lib-plugins

A list of lib artifacts, separated by commas, in the form GROUP_ID:ARTIFACT_ID:VERSION. Version is optional. Default is LATEST. Use this to add additional JARs into your /lib folder.

--bundled-plugins

A list of bundled plugin artifacts, separated by commas, in the form GROUP_ID:ARTIFACT_ID:VERSION. Version is optional. Default is LATEST.These plugins will be loaded as bundled plugins in your local version of your plugin's host application.

--product

The application to launch with the plugin. You might use this if your plugin is written for one application (as specified in the POM) but you want to install the plugin into another application.

--no-webapp

If this parameter is present, then the script will not start up the plugin's host application.

--skip-tests

If this parameter is present, the script will not execute the unit or integration tests.

--no-webapp and --skip-tests don't accept a value.

Getting Help

The shell script will display some help text if you enter one of the following as the first argument:

  • -?
  • -h
  • help
  • -help
  • --help

For example:

atlas-integration-test -?
atlas-integration-test -help

Examples

You can run your integration tests against a different application. Say you have a RefApp plugin but want to run your integration tests against Confluence:

atlas-integration-test --product confluence
RELATED TOPICS

Atlassian Plugin SDK Documentation
Plugin Testing Resources and Discussion

Was this page helpful?
Powered by Confluence and Scroll Viewport