For teams on GitLab who want a deploy to stop when Certyn's smoke tests fail.
Your setup
- GitLab CI (gitlab.com or self-managed) with a deploy job, for example to staging.
- Certyn test cases for your critical paths.
- You want the pipeline to fail when they fail.
Say this to Certyn
After our GitLab pipeline deploys to staging, run the smoke tests and fail the pipeline if they fail.
What Certyn does
- Makes sure there is a suite to run: a Certyn suite process for your
smoketest cases (app.process.create, typecertyn), for examplesmoke-suite. - Opens the
ci_setupform. Pick GitLab CI/CD. It creates an API key and shows it once. - You save the key as a protected, masked CI/CD variable
CERTYN_API_KEY. - Certyn gives you a
certyn-smokejob for.gitlab-ci.yml. Put it in a stage after your deploy job. The job usescurlandjqto:- start the suite:
POST /api/ci/runswithprojectSlug,environmentKey,processSlug(smoke-suite) andcommitSha, with theX-API-KeyandIdempotency-Keyheaders; - poll
GET /api/ci/runs/{runId}untilstateiscompletedorcancelled; - exit with an error when
failed > 0orblocked > 0.
- start the suite:
The full job is in GitLab and Other CI.
What you get
- A red pipeline when a smoke test fails or is blocked, with a link (
appUrl) to the Certyn run. - A run report, and a Certyn issue with evidence for each real product bug.
- CI retries with the same
Idempotency-Keydo not start a second run.
Limits
- The CI Runs API runs Certyn suites (by
processSlugortags). It cannot start an agent process, such as your own repo's tests. To get those into Certyn, push their results. - Certyn does not set GitLab CI/CD variables or change your pipeline here. You add the key and the job.
- If staging is on a private network, Certyn's runs need a self-hosted runner.