From d4185b2b0543e2c0640d6fdc417ad7a20209fd8b Mon Sep 17 00:00:00 2001
From: Alex Tselegidis <alextselegidis@gmail.com>
Date: Fri, 24 Mar 2023 08:11:25 +0100
Subject: [PATCH] Load the framework while testing in order to allow for
 additional tests

---
 application/config/testing/routes.php      | 20 +++++++++++
 application/controllers/Test.php           | 39 ++++++++++++++++++++++
 composer.json                              |  7 +++-
 index.php                                  | 12 ++++++-
 phpunit.xml                                |  2 +-
 tests/TestCase.php                         | 27 +++++++++++++++
 tests/Unit/Helper/ArrayHelperTest.php      | 18 +++++-----
 tests/Unit/Helper/ValidationHelperTest.php |  6 ++--
 tests/bootstrap.php                        |  5 ---
 9 files changed, 114 insertions(+), 22 deletions(-)
 create mode 100644 application/config/testing/routes.php
 create mode 100644 application/controllers/Test.php
 create mode 100644 tests/TestCase.php
 delete mode 100644 tests/bootstrap.php

diff --git a/application/config/testing/routes.php b/application/config/testing/routes.php
new file mode 100644
index 00000000..f5b2c68d
--- /dev/null
+++ b/application/config/testing/routes.php
@@ -0,0 +1,20 @@
+<?php defined('BASEPATH') or exit('No direct script access allowed');
+
+/*
+| -------------------------------------------------------------------------
+| TESTING ROUTES
+| -------------------------------------------------------------------------
+| The following routes are defined in order for CI to be able to process 
+| test execution requests via the CLI. 
+|
+| The Test controller class is used as a placeholder for this purpose.
+|
+*/
+
+$route['default_controller'] = 'test/index';
+$route['404_override'] = 'test/index'; // when in doubt, use the hammer
+$route['translate_uri_dashes'] = FALSE;
+
+
+/* End of file routes.php */
+/* Location: ./application/config/testing/routes.php */
diff --git a/application/controllers/Test.php b/application/controllers/Test.php
new file mode 100644
index 00000000..e729149f
--- /dev/null
+++ b/application/controllers/Test.php
@@ -0,0 +1,39 @@
+<?php defined('BASEPATH') or exit('No direct script access allowed');
+
+/* ----------------------------------------------------------------------------
+ * Easy!Appointments - Online Appointment Scheduler
+ *
+ * @package     EasyAppointments
+ * @author      A.Tselegidis <alextselegidis@gmail.com>
+ * @copyright   Copyright (c) Alex Tselegidis
+ * @license     https://opensource.org/licenses/GPL-3.0 - GPLv3
+ * @link        https://easyappointments.org
+ * @since       v1.5.0
+ * ---------------------------------------------------------------------------- */
+
+/*
+ * This file can only be used in a testing environment and only from the termninal.
+ */
+
+if (ENVIRONMENT !== 'testing' || ! is_cli())
+{
+    show_404();
+}
+
+/**
+ * Test controller.
+ *
+ * This controller does not have or need any logic, it is just used so that CI can be loaded properly during the test
+ * execution.
+ */
+class Test extends EA_Controller {
+    /**
+     * Placeholder callback.
+     *
+     * @return void
+     */
+    public function index(): void
+    {
+        //
+    }
+}
diff --git a/composer.json b/composer.json
index 7bd60c88..10ced5ce 100644
--- a/composer.json
+++ b/composer.json
@@ -45,6 +45,11 @@
         "phpunit/phpunit": "^10.0.18"
     },
     "scripts": {
-        "test": "php vendor/bin/phpunit"
+        "test": "APP_ENV=testing php vendor/bin/phpunit"
+    },
+    "autoload": {
+        "psr-4": {
+            "Tests\\": "tests/"
+        }
     }
 }
diff --git a/index.php b/index.php
index da730790..120373e4 100644
--- a/index.php
+++ b/index.php
@@ -89,7 +89,17 @@ require_once __DIR__ . '/vendor/autoload.php';
  *
  * NOTE: If you change these, also change the error_reporting() code below
  */
-define('ENVIRONMENT', (Config::DEBUG_MODE) ? 'development' : 'production');
+
+$app_env = getenv('APP_ENV');
+
+if ($app_env)
+{
+    define('ENVIRONMENT', $app_env);
+}
+else
+{
+    define('ENVIRONMENT', (Config::DEBUG_MODE) ? 'development' : 'production');
+}
 
 /*
  *---------------------------------------------------------------
diff --git a/phpunit.xml b/phpunit.xml
index 1a2ec8fb..25777ebb 100644
--- a/phpunit.xml
+++ b/phpunit.xml
@@ -1,7 +1,7 @@
 <phpunit
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xsi:noNamespaceSchemaLocation="./vendor/phpunit/phpunit/phpunit.xsd"
-    bootstrap="tests/bootstrap.php"
+    bootstrap="index.php"
     colors="true"
     cacheResult="false"
 >
diff --git a/tests/TestCase.php b/tests/TestCase.php
new file mode 100644
index 00000000..e075f57e
--- /dev/null
+++ b/tests/TestCase.php
@@ -0,0 +1,27 @@
+<?php
+
+namespace Tests;
+
+use CI_Controller;
+use EA_Controller;
+use PHPUnit\Framework\TestCase as PHPUnitTestCase;
+
+/**
+ * Parent test case sharing common test functionality.
+ */
+class TestCase extends PHPUnitTestCase {
+    /**
+     * @var EA_Controller|CI_Controller
+     */
+    private static EA_Controller|CI_Controller $CI;
+
+    /**
+     * Load the framework instance.
+     *
+     * @return void
+     */
+    public static function setUpBeforeClass(): void
+    {
+        self::$CI =& get_instance();
+    }
+}
diff --git a/tests/Unit/Helper/ArrayHelperTest.php b/tests/Unit/Helper/ArrayHelperTest.php
index fb2924c1..c0c35dd8 100644
--- a/tests/Unit/Helper/ArrayHelperTest.php
+++ b/tests/Unit/Helper/ArrayHelperTest.php
@@ -1,28 +1,26 @@
 <?php
 
-namespace Unit\Helper;
+namespace Tests\Unit\Helper;
 
-use PHPUnit\Framework\TestCase;
-
-require_once __DIR__ . '/../../../application/helpers/array_helper.php';
+use Tests\TestCase;
 
 class ArrayHelperTest extends TestCase {
-    public function testIsAssocReturnsTrueOnAssociativeArray()
+    public function testIsAssocReturnsTrueOnAssociativeArray(): void
     {
         $this->assertTrue(is_assoc(['test' => 'value']));
     }
 
-    public function testIsAssocReturnsFalseOnIndexedArray()
+    public function testIsAssocReturnsFalseOnIndexedArray(): void
     {
         $this->assertFalse(is_assoc(['one', 'two', 'three']));
     }
 
-    public function testIsAssocReturnsTrueOnMixedArray()
+    public function testIsAssocReturnsTrueOnMixedArray(): void
     {
         $this->assertTrue(is_assoc(['one', 'two', 'three' => 'value']));
     }
 
-    public function testArrayFindReturnsCorrectElement()
+    public function testArrayFindReturnsCorrectElement(): void
     {
         $arr = [
             [
@@ -39,7 +37,7 @@ class ArrayHelperTest extends TestCase {
         $this->assertSame($arr[0], array_find($arr, fn($element) => $element['id'] === 1));
     }
 
-    public function testArrayFieldsReturnsStrippedArray()
+    public function testArrayFieldsReturnsStrippedArray(): void
     {
         $arr = [
             'name' => 'John',
@@ -49,7 +47,7 @@ class ArrayHelperTest extends TestCase {
         $stripped = array_fields($arr, ['name']);
 
         $this->assertArrayHasKey('name', $stripped);
-        
+
         $this->assertArrayNotHasKey('email', $stripped);
     }
 }
diff --git a/tests/Unit/Helper/ValidationHelperTest.php b/tests/Unit/Helper/ValidationHelperTest.php
index e13543c6..261eed07 100644
--- a/tests/Unit/Helper/ValidationHelperTest.php
+++ b/tests/Unit/Helper/ValidationHelperTest.php
@@ -1,10 +1,8 @@
 <?php
 
-namespace Unit\Helper;
+namespace Tests\Unit\Helper;
 
-use PHPUnit\Framework\TestCase;
-
-require_once __DIR__ . '/../../../application/helpers/validation_helper.php';
+use Tests\TestCase;
 
 class ValidationHelperTest extends TestCase {
     public function testValidateDateTimeReturnsTrueOnValidValue()
diff --git a/tests/bootstrap.php b/tests/bootstrap.php
deleted file mode 100644
index e9405aba..00000000
--- a/tests/bootstrap.php
+++ /dev/null
@@ -1,5 +0,0 @@
-<?php
-
-require_once __DIR__ . '/../vendor/autoload.php';
-
-define('BASEPATH', __DIR__ . '/../system');