csomh / c3i-library

Forked from c3i-library 4 years ago
Clone
README.md

C3I Library

This is a Jenkins shared library designed to make integration testing of pipeline services easier. It defines global variables with methods to ease deployment and management of ephemeral instances, suitable for testing. The currently available global variables are:

  • c3i: General utilities, including cleaning up stale resources from previous test runs.
  • ca: Create a local certificate authority, and generate SSL certificates and Java keystores and truststores.
  • umb: Deploy an instance of the Unified Message Bus (ActiveMQ).
  • koji: Deploy and provision a Koji hub.
  • mbs: Deploy a Module Build Service instance.

More complete documentation is in progress.

Usage

To dynamically import this library from the master branch, add the following lines to your Jenkinsfile:

library identifier: 'c3i@master', changelog: false,
  retriever: modernSCM([$class: 'GitSCMSource', remote: 'https://pagure.io/c3i-library.git'])

See the Jenkins documentation for information on how to use this library from your pipelines.

Run unit tests

C3I Library uses Jenkins Pipeline Unit testing framework to simulate Jenkins pipeline engine and Gradle for compiling and running tests.

You can run the unit test suite with the following command:

gradle test # or `gradle test --info` to be more verbose