Jenkins plugin for running Ghost Inspector browser tests
Switch branches/tags
Nothing to show
Clone or download
Latest commit 3f54b16 Nov 15, 2018
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci okay, yeah I needed that network Oct 5, 2018
jenkins_home clean up Oct 5, 2018
scripts tweak runner script for proper status Oct 5, 2018
src/main add pipelines support, 2.0 Oct 4, 2018
.classpath Initial commit Apr 5, 2017
.gitignore add initial circleci config Oct 4, 2018
.project Initial commit Apr 5, 2017
Dockerfile I cannot docker Oct 5, 2018
LICENSE Remove copyright year from license Feb 6, 2018 Update Nov 15, 2018
pom.xml add pipelines support, 2.0 Oct 4, 2018

Ghost Inspector Plugin for Jenkins

Build status:

Suite Status
CircleCI plugin build CircleCI
Ghost Inspector suite test suite

With this plugin you can add a build step to your Jenkins project that executes a Ghost Inspector test suite. You can trigger this after deployment, or you can run the tests on a local build instance of your application using a tunnel in the "Start URL" field. If the test suite is successful, your pipeline will continue to the next step in your pipeline; however, if it fails (or times out), the build will be marked as failed.

Installing from Jenkins

This plugin can be installed from within the Jenkins UI (recommended).

Installing from Source

  1. Download and unpack the source
  2. From terminal mvn clean install
  3. Copy target/ghostinspector.hpi to $JENKINS_HOME/plugins
  4. Restart Jenkins


  • API Key - This is a unique, private key provided with your account which allows you to access the API. You can find it in your Ghost Inspector account settings at
  • Suite ID - The ID of the Ghost Inpsector suite that you would like to execute.


  1. Open your project configuration from the Jenkins dashboard.
  2. In the build section, click Add build step and select Run Ghost Inspector Test Suite.
  3. In the API Key field, paste in your account's API key. For the Suite ID field, paste in the ID of the test suite that you would like to execute.
  4. If you would like to run your Ghost Inspector tests on a URL other than their default setting (such as a local build instance of your application using a tunnel), enter the start URL in the Start URL field.
  5. If you would like to pass other custom parameters or variables to your suite run, specify them in the Additional Parameters field.
  6. Save your Jenkins project.

Note: Environment variables may be used in both the Start URL and Additional Parameters field with the format $VAR_NAME.

Pipelines usage

The following example will allow you to trigger the Ghost Inspector plugin from your pipelines config:

node {
   stage('Main') {
        step([$class: 'GhostInspectorBuilder', apiKey: 'my-api-key', params: 'additional=parameters&another=one', startUrl: 'my-start-url', suiteId: 'my-suite-id'])


Quick start:

$ brew install java8 maven
$ export JAVA_HOME=$(/usr/libexec/java_home -v 1.8)
$ mvn clean install

The resulting ghost-inspector.hpi can be found in the ./target folder.

Change Log

2018-Oct-04: Update plugin for pipelines support

2018-Feb-06: Add "Additional Parameters" field. Apply environment variables to "Start URL" and "Additional Parameters" fields.

2018-Feb-02: Move from sync API call to async polling

2017-Apr-04: Initial release