From a560378ea1bf7c782681e425600579b91361c207 Mon Sep 17 00:00:00 2001
From: vincent-gao <vincent.gao@dpc.vic.gov.au>
Date: Mon, 24 May 2021 11:05:24 +1000
Subject: [PATCH] Adds phpunit to dev-tools (#50)

* install phpunit

* switch to phpunit 8.5

* switch to phpunit6.5

* remove xss patch

* add core-dev as dev a dependency

* adds custom phpunit.xml.dist

* update base url and db link to phpunit

* reverts tide_core

* set test directory

* update test.sh

* test

* removed drupal-test-traits

* updates readme file
---
 .circleci/test.sh |  3 ++
 README.md         | 12 +++++++
 composer.dev.json |  4 ++-
 phpunit.xml.dist  | 85 +++++++++++++++++++++++++++++++++++++++++++++++
 4 files changed, 103 insertions(+), 1 deletion(-)
 create mode 100644 phpunit.xml.dist

diff --git a/.circleci/test.sh b/.circleci/test.sh
index 41fd68e..47282e1 100755
--- a/.circleci/test.sh
+++ b/.circleci/test.sh
@@ -10,3 +10,6 @@ ahoy lint
 echo "==> Run Behat tests"
 mkdir -p /tmp/artifacts/behat
 ahoy test-behat || ahoy test-behat -- --rerun
+
+echo "==> Run Unit tests"
+ahoy cli "/app/vendor/bin/phpunit"
diff --git a/README.md b/README.md
index 3e8f9a1..5711e48 100644
--- a/README.md
+++ b/README.md
@@ -118,6 +118,7 @@ Finally, we install the module itself.
 1. Uncomment this line in `docker-compose.yml`:
   ```
   #XDEBUG_ENABLE: "true"
+  #DOCKERHOST: "host.docker.internal"
   ```
 2. Restart the stack: `ahoy up`.
 3. Enable listening for incoming debug connections in your IDE.
@@ -181,3 +182,14 @@ To make a change:
 6. If the build passes, merge the Dev Tools branch to `master` and make a release.
     - NOTE: This must be a release in GitHub, see https://github.com/dpc-sdp/dev-tools/releases/new
 7. Remove the temporary branch in `tide_*` module from Step 3. 
+
+## Unit test
+The dev-tools supports unit tests. 
+### Registering tests
+#### Directory
+1. The unit tests should go in `tests\src\Unit` direcotry. 
+2. The unit tests need to respect PSR-4 namespace naming convention, in our case, 
+    `namespace Drupal\Tests\{module}\Unit`
+### 2 ways to run tests
+1. commit to CI.
+2. Run `./vendor/bin/phpunit` inside CLI container locally.
diff --git a/composer.dev.json b/composer.dev.json
index 07e110c..f358688 100644
--- a/composer.dev.json
+++ b/composer.dev.json
@@ -25,7 +25,9 @@
         "phpcompatibility/php-compatibility": "^9.1",
         "ubirak/rest-api-behat-extension": "dev-feature/drupalextension-compatibility as 7.0.0",
         "symfony/filesystem": "^3.2.8",
-        "php-http/curl-client": "^1.7"
+        "php-http/curl-client": "^1.7",
+        "phpunit/phpunit": "^6.5",
+        "drupal/core-dev":"8.9.x"
     },
     "autoload": {
         "classmap": [
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
new file mode 100644
index 0000000..8065eec
--- /dev/null
+++ b/phpunit.xml.dist
@@ -0,0 +1,85 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!-- TODO set checkForUnintentionallyCoveredCode="true" once https://www.drupal.org/node/2626832 is resolved. -->
+<!-- PHPUnit expects functional tests to be run with either a privileged user
+ or your current system user. See core/tests/README.md and
+ https://www.drupal.org/node/2116263 for details.
+-->
+<phpunit bootstrap="docroot/core/tests/bootstrap.php" colors="true"
+         beStrictAboutTestsThatDoNotTestAnything="true"
+         beStrictAboutOutputDuringTests="true"
+         beStrictAboutChangesToGlobalState="true"
+         printerClass="\Drupal\Tests\Listeners\HtmlOutputPrinter">
+  <php>
+    <!-- Set error reporting to E_ALL. -->
+    <ini name="error_reporting" value="32767"/>
+    <!-- Do not limit the amount of memory tests take to run. -->
+    <ini name="memory_limit" value="-1"/>
+    <!-- Example SIMPLETEST_BASE_URL value: http://localhost -->
+    <env name="SIMPLETEST_BASE_URL" value="http://nginx:8080"/>
+    <!-- Example SIMPLETEST_DB value: mysql://username:password@localhost/databasename#table_prefix -->
+    <env name="SIMPLETEST_DB" value="mysql://drupal:drupal@mariadb:3306/drupal"/>
+    <!-- Example BROWSERTEST_OUTPUT_DIRECTORY value: /path/to/webroot/sites/simpletest/browser_output -->
+<!--    <env name="BROWSERTEST_OUTPUT_DIRECTORY" value="/tmp/unit_test"/>-->
+    <!-- To have browsertest output use an alternative base URL. For example if
+     SIMPLETEST_BASE_URL is an internal DDEV URL, you can set this to the
+     external DDev URL so you can follow the links directly.
+    -->
+<!--    <env name="BROWSERTEST_OUTPUT_BASE_URL" value=""/>-->
+    <!-- To disable deprecation testing completely uncomment the next line. -->
+    <!-- <env name="SYMFONY_DEPRECATIONS_HELPER" value="disabled"/> -->
+    <!-- Example for changing the driver class for mink tests MINK_DRIVER_CLASS value: 'Drupal\FunctionalJavascriptTests\DrupalSelenium2Driver' -->
+<!--    <env name="MINK_DRIVER_CLASS" value=''/>-->
+    <!-- Example for changing the driver args to mink tests MINK_DRIVER_ARGS value: '["http://127.0.0.1:8510"]' -->
+<!--    <env name="MINK_DRIVER_ARGS" value=''/>-->
+    <!-- Example for changing the driver args to phantomjs tests MINK_DRIVER_ARGS_PHANTOMJS value: '["http://127.0.0.1:8510"]' -->
+<!--    <env name="MINK_DRIVER_ARGS_PHANTOMJS" value=''/>-->
+    <!-- Example for changing the driver args to webdriver tests MINK_DRIVER_ARGS_WEBDRIVER value: '["chrome", { "chromeOptions": { "w3c": false } }, "http://localhost:4444/wd/hub"]' For using the Firefox browser, replace "chrome" with "firefox" -->
+<!--    <env name="MINK_DRIVER_ARGS_WEBDRIVER" value=''/>-->
+  </php>
+  <testsuites>
+    <testsuite name="unit">
+      <directory>./dpc-sdp/*/tests/src/Unit</directory>
+    </testsuite>
+<!--    <testsuite name="kernel">-->
+<!--      <file>./tests/TestSuites/KernelTestSuite.php</file>-->
+<!--    </testsuite>-->
+<!--    <testsuite name="functional">-->
+<!--      <file>./tests/TestSuites/FunctionalTestSuite.php</file>-->
+<!--    </testsuite>-->
+<!--    <testsuite name="functional-javascript">-->
+<!--      <file>./tests/TestSuites/FunctionalJavascriptTestSuite.php</file>-->
+<!--    </testsuite>-->
+<!--    <testsuite name="build">-->
+<!--      <file>./tests/TestSuites/BuildTestSuite.php</file>-->
+<!--    </testsuite>-->
+  </testsuites>
+  <listeners>
+    <listener class="\Drupal\Tests\Listeners\DrupalListener">
+    </listener>
+    <!-- The Symfony deprecation listener has to come after the Drupal listener -->
+    <listener class="Symfony\Bridge\PhpUnit\SymfonyTestsListener">
+    </listener>
+  </listeners>
+  <!-- Filter for coverage reports. -->
+  <filter>
+    <whitelist>
+      <directory>./includes</directory>
+      <directory>./lib</directory>
+      <!-- Extensions can have their own test directories, so exclude those. -->
+      <directory>./modules</directory>
+      <exclude>
+        <directory>./modules/*/src/Tests</directory>
+        <directory>./modules/*/tests</directory>
+      </exclude>
+      <directory>../modules</directory>
+      <exclude>
+        <directory>../modules/*/src/Tests</directory>
+        <directory>../modules/*/tests</directory>
+        <directory>../modules/*/*/src/Tests</directory>
+        <directory>../modules/*/*/tests</directory>
+      </exclude>
+      <directory>../sites</directory>
+     </whitelist>
+  </filter>
+</phpunit>