What this pack contains
The starting point for the Jira integration: a test with the Jira action already attached, the reconciliation sweep, and a job that runs them in the right order. Import it to try the integration on day one, then copy its pieces onto your own tests and jobs.
| Item | Folder | What it is |
|---|---|---|
| Example - a failing test opens a Jira issue and a pass resolves it | Jira Issue Automation / 1 Example | A standard test whose query returns 1 and expects 0, so it fails. Its Test Ran action calls Sync Jira Issue with Test Result (Automatic), which needs nothing typed into the step |
| Reconcile Jira issues with test results | Jira Issue Automation / 2 Reconcile | A test on the Jira data source that runs the Reconcile Jira Issues with Validatar sweep. It passes whenever the sweep runs, and its result lists what the sweep checked and did |
| Jira Issue Automation | Jobs | A job that runs 1 Example, then 2 Reconcile |
The example's query is plain SQL with no table, so it runs on most databases as written:
-- Fails on purpose: returns 1, and the test expects 0.
-- Change 1 to 0 and run again to see the action resolve the issue.
SELECT 1 AS VALUE
On Oracle, add FROM DUAL.
Where to get it
Marketplace: Jira Issue Automation
Prerequisites
- A Jira data source built from the Jira Cloud Data Source Template. Jira Setup for Validatar covers it.
- Any SQL data source in the same project, for the example test.
- The Standard Test Actions optional feature, for the example's action.
- Optional: the Issue Tracking - Project Custom Fields, so the example shows its open issue.
Import
- Open Marketplace in Validatar, find Jira Issue Automation, choose Get, then Import Directly.
- Choose the target project when prompted.
- Map the pack's two data sources:
- Jira Cloud (Dev) to your Jira data source. The example's action and the sweep both use it.
- Data Warehouse (Dev) to any SQL data source. Only the example's query runs on it.
- Choose Review Changes. The review lists two tests and one job. Choose Import.
- Open the example test's Actions tab and check that the step names your Jira data source and the macro Sync Jira Issue with Test Result (Automatic).
Try it
With Dry Run on, the action decides and writes nothing; Jira Setup for Validatar shows how to check the setup in that state. With Dry Run off:
- Run the Jira Issue Automation job. The example fails, and its action opens an issue in the Jira data source's default project. The sweep runs next and checks every test in its scope. The example is not linked to a table, so it is not among them.
- Open the issue in Jira. It carries the test name, the failing query, a link to the run and a link back to the test.
- Edit the example's query from
SELECT 1toSELECT 0, save, and run the job again. The example passes, and its action comments on the issue and resolves it.
Preview on the example's Jira step reads and writes nothing: the Automatic macro sees that a preview has no run behind it and stops.
Use it on your own tests
The action. Add the same trigger and step to your own tests: a Test Ran trigger with one Run a Macro step that calls Sync Jira Issue with Test Result (Automatic). Nothing needs typing; fill in Assignee Email to assign new issues. Open and Resolve Jira Issues from Test Results describes it, and the Custom macro for when you need its extra options.
The sweep. Copy Reconcile Jira issues with test results into each project whose tests open issues, and add it as the last step of every scheduled job that runs them. The sweep covers tests linked to tables or columns of the warehouse data sources in the Jira data source's Reconcile Data Source Ids; set that parameter first. Its own parameters narrow it to one project or folder, or stop it writing open issues onto the catalog.
The job. The job shows the order to keep: tests first, sweep last. The sweep waits 30 seconds before opening or resolving anything, so the actions from the same job land first.
Troubleshooting
| Symptom | Cause | Fix |
|---|---|---|
| The example has no action after import | The Standard Test Actions feature is off | Turn it on, then import the pack again |
| The example fails but no issue appears | Dry Run is on, or the action could not reach Jira | Check the setup as Jira Setup for Validatar describes |
| The example errors with a syntax error | The database needs a FROM clause |
Add FROM DUAL on Oracle, or select from any small table |
| The sweep's result lists tests you did not expect | Reconcile Data Source Ids covers more data sources than you meant | Narrow the parameter, or set the sweep's project or folder |