Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.
Common duplication problems, and corresponding solutions are:
| 1 | <?php |
||
| 18 | use PHPUnit\Framework\TestCase; |
||
| 19 | |||
| 20 | class SiteAccessServiceTest extends TestCase |
||
| 21 | { |
||
| 22 | private const EXISTING_SA_NAME = 'existing_sa'; |
||
| 23 | private const UNDEFINED_SA_NAME = 'undefined_sa'; |
||
| 24 | private const SA_GROUP = 'group'; |
||
| 25 | |||
| 26 | /** @var \eZ\Publish\Core\MVC\Symfony\SiteAccess\SiteAccessProviderInterface|\PHPUnit\Framework\MockObject\MockObject */ |
||
| 27 | private $provider; |
||
| 28 | |||
| 29 | /** @var \eZ\Publish\Core\MVC\ConfigResolverInterface|\PHPUnit\Framework\MockObject\MockObject */ |
||
| 30 | private $configResolver; |
||
| 31 | |||
| 32 | /** @var \eZ\Publish\Core\MVC\Symfony\SiteAccess */ |
||
| 33 | private $siteAccess; |
||
| 34 | |||
| 35 | /** @var \ArrayIterator */ |
||
| 36 | private $availableSiteAccesses; |
||
| 37 | |||
| 38 | /** @var array */ |
||
| 39 | private $configResolverParameters; |
||
| 40 | |||
| 41 | protected function setUp(): void |
||
| 42 | { |
||
| 43 | parent::setUp(); |
||
| 44 | $this->provider = $this->createMock(SiteAccessProviderInterface::class); |
||
| 45 | $this->configResolver = $this->createMock(ConfigResolverInterface::class); |
||
| 46 | $this->siteAccess = new SiteAccess('current'); |
||
| 47 | $this->availableSiteAccesses = $this->getAvailableSitAccesses(['current', 'first_sa', 'second_sa', 'default']); |
||
| 48 | $this->configResolverParameters = $this->getConfigResolverParameters(); |
||
| 49 | } |
||
| 50 | |||
| 51 | public function testGetCurrentSiteAccess(): void |
||
| 52 | { |
||
| 53 | $service = new SiteAccessService( |
||
| 54 | $this->createMock(SiteAccessProviderInterface::class), |
||
| 55 | $this->createMock(ConfigResolverInterface::class) |
||
| 56 | ); |
||
| 57 | |||
| 58 | self::assertNull($service->getCurrent()); |
||
| 59 | |||
| 60 | $siteAccess = new SiteAccess('default'); |
||
| 61 | $service->setSiteAccess($siteAccess); |
||
| 62 | self::assertSame($siteAccess, $service->getCurrent()); |
||
| 63 | |||
| 64 | $service->setSiteAccess(null); |
||
| 65 | self::assertNull($service->getCurrent()); |
||
| 66 | } |
||
| 67 | |||
| 68 | public function testGetSiteAccess(): void |
||
| 69 | { |
||
| 70 | $staticSiteAccessProvider = new StaticSiteAccessProvider( |
||
| 71 | [self::EXISTING_SA_NAME], |
||
| 72 | [self::EXISTING_SA_NAME => [self::SA_GROUP]], |
||
| 73 | ); |
||
|
|
|||
| 74 | $service = new SiteAccessService( |
||
| 75 | $staticSiteAccessProvider, |
||
| 76 | $this->createMock(ConfigResolverInterface::class) |
||
| 77 | ); |
||
| 78 | |||
| 79 | self::assertEquals( |
||
| 80 | self::EXISTING_SA_NAME, |
||
| 81 | $service->get(self::EXISTING_SA_NAME)->name |
||
| 82 | ); |
||
| 83 | } |
||
| 84 | |||
| 85 | public function testGetSiteAccessThrowsNotFoundException(): void |
||
| 86 | { |
||
| 87 | $staticSiteAccessProvider = new StaticSiteAccessProvider( |
||
| 88 | [self::EXISTING_SA_NAME], |
||
| 89 | [self::EXISTING_SA_NAME => [self::SA_GROUP]], |
||
| 90 | ); |
||
| 91 | $service = new SiteAccessService( |
||
| 92 | $staticSiteAccessProvider, |
||
| 93 | $this->createMock(ConfigResolverInterface::class) |
||
| 94 | ); |
||
| 95 | |||
| 96 | $this->expectException(NotFoundException::class); |
||
| 97 | $service->get(self::UNDEFINED_SA_NAME); |
||
| 98 | } |
||
| 99 | |||
| 100 | public function testGetCurrentSiteAccessesRelation(): void |
||
| 101 | { |
||
| 102 | $this->configResolver |
||
| 103 | ->method('getParameter') |
||
| 104 | ->willReturnMap($this->configResolverParameters); |
||
| 105 | |||
| 106 | $this->provider |
||
| 107 | ->method('getSiteAccesses') |
||
| 108 | ->willReturn($this->availableSiteAccesses); |
||
| 109 | |||
| 110 | $this->assertSame(['current', 'first_sa'], $this->getSiteAccessService()->getSiteAccessesRelation()); |
||
| 111 | } |
||
| 112 | |||
| 113 | public function testGetFirstSiteAccessesRelation(): void |
||
| 114 | { |
||
| 115 | $this->configResolver |
||
| 116 | ->method('getParameter') |
||
| 117 | ->willReturnMap($this->configResolverParameters); |
||
| 118 | |||
| 119 | $this->provider |
||
| 120 | ->method('getSiteAccesses') |
||
| 121 | ->willReturn($this->availableSiteAccesses); |
||
| 122 | |||
| 123 | $this->assertSame( |
||
| 124 | ['current', 'first_sa'], |
||
| 164 |