Merge pull request #27 from crowdsecurity/move-scripts

move scripts

Author: mobula9

docs/contribute.md

@@ -22,7 +22,7 @@ Here is the development environment for this library:
 First of all, install composer dependencies:
 
 ```bash
-   ./composer-install.sh
+docker-compose run app composer install
 ```
 Then run tests:
 ```bash
@@ -67,17 +67,19 @@ We use the git workflow [Github Flow](https://guides.github.com/introduction/flo
 #### New feature
 
 ```bash
-git checkout -b <basic-name> # the name is not important now, you can type "new-features"
-git commit # as mush as necessary.
+git checkout -b <branch-name>
+git commit # as much as necessary.
 
 PHP_CS_FIXER_IGNORE_ENV=1 tools/php-cs-fixer/vendor/bin/php-cs-fixer fix # fix coding standards
 docker run -e "FILTER_REGEX_INCLUDE=/tmp/lint/src/.*" -e RUN_LOCAL=true -v ${PWD}:/tmp/lint github/super-linter # super linter local pass
 ./tests-local.sh # check tests are still OK
 docker-compose run --rm app vendor/bin/phpdoc-md # Regenerate php doc
 
-git branch -m <name-of-the-branch> # to rename the branch to what has really be done.
-git push origin :<basic-name> && git push origin <name-of-the-branch> # Only if already pushed
+# Rename branch if necessary
+git branch -m <new-name>
+git push origin :<old-name> && git push origin <new-name>
 
+# Create PR
 gh pr create --fill
 ```
 
@@ -90,4 +92,3 @@ git checkout main && git pull
 git describe --tags `git rev-list --tags --max-count=1` # to verify what is the current tag
 export NEW_GIT_VERSION=v #...X.X.X
 ./scripts/publish-release.sh
-```

examples/README.md

@@ -11,8 +11,8 @@ Let's get started and follow the guide!
 Start the containers:
 
 ```bash
-./composer-install.sh
-./setup-local-crowdsec.sh
+docker-compose run app composer install
+./scripts/setup-local-crowdsec.sh
 ```
 
 Then get a bouncer API key with:

phpdoc.dist.xml

@@ -1,14 +1,14 @@
 #!/bin/sh
 
 # Delete existing LAPI database.
-[ -e ./var/docker-data/crowdsec.db ] && rm ./var/docker-data/crowdsec.db
+[ -e ../var/docker-data/crowdsec.db ] && rm ../var/docker-data/crowdsec.db
 
 # Start containers.
 docker-compose up --force-recreate -d crowdsec
 docker-compose up --remove-orphans -d redis memcached
 
 # Create a bouncer with cscli and copy expose generated key.
-docker-compose exec crowdsec /usr/local/bin/cscli bouncers add bouncer-php-library -o raw > .bouncer-key
+docker-compose exec crowdsec /usr/local/bin/cscli bouncers add bouncer-php-library -o raw > ../.bouncer-key
 
 # Create a watcher with cscli.
 docker-compose exec crowdsec cscli machines add PhpUnitTestMachine --password PhpUnitTestMachinePassword > /dev/null 2>&1

setup-local-crowdsec.sh renamed to scripts/setup-local-crowdsec.sh

@@ -8,6 +8,7 @@
 use Psr\Log\LoggerInterface;
 use Symfony\Component\Cache\Adapter\AbstractAdapter;
 use Symfony\Component\Cache\Adapter\FilesystemAdapter;
+use Symfony\Component\Cache\Adapter\MemcachedAdapter;
 use Symfony\Component\Cache\PruneableInterface;
 
 /**
@@ -243,7 +244,7 @@ private function saveRemediations(array $decisions): bool
             }
         }
 
-        return $this->adapter->commit();
+        return $this->commit();
     }
 
     private function removeRemediations(array $decisions): bool
@@ -268,7 +269,7 @@ private function removeRemediations(array $decisions): bool
             }
         }
 
-        return $this->adapter->commit();
+        return $this->commit();
     }
 
     /**
@@ -291,17 +292,22 @@ private function saveRemediationsForIp(array $decisions, string $ip): string
             $remediation = $this->formatRemediationFromDecision(null);
             $remediationResult = $this->addRemediationToCacheItem($ip, $remediation[0], $remediation[1], $remediation[2]);
         }
-        $this->adapter->commit();
+        $this->commit();
 
         return $remediationResult;
     }
 
     public function clear(): bool
     {
-        $cleared = $this->adapter->clear();
+        $this->setCustomErrorHandler();
+        try {
+            $cleared = $this->adapter->clear();
+        } finally {
+            $this->unsetCustomErrorHandler();
+        }
         $this->warmedUp = false;
         $this->defferUpdateCacheConfig(['warmed_up' => $this->warmedUp]);
-        $this->adapter->commit();
+        $this->commit();
         $this->logger->info('', ['type' => 'CACHE_CLEARED']);
 
         return $cleared;
@@ -328,7 +334,7 @@ public function warmUp(): int
         if ($newDecisions) {
             $this->warmedUp = $this->saveRemediations($newDecisions);
             $this->defferUpdateCacheConfig(['warmed_up' => $this->warmedUp]);
-            $this->adapter->commit();
+            $this->commit();
             if (!$this->warmedUp) {
                 throw new BouncerException('Unable to warm the cache up');
             }
@@ -338,7 +344,7 @@ public function warmUp(): int
         // Store the fact that the cache has been warmed up.
         $this->defferUpdateCacheConfig(['warmed_up' => true]);
 
-        $this->adapter->commit();
+        $this->commit();
         $this->logger->info('', ['type' => 'CACHE_WARMED_UP', 'added_decisions' => $nbNew]);
 
         return $nbNew;
@@ -447,6 +453,9 @@ public function get(string $ip): string
         return $remediation;
     }
 
+    /**
+     * Prune the cache (only when using PHP File System cache).
+     */
     public function prune(): bool
     {
         if ($this->adapter instanceof PruneableInterface) {
@@ -458,4 +467,59 @@ public function prune(): bool
 
         throw new BouncerException('Cache Adapter'.\get_class($this->adapter).' is not prunable.');
     }
+
+    /**
+     * When Memcached connection fail, it throw an unhandled warning.
+     * To catch this warning as a clean execption we have to temporarily change the error handler.
+     */
+    private function setCustomErrorHandler(): void
+    {
+        if ($this->adapter instanceof MemcachedAdapter) {
+            set_error_handler(function () {
+                throw new BouncerException('Error when connecting to Memcached. Please fix the Memcached DSN or select another cache technology.');
+            });
+        }
+    }
+
+    /**
+     * When the selected cache adapter is MemcachedAdapter, revert to the previous error handler.
+     * */
+    private function unsetCustomErrorHandler(): void
+    {
+        if ($this->adapter instanceof MemcachedAdapter) {
+            restore_error_handler();
+        }
+    }
+
+    /**
+     * Wrap the cacheAdapter to catch warnings.
+     *
+     * @throws BouncerException if the connection was not successful
+     * */
+    private function commit(): bool
+    {
+        $this->setCustomErrorHandler();
+        try {
+            $result = $this->adapter->commit();
+        } finally {
+            $this->unsetCustomErrorHandler();
+        }
+
+        return $result;
+    }
+
+    /**
+     * Test the connection to the cache system (Redis or Memcached).
+     *
+     * @throws BouncerException if the connection was not successful
+     * */
+    public function testConnection(): void
+    {
+        $this->setCustomErrorHandler();
+        try {
+            $this->adapter->getItem(' ');
+        } finally {
+            $this->unsetCustomErrorHandler();
+        }
+    }
 }

src/ApiCache.php

@@ -196,4 +196,14 @@ public function checkCaptcha(string $expected, string $try, string $ip)
 
         return $solved;
     }
+
+    /**
+     * Test the connection to the cache system (Redis or Memcached)
+     * 
+     * @throws BouncerException if the connection was not successful
+     * */
+    public function testConnection()
+    {
+        return $this->apiCache->testConnection();
+    }
 }

src/Bouncer.php

@@ -18,7 +18,7 @@ class Constants
     public const CAPI_URL = 'https://api.crowdsec.net/v2/';
 
     /** @var string The last version of this library */
-    public const VERSION = 'v0.6.0';
+    public const VERSION = 'v0.7.0';
 
     /** @var string The user agent used to send request to LAPI or CAPI */
     public const BASE_USER_AGENT = 'PHP CrowdSec Bouncer/'.self::VERSION;

src/Constants.php

@@ -1,6 +1,6 @@
 #!/bin/sh
 
 # Setup local CrowdSec instance
-./setup-local-crowdsec.sh
+./scripts/setup-local-crowdsec.sh
 
 docker-compose run --rm app-php7.3 ./vendor/bin/phpunit --testdox --colors --exclude-group ignore tests/IpVerificationTest.php

tests-local-php7.3.sh

@@ -1,6 +1,6 @@
 #!/bin/sh
 
 # Setup local CrowdSec instance
-./setup-local-crowdsec.sh
+./scripts/setup-local-crowdsec.sh
 
 docker-compose run --rm app-php7.4 ./vendor/bin/phpunit --testdox --colors --exclude-group ignore tests/IpVerificationTest.php

tests-local-php7.4.sh

@@ -1,6 +1,6 @@
 #!/bin/sh
 
 # Setup local CrowdSec instance
-./setup-local-crowdsec.sh
+./scripts/setup-local-crowdsec.sh
 
 docker-compose run --rm app-php8.0 ./vendor/bin/phpunit --testdox --colors --exclude-group ignore tests/IpVerificationTest.php