Document automated testing in VMS #782

Monal5031 · 2018-07-04T15:30:08Z

Description

This PR documents the automated testing in VMS.
Fixes #779

Type of Change:

Quality Assurance
Documentation

Code/Quality Assurance Only

Bug fix (non-breaking change which fixes an issue)
This change requires a documentation update (software upgrade on readme file)
New feature (non-breaking change which adds functionality pre-approved by mentors)

How Has This Been Tested?

N/A?

Checklist:

My PR follows the style guidelines of this project
I have performed a self-review of my own code or materials
I have commented my code or provided relevant documentation, particularly in hard-to-understand areas
I have made corresponding changes to the documentation
Any dependent changes have been merged

Code/Quality Assurance Only

My changes generate no new warnings
My PR currently breaks something (fix or feature that would cause existing functionality to not work as expected)
I have added tests that prove my fix is effective or that my feature works
New and existing unit tests pass locally with my changes
Any dependent changes have been published in downstream modules

naman1901

Don't use pronouns such as 'you', 'your', etc. Make sure you change sentence structure accordingly.

naman1901 · 2018-07-04T18:56:10Z

aut_docs/Design_Document.md

@@ -23,7 +23,7 @@ The QA process is divided as follows:

 - So, each testcase Class inherits `LiveServerTestCase`, Contains a `setUp`
  and `tearDown` method to instantiate and end live-server respectively.
-  Each testcase in the class begins with `test`.
+  Each Test Case in the class begins with `test`.


testcase is fine. If you want to break into two words, don't capitalize the words.

naman1901 · 2018-07-04T18:57:07Z

aut_docs/Design_Document.md

@@ -47,3 +47,35 @@ The QA process is divided as follows:

 - To follow up changes in UI with changes in tests, the modifications need to be made only
  in the relevant locators/urls/page file.
+
+- Addition of any new view implies that a pom `page` and `locator` corresponding to that


"...implies that corresponding pom page and locator need to be created". Be concise.

naman1901 · 2018-07-04T18:58:07Z

aut_docs/Design_Document.md

+
+## Important points regarding creation of new Test Class:
+
+- As mentioned earlier, each Test Class corresponds to a view and which has a corresponding


"view and which" to "view which"

naman1901 · 2018-07-04T19:00:55Z

aut_docs/Design_Document.md

+- As mentioned earlier, each Test Class corresponds to a view and which has a corresponding
+  pom page and locator.
+
+- When you are creating a new Test Class, first identify the view you are creating the Class for


Do not address a person using pronouns. "When creating a new test class, first identify the view the class is being created for, and create corresponding the pom page and locator."

Again, be concise. Also, don't capitalize words randomly (like ...creating the Class... here)

naman1901 · 2018-07-04T19:01:36Z

aut_docs/Design_Document.md

+- Use of implicit waits should always be avoided unless needed in an extreme case and has the
+  approval of a maintainer. If wait is needed use explicit waits instead.
+
+- Tests in normal mode might fail if all are executed at once, but if a test is failing in


naman1901 · 2018-07-04T19:02:53Z

aut_docs/Installation_Setup.md

@@ -0,0 +1,103 @@
+## Steps to run tests:
+
+Following 4 points are to be followed only once to setup repository.


"A one-time setup requires the following four steps"

Prefer words intext over numerals.

naman1901 · 2018-07-04T19:03:13Z

aut_docs/Installation_Setup.md

+      virtualenv -p python3.6 venv
+    ```
+
+Following points are needed at start of every session of work.


"To start a testing session"

Or just session, as you please.

naman1901 · 2018-07-04T19:04:04Z

aut_docs/Installation_Setup.md

+  :Note: If you are using Windows then see this link to configure geckodriver in your environment
+         https://stackoverflow.com/a/40208762
+
+- To execute all the tests in the VMS, use this command:


To execute all tests in VMS:

Monal5031 · 2018-07-05T13:21:19Z

Thanks @naman1901 for the review, done with changes please review again.

naman1901 · 2018-07-11T17:04:00Z

aut_docs/Documented_Failures.md

@@ -0,0 +1,12 @@
+There are a few tests which have been commented out currently to avoid travis build failure:


Capitalize Travis. Replace with Travis CI, maybe. This is an official doc. You need it to be as perfect as possible.

naman1901 · 2018-07-11T17:05:02Z

aut_docs/Installation_Setup.md

+    ```
+
+- Automated tests in VMS require you to setup geckodriver in your path, for that
+    you can either run this command in root of project:


...path. For that, either run the following command in....

naman1901 · 2018-07-11T17:05:17Z

aut_docs/Installation_Setup.md

+    ```bash
+      bash setup-geckodriver.sh
+    ```
+    OR you can run these commands:


naman1901 · 2018-07-11T17:06:04Z

aut_docs/Installation_Setup.md

+      tar -xzvf geckodriver-v0.20.1-linux64.tar.gz
+      sudo mv geckodriver /usr/local/bin
+    ```
+  :Note: If you are using Windows then see this link to configure geckodriver in your environment


It might be okay to write you here because conditional to the user.

naman1901 · 2018-07-11T17:06:25Z

aut_docs/Installation_Setup.md

+      python manage.py test <app_name>.tests.<test_file_name> -v 2
+    ```
+
+- For the automated tests, if you have configured geckodriver correctly then


if geckodriver has been configured correctly...

ayushgarg1804

travis :/

Monal5031 · 2018-07-27T21:24:12Z

@ayushgarg1804 Travis is getting weird sometimes now, it just needs a rebuild it'll fix automatically. I'll do it in afternoon. ( On mobile atm so can't restart the build)

ayushgarg1804 · 2018-07-29T14:11:47Z

That's quite strange.

Stale

naman1901 · 2018-08-01T15:07:29Z

@Monal5031 please resolve the conflict

Monal5031 added Type: Enhancement New feature or request. Category: Documentation/Training Improvements or additions to documentation. Program: GSOC Related to work completed during the Google Summer of Code Program. labels Jul 4, 2018

Monal5031 assigned pavankm, naman1901 and abarya Jul 4, 2018

Monal5031 requested review from pavankm, naman1901, prachi1210 and abarya July 4, 2018 15:30

naman1901 reviewed Jul 4, 2018

View reviewed changes

anitab-org deleted a comment Jul 5, 2018

Monal5031 force-pushed the documentation branch from b1e52f1 to 1f7ddab Compare July 5, 2018 13:08

anitab-org deleted a comment Jul 5, 2018

Monal5031 force-pushed the documentation branch from 1f7ddab to 0135d2b Compare July 5, 2018 13:20

anitab-org deleted a comment Jul 5, 2018

Monal5031 force-pushed the documentation branch from 0135d2b to 5806f06 Compare July 9, 2018 09:16

naman1901 suggested changes Jul 11, 2018

View reviewed changes

Monal5031 force-pushed the documentation branch from 5806f06 to e306921 Compare July 11, 2018 18:21

anitab-org deleted a comment Jul 11, 2018

anitab-org deleted a comment Jul 24, 2018

ayushgarg1804 previously requested changes Jul 27, 2018

View reviewed changes

Monal5031 requested a review from naman1901 July 27, 2018 21:24

Monal5031 force-pushed the documentation branch from e891d7c to 8b9d2cb Compare July 30, 2018 08:35

anitab-org deleted a comment Jul 30, 2018

naman1901 previously approved these changes Jul 30, 2018

View reviewed changes

MehaKaushik previously approved these changes Aug 1, 2018

View reviewed changes

Monal5031 dismissed stale reviews from MehaKaushik and naman1901 via 1fd984c August 1, 2018 15:28

Monal5031 force-pushed the documentation branch from 8b9d2cb to 1fd984c Compare August 1, 2018 15:28

anitab-org deleted a comment Aug 1, 2018

naman1901 approved these changes Aug 1, 2018

View reviewed changes

Document automated testing in VMS

1fd984c

MehaKaushik approved these changes Aug 3, 2018

View reviewed changes

ayushgarg1804 merged commit 26ee7ec into anitab-org:gsoc18-infra Aug 3, 2018

Monal5031 deleted the documentation branch August 11, 2018 14:41

mayburgos unassigned pavankm and MehaKaushik Feb 1, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Document automated testing in VMS #782

Document automated testing in VMS #782

Monal5031 commented Jul 4, 2018

naman1901 left a comment

naman1901 Jul 4, 2018

Monal5031 Jul 5, 2018

naman1901 Jul 4, 2018

Monal5031 Jul 5, 2018

naman1901 Jul 4, 2018

Monal5031 Jul 5, 2018

naman1901 Jul 4, 2018

Monal5031 Jul 5, 2018

naman1901 Jul 4, 2018

Monal5031 Jul 5, 2018

naman1901 Jul 4, 2018

Monal5031 Jul 5, 2018

naman1901 Jul 4, 2018

naman1901 Jul 4, 2018

Monal5031 Jul 5, 2018

naman1901 Jul 4, 2018

Monal5031 Jul 5, 2018

Monal5031 commented Jul 5, 2018

naman1901 Jul 11, 2018

naman1901 Jul 11, 2018

naman1901 Jul 11, 2018

naman1901 Jul 11, 2018

naman1901 Jul 11, 2018

ayushgarg1804 left a comment

Monal5031 commented Jul 27, 2018

ayushgarg1804 commented Jul 29, 2018

naman1901 commented Aug 1, 2018


		## Important points regarding creation of new Test Class:

		- As mentioned earlier, each Test Class corresponds to a view and which has a corresponding

		@@ -0,0 +1,103 @@
		## Steps to run tests:

		Following 4 points are to be followed only once to setup repository.

		@@ -0,0 +1,12 @@
		There are a few tests which have been commented out currently to avoid travis build failure:

Document automated testing in VMS #782

Document automated testing in VMS #782

Conversation

Monal5031 commented Jul 4, 2018

Description

Type of Change:

How Has This Been Tested?

Checklist:

naman1901 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Monal5031 commented Jul 5, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ayushgarg1804 left a comment

Choose a reason for hiding this comment

Monal5031 commented Jul 27, 2018

ayushgarg1804 commented Jul 29, 2018

naman1901 commented Aug 1, 2018