The case page
A case has a page of its own, /test-cases/<id>, and the panel beside the tree
is a shorter version of it: Open in the panel leads here. The page reads from three places —
GET /v1/test-cases/{id}, the case’s results and its comments — and everything
that changes the case is in the ⋯ menu or in a field of its own.
The order of the blocks
Section titled “The order of the blocks”Top to bottom, a block that has nothing to say is not drawn at all — an empty precondition is not a statement, and a placeholder would turn its silence into one:
- The breadcrumb — the folders and the suite the case is in; each link opens the tree at that node.
- The head — the priority with its word, the name, the type (
manual,automated,eval), the state badge and the Flaky and Muted marks; at the right Edit, the⋯menu and, for an automated case, Draft from code — see Draft from code. - The quiet line — only the parts that say something: created by …, the reason of the current
state (
— …), since and the date of the move, who muted it and when, and the case’s stability once it has results. - The assignee, the tags and the Defects links.
- Preconditions and Description, then the body of the type: Steps (an action and an expected for each), Link to the spec for an automated case, the prompt and assertions of an eval.
- For an automated case, a Code tab: the code snapshot kept with the case, under the file it is from.
- Parameters, when the case has a table — one row per iteration, and the title each row runs under.
- Files, then Comments, then Revisions, then Result history.
A retired case wears the retired badge in the head and, when results keep arriving, says under the assignee how many came after the retirement. A case whose test left the code says The case no longer maps to a test in code. in the quiet line and offers no Edit. Both are in the lifecycle of a case.
The head and its menu
Section titled “The head and its menu”Edit opens the form. The ⋯ menu is the same one a row of the tree has, in five groups: Edit,
Move to… and Duplicate; the moves the lifecycle
allows from where the case stands (Activate, Confirm, Retire, Return to work);
Mark as flaky and Mute…; Copy ID, Copy reference, Copy URL and Copy as Markdown
(Copy reference copies the case’s reference); and Delete,
which always asks. Duplicate is greyed for an automated case, with the reason: an automated case
is its spec, so the test is duplicated in code.
Below 1024 px the head wraps and the actions go under the name; at 480 px and below Draft from
code moves from the head into the top of the ⋯ menu.
Links to other cases and suites
Section titled “Links to other cases and suites”A case or a suite has a short reference: @T for a case or @S for a suite, then the first eight
characters of its ID — @T1a2b3c4d, @S5e6f7a8b. Copy reference in the ⋯ menu copies it: the
menu of the case page, of a case’s row in the tree, and of a suite’s or folder’s row. The form says the
same under Description: Write @T and @S with the first eight characters of the ID (use Copy
reference in the ⋯ menu) to link a case or a suite.
A reference written in Preconditions or Description becomes a link on the case page and in the panel beside the tree:
- a reference to a case opens that case’s page;
- a reference to a suite or a folder opens the tree with the path to it unfolded and the cursor on it;
- pointing at a link shows the name of the case or suite it leads to.
Only those two fields are read. A reference in a step, a comment or the title stays plain text.
A reference is looked up in the project you have open. When no live case or suite of that project has it — the case or suite was deleted and sits in the Bin, it belongs to another project, or nothing has that ID — the reference is still shown, marked as an error, with the reason No case or suite in this project has this reference. The same goes for eight characters that start the IDs of two cases, or of two suites or folders, at once. Until the lookup answers, and if it fails, references are shown as plain text.
Who is to run it
Section titled “Who is to run it”The assignee is a circle with a name and a select behind it — Unassigned on top, then the members of the project. Choosing one saves at once. The wire rules are in Assignee.
Files, comments and the result history
Section titled “Files, comments and the result history”Files are the case’s own — a price list, test data, a picture of how it should look — and are described in Files.
Comments · N lists what people said, oldest first, plain text with its line breaks. Every role, a reader too, sees a box and Comment under the list; Delete is on your own comments for a member, and an owner’s or a manager’s on anyone’s. A reader has no Delete, not even on their own. The box says plain text, line breaks kept · up to 8 KB. The rules are in Comments.
Revisions
Section titled “Revisions”Revisions keeps every version of what a person wrote in the case: the title, Description, Preconditions, Parameters and the body — Steps of a manual case, the spec of an automated one, the prompt and assertions of an eval. A new revision is saved each time that content changes, whatever changed it — the form, a Markdown push, an import, an approved proposal. A change of the state, the assignee, a tag or a flag moves no version and saves nothing. The section says so itself: Every version of the title, description, preconditions, parameters and steps is kept from now on; versions from before this list are not available. A case that existed before revisions were kept starts with one, the version it had then.
The list is newest first, up to 100 versions. A line is Version N — the one the case has now marked current — with when it was saved, tested by N results when results were written against it, and Differs in: … with the fields in which it differs from the case now. View opens what that version held under the line, as the page draws it; Hide closes it.
Revert… on any line but the current one puts that content back. It always asks first, in a dialog Revert to version N? that says:
- The case’s … go back to what version N had. — the fields that change;
- The state, the place in the tree, the priority, the assignee, the flags and the custom fields stay as they are. A tag written in the title goes back with the title.
- It is saved as a new version, M: version N and the versions between stay in this list, and the runs that already tested the case keep showing the version they tested. — M being the next number.
Revert to version N confirms. A revert does not rewrite history: it saves the old content as the next version, and the page says The case is back to version N, saved as version M. Nothing in the list is removed, and results keep the version they were written against. A version whose content the case already has is refused with the case already has the content of this revision.
Everyone in the project sees the list and View; Revert… is offered to an owner, a manager and a member, not to a reader.
A result knows the version it tested. In the result history a line carries a vN badge, Tested on version N of the case; on a run, the panel of a case has Tested on version N, which opens this page with that version open under Revisions.
The result history
Section titled “The result history”Result history is every result that was recorded for the case, newest first. A line is one result:
- a sign for its status —
✔for a pass,✕for a failure or a broken test; a skip or a block has none; - the run it came from and when; the whole line is a link to that result on the run page;
- what it says about the run: the parameter row that ran, as chips (
browser = firefox); the counts2 ✓ 0 ✗, or the status in words for a result that has no assertions to count; - when the judge answered questions on the result, a judge n/m badge — how many were answered in the affirmative;
- when the result has screenshots, a button with their number and a chevron that opens them under the line.
Send to review
Section titled “Send to review”A line offers Send to review only where there is something to review, and to an owner, a member and a reader: a failure — status failed or broken, or a failed assertion — or a result
with no failed assertion on which the judge answered at least one question no, whatever its status
(typically a pass the judge half-agreed on). When that is the only reason, the line says why under the
button: The judge half-agreed — worth a look. A result that is neither has no action.
Pressing it puts the result in the review queue as a dispute, and the button turns into in the review queue. A result that is queued already answers the same, so a second press changes nothing. In the queue — Review in the sections of the project, tabs pending · approved · rejected · all — the entry carries the same judge badge and a link to the run it came from; an empty queue says A disputed result is sent here from a case page — where the judge half-agreed.
What each role sees
Section titled “What each role sees”| Reader | Member | Owner | |
|---|---|---|---|
| Reads everything on the page, with its history and comments | yes | yes | yes |
| Edit, the moves, Mark as flaky, Delete | no — the ⋯ offers the four copies only | yes | yes |
| Revisions and View | yes | yes | yes |
| Revert… | no | yes | yes |
| The assignee select | fixed | yes | yes |
| Draft from code | not drawn, no sentence in its place | yes | yes |
| Send to review | yes | yes | yes |
| A box for a comment | yes | yes | yes |
| Delete on a comment | no | your own | anyone’s |
A reader’s page opens with a notice: You can view everything in Webshop, comment and send results to
review. Changing and approving need write access — an owner can grant it on Settings → Members. (with the
project’s own name). What a reader sends to review waits as pending; only a seat that writes decides it. Who may do what about the project’s
people is in Members.
On a phone
Section titled “On a phone”At 375 px the page is one column; the head’s actions sit under the name, and the rest keeps its order.
The API
Section titled “The API”curl -H "Authorization: Bearer $PLUNE_TOKEN" "$PLUNE_API_URL/v1/test-cases/$CASE_ID"curl -H "Authorization: Bearer $PLUNE_TOKEN" "$PLUNE_API_URL/v1/test-cases/$CASE_ID/comments"The first answers the case — its fields, state and the allowedStates a person may move it to; the
second its comments; GET /v1/test-cases/{id}/results the history, with the case’s stability.
Revisions and the references have their own calls:
curl -H "Authorization: Bearer $PLUNE_TOKEN" "$PLUNE_API_URL/v1/test-cases/$CASE_ID/revisions"curl -H "Authorization: Bearer $PLUNE_TOKEN" "$PLUNE_API_URL/v1/test-cases/$CASE_ID/revisions/3"curl -X POST -H "Authorization: Bearer $PLUNE_TOKEN" -H "Content-Type: application/json" \ -d '{"version": 3}' "$PLUNE_API_URL/v1/test-cases/$CASE_ID/revert"curl -H "Authorization: Bearer $PLUNE_TOKEN" "$PLUNE_API_URL/v1/refs?ref=@T1a2b3c4d&ref=@S5e6f7a8b"The first lists the versions, the second answers one with its content, the third reverts and answers
the case. /v1/refs answers only the references that name a live case or suite of the project, with
its ID and name; up to 50 at a time, and a value that is not @T or @S with eight hex characters is
refused with 400.