Concordion is an open source framework for Java that lets you turn a plain English description of a requirement into an automated test. Concordion is the most flexible tool for creating high-quality living documentation. It is often used with Specification by Example (SbE) and Behaviour Driven Development (BDD) processes.
Java HTML Other
Latest commit 6c58cf7 Jan 23, 2017 @nigelcharman nigelcharman committed on GitHub Merge pull request #235 from concordion/only-run-concordion-fixtures
Only run Concordion fixtures from the run command.

README.md

Build Status Maven Central Apache License 2.0

Concordion is an open source framework for Java that lets you turn a plain English description of a requirement into an automated test.

Users should see the Concordion web site for details of how to download and use Concordion.

This README covers information for people wanting to work with the Concordion source code.

Target Java version

Concordion currently targets Java 6.

Building Concordion

Concordion uses Gradle as a build tool. The code base includes the Gradle Wrapper, which will automatically download the correct version of Gradle.

From the command line, run gradlew tasks to show available tasks.

Note: If the current directory is not on your path, you will need to use ./gradlew tasks on Unix-based systems, or .\gradlew tasks on Windows.

Compiling and Running the Tests

Run the following from the command line:

gradlew clean test

This will download the required dependencies, clean the existing project, recompile all source code and run all the tests. Concordion output is written to the ./build/reports/spec folder.

Creating a jar file

Run the following from the command line:

gradlew clean jar

The jar file is written to the ./build/libs folder.

Installing a jar file into your local Maven repository

Installing a Concordion jar file into your local Maven repository makes it available to other projects that are using Maven or Gradle to manage their dependencies.

The publishing tasks for Concordion have been split out into a separate publish.gradle build script, since these rely on Java 7 and the core build is based on Java 6.

Run the following from the command line:

gradlew -b publish.gradle pTML

(where pTML is short for publishToMavenLocal).

Using the Concordion jar file from your local Maven repository in a Gradle project

In order to use the local Maven repository in a Gradle project, you must add mavenLocal() to your repositories block. You can add this to the project's build.gradle script, or set it globally by adding the following to your ~/.gradle/init.gradle script:

allprojects {
    repositories {
        mavenLocal()
    }
}

You will then need to ensure that your project's build.gradle script refers to the version you have in your local Maven repository, for example your dependencies might include:

org.concordion:concordion:2.0.0-SNAPSHOT

or

org.concordion:concordion:+

for the latest version.

Importing the project into your IDE


Dependent on the version of your IDE, you may need to install a Gradle plugin to your IDE before importing the project. See Gradle tooling for details.

On importing the project to your IDE, the required dependencies will be downloaded.

Project History

History prior to April 2013 is in the Subversion repository.