Upgraded travis dist to repair broken php8 tests + refactored some tests (#809)

* Upgraded travis dist to repair broken php8 tests

* Trying to repair broken build

* Trying to repair broken build

* Trying to repair broken build

* Fixed Couchdb tests & driver

* Removed dump...

* Fixed tests for php 7.x ...

* Fixed tests & dropped support of Riak which is became unmaintenable and is globally unused

* Refactored some tests and isolated TestHelper out of core code

Author: Geolim4

bin/ci/run_tests.php

@@ -16,6 +16,7 @@
 $dir = __DIR__;
 $driver = $argv[ 1 ] ?? 'Files';
 $phpBinPath = $_SERVER['PHP_BIN_PATH'] ?? 'php';
+$failedTests = [];
 
 /**
  * @param string $pattern
@@ -37,7 +38,7 @@
 foreach ($globCallback(PFC_TEST_DIR . DIRECTORY_SEPARATOR . '*.test.php') as $filename) {
     $climate->backgroundLightYellow()->blue()->out('---');
     $command = "{$phpBinPath} -f {$filename} {$driver}";
-    $climate->out("<yellow>phpfastcache@unit-test</yellow> <blue>{$dir}</blue> <green>#</green> <red>$command</red>");
+    $climate->out("<yellow>phpfastcache@unit-tests</yellow> <blue>{$dir}</blue> <green>#</green> <red>$command</red>");
 
     \exec($command, $output, $return_var);
     $climate->out('=====================================');
@@ -48,6 +49,7 @@
     } else {
         $climate->red("Process finished with exit code $return_var");
         $status = 255;
+        $failedTests[] = basename($filename);
     }
 
     $climate->out('');
@@ -64,6 +66,7 @@
     $climate->backgroundGreen()->white()->flank('[OK] The build has passed successfully', '#')->out('');
 } else {
     $climate->backgroundRed()->white()->flank('[KO] The build has failed miserably', '~')->out('');
+    $climate->red()->out('Tests failed: ' . implode(', ', $failedTests))->out('');
 }
 
 exit($status);

composer.json

@@ -25,10 +25,12 @@
         "psr/cache": "~1.0.0",
         "psr/simple-cache": "~1.0.0",
         "ext-mbstring": "*",
-        "ext-json": "*"
+        "ext-json": "*",
+        "phpfastcache/couchdb": "^1.0"
     },
     "require-dev": {
-        "league/climate": "^3.5"
+        "league/climate": "^3.5",
+        "ext-gettext": "*"
     },
     "suggest": {
         "ext-apc": "*",
@@ -51,7 +53,8 @@
     },
     "autoload": {
         "psr-4": {
-            "Phpfastcache\\": "lib/Phpfastcache/"
+            "Phpfastcache\\": "lib/Phpfastcache/",
+            "Phpfastcache\\Tests\\": "tests/lib/"
         }
     }
 }

composer.lock

@@ -21,6 +21,9 @@
 const PFC_PHP_EXT = 'php';
 const PFC_BIN_DIR = __DIR__ . '/../../../bin/';
 const PFC_LIB_DIR = __DIR__ . '/../../../lib/';
+const PFC_TESTS_DIR = __DIR__ . '/../../../tests/lib/';
+const PFC_TESTS_NS = 'Phpfastcache\\Tests\\';
+
 
 \trigger_error('The legacy autoload will be removed in the next major release. Please include Phpfastcache through composer by running `composer require phpfastcache/phpfastcache`.', \E_USER_DEPRECATED);
 /**
@@ -59,9 +62,15 @@ static function ($entity): void {
             return;
         }
 
-        $entity = str_replace('\\', '/', $entity);
-        $path = PFC_LIB_DIR . $entity . '.' . PFC_PHP_EXT;
+        $entityPath = str_replace('\\', '/', $entity);
+
+        if(\strpos($entity, PFC_TESTS_NS) === 0){
+            $path = PFC_TESTS_DIR . \str_replace(str_replace('\\', '/', PFC_TESTS_NS), '', $entityPath) . '.' . PFC_PHP_EXT;
+        }else{
+            $path = PFC_LIB_DIR . $entityPath . '.' . PFC_PHP_EXT;
+        }
 
+        $path = \realpath($path);
         if (\is_readable($path)) {
             require_once $path;
         }
@@ -73,4 +82,4 @@ static function ($entity): void {
         'Your project already makes use of Composer. You SHOULD use the composer dependency "phpfastcache/phpfastcache" instead of hard-autoloading.',
         E_USER_WARNING
     );
-}
+}

lib/Phpfastcache/Autoload/Autoload.php

@@ -6,7 +6,7 @@
  */
 
 use Phpfastcache\Core\Item\ExtendedCacheItemInterface;
-use Phpfastcache\Helper\TestHelper;
+use Phpfastcache\Tests\Helper\TestHelper;
 use Phpfastcache\Proxy\PhpfastcacheAbstractProxy;
 
 
@@ -41,11 +41,11 @@ public function __construct($driver = '', $config = null)
 $driverInstance = new CustomMemcachedCacheClass();
 
 if (!is_object($driverInstance->getItem('test'))) {
-    $testHelper->printFailText('$driverInstance->getItem() returned an invalid var type:' . gettype($driverInstance));
+    $testHelper->assertFail('$driverInstance->getItem() returned an invalid var type:' . gettype($driverInstance));
 }else if(!($driverInstance->getItem('test') instanceof ExtendedCacheItemInterface)){
-    $testHelper->printFailText('$driverInstance->getItem() returned an invalid class that does not implements ExtendedCacheItemInterface: ' . get_class($driverInstance));
+    $testHelper->assertFail('$driverInstance->getItem() returned an invalid class that does not implements ExtendedCacheItemInterface: ' . get_class($driverInstance));
 }else{
-    $testHelper->printPassText('$driverInstance->getItem() returned a valid class that implements ExtendedCacheItemInterface: ' . get_class($driverInstance));
+    $testHelper->assertPass('$driverInstance->getItem() returned a valid class that implements ExtendedCacheItemInterface: ' . get_class($driverInstance));
 }
 
 $testHelper->terminateTest();

tests/AbstractProxy.test.php

@@ -5,17 +5,8 @@
  * @author Georges.L (Geolim4)  <contact@geolim4.com>
  */
 
-use Phpfastcache\Api;
 use Phpfastcache\CacheManager;
-use Phpfastcache\Cluster\AggregatorInterface;
-use Phpfastcache\Cluster\ClusterAggregator;
-use Phpfastcache\Cluster\ItemAbstract;
-use Phpfastcache\Core\Pool\AggregablePoolInterface;
-use Phpfastcache\Core\Pool\ExtendedCacheItemPoolInterface;
-use Phpfastcache\Exceptions\PhpfastcacheInvalidArgumentException;
-use Phpfastcache\Exceptions\PhpfastcacheRootException;
-use Phpfastcache\Helper\TestHelper;
-use Phpfastcache\Drivers\Fakefiles\Config;
+use Phpfastcache\Tests\Helper\TestHelper;
 
 
 chdir(__DIR__);

tests/Apcu.test.php

@@ -7,7 +7,7 @@
 
 use Phpfastcache\Api;
 use Phpfastcache\Exceptions\PhpfastcacheRootException;
-use Phpfastcache\Helper\TestHelper;
+use Phpfastcache\Tests\Helper\TestHelper;
 
 chdir(__DIR__);
 require_once __DIR__ . '/../vendor/autoload.php';
@@ -18,39 +18,39 @@
  */
 try {
     $version = Api::getVersion();
-    $testHelper->printPassText(sprintf('Successfully retrieved the API version: %s', $version));
+    $testHelper->assertPass(sprintf('Successfully retrieved the API version: %s', $version));
 } catch (PhpfastcacheRootException $e) {
-    $testHelper->printFailText(sprintf('Failed to retrieve the API version with the following error error: %s', $e->getMessage()));
+    $testHelper->assertFail(sprintf('Failed to retrieve the API version with the following error error: %s', $e->getMessage()));
 }
 
 /**
  * Testing PhpFastCache version
  */
 try {
     $version = Api::getPhpFastCacheVersion();
-    $testHelper->printPassText(sprintf('Successfully retrieved PhpFastCache version: %s', $version));
+    $testHelper->assertPass(sprintf('Successfully retrieved PhpFastCache version: %s', $version));
 } catch (PhpfastcacheRootException $e) {
-    $testHelper->printFailText(sprintf('Failed to retrieve the PhpFastCache version with the following error error: %s', $e->getMessage()));
+    $testHelper->assertFail(sprintf('Failed to retrieve the PhpFastCache version with the following error error: %s', $e->getMessage()));
 }
 
 /**
  * Testing API changelog
  */
 try {
     $changelog = Api::getChangelog();
-    $testHelper->printPassText(sprintf("Successfully retrieved API changelog:\n%s", $changelog));
+    $testHelper->assertPass(sprintf("Successfully retrieved API changelog:\n%s", $changelog));
 } catch (PhpfastcacheRootException $e) {
-    $testHelper->printFailText(sprintf('Failed to retrieve the API changelog with the following error error: %s', $e->getMessage()));
+    $testHelper->assertFail(sprintf('Failed to retrieve the API changelog with the following error error: %s', $e->getMessage()));
 }
 
 /**
  * Testing PhpFastCache changelog
  */
 try {
     $changelog = Api::getPhpFastCacheChangelog();
-    $testHelper->printPassText(sprintf("Successfully retrieved PhpFastCache changelog:\n%s", $changelog));
+    $testHelper->assertPass(sprintf("Successfully retrieved PhpFastCache changelog:\n%s", $changelog));
 } catch (PhpfastcacheRootException $e) {
-    $testHelper->printFailText(sprintf('Failed to retrieve the PhpFastCache changelog with the following error error: %s', $e->getMessage()));
+    $testHelper->assertFail(sprintf('Failed to retrieve the PhpFastCache changelog with the following error error: %s', $e->getMessage()));
 }
 
 $testHelper->terminateTest();

tests/Api.test.php

@@ -7,7 +7,7 @@
 
 use Phpfastcache\CacheManager;
 use Phpfastcache\Exceptions\PhpfastcacheLogicException;
-use Phpfastcache\Helper\TestHelper;
+use Phpfastcache\Tests\Helper\TestHelper;
 use Psr\Cache\CacheItemPoolInterface;
 
 
@@ -22,9 +22,9 @@
 $driverInstance = CacheManager::getInstance($defaultDriver);
 
 if (!is_object($driverInstance)) {
-    $testHelper->printFailText('CacheManager::getInstance() returned an invalid variable type:' . gettype($driverInstance));
+    $testHelper->assertFail('CacheManager::getInstance() returned an invalid variable type:' . gettype($driverInstance));
 }else if(!($driverInstance instanceof CacheItemPoolInterface)){
-    $testHelper->printFailText('CacheManager::getInstance() returned an invalid class:' . get_class($driverInstance));
+    $testHelper->assertFail('CacheManager::getInstance() returned an invalid class:' . get_class($driverInstance));
 }else{
     $key = 'test_attaching_detaching';
 
@@ -34,19 +34,19 @@
 
     if($driverInstance->isAttached($itemDetached) !== true)
     {
-        $testHelper->printPassText('ExtendedCacheItemPoolInterface::isAttached() identified $itemDetached as being detached.');
+        $testHelper->assertPass('ExtendedCacheItemPoolInterface::isAttached() identified $itemDetached as being detached.');
     }
     else
     {
-        $testHelper->printFailText('ExtendedCacheItemPoolInterface::isAttached() failed to identify $itemDetached as to be detached.');
+        $testHelper->assertFail('ExtendedCacheItemPoolInterface::isAttached() failed to identify $itemDetached as to be detached.');
     }
 
     try{
         $driverInstance->attachItem($itemDetached);
-        $testHelper->printFailText('ExtendedCacheItemPoolInterface::attachItem() attached $itemDetached without trowing an error.');
+        $testHelper->assertFail('ExtendedCacheItemPoolInterface::attachItem() attached $itemDetached without trowing an error.');
     }catch(PhpfastcacheLogicException $e){
-        $testHelper->printPassText('ExtendedCacheItemPoolInterface::attachItem() failed to attach $itemDetached by trowing a phpfastcacheLogicException exception.');
+        $testHelper->assertPass('ExtendedCacheItemPoolInterface::attachItem() failed to attach $itemDetached by trowing a phpfastcacheLogicException exception.');
     }
 }
 
-$testHelper->terminateTest();
+$testHelper->terminateTest();

tests/AttachingDetachingMethods.test.php

@@ -8,13 +8,13 @@
 use Phpfastcache\CacheManager;
 use Phpfastcache\Core\Pool\ExtendedCacheItemPoolInterface;
 use Phpfastcache\Exceptions\PhpfastcacheRootException;
-use Phpfastcache\Helper\TestHelper;
+use Phpfastcache\Tests\Helper\TestHelper;
 
 chdir(__DIR__);
 require_once __DIR__ . '/../vendor/autoload.php';
 $testHelper = new TestHelper('"Auto" driver');
 
-$testHelper->printSkipText('This feature has been removed as of phpfastcache V8');
+$testHelper->assertSkip('This feature has been removed as of phpfastcache V8');
 /*try{
     $driverInstance = CacheManager::getInstance('Auto');
     if($driverInstance instanceof ExtendedCacheItemPoolInterface){

tests/AutoDriver.test.php

@@ -6,6 +6,7 @@
  */
 
 use Phpfastcache\CacheManager;
+use Phpfastcache\Tests\Helper\TestHelper;
 use Psr\Cache\CacheItemInterface;
 
 chdir(__DIR__);
@@ -32,4 +33,14 @@
     print '[PASS] Autoload successfully found the Psr CacheItemInterface' . PHP_EOL;
 }
 
-exit($exitCode);
+/**
+ * Testing Psr autoload
+ */
+if (!class_exists(TestHelper::class)) {
+    print '[FAIL] Autoload failed to find the TestHelper' . PHP_EOL;
+    $exitCode = 255;
+} else {
+    print '[PASS] Autoload successfully found the TestHelper' . PHP_EOL;
+}
+
+exit($exitCode);

tests/Autoload.test.php

@@ -8,7 +8,7 @@
 use Phpfastcache\Core\Pool\ExtendedCacheItemPoolInterface;
 use Phpfastcache\CacheManager;
 use Phpfastcache\Exceptions\PhpfastcacheInstanceNotFoundException;
-use Phpfastcache\Helper\TestHelper;
+use Phpfastcache\Tests\Helper\TestHelper;
 
 chdir(__DIR__);
 require_once __DIR__ . '/../vendor/autoload.php';
@@ -28,17 +28,17 @@
 
 $cacheInstances = CacheManager::getInstances();
 if(\count($cacheInstances) === 3){
-    $testHelper->printPassText('A single cache instance have been cleared');
+    $testHelper->assertPass('A single cache instance have been cleared');
 }else{
-    $testHelper->printFailText('A single cache instance have NOT been cleared');
+    $testHelper->assertFail('A single cache instance have NOT been cleared');
 }
 
 $driverInstance2Hash = spl_object_hash($driverInstance2);
 foreach ($cacheInstances as $cacheInstance) {
     $driverInstanceHash = spl_object_hash($cacheInstance);
     if($driverInstanceHash !== $driverInstance2Hash){
-        $testHelper->printPassText("Compared cache instance #{$driverInstanceHash} does not match with previously cleared cache instance #" . $driverInstance2Hash);
+        $testHelper->assertPass("Compared cache instance #{$driverInstanceHash} does not match with previously cleared cache instance #" . $driverInstance2Hash);
     }else{
-        $testHelper->printFailText("Compared cache instance  #{$driverInstanceHash} unfortunately match with previously cleared cache instance #" . $driverInstance2Hash);
+        $testHelper->assertFail("Compared cache instance  #{$driverInstanceHash} unfortunately match with previously cleared cache instance #" . $driverInstance2Hash);
     }
-}
+}