Mentorship-backend: Improve existing test documentation

[rpattath]

Description

Currently we have this doc to record tests under each api. We need an improved way/tool to document/record integration test.

Definition of Done

• [ ] The tool should be easy for collaboration among team members
• [ ] Easy to integrate with github and Travis CI and heroku (or whichever CI/CD tool being used).
• [x] Approval by 1 admins.
• [ ] Approval by coding team.

Estimation

10 hours

[isabelcosta]

This sounds good @rpattath 🎉 I cannot wait to learn about this. To understand this better I would like to know:

• what is the purpose/goal... pros and cons
• which tool we could use, what is it improving in our current workflow
• one or more use cases of why we need this tool (e.g.: like a user story, where you give an example of how a QA person would use this and collaborate with the team)
• how would this be maintained (e.g.: when.. how often... would this be changed and updated, who would be responsible for maintaining it, ...)
• the workflow in general and how would this be integrated into TravisCI

[rpattath]

Thank you for this amazing list of questions @isabelcosta

1. what is the purpose/goal... pros and cons?
   Pros: QA team has been working on testing the whole project from the staged branch on heroku. We have been using google docs to document the tests which is not an ideal tool for test documentation of integration tests.
   The test documentation tool that would be identified here would help with the following:
   a. One location to document the testcases by anyone in the team.
   b. The tool will help with documenting test results for each of the testcase whenever there a new version on the staged branch.
   c. Team members interested in automating the testcases can pick up any testcase they want to automate from this location and automate it. They can then mark the TC on the tool to `Automated.
   d. Easier to compare the results of each version on the staged branch with the previous version if any of the PRs broke any of the feature that was working earlier.

Cons:
a. Time to find a tool and integrating it with Travis (CI) and heroku (CD).
b. Training the team members.

1. which tool we could use, what is it improving in our current workflow.
   The following are the ones I have shortlisted
   a. testQuality - This tool has been verified by GitHub which may assure easy integration with GitHub.
   b. Testopia - This is free version of Bugzilla which I have experice using for bug documentation.

2. one or more use cases of why we need this tool (e.g.: like a user story, where you give an example of how a QA person would use this and collaborate with the team)
   a. When a QA team member works on integration testing of multiple apis, after the testing is complete the tester will create a testcase on the above tool with the following information.
   i. Steps of how that feature was tested.
   ii. If the test has been automated or not.
   iii. If the test passed/failed on that particular date/version.

b. When there is a new version on the stage branch of heroku, the team will start working in running all the testcases on the tool and mark on the tool if the testcase passed or failed. The tester could create an issue if any of the tests fails that was passed in the previous versions.

c. The tool may need update whenever a new version is released. I do not expect it to be more frequent that 2-3 times a year. There could be 2-3 members from the QA team trained to do this.

d. the workflow in general and how would this be integrated into TravisCI.

We would choose a tool that is easiest to setup with Travis CI. So whenever a tester or coder automates one of the testcases from the above tool, the automated test has to be added to run with travis CI. Whenever travis CI runs this test the result would be updated automatically on the tool as passed/failed. For all of the failed testcases we will either open an issue or fix the automated test if needed.

[rpattath]

https://www.testim.io/ was a tool suggested by @isabelcosta which can be considered for comparison as well.

[isabelcosta]

Thank you @rpattath for coming with all these responses and ideas! 🎉
I learned a lot from you in our discussion about QA 🤗 (in the Office hour).