Merge pull request #1581 from WPO-Foundation/test-test-1-2

feat(unit tests): Add phpunit to our stuff

.github/workflows/ci.yml

@@ -0,0 +1,19 @@
+name: CI
+
+on: [push]
+
+jobs:
+ build-test:
+ runs-on: ubuntu-latest
+
+ steps:
+ - uses: actions/checkout@v2
+
+ - uses: php-actions/composer@v5
+
+ - name: PHPUnit Tests
+ uses: php-actions/phpunit@v3
+ with:
+ configuration: tests/phpunit.xml
+ php_version: 7.4
+ php_extensions: gd

.gitignore

@@ -111,4 +111,7 @@ www/settings/custom_metrics/meta-viewport.js
 www/settings/custom_metrics/scriptTagCount.js
 www/settings/common
 www/settings/server
-www/robots.txt
+www/robots.txt
+
+vendor
+tests/*.cache

README.md

@@ -27,6 +27,13 @@ There are two examples using the [Restful API](https://docs.webpagetest.org/dev/
 
 There are 2 separate lies of development under different licenses and pull requests are accepted to either of them. The master branch where most active development is occurring is under the [Polyform Shield 1.0.0 license](LICENSE.md) and there is an "apache" branch which is under the more permissive Apache 2.0 license.
 
+## Testing the code
+
+WebPageTest uses [PHPUnit](https://phpunit.de/index.html) to run unit tests. In
+order to install PHPUnit and run the unit tests, you'll first need to install
+[Composer](https://getcomposer.org/). From there, you can run `composer install`
+and `composer test` to run the tests.
+
 # Change Log
 
 View the [WebPageTest Change Log](https://docs.webpagetest.org/change-log)

composer.json

@@ -0,0 +1,8 @@
+{
+ "require-dev": {
+ "phpunit/phpunit": "^9"
+ },
+ "scripts": {
+ "test": "phpunit --configuration tests/phpunit.xml"
+ }
+}