Quality gates
Integrate the results of your own testing pipelines with quality gates to make the testing process more transparent and reduce the time and resources needed to identify issues.
With quality gates, you can block an artifact that doesn't meet the defined requirements. In this way, you ensure that only the selected artifacts are pushed to the next stage of your pipeline.
An artifact can be one of the following:
- A commit that you want to merge.
- A build that you want to promote.
You can manage quality gates in the Quality Gates app or with the CI/CD Manager API.
Access to this application is managed by Guidewire Hub. For details, see Access Cloud Platform apps and services.
Default and custom gates
Guidewire offers two types of quality gates:
-
Default gates are predefined quality gates managed by Guidewire. Default gates come with built-in validation mechanisms that don't require additional customer resources, for example testing investments.
Currently, you can use deployment checks to check the deployment status of an app before a build can be promoted to a higher star system.
-
Custom gates are quality gates that you can set up according to your needs, and be applied at different stages, to different artifacts, and for different types of tests. Custom gates allow you to define your own verification criteria and bring the results of your own testing investments to Cloud Platform.
Both types of gates come with the following benefits:
Default gates | Custom gates |
---|---|
Managed by Guidewire. | Managed by the user. |
A complete solution. | Require internal testing investments that you can combine with Quality Gates in bring-your-own testing framework. |
Predefined by Guidewire. | You define at what stages and for which artifacts the custom gate applies. |
With the Insurer Admin credentials, you can override the status of default gates. | You can change the verification status through CI/CD Manager API multiple times. |
Quality gate status
Quality gate status is a combined status of all the verification statuses at a given stage and indicates if an artifact can be merged or promoted. It can be one of the following statuses:
Verification statuses | Quality gate status | Result |
---|---|---|
All the verifications for an artifact have a Successful status. | Passing | You can merge or promote an artifact. |
All the required verifications have a Successful status, but at least one optional verification has either Failed or Pending status. | Passing with warnings | You can merge or promote an artifact. |
At least one required verification for an artifact has a Failed status. | Failing | You can't merge or promote an artifact. |
At least one required verification for an artifact has a Pending status. | Pending | You can't merge or promote an artifact. |
If there are no custom gates configured for a build:
- In the Build Promoter app, the quality gate status is:
Not configured
for builds in non-production star systems that aren't promoted yet and for builds promoted to pre-production star systems.Not applicable
for builds promoted to production star systems.
- In CI/CD Manager API, the quality gate status is
Passing
.
Examples
Example 1
You can update the verification status as many times as you need. Set the verification status as:
-
Pending
when the first test run starts. -
Failed
when the first test run fails. -
Pending
when the second test run starts. -
Successful
when the second test run succeeds.
Example 2
- You set up a required deployment check for ClaimCenter.
- The app is deployed, the verification status for the deployment check is "Successful".
- The quality gate status in the Build Promotion app says "Passing".
- You can now promote your build.
Example 3
- You set up an optional deployment check and a required pre-promotion custom gate for a functional test for ClaimCenter.
- The app is deployed, the verification status for the deployment check is "Successful" but the app fails the functional test.
- The quality gate status in the Build Promotion app says "Failing".
- You can't promote your build.
Example 4
- You set up an optional pre-promotion custom gate for a functional test and a required pre-promotion custom gate for a non-functional test for ClaimCenter.
- The first test fails and the verification status for the deployment check is "Failed". The second test passes and the verification status is "Successful".
- The quality gate status in the Build Promotion app says "Passing with warnings".
- You still can promote your build as the verification with "Failed" status is optional and doesn't block the promotion.
Example 5
- You set up a required pre-merge custom gate for a static analysis.
- The static analysis fails and the verification status for the custom gate in Bitbucket is "Failed".
- You cannot merge your pull request as the required verification has the "Failed" status blocks merging on Bitbucket.
Check the quality gate status
Checking the status depends on the stage at which the quality gates are applied:
-
For pre-merge quality gates, you can use the CI/CD Manager API or see them as merge conditions in Bitbucket.
-
For pre-promote quality gates, you can use the CI/CD Manager API or the Build Promoter app.
For details, see Pre-promotion quality gates status.
Access Quality Gates
To access the Quality Gates app:
-
Select a star system.
-
From
Apps, select Quality Gates or select it from your pinned apps.
Here, you can create, delete, edit, and see the details of all the existing quality gates for your star system.