From f0b487ca362975ee40c34b6a09d005a8675efebd Mon Sep 17 00:00:00 2001
From: Yasen Pramatarov <yasen@lindeas.com>
Date: Thu, 20 Feb 2025 10:41:14 +0200
Subject: [PATCH] Reorganizes tests folder structure

---
 tests/{framework => }/.gitignore              |  0
 .../Middleware/RateLimitMiddlewareTest.php    |  6 ++--
 .../Middleware/SessionMiddlewareTest.php      |  2 +-
 .../Security/CsrfProtectionTest.php           |  4 +--
 .../Security/SecurityHeadersTest.php          |  2 +-
 tests/README.md                               | 25 +++++++++-------
 tests/{framework => }/TestCase.php            |  0
 tests/{framework => }/TestSessionHandler.php  |  0
 .../Unit/Classes/AgentTest.php                |  4 +--
 .../Unit/Classes/DatabaseTest.php             |  2 +-
 .../Unit/Classes/FeedbackTest.php             |  2 +-
 .../{framework => }/Unit/Classes/HostTest.php |  2 +-
 .../Unit/Classes/JiloServerTest.php           |  4 +--
 .../{framework => }/Unit/Classes/LogTest.php  |  4 +--
 .../Unit/Classes/PlatformTest.php             |  4 +--
 .../Unit/Classes/RateLimiterTest.php          |  6 ++--
 .../Unit/Classes/SettingsTest.php             |  4 +--
 .../{framework => }/Unit/Classes/UserTest.php |  6 ++--
 .../Unit/Classes/ValidatorTest.php            |  2 +-
 .../Unit/Helpers/SecurityHelperTest.php       |  2 +-
 tests/{framework => }/bootstrap.php           |  0
 tests/{framework => }/composer.json           | 30 +++++++++----------
 tests/{framework => }/phpunit.xml             | 13 ++++----
 tests/{framework => }/test_php.ini            |  0
 24 files changed, 66 insertions(+), 58 deletions(-)
 rename tests/{framework => }/.gitignore (100%)
 rename tests/{framework/Integration => Feature}/Middleware/RateLimitMiddlewareTest.php (96%)
 rename tests/{framework/Integration => Feature}/Middleware/SessionMiddlewareTest.php (97%)
 rename tests/{framework/Integration => Feature}/Security/CsrfProtectionTest.php (97%)
 rename tests/{framework/Integration => Feature}/Security/SecurityHeadersTest.php (98%)
 rename tests/{framework => }/TestCase.php (100%)
 rename tests/{framework => }/TestSessionHandler.php (100%)
 rename tests/{framework => }/Unit/Classes/AgentTest.php (98%)
 rename tests/{framework => }/Unit/Classes/DatabaseTest.php (98%)
 rename tests/{framework => }/Unit/Classes/FeedbackTest.php (98%)
 rename tests/{framework => }/Unit/Classes/HostTest.php (98%)
 rename tests/{framework => }/Unit/Classes/JiloServerTest.php (95%)
 rename tests/{framework => }/Unit/Classes/LogTest.php (96%)
 rename tests/{framework => }/Unit/Classes/PlatformTest.php (98%)
 rename tests/{framework => }/Unit/Classes/RateLimiterTest.php (95%)
 rename tests/{framework => }/Unit/Classes/SettingsTest.php (84%)
 rename tests/{framework => }/Unit/Classes/UserTest.php (96%)
 rename tests/{framework => }/Unit/Classes/ValidatorTest.php (98%)
 rename tests/{framework => }/Unit/Helpers/SecurityHelperTest.php (98%)
 rename tests/{framework => }/bootstrap.php (100%)
 rename tests/{framework => }/composer.json (53%)
 rename tests/{framework => }/phpunit.xml (66%)
 rename tests/{framework => }/test_php.ini (100%)

diff --git a/tests/framework/.gitignore b/tests/.gitignore
similarity index 100%
rename from tests/framework/.gitignore
rename to tests/.gitignore
diff --git a/tests/framework/Integration/Middleware/RateLimitMiddlewareTest.php b/tests/Feature/Middleware/RateLimitMiddlewareTest.php
similarity index 96%
rename from tests/framework/Integration/Middleware/RateLimitMiddlewareTest.php
rename to tests/Feature/Middleware/RateLimitMiddlewareTest.php
index c75ea94..30e6caf 100644
--- a/tests/framework/Integration/Middleware/RateLimitMiddlewareTest.php
+++ b/tests/Feature/Middleware/RateLimitMiddlewareTest.php
@@ -1,8 +1,8 @@
 <?php
 
-require_once dirname(__DIR__, 4) . '/app/classes/database.php';
-require_once dirname(__DIR__, 4) . '/app/classes/ratelimiter.php';
-require_once dirname(__DIR__, 4) . '/app/includes/rate_limit_middleware.php';
+require_once dirname(__DIR__, 3) . '/app/classes/database.php';
+require_once dirname(__DIR__, 3) . '/app/classes/ratelimiter.php';
+require_once dirname(__DIR__, 3) . '/app/includes/rate_limit_middleware.php';
 
 use PHPUnit\Framework\TestCase;
 
diff --git a/tests/framework/Integration/Middleware/SessionMiddlewareTest.php b/tests/Feature/Middleware/SessionMiddlewareTest.php
similarity index 97%
rename from tests/framework/Integration/Middleware/SessionMiddlewareTest.php
rename to tests/Feature/Middleware/SessionMiddlewareTest.php
index 9de6580..171c9d4 100644
--- a/tests/framework/Integration/Middleware/SessionMiddlewareTest.php
+++ b/tests/Feature/Middleware/SessionMiddlewareTest.php
@@ -1,6 +1,6 @@
 <?php
 
-require_once dirname(__DIR__, 4) . '/app/includes/session_middleware.php';
+require_once dirname(__DIR__, 3) . '/app/includes/session_middleware.php';
 
 use PHPUnit\Framework\TestCase;
 
diff --git a/tests/framework/Integration/Security/CsrfProtectionTest.php b/tests/Feature/Security/CsrfProtectionTest.php
similarity index 97%
rename from tests/framework/Integration/Security/CsrfProtectionTest.php
rename to tests/Feature/Security/CsrfProtectionTest.php
index 3e3d6a5..248297c 100644
--- a/tests/framework/Integration/Security/CsrfProtectionTest.php
+++ b/tests/Feature/Security/CsrfProtectionTest.php
@@ -2,8 +2,8 @@
 
 namespace Tests\Framework\Integration\Security;
 
-require_once dirname(__DIR__, 4) . '/app/classes/log.php';
-require_once dirname(__DIR__, 4) . '/app/helpers/security.php';
+require_once dirname(__DIR__, 3) . '/app/classes/log.php';
+require_once dirname(__DIR__, 3) . '/app/helpers/security.php';
 
 use PHPUnit\Framework\TestCase;
 
diff --git a/tests/framework/Integration/Security/SecurityHeadersTest.php b/tests/Feature/Security/SecurityHeadersTest.php
similarity index 98%
rename from tests/framework/Integration/Security/SecurityHeadersTest.php
rename to tests/Feature/Security/SecurityHeadersTest.php
index dbef01f..3aa2f99 100644
--- a/tests/framework/Integration/Security/SecurityHeadersTest.php
+++ b/tests/Feature/Security/SecurityHeadersTest.php
@@ -4,7 +4,7 @@ namespace Tests\Framework\Integration\Security;
 
 use PHPUnit\Framework\TestCase;
 
-require_once dirname(__DIR__, 4) . '/app/includes/security_headers_middleware.php';
+require_once dirname(__DIR__, 3) . '/app/includes/security_headers_middleware.php';
 
 class SecurityHeadersTest extends TestCase
 {
diff --git a/tests/README.md b/tests/README.md
index eb2ac88..5f93874 100644
--- a/tests/README.md
+++ b/tests/README.md
@@ -6,20 +6,25 @@ This directory contains the test suite for the Jilo Web application. All testing
 
 ```
 tests/
-├── framework/           # Test framework files
-│   ├── composer.json   # Composer configuration for tests
-│   ├── phpunit.xml     # PHPUnit configuration
-│   ├── Unit/          # Unit tests
-│   ├── Integration/   # Integration tests
-│   └── TestCase.php   # Base test case class
-└── README.md          # This file
+├── Unit/            # Unit tests (individual classes and methods)
+    ├── Classes/
+    └── Helpers/
+├── Feature/         # Feature (integration) tests (covering multiple components)
+    ├── Midleware/
+    └── Security/
+├── Functional/      # Functionl tests (real usage scenarios)
+├── Utils/           # Custom test utilities and libraries
+├── TestCase.php     # Base test case class
+├── composer.json    # Composer configuration for tests
+├── phpunit.xml      # PHPUnit configuration
+└── README.md        # This file
 ```
 
 ## Running Tests
 
-1. Change to the framework directory:
+1. Change to the test framework directory:
 ```bash
-cd tests/framework
+cd tests
 ```
 
 2. Install dependencies (first time only):
@@ -37,4 +42,4 @@ composer test
 composer test-coverage
 ```
 
-The coverage report will be generated in `tests/framework/coverage/`.
+The coverage report will be generated in `tests/coverage/`.
diff --git a/tests/framework/TestCase.php b/tests/TestCase.php
similarity index 100%
rename from tests/framework/TestCase.php
rename to tests/TestCase.php
diff --git a/tests/framework/TestSessionHandler.php b/tests/TestSessionHandler.php
similarity index 100%
rename from tests/framework/TestSessionHandler.php
rename to tests/TestSessionHandler.php
diff --git a/tests/framework/Unit/Classes/AgentTest.php b/tests/Unit/Classes/AgentTest.php
similarity index 98%
rename from tests/framework/Unit/Classes/AgentTest.php
rename to tests/Unit/Classes/AgentTest.php
index 60bea33..cc0f3e9 100644
--- a/tests/framework/Unit/Classes/AgentTest.php
+++ b/tests/Unit/Classes/AgentTest.php
@@ -1,7 +1,7 @@
 <?php
 
-require_once dirname(__DIR__, 4) . '/app/classes/database.php';
-require_once dirname(__DIR__, 4) . '/app/classes/agent.php';
+require_once dirname(__DIR__, 3) . '/app/classes/database.php';
+require_once dirname(__DIR__, 3) . '/app/classes/agent.php';
 
 use PHPUnit\Framework\TestCase;
 
diff --git a/tests/framework/Unit/Classes/DatabaseTest.php b/tests/Unit/Classes/DatabaseTest.php
similarity index 98%
rename from tests/framework/Unit/Classes/DatabaseTest.php
rename to tests/Unit/Classes/DatabaseTest.php
index 7d4582e..1635b72 100644
--- a/tests/framework/Unit/Classes/DatabaseTest.php
+++ b/tests/Unit/Classes/DatabaseTest.php
@@ -1,6 +1,6 @@
 <?php
 
-require_once dirname(__DIR__, 4) . '/app/classes/database.php';
+require_once dirname(__DIR__, 3) . '/app/classes/database.php';
 
 use PHPUnit\Framework\TestCase;
 
diff --git a/tests/framework/Unit/Classes/FeedbackTest.php b/tests/Unit/Classes/FeedbackTest.php
similarity index 98%
rename from tests/framework/Unit/Classes/FeedbackTest.php
rename to tests/Unit/Classes/FeedbackTest.php
index 93feff1..ca1bb90 100644
--- a/tests/framework/Unit/Classes/FeedbackTest.php
+++ b/tests/Unit/Classes/FeedbackTest.php
@@ -1,6 +1,6 @@
 <?php
 
-require_once dirname(__DIR__, 4) . '/app/classes/feedback.php';
+require_once dirname(__DIR__, 3) . '/app/classes/feedback.php';
 
 use PHPUnit\Framework\TestCase;
 
diff --git a/tests/framework/Unit/Classes/HostTest.php b/tests/Unit/Classes/HostTest.php
similarity index 98%
rename from tests/framework/Unit/Classes/HostTest.php
rename to tests/Unit/Classes/HostTest.php
index e5cce13..8e1e08b 100644
--- a/tests/framework/Unit/Classes/HostTest.php
+++ b/tests/Unit/Classes/HostTest.php
@@ -1,6 +1,6 @@
 <?php
 
-require_once dirname(__DIR__, 4) . '/app/classes/host.php';
+require_once dirname(__DIR__, 3) . '/app/classes/host.php';
 
 use PHPUnit\Framework\TestCase;
 
diff --git a/tests/framework/Unit/Classes/JiloServerTest.php b/tests/Unit/Classes/JiloServerTest.php
similarity index 95%
rename from tests/framework/Unit/Classes/JiloServerTest.php
rename to tests/Unit/Classes/JiloServerTest.php
index 0edb07d..e874e0a 100644
--- a/tests/framework/Unit/Classes/JiloServerTest.php
+++ b/tests/Unit/Classes/JiloServerTest.php
@@ -1,7 +1,7 @@
 <?php
 
-require_once dirname(__DIR__, 4) . '/app/classes/database.php';
-require_once dirname(__DIR__, 4) . '/app/classes/server.php';
+require_once dirname(__DIR__, 3) . '/app/classes/database.php';
+require_once dirname(__DIR__, 3) . '/app/classes/server.php';
 
 use PHPUnit\Framework\TestCase;
 
diff --git a/tests/framework/Unit/Classes/LogTest.php b/tests/Unit/Classes/LogTest.php
similarity index 96%
rename from tests/framework/Unit/Classes/LogTest.php
rename to tests/Unit/Classes/LogTest.php
index b99b05a..22bac6e 100644
--- a/tests/framework/Unit/Classes/LogTest.php
+++ b/tests/Unit/Classes/LogTest.php
@@ -1,7 +1,7 @@
 <?php
 
-require_once dirname(__DIR__, 4) . '/app/classes/database.php';
-require_once dirname(__DIR__, 4) . '/app/classes/log.php';
+require_once dirname(__DIR__, 3) . '/app/classes/database.php';
+require_once dirname(__DIR__, 3) . '/app/classes/log.php';
 
 use PHPUnit\Framework\TestCase;
 
diff --git a/tests/framework/Unit/Classes/PlatformTest.php b/tests/Unit/Classes/PlatformTest.php
similarity index 98%
rename from tests/framework/Unit/Classes/PlatformTest.php
rename to tests/Unit/Classes/PlatformTest.php
index b9d570c..e3f2aa9 100644
--- a/tests/framework/Unit/Classes/PlatformTest.php
+++ b/tests/Unit/Classes/PlatformTest.php
@@ -1,7 +1,7 @@
 <?php
 
-require_once dirname(__DIR__, 4) . '/app/classes/database.php';
-require_once dirname(__DIR__, 4) . '/app/classes/platform.php';
+require_once dirname(__DIR__, 3) . '/app/classes/database.php';
+require_once dirname(__DIR__, 3) . '/app/classes/platform.php';
 
 use PHPUnit\Framework\TestCase;
 
diff --git a/tests/framework/Unit/Classes/RateLimiterTest.php b/tests/Unit/Classes/RateLimiterTest.php
similarity index 95%
rename from tests/framework/Unit/Classes/RateLimiterTest.php
rename to tests/Unit/Classes/RateLimiterTest.php
index b5e15cc..6bd5775 100644
--- a/tests/framework/Unit/Classes/RateLimiterTest.php
+++ b/tests/Unit/Classes/RateLimiterTest.php
@@ -1,8 +1,8 @@
 <?php
 
-require_once dirname(__DIR__, 4) . '/app/classes/database.php';
-require_once dirname(__DIR__, 4) . '/app/classes/ratelimiter.php';
-require_once dirname(__DIR__, 4) . '/app/classes/log.php';
+require_once dirname(__DIR__, 3) . '/app/classes/database.php';
+require_once dirname(__DIR__, 3) . '/app/classes/ratelimiter.php';
+require_once dirname(__DIR__, 3) . '/app/classes/log.php';
 
 use PHPUnit\Framework\TestCase;
 
diff --git a/tests/framework/Unit/Classes/SettingsTest.php b/tests/Unit/Classes/SettingsTest.php
similarity index 84%
rename from tests/framework/Unit/Classes/SettingsTest.php
rename to tests/Unit/Classes/SettingsTest.php
index c288461..aca7520 100644
--- a/tests/framework/Unit/Classes/SettingsTest.php
+++ b/tests/Unit/Classes/SettingsTest.php
@@ -1,7 +1,7 @@
 <?php
 
-require_once dirname(__DIR__, 4) . '/app/classes/database.php';
-require_once dirname(__DIR__, 4) . '/app/classes/settings.php';
+require_once dirname(__DIR__, 3) . '/app/classes/database.php';
+require_once dirname(__DIR__, 3) . '/app/classes/settings.php';
 
 use PHPUnit\Framework\TestCase;
 
diff --git a/tests/framework/Unit/Classes/UserTest.php b/tests/Unit/Classes/UserTest.php
similarity index 96%
rename from tests/framework/Unit/Classes/UserTest.php
rename to tests/Unit/Classes/UserTest.php
index 26a8ba7..672f887 100644
--- a/tests/framework/Unit/Classes/UserTest.php
+++ b/tests/Unit/Classes/UserTest.php
@@ -1,8 +1,8 @@
 <?php
 
-require_once dirname(__DIR__, 4) . '/app/classes/database.php';
-require_once dirname(__DIR__, 4) . '/app/classes/user.php';
-require_once dirname(__DIR__, 4) . '/app/classes/ratelimiter.php';
+require_once dirname(__DIR__, 3) . '/app/classes/database.php';
+require_once dirname(__DIR__, 3) . '/app/classes/user.php';
+require_once dirname(__DIR__, 3) . '/app/classes/ratelimiter.php';
 
 use PHPUnit\Framework\TestCase;
 
diff --git a/tests/framework/Unit/Classes/ValidatorTest.php b/tests/Unit/Classes/ValidatorTest.php
similarity index 98%
rename from tests/framework/Unit/Classes/ValidatorTest.php
rename to tests/Unit/Classes/ValidatorTest.php
index a31835d..05130c6 100644
--- a/tests/framework/Unit/Classes/ValidatorTest.php
+++ b/tests/Unit/Classes/ValidatorTest.php
@@ -1,6 +1,6 @@
 <?php
 
-require_once dirname(__DIR__, 4) . '/app/classes/validator.php';
+require_once dirname(__DIR__, 3) . '/app/classes/validator.php';
 
 use PHPUnit\Framework\TestCase;
 
diff --git a/tests/framework/Unit/Helpers/SecurityHelperTest.php b/tests/Unit/Helpers/SecurityHelperTest.php
similarity index 98%
rename from tests/framework/Unit/Helpers/SecurityHelperTest.php
rename to tests/Unit/Helpers/SecurityHelperTest.php
index 33eeb5e..6590daf 100644
--- a/tests/framework/Unit/Helpers/SecurityHelperTest.php
+++ b/tests/Unit/Helpers/SecurityHelperTest.php
@@ -1,6 +1,6 @@
 <?php
 
-require_once dirname(__DIR__, 4) . '/app/helpers/security.php';
+require_once dirname(__DIR__, 3) . '/app/helpers/security.php';
 
 use PHPUnit\Framework\TestCase;
 
diff --git a/tests/framework/bootstrap.php b/tests/bootstrap.php
similarity index 100%
rename from tests/framework/bootstrap.php
rename to tests/bootstrap.php
diff --git a/tests/framework/composer.json b/tests/composer.json
similarity index 53%
rename from tests/framework/composer.json
rename to tests/composer.json
index 4e55f7e..27e4d56 100644
--- a/tests/framework/composer.json
+++ b/tests/composer.json
@@ -12,21 +12,21 @@
     },
     "autoload": {
         "files": [
-            "../../app/includes/errors.php",
-            "../../app/classes/database.php",
-            "../../app/classes/agent.php",
-            "../../app/classes/host.php",
-            "../../app/classes/platform.php",
-            "../../app/classes/server.php",
-            "../../app/classes/log.php",
-            "../../app/classes/feedback.php",
-            "../../app/classes/settings.php",
-            "../../app/classes/validator.php",
-            "../../app/classes/router.php",
-            "../../app/classes/ratelimiter.php",
-            "../../app/classes/user.php",
-            "../../app/helpers/security.php",
-            "../../app/includes/errors.php"
+            "../app/includes/errors.php",
+            "../app/classes/database.php",
+            "../app/classes/agent.php",
+            "../app/classes/host.php",
+            "../app/classes/platform.php",
+            "../app/classes/server.php",
+            "../app/classes/log.php",
+            "../app/classes/feedback.php",
+            "../app/classes/settings.php",
+            "../app/classes/validator.php",
+            "../app/classes/router.php",
+            "../app/classes/ratelimiter.php",
+            "../app/classes/user.php",
+            "../app/helpers/security.php",
+            "../app/includes/errors.php"
         ],
         "classmap": [
             "TestCase.php"
diff --git a/tests/framework/phpunit.xml b/tests/phpunit.xml
similarity index 66%
rename from tests/framework/phpunit.xml
rename to tests/phpunit.xml
index 26cbf9d..83828f8 100644
--- a/tests/framework/phpunit.xml
+++ b/tests/phpunit.xml
@@ -8,17 +8,20 @@
         <testsuite name="Unit">
             <directory suffix="Test.php">./Unit</directory>
         </testsuite>
-        <testsuite name="Integration">
-            <directory suffix="Test.php">./Integration</directory>
+        <testsuite name="Feature">
+            <directory suffix="Test.php">./Feature</directory>
+        </testsuite>
+        <testsuite name="Functional">
+            <directory suffix="Test.php">./Functional</directory>
         </testsuite>
     </testsuites>
     <coverage processUncoveredFiles="true">
         <include>
-            <directory suffix=".php">../../app</directory>
+            <directory suffix=".php">../app</directory>
         </include>
         <exclude>
-            <directory>../../app/templates</directory>
-            <directory>../../app/includes</directory>
+            <directory>../app/templates</directory>
+            <directory>../app/includes</directory>
         </exclude>
     </coverage>
     <php>
diff --git a/tests/framework/test_php.ini b/tests/test_php.ini
similarity index 100%
rename from tests/framework/test_php.ini
rename to tests/test_php.ini