From 4ac6b8e9a51102e65da03580377afaa1d4bc1677 Mon Sep 17 00:00:00 2001
From: Joshua Ramon Enslin <joshua@museum-digital.de>
Date: Mon, 11 Nov 2019 12:13:52 +0100
Subject: [PATCH] Add test for start page

phpcs-errors:1646 phpunit-status:successful
---
 .gitignore                     |  3 +++
 composer.json                  |  5 +++++
 index.php                      |  2 +-
 scripts/checkCodeQuality.sh    | 40 ++++++++++++++++++++++++++++++++++
 tests/apisRandomImagesTest.php | 30 +++++++++++++++++++++++++
 tests/config.xml               | 37 +++++++++++++++++++++++++++++++
 6 files changed, 116 insertions(+), 1 deletion(-)
 create mode 100644 composer.json
 create mode 100644 scripts/checkCodeQuality.sh
 create mode 100644 tests/apisRandomImagesTest.php
 create mode 100644 tests/config.xml

diff --git a/.gitignore b/.gitignore
index 5112f1d..e0ee4a6 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,7 +1,10 @@
 /csv
+/composer.lock
 /translation-importer
 /values/langfiles
 *.swp
 *.swo
 commonservices
+/vendor/
 /xml
+.phpunit.result.cache
diff --git a/composer.json b/composer.json
new file mode 100644
index 0000000..cbadbc6
--- /dev/null
+++ b/composer.json
@@ -0,0 +1,5 @@
+{
+    "require-dev": {
+        "phpunit/phpunit": "^8.4"
+    }
+}
diff --git a/index.php b/index.php
index f31fe66..da6d05f 100644
--- a/index.php
+++ b/index.php
@@ -79,7 +79,7 @@ foreach ($availableFields as $headline => $fields) {
         echo "
         <li id='{$fieldName}' data-alt='{$field['name_human_readable']}' data-value='{$fieldName}' data-for='{$fieldName}' class='";
         if ($hasTooltip === true) echo " newToolTipTag";
-        if ($field['required'] === true) echo " requiredField";
+        if (!empty($field['required']) and $field['required'] === true) echo " requiredField";
         echo "'";
         if (!empty($field['dependsOn'])) {
             echo " data-dependencies='" . htmlspecialchars(implode(";", $field['dependsOn'])) . "'";
diff --git a/scripts/checkCodeQuality.sh b/scripts/checkCodeQuality.sh
new file mode 100644
index 0000000..5717f04
--- /dev/null
+++ b/scripts/checkCodeQuality.sh
@@ -0,0 +1,40 @@
+#!/bin/bash
+
+# Ensure that phpcs is available on the system.
+
+if ! [ -x "$(command -v phpcs)" ]; then
+    echo "This script needs phpcs installed to run!"
+    exit 1;
+fi
+
+# Load environment and load list of relevant instances.
+
+SCRIPT_DIR="$( cd "$( dirname "$0" )" && pwd )"
+
+# Run PHPCS
+
+PHPCS_RESULT=$(phpcs --standard=~/Rules/md_Rules/md_phpcs_rules.xml "$SCRIPT_DIR/../*.php" | grep " | " | wc -l)
+
+for i in "$SCRIPT_DIR/../"*; do
+    if [ "$(echo $i | grep -v "musdb" | wc -l)" = "0" ]; then
+        continue
+    fi
+    PHPCS_RESULT=$(echo "$(phpcs --standard=~/Rules/md_Rules/md_phpcs_rules.xml $i/*.php | grep " | " | wc -l) + $PHPCS_RESULT" | bc)
+done
+
+# PHPCS_RESULT=$(echo "$(phpcs --standard=~/Rules/md_Rules/md_phpcs_rules.xml "$SCRIPT_DIR/../*/*.php" | grep " | " | wc -l) + $PHPCS_RESULT" | bc)
+
+echo "phpcs-errors:$PHPCS_RESULT";
+
+# Run PHPUnit
+
+PHPUNIT_TEST_BASE_DIR="/var/www/vhosts/museum-digital.de/sandkasten.museum-digital.de"
+
+$(php $PHPUNIT_TEST_BASE_DIR/vendor/bin/phpunit --stderr -c $PHPUNIT_TEST_BASE_DIR/tests/config.xml --testdox $PHPUNIT_TEST_BASE_DIR/tests)
+PHPUNIT_EC=$?
+echo ""
+if [ "$PHPUNIT_EC" = "1" ]; then
+    echo "phpunit-status:failing";
+else
+    echo "phpunit-status:successful";
+fi
diff --git a/tests/apisRandomImagesTest.php b/tests/apisRandomImagesTest.php
new file mode 100644
index 0000000..3a766b7
--- /dev/null
+++ b/tests/apisRandomImagesTest.php
@@ -0,0 +1,30 @@
+<?PHP
+/**
+ * This script contains tests for the home page.
+ *
+ * @author Joshua Ramon Enslin <joshua@jrenslin.de>
+ */
+declare(strict_types=1);
+
+// phpcs:disable
+
+use PHPUnit\Framework\TestCase;
+
+final class StartPageLoadsTest extends TestCase {
+
+    public function testHTMLOutput():void {
+
+        ob_start();
+        include __DIR__ . "/../index.php";
+        $output = $this->getActualOutput();
+
+        $this->assertEquals(
+            true,
+            is_string($output)
+        );
+
+        ob_clean();
+
+    }
+
+}
diff --git a/tests/config.xml b/tests/config.xml
new file mode 100644
index 0000000..b828b98
--- /dev/null
+++ b/tests/config.xml
@@ -0,0 +1,37 @@
+<phpunit
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/|version|/phpunit.xsd"
+        backupGlobals="true"
+        backupStaticAttributes="false"
+        cacheResult="true"
+        cacheTokens="true"
+        colors="false"
+        convertErrorsToExceptions="false"
+        convertNoticesToExceptions="false"
+        convertWarningsToExceptions="false"
+        forceCoversAnnotation="false"
+        printerClass="PHPUnit\TextUI\ResultPrinter"
+        processIsolation="true"
+        stopOnError="true"
+        stopOnFailure="true"
+        stopOnIncomplete="true"
+        stopOnSkipped="true"
+        stopOnRisky="true"
+        testSuiteLoaderClass="PHPUnit\Runner\StandardTestSuiteLoader"
+        timeoutForSmallTests="1"
+        timeoutForMediumTests="10"
+        timeoutForLargeTests="60"
+        verbose="false">
+	<filter>
+		<whitelist processUncoveredFilesFromWhitelist="true">
+			<directory suffix=".php">../home/</directory>
+			<directory suffix=".php">../inc/</directory>
+			<!-- <file>/path/to/file</file>
+			<exclude>
+				<directory suffix=".php">/path/to/files</directory>
+				<file>/path/to/file</file>
+			</exclude>-->
+		</whitelist>
+	</filter>
+</phpunit>
+