Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create a small template for reporting test results #541

Closed
eloquence opened this issue Apr 22, 2020 · 4 comments
Closed

Create a small template for reporting test results #541

eloquence opened this issue Apr 22, 2020 · 4 comments

Comments

@eloquence
Copy link
Member

eloquence commented Apr 22, 2020

We've agreed that it makes sense to standardize reporting of workstation test results a bit, to ensure we consistently capture version and environmental data. For example:

  • host OS used for testing (Qubes vs. Linux/Mac; versions thereof)
  • server environment (dev/staging/prod)
  • workstation environment (dev/staging/prod)
  • client environment (e.g., sd-app vs. an sd-dev type setup)
  • commit hash; any applied patches

While automatic gathering of this data may help in future, for now let's just agree on a standard format to use & what information is most important to gather. See this report by Allie, for example: freedomofpress/securedrop-client#1025 (comment)

@eloquence
Copy link
Member Author

@zenmonkeykstop said he wants to take a first stab at this during the 4/22-5/6 sprint period, can just be a wiki page for now.

@eloquence eloquence added this to Sprint #49 - 4/22-5/6 in SecureDrop Team Board Apr 22, 2020
@zenmonkeykstop
Copy link
Contributor

First stab here: https://github.com/freedomofpress/securedrop-workstation/wiki/Workstation-test-case-report-template

This might make more sense as an issue template, now that I look at it.

@conorsch
Copy link
Contributor

Looks great!

might make more sense as an issue template

We can always port it at some point, but I see value in using the test-results when reviewing PRs, as well, so wiki page as a first attempt definitely make sense.

@eloquence
Copy link
Member Author

Thanks for initializing @zenmonkeykstop, closing - we can take further edits to the wiki :-)

SecureDrop Team Board automation moved this from Sprint #51 - 5/20-6/3 to Done May 21, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Development

No branches or pull requests

3 participants