Horreum Plugin

Horreum Plugin ToC

• Features
  • Basic plugin features
  • Pipeline features
• Building
• Testing
• Stand up Jenkins server instance
• Configure Global Settings

Overview

This plugin sends a JSON result object to a Horreum instance secured by Keycloak. The request is made as a job execution in Jenkins and if the upload is unsuccessful, the job can be marked as failed (configurable).

Features

The following features are available in both Pipeline and traditional project types:

• Upload JSON result object to Horruem

• Supports Keycloak Authentication

Basic plugin features

Pipeline features

Example upload of output.json to Horreum instance

horreumUpload (
    credentials: 'dev-ci',
    test: 'Dummy Test',
    owner: 'dev-team',
    access: 'PUBLIC',
    start: '$.build-timestamp',
    stop: '$.build-timestamp',
    jsonFile: 'run/localhost/output.json'
)

You can access the response within a groovy script:

def response = horreumUpload (
    credentials: 'dev-ci',
    test: 'Dummy Test',
    owner: 'dev-team',
    access: 'PUBLIC',
    start: '$.build-timestamp',
    stop: '$.build-timestamp',
    jsonFile: 'run/localhost/output.json',
    abortOnfailure: false,
    quiet: false
)
println("Response: "+response)

The created Run ID by Horreum is provided in the response.

Building

The plugin can be built using Maven

mvn package -DskipTests=true

Testing

Testing using Maven and JUnit:

mvn test

Stand up Jenkins server instance

The [Maven HPI plugin](https://jenkinsci.github.io/maven-hpi-plugin/) is used for standing up a Jenkins instance.

mvn hpi:run

Configure Global Settings