From 0209c0189ae0fcc8a233ff1bb35a96fe67d2daa2 Mon Sep 17 00:00:00 2001
From: Andy Broomfield <andybroomfield@gmail.com>
Date: Thu, 29 Aug 2024 08:48:10 +0100
Subject: [PATCH] Amend the visibility test to account for banner caching

See #327.

Extends visibility test by providing actual pages for the banner to display on.
This also provides an extra banner to test the correct banner is visible per page.
---
 tests/src/Functional/VisibilityTest.php | 63 ++++++++++++++++++++++++-
 1 file changed, 61 insertions(+), 2 deletions(-)

diff --git a/tests/src/Functional/VisibilityTest.php b/tests/src/Functional/VisibilityTest.php
index 1e000a3b..6b105f5b 100644
--- a/tests/src/Functional/VisibilityTest.php
+++ b/tests/src/Functional/VisibilityTest.php
@@ -2,12 +2,15 @@
 
 namespace Drupal\Tests\localgov_alert_banner\Functional;
 
+use Drupal\node\NodeInterface;
 use Drupal\Tests\BrowserTestBase;
+use Drupal\Tests\node\Traits\NodeCreationTrait;
 
 /**
  * Functional tests for LocalGov Drupal Alert banner admin view.
  */
 class VisibilityTest extends BrowserTestBase {
+  use NodeCreationTrait;
 
   /**
    * {@inheritdoc}
@@ -19,6 +22,8 @@ class VisibilityTest extends BrowserTestBase {
    */
   protected static $modules = [
     'localgov_alert_banner',
+    'node',
+    'path_alias',
   ];
 
   /**
@@ -35,15 +40,27 @@ protected function setUp(): void {
    */
   public function testAlertBannerVisibility() {
 
+    // Create a page for the alert banner.
+    $this->createContentType(['type' => 'page']);
+    $node = $this->createNode([
+      'title' => 'Council tax',
+      'type' => 'page',
+      'status' => NodeInterface::PUBLISHED,
+    ]);
+    $this->container->get('entity_type.manager')->getStorage('path_alias')->create([
+      'path' => '/node/' . $node->id(),
+      'alias' => '/council-tax',
+    ])->save();
+
     // Create an alert banner.
-    $title = $this->randomMachineName(8);
+    $title = 'Council tax - ' . $this->randomMachineName(8);
     $alert_message = 'Alert message: ' . $this->randomMachineName(16);
     $alert = $this->container->get('entity_type.manager')->getStorage('localgov_alert_banner')
       ->create([
         'type' => 'localgov_alert_banner',
         'title' => $title,
         'short_description' => $alert_message,
-        'type_of_alert' => 'minor',
+        'type_of_alert' => '20--minor',
         'moderation_state' => 'published',
         'visibility' => [
           'conditions' => [
@@ -71,6 +88,48 @@ public function testAlertBannerVisibility() {
     // Check it's still on /council-tax.
     $this->drupalGet('/council-tax');
     $this->assertSession()->pageTextContains($title);
+
+    // Create a second page and banner to test banner display caches correctly.
+    // @See https://github.com/localgovdrupal/localgov_alert_banner/issues/327
+    $node2 = $this->createNode([
+      'title' => 'Adult social care',
+      'type' => 'page',
+      'status' => NodeInterface::PUBLISHED,
+    ]);
+    $this->container->get('entity_type.manager')->getStorage('path_alias')->create([
+      'path' => '/node/' . $node2->id(),
+      'alias' => '/adult-social-care',
+    ])->save();
+
+    $title2 = 'Adult social care - ' . $this->randomMachineName(8);
+    $alert_message2 = 'Alert message: ' . $this->randomMachineName(16);
+    $alert2 = $this->container->get('entity_type.manager')->getStorage('localgov_alert_banner')
+      ->create([
+        'type' => 'localgov_alert_banner',
+        'title' => $title2,
+        'short_description' => $alert_message2,
+        'type_of_alert' => '20--minor',
+        'moderation_state' => 'published',
+        'visibility' => [
+          'conditions' => [
+            'request_path' => [
+              'pages' => '/adult-social-care',
+              'negate' => 0,
+            ],
+          ],
+        ],
+      ]);
+    $alert2->save();
+
+    // Check the correct alert is on /adult-social-care.
+    $this->drupalGet('/adult-social-care');
+    $this->assertSession()->pageTextNotContains($title);
+    $this->assertSession()->pageTextContains($title2);
+
+    // Check the correct alert is on /council-tax.
+    $this->drupalGet('/council-tax');
+    $this->assertSession()->pageTextContains($title);
+    $this->assertSession()->pageTextNotContains($title2);
   }
 
 }