Setup

COLA Tests can be compiled in the command line using the Cola Tests Compiler, in maven projects through the cola-maven-plugin and in gradle projects through cola-gradle-plugin.

Command Line Compiler

The COLA Tests command line compiler is available as an executable über-jar.

Download: colac latest

Don’t forget to add respective cola-tests library to the JUnit test classpath.

First check the cola-tests version:

#java -jar colac.jar --version
cola-tests-compiler 0.0.3

Then download the respective cola-tests version from Maven Central Repository and add it to your junit tests class path.

Maven

The material presented here is purely introductory. Please refer to maven plugin documentation for more information.

• Add cola-tests as a dependency to the maven pom.xml

<dependency>
  <groupId>com.github.bmsantos</groupId>
  <artifactId>cola-tests</artifactId>
  <version>0.0.3</version>
</dependency>

• Add cola-maven-plugin as a maven plugin to the maven pom.xml

<plugin>
  <groupId>com.github.bmsantos</groupId>
  <artifactId>cola-maven-plugin</artifactId>
  <version>0.0.2</version>
  <configuration>
    <ideBaseClass>com.github.bmsantos.maven.cola.BaseColaTest</ideBaseClass>
    <ideBaseClassTest>iWillBeRemoved</ideBaseClassTest>
    <includes>
      <include>**/*Test.class</include>
    </includes>
    <excludes>
      <exclude>**/ExcludedTest.class</exclude>
    </excludes>
  </configuration>
  <executions>
    <execution>
      <id>compile-cola-tests</id>
      <phase>process-test-classes</phase>
      <goals>
        <goal>compile</goal>
      </goals>
    </execution>
  </executions>
</plugin>

The following configuration options are required if running the tests from an IDE:

• ideBaseClass : Common base class to all tests

• ideBaseClassTest : The name of the JUnit test method to be removed.

This is required because IDEs requires the presence of a JUnit test method in order to execute the test class.

Gradle

• Add build dependencies cola-tests and cola-gradle-plugin to the project build.gradle

buildscript {
  repositories {
    mavenCentral()
  }

  dependencies {
    classpath 'com.github.bmsantos:cola-tests:0.0.3'
    classpath 'com.github.bmsantos:cola-gradle-plugin:0.0.3'
  }
}

• Add test dependency cola-tests and optional slf4j bridge to the project build.gradle

dependencies {
  // testCompile 'org.slf4j:slf4j-simple:1.7.7' // Optional - Can use other slf4j bridge.
  testCompile 'com.github.bmsantos:cola-tests:0.0.3'
  testCompile 'junit:junit:4.+'
}

• Configure Cola Tests in project build.gradle

apply plugin: 'cola'
cola {
  ideBaseClass = 'org.gradle.cola.tests.TestBase'
  ideBaseClassTest = 'toBeRemoved'
  targetDirectory = compileTestJava.destinationDir
  includes = ['org/gradle/cola/tests/**']
  excludes = ['something/else/**', 'and/some/CompiledFile.class']
}

• Hook Cola Test Compiler task to the project build.gradle. Hooks have to be placed after compiling test classes and before executing them. The following example is based on Gradle Java Plugin testClasses task.

colac.dependsOn testClasses
colac.mustRunAfter testClasses

• Configure JUnit for tests and make test task depend on cola-compiler (colac) task

test {
  useJUnit()
  dependsOn colac
}

Example Projects

Here are a couple of example configurations for:

1. Java: maven-simple, maven-SpringJUnit4ClassRunner, gradle-simple
2. Kotlin: maven-simple