We'll show you how to find a pull request and how to test the patch. We've created a youtube video showing how to test a patch: Live presentation "Test patch in 3 minutes"
What do I need to test a patch?
- 1. Possibility: Use the Online PBF environment
You do not need to authenticate yourself in the patch tester with GitHub. In the Issue Tracker ( http: //issues.joomla .org ) you can log in directly with GitHub and comment on it. Go to the online PBF environment guide .
Second Option: Use the local installation.
You'll need to install a local server (with Windows it is Xampp), a Nightly Build and the Patchtester Component. Then you can authenticate yourself in the Patch Tester and comment comfortably from there. See the Local Installation Guide .
And this is how it works:
1st Find a Pull Request to test:
On the morning of the PBF event, a Google document is released containing all the patches to be tested. On this list, all participants can enter information at the same time, so that everyone knows who is working on what, what has already been done and what may need to be considered.
The list will look like this:
Column A:: The linked patch (ID = number).
Green means simple testing with test description.
Yellow means advanced testing ; little or no test description / simple code.
Red means no test description and more extensive code or even writing code.
Column B: Tester 1 enters his name as soon as he has decided on a patch. When the test is done, enter the result, i.e. "successful", "not successful"
Column C: Tester 2 can work at the same time as Tester 1.
Column D: Diese Spalte bearbeitet ein “Produktverantwortlicher”. Das ist jemand, der die Schreibrechte für den Quelltext hat.
Hints / issues: Here you can add additional Information.
2. Structure of the Issue Tracker
on item 1: Using the issue tracker requires a GitHub account. Sing up on https://github.com/. When registering, you must autorize for Joomla!. If you've enabled Two-Factor Authentication for your GitHub account , you'll need a personal token to access under https://github.com/settings/applications and paste it into the GitHub token field. For more information, see the Patch Tester's Guide .
to point 2: You can select your language, but then only the menu items will be displayed in your language. Why? Because there is no translator for comments. Please comment in English, because people from all nations are working here.
to point 3: Filter the patches. Click the "Search Tools" button in the Patch Tester
for a specific ID
for the type "issue" or "pull request"
for easy tests
to point 4: The status is important and is explained here:
New ("new"): The bug has been reported, nothing has been done yet. Maybe you want to adjust and confirm it?
Confirmed: The bug has been confirmed, but there is no patch yet. Developers will find a solution (or you can fix the bug?)
Pending: There is a patch to fix the bug and now must be be tested. Look for the label next to the title, as it tells you which Joomla! Version of the patch was created. We test only Version 4.0.
Simple ("easy"): The patch has sufficient test description to test it without much prior knowledge.
Ready to commit ("RTC"): There's nothing left for us to do, even though the patch is on our list; The patch has been successfully tested and the code can be submitted and will be released soon.
Closed: The patch or bug entry has been closed, there's nothing left for us to do
5th: The error description; Clicking on the itile to go to the detailled description.
Third: Adjust the error and execute the test.
A list of all the bugs we want to edit at PBF will be distributed on the morning of the PBF.
Choose from the list an entry that has not yet been edited by two other reviewers.
To do this, switch to the Joomla backend in the "Patch Tester" component and search for the error. Normally you can use the search field on the top right to search for the pull ID.
Fetch your patch
First you read the error description and decide if you want to test this patch or not. If you want to test this patch, enter yourself as Tester1 or Tester2 in the Google doc. This way we make sure that not everyone tests the same patch.
Readjust the bug, test the patch
Now you log into your Joomla backend and replicate the bug/error in your own Joomla installation. This is an important step, because by adjusting the error, you can check if the bug actually exists (yet).
4th Apply Patch (Patch Tester)
You apply the patch by clicking on the blue button "Apply Patch". The button turns green. The error correction or new feature will automatically be added to your Joomla! - Installation recorded.
If the button "Apply Patch" is hidden, you have to search for the ID in the list.
The patch has been applied.
- Now perform all steps exactly as described in the test statement. Is the problem fixed now?
- Look at the code! Even if you don't really understand the code completely, you should get an overview which files have been changed.
- Test also whether the behavior affects other parts of Joomla. Do unexpected effects occur?
5th Take Back Patch (Revert Patch)
Click on the button "revert", the patch tester restores the status of the patch from before.
And after the button turns blue, you get the following message:
6th Comment (Issue Tracker)
Whether the test was successful or unsuccessful it must be logged in the Issue Tracker ( http://issues.joomla.org ). You can either access the page ( http://issues.joomla.org ) to the "Issue Tracker" or via the patch tester by clicking on the yellow "Issue Tracker" button.
Comments must be written in English.
Mark the test result: Click on the button "Test this". Mark whether the test was successful or not. The Issue tracker will automatically generate a Success (or Failure) message.
You can comment on the test result if you want. For example, if the code cannot be verified, e.g. "I don´t understand the Code, but it works". If you are inhibited from writing a comment: Here you can find examples of comment texts (English).
With the Submit button you publish your test result.