Merge branch 'automated-testing' into 3.0

README.md

@@ -27,6 +27,7 @@ Featured on [wpmudev][wpmudev] — cheers for the review, folks!
 * [Features](#features)
 * [Getting Started](#getting-started)
 * [Documentation](#documentation)
+* [Testing](#testing)
 * [Acknowledgments](#acknowledgements)
 * [License](#license)
 * [Contact Information](#contact-information)
@@ -53,11 +54,20 @@ This Plugin provides:
 1. install all dependencies (`composer install`):
     * you will have to install `php-mbstring` manually if you do not already
       have it.
-
+      
 ## Documentation
 
 View the current docs [here][footnotes-docs].
 
+## Testing
+
+This repo. uses [PHPUnit](phpunit) to run automated tests. To run the full test 
+suite, use `composer run test`.
+
+Test cases are found in the `tests/` directory.
+
+PHPUnit settings are available in the file `phpunit.xml`.
+
 ## Acknowledgements
 
 Huge thanks to every **footnotes** user, contributor, bug reporter, feature
@@ -86,6 +96,7 @@ This project is licensed under the [GNU GPL v3][gpl-v3].
 [prettier]: https://prettier.io/
 [eslint]: https://eslint.org/
 [stylelint]: https://stylelint.io/
+[phpunit]: https://phpunit.de/
 [phpdocumentor]: https://phpdoc.org/
 [footnotes-docs]: https://markcheret.github.io/footnotes/
 [gpl-v3]: https://www.gnu.org/licenses/gpl-3.0.en.html

composer.json

@@ -24,7 +24,8 @@
         "post-install-cmd": "npm install",
         "minify": "npm run minify",
         "minify:css": "npm run minify:css",
-        "minify:js": "npm run minify:js"
+        "minify:js": "npm run minify:js",
+        "test": "phpunit"
     },
     "require-dev": {
         "dealerdirect/phpcodesniffer-composer-installer": "^0.7.1",

phpunit.xml

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit backupGlobals="false"
+         backupStaticAttributes="false"
+         bootstrap="./vendor/autoload.php"
+         colors="true"
+         convertErrorsToExceptions="true"
+         convertNoticesToExceptions="true"
+         convertWarningsToExceptions="true"
+         processIsolation="false"
+         stopOnFailure="false"
+>
+    <testsuites>
+        <testsuite name="Application Test Suite">
+            <directory>./tests/</directory>
+        </testsuite>
+    </testsuites>
+</phpunit>

tests/exampleTest.php

@@ -0,0 +1,13 @@
+<?php
+declare(strict_types=1);
+
+use PHPUnit\Framework\TestCase;
+
+final class ExampleTest extends TestCase {
+    public function testAdd() {
+        $result = 1 + 2;
+
+        $this->assertEquals(3, $result);
+    }
+}
+