feature #30935 Use env variable to create anytype of lock store (jderusse)

fabpot · fabpot · commit fad7c8c01fc8 · 2019-04-06T21:40:22.000+02:00
This PR was merged into the 4.3-dev branch. Discussion ---------- Use env variable to create anytype of lock store | Q | A | ------------- | --- | Branch? | master | Bug fix? | yes | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #27555 | License | MIT | Doc PR | NA In lock configuration, at the moment, env variable are only able to resolve DNS which are able to create RedisStore and MemcachedStore. This PR update the StoreFactory to be able to also create connection at runtime. Commits ------- 6b57ea9 Use env variable to create anytype of lock store
diff --git a/src/Symfony/Component/Lock/Store/StoreFactory.php b/src/Symfony/Component/Lock/Store/StoreFactory.php
@@ -11,9 +11,11 @@
 
 namespace Symfony\Component\Lock\Store;
 
+use Symfony\Component\Cache\Adapter\AbstractAdapter;
 use Symfony\Component\Cache\Traits\RedisClusterProxy;
 use Symfony\Component\Cache\Traits\RedisProxy;
 use Symfony\Component\Lock\Exception\InvalidArgumentException;
+use Symfony\Component\Lock\StoreInterface;
 
 /**
  * StoreFactory create stores and connections.
@@ -23,9 +25,9 @@
 class StoreFactory
 {
     /**
-     * @param \Redis|\RedisArray|\RedisCluster|\Predis\Client|\Memcached|\Zookeeper $connection
+     * @param \Redis|\RedisArray|\RedisCluster|\Predis\Client|\Memcached|\Zookeeper|string $connection Connection or DSN or Store short name
      *
-     * @return RedisStore|MemcachedStore|ZookeeperStore
+     * @return StoreInterface
      */
     public static function createStore($connection)
     {
@@ -45,7 +47,21 @@ public static function createStore($connection)
         if ($connection instanceof \Zookeeper) {
             return new ZookeeperStore($connection);
         }
+        if (!\is_string($connection)) {
+            throw new InvalidArgumentException(sprintf('Unsupported Connection: %s.', \get_class($connection)));
+        }
 
-        throw new InvalidArgumentException(sprintf('Unsupported Connection: %s.', \get_class($connection)));
+        switch (true) {
+            case 'flock' === $connection:
+                return new FlockStore();
+            case 0 === strpos($connection, 'flock://'):
+                return new FlockStore(substr($connection, 8));
+            case 'semaphore' === $connection:
+                return new SemaphoreStore();
+            case preg_match('#^[a-z]++://#', $connection):
+                return static::createStore(AbstractAdapter::createConnection($connection));
+            default:
+                throw new InvalidArgumentException(sprintf('Unsupported Connection: %s.', $connection));
+        }
     }
 }
diff --git a/src/Symfony/Component/Lock/Tests/Store/StoreFactoryTest.php b/src/Symfony/Component/Lock/Tests/Store/StoreFactoryTest.php
@@ -0,0 +1,58 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Lock\Tests\Store;
+
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\Cache\Traits\RedisProxy;
+use Symfony\Component\Lock\Store\FlockStore;
+use Symfony\Component\Lock\Store\MemcachedStore;
+use Symfony\Component\Lock\Store\RedisStore;
+use Symfony\Component\Lock\Store\SemaphoreStore;
+use Symfony\Component\Lock\Store\StoreFactory;
+use Symfony\Component\Lock\Store\ZookeeperStore;
+
+/**
+ * @author Jérémy Derussé <jeremy@derusse.com>
+ */
+class StoreFactoryTest extends TestCase
+{
+    /**
+     * @dataProvider validConnections
+     */
+    public function testCreateStore($connection, string $expectedStoreClass)
+    {
+        $store = StoreFactory::createStore($connection);
+
+        $this->assertInstanceOf($expectedStoreClass, $store);
+    }
+
+    public function validConnections()
+    {
+        if (\class_exists(\Redis::class)) {
+            yield [$this->createMock(\Redis::class), RedisStore::class];
+        }
+        yield [$this->createMock(RedisProxy::class), RedisStore::class];
+        yield [$this->createMock(\Predis\Client::class), RedisStore::class];
+        if (\class_exists(\Memcached::class)) {
+            yield [$this->createMock(\Memcached::class), MemcachedStore::class];
+        }
+        if (\class_exists(\Zookeeper::class)) {
+            yield [$this->createMock(\Zookeeper::class), ZookeeperStore::class];
+        }
+        yield ['flock', FlockStore::class];
+        yield ['flock:///tmp', FlockStore::class];
+        yield ['semaphore', SemaphoreStore::class];
+        if (\class_exists(\Memcached::class)) {
+            yield ['memcached://server.com', MemcachedStore::class];
+        }
+    }
+}
