gitter-badger / atam4j

Acceptance Tests As Monitors

atam4j

Acceptance Tests As Monitors

• A simple library that allows you to run junit tests as monitoring checks.
• Runs tests on a schedule and exposes results via a restful api that can called from your monitoring (e.g. nagios, zabbix, icinga, pingdom etc etc)

Latest Build Status

Maven Dependency

<dependency>    
   <groupId>me.atam</groupId>    
   <artifactId>atam4j</artifactId>    
   <version>0.2.0</version>    
</dependency>

Using atam4j

1. Include the atam4j maven dependency.

2. Write Junit based tests in the usual manner, with the exception of including them in the main application classpath instead of the tests classpath. This can be done by including them in the src/main/java directory instead of the src/test/java directory.

3. Instantiate the AcceptanceTestHealthCheckManager in the run method of your dropwizard application class.

new AcceptanceTestHealthCheckManager(environment, TEN_MINUTES_IN_SECONDS, HelloWorldTest.class).initialise();

4. Run the dropwizard app and observe the status of the acceptnace tests reported under the health-check endpoint.

Refer to atam4j-sample-app for a complete working example.

Available Versions

Snapshots

https://oss.sonatype.org/content/repositories/snapshots/me/atam/atam4j/

Releases

Look for non-snapshot version https://oss.sonatype.org/content/groups/public/me/atam/atam4j/

Developing atam4j

Build and Release

Building Locally

mvn clean install

Running Tests using Maven CLI

mvn clean test

Release - Manual

Prerequisite

Only core committers can release atam4j to maven central. You need Sonatype Nexus OSS account info for atam.me.

Steps

1. Set version of the release

mvn versions:set -DnewVersion=${versionNumber}

2. Commit the version back to git and push to remote

git commit -a -m "Preparing release v${versionNumber}"
git push

3. Tag code

git tag -a v${versionNumber} -m 'version ${versionNumber}’ git push origin v${versionNumber}

4. Create release in Github - https://github.com/atam4j/atam4j/releases

5. Deploy to maven central

mvn clean deploy