Walkthrough with sample data

First run walkthrough

Follow a sample test report from upload to a finished run, without uploading anything. The walkthrough shows that TestLookup accepting an upload is a different step from the run being finished.

Install

Try it

Step through it yourself

State 1 of 5: Accepted

Nothing plays on its own, and nothing is uploaded or sent to TestLookup or any other service.

Accepted

The pretend upload gets an accepted reply (HTTP 202) with a task ID and a run ID. TestLookup has accepted the report but hasn't processed it yet.

  • task_id: example-task-001
  • run_id: 00000000-0000-4000-8000-000000000070
  • task status: pending
  • task record kept for: 24 hours

Read all the steps as text

The buttons appear once the page has finished loading. All the steps are already written out below.

Step by step

All the steps as text

Example with made-up data. Nothing on this page contacts a server.

  1. Accepted

    You've just uploaded the sample file. The page shows that TestLookup accepted it, with a separate task ID and run ID, and that the task is pending. Accepted doesn't mean finished.

    Details
    • task_id: example-task-001
    • run_id: 00000000-0000-4000-8000-000000000070
    • task status: pending
    • task record kept for: 24 hours
  2. Parsing

    Choose Observe parsing. The task starts reading the file, saving the results comes next, and the run is still in progress.

    Details
    • task status: parsing
    • next task status: ingesting
    • run status: IN_PROGRESS
  3. Saved and finished

    Choose Observe finalization. The upload task succeeded, but the run is FAILED. The page shows the sample counts and both pass rates. The one over tests that ran matches the pass rate TestLookup shows.

    Details
    • task status: succeeded
    • run status: FAILED
    • pass rate over tests that ran: 77.8% (what TestLookup shows)
    • pass rate over all 100 results: 70.0% (for comparison only)
  4. Invalid file

    Choose invalid file. The task fails after the upload was accepted, and the page doesn't guess whether a run exists.

    Details
    • task status: failed
    • run exists: unknown
    • what to do: read the task's error, then upload a valid file
  5. All skipped

    Choose all skipped. The run finishes as STOPPED because no test ran.

    Details
    • tests that ran: 0
    • skipped: 100
    • run status: STOPPED

The sample data

Example with made-up data. Nothing on this page contacts a server.

The sample has 100 made-up test results: 70 passed, 15 failed, 5 broken and 10 skipped. Its task ID and run ID are fake. It contains no passwords or keys, personal data, production logs or signed download links.

TestLookup’s pass rate counts only the tests that ran. It divides the passed tests by the passed, failed and broken tests together. For this sample, that’s 70 of 90, or 77.8%, and that’s the figure TestLookup would show.

The walkthrough also shows 70.0%, which is 70 out of all 100 with the skipped tests included. That figure is there only for comparison.

The walkthrough follows the steps in the workflow guide on GitHub.

Upload accepted

The walkthrough starts at Accepted, as if you had just uploaded the sample file. It shows an example reply from TestLookup: accepted (HTTP 202), with a task ID and a run ID. Nothing is actually sent.

Accepted means TestLookup has the file. It doesn’t yet mean the file has been read, saved, analyzed or reviewed.

From upload to finished run

Choose Observe parsing, then Observe finalization. The upload task and the run stay separate the whole time.

In TestLookup, the upload task goes through these stages:

  1. Pending: waiting to start.
  2. Parsing: reading the file.
  3. Ingesting: saving the results.
  4. Succeeded or failed.

The walkthrough shows the task as pending at Accepted. At Parsing, it notes that saving the results comes next. At Saved and finished, it shows that the task succeeded while the run itself is FAILED.

Details: in the API, the task states are pending, parsing, ingesting, succeeded and failed.

A task can fail even after TestLookup accepted the upload. TestLookup keeps the task record for 24 hours, so a missing task record doesn’t prove that there’s no run. The upload guide on GitHub describes these steps.

Choose invalid file shows a task that fails after it was accepted. The walkthrough leaves open whether a run exists. It never retries a real upload.

Final status

The sample run finishes as FAILED, because some tests failed or broke. Choose all skipped, offered at the Parsing step, shows a run that finishes as STOPPED, because no test ran.

A run with no results stays in progress until TestLookup marks it as finished. The test run guide on GitHub sets out these rules.

Evidence detail

The last step lists the sample’s counts and both pass rates. It labels the task’s state, the run’s state and any missing information separately.

The run ID shown is the one TestLookup sends back. In TestLookup, use that ID to open a run, rather than a display name.

Reset

Back and Reset walkthrough only change what this page shows. Nothing is saved, and they touch no data or activity record in TestLookup.

Reset walkthrough goes back to Accepted. Reloading the page does the same, unless the page address names a step the page recognizes.

All the steps as text

The step-by-step text at the end of this page lists every step. It covers the accepted upload, reading the file, the finished FAILED run, the invalid file and the all-skipped STOPPED run. It’s complete even with JavaScript turned off.

Try it for real

When the steps make sense, try them for real. Follow the Quick start on a spare machine that you can wipe afterwards, then import your first report.

Open the Quick start.