Add Test plan report status dialog (P1)

[lolaodelola]

Taken from #648.

This page or dialog shows detailed status of AT/browser reports for a given version of a given test plan. The AT/browser combinations are limited to the AT covered by the plan and the most recent version of each in-scope browser included in the system browser list.

It includes:

• Links to completed reports
• Status of in-progress reports
• Information about missing reports
• Whether a specific report is required for the current phase
• The data is presented in a table captioned "PHASE_NAME TEST_PLAN_NAME test Plan Reports". Example: "Draft Alert Test Plan Reports".

The table has columns for:

1. required?: Shows "Yes" or "No"
2. AT: Shows AT Name and version
3. Browser: Shows browser name and version
4. Report Status: Shows:
   • If the report is complete, a link to the report with text "Report Completed on DATE"
   • If report is missing, the string "Missing", and if user is admin, button "Add to Test Queue"
   • If report is not complete and not missing and not in test queue, the string "None", and if user is admin, "Add to Test Queue" button
   • If report is in the test queue, the string "X% complete by Y testers with Z conflicts"
   • Note: Percent complete = NUMBER_COMPLETED_TESTS_BY_ALL_TESTERS / (NUMBER_ASSIGNED_TESTERS * NUMBER_TESTS_IN_PLAN) * 100

The table is sorted by required Yes, then required No, then AT, then browser.

[lolaodelola]

@ccanash @howard-e This needs to be split into individual tasks and prioritised, some of the tasks may not end up being P0.

[lolaodelola]

Hi @mcking65, Do you have a preference between page & dialogue? It'd be good for you and @isaacdurazo to coordinate on what the UI needs for this dialogue/page is, also it'd be helpful to know what the prioritisation of this work is, I've put it at P0 for now.

[ccanash]

Updating description per latest update in #648 @lolaodelola @mcking65 from latest update it seems now we know it will be a dialogue.

Test plan report status dialog Description

This dialog shows detailed status of AT/browser reports for a single version of a single test plan.

The label on the button that opens the dialog provides information about the current report status for the test plan. The button has one of the following labels.

Button Label	Condition
Required Reports Not Started	For every AT/browser pair that requires a report, the report is neither complete nor in the test queue.
Some Required Reports Missing	At least one of the AT/browser pairs that requires a report neither has a complete report nor has a run in the test queue. At the same time, at least one of the AT/browser pairs that requires a report either has a complete report or has a run in the test queue.
Required Reports In Progress	At least one AT/browser pair that requires a report does not have a complete report and is in the test queue. All other AT/browser pairs that require a report are either complete or are in the test queue.
Required Reports Complete	All AT/browser pairs that require a report have a complete report.

The dialog title is: "Report Status for TEST_PLAN_NAME Test Plan"

The dialog content includes a note and a table.

• Note content:
  • "Note: This plan is in the PHASE_NAME phase. N AT/browser pairs require reports in this phase."
  • Example: "This plan is in the Draft Review phase. 3 AT/browser pairs require reports in this phase."
• The table is captioned:
  • "Reports for PHASE_NAME TEST_PLAN_NAME Test Plan"
  • Example: "Reports for Draft Alert Test Plan".

The table columns are:

1. required?: Shows "Yes" or "No"
2. AT:
   • If phase is draft, shows AT name.
   • If phase is recommended, Shows AT Name and version.
3. Browser:
   • If phase is draft, shows browser name.
   • If phase is recommended, shows browser name and version.
4. Report Status:
   • If the report is complete, shows a link to the report with text "Report Completed on DATE"
   • If report is missing, shows the string "Missing", and if user is admin, button "Add to Test Queue"
   • If report is not complete and not missing and not in test queue, shows the string "None", and if user is admin, "Add to Test Queue" button
   • If report is in the test queue, shows the string "X% complete by Y testers with Z conflicts"
   • Note: Percent complete = NUMBER_COMPLETED_TESTS_BY_ALL_TESTERS / (NUMBER_ASSIGNED_TESTERS * NUMBER_TESTS_IN_PLAN) * 100

The table is sorted by required Yes, then required No, then AT, then browser.

The rows that appear in the table are determined as follows.

• If the phase is draft, there is one row for each valid AT/browser pair for all AT covered by the plan.
• TODO: If the phase is recommended, the algorithm for determining what rows to put in the table will be described in the next update of this specification.

[isaacdurazo]

Here's the mockup for this dialog.

Keep in mind that this is not a real scenario since we wouldn't have 4 required reports for a Draft Test plan. I added an extra row just so I could show all the different Report statuses.

@mcking65 This table is pretty simple in terms of Visual Design. The Required, AT, and Browser columns display all plain text. The Report Status uses our existing styling for secondary buttons when we have the "Add to Test Queue" button and the statuses strings reuse the little circle icon I propose in issue #648.

[ccanash]

Hi @mcking65 , we plan on working on this on Wednesday. Would it be possible for you to review the design beforehand?

[mcking65]

Hi @ccanash, I don't see anything for me to review.

[isaacdurazo]

@mcking65 This is the comment with the proposed dialog.

[mcking65]

@isaacdurazo wrote:

Here's the mockup for this dialog.

Keep in mind that this is not a real scenario since we wouldn't have 4 required reports for a Draft Test plan. I added an extra row just so I could show all the different Report statuses.

@mcking65 This table is pretty simple in terms of Visual Design. The Required, AT, and Browser columns display all plain text. The Report Status uses our existing styling for secondary buttons when we have the "Add to Test Queue" button and the statuses strings reuse the little circle icon I propose in issue #648.

That sounds good to me.

I am assuming the content in the image matches what is described in the top comment. Is a version of this viewable in the sandbox now?

[mcking65]

Tested in staging. Overall, this dialog looks great! Thank you.

There are two unmet requirements and two bugs. I raised separate issues for them so we can close this issue after deployment.

Requirements:

If phase is recommended, Shows AT Name and version.
If phase is recommended, shows browser name and version.

The rationale for showing versions is related to #792. The version numbers are not especially helpful until we can actually generate reports for specific versions. So, we can let #792 and the issues it depends on track development of that capability.

The two bugs are documented in #796. Those are not blocking issues, so we can consider this issue complete as soon as we deploy.

[ccanash]

Released to prod.