diff options
| -rw-r--r-- | PRIVACY.md | 2 | ||||
| -rwxr-xr-x | config/global.ini.php | 2 | ||||
| -rw-r--r-- | core/Tracker/ScheduledTasksRunner.php | 2 | ||||
| -rw-r--r-- | js/piwik.js | 8 | ||||
| -rw-r--r-- | plugins/UsersManager/Controller.php | 2 | ||||
| -rw-r--r-- | tests/README.md | 37 | ||||
| -rw-r--r-- | tests/UI/expected-screenshots/UIIntegrationTest_admin_diagnostics_configfile.png | 4 | ||||
| -rw-r--r-- | tests/UI/expected-screenshots/UIIntegrationTest_dashboard2.png | 4 |
8 files changed, 30 insertions, 31 deletions
diff --git a/PRIVACY.md b/PRIVACY.md index ebf59b7861..02f41038bd 100644 --- a/PRIVACY.md +++ b/PRIVACY.md @@ -7,7 +7,7 @@ In this section we document how to protect the privacy of visitors who are track ### Anonymise visitor IP addresses By default, Matomo stores the visitor IP address (IPv4 or IPv6 format) in the database for each new visitor. -If a visitor has a static IP address this means her browsing history can be easily identified across several days and +If a visitor has a static IP address this means their browsing history can be easily identified across several days and even across several websites tracked within the same Matomo server. You can anonymize IP addresses to ensure visitors cannot be tracked this way: [How to anonymise IP addresses.](https://matomo.org/docs/privacy/#step-1-automatically-anonymize-visitor-ips) diff --git a/config/global.ini.php b/config/global.ini.php index d86791af7f..3fec499e6f 100755 --- a/config/global.ini.php +++ b/config/global.ini.php @@ -352,7 +352,7 @@ enable_browser_archiving_triggering = 1 ; or make sure the date ranges users' want to see will be processed somehow. archiving_range_force_on_browser_request = 1 -; By default Matomo will automatically archive all date ranges any user has chosen in his account settings. +; By default Matomo will automatically archive all date ranges any user has chosen in their account settings. ; This is limited to the available options last7, previous7, last30 and previous30. ; If you need any other period, or want to ensure one of those is always archived, you can define them here archiving_custom_ranges[] = diff --git a/core/Tracker/ScheduledTasksRunner.php b/core/Tracker/ScheduledTasksRunner.php index 2cab2a2ac1..770dfed06f 100644 --- a/core/Tracker/ScheduledTasksRunner.php +++ b/core/Tracker/ScheduledTasksRunner.php @@ -43,7 +43,7 @@ class ScheduledTasksRunner // this could be too aggressive minimum interval (some hours would be skipped in case of low traffic) $minimumInterval = TrackerConfig::getConfigValue('scheduled_tasks_min_interval'); - // If the user disabled browser archiving, he has already setup a cron + // If the user disabled browser archiving, they have already setup a cron // To avoid parallel requests triggering the Scheduled Tasks, // Get last time tasks started executing $cache = Cache::getCacheGeneral(); diff --git a/js/piwik.js b/js/piwik.js index e8fa4b4760..18323673a4 100644 --- a/js/piwik.js +++ b/js/piwik.js @@ -5958,7 +5958,7 @@ if (typeof window.Matomo !== 'object') { * * When you call this method, we imply that the user has given cookie consent for this page view, and will also * imply consent for all future page views unless the cookie expires or the user - * deletes all her or his cookies. Remembering cookie consent means even if you call {@link disableCookies()}, + * deletes all their cookies. Remembering cookie consent means even if you call {@link disableCookies()}, * then cookies will still be enabled and it won't disable cookies since the user has given consent for cookies. * * Please note that this feature requires you to set the `cookieDomain` and `cookiePath` correctly. Please @@ -6760,8 +6760,8 @@ if (typeof window.Matomo !== 'object') { /** * When called, no tracking request will be sent to the Matomo server until you have called `setConsentGiven()` - * unless consent was given previously AND you called {@link rememberConsentGiven()} when the user gave her - * or his consent. + * unless consent was given previously AND you called {@link rememberConsentGiven()} when the user gave their + * consent. * * This may be useful when you want to implement for example a popup to ask for consent before tracking the user. * Once the user has given consent, you should call {@link setConsentGiven()} or {@link rememberConsentGiven()}. @@ -6842,7 +6842,7 @@ if (typeof window.Matomo !== 'object') { * * When you call this method, we imply that the user has given consent for this page view, and will also * imply consent for all future page views unless the cookie expires (if timeout defined) or the user - * deletes all her or his cookies. This means even if you call {@link requireConsent()}, then all requests + * deletes all their cookies. This means even if you call {@link requireConsent()}, then all requests * will still be tracked. * * Please note that this feature requires you to set the `cookieDomain` and `cookiePath` correctly and requires diff --git a/plugins/UsersManager/Controller.php b/plugins/UsersManager/Controller.php index 617bace475..ce979f36be 100644 --- a/plugins/UsersManager/Controller.php +++ b/plugins/UsersManager/Controller.php @@ -447,7 +447,7 @@ class Controller extends ControllerAdmin $anonymousDefaultReport = Piwik::getLoginPluginName(); } else { // we manually imitate what would happen, in case the anonymous user logs in - // and is redirected to the first website available to him in the list + // and is redirected to the first website available to them in the list // @see getDefaultWebsiteId() $anonymousDefaultReport = '1'; $anonymousDefaultSite = $anonymousSites[0]['key']; diff --git a/tests/README.md b/tests/README.md index 4f86392ff7..6218333a51 100644 --- a/tests/README.md +++ b/tests/README.md @@ -1,21 +1,20 @@ -Piwik comes with unit tests, integration tests, system tests, Javascript tests and UI tests. -This document briefly describes how to use and modify Piwik tests. +Matomo comes with unit tests, integration tests, system tests, Javascript tests and UI tests. +This document briefly describes how to use and modify Matomo tests. ## Continuous Integration We use Travis CI for our continuous integration server. It automatically runs our battery of thousands of unit/integration/screenshot tests after each commit to our GIT repo. More information at the links: - * Piwik on Travis CI: https://travis-ci.org/piwik/piwik - * QA in Piwik: https://matomo.org/qa/ + * Matomo on Travis CI: https://travis-ci.com/matomo-org/matomo -Each core Piwik developer is responsible to keep the build green. If a developer breaks the build, he will receive an email from Travis CI. +Each core Matomo developer is responsible to keep the build green. If a developer breaks the build, they will receive an E-Mail from Travis CI. The next section explains how you can run the test suite on your own dev machine. -## How To Run Piwik Tests +## How To Run Matomo Tests -To run tests, you must install Piwik via Git and set it up for development. A guide for this is available in our [Developer Zone](http://developer.piwik.org/guides/getting-started-part-1). The part about "Creating a plugin" can be skipped. +To run tests, you must install Matomo via Git and set it up for development. A guide for this is available in our [Developer Zone](https://developer.matomo.org/guides/getting-started-part-1). The part about "Creating a plugin" can be skipped. To execute the tests: @@ -29,21 +28,21 @@ To execute the tests: ## PHPUnit Tests -1. To install PHPUnit, run `php composer.phar install --dev` in the Piwik root directory. +1. To install PHPUnit, run `php composer.phar install --dev` in the Matomo root directory. -2. Ensure the `[database_tests]` section in `piwik/config/config.ini.php` is set up correctly, +2. Ensure the `[database_tests]` section in `matomo/config/config.ini.php` is set up correctly, i.e. with the correct password to prevent the following error: `SQLSTATE[28000] [1045] Access denied for user 'root'@'localhost' (using password: NO)` 3. Run the tests - $ cd /path/to/piwik + $ cd /path/to/matomo $ ./console tests:run --testsuite unit $ ./console tests:run --testsuite integration $ ./console tests:run --testsuite system There are also two main groups of tests: core and plugins - For example run `./console tests:run core` to run all Core Piwik tests. + For example run `./console tests:run core` to run all Core Matomo tests. You can combine testsuite and groups like this: `./console tests:run --testsuite unit core`. This would run all unit tests in core. @@ -69,7 +68,7 @@ your test will be really fast. It is an integration test if you have any dependency to a loaded plugin, to the filesystem, web, config, database or something similar. It is an integration test if you test multiple classes in one test. -It is a system test if you - for instance - make a call to Piwik itself via HTTP or CLI and the whole system is being tested. +It is a system test if you - for instance - make a call to Matomo itself via HTTP or CLI and the whole system is being tested. ### Why do we split tests in unit, integration, system and ui folders? @@ -88,14 +87,14 @@ not tested they would be still marked as tested when running integration tests. System tests files are in `tests/PHPUnit/System/*Test.php` -System tests allow to test how major Piwik components interact together. +System tests allow to test how major Matomo components interact together. A test will typically generate hits to the Tracker (record visits and page views) and then test all API responses and for each API output. It then checks that they match expected XML (or CSV, json, etc.). If a test fails, you can compare the processed/ and expected/ directories in a graphical text compare tool, such as WinMerge on Win, or MELD on Linux, or even with PhpStorm, to easily view changes between files. For example using Meld, click on "Start new comparison", "Directory comparison", -in "Original" select "path/to/piwik/tests/PHPUnit/System/expected" -in "Mine" select "path/to/piwik/tests/PHPUnit/System/processed" +in "Original" select "path/to/matomo/tests/PHPUnit/System/expected" +in "Mine" select "path/to/matomo/tests/PHPUnit/System/processed" If changes are expected due to the code changes you make, simply copy the file from processed/ to expected/, and test will then pass. Copying files is done easily using Meld (ALT+LEFT). Otherwise, if you didn't expect to modify the API outputs, it might be that your changes are breaking some features unexpectedly. @@ -133,11 +132,11 @@ If you use Ubuntu or another Linux distribution, you must make one change to the ## JavaScript Tests -piwik.js is unit tested and you can run the Javascript tests at: /piwik/tests/javascript/ +piwik.js is unit tested and you can run the Javascript tests at: /matomo/tests/javascript/ ## Testing Data -See [tests/README.testing-data.md](https://github.com/matomo-org/matomo/blob/master/tests/README.testing-data.md) to import testing data in Piwik. +See [tests/README.testing-data.md](https://github.com/matomo-org/matomo/blob/master/tests/README.testing-data.md) to import testing data in Matomo. ## UI Screenshots Tests @@ -151,7 +150,7 @@ You can retrieve the files generated during the build (the build artifacts) at [ ### Test logs on CI -By default tests running on Travis CI will log all messages of at least `INFO` level in `$PIWIK_ROOT_DIR/tmp/logs/piwik.log`. In a given travis build output, you can view the logs by clicking on the line `$ cat $PIWIK_ROOT_DIR/tmp/logs/matomo.log` at the end of the build output text. +By default tests running on Travis CI will log all messages of at least `INFO` level in `$PIWIK_ROOT_DIR/tmp/logs/matomo.log`. In a given travis build output, you can view the logs by clicking on the line `$ cat $PIWIK_ROOT_DIR/tmp/logs/matomo.log` at the end of the build output text. Note: `DEBUG` and `VERBOSE` messages are not logged by default (to keep Travis page loading fast). At any time you can temporarily enable logging by [modifying this file](https://github.com/matomo-org/matomo/blob/master/tests/PHPUnit/config.ini.travis.php#L23-27) and changing `log_level = info` to `log_level = debug` or `log_level = verbose`. @@ -176,7 +175,7 @@ See [tests/PHPUnit/Benchmarks/README.md](https://github.com/matomo-org/matomo/bl ### Profiling -See [tests/README.xhprof.md](https://github.com/matomo-org/matomo/blob/master/tests/README.xhprof.md) for help on how to profile Piwik with XHProf. +See [tests/README.xhprof.md](https://github.com/matomo-org/matomo/blob/master/tests/README.xhprof.md) for help on how to profile Matomo with XHProf. diff --git a/tests/UI/expected-screenshots/UIIntegrationTest_admin_diagnostics_configfile.png b/tests/UI/expected-screenshots/UIIntegrationTest_admin_diagnostics_configfile.png index 27a9008c94..f0302ae30b 100644 --- a/tests/UI/expected-screenshots/UIIntegrationTest_admin_diagnostics_configfile.png +++ b/tests/UI/expected-screenshots/UIIntegrationTest_admin_diagnostics_configfile.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:2746ddd05ff7a478fd6c3be3610a6da96e96ca1376ee7a8f232af3691e9a4ade -size 4949384 +oid sha256:fce9b20b21526eb301aed8206660f85903e37c3b5d2ac562f1e238234104833e +size 4950503 diff --git a/tests/UI/expected-screenshots/UIIntegrationTest_dashboard2.png b/tests/UI/expected-screenshots/UIIntegrationTest_dashboard2.png index a82c7b5487..29c3895ff6 100644 --- a/tests/UI/expected-screenshots/UIIntegrationTest_dashboard2.png +++ b/tests/UI/expected-screenshots/UIIntegrationTest_dashboard2.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:bdde60d2630c9ce0283b643ec337fc8dac86a7ac11937d93978d4c0021fad51e -size 1564072 +oid sha256:71f8d63f344497a452b6dfe1387b2dc897653b58dd091f9f461fc53668171245 +size 1566714 |
