Greenrun help
Everything you need to start testing in Jira. Can't find something? Get support.
1. Getting started
Install Greenrun from the Atlassian Marketplace (a Jira admin does this once). Then open Apps > Greenrun in Jira.
Pick a Jira project at the top. Tests, cycles and reports belong to that project. Greenrun has four tabs:
- Test cases: write and organise your tests in folders.
- Shared steps: steps you reuse in many tests, such as "Log in as a customer".
- Test cycles: rounds of testing, such as "Release 2.4 regression", where results are recorded.
- Reports: progress, coverage and defects.
2. Writing test cases
On Test cases, click + New test case. Give it a title, and optionally an objective, a precondition, a priority and a status (Draft, Ready or Deprecated).
Write the test as either:
- Steps: each step has an action, optional test data, and the expected result. Ctrl+Enter in the last row adds a step.
- Given/When/Then: plain Gherkin text. Greenrun warns about lines it doesn't understand.
Ctrl+S saves. Each test gets a key like DEMO-T12.
Folders
Use + New in the Folders panel. Drag folders to reorganise them, and drag ticked test cases onto a folder to move them. A folder can only be deleted when it's empty.
Shared steps
Create a set on the Shared steps tab, then use Insert shared steps… in any test. Edit the set once and every test using it changes. A set can't be deleted while a test uses it.
Changing many tests at once
Tick tests in the list to move them, set their status or priority, or delete them together.
If two people edit the same test, the second save is refused with a message, so nobody's work is overwritten. Copy your changes, reopen the test and try again.
Drafting tests with AI
Greenrun can suggest tests from a Jira story. It is off until a Jira admin of the project turns it on in Settings > AI test writing.
- Open the story, and in its Tests box choose Steps or Given / When / Then, then Draft tests. It usually takes 10 to 40 seconds.
- Greenrun suggests 3 to 8 tests from the story's summary and description. Untick the ones you don't want, fix the titles, and click Save. They are saved as Draft tests, linked to the story and labelled ai-drafted, so you can find and review them.
- AI can be wrong or miss things: always read the tests before using them.
- Each Jira site has 10 AI drafts a month on the free plan and 50 on a paid plan, reset on the 1st. If the AI can't be reached, the request doesn't count. The meter is in Settings and under the button.
- It uses Atlassian's own AI service for apps, so the story stays in Atlassian's cloud. Greenrun deletes the story text and suggestions 2 days later.
3. Running tests in a cycle
On Test cycles, click + New cycle. Optionally group cycles into a test plan, for example every cycle for one release.
Open the cycle and add tests: pick them, or add a whole folder. Greenrun takes a copy of each test's steps at that moment, so editing a test later never changes results you've already recorded. If a test changes, its run shows "This test has been edited", with Use latest version.
Open a test in the cycle and, for each step, choose Passed, Failed, Blocked or Skipped. Type what actually happened, and paste screenshots with Ctrl+V or use Add file (up to 100 MB each, so screen recordings fit). The overall result is worked out from the steps: any failed step means Failed, any blocked step means Blocked, and all done means Passed. You can also set it by hand.
4. Raising bugs
On a failed step, click Raise bug. Greenrun creates a Jira bug as you, with the steps to reproduce, the expected and actual results and your screenshots, then links it to the run. You can also link an existing issue by its key. Linked bugs show their live Jira status.
5. Linking tests to stories
A test can cover any Jira issue except bugs and sub-tasks: stories, tasks, epics and so on. Link them in either place:
- In a test's editor, under Covers (requirements), type an issue key and click Link issue.
- On the Jira issue itself, open the Tests section in the right-hand column. Type a test key or search by title, or click + New test for this issue.
The Tests section shows each test's latest result, the bugs its runs raised, and an overall coverage label:
| Label | Meaning |
|---|---|
| Not covered | No tests are linked. |
| Untested | Tests are linked, but none has passed yet. |
| Partly tested | Some linked tests passed; others haven't been run. |
| Passing | Every linked test's latest result is Passed. |
| Failing | At least one linked test's latest result is Failed. |
| Blocked | None failed, but at least one is Blocked. |
On a bug, the same section shows which test runs found it.
6. Reports and the dashboard gadget
The Reports tab has three reports. Each can cover all cycles, one plan or one cycle:
- Progress: passed, failed, blocked and still-to-do counts, a chart of tests run per day, and results per cycle and per tester.
- Coverage: pick issues by fix version, the whole project or a JQL search, and see each one's coverage label and tests.
- Defects: every bug linked from test runs, with its live status, priority and the tests that found it.
To see progress on a Jira dashboard, edit the dashboard, choose Add gadget, search for Test progress, then pick a project and a cycle or plan.
Exporting
The Export button on the test list, on a cycle and on each report downloads what you see as Excel or CSV, or opens your browser's print window, where Save as PDF makes a PDF. A test export uses the same columns as the importer, so you can import it again.
Automated test results (Jenkins, GitHub Actions, GitLab...)
Your build can send its JUnit XML or Cucumber JSON report to Greenrun after every run. A Jira admin of the project sets it up once in Settings > Automated test results:
- Create an API key and store it in your build's secret settings. It is shown once only; Greenrun keeps just a fingerprint of it. Results sent with a key show as run by the person who made it, and the key stops working if that person loses access to the project.
- Copy the ready-made
curlcommand or GitHub Actions step from the same page. The address ends with?cycle=and the test cycle the results go into; it is made if it doesn't exist. - Each test is matched by a Greenrun key in its name or tags (for example
SCRUM-T12), or by the same test sent before. Tests not seen before are added to an Automated folder with the label automated. - Sending results again into the same cycle keeps the earlier results under Earlier runs, as Run again does.
- Up to 2,000 tests and 10 MB per report. Send several files one after another if your tool writes one per test class.
REST API
Your own scripts and tools can read and create tests and read cycle results through Greenrun's REST API. It runs on Atlassian's app REST APIs, so your data still never leaves Atlassian's cloud. To set it up:
- A site admin switches on app REST APIs for Greenrun in Atlassian Administration > Connected apps.
- Make an OAuth 2.0 (3LO) integration in the Atlassian developer console with the scopes
read:greenrun:custom(read) andwrite:greenrun:custom(create and change), and sign in with it to get a token. - Send
Authorization: Bearer <token>tohttps://<your-site>.atlassian.net/gateway/api/svc/jira/apps/<Greenrun's app id>followed by an address below.
GET /tests?project=SCRUM: a page of tests. Optional:folder,label,search; for the next page addafter=thenextnumber from the answer.GET /tests/SCRUM-T12: one test with its steps.POST /tests: create a test. Body:project,title, and any ofobjective,precondition,priority,status,steps(a list ofaction,data,expected),bdd,labels,custom.PUT /tests/SCRUM-T12: change a test. Send theversionfrom your last read; if someone changed it since, the answer is409and nothing is overwritten.GET /cycles?project=SCRUM: the project's cycles.GET /cycles/<id>: one cycle's results, a page at a time (offset=thenextnumber).
Every call acts as the person who signed in, with their own Jira permissions: reading needs Browse projects, changing needs Edit issues. Answers are JSON; errors come with a plain message (400 bad request, 401 no or expired token, 403 not allowed, 404 not found, 409 changed by someone else).
A person who closed their Atlassian account is shown by Greenrun as erased-account in fields such as createdBy and executedBy, because Atlassian's privacy rules require Greenrun to remove closed accounts' IDs. Treat that value as "a closed account"; don't look it up in Jira.
Searching from Jira (JQL)
Greenrun adds four functions to Jira's own search, so you can use test results in filters, boards and dashboards:
issue in greenrunCoverage("Failing"): issues whose tests' latest results make them Failing. Also Passing, Blocked, Partly tested or Untested. Add a project to count only its tests, and a cycle or plan to count only its results:greenrunCoverage("Failing", "SCRUM", "Sprint 4").issue in greenrunHasTests(): issues linked to at least one test.issue not in greenrunHasTests()finds those with none.issue in greenrunCoveredBy("SCRUM-T12"): the issues one test covers.issue in greenrunBugs(): bugs raised or linked from test runs, optionally for a project and a cycle or plan.
Jira keeps each answer for a while, and Greenrun updates it about a minute after a change. A function can return up to 1,000 issues; above that, add a project, a cycle or a plan. Jira still only shows issues you're allowed to see.
7. Importing tests (CSV, Excel, Zephyr)
On Test cases, click Import… and choose a .csv or .xlsx file. The file is read in your browser.
- Use one row per test, or one row per step with the test's title on its first row. Rows below it with no title add steps to that test.
- Greenrun matches columns by their names (title, steps, expected result, folder, priority and so on). Check the matches and change any that are wrong.
- A folder path like Login/Smoke creates those folders. Jira keys in a "Coverage" column link the test to those issues.
- If the file has a key or ID column, running the same import again skips tests already imported, so nothing is duplicated.
Moving from Zephyr
Zephyr Scale: open Test cases, select the tests, then More > Export to Excel.
Zephyr Essential (Squad): use Export test cases > Excel (all fields).
Import that file into Greenrun. Greenrun recognises Zephyr's column names, and your Zephyr data stays exactly where it is.
Please note: the Zephyr importer was built from Zephyr's published column names and tested on look-alike files, not yet on a real customer's export. Before importing everything, try a small export first and check the result. If anything doesn't come across properly, email us the file's column headings and we'll fix it quickly.
Up to 5,000 tests and 20 MB per file. Test results history, attachments and custom fields aren't imported yet.
8. Who can see and change what
Greenrun follows your Jira project permissions. There's nothing extra to set up.
- To see a project's tests, cycles and reports, you need Browse projects in that Jira project.
- To change anything, including creating, editing, running or deleting tests, you also need Edit issues.
- People who can browse but not edit get a read-only view, with a notice explaining why.
- Tests in projects you can't see never appear anywhere, including on Jira issues and in reports.
A change to someone's Jira permissions takes up to a minute to apply in Greenrun.
9. Pricing and licences
Free for Jira sites with up to 10 users. Above that, $2.15 per user per month, billed by Atlassian. As with all Jira apps, the price follows your Jira site's user count.
If a licence lapses, Greenrun becomes read-only: you can still see and report on everything, but changes are switched off until a Jira admin renews it in Apps > Manage apps. Your data isn't deleted.
10. Limits
| What | Limit |
|---|---|
| Steps in one test or shared set | 200 |
| Tests changed at once (bulk) | 500 |
| Tests added to a cycle at once | 500 |
| Files per step / size of a file | 10 files / 100 MB each |
| Import file | 5,000 tests, 20 MB |
| Issues in one coverage report | 500 |
11. Support
We reply within 1 working day (UK hours, Monday to Friday). The support page lists what to include and has the email address.