From 4cbb6590d28bb1918485c85fb1ade118a2211c34 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bartosz=20Wojda=C5=82owicz?= Date: Mon, 19 Feb 2024 08:25:43 +0100 Subject: [PATCH 1/2] OP-237 - write phpspec tests --- spec/ApiClient/SuluApiClientSpec.php | 68 ++++++++++++++ .../Action/PurgeSuluCacheActionSpec.php | 62 +++++++++++++ .../Action/RenderPageActionSpec.php | 84 +++++++++++++++++ .../Block/SuluBlockRendererStrategySpec.php | 63 +++++++++++++ .../Page/SuluPageRendererStrategySpec.php | 64 +++++++++++++ spec/Twig/Runtime/SuluRuntimeSpec.php | 90 +++++++++++++++++++ src/ApiClient/SuluApiClient.php | 2 +- src/ApiClient/SuluApiClientInterface.php | 10 +++ src/Controller/Action/RenderPageAction.php | 10 +-- src/Entity/ChannelInterface.php | 4 +- .../Block/SuluBlockRendererStrategy.php | 2 +- .../SuluBlockRendererStrategyInterface.php | 10 +++ .../Page/SuluPageRendererStrategy.php | 2 +- .../SuluPageRendererStrategyInterface.php | 10 +++ src/Twig/Runtime/SuluRuntime.php | 12 +-- 15 files changed, 478 insertions(+), 15 deletions(-) create mode 100644 spec/ApiClient/SuluApiClientSpec.php create mode 100644 spec/Controller/Action/PurgeSuluCacheActionSpec.php create mode 100644 spec/Controller/Action/RenderPageActionSpec.php create mode 100644 spec/Renderer/Block/SuluBlockRendererStrategySpec.php create mode 100644 spec/Renderer/Page/SuluPageRendererStrategySpec.php create mode 100644 spec/Twig/Runtime/SuluRuntimeSpec.php create mode 100644 src/ApiClient/SuluApiClientInterface.php create mode 100644 src/Renderer/Block/SuluBlockRendererStrategyInterface.php create mode 100644 src/Renderer/Page/SuluPageRendererStrategyInterface.php diff --git a/spec/ApiClient/SuluApiClientSpec.php b/spec/ApiClient/SuluApiClientSpec.php new file mode 100644 index 0000000..96d6f07 --- /dev/null +++ b/spec/ApiClient/SuluApiClientSpec.php @@ -0,0 +1,68 @@ +beConstructedWith($client, $shopperContext, $suluBaseUri, $cacheDir); + } + + public function it_is_initializable(): void + { + $this->shouldHaveType(SuluApiClient::class); + } + + public function it_implements_sulu_api_client_interface_interface(): void + { + $this->shouldHaveType(SuluApiClientInterface::class); + } + +// function it_fetches_cms_content( +// HttpClientInterface $client, +// ShopperContextInterface $shopperContext, +// ChannelInterface $channel, +// ) { +// $url = '/cms/content'; +// $locale = 'en_US'; +// +// $shopperContext->getChannel()->willReturn($channel); +// $shopperContext->getLocaleCode()->willReturn($locale); +// $channel->isSuluUseLocalizedUrls()->willReturn(true); +// +// $client->request('GET', 'http://example.com/en_US/cms/content.json', ['headers' => ['Accept' => 'application/json']])->shouldBeCalled(); +// +// $this->fetchCmsContent($url); +// } +// +// function it_fetches_cms_content_with_global_channel( +// HttpClientInterface $client, +// ShopperContextInterface $shopperContext, +// ChannelInterface $channel, +// ) { +// $url = '/cms/content'; +// +// $shopperContext->getChannel()->willReturn($channel); +// $shopperContext->getLocaleCode()->willReturn(null); +// $channel->isSuluUseLocalizedUrls()->willReturn(false); +// +// +// $client->request('GET', 'http://example.com/cms/content.json', ['headers' => ['Accept' => 'application/json']])->shouldBeCalled(); +// +// $this->fetchCmsContent($url); +// } +} diff --git a/spec/Controller/Action/PurgeSuluCacheActionSpec.php b/spec/Controller/Action/PurgeSuluCacheActionSpec.php new file mode 100644 index 0000000..465c477 --- /dev/null +++ b/spec/Controller/Action/PurgeSuluCacheActionSpec.php @@ -0,0 +1,62 @@ +beConstructedWith($channelRepository, $requestStack, $translator, $cacheDir); + } + + function it_is_initializable() + { + $this->shouldHaveType(PurgeSuluCacheAction::class); + } + + function it_returns_response( + ChannelRepositoryInterface $channelRepository, + ChannelInterface $channel, + RequestStack $requestStack, + Request $request, + ServerBag $serverBag, + Session $session, + FlashBagInterface $flashbag, + ) { + $channelId = 1; + $localeCode = 'en_US'; + $referer = 'http://example.com'; + + $request->get('id')->willReturn($channelId); + $request->get('locale')->willReturn($localeCode); + $request->server = $serverBag; + $serverBag->get('HTTP_REFERER')->willReturn($referer); + $session->getFlashBag()->willReturn($flashbag); + + $channel->getCode()->willReturn('TEST'); + $channelRepository->find($channelId)->willReturn($channel); + + $requestStack->getSession()->willReturn($session); + + $this->__invoke($request)->shouldBeAnInstanceOf(RedirectResponse::class); + } +} diff --git a/spec/Controller/Action/RenderPageActionSpec.php b/spec/Controller/Action/RenderPageActionSpec.php new file mode 100644 index 0000000..abadab0 --- /dev/null +++ b/spec/Controller/Action/RenderPageActionSpec.php @@ -0,0 +1,84 @@ +beConstructedWith($suluApiClient, $pageRendererStrategy); + } + + function it_is_initializable() + { + $this->shouldHaveType(RenderPageAction::class); + } + + function it_returns_response_for_valid_url( + SuluApiClientInterface $suluApiClient, + SuluPageRendererStrategyInterface $pageRendererStrategy, + Request $request, + ) { + $url = 'example-page'; + $pageContent = '

Example Page

'; + + $request->get('slug')->willReturn($url); + $request->get('second_slug')->willReturn(null); + + $suluApiClient->fetchCmsContent($url)->willReturn(['content' => $pageContent]); + $pageRendererStrategy->renderPage(['content' => $pageContent])->willReturn($pageContent); + + $this->__invoke($request)->shouldBeAnInstanceOf(Response::class); + $this->__invoke($request)->getContent()->shouldReturn($pageContent); + } + + function it_returns_response_for_valid_url_with_second_slug( + SuluApiClientInterface $suluApiClient, + SuluPageRendererStrategyInterface $pageRendererStrategy, + Request $request, + ) { + $url = 'example-page'; + $secondSlug = 'second-slug'; + $fullUrl = "{$url}/{$secondSlug}"; + $pageContent = '

Example Page

'; + + $request->get('slug')->willReturn($url); + $request->get('second_slug')->willReturn($secondSlug); + + $suluApiClient->fetchCmsContent($fullUrl)->willReturn(['content' => $pageContent]); + $pageRendererStrategy->renderPage(['content' => $pageContent])->willReturn($pageContent); + + $this->__invoke($request)->shouldBeAnInstanceOf(Response::class); + $this->__invoke($request)->getContent()->shouldReturn($pageContent); + } + + function it_returns_404_response_for_unknown_url( + SuluApiClientInterface $suluApiClient, + Request $request, + SuluPageRendererStrategyInterface $pageRendererStrategy, + ) { + $url = 'non-existing-page'; + + $request->get('slug')->willReturn($url); + $request->get('second_slug')->willReturn(null); + + $suluApiClient->fetchCmsContent($url)->willReturn([]); + $pageRendererStrategy->renderPage([])->willReturn(''); + + $response = $this->__invoke($request); + $response->shouldBeAnInstanceOf(Response::class); + $response->getStatusCode()->shouldReturn(404); + } +} diff --git a/spec/Renderer/Block/SuluBlockRendererStrategySpec.php b/spec/Renderer/Block/SuluBlockRendererStrategySpec.php new file mode 100644 index 0000000..9bf9480 --- /dev/null +++ b/spec/Renderer/Block/SuluBlockRendererStrategySpec.php @@ -0,0 +1,63 @@ +beConstructedWith([$blockRenderer1, $blockRenderer2]); + } + + function it_is_initializable() + { + $this->shouldHaveType(SuluBlockRendererStrategy::class); + } + + function it_throws_runtime_error_if_no_renderer_is_found( + SuluBlockRenderStrategyInterface $blockRenderer1, + SuluBlockRenderStrategyInterface $blockRenderer2, + ) { + $blockData = ['type' => 'non-existing-type']; + + $blockRenderer1->support($blockData)->willReturn(false); + $blockRenderer2->support($blockData)->willReturn(false); + + $this->shouldThrow(RuntimeError::class)->during('renderBlock', [$blockData]); + } + + function it_returns_rendered_block_content( + SuluBlockRenderStrategyInterface $blockRenderer1, + SuluBlockRenderStrategyInterface $blockRenderer2, + ) { + $blockData = ['type' => 'existing-type', 'data' => []]; + $renderedContent = '
Rendered content
'; + + $blockRenderer1->support($blockData)->willReturn(false); + $blockRenderer2->support($blockData)->willReturn(true); + $blockRenderer2->render($blockData)->willReturn($renderedContent); + + $this->renderBlock($blockData)->shouldReturn($renderedContent); + } + + function it_returns_empty_string_on_render_error( + SuluBlockRenderStrategyInterface $blockRenderer1, + SuluBlockRenderStrategyInterface $blockRenderer2, + ) { + $blockData = ['type' => 'existing-type', 'data' => []]; + + $blockRenderer1->support($blockData)->willReturn(false); + $blockRenderer2->support($blockData)->willReturn(true); + $blockRenderer2->render($blockData)->willThrow(Error::class); + + $this->renderBlock($blockData)->shouldReturn(''); + } +} diff --git a/spec/Renderer/Page/SuluPageRendererStrategySpec.php b/spec/Renderer/Page/SuluPageRendererStrategySpec.php new file mode 100644 index 0000000..5442595 --- /dev/null +++ b/spec/Renderer/Page/SuluPageRendererStrategySpec.php @@ -0,0 +1,64 @@ +beConstructedWith([$pageRenderer1, $pageRenderer2]); + } + + function it_is_initializable() + { + $this->shouldHaveType(SuluPageRendererStrategy::class); + } + + function it_throws_runtime_error_if_no_renderer_is_found( + SuluPageRenderStrategyInterface $pageRenderer1, + SuluPageRenderStrategyInterface $pageRenderer2, + ) { + $page = ['template' => 'non-existing-template']; + + $pageRenderer1->support($page)->willReturn(false); + $pageRenderer2->support($page)->willReturn(false); + + $this->shouldThrow(\Twig\Error\RuntimeError::class)->during('renderPage', [$page]); + } + + function it_returns_rendered_page_content( + SuluPageRenderStrategyInterface $pageRenderer1, + SuluPageRenderStrategyInterface $pageRenderer2, + ) { + $page = ['template' => 'existing-template', 'data' => []]; + $renderedContent = '

Rendered Page

'; + + $pageRenderer1->support($page)->willReturn(false); + $pageRenderer2->support($page)->willReturn(true); + $pageRenderer2->render($page)->willReturn($renderedContent); + + $this->renderPage($page)->shouldReturn($renderedContent); + } + + function it_returns_empty_string_on_render_error( + SuluPageRenderStrategyInterface $pageRenderer1, + SuluPageRenderStrategyInterface $pageRenderer2, + ) { + $page = ['template' => 'existing-template', 'data' => []]; + + $pageRenderer1->support($page)->willReturn(false); + $pageRenderer2->support($page)->willReturn(true); + $pageRenderer2->render($page)->willThrow(Error::class); + + $this->renderPage($page)->shouldReturn(''); + } +} diff --git a/spec/Twig/Runtime/SuluRuntimeSpec.php b/spec/Twig/Runtime/SuluRuntimeSpec.php new file mode 100644 index 0000000..41247a0 --- /dev/null +++ b/spec/Twig/Runtime/SuluRuntimeSpec.php @@ -0,0 +1,90 @@ +beConstructedWith($suluApiClient, $blockRendererStrategy, $pageRendererStrategy); + } + + function it_is_initializable() + { + $this->shouldHaveType(SuluRuntime::class); + } + + function it_fetches_sulu_page_from_api_client(SuluApiClientInterface $suluApiClient) + { + $id = 'example-page-id'; + $page = ['id' => $id, 'title' => 'Example Page']; + + $suluApiClient->fetchCmsContent($id)->willReturn($page); + + $this->getSuluPage($id)->shouldReturn($page); + } + + function it_renders_sulu_page_using_page_renderer_strategy( + SuluApiClientInterface $suluApiClient, + SuluPageRendererStrategyInterface $pageRendererStrategy, + ) { + $id = 'example-page-id'; + $page = ['id' => $id, 'title' => 'Example Page']; + $renderedPage = '

Example Page

'; + + $suluApiClient->fetchCmsContent($id)->willReturn($page); + $pageRendererStrategy->renderPage($page)->willReturn($renderedPage); + + $this->renderSuluPage($id)->shouldReturn($renderedPage); + } + + function it_renders_sulu_blocks_using_block_renderer_strategy( + SuluBlockRendererStrategyInterface $blockRendererStrategy, + ) { + $blocks = [['type' => 'block-type-1'], ['type' => 'block-type-2']]; + $renderedBlocks = '
Block 1
Block 2
'; + $divider = '
'; + + $blockRendererStrategy->renderBlock($blocks[0])->willReturn('
Block 1
'); + $blockRendererStrategy->renderBlock($blocks[1])->willReturn('
Block 2
'); + + $this->renderSuluBlocks($blocks, $divider)->shouldReturn($renderedBlocks); + } + + function it_renders_sulu_blocks_with_specified_type_using_block_renderer_strategy( + SuluBlockRendererStrategyInterface $blockRendererStrategy, + ) { + $blocks = [['type' => 'block-type-1'], ['type' => 'block-type-2'], ['type' => 'block-type-1']]; + $filteredBlocks = [['type' => 'block-type-1'], ['type' => 'block-type-1']]; + $renderedBlocks = '
Block 1
Block 1
'; + $divider = '
'; + + $blockRendererStrategy->renderBlock($filteredBlocks[0])->willReturn('
Block 1
'); + $blockRendererStrategy->renderBlock($filteredBlocks[1])->willReturn('
Block 1
'); + + $this->renderSuluBlocksWithType($blocks, 'block-type-1', $divider)->shouldReturn($renderedBlocks); + } + + function it_renders_first_sulu_block_with_specified_type_using_block_renderer_strategy( + SuluBlockRendererStrategyInterface $blockRendererStrategy, + ) { + $blocks = [['type' => 'block-type-1', 'content' => 'Block 1 content'], ['type' => 'block-type-2']]; + $filteredBlocks = [['type' => 'block-type-1', 'content' => 'Block 1 content']]; + $renderedBlock = '
Block 1
'; + + $blockRendererStrategy->renderBlock($filteredBlocks[0])->willReturn('
Block 1
'); + + $this->renderSuluBlockWithType($blocks, 'block-type-1')->shouldReturn($renderedBlock); + } +} diff --git a/src/ApiClient/SuluApiClient.php b/src/ApiClient/SuluApiClient.php index d98694d..e345cdf 100644 --- a/src/ApiClient/SuluApiClient.php +++ b/src/ApiClient/SuluApiClient.php @@ -12,7 +12,7 @@ use Symfony\Contracts\HttpClient\ResponseInterface; use Webmozart\Assert\Assert; -final class SuluApiClient +final class SuluApiClient implements SuluApiClientInterface { public function __construct( private HttpClientInterface $client, diff --git a/src/ApiClient/SuluApiClientInterface.php b/src/ApiClient/SuluApiClientInterface.php new file mode 100644 index 0000000..2a8553e --- /dev/null +++ b/src/ApiClient/SuluApiClientInterface.php @@ -0,0 +1,10 @@ +pageRendererStrategy->renderPage($page); if (strlen($page) === 0) { - return new Response(null, 404); + return new Response('', 404); } return new Response($page); diff --git a/src/Entity/ChannelInterface.php b/src/Entity/ChannelInterface.php index 7a5e04f..135c82d 100644 --- a/src/Entity/ChannelInterface.php +++ b/src/Entity/ChannelInterface.php @@ -4,7 +4,9 @@ namespace BitBag\SyliusSuluPlugin\Entity; -interface ChannelInterface +use Sylius\Component\Core\Model\ChannelInterface as BaseChannelInterface; + +interface ChannelInterface extends BaseChannelInterface { public function isSuluUseLocalizedUrls(): bool; diff --git a/src/Renderer/Block/SuluBlockRendererStrategy.php b/src/Renderer/Block/SuluBlockRendererStrategy.php index 79ab6ae..421fa40 100644 --- a/src/Renderer/Block/SuluBlockRendererStrategy.php +++ b/src/Renderer/Block/SuluBlockRendererStrategy.php @@ -7,7 +7,7 @@ use Twig\Error\Error; use Twig\Error\RuntimeError; -final class SuluBlockRendererStrategy +final class SuluBlockRendererStrategy implements SuluBlockRendererStrategyInterface { public function __construct( private iterable $blockRenderers, diff --git a/src/Renderer/Block/SuluBlockRendererStrategyInterface.php b/src/Renderer/Block/SuluBlockRendererStrategyInterface.php new file mode 100644 index 0000000..80940e3 --- /dev/null +++ b/src/Renderer/Block/SuluBlockRendererStrategyInterface.php @@ -0,0 +1,10 @@ + Date: Fri, 23 Feb 2024 08:31:18 +0100 Subject: [PATCH 2/2] OP-237 - write behat tests, mock api responses, create examples of renderers --- composer.json | 2 +- features/caching_sulu_request.feature | 50 +++++ features/render_sulu_page.feature | 27 +++ .../show_featured_pages_on_homepage.feature | 20 ++ src/Entity/SuluChannelConfigurationTrait.php | 10 + src/Twig/Extension/SuluPageExtension.php | 1 + src/Twig/Runtime/SuluRuntime.php | 19 +- src/Twig/Runtime/SuluRuntimeInterface.php | 2 + .../Grid/Action/invalidateSuluCache.html.twig | 2 +- tests/Application/.env | 4 + tests/Application/config/bundles.php | 2 + .../config/doctrine/Channel.Channel.orm.xml | 12 ++ .../Application/config/packages/_sylius.yaml | 32 +++ .../Application/config/packages/doctrine.yaml | 11 ++ .../config/packages/framework.yaml | 5 + .../config/routes/sylius_admin.yaml | 12 ++ .../config/routes/sylius_shop.yaml | 16 ++ tests/Application/config/services.yaml | 2 + tests/Application/config/services_test.yaml | 30 +++ .../src/Entity/Channel/Channel.php | 13 ++ .../src/Renderer/Block/ImageRenderer.php | 47 +++++ .../src/Renderer/Block/QuoteRenderer.php | 47 +++++ .../src/Renderer/Block/TextRenderer.php | 48 +++++ .../src/Renderer/Page/BlogPageRenderer.php | 46 +++++ .../Renderer/Page/FeaturedPagesRenderer.php | 49 +++++ .../shop/block/image.html.twig | 1 + .../shop/block/quote.html.twig | 1 + .../shop/block/text.html.twig | 1 + .../shop/page/blog.html.twig | 48 +++++ .../shop/page/featuredPages.html.twig | 16 ++ .../Homepage/_featuredPages.html.twig | 7 + .../blog_page_with_blocks_and_links.json | 183 ++++++++++++++++++ .../blog_page_with_properties.json | 62 ++++++ .../Behat/ApiResponseMock/featured_pages.json | 141 ++++++++++++++ tests/Behat/Context/Setup/SuluPageContext.php | 119 ++++++++++++ .../Context/Ui/SuluAdminPanelContext.php | 108 +++++++++++ tests/Behat/Context/Ui/SuluPageContext.php | 89 +++++++++ tests/Behat/Page/ChannelIndexPage.php | 21 ++ tests/Behat/Page/HomePage.php | 18 ++ tests/Behat/Page/SuluPage.php | 37 ++++ tests/Behat/Resources/services.xml | 63 ++++++ tests/Behat/Resources/suites.yml | 4 + .../Resources/suites/ui/cache_sulu_page.yml | 22 +++ .../Resources/suites/ui/render_sulu_page.yml | 19 ++ tests/Behat/Resources/suites/ui/sulu_page.yml | 19 ++ tests/Behat/Services/SuluApiClient.php | 100 ++++++++++ 46 files changed, 1585 insertions(+), 3 deletions(-) create mode 100644 features/caching_sulu_request.feature create mode 100644 features/render_sulu_page.feature create mode 100644 features/show_featured_pages_on_homepage.feature create mode 100644 tests/Application/config/doctrine/Channel.Channel.orm.xml create mode 100644 tests/Application/src/Entity/Channel/Channel.php create mode 100644 tests/Application/src/Renderer/Block/ImageRenderer.php create mode 100644 tests/Application/src/Renderer/Block/QuoteRenderer.php create mode 100644 tests/Application/src/Renderer/Block/TextRenderer.php create mode 100644 tests/Application/src/Renderer/Page/BlogPageRenderer.php create mode 100644 tests/Application/src/Renderer/Page/FeaturedPagesRenderer.php create mode 100644 tests/Application/templates/bundles/BitBagSyliusSuluPlugin/shop/block/image.html.twig create mode 100644 tests/Application/templates/bundles/BitBagSyliusSuluPlugin/shop/block/quote.html.twig create mode 100644 tests/Application/templates/bundles/BitBagSyliusSuluPlugin/shop/block/text.html.twig create mode 100644 tests/Application/templates/bundles/BitBagSyliusSuluPlugin/shop/page/blog.html.twig create mode 100644 tests/Application/templates/bundles/BitBagSyliusSuluPlugin/shop/page/featuredPages.html.twig create mode 100644 tests/Application/templates/bundles/SyliusShopBundle/Homepage/_featuredPages.html.twig create mode 100644 tests/Behat/ApiResponseMock/blog_page_with_blocks_and_links.json create mode 100644 tests/Behat/ApiResponseMock/blog_page_with_properties.json create mode 100644 tests/Behat/ApiResponseMock/featured_pages.json create mode 100644 tests/Behat/Context/Setup/SuluPageContext.php create mode 100644 tests/Behat/Context/Ui/SuluAdminPanelContext.php create mode 100644 tests/Behat/Context/Ui/SuluPageContext.php create mode 100644 tests/Behat/Page/ChannelIndexPage.php create mode 100644 tests/Behat/Page/HomePage.php create mode 100644 tests/Behat/Page/SuluPage.php create mode 100644 tests/Behat/Resources/suites.yml create mode 100644 tests/Behat/Resources/suites/ui/cache_sulu_page.yml create mode 100644 tests/Behat/Resources/suites/ui/render_sulu_page.yml create mode 100644 tests/Behat/Resources/suites/ui/sulu_page.yml create mode 100644 tests/Behat/Services/SuluApiClient.php diff --git a/composer.json b/composer.json index 7c83bb2..111e7a1 100644 --- a/composer.json +++ b/composer.json @@ -17,7 +17,7 @@ }, "require-dev": { "behat/behat": "^3.6.1", - "behat/mink-selenium2-driver": "^1.4", + "behat/mink-selenium2-driver": "~1.6.0", "bitbag/coding-standard": "^3.0", "dmore/behat-chrome-extension": "^1.3", "dmore/chrome-mink-driver": "^2.7", diff --git a/features/caching_sulu_request.feature b/features/caching_sulu_request.feature new file mode 100644 index 0000000..4cc118d --- /dev/null +++ b/features/caching_sulu_request.feature @@ -0,0 +1,50 @@ +@sulu_cache +Feature: Caching sulu page request + In order to see again some page + As a Visitor + I want to be able to see the page without sending request to sulu + + Background: + Given the store operates on a single channel in "United States" + And Sulu has defined page "blog_page_with_blocks_and_links" in locale "en_US" + And Cache for sulu not exists + + + @ui + Scenario: See the featured pages on homepage + When I visit this channel's homepage + And "United States" has enabled sulu localized requests + Then Sulu cache should not exists + And I visit a sulu page "blog_page_with_blocks_and_links" in locale en_US + And Sulu cache should exists for "United States" with locale en_US + + @ui + Scenario: Manually clear cache when localized urls are disabled + When I visit a sulu page "blog_page_with_blocks_and_links" in locale en_US + Then Sulu cache should exists + And I am logged in as an administrator + And I browse channels + And I should see button "Purge sulu cache" in "United States" + And I click "Clear Cache" button in "United States" + And I should see success "Successfully purged" flash message + And Sulu cache should exists for "United States" with locale en_US + + @ui + Scenario: Manually clear cache when localized urls are enabled + When "United States" has enabled sulu localized requests + And I visit a sulu page "blog_page_with_blocks_and_links" in locale en_US + Then Sulu cache should exists + And I am logged in as an administrator + And I browse channels + And I should see expanded button "Purge sulu cache" in "United States" + And I click expanded "en_US" button in "United States" + And I should see success "Successfully purged" flash message + And Sulu cache should exists for "United States" with locale en_US + + @ui + Scenario: Manually clear cache when localized urls are disabled and cache not exists + When I am logged in as an administrator + And I browse channels + Then I should see button "Purge sulu cache" in "United States" + And I click "Purge sulu cache" button in "United States" + And I should see error "Dir with sulu cache not found" flash message diff --git a/features/render_sulu_page.feature b/features/render_sulu_page.feature new file mode 100644 index 0000000..b617487 --- /dev/null +++ b/features/render_sulu_page.feature @@ -0,0 +1,27 @@ +@render_sulu_page +Feature: Render sulu page + In order to see a sulu page + As a Visitor + I want to be able to see rendered sulu page + + Background: + Given the store operates on a single channel in "United States" + And Sulu has defined page "blog_page_with_properties" in locale "en_US" + And Sulu has defined page "blog_page_with_blocks_and_links" in locale "en_US" + And Page "blog_page_with_blocks_and_links" has block "quote" + And Page "blog_page_with_blocks_and_links" has block "text" + And Page "blog_page_with_blocks_and_links" has block "image" + + @ui + Scenario: Rendering a sulu page with properties + When I visit a sulu page "blog_page_with_properties" in locale en_US + Then I should see a "title" with value "E-commerce trends" + And I should see a "content" with value "CONTENT" + + @ui + Scenario: Rendering a sulu page with properties and blocks + When I visit a sulu page "blog_page_with_blocks_and_links" in locale en_US + Then I should see a "title" with value "E-commerce trends" + And I should see a block "content" with value "2021 was followed by the time of the 2020 pandemic. During these two years, a lot has changed..." + And I should see a block image with url "https://en.wikipedia.org/wiki/Cat#/media/File:Sheba1.JPG" + And I should see a block "quote" with value "Lorem ipsum dolor sit amet, con" diff --git a/features/show_featured_pages_on_homepage.feature b/features/show_featured_pages_on_homepage.feature new file mode 100644 index 0000000..daa2964 --- /dev/null +++ b/features/show_featured_pages_on_homepage.feature @@ -0,0 +1,20 @@ +@sulu_page +Feature: Show featured pages on homepage + In order to see featured pages on homepage + As a Visitor + I want to be able to see featured pages on homepage + + Background: + Given the store operates on a single channel in "United States" + And Sulu has defined featured pages list featured_pages in locale en_US + And One of the featured page is page "Blog Page 1" + And One of the featured page is page "Blog Page 2" + And One of the featured page is page "Blog Page 3" + + @ui + Scenario: See the featured pages on homepage + When I visit this channel's homepage + Then I should see 3 featured pages. + And I should see featured page "Blog Page 1" + And I should see featured page "Blog Page 2" + And I should see featured page "Blog Page 3" diff --git a/src/Entity/SuluChannelConfigurationTrait.php b/src/Entity/SuluChannelConfigurationTrait.php index 2143228..583e729 100644 --- a/src/Entity/SuluChannelConfigurationTrait.php +++ b/src/Entity/SuluChannelConfigurationTrait.php @@ -4,8 +4,18 @@ namespace BitBag\SyliusSuluPlugin\Entity; +use Doctrine\ORM\Mapping as ORM; + +/** + * @ORM\Entity + * + * @ORM\Table(name="sylius_channel") + */ +#[ORM\Entity] +#[ORM\Table(name: 'sylius_channel')] trait SuluChannelConfigurationTrait { + /** @ORM\Column(type="boolean", nullable=false) */ protected bool $suluUseLocalizedUrls = false; public function isSuluUseLocalizedUrls(): bool diff --git a/src/Twig/Extension/SuluPageExtension.php b/src/Twig/Extension/SuluPageExtension.php index 064137c..6d927ee 100644 --- a/src/Twig/Extension/SuluPageExtension.php +++ b/src/Twig/Extension/SuluPageExtension.php @@ -23,6 +23,7 @@ public function getFunctions(): array new TwigFunction('bitbag_render_sulu_blocks', [$this->suluRuntime, 'renderSuluBlocks']), new TwigFunction('bitbag_render_sulu_blocks_with_type', [$this->suluRuntime, 'renderSuluBlocksWithType']), new TwigFunction('bitbag_render_sulu_block_with_type', [$this->suluRuntime, 'renderSuluBlockWithType']), + new TwigFunction('bitbag_page_has_sulu_block', [$this->suluRuntime, 'hasSuluBlock']), ]; } } diff --git a/src/Twig/Runtime/SuluRuntime.php b/src/Twig/Runtime/SuluRuntime.php index c8e7104..f31e6ea 100644 --- a/src/Twig/Runtime/SuluRuntime.php +++ b/src/Twig/Runtime/SuluRuntime.php @@ -59,10 +59,10 @@ public function renderSuluBlocksWithType(array $blocks, string $type, ?string $d public function renderSuluBlockWithType(array $blocks, string $type): string { $blocks = array_filter($blocks, fn (array $block) => $block['type'] === $type); - if (count($blocks) > 1) { $blocks = $blocks[0]; } + $content = ''; foreach ($blocks as $block) { @@ -71,4 +71,21 @@ public function renderSuluBlockWithType(array $blocks, string $type): string return $content; } + + public function hasSuluBlock(array $page, string $type): bool + { + if (!array_key_exists('blocks', $page)) { + return false; + } + + $blocks = $page['blocks']; + + if (count($blocks) === 0) { + return false; + } + + $blocks = array_filter($blocks, fn (array $block) => $block['type'] === $type); + + return count($blocks) !== 0; + } } diff --git a/src/Twig/Runtime/SuluRuntimeInterface.php b/src/Twig/Runtime/SuluRuntimeInterface.php index 643f1ec..f1c7753 100644 --- a/src/Twig/Runtime/SuluRuntimeInterface.php +++ b/src/Twig/Runtime/SuluRuntimeInterface.php @@ -17,4 +17,6 @@ public function renderSuluBlocks(array $blocks): string; public function renderSuluBlocksWithType(array $blocks, string $type): string; public function renderSuluBlockWithType(array $blocks, string $type): string; + + public function hasSuluBlock(array $page, string $type): bool; } diff --git a/templates/Admin/Grid/Action/invalidateSuluCache.html.twig b/templates/Admin/Grid/Action/invalidateSuluCache.html.twig index 2523db1..24be26c 100644 --- a/templates/Admin/Grid/Action/invalidateSuluCache.html.twig +++ b/templates/Admin/Grid/Action/invalidateSuluCache.html.twig @@ -1,5 +1,5 @@ {% if true == data.isSuluUseLocalizedUrls %} -
+
{{ action.label|trans }}
diff --git a/tests/Application/.env b/tests/Application/.env index 3288c4e..7911b02 100644 --- a/tests/Application/.env +++ b/tests/Application/.env @@ -31,3 +31,7 @@ SYLIUS_MESSENGER_TRANSPORT_MAIN_FAILED_DSN=doctrine://default?queue_name=main_fa SYLIUS_MESSENGER_TRANSPORT_CATALOG_PROMOTION_REMOVAL_DSN=doctrine://default?queue_name=catalog_promotion_removal SYLIUS_MESSENGER_TRANSPORT_CATALOG_PROMOTION_REMOVAL_FAILED_DSN=doctrine://default?queue_name=catalog_promotion_removal_failed ###< symfony/messenger ### + +###< sulu ### +SULU_BASE_URI=https://127.0.0.1:8001/ +###< sulu ### diff --git a/tests/Application/config/bundles.php b/tests/Application/config/bundles.php index 386dfdb..a90ed42 100644 --- a/tests/Application/config/bundles.php +++ b/tests/Application/config/bundles.php @@ -1,5 +1,7 @@ ['all' => true], Symfony\Bundle\MonologBundle\MonologBundle::class => ['all' => true], diff --git a/tests/Application/config/doctrine/Channel.Channel.orm.xml b/tests/Application/config/doctrine/Channel.Channel.orm.xml new file mode 100644 index 0000000..a9c218f --- /dev/null +++ b/tests/Application/config/doctrine/Channel.Channel.orm.xml @@ -0,0 +1,12 @@ + + + + + + + diff --git a/tests/Application/config/packages/_sylius.yaml b/tests/Application/config/packages/_sylius.yaml index 18acdd4..5611fd4 100644 --- a/tests/Application/config/packages/_sylius.yaml +++ b/tests/Application/config/packages/_sylius.yaml @@ -16,3 +16,35 @@ sylius_shop: sylius_api: enabled: true + +sylius_channel: + resources: + channel: + classes: + model: Tests\BitBag\SyliusSuluPlugin\Application\src\Entity\Channel\Channel + + +sylius_ui: + events: + sylius.shop.homepage: + blocks: + featured_pages: + template: "@SyliusShop/Homepage/_featuredPages.html.twig" + priority: 20 +sylius_grid: + grids: + sylius_admin_channel: + actions: + item: + invalidate_sulu_cache: + type: invalidate_sulu_cache + label: bitbag.sulu_plugin.purge_channel_cache + icon: sync + options: + link: + route: bitbag_purge_sulu_cache_for_channel + parameters: + id: resource.id + templates: + action: + invalidate_sulu_cache: "@BitBagSyliusSuluPlugin/Admin/Grid/Action/invalidateSuluCache.html.twig" diff --git a/tests/Application/config/packages/doctrine.yaml b/tests/Application/config/packages/doctrine.yaml index f51ba5a..c56eb14 100644 --- a/tests/Application/config/packages/doctrine.yaml +++ b/tests/Application/config/packages/doctrine.yaml @@ -12,3 +12,14 @@ doctrine: charset: UTF8 url: '%env(resolve:DATABASE_URL)%' + + orm: + auto_generate_proxy_classes: '%kernel.debug%' + naming_strategy: doctrine.orm.naming_strategy.underscore + auto_mapping: true + mappings: + App: + is_bundle: false + type: xml + dir: '%kernel.project_dir%/config/doctrine' + prefix: 'Tests\BitBag\SyliusSuluPlugin\Application\src\Entity' diff --git a/tests/Application/config/packages/framework.yaml b/tests/Application/config/packages/framework.yaml index 8be076b..3021cd2 100644 --- a/tests/Application/config/packages/framework.yaml +++ b/tests/Application/config/packages/framework.yaml @@ -7,3 +7,8 @@ framework: serializer: mapping: paths: [ '%kernel.project_dir%/config/serialization' ] + cache: + pools: + sulu: + adapter: cache.adapter.filesystem + default_lifetime: 3600 diff --git a/tests/Application/config/routes/sylius_admin.yaml b/tests/Application/config/routes/sylius_admin.yaml index 1ba48d6..6018403 100644 --- a/tests/Application/config/routes/sylius_admin.yaml +++ b/tests/Application/config/routes/sylius_admin.yaml @@ -1,3 +1,15 @@ sylius_admin: resource: "@SyliusAdminBundle/Resources/config/routing.yml" prefix: /admin + +bitbag_purge_sulu_cache_for_channel: + path: /invalidate-sulu-cache/{id}/{locale} + methods: [GET] + prefix: /admin + defaults: + locale: '' + _controller: bitbag.sylius_sulu_plugin.controller.action.purge_sulu_cache_action + _sylius: + section: admin + redirect: referer + permission: true diff --git a/tests/Application/config/routes/sylius_shop.yaml b/tests/Application/config/routes/sylius_shop.yaml index fae46cb..de0d244 100644 --- a/tests/Application/config/routes/sylius_shop.yaml +++ b/tests/Application/config/routes/sylius_shop.yaml @@ -12,3 +12,19 @@ sylius_shop_default_locale: methods: [GET] defaults: _controller: sylius.controller.shop.locale_switch::switchAction + +bitbag_render_sulu_page: + path: /{locale}/page/{slug} + methods: [GET] + defaults: + _controller: bitbag.sylius_sulu_plugin.controller.action.render_page_action + _sylius: + permission: false + +bitbag_render_sulu_sub_page: + path: /{locale}/page/{slug}/{second_slug} + methods: [GET] + defaults: + _controller: bitbag.sylius_sulu_plugin.controller.action.render_page_action + _sylius: + permission: false diff --git a/tests/Application/config/services.yaml b/tests/Application/config/services.yaml index 615506e..f2ed8a1 100644 --- a/tests/Application/config/services.yaml +++ b/tests/Application/config/services.yaml @@ -2,3 +2,5 @@ # https://symfony.com/doc/current/best_practices/configuration.html#application-related-configuration parameters: locale: en_US + bitbag.sulu_base_uri: "%env(string:SULU_BASE_URI)%" + bitbag.sulu_cache_dir: "%kernel.cache_dir%/sulu" diff --git a/tests/Application/config/services_test.yaml b/tests/Application/config/services_test.yaml index af40901..2015ae0 100644 --- a/tests/Application/config/services_test.yaml +++ b/tests/Application/config/services_test.yaml @@ -6,3 +6,33 @@ imports: # see https://github.com/FriendsOfBehat/SymfonyExtension/issues/88 services: Symfony\Component\BrowserKit\AbstractBrowser: '@test.client' + + tests.bitbag.sylius_sulu_plugin.application.src.renderer.page.featured_pages_renderer: + class: Tests\BitBag\SyliusSuluPlugin\Application\src\Renderer\Page\FeaturedPagesRenderer + arguments: [ '@twig' ] + tags: + - { name: bitbag.sylius_sulu_plugin.strategy.page_renderer} + + tests.bit_bag.sylius_sulu_plugin.application.src.renderer.page.blog_page_renderer: + class: Tests\BitBag\SyliusSuluPlugin\Application\src\Renderer\Page\BlogPageRenderer + arguments: [ '@twig' ] + tags: + - { name: bitbag.sylius_sulu_plugin.strategy.page_renderer } + + tests.bitbag.sylius_sulu_plugin.application.src.renderer.block.text_renderer: + class: Tests\BitBag\SyliusSuluPlugin\Application\src\Renderer\Block\TextRenderer + arguments: [ '@twig' ] + tags: + - { name: bitbag.sylius_sulu_plugin.strategy.block_renderer } + + tests.bitbag.sylius_sulu_plugin.application.src.renderer.block.quote_renderer: + class: Tests\BitBag\SyliusSuluPlugin\Application\src\Renderer\Block\QuoteRenderer + arguments: [ '@twig' ] + tags: + - { name: bitbag.sylius_sulu_plugin.strategy.block_renderer } + + tests.bitbag.sylius_sulu_plugin.application.src.renderer.block.image_renderer: + class: Tests\BitBag\SyliusSuluPlugin\Application\src\Renderer\Block\ImageRenderer + arguments: [ '@twig' ] + tags: + - { name: bitbag.sylius_sulu_plugin.strategy.block_renderer } diff --git a/tests/Application/src/Entity/Channel/Channel.php b/tests/Application/src/Entity/Channel/Channel.php new file mode 100644 index 0000000..e8ccea3 --- /dev/null +++ b/tests/Application/src/Entity/Channel/Channel.php @@ -0,0 +1,13 @@ +getAllowedBlocks(), true) && + $this->twig->getLoader()->exists($this->getTemplate()) + ; + } + + public function render(array $blockData): string + { + return $this->twig->render( + $this->getTemplate(), + [ + 'url' => $blockData['url'], + 'alt' => $blockData['alt'], + ], + ); + } + + public function getAllowedBlocks(): array + { + return [self::IMAGE]; + } + + public function getTemplate(): string + { + return '@BitBagSyliusSuluPlugin/shop/block/image.html.twig'; + } +} diff --git a/tests/Application/src/Renderer/Block/QuoteRenderer.php b/tests/Application/src/Renderer/Block/QuoteRenderer.php new file mode 100644 index 0000000..2657e6d --- /dev/null +++ b/tests/Application/src/Renderer/Block/QuoteRenderer.php @@ -0,0 +1,47 @@ +getAllowedBlocks(), true) && + $this->twig->getLoader()->exists($this->getTemplate()) + ; + } + + public function render(array $blockData): string + { + return $this->twig->render( + $this->getTemplate(), + [ + 'quote' => $blockData['quote'], + 'quoteReference' => $blockData['quoteReference'], + ], + ); + } + + public function getAllowedBlocks(): array + { + return [self::TYPE]; + } + + public function getTemplate(): string + { + return '@BitBagSyliusSuluPlugin/shop/block/quote.html.twig'; + } +} diff --git a/tests/Application/src/Renderer/Block/TextRenderer.php b/tests/Application/src/Renderer/Block/TextRenderer.php new file mode 100644 index 0000000..8400aa7 --- /dev/null +++ b/tests/Application/src/Renderer/Block/TextRenderer.php @@ -0,0 +1,48 @@ +getAllowedBlocks(), true) && + $this->twig->getLoader()->exists($this->getTemplate()) + ; + } + + public function render(array $blockData): string + { + return $this->twig->render( + $this->getTemplate(), + [ + 'title' => $blockData['title'], + 'description' => $blockData['content'], + 'tags' => $blockData['tags'], + ], + ); + } + + public function getAllowedBlocks(): array + { + return [self::TEXT]; + } + + public function getTemplate(): string + { + return '@BitBagSyliusSuluPlugin/shop/block/text.html.twig'; + } +} diff --git a/tests/Application/src/Renderer/Page/BlogPageRenderer.php b/tests/Application/src/Renderer/Page/BlogPageRenderer.php new file mode 100644 index 0000000..ba8129a --- /dev/null +++ b/tests/Application/src/Renderer/Page/BlogPageRenderer.php @@ -0,0 +1,46 @@ +getAllowedPageTemplates(), true) && + $this->twig->getLoader()->exists($this->getTemplate()) + ; + } + + public function render(array $page): string + { + return $this->twig->render( + $this->getTemplate(), + ['page' => $page['content']], + ); + } + + public function getAllowedPageTemplates(): array + { + return [self::BLOG_PAGE]; + } + + public function getTemplate(): string + { + return '@BitBagSyliusSuluPlugin/shop/page/blog.html.twig'; + } +} diff --git a/tests/Application/src/Renderer/Page/FeaturedPagesRenderer.php b/tests/Application/src/Renderer/Page/FeaturedPagesRenderer.php new file mode 100644 index 0000000..a5aa8e0 --- /dev/null +++ b/tests/Application/src/Renderer/Page/FeaturedPagesRenderer.php @@ -0,0 +1,49 @@ +getAllowedPageTemplates(), true) && + $this->twig->getLoader()->exists($this->getTemplate()) + ; + } + + public function render(array $page): string + { + return $this->twig->render( + $this->getTemplate(), + [ + 'page' => $page['content'], + 'links' => $page['content']['links'], + ], + ); + } + + public function getAllowedPageTemplates(): array + { + return [self::BLOG_PAGE]; + } + + public function getTemplate(): string + { + return '@BitBagSyliusSuluPlugin/shop/page/featuredPages.html.twig'; + } +} diff --git a/tests/Application/templates/bundles/BitBagSyliusSuluPlugin/shop/block/image.html.twig b/tests/Application/templates/bundles/BitBagSyliusSuluPlugin/shop/block/image.html.twig new file mode 100644 index 0000000..9c0e0d1 --- /dev/null +++ b/tests/Application/templates/bundles/BitBagSyliusSuluPlugin/shop/block/image.html.twig @@ -0,0 +1 @@ +{{ alt }} diff --git a/tests/Application/templates/bundles/BitBagSyliusSuluPlugin/shop/block/quote.html.twig b/tests/Application/templates/bundles/BitBagSyliusSuluPlugin/shop/block/quote.html.twig new file mode 100644 index 0000000..d312e9c --- /dev/null +++ b/tests/Application/templates/bundles/BitBagSyliusSuluPlugin/shop/block/quote.html.twig @@ -0,0 +1 @@ +{{ quote }} diff --git a/tests/Application/templates/bundles/BitBagSyliusSuluPlugin/shop/block/text.html.twig b/tests/Application/templates/bundles/BitBagSyliusSuluPlugin/shop/block/text.html.twig new file mode 100644 index 0000000..6e7fc52 --- /dev/null +++ b/tests/Application/templates/bundles/BitBagSyliusSuluPlugin/shop/block/text.html.twig @@ -0,0 +1 @@ +{{ description }} diff --git a/tests/Application/templates/bundles/BitBagSyliusSuluPlugin/shop/page/blog.html.twig b/tests/Application/templates/bundles/BitBagSyliusSuluPlugin/shop/page/blog.html.twig new file mode 100644 index 0000000..e6bf512 --- /dev/null +++ b/tests/Application/templates/bundles/BitBagSyliusSuluPlugin/shop/page/blog.html.twig @@ -0,0 +1,48 @@ +{% extends '@SyliusShop/layout.html.twig' %} + +{%- block title -%} + {% if page.title is not empty %} + {{ page.title }} + {% endif %} +{%- endblock -%} + +{% block content %} +
+

{{ page.title }}

+ + + {% if bitbag_page_has_sulu_block(page, 'image') %} +
{{ bitbag_render_sulu_block_with_type(page.blocks, 'image')|raw }}
+ {% endif %} + + + {% if bitbag_page_has_sulu_block(page, 'text') %} +
{{ bitbag_render_sulu_block_with_type(page.blocks, 'text') }}
+ {% elseif page.content is defined and page.content is not null %} +
{{ page.content }}
+ {% endif %} + + + + {% if bitbag_page_has_sulu_block(page, 'quote') %} +
{{ bitbag_render_sulu_block_with_type(page.blocks, 'quote') }}
+ {% endif %} +
+ {% if page.tags is defined and page.tags|length > 0 %} +
+ Tags : + {% for tag in page.tags %} + {{ tag.content.name }} + {% endfor %} +
+ {% endif %} + + {% if page.links is defined and page.links|length > 0 %} +
+ {{ 'Similar posts' }}: + {% for link in page.links %} + {{ link.content.title }} + {% endfor %} +
+ {% endif %} +{% endblock %} diff --git a/tests/Application/templates/bundles/BitBagSyliusSuluPlugin/shop/page/featuredPages.html.twig b/tests/Application/templates/bundles/BitBagSyliusSuluPlugin/shop/page/featuredPages.html.twig new file mode 100644 index 0000000..f07cd00 --- /dev/null +++ b/tests/Application/templates/bundles/BitBagSyliusSuluPlugin/shop/page/featuredPages.html.twig @@ -0,0 +1,16 @@ +
+ {% for link in links %} +
+
+
+ {{ link.content.title }} +
+
+
+ {{ link.content.article|raw }} +
+
+
+
+ {% endfor %} +
diff --git a/tests/Application/templates/bundles/SyliusShopBundle/Homepage/_featuredPages.html.twig b/tests/Application/templates/bundles/SyliusShopBundle/Homepage/_featuredPages.html.twig new file mode 100644 index 0000000..37ff51b --- /dev/null +++ b/tests/Application/templates/bundles/SyliusShopBundle/Homepage/_featuredPages.html.twig @@ -0,0 +1,7 @@ +

{{ 'Featured pages' }}

+ + +
+ {{ render(url('bitbag_render_sulu_page', {'slug': 'featured_pages', 'locale': sylius.localeCode })) }} +
+ diff --git a/tests/Behat/ApiResponseMock/blog_page_with_blocks_and_links.json b/tests/Behat/ApiResponseMock/blog_page_with_blocks_and_links.json new file mode 100644 index 0000000..b5ace7c --- /dev/null +++ b/tests/Behat/ApiResponseMock/blog_page_with_blocks_and_links.json @@ -0,0 +1,183 @@ +{ + "id": "6c0542ce-a3e9-449d-b684-783a2e7d38ae", + "nodeType": 1, + "type": "page", + "template": "blog", + "content": { + "category_selection": [], + "title": "E-commerce trends", + "url": "/E-commerce trends", + "content": "CONTENT", + "links": [ + { + "id": "7c6acba2-d1b6-4985-96e2-b12db89b8414", + "nodeType": 1, + "type": "page", + "template": "blog_page", + "content": { + "title": "Blog Page 2", + "url": "/blog-page-2", + "article": "

Blog Page 2

", + "excerptTitle": "", + "excerptDescription": "" + }, + "view": { + "title": [], + "url": [], + "article": [], + "excerptTitle": [], + "excerptDescription": [] + }, + "author": 1, + "authored": "2024-02-12T20:35:45+0000", + "changer": 1, + "changed": "2024-02-12T20:35:45+0000", + "creator": 1, + "created": "2024-02-12T20:35:45+0000" + }, + { + "id": "7c6acba2-d1b6-4985-96e2-b12db89b8414", + "nodeType": 1, + "type": "page", + "template": "blog_page", + "content": { + "title": "Blog Page 3", + "url": "/blog-page-3", + "article": "

Blog Page 3

", + "excerptTitle": "", + "excerptDescription": "" + }, + "view": { + "title": [], + "url": [], + "article": [], + "excerptTitle": [], + "excerptDescription": [] + }, + "author": 1, + "authored": "2024-02-12T20:35:45+0000", + "changer": 1, + "changed": "2024-02-12T20:35:45+0000", + "creator": 1, + "created": "2024-02-12T20:35:45+0000" + } + ], + "tags": [ + { + "id": "7c6acba2-d1b6-4985-96e2-b12db89b8414", + "nodeType": 1, + "type": "page", + "template": "tag", + "content": { + "name": "best-post-2022", + "url": "/tag/best-posts" + }, + "view": { + "title": [], + "url": [], + "article": [], + "excerptTitle": [], + "excerptDescription": [] + }, + "author": 1, + "authored": "2024-02-12T20:35:45+0000", + "changer": 1, + "changed": "2024-02-12T20:35:45+0000", + "creator": 1, + "created": "2024-02-12T20:35:45+0000" + }, + { + "id": "7c6acba2-d1b6-4985-96e2-b12db89b8414", + "nodeType": 1, + "type": "page", + "template": "tag", + "content": { + "name": "e-commerce", + "url": "/tag/e-commerce" + }, + "view": { + "title": [], + "url": [], + "article": [], + "excerptTitle": [], + "excerptDescription": [] + }, + "author": 1, + "authored": "2024-02-12T20:35:45+0000", + "changer": 1, + "changed": "2024-02-12T20:35:45+0000", + "creator": 1, + "created": "2024-02-12T20:35:45+0000" + } + ], + "blocks": [ + { + "type": "quote", + "settings": {}, + "quote": "Lorem ipsum dolor sit amet, con", + "quoteReference": "Unknown" + }, + { + "type": "text", + "settings": {}, + "content": "2021 was followed by the time of the 2020 pandemic. During these two years, a lot has changed...", + "title": "E-commerce trends in 2022", + "tags": "trends, e-commerce" + }, + { + "type": "image", + "settings": {}, + "url": "https://en.wikipedia.org/wiki/Cat#/media/File:Sheba1.JPG", + "alt": "bitbag logo" + } + ] + }, + "view": { + "category_selection": { + "ids": [] + }, + "title": [], + "url": [], + "article": [], + "links": { + "ids": [] + }, + "blocks": [ + { + "quote": [], + "quoteReference": [] + }, + { + "quote": [], + "quoteReference": [] + } + ] + }, + "author": "1", + "authored": "2024-02-12T20:36:49+0000", + "changer": 1, + "changed": "2024-02-13T13:58:45+0000", + "creator": 1, + "created": "2024-02-12T20:36:49+0000", + "extension": { + "seo": { + "title": "", + "description": "", + "keywords": "", + "canonicalUrl": "", + "noIndex": false, + "noFollow": false, + "hideInSitemap": false + }, + "excerpt": { + "title": "", + "more": "", + "description": "", + "categories": [], + "tags": [], + "segments": [], + "icon": [], + "images": [] + } + } +} diff --git a/tests/Behat/ApiResponseMock/blog_page_with_properties.json b/tests/Behat/ApiResponseMock/blog_page_with_properties.json new file mode 100644 index 0000000..d05c6b7 --- /dev/null +++ b/tests/Behat/ApiResponseMock/blog_page_with_properties.json @@ -0,0 +1,62 @@ +{ + "id": "6c0542ce-a3e9-449d-b684-783a2e7d38ae", + "nodeType": 1, + "type": "page", + "template": "blog", + "content": { + "category_selection": [], + "title": "E-commerce trends", + "url": "/E-commerce trends", + "content": "CONTENT", + "links": [], + "blocks": [] + }, + "view": { + "category_selection": { + "ids": [] + }, + "title": [], + "url": [], + "article": [], + "links": { + "ids": [] + }, + "blocks": [ + { + "quote": [], + "quoteReference": [] + }, + { + "quote": [], + "quoteReference": [] + } + ] + }, + "author": "1", + "authored": "2024-02-12T20:36:49+0000", + "changer": 1, + "changed": "2024-02-13T13:58:45+0000", + "creator": 1, + "created": "2024-02-12T20:36:49+0000", + "extension": { + "seo": { + "title": "", + "description": "", + "keywords": "", + "canonicalUrl": "", + "noIndex": false, + "noFollow": false, + "hideInSitemap": false + }, + "excerpt": { + "title": "", + "more": "", + "description": "", + "categories": [], + "tags": [], + "segments": [], + "icon": [], + "images": [] + } + } +} diff --git a/tests/Behat/ApiResponseMock/featured_pages.json b/tests/Behat/ApiResponseMock/featured_pages.json new file mode 100644 index 0000000..00a76e2 --- /dev/null +++ b/tests/Behat/ApiResponseMock/featured_pages.json @@ -0,0 +1,141 @@ +{ + "id": "6c0542ce-a3e9-449d-b684-783a2e7d38ae", + "nodeType": 1, + "type": "page", + "template": "featured_pages", + "content": { + "category_selection": [], + "title": "Featured pages", + "url": "/featured-pages", + "article": "

FeaturedPages

", + "links": [ + { + "id": "6c0542ce-a3e9-449d-b684-783a2e7d38ae", + "nodeType": 1, + "type": "page", + "template": "blog_page", + "content": { + "title": "Blog Page 1", + "url": "/blog-page-1", + "article": "

Blog Page 1

", + "excerptTitle": "", + "excerptDescription": "" + }, + "view": { + "title": [], + "url": [], + "article": [], + "excerptTitle": [], + "excerptDescription": [] + }, + "author": "1", + "authored": "2024-02-12T20:36:49+0000", + "changer": 1, + "changed": "2024-02-13T13:58:45+0000", + "creator": 1, + "created": "2024-02-12T20:36:49+0000" + }, + { + "id": "7c6acba2-d1b6-4985-96e2-b12db89b8414", + "nodeType": 1, + "type": "page", + "template": "blog_page", + "content": { + "title": "Blog Page 2", + "url": "/blog-page-2", + "article": "

Blog Page 2

", + "excerptTitle": "", + "excerptDescription": "" + }, + "view": { + "title": [], + "url": [], + "article": [], + "excerptTitle": [], + "excerptDescription": [] + }, + "author": 1, + "authored": "2024-02-12T20:35:45+0000", + "changer": 1, + "changed": "2024-02-12T20:35:45+0000", + "creator": 1, + "created": "2024-02-12T20:35:45+0000" + }, + { + "id": "7c6acba2-d1b6-4985-96e2-b12db89b8414", + "nodeType": 1, + "type": "page", + "template": "blog_page", + "content": { + "title": "Blog Page 3", + "url": "/blog-page-3", + "article": "

Blog Page 3

", + "excerptTitle": "", + "excerptDescription": "" + }, + "view": { + "title": [], + "url": [], + "article": [], + "excerptTitle": [], + "excerptDescription": [] + }, + "author": 1, + "authored": "2024-02-12T20:35:45+0000", + "changer": 1, + "changed": "2024-02-12T20:35:45+0000", + "creator": 1, + "created": "2024-02-12T20:35:45+0000" + } + ], + "blocks": [] + }, + "view": { + "category_selection": { + "ids": [] + }, + "title": [], + "url": [], + "article": [], + "links": { + "ids": [] + }, + "blocks": [ + { + "quote": [], + "quoteReference": [] + }, + { + "quote": [], + "quoteReference": [] + } + ] + }, + "author": "1", + "authored": "2024-02-12T20:36:49+0000", + "changer": 1, + "changed": "2024-02-13T13:58:45+0000", + "creator": 1, + "created": "2024-02-12T20:36:49+0000", + "extension": { + "seo": { + "title": "", + "description": "", + "keywords": "", + "canonicalUrl": "", + "noIndex": false, + "noFollow": false, + "hideInSitemap": false + }, + "excerpt": { + "title": "", + "more": "", + "description": "", + "categories": [], + "tags": [], + "segments": [], + "icon": [], + "images": [] + } + } +} diff --git a/tests/Behat/Context/Setup/SuluPageContext.php b/tests/Behat/Context/Setup/SuluPageContext.php new file mode 100644 index 0000000..7b6355e --- /dev/null +++ b/tests/Behat/Context/Setup/SuluPageContext.php @@ -0,0 +1,119 @@ +apiClient->fetchCmsContent($page); + + $jsonResponse = sprintf('%s/../../ApiResponseMock/%s.json', __DIR__, $page); + + Assert::eq($response, json_decode(file_get_contents($jsonResponse), true)); + + $this->sharedStorage->set($page, $response); + } + + /** + * @Given Sulu has defined featured pages list :featured_pages in locale :locale + */ + public function suluHasFeaturedPagesInLocale(string $featuredPagesCode, string $locale) + { + $response = $this->apiClient->fetchCmsContent($featuredPagesCode); + + Assert::eq($response, json_decode(file_get_contents(__DIR__ . '/../../ApiResponseMock/featured_pages.json'), true)); + + $this->sharedStorage->set('featured_pages', $response); + } + + /** + * @Given One of the featured page is page :pageTitle + */ + public function suluPageIsFeatured(string $pageTitle) + { + $featuredPages = $this->sharedStorage->get('featured_pages'); + + foreach ($featuredPages['content']['links'] as $link) { + if ($link['content']['title'] === $pageTitle) { + return; + } + } + + throw new \Exception('featured page not found'); + } + + /** + * @Given Page :page has block :blockType + */ + public function pageHasBlock(string $page, string $blockType) + { + $page = $this->sharedStorage->get($page); + + foreach ($page['content']['blocks'] as $block) { + if ($block['type'] === $blockType) { + return; + } + } + + throw new \Exception('featured page not found'); + } + + /** + * @Given Cache for sulu not exists + */ + public function suluCacheNotExists() + { + if (is_dir($this->suluCacheDirectory)) { + $this->removeDir($this->suluCacheDirectory); + } + } + + /** + * @When :channel has enabled sulu localized requests + */ + public function channelUseOrNotSuluLocalizedUrls(ChannelInterface $channel) + { + $channel->setSuluUseLocalizedUrls(true); + + $this->entityManager->flush(); + } + + private function removeDir(string $dir): void + { + $iterator = new RecursiveDirectoryIterator($dir, RecursiveDirectoryIterator::SKIP_DOTS); + $files = new \RecursiveIteratorIterator($iterator, \RecursiveIteratorIterator::CHILD_FIRST); + + /** @var \SplFileInfo $file */ + foreach ($files as $file) { + if ($file->isDir()) { + rmdir($file->getPathname()); + } else { + unlink($file->getPathname()); + } + } + + rmdir($dir); + } +} diff --git a/tests/Behat/Context/Ui/SuluAdminPanelContext.php b/tests/Behat/Context/Ui/SuluAdminPanelContext.php new file mode 100644 index 0000000..9f9fa2c --- /dev/null +++ b/tests/Behat/Context/Ui/SuluAdminPanelContext.php @@ -0,0 +1,108 @@ +suluCacheDirectory); + } + + /** + * @Then Sulu cache should exists + */ + public function suluCacheShouldExists() + { + return is_dir($this->suluCacheDirectory); + } + + /** + * @Then Sulu cache should exists for :channel with locale :locale + */ + public function suluCacheShouldExistsForChannelWithLocale(ChannelInterface $channel, string $locale) + { + return is_dir(sprintf('%s/%s/%s', $this->suluCacheDirectory, $channel->getCode(), $locale)); + } + + /** + * @Then I should see button :button in :channel + */ + public function iShouldSeeAButtonInChannelRow(string $buttonText, ChannelInterface $channel) + { + $button = $this->channelIndexPage->findAPurgeCacheButton(); + + Assert::eq($button->getText(), $buttonText); + } + + /** + * @Then I click :button button in :channel + */ + public function iClickAButtonInChannelRow(string $button, ChannelInterface $channel) + { + $button = $this->channelIndexPage->findAPurgeCacheButton(); + + $button->click(); + } + + /** + * @Then I should see :type :message flash message + */ + public function iShouldSeeAFlashMessage(string $type, string $message) + { + $type = match ($type) { + 'error' => NotificationType::failure(), + 'success' => NotificationType::success() + }; + + $this->testHelper->waitUntilNotificationPopups( + $this->notificationChecker, + $type, + $message, + ); + } + + /** + * @Then I should see expanded button :button in :channel + */ + public function iShouldSeeACollapsedButtonInChannelRow(string $buttonText, ChannelInterface $channel) + { + $button = $this->channelIndexPage->findAPurgeCacheButtonWithLocales(); + + Assert::eq($button->find('css', 'span.text')->getText(), $buttonText); + } + + /** + * @Then I click expanded :text button in :channel + */ + public function iClickAButtonCollapsedInChannelRow(string $text, ChannelInterface $channel) + { + $button = $this->channelIndexPage->findAPurgeCacheButtonWithLocales(); + + $button = $button->find('css', 'a.item'); + + Assert::eq($button->getText(), $text); + + $button->click(); + } + +} diff --git a/tests/Behat/Context/Ui/SuluPageContext.php b/tests/Behat/Context/Ui/SuluPageContext.php new file mode 100644 index 0000000..dfa60d5 --- /dev/null +++ b/tests/Behat/Context/Ui/SuluPageContext.php @@ -0,0 +1,89 @@ +homePage->getFeaturedPages(); + + Assert::count($pages, $count); + } + + /** + * @Then I should see featured page :pageTitle + */ + public function iShouldSeeAFeaturedPage(string $pageTitle) + { + $pages = $this->homePage->getFeaturedPages(); + + /** @var NodeElement $page */ + foreach ($pages as $page) { + if ($page->find('css', 'span')?->getText() === $pageTitle) { + return; + } + } + + throw new \Exception('Page not found'); + } + + /** + * @When I visit a sulu page :pageSlug in locale :locale + */ + public function iVisitSuluPage(string $pageSlug, string $locale) + { + $this->suluPage->open(['slug' => $pageSlug, 'locale' => $locale]); + } + + /** + * @Then I should see a :element with value :value + */ + public function iShouldSeeElementWithValue(string $element, string $value) + { + /** @var NodeElement $nodeElement */ + $nodeElement = $this->suluPage->findElement($element); + + Assert::eq($nodeElement->getText(), $value); + } + + /** + * @Then I should see a block :element with value :value + */ + public function iShouldSeeBlockElementWithValue(string $element, string $value) + { + /** @var NodeElement $nodeElement */ + $nodeElement = $this->suluPage->findBlockElement($element); + + Assert::eq($nodeElement->getText(), $value); + } + + /** + * @Then I should see a block image with url :url + */ + public function iShouldSeeBlockImageWithUrl(string $url) + { + /** @var NodeElement $nodeElement */ + $nodeElement = $this->suluPage->findBlockElement('image'); + + Assert::eq($nodeElement->find('css', 'img')->getAttribute('src'), $url); + } +} diff --git a/tests/Behat/Page/ChannelIndexPage.php b/tests/Behat/Page/ChannelIndexPage.php new file mode 100644 index 0000000..a6466d7 --- /dev/null +++ b/tests/Behat/Page/ChannelIndexPage.php @@ -0,0 +1,21 @@ +getDocument()->find('css', '[data-test-button="bitbag.sulu_plugin.purge_channel_cache"]'); + } + + public function findAPurgeCacheButtonWithLocales(): ?NodeElement + { + return $this->getDocument()->find('css', 'div.select-locale'); + } +} diff --git a/tests/Behat/Page/HomePage.php b/tests/Behat/Page/HomePage.php new file mode 100644 index 0000000..edc57f8 --- /dev/null +++ b/tests/Behat/Page/HomePage.php @@ -0,0 +1,18 @@ +getDocument() + ->find('css', 'div.featured-pages') + ->findAll('css', 'div.ui.fluid.card') + ; + } +} diff --git a/tests/Behat/Page/SuluPage.php b/tests/Behat/Page/SuluPage.php new file mode 100644 index 0000000..2ee4b7d --- /dev/null +++ b/tests/Behat/Page/SuluPage.php @@ -0,0 +1,37 @@ +getDocument(); + + return match ($element) { + 'title' => $document->find('css', '#page-title'), + 'content' => $document->find('css', '#page-content'), + }; + } + + public function findBlockElement(string $element): ?NodeElement + { + $document = $this->getDocument(); + + return match ($element) { + 'image' => $document->find('css', '#block-image'), + 'quote' => $document->find('css', '#block-quote'), + 'content' => $document->find('css', '#block-content'), + }; + } +} diff --git a/tests/Behat/Resources/services.xml b/tests/Behat/Resources/services.xml index e69de29..1d4ff87 100644 --- a/tests/Behat/Resources/services.xml +++ b/tests/Behat/Resources/services.xml @@ -0,0 +1,63 @@ + + + + + + + + %bitbag.sulu_cache_dir% + + + + + + + + + + + %bitbag.sulu_cache_dir% + + + + + + + + %bitbag.sulu_base_uri% + %bitbag.sulu_cache_dir% + + + + + + + + + + diff --git a/tests/Behat/Resources/suites.yml b/tests/Behat/Resources/suites.yml new file mode 100644 index 0000000..4030a1f --- /dev/null +++ b/tests/Behat/Resources/suites.yml @@ -0,0 +1,4 @@ +imports: + - suites/ui/sulu_page.yml + - suites/ui/render_sulu_page.yml + - suites/ui/cache_sulu_page.yml diff --git a/tests/Behat/Resources/suites/ui/cache_sulu_page.yml b/tests/Behat/Resources/suites/ui/cache_sulu_page.yml new file mode 100644 index 0000000..16a4566 --- /dev/null +++ b/tests/Behat/Resources/suites/ui/cache_sulu_page.yml @@ -0,0 +1,22 @@ +default: + suites: + cache_sulu_page: + contexts: + - sylius.behat.context.hook.doctrine_orm + - sylius.behat.context.transform.channel + - sylius.behat.context.transform.customer + - sylius.behat.context.transform.product + - sylius.behat.context.transform.shared_storage + + - tests.bitbag.sylius_sulu_plugin.behat.context.setup.sulu_page_context + - tests.bitbag.sylius_sulu_plugin.behat.context.ui.sulu_page_context + - sylius.behat.context.ui.channel + - sylius.behat.context.setup.shop_security + - sylius.behat.context.setup.channel + - sylius.behat.context.setup.user + - sylius.behat.context.ui.admin.managing_channels + - sylius.behat.context.setup.admin_security + - tests.bitbag.sylius_sulu_plugin.behat.context.ui.sulu_admin_panel_context + + filters: + tags: "@sulu_cache&&@ui" diff --git a/tests/Behat/Resources/suites/ui/render_sulu_page.yml b/tests/Behat/Resources/suites/ui/render_sulu_page.yml new file mode 100644 index 0000000..caabf91 --- /dev/null +++ b/tests/Behat/Resources/suites/ui/render_sulu_page.yml @@ -0,0 +1,19 @@ +default: + suites: + render_sulu_page: + contexts: + - sylius.behat.context.hook.doctrine_orm + - sylius.behat.context.transform.channel + - sylius.behat.context.transform.customer + - sylius.behat.context.transform.product + - sylius.behat.context.transform.shared_storage + + - tests.bitbag.sylius_sulu_plugin.behat.context.setup.sulu_page_context + - tests.bitbag.sylius_sulu_plugin.behat.context.ui.sulu_page_context + - sylius.behat.context.ui.channel + - sylius.behat.context.setup.shop_security + - sylius.behat.context.setup.channel + - sylius.behat.context.setup.user + + filters: + tags: "@render_sulu_page&&@ui" diff --git a/tests/Behat/Resources/suites/ui/sulu_page.yml b/tests/Behat/Resources/suites/ui/sulu_page.yml new file mode 100644 index 0000000..e784c01 --- /dev/null +++ b/tests/Behat/Resources/suites/ui/sulu_page.yml @@ -0,0 +1,19 @@ +default: + suites: + sulu_page: + contexts: + - sylius.behat.context.hook.doctrine_orm + - sylius.behat.context.transform.channel + - sylius.behat.context.transform.customer + - sylius.behat.context.transform.product + - sylius.behat.context.transform.shared_storage + + - tests.bitbag.sylius_sulu_plugin.behat.context.setup.sulu_page_context + - tests.bitbag.sylius_sulu_plugin.behat.context.ui.sulu_page_context + - sylius.behat.context.ui.channel + - sylius.behat.context.setup.shop_security + - sylius.behat.context.setup.channel + - sylius.behat.context.setup.user + + filters: + tags: "@sulu_page&&@ui" diff --git a/tests/Behat/Services/SuluApiClient.php b/tests/Behat/Services/SuluApiClient.php new file mode 100644 index 0000000..bde2e33 --- /dev/null +++ b/tests/Behat/Services/SuluApiClient.php @@ -0,0 +1,100 @@ +shopperContext->getChannel(); + $storeRoot = sprintf( + '%s/%s', + $this->cacheDir, + $channel->getCode() ?? 'GLOBAL', + ); + + Assert::methodExists($channel, 'isSuluUseLocalizedUrls'); + + if ($channel->isSuluUseLocalizedUrls()) { + $locale = $this->shopperContext->getLocaleCode(); + $storeRoot = sprintf('%s/%s', $storeRoot, $locale); + } + $cache = new FilesystemAdapter(defaultLifetime: 3600, directory: $storeRoot); + + $this->client = + new MockHttpClient( + $this->mockResponses()[$url], + $this->suluBaseUri, + ); + + try { + $response = $cache->get( + $url, + function (ItemInterface $cacheItem) use ($url) { + $response = $this->makeApiCall($url); + + $response = json_decode($response->getContent(), true); + Assert::isArray($response); + + $cacheItem->set($response); + $cacheItem->expiresAfter(3600); + + return $response; + }, + ); + } catch (\Exception $e) { + return []; + } + + return $response; + } + + private function makeApiCall(string $url): ResponseInterface + { + $response = $this->client->request( + Request::METHOD_GET, + $url, + [ + 'headers' => [ + 'Accept' => 'application/json', + ], + ], + ); + + return $response; + } + + private function mockResponses(): array + { + $featured = file_get_contents(__DIR__.'/../ApiResponseMock/featured_pages.json'); + $pageWithProperties = file_get_contents(__DIR__.'/../ApiResponseMock/blog_page_with_properties.json'); + $pageWithBlocks = file_get_contents(__DIR__.'/../ApiResponseMock/blog_page_with_blocks_and_links.json'); + + return [ + 'featured_pages' => new MockResponse($featured, ['http_code' => 200]), + 'blog_page_with_properties' => new MockResponse($pageWithProperties, ['http_code' => 200]), + 'blog_page_with_blocks_and_links' => new MockResponse($pageWithBlocks, ['http_code' => 200]), + ]; + } +}