This module, intended for use with Apache Isis, provides a set of testing utilities to support unit testing.
How to configure/use
You can either use this module "out-of-the-box", or you can fork this repo and extend to your own requirements.
To use "out-of-the-box":
update your classpath by adding this dependency in your dom project’s
<dependency> <groupId>org.incode.module.unittestsupport</groupId> <artifactId>incode-module-unittestsupport-dom</artifactId> <version>1.14.0</version> <scope>test</scope> </dependency>
Check for later releases by searching Maven Central Repo.
If you want to use the current
-SNAPSHOT, then the steps are the same as above, except:
when updating the classpath, specify the appropriate -SNAPSHOT version:
add the repository definition to pick up the most recent snapshot (we use the Cloudbees continuous integration service). We suggest defining the repository in a
<profile> <id>cloudbees-snapshots</id> <activation> <activeByDefault>true</activeByDefault> </activation> <repositories> <repository> <id>snapshots-repo</id> <url>http://repository-estatio.forge.cloudbees.com/snapshot/</url> <releases> <enabled>false</enabled> </releases> <snapshots> <enabled>true</enabled> </snapshots> </repository> </repositories> </profile>
1.14.0- released against Isis 1.14.0
1.13.4- fixes #4 - new
1.13.3- fixes #3 - moving assertions and matchers out from Estatio’s EstatioIntegrationTestAbstract base class
1.13.2- fixes #2 - moving further contract tests from incode-module-base into this repo
1.13.1- fixes #1 - moving contract tests from incode-module-base into this repo
1.13.0- released against Isis 1.13.0 (copied from incode-module-base)
Forking the repo
If instead you want to extend this module’s functionality, then we recommend that you fork this repo. The repo is structured as follows:
pom.xml- parent pom
dom- the module implementation, depends on Isis applib
dom project is released to Maven Central Repo. The versions of the other modules are purposely left at
0.0.1-SNAPSHOT because they are not intended to be released.
Copyright 2016 Dan Haywood Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Maven deploy notes
dom module is deployed, and is done so using Sonatype’s OSS support (see
Release to Sonatype’s Snapshot Repo
To deploy a snapshot, use:
pushd dom mvn clean deploy popd
The artifacts should be available in Sonatype’s Snapshot Repo.
Release an Interim Build
If you have commit access to this project (or a fork of your own) then you can create interim releases using the
The idea is that this will - in a new branch - update the
dom/pom.xml with a timestamped version (eg
It then pushes the branch (and a tag) to the specified remote.
A CI server such as Jenkins can monitor the branches matching the wildcard
origin/interim/* and create a build.
These artifacts can then be published to a snapshot repository.
sh interim-release.sh 1.14.0 origin
1.14.0is the base release
originis the name of the remote to which you have permissions to write to.
Release to Maven Central
release.sh script automates the release process. It performs the following:
performs a sanity check (
mvn clean install -o) that everything builds ok
pom.xmlto a specified release version, and tag
performs a double check (
mvn clean install -o) that everything still builds ok
releases the code using
mvn clean deploy
pom.xmlto a specified release version
sh release.sh 1.14.0 \ 1.15.0-SNAPSHOT \ email@example.com \ "this is not really my passphrase"
$1 is the release version
$2 is the snapshot version
$3 is the email of the secret key (
~/.gnupg/secring.gpg) to use for signing
$4 is the corresponding passphrase for that secret key.
Other ways of specifying the key and passphrase are available, see the `pgp-maven-plugin’s documentation).
If the script completes successfully, then push changes:
git push origin master && git push origin 1.14.0
If the script fails to complete, then identify the cause, perform a
git reset --hard to start over and fix the issue
before trying again. Note that in the
dom’s `pom.xml the
nexus-staging-maven-plugin has the
autoReleaseAfterClose setting set to
true (to automatically stage, close and the release the repo). You may want
to set this to
false if debugging an issue.
According to Sonatype’s guide, it takes about 10 minutes to sync, but up to 2 hours to update search.