From 2b19977d337dac0cfecdde91fe42bf79e4e88a14 Mon Sep 17 00:00:00 2001
From: Daniel Sasser <daniel.sasser@agile6.com>
Date: Fri, 28 Jun 2024 08:04:03 -0700
Subject: [PATCH] VACMS-18005: Aging content tests (#18256)

* VACMS-18005: Adds tests for JobTypeMessageNotifyBase.

* VACMS-18005: Adds missing template exception to the test.

* VACMS-18005: Adds functional tests of expired or warned FWB.

* VACMS-18005: Updates expirable_content to latest alpha.

---------

Co-authored-by: Tim Cosgrove <timcosgrove@users.noreply.github.com>
Co-authored-by: Tim Cosgrove <tcosgrove@metrostar.com>
---
 composer.json                                 |   2 +-
 composer.lock                                 |  21 +--
 .../AgingContentFullWidthBannerTest.php       | 107 ++++++++++++++
 .../kernel/JobTypeMessageNotifyBaseTest.php   | 138 ++++++++++++++++++
 4 files changed, 258 insertions(+), 10 deletions(-)
 create mode 100644 tests/phpunit/va_gov_notifications/functional/AgingContentFullWidthBannerTest.php
 create mode 100644 tests/phpunit/va_gov_notifications/kernel/JobTypeMessageNotifyBaseTest.php

diff --git a/composer.json b/composer.json
index e04b5ee097..55c2569640 100644
--- a/composer.json
+++ b/composer.json
@@ -80,7 +80,7 @@
         "drupal/entityqueue": "^1.2",
         "drupal/environment_indicator": "^4.0",
         "drupal/epp": "^1.1",
-        "drupal/expirable_content": "1.0.x-dev@dev",
+        "drupal/expirable_content": "^1.0@alpha",
         "drupal/fast_404": "^3.0",
         "drupal/feature_toggle": "^2.0",
         "drupal/field_group": "^3.4",
diff --git a/composer.lock b/composer.lock
index 7330347e10..8e802248ed 100644
--- a/composer.lock
+++ b/composer.lock
@@ -4,7 +4,7 @@
         "Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies",
         "This file is @generated automatically"
     ],
-    "content-hash": "47cf0b96e9848155990d8b6eb316d442",
+    "content-hash": "d4a8e6fee6064073a5f736e456c263c9",
     "packages": [
         {
             "name": "asm89/stack-cors",
@@ -6361,23 +6361,26 @@
         },
         {
             "name": "drupal/expirable_content",
-            "version": "dev-1.0.x",
+            "version": "1.0.0-alpha4",
             "source": {
                 "type": "git",
                 "url": "https://git.drupalcode.org/project/expirable_content.git",
-                "reference": "ecf4bd5662851f58c531fc1c71a03f7687905fad"
+                "reference": "1.0.0-alpha4"
+            },
+            "dist": {
+                "type": "zip",
+                "url": "https://ftp.drupal.org/files/projects/expirable_content-1.0.0-alpha4.zip",
+                "reference": "1.0.0-alpha4",
+                "shasum": "49483d13aca9c5fedfb1961483ba02b9759d846a"
             },
             "require": {
                 "drupal/core": "^9 || ^10"
             },
             "type": "drupal-module",
             "extra": {
-                "branch-alias": {
-                    "dev-1.0.x": "1.0.x-dev"
-                },
                 "drupal": {
-                    "version": "1.0.0-alpha2+3-dev",
-                    "datestamp": "1714075716",
+                    "version": "1.0.0-alpha4",
+                    "datestamp": "1718733572",
                     "security-coverage": {
                         "status": "not-covered",
                         "message": "Project has not opted into security advisory coverage!"
@@ -26999,7 +27002,7 @@
         "drupal/entity_reference_validators": 15,
         "drupal/entity_route_context": 5,
         "drupal/entity_usage": 10,
-        "drupal/expirable_content": 20,
+        "drupal/expirable_content": 15,
         "drupal/fieldhelptext": 10,
         "drupal/flag": 10,
         "drupal/graphql_menu": 15,
diff --git a/tests/phpunit/va_gov_notifications/functional/AgingContentFullWidthBannerTest.php b/tests/phpunit/va_gov_notifications/functional/AgingContentFullWidthBannerTest.php
new file mode 100644
index 0000000000..f0516b7ed1
--- /dev/null
+++ b/tests/phpunit/va_gov_notifications/functional/AgingContentFullWidthBannerTest.php
@@ -0,0 +1,107 @@
+<?php
+
+namespace tests\phpunit\va_gov_notifications\functional;
+
+use Drupal\Core\Datetime\DrupalDateTime;
+use Drupal\Core\StringTranslation\StringTranslationTrait;
+use JetBrains\PhpStorm\ArrayShape;
+use Tests\Support\Classes\VaGovExistingSiteBase;
+
+/**
+ * Tests Aging Content FWB notifications.
+ *
+ * @group va_gov_notifications
+ * @group aging_content
+ */
+class AgingContentFullWidthBannerTest extends VaGovExistingSiteBase {
+
+  use StringTranslationTrait;
+
+  /**
+   * {@inheritDoc}
+   */
+  public function setUp(): void {
+    parent::setUp();
+    $user = $this->createUser([], 'Admin', TRUE);
+    $this->drupalLogin($user);
+
+    $node_base = [
+      'title' => 'Expirable Content Test Node',
+      'status' => 1,
+      'moderation_state' => 'published',
+      'type' => 'banner',
+      'uid' => 1,
+      'revision_default' => 1,
+      'field_administration' => ['target_id' => 194],
+    ];
+
+    $base_date = DrupalDateTime::createFromTimestamp(time());
+    $warn_node = clone $base_date;
+    $exp_node = clone $base_date;
+
+    $dates = [
+      'not expired or warn' => $base_date->getTimestamp(),
+      'warn' => $warn_node->sub(new \DateInterval('P5D'))->getTimestamp(),
+      'expired' => $exp_node->sub(new \DateInterval('P8D'))->getTimestamp(),
+    ];
+
+    foreach ($dates as $key => $date) {
+      $node = $this->createNode($node_base);
+      $node->set('field_last_saved_by_an_editor', $date);
+      $node->set('title', $node->getTitle() . ':' . $key);
+      $node->save();
+    }
+  }
+
+  /**
+   * Data provider for expiration and warning tests.
+   */
+  #[ArrayShape(['expired' => "string[]", 'warn' => "string[]"])]
+  public function dataProvider(): array {
+    return [
+      'expired' => ['expired'],
+      'warn' => ['warn'],
+    ];
+  }
+
+  /**
+   * Tests that Full Width Alerts (banner) notifications are sent.
+   *
+   * @param string $type
+   *   The type of test either 'warn' or 'expired'.
+   *
+   * @dataProvider dataProvider
+   *
+   * @throws \Behat\Mink\Exception\ResponseTextException
+   * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
+   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
+   * @throws \Drupal\Core\Entity\EntityStorageException
+   */
+  public function testFullWidthBannerJobQueued(string $type) {
+    // Enable the ECA if it is not already.
+    /** @var \Drupal\eca\Entity\Eca $eca */
+    $eca = \Drupal::entityTypeManager()->getStorage('eca')->load("aging_content_{$type}_fwb");
+    $status = $eca->status();
+    $eca->enable();
+    $eca->save();
+
+    // Run cron to queue the job.
+    $this->drupalGet('admin/reports/status');
+    $this->clickLink($this->t('Run cron'));
+
+    // Check that the job is queued.
+    $this->drupalGet('admin/config/system/queues/jobs/aging_content');
+    $this->assertSession()->pageTextContains("Expirable Content Test Node:{$type}");
+
+    // Set ECA to previous state. This is to prevent duplicate queued items.
+    $eca->setStatus($status);
+    $eca->save();
+
+    // Run cron again to execute the job, which sends the notification.
+    $this->drupalGet('admin/reports/status');
+    $this->clickLink($this->t('Run cron'));
+
+    $this->assertSession()->pageTextContains('Success');
+  }
+
+}
diff --git a/tests/phpunit/va_gov_notifications/kernel/JobTypeMessageNotifyBaseTest.php b/tests/phpunit/va_gov_notifications/kernel/JobTypeMessageNotifyBaseTest.php
new file mode 100644
index 0000000000..520edcddd7
--- /dev/null
+++ b/tests/phpunit/va_gov_notifications/kernel/JobTypeMessageNotifyBaseTest.php
@@ -0,0 +1,138 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\va_gov_notifications\kernel;
+
+use Drupal\advancedqueue\Job;
+use Drupal\Core\TypedData\Exception\MissingDataException;
+use Drupal\KernelTests\KernelTestBase;
+use Drupal\message\Entity\MessageTemplate;
+use Drupal\Tests\user\Traits\UserCreationTrait;
+use Drupal\va_gov_notifications\JobTypeMessageNotifyBase;
+
+/**
+ * Tests for JobTypeMessageNotifyBase.
+ *
+ * @group va_gov_notifications
+ * @covers JobTypeMessageNotifyBase
+ */
+class JobTypeMessageNotifyBaseTest extends KernelTestBase {
+
+  use UserCreationTrait;
+
+  /**
+   * {@inheritdoc}
+   */
+  public static $modules = [
+    'system',
+    'user',
+    'message',
+    'message_notify',
+    'va_gov_notifications',
+    'advancedqueue',
+    'flag',
+    'workbench_access',
+  ];
+
+  /**
+   * The job type plugin under test.
+   *
+   * @var \Drupal\va_gov_notifications\JobTypeMessageNotifyBase
+   */
+  protected JobTypeMessageNotifyBase $jobType;
+
+  /**
+   * {@inheritdoc}
+   *
+   * @throws \Drupal\Core\Entity\EntityStorageException
+   */
+  protected function setUp(): void {
+    parent::setUp();
+    $this->installEntitySchema('user');
+    $this->installEntitySchema('message');
+    $this->createUser(admin: FALSE);
+
+    // Create message template.
+    $message_template = MessageTemplate::create([
+      'template' => 'foo_template',
+      'label' => 'Example Template',
+    ]);
+    $message_template->save();
+
+    // Instantiate the job type.
+    $this->jobType = new JobTypeMessageNotifyBase(
+      ['id' => 'test_job_type'],
+      'test_job_type',
+      ['provider' => 'va_gov_notifications'],
+      $this->container->get('logger.factory'),
+      $this->container->get('message_notify.sender')
+    );
+  }
+
+  /**
+   * Tests the process method for a successful message send.
+   */
+  public function testProcessSuccess() {
+    $payload = [
+      'values' => [],
+      'template_values' => [
+        'uid' => 1,
+        'template' => 'foo_template',
+      ],
+      'restrict_delivery_to' => [1],
+    ];
+    $job = new Job([
+      'type' => 'test_job_type',
+      'payload' => $payload,
+      'state' => Job::STATE_QUEUED,
+    ]);
+
+    $result = $this->jobType->process($job);
+    $this->assertEquals(Job::STATE_SUCCESS, $result->getState());
+    $this->assertEquals('Message 1 sent successfully.', $result->getMessage());
+  }
+
+  /**
+   * Tests the process method with an error due to missing template values.
+   */
+  public function testProcessFailureRecipientAllowList() {
+    $payload = [
+      'values' => [],
+      'template_values' => [
+        'uid' => 1,
+        'template' => 'foo_template',
+      ],
+      'restrict_delivery_to' => [2],
+    ];
+    $job = new Job([
+      'type' => 'test_job_type',
+      'payload' => $payload,
+      'state' => Job::STATE_QUEUED,
+    ]);
+
+    $result = $this->jobType->process($job);
+    $this->assertEquals(Job::STATE_FAILURE, $result->getState());
+    $this->assertEquals('Recipient is not on the allow list for message 1.', $result->getMessage());
+  }
+
+  /**
+   * Tests the process method with an error due to missing template values.
+   */
+  public function testProcessFailureMissingTemplateValues() {
+    $payload = [
+      'values' => [],
+    ];
+    $job = new Job([
+      'type' => 'test_job_type',
+      'payload' => $payload,
+      'state' => Job::STATE_QUEUED,
+    ]);
+    $this->expectException(MissingDataException::class);
+    $this->expectExceptionMessage('Missing template_values in payload for job id');
+    $result = $this->jobType->process($job);
+    $this->assertEquals(Job::STATE_FAILURE, $result->getState());
+
+  }
+
+}