hurl/docs/tutorial/ci-cd-integration.md

CI/CD Integration

Up until now, we have run our test files locally. Now, we want to integrate them in a CI/CD pipeline (like GitHub Actions or GitLab CI/CD pipelines). As Hurl is very fast, we're going to run our tests on each commit of our project, drastically improving the project quality.

A typical web project pipeline is:

• build the application, run unit tests and static code analysis,
• publish the application image to a Docker registry,
• pull the application image and run integration tests.

In this workflow, we're testing the same image that will be used and deployed in production.

For the tutorial, we are skipping build and publication phases and only run integration tests on a prebuilt Docker image. To check a complete project with build, Docker upload/publish and integration tests, go to https://github.com/jcamiel/hurl-express-tutorial

In a first step, we're going to write a shell script that will pull our Docker image, launch it and run Hurl tests against it. Once we have checked that this script runs locally, we'll see how to run it automatically in a CI/CD pipeline.

Templating Tests

Before writing our test script, we're going to template our Hurl files so we can run them more easily in various configuration. One way to do this is to use variables. We've already seen variables when chaining requests, we're going to see how we can use them to inject data.

In the file basic.hurl, we first test the home page:

# Checking our home page:
GET http://localhost:3000

# ...

We've hardcoded our server's URL but what if we need to run the same test on another URL (against production URL with HTTPS for example)? We can use a variable like this:

# Checking our home page:
GET {{host}}

# ...

And run our file with --variable option:

$ hurl --variable host=http://localhost:3000 --test basic.hurl

This way, our host is not hardcoded any more and we can run our tests in various configurations.

1. Replace http://localhost:3000 by {{host}} in basic.hurl, login.hurl and signup.hurl and test that everything is ok

$ hurl --variable host=http://localhost:3000 --test *.hurl
Running Hurl tests
integration/basic.hurl: Running [1/2]
integration/basic.hurl: Success (4 request(s) in 18 ms)
integration/login.hurl: Running [2/2]
integration/login.hurl: Success (6 request(s) in 18 ms)
--------------------------------------------------------------------------------
Executed files:  2
Succeeded files: 2 (100.0%)
Failed files:    0 (0.0%)
Duration:        48 ms

Now, we're ready to write our integration script.

Integration Script

1. First, create a directory name movies-project, add integration/basic.hurl and integration/create-quiz.hurl from the previous tutorial to the directory.

$ mkdir movies-project
$ cd movies-project
$ mkdir integration
$ vi integration/basic.hurl

# Import basic.hurl here!

$ vi integration/login.hurl

# Import login.hurl here!

$ vi integration/signup.hurl

# Import signup.hurl here!

Next, we are going to write the first version of our integration script that will just pull the Quiz image and run it. This script will our server URl as argument

2. Create a script named bin/integration.sh with the following content:

#!/bin/sh
set -eu

echo "Starting container"
docker run --name movies --rm --detach --publish 3000:3000 ghcr.io/jcamiel/hurl-express-tutorial:latest

3. Make the script executable and run it:

$ chmod u+x bin/integration.sh
$ bin/integration.sh http://localhost:3000
Starting container
5d311561828d6078e84eb4b8b87dfd5d67bde6d9614ad83860b60cf310438d2a

4. Verify that our container is up and running, and stop it.

$ docker ps
CONTAINER ID   IMAGE                                          COMMAND                  CREATED         STATUS         PORTS                                       NAMES
4002ce42e507   ghcr.io/jcamiel/hurl-express-tutorial:latest   "node dist/bin/www.js"   3 seconds ago   Up 2 seconds   0.0.0.0:3000->3000/tcp, :::3000->3000/tcp   movies
$ docker stop movies
movies

Now, we have a basic script that starts our container. Before adding our integration tests, we need to ensure that our application server is ready: the container has started, but the application server can take a few seconds to be really ready to accept incoming HTTP requests.

To do so, we can test our health API. With a function wait_for_url, we use Hurl to check a given URL to return a 200 OK. We loop on this function until the check succeeds with --retry Hurl option. Once the test has succeeded, we stop the container.

5. Modify bin/integration.sh to wait for the application to be ready:

#!/bin/sh
set -eu

wait_for_url () {
    echo "Testing $1..."
    printf 'GET %s\nHTTP 200' "$1" | hurl --retry "$2" > /dev/null;
    return 0
}

echo "Starting container"
docker run --name movies --rm --detach --publish 3000:3000 ghcr.io/jcamiel/hurl-express-tutorial:latest

echo "Waiting server to be ready"
wait_for_url "$1" 60

echo "Stopping container"
docker stop movies

We have now the simplest integration test script: it pulls our Docker image, then starts the container and waits for a 200 OK response.

Next, we're going to add our Hurl tests to the script.

6. Modify bin/integration.sh to add integration tests:

#!/bin/sh
set -eu

# ...

echo "Starting container"
# ...

echo "Waiting server to be ready"
# ...

echo "Running Hurl tests"
hurl --variable host="$1" --test integration/*.hurl

echo "Stopping container"
# ...

7. Run bin/integration.sh to check that our application passes all tests:

$ bin/integration.sh http://localhost:3000
Starting container
48cf21d193a01651fc42b80648abdb51dc626f31c3f9c8917aea899c68eb4a12
Waiting server to be ready
Testing http://localhost:3000
Running Hurl tests
integration/basic.hurl: Running [1/2]
integration/basic.hurl: Success (4 request(s) in 18 ms)
integration/login.hurl: Running [2/2]
integration/login.hurl: Success (6 request(s) in 18 ms)
--------------------------------------------------------------------------------
Executed files:  2
Succeeded files: 2 (100.0%)
Failed files:    0 (0.0%)
Duration:        48 ms

Stopping container
movies

Locally, our test suite is now fully functional. As Hurl is very fast, we can use it to ensure that new developments don't have regression. Our next step is to run the integration tests automatically in a CI/CD pipeline. As an example, we're going to create a [GitHub Action]. You can also see how to integrate your tests in GitLab CI/CD here.

Running Tests with GitHub Action

1. Create a new empty repository in GitHub, named movies-project:

2. On your computer, create a git repo in movies-project directory and commit the projects files:

$ git init
Initialized empty Git repository in /Users/jc/Documents/Dev/movies-project/.git/
$ git add .
$ git commit -m "Add integration tests."
[master (root-commit) ea3e5cd] Add integration tests.
 3 files changed, 146 insertions(+)
 create mode 100755 bin/integration.sh
...
$ git remote add origin https://github.com/jcamiel/movies-project.git
$ git push --set-upstream origin main
Enumerating objects: 7, done.
Counting objects: 100% (7/7), done.
...

Next, we are going to add a GitHub Action to our repo. The purpose of this action will be to launch our integration script on each commit.

3. Create a file in .github/workflows/ci.yml:

name: CI

on:
  push:
    branches:
      - main

jobs:
  build:
    runs-on: ubuntu-latest
    permissions:
      contents: read
    steps:
      - name: Checkout
        uses: actions/checkout@v3
      - name: Build
        run: echo "Building app..."
      - name: Integration test
        run: |
          curl --location --remote-name https://github.com/Orange-OpenSource/hurl/releases/download/4.0.0/hurl_4.0.0_amd64.deb
          sudo dpkg -i hurl_4.0.0_amd64.deb
          bin/integration.sh http://localhost:3000          

4. Commit and push the new action:

$ git add .github/workflows/ci.yml
$ git commit -m "Add GitHub action."
[main 077d754] Add GitHub action.
 1 file changed, 19 insertions(+)
 ...
$ git push
Enumerating objects: 6, done.
Counting objects: 100% (6/6), done.
...

Finally, you can check on GitHub that our action is running:

Running Tests with GitLab CI/CD

1. Create a new empty repository in GitLab, named movies-project:

2. On your computer, create a git repo in movies-project directory and commit the projects files:

$ git init
Initialized empty Git repository in /Users/jc/Documents/Dev/movies-project/.git/
$ git add .
$ git commit -m "Add integration tests."
[master (root-commit) ea3e5cd] Add integration tests.
 3 files changed, 146 insertions(+)
 create mode 100755 bin/integration.sh
...
$ git remote add origin git@gitlab.com:jcamiel/movies-project.git
$ git push --set-upstream origin main
Enumerating objects: 7, done.
Counting objects: 100% (7/7), done.
...

Next, we are going to add a GitLab CI/CD pipeline. The purpose of this pipeline will be to launch our integration script on each commit. We'll base our image on a Docker based image, with a Docker-In-Docker service.

3. Create a file .gitlab-ci.yml:

image: docker:24

build:
   stage: build
   services:
      - docker:24-dind
   before_script:
      # Add Hurl on Alpine (testing channel)
      - apk add --no-cache --repository http://dl-cdn.alpinelinux.org/alpine/edge/testing hurl
   script:
      - bin/integration.sh http://docker:3000

Because of Docker-In-Docker, our server is accessible with the docker hostname (and not localhost). As we have made our script configurable, we can just pass the hostname and don't modify our integration script

4. Commit and push the new action:

$ git add .gitlab-ci.yml
$ git commit -m "Add GitLab CI/CD pipeline."
[main 11c4e7e] Add GitLab CI/CD pipeline.
 1 file changed, 13 insertions(+)
 create mode 100644 .gitlab-ci.yml
$ git push
Enumerating objects: 6, done.
Counting objects: 100% (6/6), done.
...

Finally, you can check on GitLab that our pipeline is running:

For a more complete GitLab CI/CD example, you can check this detailed tutorial on how to continuously run your Hurl test suite.

Tests Report

TBD

Recap

In less than half an hour, we have added a full CI/CD pipeline to our project. Now, we can add more Hurl tests and start developing new features with confidence!