Differences

This shows you the differences between two versions of the page.

--- project:unittests [2025/08/03 03:31] – mnewnham
+++ project:unittests [2025/08/05 16:54] (current) – [Prerequistes] mnewnham
@@ Line 3: / Line 3: @@
 Unit testing can be done using PHPUnit testing. Testing can be done against any database that is available that you have admin rights on. The test creates tables, populates them with small amounts of data and drops them.
-==== Prerequistes ====
+===== Prerequistes =====
-[[https://phpunit.de|PHPUnit]] Version 9 or higher must be installed to conduct the suite of tests.
+  * PHP 8.0 or higher
+  * [[https://phpunit.de|PHPUnit]] Version 9 or higher must be installed to conduct the suite of tests.
 ===== Setup =====
@@ Line 40: / Line 41: @@
 </code>
 ==== Driver Section ====
-The driver configuration is based on the driver name.
+The driver configuration is based on the driver name. You can add as many drivers to the configuration file as you want. Only the driver specified on the command line or the first driver found in the configuration file flagged //**active**// is tested.
 <code>
@@ Line 64: / Line 65: @@
 ==== Meta Section ====
-Unless explicitly enabled, the test to create new database using the //**createDatabase**// method is skipped as it requires CREATE DATABASE privilege on the DBMS. To enable this test, set the following section:
+Unless explicitly enabled, the test to create a new database using the //**createDatabase**// method is skipped as it requires CREATE DATABASE privilege on the DBMS. To enable this test, set the following section:
-<code>[meta]
+<code>
+[meta]
 skipDbCreation=0
 </code>
@@ Line 72: / Line 74: @@
 ==== Caching Section ====
-Unless explicitly enabled, cache functions such as //**CacheExecute()**// are skipped. Tests only currently support Filesystem based caching. To activate this, add the following section to adodb-unittest.ini:
+Unless explicitly enabled, cache functions such as //**CacheExecute()**// are skipped. Tests are supported using Filesystem based or memcache based caching. To activate this, add the following section to adodb-unittest.ini:
+=== Filesystem ===
 <code>
 [caching]
 cacheMethod=1
 cacheDir=c:/dev/cache
+</code>
+=== Memcache Based ===
+<code>
+[cache]
+cacheMethod=2
+cacheHost=192.168.1.50
 </code>
@@ Line 93: / Line 102: @@
 ===== Test Execution =====
-==== PHPUnit ====
+==== PHPUnit Version 9 ====
 <code>
 phpunit unittest --bootstrap unittest/dbconnector.php <driver>
@@ Line 107: / Line 116: @@
 It is not possible to pass the driver name as a run-time argument in this version. The driver to test must have the **active** flag defined in the driver section.
+===== Writing or Updating Tests =====
+  * Tests should be compliant with PHPunit version 9 and higher
+  * Tests should be compatible with all platforms supported by PHPunit
+  * Tests should be written to [[https://www.php-fig.org/psr/psr-12/|PSR 12]] standards when possible
+  * Wherever possible, write database agnostic tests. Only write driver specific tests when a feature is only supported by one or two DBMS
+  * Only add driver specific tests to the test file specifically labeled for that driver, e.g. //**MysqliDriverTest.php**//
+  * Do not add driver-based code branches inside the generic test code