em = $this->prophesize(EntityManagerInterface::class); $this->domainService = new DomainService($this->em->reveal(), 'default.com', new NotFoundRedirectOptions()); } /** * @test * @dataProvider provideExcludedDomains */ public function listDomainsDelegatesIntoRepository(array $domains, array $expectedResult, ?ApiKey $apiKey): void { $repo = $this->prophesize(DomainRepositoryInterface::class); $getRepo = $this->em->getRepository(Domain::class)->willReturn($repo->reveal()); $findDomains = $repo->findDomainsWithout('default.com', $apiKey)->willReturn($domains); $result = $this->domainService->listDomains($apiKey); self::assertEquals($expectedResult, $result); $getRepo->shouldHaveBeenCalledOnce(); $findDomains->shouldHaveBeenCalledOnce(); } public function provideExcludedDomains(): iterable { $default = DomainItem::forDefaultDomain('default.com', new NotFoundRedirectOptions()); $adminApiKey = ApiKey::create(); $domainSpecificApiKey = ApiKey::fromMeta( ApiKeyMeta::withRoles(RoleDefinition::forDomain(Domain::withAuthority('')->setId('123'))), ); yield 'empty list without API key' => [[], [$default], null]; yield 'one item without API key' => [ [Domain::withAuthority('bar.com')], [$default, DomainItem::forExistingDomain(Domain::withAuthority('bar.com'))], null, ]; yield 'multiple items without API key' => [ [Domain::withAuthority('foo.com'), Domain::withAuthority('bar.com')], [ $default, DomainItem::forExistingDomain(Domain::withAuthority('foo.com')), DomainItem::forExistingDomain(Domain::withAuthority('bar.com')), ], null, ]; yield 'empty list with admin API key' => [[], [$default], $adminApiKey]; yield 'one item with admin API key' => [ [Domain::withAuthority('bar.com')], [$default, DomainItem::forExistingDomain(Domain::withAuthority('bar.com'))], $adminApiKey, ]; yield 'multiple items with admin API key' => [ [Domain::withAuthority('foo.com'), Domain::withAuthority('bar.com')], [ $default, DomainItem::forExistingDomain(Domain::withAuthority('foo.com')), DomainItem::forExistingDomain(Domain::withAuthority('bar.com')), ], $adminApiKey, ]; yield 'empty list with domain-specific API key' => [[], [], $domainSpecificApiKey]; yield 'one item with domain-specific API key' => [ [Domain::withAuthority('bar.com')], [DomainItem::forExistingDomain(Domain::withAuthority('bar.com'))], $domainSpecificApiKey, ]; yield 'multiple items with domain-specific API key' => [ [Domain::withAuthority('foo.com'), Domain::withAuthority('bar.com')], [ DomainItem::forExistingDomain(Domain::withAuthority('foo.com')), DomainItem::forExistingDomain(Domain::withAuthority('bar.com')), ], $domainSpecificApiKey, ]; } /** @test */ public function getDomainThrowsExceptionWhenDomainIsNotFound(): void { $find = $this->em->find(Domain::class, '123')->willReturn(null); $this->expectException(DomainNotFoundException::class); $find->shouldBeCalledOnce(); $this->domainService->getDomain('123'); } /** @test */ public function getDomainReturnsEntityWhenFound(): void { $domain = Domain::withAuthority(''); $find = $this->em->find(Domain::class, '123')->willReturn($domain); $result = $this->domainService->getDomain('123'); self::assertSame($domain, $result); $find->shouldHaveBeenCalledOnce(); } /** * @test * @dataProvider provideFoundDomains */ public function getOrCreateAlwaysPersistsDomain(?Domain $foundDomain, ?ApiKey $apiKey): void { $authority = 'example.com'; $repo = $this->prophesize(DomainRepositoryInterface::class); $repo->findOneByAuthority($authority, $apiKey)->willReturn($foundDomain); $getRepo = $this->em->getRepository(Domain::class)->willReturn($repo->reveal()); $persist = $this->em->persist($foundDomain ?? Argument::type(Domain::class)); $flush = $this->em->flush(); $result = $this->domainService->getOrCreate($authority, $apiKey); if ($foundDomain !== null) { self::assertSame($result, $foundDomain); } $getRepo->shouldHaveBeenCalledOnce(); $persist->shouldHaveBeenCalledOnce(); $flush->shouldHaveBeenCalledOnce(); } /** @test */ public function getOrCreateThrowsExceptionForApiKeysWithDomainRole(): void { $authority = 'example.com'; $domain = Domain::withAuthority($authority)->setId('1'); $apiKey = ApiKey::fromMeta(ApiKeyMeta::withRoles(RoleDefinition::forDomain($domain))); $repo = $this->prophesize(DomainRepositoryInterface::class); $repo->findOneByAuthority($authority, $apiKey)->willReturn(null); $getRepo = $this->em->getRepository(Domain::class)->willReturn($repo->reveal()); $this->expectException(DomainNotFoundException::class); $getRepo->shouldBeCalledOnce(); $this->em->persist(Argument::cetera())->shouldNotBeCalled(); $this->em->flush()->shouldNotBeCalled(); $this->domainService->getOrCreate($authority, $apiKey); } /** * @test * @dataProvider provideFoundDomains */ public function configureNotFoundRedirectsConfiguresFetchedDomain(?Domain $foundDomain, ?ApiKey $apiKey): void { $authority = 'example.com'; $repo = $this->prophesize(DomainRepositoryInterface::class); $repo->findOneByAuthority($authority, $apiKey)->willReturn($foundDomain); $getRepo = $this->em->getRepository(Domain::class)->willReturn($repo->reveal()); $persist = $this->em->persist($foundDomain ?? Argument::type(Domain::class)); $flush = $this->em->flush(); $result = $this->domainService->configureNotFoundRedirects($authority, NotFoundRedirects::withRedirects( 'foo.com', 'bar.com', 'baz.com', ), $apiKey); if ($foundDomain !== null) { self::assertSame($result, $foundDomain); } self::assertEquals('foo.com', $result->baseUrlRedirect()); self::assertEquals('bar.com', $result->regular404Redirect()); self::assertEquals('baz.com', $result->invalidShortUrlRedirect()); $getRepo->shouldHaveBeenCalledOnce(); $persist->shouldHaveBeenCalledOnce(); $flush->shouldHaveBeenCalledOnce(); } public function provideFoundDomains(): iterable { $domain = Domain::withAuthority(''); $adminApiKey = ApiKey::create(); $authorApiKey = ApiKey::fromMeta(ApiKeyMeta::withRoles(RoleDefinition::forAuthoredShortUrls())); yield 'domain not found and no API key' => [null, null]; yield 'domain found and no API key' => [$domain, null]; yield 'domain not found and admin API key' => [null, $adminApiKey]; yield 'domain found and admin API key' => [$domain, $adminApiKey]; yield 'domain not found and author API key' => [null, $authorApiKey]; yield 'domain found and author API key' => [$domain, $authorApiKey]; } /** @test */ public function anExceptionIsThrowsWhenTryingToEditRedirectsForDefaultDomain(): void { $this->expectException(InvalidDomainException::class); $this->expectExceptionMessage( 'You cannot configure default domain\'s redirects this way. Use the configuration or env vars.', ); $this->domainService->configureNotFoundRedirects('default.com', NotFoundRedirects::withoutRedirects()); } }