RedisLockStrategyTest::shouldThrowExceptionBecauseConfigIsMissing() - Code Metrics - Inspection of "re-implementation with a REDIS list as a synchroni..." - tourstream/typo3-redis-lock-strategy - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#8)

unknown

created 2017-12-18 11:58 UTC

shouldThrowExceptionBecauseConfigIsMissing() A

↳ Parent: RedisLockStrategyTest

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	4
rs	10
cc	1
eloc	2
nc	1
nop	0

<?php

namespace Tourstream\RedisLockStrategy\Tests;

/***************************************************************
 *  Copyright notice
 *
 *  (c) 2017 Alexander Miehe ([email protected])
 *  All rights reserved
 *
 *  You may not remove or change the name of the author above. See:
 *  http://www.gnu.org/licenses/gpl-faq.html#IWantCredit
 *
 *  This script is part of the Typo3 project. The Typo3 project is
 *  free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  The GNU General Public License can be found at
 *  http://www.gnu.org/copyleft/gpl.html.
 *  A copy is found in the LICENSE and distributed with these scripts.
 *
 *
 *  This script is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  This copyright notice MUST APPEAR in all copies of the script!
 ***************************************************************/

use TYPO3\CMS\Core\Locking\LockFactory;
use TYPO3\CMS\Core\Locking\LockingStrategyInterface;
use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\TestingFramework\Core\Functional\FunctionalTestCase;

/**
 * @author Alexander Miehe <[email protected]>
 *
 * @covers \Tourstream\RedisLockStrategy\RedisLockStrategy
 */
class RedisLockStrategyTest extends FunctionalTestCase
{
    /**
     * @var LockFactory
     */
    private $lockFactory;
    private $redisHost;
    private $redisDatabase;

    /**
     * @test
     * @expectedException \TYPO3\CMS\Core\Locking\Exception\LockCreateException
     * @expectedExceptionMessage no configuration for redis lock strategy found
     */
    public function shouldThrowExceptionBecauseConfigIsMissing()
    {
        $this->lockFactory->createLocker('test');
    }

    /**
     * @test
     * @expectedException \TYPO3\CMS\Core\Locking\Exception\LockCreateException
     * @expectedExceptionMessage no configuration for redis lock strategy found
     */
    public function shouldThrowExceptionBecauseConfigIsNotAnArray()
    {
        $GLOBALS['TYPO3_CONF_VARS']['SYS']['redis_lock'] = 'test';

        $this->lockFactory->createLocker('test');
    }

    /**
     * @test
     * @expectedException \TYPO3\CMS\Core\Locking\Exception\LockCreateException
     * @expectedExceptionMessage no host for redis lock strategy found
     */
    public function shouldThrowExceptionBecauseConfigHasNoHost()
    {
        $GLOBALS['TYPO3_CONF_VARS']['SYS']['redis_lock'] = [];

        $this->lockFactory->createLocker('test');
    }

    /**
     * @test
     * @expectedException \TYPO3\CMS\Core\Locking\Exception\LockCreateException
     * @expectedExceptionMessage no database for redis lock strategy found
     */
    public function shouldThrowExceptionBecauseConfigHasNoDatabase()

    {
        $GLOBALS['TYPO3_CONF_VARS']['SYS']['redis_lock'] = [
            'host' => $this->redisHost,
        ];

        $this->lockFactory->createLocker('test');
    }

    /**
     * @test
     */
    public function shouldConnectAndAcquireAExistingLock()
    {
        $subject = uniqid();

        $locker = $this->getLocker($subject);

        self::assertTrue($locker->acquire());
    }

    /**
     * @test
     */
    public function shouldConnectAndAcquireALock()

    {
        $subject = uniqid();

        $mutex = sprintf('lock:mutex:%s', $subject);

        $locker = $this->getLocker($subject);

        $redis = $this->getRedisClient();

        self::assertTrue($locker->acquire());

        self::assertTrue($redis->exists($mutex));
    }

    /**
     * @test
     */
    public function shouldConnectAndCheckIfLockIsAcquired()
    {
        $subject = uniqid();

        $locker = $this->getLocker($subject);

        $locker->acquire();

        self::assertTrue($locker->isAcquired());
    }

    /**
     * @test
     */
    public function shouldConnectAndDestroyALock()

    {
        $subject = uniqid();

        $mutex = sprintf('lock:mutex:%s', $subject);

        $locker = $this->getLocker($subject);

        $redis = $this->getRedisClient();

        $locker->destroy();

        self::assertFalse($redis->exists($mutex));
    }

    /**
     * @test
     */
    public function shouldAcquireNonBlockingAndReleaseMoreLocks()
    {
        $subject = uniqid();
$a = "a";
$ab = "ab";
$abc = "abc";
        $capabilities = LockingStrategyInterface::LOCK_CAPABILITY_EXCLUSIVE | LockingStrategyInterface::LOCK_CAPABILITY_NOBLOCK;


        $locker1 = $this->getLocker($subject);
        $locker2 = $this->getLocker($subject);
        $locker3 = $this->getLocker($subject);

        self::assertTrue($locker1->acquire($capabilities));
        self::expectException('\TYPO3\CMS\Core\Locking\Exception\LockAcquireWouldBlockException') && $locker2->acquire($capabilities);

        self::expectException('\TYPO3\CMS\Core\Locking\Exception\LockAcquireWouldBlockException') && $locker3->acquire($capabilities);


        self::assertTrue($locker1->isAcquired());
        self::assertFalse($locker2->isAcquired());
        self::assertFalse($locker3->isAcquired());

        self::assertTrue($locker1->release());

        self::assertFalse($locker1->isAcquired());
        self::assertFalse($locker2->isAcquired());
        self::assertFalse($locker3->isAcquired());

        self::assertTrue($locker2->acquire($capabilities));

        self::assertFalse($locker1->isAcquired());
        self::assertTrue($locker2->isAcquired());
        self::assertFalse($locker3->isAcquired());

        self::assertTrue($locker3->release());

        self::assertFalse($locker1->isAcquired());
        self::assertTrue($locker2->isAcquired());
        self::assertFalse($locker3->isAcquired());

        self::assertFalse($locker1->acquire($capabilities));

        self::assertFalse($locker1->isAcquired());
        self::assertTrue($locker2->isAcquired());
        self::assertFalse($locker3->isAcquired());

        self::assertTrue($locker2->release());

        self::assertFalse($locker1->isAcquired());
        self::assertFalse($locker2->isAcquired());
        self::assertFalse($locker3->isAcquired());

        self::assertTrue($locker3->acquire($capabilities));

        self::assertFalse($locker1->isAcquired());
        self::assertFalse($locker2->isAcquired());
        self::assertTrue($locker3->isAcquired());
    }

    protected function setUp()
    {
        $this->testExtensionsToLoad[] = 'typo3conf/ext/redis_lock_strategy';
        $this->redisHost              = getenv('typo3RedisHost');
        $this->redisDatabase          = getenv('typo3RedisDatabase');

        parent::setUp();

        $this->lockFactory = GeneralUtility::makeInstance(LockFactory::class);
    }

    protected function tearDown()
    {
        parent::tearDown();

        $this->getRedisClient()->flushDB();
    }

    /**
     * @return \Redis
     */
    private function getRedisClient()
    {
        $redis = new \Redis();
        $redis->connect($this->redisHost);
        $redis->select($this->redisDatabase);

        return $redis;
    }

    /**
     * @param string $id Locker id
     *
     * @return \TYPO3\CMS\Core\Locking\LockingStrategyInterface
     */
    private function getLocker($id)

    {
        $GLOBALS['TYPO3_CONF_VARS']['SYS']['redis_lock'] = [
            'host'     => $this->redisHost,
            'database' => $this->redisDatabase,
        ];

        return $this->lockFactory->createLocker($id);
    }

}


1		<?php
2
3		namespace Tourstream\RedisLockStrategy\Tests;
4
5		/***************************************************************
6		* Copyright notice
7		*
8		* (c) 2017 Alexander Miehe ([email protected])
9		* All rights reserved
10		*
11		* You may not remove or change the name of the author above. See:
12		* http://www.gnu.org/licenses/gpl-faq.html#IWantCredit
13		*
14		* This script is part of the Typo3 project. The Typo3 project is
15		* free software; you can redistribute it and/or modify
16		* it under the terms of the GNU General Public License as published by
17		* the Free Software Foundation; either version 3 of the License, or
18		* (at your option) any later version.
19		*
20		* The GNU General Public License can be found at
21		* http://www.gnu.org/copyleft/gpl.html.
22		* A copy is found in the LICENSE and distributed with these scripts.
23		*
24		*
25		* This script is distributed in the hope that it will be useful,
26		* but WITHOUT ANY WARRANTY; without even the implied warranty of
27		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
28		* GNU General Public License for more details.
29		*
30		* This copyright notice MUST APPEAR in all copies of the script!
31		***************************************************************/
32
33		use TYPO3\CMS\Core\Locking\LockFactory;
34		use TYPO3\CMS\Core\Locking\LockingStrategyInterface;
35		use TYPO3\CMS\Core\Utility\GeneralUtility;
36		use TYPO3\TestingFramework\Core\Functional\FunctionalTestCase;
37
38		/**
39		* @author Alexander Miehe <[email protected]>
40		*
41		* @covers \Tourstream\RedisLockStrategy\RedisLockStrategy
42		*/
43		class RedisLockStrategyTest extends FunctionalTestCase
44		{
45		/**
46		* @var LockFactory
47		*/
48		private $lockFactory;
49		private $redisHost;
50		private $redisDatabase;
51
52		/**
53		* @test
54		* @expectedException \TYPO3\CMS\Core\Locking\Exception\LockCreateException
55		* @expectedExceptionMessage no configuration for redis lock strategy found
56		*/
57		public function shouldThrowExceptionBecauseConfigIsMissing()
58		{
59		$this->lockFactory->createLocker('test');
60		}
61
62		/**
63		* @test
64		* @expectedException \TYPO3\CMS\Core\Locking\Exception\LockCreateException
65		* @expectedExceptionMessage no configuration for redis lock strategy found
66		*/
67		public function shouldThrowExceptionBecauseConfigIsNotAnArray()
68		{
69		$GLOBALS['TYPO3_CONF_VARS']['SYS']['redis_lock'] = 'test';
70
71		$this->lockFactory->createLocker('test');
72		}
73
74		/**
75		* @test
76		* @expectedException \TYPO3\CMS\Core\Locking\Exception\LockCreateException
77		* @expectedExceptionMessage no host for redis lock strategy found
78		*/
79		public function shouldThrowExceptionBecauseConfigHasNoHost()
80		{
81		$GLOBALS['TYPO3_CONF_VARS']['SYS']['redis_lock'] = [];
82
83		$this->lockFactory->createLocker('test');
84		}
85
86		/**
87		* @test
88		* @expectedException \TYPO3\CMS\Core\Locking\Exception\LockCreateException
89		* @expectedExceptionMessage no database for redis lock strategy found
90		*/
91	View Code Duplication	public function shouldThrowExceptionBecauseConfigHasNoDatabase()
		0 ignored issues – show Duplication introduced 2017-12-18 12:02 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
92		{
93		$GLOBALS['TYPO3_CONF_VARS']['SYS']['redis_lock'] = [
94		'host' => $this->redisHost,
95		];
96
97		$this->lockFactory->createLocker('test');
98		}
99
100		/**
101		* @test
102		*/
103		public function shouldConnectAndAcquireAExistingLock()
104		{
105		$subject = uniqid();
106
107		$locker = $this->getLocker($subject);
108
109		self::assertTrue($locker->acquire());
110		}
111
112		/**
113		* @test
114		*/
115	View Code Duplication	public function shouldConnectAndAcquireALock()
		0 ignored issues – show Duplication introduced 2017-08-03 08:34 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
116		{
117		$subject = uniqid();
118
119		$mutex = sprintf('lock:mutex:%s', $subject);
120
121		$locker = $this->getLocker($subject);
122
123		$redis = $this->getRedisClient();
124
125		self::assertTrue($locker->acquire());
126
127		self::assertTrue($redis->exists($mutex));
128		}
129
130		/**
131		* @test
132		*/
133		public function shouldConnectAndCheckIfLockIsAcquired()
134		{
135		$subject = uniqid();
136
137		$locker = $this->getLocker($subject);
138
139		$locker->acquire();
140
141		self::assertTrue($locker->isAcquired());
142		}
143
144		/**
145		* @test
146		*/
147	View Code Duplication	public function shouldConnectAndDestroyALock()
		0 ignored issues – show Duplication introduced 2017-08-03 08:34 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
148		{
149		$subject = uniqid();
150
151		$mutex = sprintf('lock:mutex:%s', $subject);
152
153		$locker = $this->getLocker($subject);
154
155		$redis = $this->getRedisClient();
156
157		$locker->destroy();
158
159		self::assertFalse($redis->exists($mutex));
160		}
161
162		/**
163		* @test
164		*/
165		public function shouldAcquireNonBlockingAndReleaseMoreLocks()
166		{
167		$subject = uniqid();
		0 ignored issues – show Coding Style introduced 2017-12-14 23:58 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 6 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
168		$capabilities = LockingStrategyInterface::LOCK_CAPABILITY_EXCLUSIVE \| LockingStrategyInterface::LOCK_CAPABILITY_NOBLOCK;
		0 ignored issues – show Coding Style introduced 2017-12-14 23:58 UTC by Report Bug Copy Issue Report This line exceeds maximum limit of 120 characters; contains 128 characters Overly long lines are hard to read on any screen. Most code styles therefor impose a maximum limit on the number of characters in a line. Loading history...
169
170		$locker1 = $this->getLocker($subject);
171		$locker2 = $this->getLocker($subject);
172		$locker3 = $this->getLocker($subject);
173
174		self::assertTrue($locker1->acquire($capabilities));
175		self::expectException('\TYPO3\CMS\Core\Locking\Exception\LockAcquireWouldBlockException') && $locker2->acquire($capabilities);
		0 ignored issues – show Coding Style introduced 2017-12-15 00:10 UTC by Report Bug Copy Issue Report This line exceeds maximum limit of 120 characters; contains 134 characters Overly long lines are hard to read on any screen. Most code styles therefor impose a maximum limit on the number of characters in a line. Loading history...
176		self::expectException('\TYPO3\CMS\Core\Locking\Exception\LockAcquireWouldBlockException') && $locker3->acquire($capabilities);
		0 ignored issues – show Coding Style introduced 2017-12-15 00:10 UTC by Report Bug Copy Issue Report This line exceeds maximum limit of 120 characters; contains 134 characters Overly long lines are hard to read on any screen. Most code styles therefor impose a maximum limit on the number of characters in a line. Loading history...
177
178		self::assertTrue($locker1->isAcquired());
179		self::assertFalse($locker2->isAcquired());
180		self::assertFalse($locker3->isAcquired());
181
182		self::assertTrue($locker1->release());
183
184		self::assertFalse($locker1->isAcquired());
185		self::assertFalse($locker2->isAcquired());
186		self::assertFalse($locker3->isAcquired());
187
188		self::assertTrue($locker2->acquire($capabilities));
189
190		self::assertFalse($locker1->isAcquired());
191		self::assertTrue($locker2->isAcquired());
192		self::assertFalse($locker3->isAcquired());
193
194		self::assertTrue($locker3->release());
195
196		self::assertFalse($locker1->isAcquired());
197		self::assertTrue($locker2->isAcquired());
198		self::assertFalse($locker3->isAcquired());
199
200		self::assertFalse($locker1->acquire($capabilities));
201
202		self::assertFalse($locker1->isAcquired());
203		self::assertTrue($locker2->isAcquired());
204		self::assertFalse($locker3->isAcquired());
205
206		self::assertTrue($locker2->release());
207
208		self::assertFalse($locker1->isAcquired());
209		self::assertFalse($locker2->isAcquired());
210		self::assertFalse($locker3->isAcquired());
211
212		self::assertTrue($locker3->acquire($capabilities));
213
214		self::assertFalse($locker1->isAcquired());
215		self::assertFalse($locker2->isAcquired());
216		self::assertTrue($locker3->isAcquired());
217		}
218
219		protected function setUp()
220		{
221		$this->testExtensionsToLoad[] = 'typo3conf/ext/redis_lock_strategy';
222		$this->redisHost = getenv('typo3RedisHost');
223		$this->redisDatabase = getenv('typo3RedisDatabase');
224
225		parent::setUp();
226
227		$this->lockFactory = GeneralUtility::makeInstance(LockFactory::class);
228		}
229
230		protected function tearDown()
231		{
232		parent::tearDown();
233
234		$this->getRedisClient()->flushDB();
235		}
236
237		/**
238		* @return \Redis
239		*/
240		private function getRedisClient()
241		{
242		$redis = new \Redis();
243		$redis->connect($this->redisHost);
244		$redis->select($this->redisDatabase);
245
246		return $redis;
247		}
248
249		/**
250		* @param string $id Locker id
251		*
252		* @return \TYPO3\CMS\Core\Locking\LockingStrategyInterface
253		*/
254	View Code Duplication	private function getLocker($id)
		0 ignored issues – show Duplication introduced 2017-12-18 12:02 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
255		{
256		$GLOBALS['TYPO3_CONF_VARS']['SYS']['redis_lock'] = [
257		'host' => $this->redisHost,
258		'database' => $this->redisDatabase,
259		];
260
261		return $this->lockFactory->createLocker($id);
262		}
263
264		}
265

tourstream / typo3-redis-lock-strategy

Pull Request — master (#8)

shouldThrowExceptionBecauseConfigIsMissing() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like