Merge pull request #120 from julienloizelet/fix/test-connection-for-memcached

fix(memcached): Update testCacheConnetion method to throw an error if…

Author: julienloizelet

.github/workflows/release.yml

@@ -66,7 +66,7 @@ jobs:
           fi
           
           # Check top [_Compare with previous release_](GITHUB_URL/compare/vLAST_TAG...vVERSION_NUMBER) in CHANGELOG.md
-          COMPARISON=$(grep -oP "\/compare\/\K(.*)$" CHANGELOG.md | head -1)
+          COMPARISON=$(grep -oP "$GITHUB_SERVER_URL/$GITHUB_REPOSITORY/compare/\K(.*)$" CHANGELOG.md | head -1)
           LAST_TAG=$(curl -Ls -o /dev/null -w %{url_effective} $GITHUB_SERVER_URL/$GITHUB_REPOSITORY/releases/latest | grep -oP "\/tag\/\K(.*)$")
           if [[ $COMPARISON == "$LAST_TAG...v${{ env.VERSION_NUMBER }})" ]]
           then

CHANGELOG.md

@@ -9,6 +9,15 @@ The purpose of this section is to declare the public API of this library as requ
 
 The public API of this library consists of all public or protected methods, properties and constants belonging to the `src` folder.
 
+---
+
+## [1.0.1](https://github.com/crowdsecurity/php-cs-bouncer/releases/tag/v1.0.0) - 2023-02-10
+[_Compare with previous release_](https://github.com/crowdsecurity/php-cs-bouncer/compare/v1.0.0...v1.0.1)
+
+### Fixed
+- Update `AbstractBouncer::testCacheConnection` method to throw an exception for Memcached if necessary
+
+
 ---
 
 ## [1.0.0](https://github.com/crowdsecurity/php-cs-bouncer/releases/tag/v1.0.0) - 2023-02-03

src/AbstractBouncer.php

@@ -281,18 +281,29 @@ public function shouldBounceCurrentIp(): bool
      * @return void
      * @throws BouncerException
      * @throws InvalidArgumentException
+     * @todo custom error handler should be in RemediationEngine (v3.0.0)
      */
     public function testCacheConnection(): void
     {
         try {
             $cache = $this->getRemediationEngine()->getCacheStorage();
+            if ($cache instanceof Memcached) {
+                set_error_handler(function ($errno, $errstr) {
+                    $message = "Memcached error. (Error level: $errno) Original error was: $errstr";
+                    throw new CacheStorageException($message);
+                });
+            }
             $cache->getItem(AbstractCache::CONFIG);
         } catch (\Exception $e) {
             throw new BouncerException(
                 'Error while testing cache connection: ' . $e->getMessage(),
                 (int)$e->getCode(),
                 $e
             );
+        } finally {
+            if (isset($cache) && $cache instanceof Memcached) {
+                restore_error_handler();
+            }
         }
     }
 

src/Constants.php

@@ -39,7 +39,7 @@ class Constants extends RemConstants
     /** @var string Path for html templates folder (e.g. ban and captcha wall) */
     public const TEMPLATES_DIR = __DIR__ . "/templates";
     /** @var string The last version of this library */
-    public const VERSION = 'v1.0.0';
+    public const VERSION = 'v1.0.1';
     /** @var string The "disabled" x-forwarded-for setting */
     public const X_FORWARDED_DISABLED = 'no_forward';
 }

tests/Integration/IpVerificationTest.php

@@ -5,6 +5,7 @@
 namespace CrowdSecBouncer\Tests\Integration;
 
 use CrowdSec\Common\Logger\FileLog;
+use CrowdSec\RemediationEngine\CacheStorage\CacheStorageException;
 use CrowdSecBouncer\Bouncer;
 use CrowdSecBouncer\BouncerException;
 use CrowdSecBouncer\Constants;
@@ -186,6 +187,65 @@ private function addTlsConfig(&$bouncerConfigs, $tlsPath)
         $bouncerConfigs['tls_verify_peer'] = true;
     }
 
+    /**
+     * @group integration
+     * @dataProvider cacheAdapterConfigProvider
+     */
+    public function testTestCacheConnexion($cacheAdapterName, $origCacheName)
+    {
+        $bouncer = new StandaloneBouncer(array_merge($this->configs,
+                ['cache_system'=> $cacheAdapterName]));
+        $error = '';
+        try {
+            $bouncer->testCacheConnection();
+        } catch (\Exception $e){
+            $error = $e->getMessage();
+        }
+        $this->assertEquals('', $error);
+
+        // Test custom error handler for Memcached
+        if($cacheAdapterName === 'memcached'){
+            $bouncer2 = new StandaloneBouncer(array_merge($this->configs,
+                [
+                    'cache_system'=> $cacheAdapterName,
+                    'memcached_dsn' => 'memcached://memcached:21',
+                ]));
+
+            $error = '';
+            try {
+                $bouncer2->testCacheConnection();
+            } catch (BouncerException $e){
+                $error = $e->getMessage();
+            }
+            PHPUnitUtil::assertRegExp(
+                $this,
+                '/Error while testing cache connection/',
+                $error,
+                'Should have throw an error'
+            );
+        }
+        // Test bad dsn for redis
+        if($cacheAdapterName === 'redis'){
+            $error = '';
+            try {
+                $bouncer3 = new StandaloneBouncer(array_merge($this->configs,
+                    [
+                        'cache_system'=> $cacheAdapterName,
+                        'redis_dsn' => 'redis://redis:21'
+                    ]));
+            } catch (CacheStorageException $e){
+                $error = $e->getMessage();
+            }
+            PHPUnitUtil::assertRegExp(
+                $this,
+                '/Error when creating/',
+                $error,
+                'Should have throw an error'
+            );
+
+        }
+    }
+
     public function testConstructAndSomeMethods()
     {
         unset($_SERVER['REMOTE_ADDR'] );