Skip to content
Snippets Groups Projects
Commit c3b1bcfd authored by eileen's avatar eileen :8ball:
Browse files

Merge branch 'master-labels' into 'master'

pr-review.md - Update info about test-results

See merge request documentation/docs/dev!1189
parents 6c6439ce 4bc4bd1b
No related branches found
No related tags found
No related merge requests found
......@@ -50,23 +50,59 @@ Confirm which branch the PR was created against. This is probably either `master
Confirm that the issue was a problem and a problem “worth solving”, generally worthy of being in core.
## Reproduce the fix
## Validate the fix
Confirm that the PR works as advertised by observing the result in the build.
Confirm that the PR works as advertised. Follow some mix of these steps:
You can either test locally or on the test server.
* Use the automatic demo-site
* Review automatic test-results
* Request additional test-results
* Apply the patch locally
### Using the test server to review
### Use the automatic demo-site
Our test server automatically creates a dedicated CiviCRM installation for every PR so that (in most cases) it's easy to review the PR without needing to set up a local installation with the fix applied. To access the test build follow these steps:
Whenever a pull-request is submitted or updated, the test server will create a new demo-site. Civibot will post a link to the "_Online demo of this PR_".
1. In the PR, find the section at the bottom of the page which says "All checks have passed"
1. Go to: "Show all checks" > "Details" > "Console Output" > "Full Log"
1. Search in page for `CMS_URL`
1. The first result should bring you to a URL which points to an installation for the build of this PR.
1. Click on the URL to go to the built site
1. To get login credentials click on "test sites" link from Civibot's (Standard links) comment on the PR
### Reviewing locally
!!! question "What if there are no demo sites?"
The demo may have expired. Demos are usually retained for a few days. But if there is a lot of activity, then it may only be a few hours.
Alternatively, the PR may have a bug that prevents installation.
In either case, proceed to the next step ("_Review automatic test-results_"). It will provide a console log and the option to retry.
### Review automatic test-results
1. In the PR timeline, find the latest commit.
2. Find the status icon (*orange dot, red X, or green checkmark*) and click on it.
3. Drill-down on the "Details".
4. This page shows a list of automatic tasks -- such as building the demo, running low-level unit-tests, running end-to-end tests, and similar.
5. Each task will have a few links available, such as:
* __Statistical summary__: If the test-suite runs normally, it will provide a report of successes and failures.
* __Console output__: Use this to monitor an active job or to identify fatal errors.
* __Retry__: Run the task again. This is useful if the test-results have expired or if the test-server went offline.
### Request additional test-results
By default, the automatic tests include one demo site and a variety of tests. However, deeper tests may be appropriate if:
* The patch involves a CiviCRM integration (such as CiviCRM-Drupal or CiviCRM-WordPress).
* The patch involves low-level code (such as the installer or the bootstrap process).
If you have permission to add labels, then you may request further tests with any of these labels:
| Label | Description |
|--|--|
| `run-backdrop` | Create a demo-site with Backdrop. Run end-to-end tests on Backdrop. |
| `run-drupal-7` | Create a demo-site with Drupal 7. Run end-to-end tests on Drupal 7. |
| `run-drupal-x` | Create a demo-site with Drupal 9/10. Run end-to-end tests on Drupal 9/10. |
| `run-wordpress` | Create a demo-site with WordPress. Run end-to-end tests on WordPress. |
| `run-extended-tests` | Run a comprehensive set of tests, including Backdrop, D7/D9/10, WordPress, and several versions of PHP-MySQL. |
| `run-distmaker` | Create a set of zip-files/tar-files which include the patch. Use these to install locally. |
Every label added will create more outputs and require additional time to complete.
### Apply the patch locally
For more complicated PRs it is sometimes helpful or necessary to manually test them within a local development installation.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment