test-runner-node

Ghost Inspector test runner Docker images

Build status:

Ghost Inspector is an automated website testing and monitoring service that checks for problems with your website or application. It carries out operations in a browser, the same way a user would, to ensure that everything is working properly.

This Docker image will allow you to execute your Ghost Inspector test suite against your local Docker application.

There is also a standalone, multi-container Docker image available here.

Quickstart

Example Dockerfile:

FROM ghostinspector/test-runner-node

# Copy your node app
COPY . .

# Install your app
RUN npm install .

ENV APP_PORT 3000
ENV GI_API_KEY <ghostinspector-api-key>
ENV GI_SUITE <ghostinspector-suite-id>
ENV GI_PARAM_myVar some-custom-value
ENV NGROK_TOKEN <your-ngrok-token>

# Pass your application entrypoint into our test runner script
CMD ["index.js"]

Now build and run your image:

$ docker build -t my-app .
$ docker run my-app

Base Docker Image

This image is intended to be the base image for your application under test, meaning that the application runtime and Ghost Inspector scripts and utilities are pre-installed for you.

To get started, specify ghostinspector/test-runner-node in the FROM section of your Dockerfile.

Environment variables

As well as adding any dependencies or additional requirements for your application, the following environment variables are required for the test runner:

• APP_PORT - the port your local application will run on (eg: 3000)
• GI_API_KEY - available in your Ghost Inspector account
• GI_SUITE - the ID of the Ghost Inspector test suite you wish to run
• NGROK_TOKEN - available from your ngrok account
• STARTUP_DELAY (optional) - seconds to wait for application and ngrok each to start up, defaults to 3 seconds
• GI_PARAM_myVar (optional) - additional URL parameter to send to our API, the value of which will be accessible in your test under {{myVar}}

Entry point

The last line of your Dockerfile should be CMD, which should look something like this:

CMD ["index.js", "--foo=bar"]

...where index.js is the entrypoint for your application. Under the hood, our test runner script will perform the following:

• start the entrypoint specified in CMD (eg: index.js) with node
• start the ngrok daemon and open a tunnel to localhost:PORT
• execute the Ghost Inspector test suite based on GI_SUITE
• poll the Ghost Inspector API for passing status until a result is provided
• exit with the pass (0) or fail (1) status

LICENSE

The MIT License

Copyright (c) Ghost Inspector, Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

Support

Please open issues in Github or send questions to Ghost Inspector support