OrderRulesEventsTest.php in Ubercart 8.4

Namespace

Drupal\Tests\uc_order\Functional

File

uc_order/tests/src/Functional/OrderRulesEventsTest.php

<?php

namespace Drupal\Tests\uc_order\Functional;

use Drupal\rules\Context\ContextConfig;

/**
 * Tests the four events that uc_order provides for use in Rules module.
 *
 * @group ubercart
 */
class OrderRulesEventsTest extends OrderRulesTestBase {

  /**
   * Tests the four events provided by uc_order.
   *
   * This class tests all four events provided by uc_order, by creating four
   * rules which are all active throughout the test. They are all checked in
   * this one test class to make the tests stronger, as this will show not only
   * that the correct events are triggered in the right places, but also
   * that they are not triggered in the wrong places.
   */
  public function testRulesEvents() {

    // Create four reaction rules, one for each event that uc_order triggers.
    $rule_data = [
      1 => [
        'uc_order_status_update',
        'An order status has been changed',
      ],
      2 => [
        'uc_order_comment_added',
        'An order comment is added',
      ],
      3 => [
        'uc_order_status_email_update',
        'An Email notification of order status change was requested',
      ],
      4 => [
        'uc_order_delete',
        'An order is being deleted',
      ],
    ];
    foreach ($rule_data as $i => list($event_name, $description)) {
      $rule[$i] = $this->expressionManager
        ->createRule();
      $message[$i] = 'RULES message ' . $i . ': ' . $description;
      $rule[$i]
        ->addAction('rules_system_message', ContextConfig::create()
        ->setValue('message', $message[$i])
        ->setValue('type', 'status'));
      $config_entity = $this->rulesStorage
        ->create([
        'id' => 'rule' . $i,
        'events' => [
          [
            'event_name' => $event_name,
          ],
        ],
        'expression' => $rule[$i]
          ->getConfiguration(),
      ]);
      $config_entity
        ->save();
    }

    /** @var \Drupal\Tests\WebAssert $assert */
    $assert = $this
      ->assertSession();

    // Create an order to test order events.
    $order = $this
      ->createOrder();

    // Changing the order status on the admin form will also create
    // an order comment. Expect to see the first two events triggered.
    $edit = [
      'status' => 'processing',
    ];
    $this
      ->drupalGet('admin/store/orders/' . $order
      ->id());
    $this
      ->submitForm($edit, 'Update');
    $assert
      ->pageTextContains('Order updated.');
    $assert
      ->pageTextContains($message[1], '"' . $message[1] . '" IS shown');
    $assert
      ->pageTextContains($message[2], '"' . $message[2] . '" IS shown');
    $assert
      ->pageTextNotContains($message[3], '"' . $message[3] . '" is not shown');
    $assert
      ->pageTextNotContains($message[4], '"' . $message[4] . '" is not shown');

    // Add an order comment. Expect to see the second event triggered.
    $edit = [
      'order_comment' => $this
        ->randomString(30),
    ];
    $this
      ->drupalGet('admin/store/orders/' . $order
      ->id());
    $this
      ->submitForm($edit, 'Update');
    $assert
      ->pageTextContains('Order updated.');
    $assert
      ->pageTextNotContains($message[1], '"' . $message[1] . '" is not shown');
    $assert
      ->pageTextContains($message[2], '"' . $message[2] . '" IS shown');
    $assert
      ->pageTextNotContains($message[3], '"' . $message[3] . '" is not shown');
    $assert
      ->pageTextNotContains($message[4], '"' . $message[4] . '" is not shown');

    // Add an admin order comment. Expect to see the second event triggered.
    $edit = [
      'admin_comment' => $this
        ->randomString(30),
    ];
    $this
      ->drupalGet('admin/store/orders/' . $order
      ->id());
    $this
      ->submitForm($edit, 'Update');
    $assert
      ->pageTextContains('Order updated.');
    $assert
      ->pageTextNotContains($message[1], '"' . $message[1] . '" is not shown');
    $assert
      ->pageTextContains($message[2], '"' . $message[2] . '" IS shown');
    $assert
      ->pageTextNotContains($message[3], '"' . $message[3] . '" is not shown');
    $assert
      ->pageTextNotContains($message[4], '"' . $message[4] . '" is not shown');

    // Change order status with 'Send e-mail notification on update' checked.
    // Expect to see the first, second, AND third event triggered.
    $edit = [
      'status' => 'completed',
      'notify' => 1,
    ];
    $this
      ->drupalGet('admin/store/orders/' . $order
      ->id());
    $this
      ->submitForm($edit, 'Update');
    $assert
      ->pageTextContains('Order updated.');
    $assert
      ->pageTextContains($message[1], '"' . $message[1] . '" IS shown');
    $assert
      ->pageTextContains($message[2], '"' . $message[2] . '" IS shown');
    $assert
      ->pageTextContains($message[3], '"' . $message[3] . '" IS shown');
    $assert
      ->pageTextNotContains($message[4], '"' . $message[4] . '" is not shown');

    // Delete this order. Expect to see the fourth event triggered.
    $this
      ->drupalGet('admin/store/orders/view');
    $this
      ->clickLink('Delete');
    $assert
      ->addressEquals('admin/store/orders/' . $order
      ->id() . '/delete');
    $assert
      ->pageTextContains('Are you sure you want to delete order ' . $order
      ->id() . '?');
    $this
      ->submitForm([], 'Delete');
    $assert
      ->pageTextContains('Order ' . $order
      ->id() . ' completely removed from the database.');
    $assert
      ->pageTextNotContains($message[1], '"' . $message[1] . '" is not shown');
    $assert
      ->pageTextNotContains($message[2], '"' . $message[2] . '" is not shown');
    $assert
      ->pageTextNotContains($message[3], '"' . $message[3] . '" is not shown');
    $assert
      ->pageTextContains($message[4], '"' . $message[4] . '" IS shown');
  }

}

Classes

Name	Description
OrderRulesEventsTest	Tests the four events that uc_order provides for use in Rules module.