Skip to content

Latest commit

 

History

History
120 lines (99 loc) · 4.89 KB

README.md

File metadata and controls

120 lines (99 loc) · 4.89 KB
Raw

Orangebeard.io FitNesse TestSystemListener
Orangebeard.io FitNesse TestSystemListener

A test output listener for Praegus Open Source Toolchain FitNesse tests.

MVN Version Build Status License

Installation

The listener is only compatible with Java 11+, so make sure you're running your FitNesse test with Java 11.

Add this project as a test dependency to your pom:

<dependency>
    <groupId>io.orangebeard</groupId>
    <artifactId>fitnesse-toolchain-listener</artifactId>
    <version>version</version>
    <scope>test</scope>
</dependency>

Configuration

Create orangebeard.properties in your project's test resource folder, containing:

orangebeard.endpoint=<ORANGEBEARD-ENDPOINT>
orangebeard.accessToken=<XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX>
orangebeard.project=<PROJECT_NAME>
orangebeard.testset=<TESTSET_NAME>

# optional
orangebeard.logLevel=INFO
orangebeard.description=<DESCRIPTION>
orangebeard.attributes=key:value; value;
orangebeard.logsAtEndOfTest=false

Be warned: the access token is a credential token. We advise you to store this token in a credential store, and pass it to the listener through environment properties. See below how to do that!

The log level is set to INFO by default. Valid values are: DEBUG, INFO, WARN and ERROR. Logs of the set level and up to be logged. So if you were to set the log level to WARN, only WARN and ERROR logs will be logged.

Set orangebeard.logsAtEndOfTest to true if you want the listener to stash the logs per test client side, and send them all at once once the test is finished. This will improve performance of the listener, but you will lose real time log information. It is recommended to set this value to true for very fast test runs, like api tests.

Environment properties

Properties can also be set in the build, by passing them to the maven build. For example:

mvn clean test-compile ... -Dorangebeard.attributes=Jenkins;Chrome -Dorangebeard.testset=small-regression

Use the runner

Replace the

@RunWith(ToolchainTestRunner.class)

with

@RunWith(OrangebeardJunitRunner.class)

in the test that is started from your pipeline (which is probably src/test/java/.../FixtureDebugTest.java)

Installation option 2 (as a FitNesse Plugin for local test execution)

Make sure the jar-with dependencies is in your wiki/plugins directory. If you use maven, you can use the following execution for the maven-dependency-plugin to do it:

 <execution>
    <id>copy-plugin</id>
    <phase>generate-resources</phase>
    <goals>
        <goal>copy</goal>
    </goals>
    <configuration>
        <artifactItems>
            <artifactItem>
                <groupId>io.orangebeard</groupId>
                <artifactId>fitnesse-toolchain-listener</artifactId>
                <version>version</version>
                <classifier>jar-with-dependencies</classifier>
                <overWrite>true</overWrite>
            </artifactItem>
        </artifactItems>
        <outputDirectory>${project.basedir}/wiki/plugins</outputDirectory>
    </configuration>
</execution>

Add the endpoint, accessToken and projectName properties to your FitNesse instances plugins.properties (or custom properties file if you wish to configure it)

Run FitNesse, the plugin will register itself and show the Orangebeard logo on your test and suite pages. Press the logo to run and report the outcome to Orangebeard.

Limitations

  • Currently, this runner/listener will start separate launches for each testsystem if you use >1 testsystem (i.e. Fit and Slim)in one suite
  • Full HTML report zip (or any other attachments) will not be saved when its size is exceeds 1 MB due to an api limitation