Difference between revisions of "QA testing"

Jump to: navigation, search
(Running tests: obtaining Moodle 2.3dev)
(See also)
 
(119 intermediate revisions by 9 users not shown)
Line 1: Line 1:
 
'''Quality Assurance''' tests look at the functionality of Moodle from a user's point of view.   
 
'''Quality Assurance''' tests look at the functionality of Moodle from a user's point of view.   
  
Real users systematically try each feature in Moodle and test that it works in the current version of the Moodle code.
+
Real users systematically try each feature in Moodle and test that it works in the current version of the Moodle code. These tests are repeated in series of cycles, usually 4 weeks before a major release, once all major features have landed.
  
These tests are repeated in series of cycles, usually just before major releases.
+
<p class="note">'''QA testing latest''': ''A 100% pass rate was obtained in Moodle 3.8 QA testing. Many thanks to all our [[Testing credits|QA testers]].''</p>
  
 
==Getting involved==
 
==Getting involved==
  
[[Image:Qa test workflow actions.png|thumb|Testers can pass or fail QA tests and add comments]]Would you like to help with QA testing? If so, please contact [http://moodle.org/user/profile.php?id=1408100 Tim Barker] and ensure you're subscribed to the [http://moodle.org/mod/forum/view.php?id=56 Testing and QA forum] in order to receive QA testing news updates.
+
Would you like to help with QA testing? If so, please make sure you have created an account in the [[Tracker_introduction|Moodle tracker]], then contact [https://moodle.org/user/profile.php?id=24152&course=1 Helen]. Also, make sure you're subscribed to the [https://moodle.org/mod/forum/view.php?id=56 Testing and QA forum] in order to receive QA testing news updates.
  
 
All testers are members of the testers group in the Moodle Tracker, enabling them to pass or fail QA tests and add comments.
 
All testers are members of the testers group in the Moodle Tracker, enabling them to pass or fail QA tests and add comments.
Line 13: Line 13:
 
==Running tests==
 
==Running tests==
  
# Select a test from the list - MDLQA-1814
+
# Go to the QA testing dashboard  and choose a test from the list of current QA cycle open issues. When viewing a test, if you wish, you can click the 'Assign to me' link on the right, so that nobody else chooses the same test to run. (If you then find you are unable to run the test, you can click the Assign button and set the assignee as 'Unassigned'.) Please note:
# Using either the [http://qa.moodle.net/ Moodle QA Testing Site] or your own test site running the latest Moodle 2.3dev (available from Git on the integration/master branch ''<nowiki>git://git.moodle.org/integration.git</nowiki>''), perform each of the steps listed in the test
+
#* Only assign an issue to yourself which no one else is testing (Assignee = Unassigned).
 +
#* Only assign one issue at a time unless you plan to test a number of related issues within the next 24 hours. In other words, don't assign several issues to yourself then do nothing for several days. ;-)
 +
#* The label ''test_server_required'' indicates issues that can't be tested on the QA testing site. The label ''credentials_required'' indicates that credentials such as an OAuth 2 service client ID and secret are required.
 +
# Using either the [https://qa.moodledemo.net/ Moodle QA Testing Site] or your own test site running the latest Moodle 3.x dev (available from Git on the integration/master branch ''<nowiki>git://git.moodle.org/integration.git</nowiki>'') with [[:en:Debugging|debugging]] set to developer, perform each of the steps listed in the test. ''If it makes sense, please test using the currently supported themes, Boost and Classic.''
 
# Choose an appropriate workflow action:
 
# Choose an appropriate workflow action:
#* ''Pass'' - Test runs perfectly :)
+
#* ''Pass'' - Test runs perfectly. Add comment such as feedback about a new feature, browsers used for testing (if applicable), or simply "This test passes - yippee!"
#* ''Fail'' - See [[#failedTests|below]] for actions to take
+
#* ''Fail'' - Something doesn't work, or you obtain debugging messages. Add comment describing the step that doesn't work. If in doubt whether to pass a test, give it a fail and add a comment describing your doubts.
#* ''Obsolete'' - Test is no longer relevant in the current Moodle version
+
#* ''Obsolete'' - Test is no longer relevant in the current Moodle version. Add comment explaining why.
# Add a comment about the workflow action (e.g. "This test passes - yippee!") to confirm that the test wasn't accidentally passed without being run
 
  
Please note: If you are behind a firewall you do not control or content filtering system, it may interfere with the use of the Moodle QA site. It is advisable that testing is completed where such complications are not in place.
+
If you notice that the test description is out-of-date, add a comment mentioning that it needs updating. Alternatively, if you'd like to help with updating the test yourself, see below.
  
When you pass or fail a test, you are automatically named as the assignee.
+
===Moodle QA Testing Site===
  
If in doubt whether to pass a test, give it a fail and perhaps ask someone else to have a look by adding them as a watcher then adding a comment.
+
The [https://qa.moodledemo.net/ Moodle QA Testing Site] is updated daily at around 13:00 UTC with the latest bug fixes to enable you to re-run QA tests.
  
If you notice that the test description is out-of-date, add Tim as a watcher (username ''timb'') then add a comment suggesting how it can be updated.
+
To prevent the site being used for sending spam, no emails are sent from it. Thus, tests involving email cannot be run using the Moodle QA Testing Site. (If such tests are attempted, an email debug message is displayed. This is not a bug but rather expected behaviour.)
  
Note: Always use the latest version of Moodle 2.3dev for testing or the [http://qa.moodle.net/ Moodle QA Testing Site]. Contact Helen if you would like admin access to the Moodle QA Testing Site.
+
Teacher and student accounts are provided. Please contact [https://moodle.org/user/profile.php?id=24152&course=1 Helen] if you would like admin or manager access to the Moodle QA Testing Site for running certain tests.
  
 
==<div id="failedTests">Failed tests</div>==
 
==<div id="failedTests">Failed tests</div>==
Line 38: Line 40:
 
# Add a comment to the QA test stating that there was a problem and that you will report it as a Moodle bug.
 
# Add a comment to the QA test stating that there was a problem and that you will report it as a Moodle bug.
 
# Note the MDLQA number; it will be something like <nowiki>MDLQA-448</nowiki>.
 
# Note the MDLQA number; it will be something like <nowiki>MDLQA-448</nowiki>.
# Report the problem as a bug so that developers can investigate and fix it. Do this by clicking the button labelled "+ Create Issue" on the top-right corner of the Tracker page. The project should be "Moodle" and the Issue Type will be "Bug". <br />[[Image:CreateIssue.png|150px|Creating an issue in the tracker]]
+
# Try searching for whether the bug has been reported previously, and if not create a new issue for it (as described in [[Tracker introduction]]).
# Add as much detail as to the bug description. Include the steps that would be needed to reproduce the bug. For the environment, write qa.moodle.net.
 
# Include screenshots that illustrate the problem, if possible.
 
# Give the issue the label 'mdlqa'.
 
 
# In the new Moodle (MDL) issue select 'Link' from the 'More actions' dropdown menu. <br />[[Image:LinkIssue.png|150px|Linking to the QA issue in the tracker]]
 
# In the new Moodle (MDL) issue select 'Link' from the 'More actions' dropdown menu. <br />[[Image:LinkIssue.png|150px|Linking to the QA issue in the tracker]]
 
# Link to the QA test by selecting 'blocks' as the link type, entering the MDLQA number that you noted earlier, and optionally adding a comment. <br />[[Image:LinkDetails.png|150px|Adding details for a link to the QA issue]]
 
# Link to the QA test by selecting 'blocks' as the link type, entering the MDLQA number that you noted earlier, and optionally adding a comment. <br />[[Image:LinkDetails.png|150px|Adding details for a link to the QA issue]]
 +
# Give the issue the label 'mdlqa'.
 
# (Optional) Add yourself as a watcher to the MDL issue so that you receive email notification when the issue is fixed.
 
# (Optional) Add yourself as a watcher to the MDL issue so that you receive email notification when the issue is fixed.
# When the MDL issue is fixed, hopefully within a day or two, the QA test can be reset, the reset QA test can then be run again.
+
# When the MDL issue is fixed, hopefully within a day or two, the QA test can be reset and can then be run again.
  
''Note for testers:''
+
==Resetting tests==
  
The [http://qa.moodle.net/ Moodle QA Testing Site] is updated daily at 11:00 UTC with the latest bug fixes to enable you to re-run QA tests.
+
''Note for integrators:''
 +
 
 +
After integrating a fix,
 +
 
 +
# Reset the MDLQA test, adding a comment.
 +
# Remove the 'mdlqa' label from the MDL issue.
 +
# If the issue doesn't have testing instructions, pass it with message "Will be tested by MDLQA-XXXX".
 +
 
 +
The tester will then receive email notification that the bug is fixed and will hopefully decide to run the test again soon.
  
''Note for integrators:''
+
==New QA tests required==
 +
 
 +
''Note for developers:''
 +
 
 +
If an issue fix cannot be covered by automated tests,
 +
 
 +
# Add the label 'qa_test_required' to the issue.
 +
# Add a comment explaining why it can't be covered by automated tests and suggesting which steps of the testing instructions should be included in a QA test e.g. steps 6-10 or all steps.
 +
 
 +
QA tests will then be written and included in the next QA cycle. For issues with long testing instructions, several QA tests will be written to cover the issue. If appropriate, activities etc. will be set up on the [https://qa.moodledemo.net/ Moodle QA Testing Site] to enable the issue to be easily tested in future.
 +
 
 +
Similarly, for new features and improvements which would benefit from exploratory testing,
 +
 
 +
# Add the label 'qa_test_required' to the issue.
 +
# Add a comment mentioning that exploratory testing is required.
  
After integrating a fix, please firstly add a comment to the linked MDLQA test thanking the tester and informing them that the test can be run again, then click the reset link. The tester will then receive email notification that the bug is fixed and will hopefully decide to run the test again soon. (Otherwise when the test is reset, it's assigned to nobody, and if the tester isn't watching the MDL issue, they won't know about the bug being fixed.)
+
Exploratory QA tests will then be written and included in the next QA cycle and then removed.
  
==The role of Core developers in creating tests==
+
==Updating tests==
  
When a developer adds functionality to Moodle, they should also do the following.
+
QA tests often become out-of-date due to new developments. If you would like to help with updating tests, you'll need to be a member of the test writers group in the Tracker. Please contact Helen about being added.
  
# Write user documentation in the User docs about the new feature (this should happen as part of the normal development process). Ask someone to proof read this documentation.
+
To update a QA test:
# Add a feature to the release notes. This feature should include a link to the appropriate Tracker issue, which will contain testing instructions. The feature should also include a link to the user documentation for the feature.
 
  
The QA tests will be written by the Community Manager or a Test Writer based on the documentation and release notes written by the developer.
+
# Search for the master copy of the test - with affects version as 'Master copy' and MDLQA-1 as parent.
 +
# Edit the test description.
 +
# Optional: Add a comment describing your edit.
  
 
==Writing new tests==
 
==Writing new tests==
  
Would you like to help with writing new QA tests? If so, you'll need to be a member of the test writers group in the Tracker. Please contact [http://moodle.org/user/profile.php?id=1408100 Tim Barker] about being added.
+
Would you like to help with writing new QA tests? If so, as for updating tests, you'll need to be a member of the test writers group in the Tracker. Please contact Helen about being added.
  
 
To create a new QA test:
 
To create a new QA test:
  
# Create a sub-task of MDLQA-1
+
# Choose an issue from the  [https://tracker.moodle.org/issues/?jql=labels%20%3D%20qa_test_required%20AND%20status%20%3D%20Closed closed qa_test_required-labelled issues]
 +
# Do a quick search of MDLQA-1 to check if there is an existing test which can be updated
 +
# If not, create a sub-task of MDLQA-1
 
# Select Master copy as affected version
 
# Select Master copy as affected version
 
# Select appropriate components including at least one of the following: User, Student, Teacher, Administrator
 
# Select appropriate components including at least one of the following: User, Student, Teacher, Administrator
# Leave the assignee as automatic (nobody)
+
# Set assignee as unassigned
 +
# Write the test (usually between 3 and 10 steps). It's a good idea to try doing the steps yourself as you write the test.
 +
# For tests which can’t be run on the QA site, label test_server_required. For OAuth 2 tests and any other tests which require a client ID or secret to be entered, label credentials_required.
 +
# For issues which specifically mention in the testing instructions to test in different browsers, use the phrase “Test in as many browsers as possible and mention in a comment which ones you’ve used.”
 +
# Go to the MDL issue and create a ‘has a QA test’ link to the new QA test, adding a comment “Thanks for this improvement which is now covered by the QA test MDLQA....”, and remove the qa_test_required label. ''Make sure that all QA tests are linked back to a corresponding MDL issue.''
  
 
New tests will be included in the next QA cycle.
 
New tests will be included in the next QA cycle.
Line 79: Line 108:
 
==Feedback==
 
==Feedback==
  
Feedback on all aspects of our QA testing process is welcome. If you have any questions or comments, please post in the [http://moodle.org/mod/forum/view.php?id=56 Testing and QA forum] in Using Moodle.
+
Feedback on all aspects of our QA testing process is welcome. If you have any questions or comments, please post in the [https://moodle.org/mod/forum/view.php?id=56 Testing and QA forum].
  
 
==See also==
 
==See also==
  
 +
* [https://tracker.moodle.org/secure/Dashboard.jspa?selectPageId=11454 QA testing dashboard]
 
* [[Testing credits]]
 
* [[Testing credits]]
 +
* [[MDLQA-features]]
 +
* [https://moodle.org/mod/forum/discuss.php?d=351302 Useful tips for QA testing]
  
 
Comments on tests from previous QA cycles:
 
Comments on tests from previous QA cycles:
* [http://tracker.moodle.org/browse/MDLQA-150 Moodle 2.0 QA Cycle 1]
+
* [https://tracker.moodle.org/browse/MDLQA-150 Moodle 2.0 QA Cycle 1]
* [http://tracker.moodle.org/browse/MDLQA-328 Moodle 2.0 QA Cycle 2]
+
* [https://tracker.moodle.org/browse/MDLQA-328 Moodle 2.0 QA Cycle 2]
* [http://tracker.moodle.org/browse/MDLQA-540 Moodle 2.0.2 QA]
+
* [https://tracker.moodle.org/browse/MDLQA-540 Moodle 2.0.2 QA]
* [http://tracker.moodle.org/browse/MDLQA-944 Moodle 2.1 QA Cycle 1]
+
* [https://tracker.moodle.org/browse/MDLQA-944 Moodle 2.1 QA Cycle 1]
* [http://tracker.moodle.org/browse/MDLQA-1190 Moodle 2.2 QA]
+
* [https://tracker.moodle.org/browse/MDLQA-1190 Moodle 2.2 QA]
 +
* [https://tracker.moodle.org/browse/MDLQA-1814 Moodle 2.3 QA]
 +
* [https://tracker.moodle.org/browse/MDLQA-4602 Moodle 2.4 QA]
 +
* [https://tracker.moodle.org/browse/MDLQA-5267 Moodle 2.5 QA]
 +
* [https://tracker.moodle.org/browse/MDLQA-5740 Moodle 2.6 QA]
 +
* [https://tracker.moodle.org/browse/MDLQA-6693 Moodle 2.7 QA]
 +
* [https://tracker.moodle.org/browse/MDLQA-7170 Moodle 2.8 QA]
 +
* [https://tracker.moodle.org/browse/MDLQA-7660 Moodle 2.9 QA]
 +
* [https://tracker.moodle.org/browse/MDLQA-8205 Moodle 3.0 QA]
 +
* [https://tracker.moodle.org/browse/MDLQA-9267 Moodle 3.1 QA]
 +
* [https://tracker.moodle.org/browse/MDLQA-9827 Moodle 3.2 QA]
 +
* [https://tracker.moodle.org/browse/MDLQA-10403 Moodle 3.3 QA]
 +
* [https://tracker.moodle.org/browse/MDLQA-10999 Moodle 3.4 QA]
 +
* [https://tracker.moodle.org/browse/MDLQA-11698 Moodle 3.5 QA]
 +
* [https://tracker.moodle.org/browse/MDLQA-12282 Moodle 3.6 QA]
 +
* [https://tracker.moodle.org/browse/MDLQA-12911 Moodle 3.7 QA]
 +
* [https://tracker.moodle.org/browse/MDLQA-13517 Moodle 3.8 QA]
  
 
[[Category:Quality Assurance]]
 
[[Category:Quality Assurance]]

Latest revision as of 09:55, 6 December 2019

Quality Assurance tests look at the functionality of Moodle from a user's point of view.

Real users systematically try each feature in Moodle and test that it works in the current version of the Moodle code. These tests are repeated in series of cycles, usually 4 weeks before a major release, once all major features have landed.

QA testing latest: A 100% pass rate was obtained in Moodle 3.8 QA testing. Many thanks to all our QA testers.

Getting involved

Would you like to help with QA testing? If so, please make sure you have created an account in the Moodle tracker, then contact Helen. Also, make sure you're subscribed to the Testing and QA forum in order to receive QA testing news updates.

All testers are members of the testers group in the Moodle Tracker, enabling them to pass or fail QA tests and add comments.

Running tests

  1. Go to the QA testing dashboard and choose a test from the list of current QA cycle open issues. When viewing a test, if you wish, you can click the 'Assign to me' link on the right, so that nobody else chooses the same test to run. (If you then find you are unable to run the test, you can click the Assign button and set the assignee as 'Unassigned'.) Please note:
    • Only assign an issue to yourself which no one else is testing (Assignee = Unassigned).
    • Only assign one issue at a time unless you plan to test a number of related issues within the next 24 hours. In other words, don't assign several issues to yourself then do nothing for several days. ;-)
    • The label test_server_required indicates issues that can't be tested on the QA testing site. The label credentials_required indicates that credentials such as an OAuth 2 service client ID and secret are required.
  2. Using either the Moodle QA Testing Site or your own test site running the latest Moodle 3.x dev (available from Git on the integration/master branch git://git.moodle.org/integration.git) with debugging set to developer, perform each of the steps listed in the test. If it makes sense, please test using the currently supported themes, Boost and Classic.
  3. Choose an appropriate workflow action:
    • Pass - Test runs perfectly. Add comment such as feedback about a new feature, browsers used for testing (if applicable), or simply "This test passes - yippee!"
    • Fail - Something doesn't work, or you obtain debugging messages. Add comment describing the step that doesn't work. If in doubt whether to pass a test, give it a fail and add a comment describing your doubts.
    • Obsolete - Test is no longer relevant in the current Moodle version. Add comment explaining why.

If you notice that the test description is out-of-date, add a comment mentioning that it needs updating. Alternatively, if you'd like to help with updating the test yourself, see below.

Moodle QA Testing Site

The Moodle QA Testing Site is updated daily at around 13:00 UTC with the latest bug fixes to enable you to re-run QA tests.

To prevent the site being used for sending spam, no emails are sent from it. Thus, tests involving email cannot be run using the Moodle QA Testing Site. (If such tests are attempted, an email debug message is displayed. This is not a bug but rather expected behaviour.)

Teacher and student accounts are provided. Please contact Helen if you would like admin or manager access to the Moodle QA Testing Site for running certain tests.

Failed tests

So you ran a test and it failed? Congratulations on finding a bug! Please do the following.

  1. Click the Fail button at the top of the page.
  2. Add a comment to the QA test stating that there was a problem and that you will report it as a Moodle bug.
  3. Note the MDLQA number; it will be something like MDLQA-448.
  4. Try searching for whether the bug has been reported previously, and if not create a new issue for it (as described in Tracker introduction).
  5. In the new Moodle (MDL) issue select 'Link' from the 'More actions' dropdown menu.
    Linking to the QA issue in the tracker
  6. Link to the QA test by selecting 'blocks' as the link type, entering the MDLQA number that you noted earlier, and optionally adding a comment.
    Adding details for a link to the QA issue
  7. Give the issue the label 'mdlqa'.
  8. (Optional) Add yourself as a watcher to the MDL issue so that you receive email notification when the issue is fixed.
  9. When the MDL issue is fixed, hopefully within a day or two, the QA test can be reset and can then be run again.

Resetting tests

Note for integrators:

After integrating a fix,

  1. Reset the MDLQA test, adding a comment.
  2. Remove the 'mdlqa' label from the MDL issue.
  3. If the issue doesn't have testing instructions, pass it with message "Will be tested by MDLQA-XXXX".

The tester will then receive email notification that the bug is fixed and will hopefully decide to run the test again soon.

New QA tests required

Note for developers:

If an issue fix cannot be covered by automated tests,

  1. Add the label 'qa_test_required' to the issue.
  2. Add a comment explaining why it can't be covered by automated tests and suggesting which steps of the testing instructions should be included in a QA test e.g. steps 6-10 or all steps.

QA tests will then be written and included in the next QA cycle. For issues with long testing instructions, several QA tests will be written to cover the issue. If appropriate, activities etc. will be set up on the Moodle QA Testing Site to enable the issue to be easily tested in future.

Similarly, for new features and improvements which would benefit from exploratory testing,

  1. Add the label 'qa_test_required' to the issue.
  2. Add a comment mentioning that exploratory testing is required.

Exploratory QA tests will then be written and included in the next QA cycle and then removed.

Updating tests

QA tests often become out-of-date due to new developments. If you would like to help with updating tests, you'll need to be a member of the test writers group in the Tracker. Please contact Helen about being added.

To update a QA test:

  1. Search for the master copy of the test - with affects version as 'Master copy' and MDLQA-1 as parent.
  2. Edit the test description.
  3. Optional: Add a comment describing your edit.

Writing new tests

Would you like to help with writing new QA tests? If so, as for updating tests, you'll need to be a member of the test writers group in the Tracker. Please contact Helen about being added.

To create a new QA test:

  1. Choose an issue from the closed qa_test_required-labelled issues
  2. Do a quick search of MDLQA-1 to check if there is an existing test which can be updated
  3. If not, create a sub-task of MDLQA-1
  4. Select Master copy as affected version
  5. Select appropriate components including at least one of the following: User, Student, Teacher, Administrator
  6. Set assignee as unassigned
  7. Write the test (usually between 3 and 10 steps). It's a good idea to try doing the steps yourself as you write the test.
  8. For tests which can’t be run on the QA site, label test_server_required. For OAuth 2 tests and any other tests which require a client ID or secret to be entered, label credentials_required.
  9. For issues which specifically mention in the testing instructions to test in different browsers, use the phrase “Test in as many browsers as possible and mention in a comment which ones you’ve used.”
  10. Go to the MDL issue and create a ‘has a QA test’ link to the new QA test, adding a comment “Thanks for this improvement which is now covered by the QA test MDLQA....”, and remove the qa_test_required label. Make sure that all QA tests are linked back to a corresponding MDL issue.

New tests will be included in the next QA cycle.

Feedback

Feedback on all aspects of our QA testing process is welcome. If you have any questions or comments, please post in the Testing and QA forum.

See also

Comments on tests from previous QA cycles: