2022-05-31 15:36:54 +03:00
|
|
|
|
# CI/CD Integration
|
|
|
|
|
|
2022-09-28 11:24:24 +03:00
|
|
|
|
Up until now, we have run our test files locally. Now, we want to integrate
|
2022-05-31 15:36:54 +03:00
|
|
|
|
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:
|
|
|
|
|
|
2022-09-28 11:24:24 +03:00
|
|
|
|
- build the application, run unit tests and static code analysis,
|
2022-05-31 15:36:54 +03:00
|
|
|
|
- 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/quiz>
|
|
|
|
|
|
|
|
|
|
In a first step, we're going to write a bash 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.
|
|
|
|
|
|
|
|
|
|
## Integration Script
|
|
|
|
|
|
|
|
|
|
1. First, create a directory name `quiz-project`, add [`integration/basic.hurl`]
|
|
|
|
|
and [`integration/create-quiz.hurl`] from the previous tutorial to the directory.
|
|
|
|
|
|
|
|
|
|
<pre><code class="language-shell">$ mkdir quiz-project
|
|
|
|
|
$ cd quiz-project
|
|
|
|
|
$ mkdir integration
|
|
|
|
|
$ vi integration/basic.hurl
|
|
|
|
|
|
|
|
|
|
# Import <a href="https://raw.githubusercontent.com/jcamiel/quiz/master/integration/basic.hurl">basic.hurl</a> here!
|
|
|
|
|
|
|
|
|
|
$ vi integration/create-quiz.hurl
|
|
|
|
|
|
|
|
|
|
# Import <a href="https://raw.githubusercontent.com/jcamiel/quiz/master/integration/create-quiz.hurl">create-quiz.hurl</a> here!</code></pre>
|
|
|
|
|
|
2022-09-28 11:24:24 +03:00
|
|
|
|
Next, we are going to write the first version of our integration script that will
|
2022-05-31 15:36:54 +03:00
|
|
|
|
just pull the Quiz image and run it:
|
|
|
|
|
|
|
|
|
|
2. Create a script named `bin/integration.sh` with the following content:
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
#!/bin/bash
|
|
|
|
|
set -eu
|
|
|
|
|
|
|
|
|
|
echo "Starting Quiz container"
|
|
|
|
|
docker run --name quiz --rm --detach --publish 8080:8080 ghcr.io/jcamiel/quiz:latest
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
3. Make the script executable and run it:
|
|
|
|
|
|
|
|
|
|
```shell
|
|
|
|
|
$ chmod u+x bin/integration.sh
|
|
|
|
|
$ bin/integration.sh
|
|
|
|
|
Starting Quiz container
|
|
|
|
|
5d311561828d6078e84eb4b8b87dfd5d67bde6d9614ad83860b60cf310438d2a
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
4. Verify that our container is up and running, and stop it.
|
|
|
|
|
|
|
|
|
|
```shell
|
|
|
|
|
$ docker ps
|
|
|
|
|
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
|
|
|
|
|
c685f3887cc1 ghcr.io/jcamiel/quiz:latest "java -jar app/quiz.…" 3 seconds ago Up 3 seconds 0.0.0.0:8080->8080/tcp, :::8080->8080/tcp quiz
|
|
|
|
|
$ docker stop quiz
|
|
|
|
|
quiz
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
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
|
2022-09-28 11:24:24 +03:00
|
|
|
|
container has started, but the application server can take a few seconds to be
|
2022-05-31 15:36:54 +03:00
|
|
|
|
really ready to accept incoming HTTP requests.
|
|
|
|
|
|
2022-09-28 11:34:00 +03:00
|
|
|
|
To do so, we can test our health API. With a function `wait_for_url`,
|
2022-10-31 13:50:22 +03:00
|
|
|
|
we use Hurl to check a given URL to return a `200 OK`. We loop on this function
|
2022-12-19 23:30:08 +03:00
|
|
|
|
until the check succeeds with [`--retry`] Hurl option. Once the test has succeeded, we stop the container.
|
2022-05-31 15:36:54 +03:00
|
|
|
|
|
|
|
|
|
5. Modify `bin/integration.sh` to wait for the application to be ready:
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
#!/bin/bash
|
|
|
|
|
set -eu
|
|
|
|
|
|
|
|
|
|
wait_for_url () {
|
2022-12-19 23:30:08 +03:00
|
|
|
|
echo "Testing $1..."
|
|
|
|
|
echo -e "GET $1\nHTTP 200" | hurl --retry --retry-max-count "$2" > /dev/null;
|
|
|
|
|
return 0
|
2022-05-31 15:36:54 +03:00
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
echo "Starting Quiz container"
|
2022-12-19 23:30:08 +03:00
|
|
|
|
docker run --rm --detach --publish 8080:8080 --name quiz ghcr.io/jcamiel/quiz:latest
|
2022-05-31 15:36:54 +03:00
|
|
|
|
|
|
|
|
|
echo "Starting Quiz instance to be ready"
|
|
|
|
|
wait_for_url 'http://localhost:8080' 60
|
|
|
|
|
|
|
|
|
|
echo "Stopping Quiz instance"
|
|
|
|
|
docker stop quiz
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
We have now the simplest integration test script: it pulls a Quiz image, then starts
|
|
|
|
|
the container and waits for a `200 OK` response.
|
|
|
|
|
|
|
|
|
|
Next, we're going to add our Hurl tests to the script.
|
|
|
|
|
|
2022-09-25 13:52:24 +03:00
|
|
|
|
6. Modify `bin/integration.sh` to add integration tests:
|
2022-05-31 15:36:54 +03:00
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
#!/bin/bash
|
|
|
|
|
set -eu
|
|
|
|
|
|
|
|
|
|
# ...
|
|
|
|
|
|
|
|
|
|
echo "Starting Quiz container"
|
|
|
|
|
# ...
|
|
|
|
|
|
|
|
|
|
echo "Starting Quiz instance to be ready"
|
|
|
|
|
# ...
|
|
|
|
|
|
|
|
|
|
echo "Running Hurl tests"
|
2022-08-16 16:30:48 +03:00
|
|
|
|
hurl --test integration/*.hurl
|
2022-05-31 15:36:54 +03:00
|
|
|
|
|
|
|
|
|
echo "Stopping Quiz instance"
|
|
|
|
|
# ...
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
7. Run [`bin/integration.sh`] to check that our application passes all tests:
|
|
|
|
|
|
|
|
|
|
```shell
|
|
|
|
|
$ bin/integration.sh
|
|
|
|
|
Starting Quiz container
|
|
|
|
|
48cf21d193a01651fc42b80648abdb51dc626f31c3f9c8917aea899c68eb4a12
|
|
|
|
|
Starting Quiz instance to be ready
|
|
|
|
|
Testing http://localhost:8080
|
|
|
|
|
Wait 0s
|
|
|
|
|
Wait 1s
|
|
|
|
|
Wait 2s
|
|
|
|
|
Wait 3s
|
|
|
|
|
Wait 4s
|
|
|
|
|
Wait 5s
|
|
|
|
|
Running Hurl tests
|
2022-08-16 16:30:48 +03:00
|
|
|
|
[1mintegration/basic.hurl[0m: [1;36mRunning[0m [1/2]
|
2022-08-23 19:36:47 +03:00
|
|
|
|
[1mintegration/basic.hurl[0m: [1;32mSuccess[0m (4 request(s) in 18 ms)
|
2022-08-16 16:30:48 +03:00
|
|
|
|
[1mintegration/create-quiz.hurl[0m: [1;36mRunning[0m [2/2]
|
2022-08-23 19:36:47 +03:00
|
|
|
|
[1mintegration/create-quiz.hurl[0m: [1;32mSuccess[0m (6 request(s) in 18 ms)
|
2022-05-31 15:36:54 +03:00
|
|
|
|
--------------------------------------------------------------------------------
|
2022-08-23 19:36:47 +03:00
|
|
|
|
Executed files: 2
|
|
|
|
|
Succeeded files: 2 (100.0%)
|
|
|
|
|
Failed files: 0 (0.0%)
|
|
|
|
|
Duration: 48 ms
|
2022-05-31 15:36:54 +03:00
|
|
|
|
Stopping Quiz instance
|
|
|
|
|
quiz
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
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
|
2022-12-15 13:06:33 +03:00
|
|
|
|
to create a [GitHub Action]. You can also see how to integrate your tests in [GitLab CI/CD here].
|
2022-05-31 15:36:54 +03:00
|
|
|
|
|
|
|
|
|
## Running Tests with GitHub Action
|
|
|
|
|
|
|
|
|
|
1. Create a new empty repository in GitHub, named `quiz-project`:
|
|
|
|
|
|
|
|
|
|
<p>
|
|
|
|
|
<img class="light-img u-drop-shadow u-border" src="/docs/assets/img/github-new-repository-light.png" width="100%" alt="Create new GitHub repository"/>
|
|
|
|
|
<img class="dark-img u-drop-shadow u-border" src="/docs/assets/img/github-new-repository-dark.png" width="100%" alt="Create new GitHub repository"/>
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2. On your computer, create a git repo in `quiz-project` directory and
|
|
|
|
|
commit the projects files:
|
|
|
|
|
|
|
|
|
|
```shell
|
|
|
|
|
$ git init
|
|
|
|
|
Initialized empty Git repository in /Users/jc/Documents/Dev/quiz-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 branch -M main
|
|
|
|
|
$ git remote add origin https://github.com/jcamiel/quiz-project.git
|
|
|
|
|
$ git push -u 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`:
|
|
|
|
|
|
|
|
|
|
```yaml
|
|
|
|
|
name: CI
|
|
|
|
|
|
|
|
|
|
on:
|
|
|
|
|
push:
|
|
|
|
|
branches:
|
|
|
|
|
- main
|
|
|
|
|
|
|
|
|
|
jobs:
|
|
|
|
|
build:
|
|
|
|
|
runs-on: ubuntu-latest
|
|
|
|
|
permissions:
|
|
|
|
|
contents: read
|
|
|
|
|
steps:
|
|
|
|
|
- name: Checkout
|
|
|
|
|
uses: actions/checkout@v2
|
|
|
|
|
- name: Build
|
|
|
|
|
run: echo "Building app..."
|
|
|
|
|
- name: Integration test
|
|
|
|
|
run: |
|
|
|
|
|
curl -LO https://github.com/Orange-OpenSource/hurl/releases/download/1.4.0/hurl_1.4.0_amd64.deb
|
|
|
|
|
sudo dpkg -i hurl_1.4.0_amd64.deb
|
|
|
|
|
bin/integration.sh
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
4. Commit and push the new action:
|
|
|
|
|
|
|
|
|
|
```shell
|
|
|
|
|
$ 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:
|
|
|
|
|
|
|
|
|
|
<p>
|
|
|
|
|
<img class="light-img u-drop-shadow u-border" src="/docs/assets/img/github-action-light.png" width="100%" alt="GitHub Action"/>
|
|
|
|
|
<img class="dark-img u-drop-shadow u-border" src="/docs/assets/img/github-action-dark.png" width="100%" alt="GitHub Action"/>
|
|
|
|
|
</p>
|
|
|
|
|
|
2022-12-15 13:06:33 +03:00
|
|
|
|
## Running Tests with GitLab CI/CD
|
|
|
|
|
|
|
|
|
|
If you use [GitLab CI/CD], you can check [this detailed tutorial] on how to continuously run your Hurl test suite.
|
|
|
|
|
|
|
|
|
|
|
2022-05-31 15:36:54 +03:00
|
|
|
|
## Tests Report
|
|
|
|
|
|
|
|
|
|
TBD
|
|
|
|
|
|
|
|
|
|
## Recap
|
|
|
|
|
|
2022-09-28 11:24:24 +03:00
|
|
|
|
In less than half an hour, we have added a full CI/CD pipeline to our project.
|
2022-05-31 15:36:54 +03:00
|
|
|
|
Now, we can add more Hurl tests and start developing new features with confidence!
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
[`integration/basic.hurl`]: https://raw.githubusercontent.com/jcamiel/quiz/master/integration/basic.hurl
|
|
|
|
|
[`integration/create-quiz.hurl`]: https://raw.githubusercontent.com/jcamiel/quiz/master/integration/create-quiz.hurl
|
|
|
|
|
[GitHub Actions]: https://github.com/features/actions
|
|
|
|
|
[GitLab CI/CD pipelines]: https://docs.gitlab.com/ee/ci/pipelines/
|
|
|
|
|
[`bin/integration.sh`]: https://github.com/jcamiel/quiz/blob/master/bin/integration.sh
|
2022-12-15 13:06:33 +03:00
|
|
|
|
[GitLab CI/CD here]: https://about.gitlab.com/blog/2022/12/14/how-to-continously-test-web-apps-apis-with-hurl-and-gitlab-ci-cd/
|
|
|
|
|
[GitLab CI/CD]: https://about.gitlab.com/why-gitlab/
|
|
|
|
|
[this detailed tutorial]: https://about.gitlab.com/blog/2022/12/14/how-to-continously-test-web-apps-apis-with-hurl-and-gitlab-ci-cd/
|
2022-12-19 23:30:08 +03:00
|
|
|
|
[`--retry`]: /docs/manual.md#retry
|