You are here

class SchedulerHooksTest in Scheduler 2.x

Tests the API hook functions of the Scheduler module.

This class covers the eight hook functions that Scheduler provides, allowing other modules to interact with editting, scheduling and processing via cron.

@group scheduler

Hierarchy

Expanded class hierarchy of SchedulerHooksTest

File

tests/src/Functional/SchedulerHooksTest.php, line 17

Namespace

Drupal\Tests\scheduler\Functional
View source
class SchedulerHooksTest extends SchedulerBrowserTestBase {

  /**
   * Additional modules required.
   *
   * @var array
   *
   * @todo 'menu_ui' is in the exported node.type definition, and 'path' is in
   * the entity_form_display. Could these be removed from the config files and
   * then not needed here?
   */
  protected static $modules = [
    'scheduler_api_test',
    'menu_ui',
    'path',
  ];

  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    parent::setUp();

    // Load the custom node type. These entity types are enabled for Scheduler
    // automatically as that is pre-configured in the {type}.yml files.
    $customNodeName = 'scheduler_api_node_test';
    $customNodetype = NodeType::load($customNodeName);

    // Check that the custom node type has loaded OK.
    $this
      ->assertNotNull($customNodetype, "Custom node type {$customNodeName} failed to load during setUp");

    // Load the custom media type.
    $customMediaName = 'scheduler_api_media_test';
    $customMediatype = MediaType::load($customMediaName);

    // Check that the custom media type has loaded OK.
    $this
      ->assertNotNull($customMediatype, "Custom media type {$customMediaName} failed to load during setUp");

    // Load the custom product type.
    $customProductName = 'scheduler_api_product_test';
    $customProductType = ProductType::load($customProductName);

    // Check that the custom product type has loaded OK.
    $this
      ->assertNotNull($customProductType, "Custom product type {$customProductName} failed to load during setUp");

    // Create a web user that has permission to create and edit and schedule
    // the custom entity types.
    $this->webUser = $this
      ->drupalCreateUser([
      "create {$customNodeName} content",
      "edit any {$customNodeName} content",
      'schedule publishing of nodes',
      "create {$customMediaName} media",
      "edit any {$customMediaName} media",
      'schedule publishing of media',
      "create {$customProductName} commerce_product",
      "update any {$customProductName} commerce_product",
      'schedule publishing of commerce_product',
      // 'administer commerce_store' is needed to see and use any store, i.e
      // cannot add a product without this. Is it a bug?
      'administer commerce_store',
    ]);
    $this->webUser
      ->set('name', 'Wenlock the Web user')
      ->save();
  }

  /**
   * Provides test data containing the custom entity types.
   *
   * @return array
   *   Each array item has the values: [entity type id, bundle id].
   */
  public function dataCustomEntityTypes() {
    $data = [
      '#node' => [
        'node',
        'scheduler_api_node_test',
      ],
      '#media' => [
        'media',
        'scheduler_api_media_test',
      ],
      '#commerce_product' => [
        'commerce_product',
        'scheduler_api_product_test',
      ],
    ];
    return $data;
  }

  /**
   * Covers hook_scheduler_list() and hook_scheduler_{type}_list()
   *
   * These hooks allow other modules to add more entity ids into the list being
   * processed. In real scenarios, the third-party module would likely have more
   * complex data structures and/or tables from which to identify the ids to
   * add. In this test, to keep it simple, we identify entities simply by title.
   *
   * @dataProvider dataStandardEntityTypes()
   */
  public function testList($entityTypeId, $bundle) {
    $storage = $this
      ->entityStorageObject($entityTypeId);
    $this
      ->drupalLogin($this->schedulerUser);

    // Create test entities using the standard scheduler test entity types.
    // Entity 1 is not published and has no publishing date set. The test API
    // module will add this entity into the list to be published using an
    // implementation of general hook_scheduler_list() function. Entity 2 is
    // similar but will be added via the hook_scheduler_{type}_list() function.
    $entity1 = $this
      ->createEntity($entityTypeId, $bundle, [
      'status' => FALSE,
      'title' => "Pink {$entityTypeId} list publish me",
    ]);
    $entity2 = $this
      ->createEntity($entityTypeId, $bundle, [
      'status' => FALSE,
      'title' => "Purple {$entityTypeId} list publish me",
    ]);

    // Entity 3 is published and has no unpublishing date set. The test API
    // module will add this entity into the list to be unpublished.
    $entity3 = $this
      ->createEntity($entityTypeId, $bundle, [
      'status' => TRUE,
      'title' => "Pink {$entityTypeId} list unpublish me",
    ]);
    $entity4 = $this
      ->createEntity($entityTypeId, $bundle, [
      'status' => TRUE,
      'title' => "Purple {$entityTypeId} list unpublish me",
    ]);

    // Before cron, check that entity 1 and 2 are unpublished and entity 3 and 4
    // are published.
    $this
      ->assertFalse($entity1
      ->isPublished(), "Before cron, {$entityTypeId} 1 '{$entity1->label()}' should be unpublished.");
    $this
      ->assertFalse($entity2
      ->isPublished(), "Before cron, {$entityTypeId} 2 '{$entity2->label()}' should be unpublished.");
    $this
      ->assertTrue($entity3
      ->isPublished(), "Before cron, {$entityTypeId} 3 '{$entity3->label()}' should be published.");
    $this
      ->assertTrue($entity4
      ->isPublished(), "Before cron, {$entityTypeId} 4 '{$entity4->label()}' should be published.");

    // Run cron and refresh the entities.
    scheduler_cron();
    $storage
      ->resetCache();
    for ($i = 1; $i <= 4; $i++) {
      ${"entity{$i}"} = $storage
        ->load(${"entity{$i}"}
        ->id());
    }

    // Check tha entity 1 and 2 have been published.
    $this
      ->assertTrue($entity1
      ->isPublished(), "After cron, {$entityTypeId} 1 '{$entity1->label()}' should be published.");
    $this
      ->assertTrue($entity2
      ->isPublished(), "After cron, {$entityTypeId} 2 '{$entity2->label()}' should be published.");

    // Check that entity 3 and 4 have been unpublished.
    $this
      ->assertFalse($entity3
      ->isPublished(), "After cron, {$entityTypeId} 3 '{$entity3->label()}' should be unpublished.");
    $this
      ->assertFalse($entity4
      ->isPublished(), "After cron, {$entityTypeId} 4 '{$entity4->label()}' should be unpublished.");
  }

  /**
   * Covers hook_scheduler_list_alter() and hook_scheduler_{type}_list_alter()
   *
   * These hook allows other modules to add or remove entity ids from the list
   * to be processed.
   *
   * @dataProvider dataStandardEntityTypes()
   */
  public function testListAlter($entityTypeId, $bundle) {
    $storage = $this
      ->entityStorageObject($entityTypeId);
    $this
      ->drupalLogin($this->schedulerUser);

    // Create test entities using the standard scheduler test entity types.
    // Entity 1 is set for scheduled publishing, but will be removed by the test
    // API generic hook_scheduler_list_alter() function. Entity 2 is similar but
    // is removed via the specifc hook_scheduler_{type}_list_alter() function.
    $entity1 = $this
      ->createEntity($entityTypeId, $bundle, [
      'status' => FALSE,
      'title' => "Pink {$entityTypeId} list_alter do not publish me",
      'publish_on' => strtotime('-1 day'),
    ]);
    $entity2 = $this
      ->createEntity($entityTypeId, $bundle, [
      'status' => FALSE,
      'title' => "Purple {$entityTypeId} list_alter do not publish me",
      'publish_on' => strtotime('-1 day'),
    ]);

    // Entity 3 is not published and has no publishing date set. The test module
    // generic hook_scheduler_list_alter() function will add a date and add the
    // id into the list to be published. Entity 4 is similar but the date and id
    // is added by the specifc hook_scheduler_{type}_list_alter() function.
    $entity3 = $this
      ->createEntity($entityTypeId, $bundle, [
      'status' => FALSE,
      'title' => "Pink {$entityTypeId} list_alter publish me",
    ]);
    $entity4 = $this
      ->createEntity($entityTypeId, $bundle, [
      'status' => FALSE,
      'title' => "Purple {$entityTypeId} list_alter publish me",
    ]);

    // Entity 5 is set for scheduled unpublishing, but will be removed by the
    // generic hook_scheduler_list_alter() function. Entity 6 is similar but is
    // removed by the specifc hook_scheduler_{type}_list_alter() function.
    $entity5 = $this
      ->createEntity($entityTypeId, $bundle, [
      'status' => TRUE,
      'title' => "Pink {$entityTypeId} list_alter do not unpublish me",
      'unpublish_on' => strtotime('-1 day'),
    ]);
    $entity6 = $this
      ->createEntity($entityTypeId, $bundle, [
      'status' => TRUE,
      'title' => "Purple {$entityTypeId} list_alter do not unpublish me",
      'unpublish_on' => strtotime('-1 day'),
    ]);

    // Entity 7 is published and has no unpublishing date set. The generic
    // hook_scheduler_list_alter() will add a date and add the id into the list
    // to be unpublished. Entity 8 is similar but the date and id will be added
    // by the specifc hook_scheduler_{type}_list_alter() function.
    $entity7 = $this
      ->createEntity($entityTypeId, $bundle, [
      'status' => TRUE,
      'title' => "Pink {$entityTypeId} list_alter unpublish me",
    ]);
    $entity8 = $this
      ->createEntity($entityTypeId, $bundle, [
      'status' => TRUE,
      'title' => "Purple {$entityTypeId} list_alter unpublish me",
    ]);

    // Before cron, check entities 1-4 are unpublished and 5-8 are published.
    $this
      ->assertFalse($entity1
      ->isPublished(), "Before cron, {$entityTypeId} 1 '{$entity1->label()}' should be unpublished.");
    $this
      ->assertFalse($entity2
      ->isPublished(), "Before cron, {$entityTypeId} 2 '{$entity2->label()}' should be unpublished.");
    $this
      ->assertFalse($entity3
      ->isPublished(), "Before cron, {$entityTypeId} 3 '{$entity3->label()}' should be unpublished.");
    $this
      ->assertFalse($entity4
      ->isPublished(), "Before cron, {$entityTypeId} 4 '{$entity4->label()}' should be unpublished.");
    $this
      ->assertTrue($entity5
      ->isPublished(), "Before cron, {$entityTypeId} 5 '{$entity5->label()}' should be published.");
    $this
      ->assertTrue($entity6
      ->isPublished(), "Before cron, {$entityTypeId} 6 '{$entity6->label()}' should be published.");
    $this
      ->assertTrue($entity7
      ->isPublished(), "Before cron, {$entityTypeId} 7 '{$entity7->label()}' should be published.");
    $this
      ->assertTrue($entity8
      ->isPublished(), "Before cron, {$entityTypeId} 8 '{$entity8->label()}' should be published.");

    // Run cron and refresh the entities from storage.
    scheduler_cron();
    $storage
      ->resetCache();
    for ($i = 1; $i <= 8; $i++) {
      ${"entity{$i}"} = $storage
        ->load(${"entity{$i}"}
        ->id());
    }

    // After cron, check that entities 1-2 remain unpublished, 3-4 have now
    // been published, 5-6 remain published and 7-8 have been unpublished.
    $this
      ->assertFalse($entity1
      ->isPublished(), "After cron, {$entityTypeId} 1 '{$entity1->label()}' should be unpublished.");
    $this
      ->assertFalse($entity2
      ->isPublished(), "After cron, {$entityTypeId} 2 '{$entity2->label()}' should be unpublished.");
    $this
      ->assertTrue($entity3
      ->isPublished(), "After cron, {$entityTypeId} 3 '{$entity3->label()}' should be published.");
    $this
      ->assertTrue($entity4
      ->isPublished(), "After cron, {$entityTypeId} 4 '{$entity4->label()}' should be published.");
    $this
      ->assertTrue($entity5
      ->isPublished(), "After cron, {$entityTypeId} 5 '{$entity5->label()}' should be published.");
    $this
      ->assertTrue($entity6
      ->isPublished(), "After cron, {$entityTypeId} 6 '{$entity6->label()}' should be published.");
    $this
      ->assertFalse($entity7
      ->isPublished(), "After cron, {$entityTypeId} 7 '{$entity7->label()}' should be unpublished.");
    $this
      ->assertFalse($entity8
      ->isPublished(), "After cron, {$entityTypeId} 8 '{$entity8->label()}' should be unpublished.");
  }

  /**
   * Covers hook_scheduler_{type}_publishing_allowed()
   *
   * This hook is used to deny the publishing of individual entities. The test
   * uses the customised content type which has checkboxes 'Approved for
   * publishing' and 'Approved for unpublishing'.
   *
   * @dataProvider dataCustomEntityTypes()
   */
  public function testPublishingAllowed($entityTypeId, $bundle) {
    $storage = $this
      ->entityStorageObject($entityTypeId);
    $titleField = $entityTypeId == 'media' ? 'name' : 'title';
    $this
      ->drupalLogin($this->webUser);

    // Check the 'approved for publishing' field is shown on the entity form.
    $this
      ->drupalGet($this
      ->entityAddUrl($entityTypeId, $bundle));
    $this
      ->assertSession()
      ->fieldExists('edit-field-approved-publishing-value');

    // Check that the message is shown when scheduling an entity for publishing
    // which is not yet allowed to be published.
    $edit = [
      "{$titleField}[0][value]" => "Blue {$entityTypeId} - Set publish-on date without approval",
      'publish_on[0][value][date]' => date('Y-m-d', time() + 3),
      'publish_on[0][value][time]' => date('H:i:s', time() + 3),
    ];
    $this
      ->submitForm($edit, 'Save');
    $this
      ->assertSession()
      ->pageTextMatches('/is scheduled for publishing.* but will not be published until approved/');

    // Create an entity that is scheduled but not approved for publishing. Then
    // run cron for scheduler, and check that the entity is still not published.
    $entity = $this
      ->createUnapprovedEntity($entityTypeId, $bundle, 'publish_on');
    scheduler_cron();
    $storage
      ->resetCache([
      $entity
        ->id(),
    ]);
    $entity = $storage
      ->load($entity
      ->id());
    $this
      ->assertFalse($entity
      ->isPublished(), "Unapproved '{$entity->label()}' should not be published during cron processing.");

    // Create an entity and approve it for publishing, run cron for scheduler
    // and check that the entity is published. This is a stronger test than
    // simply approving the previously used entity above, as we do not know what
    // publish state that may be in after the cron run above.
    $entity = $this
      ->createUnapprovedEntity($entityTypeId, $bundle, 'publish_on');
    $this
      ->approveEntity($entityTypeId, $entity
      ->id(), 'field_approved_publishing');
    $this
      ->assertFalse($entity
      ->isPublished(), "New approved '{$entity->label()}' should not be initially published.");
    scheduler_cron();
    $storage
      ->resetCache([
      $entity
        ->id(),
    ]);
    $entity = $storage
      ->load($entity
      ->id());
    $this
      ->assertTrue($entity
      ->isPublished(), "Approved '{$entity->label()}' should be published during cron processing.");

    // Turn on immediate publishing when the date is in the past and repeat
    // the tests. It is not needed to run cron jobs here.
    $bundle_field_name = $entity
      ->getEntityType()
      ->get('entity_keys')['bundle'];
    $entity->{$bundle_field_name}->entity
      ->setThirdPartySetting('scheduler', 'publish_past_date', 'publish')
      ->save();

    // Check that an entity can be approved and published programatically.
    $entity = $this
      ->createUnapprovedEntity($entityTypeId, $bundle, 'publish_on');
    $this
      ->assertFalse($entity
      ->isPublished(), "New unapproved '{$entity->label()}' with a date in the past should not be published immediately after saving.");
    $this
      ->approveEntity($entityTypeId, $entity
      ->id(), 'field_approved_publishing');
    $storage
      ->resetCache([
      $entity
        ->id(),
    ]);
    $entity = $storage
      ->load($entity
      ->id());
    $this
      ->assertTrue($entity
      ->isPublished(), "New approved '{$entity->label()}' with a date in the past should be published immediately when created programatically.");

    // Check that an entity can be approved and published via edit form.
    $entity = $this
      ->createUnapprovedEntity($entityTypeId, $bundle, 'publish_on');
    $this
      ->drupalGet($entity
      ->toUrl('edit-form'));
    $this
      ->submitForm([
      'field_approved_publishing[value]' => '1',
    ], 'Save');
    $storage
      ->resetCache([
      $entity
        ->id(),
    ]);
    $entity = $storage
      ->load($entity
      ->id());
    $this
      ->assertTrue($entity
      ->isPublished(), "Approved '{$entity->label()}' with a date in the past is published immediately after saving via edit form.");
  }

  /**
   * Covers hook_scheduler_{type}_unpublishing_allowed()
   *
   * This hook is used to deny the unpublishing of individual entities. This
   * test is simpler than the test sequence for allowed publishing, because the
   * past date 'publish' option is not applicable.
   *
   * @dataProvider dataCustomEntityTypes()
   */
  public function testUnpublishingAllowed($entityTypeId, $bundle) {
    $storage = $this
      ->entityStorageObject($entityTypeId);
    $titleField = $entityTypeId == 'media' ? 'name' : 'title';
    $this
      ->drupalLogin($this->webUser);

    // Check the 'approved for unpublishing' field is shown on the entity form.
    $this
      ->drupalGet($this
      ->entityAddUrl($entityTypeId, $bundle));
    $this
      ->assertSession()
      ->fieldExists('edit-field-approved-unpublishing-value');

    // Check that the message is shown when scheduling an entity for
    // unpublishing which is not yet allowed to be unpublished.
    $edit = [
      "{$titleField}[0][value]" => "Red {$entityTypeId} - Set unpublish-on date without approval",
      'unpublish_on[0][value][date]' => date('Y-m-d', time() + 3),
      'unpublish_on[0][value][time]' => date('H:i:s', time() + 3),
    ];
    $this
      ->submitForm($edit, 'Save');
    $this
      ->assertSession()
      ->pageTextMatches('/is scheduled for unpublishing.* but will not be unpublished until approved/');

    // Create an entity that is scheduled but not approved for unpublishing, run
    // cron for scheduler, and check that the entity is still published.
    $entity = $this
      ->createUnapprovedEntity($entityTypeId, $bundle, 'unpublish_on');
    scheduler_cron();
    $storage
      ->resetCache([
      $entity
        ->id(),
    ]);
    $entity = $storage
      ->load($entity
      ->id());
    $this
      ->assertTrue($entity
      ->isPublished(), "Unapproved '{$entity->label()}' should not be unpublished during cron processing.");

    // Create an entity and approve it for unpublishing, run cron for scheduler
    // and check that the entity is unpublished.
    $entity = $this
      ->createUnapprovedEntity($entityTypeId, $bundle, 'unpublish_on');
    $this
      ->approveEntity($entityTypeId, $entity
      ->id(), 'field_approved_unpublishing');
    $this
      ->assertTrue($entity
      ->isPublished(), "New approved '{$entity->label()}' should initially remain published.");
    scheduler_cron();
    $storage
      ->resetCache([
      $entity
        ->id(),
    ]);
    $entity = $storage
      ->load($entity
      ->id());
    $this
      ->assertFalse($entity
      ->isPublished(), "Approved '{$entity->label()}' should be unpublished during cron processing.");
  }

  /**
   * Creates a new entity that is not approved.
   *
   * The entity will have a publish/unpublish date in the past to make sure it
   * will be included in the next cron run.
   *
   * @param string $entityTypeId
   *   The entity type to create, 'node' or 'media'.
   * @param string $bundle
   *   The bundle to create, 'scheduler_api_test' or 'scheduler_api_media_test'.
   * @param string $date_field
   *   The Scheduler date field to set, either 'publish_on' or 'unpublish_on'.
   *
   * @return \Drupal\Core\Entity\EntityInterface
   *   The created entity object.
   */
  protected function createUnapprovedEntity($entityTypeId, $bundle, $date_field) {
    $settings = [
      'title' => ($date_field == 'publish_on' ? 'Blue' : 'Red') . " {$entityTypeId} {$this->randomMachineName(10)}",
      'status' => $date_field == 'unpublish_on',
      $date_field => strtotime('-1 day'),
      'field_approved_publishing' => 0,
      'field_approved_unpublishing' => 0,
    ];
    return $this
      ->createEntity($entityTypeId, $bundle, $settings);
  }

  /**
   * Approves an entity for publication or unpublication.
   *
   * @param string $entityTypeId
   *   The entity type to approve, 'node' or 'media'.
   * @param int $id
   *   The id of the entity to approve.
   * @param string $field_name
   *   The name of the field to set, either 'field_approved_publishing' or
   *   'field_approved_unpublishing'.
   */
  protected function approveEntity($entityTypeId, $id, $field_name) {
    $storage = $this
      ->entityStorageObject($entityTypeId);
    $storage
      ->resetCache([
      $id,
    ]);
    $entity = $storage
      ->load($id);
    $entity
      ->set($field_name, TRUE);
    $label_field = $entity
      ->getEntityType()
      ->get('entity_keys')['label'];
    $entity
      ->set($label_field, $entity
      ->label() . " - approved for publishing: {$entity->field_approved_publishing->value}, for unpublishing: {$entity->field_approved_unpublishing->value}")
      ->save();
  }

  /**
   * Tests the hooks which allow hiding of scheduler input fields.
   *
   * This test covers:
   *   hook_scheduler_hide_publish_date()
   *   hook_scheduler_hide_unpublish_date()
   *   hook_scheduler_{type}_hide_publish_date()
   *   hook_scheduler_{type}_hide_unpublish_date()
   *
   * @dataProvider dataStandardEntityTypes()
   */
  public function testHideDateField($entityTypeId, $bundle) {
    $this
      ->drupalLogin($this->schedulerUser);

    // Create test entities.
    $entity1 = $this
      ->createEntity($entityTypeId, $bundle, [
      'title' => "Red {$entityTypeId} will have neither field hidden",
    ]);
    $entity2 = $this
      ->createEntity($entityTypeId, $bundle, [
      'title' => "Orange {$entityTypeId} will have the publish-on field hidden",
    ]);
    $entity3 = $this
      ->createEntity($entityTypeId, $bundle, [
      'title' => "Yellow {$entityTypeId} will have the unpublish-on field hidden",
    ]);
    $entity4 = $this
      ->createEntity($entityTypeId, $bundle, [
      'title' => "Green {$entityTypeId} will have both Scheduler fields hidden",
    ]);

    // Set the scheduler fieldset to always expand, for ease during development.
    $bundle_field_name = $entity1
      ->getEntityType()
      ->get('entity_keys')['bundle'];
    $entity1->{$bundle_field_name}->entity
      ->setThirdPartySetting('scheduler', 'expand_fieldset', 'always')
      ->save();

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

    // Entity 1 'Red' should have both fields displayed.
    $this
      ->drupalGet($entity1
      ->toUrl('edit-form'));
    $assert
      ->ElementExists('xpath', '//input[@id = "edit-publish-on-0-value-date"]');
    $assert
      ->ElementExists('xpath', '//input[@id = "edit-unpublish-on-0-value-date"]');

    // Entity 2 'Orange' should have only the publish-on field hidden.
    $this
      ->drupalGet($entity2
      ->toUrl('edit-form'));
    $assert
      ->ElementNotExists('xpath', '//input[@id = "edit-publish-on-0-value-date"]');
    $assert
      ->ElementExists('xpath', '//input[@id = "edit-unpublish-on-0-value-date"]');

    // Entity 3 'Yellow' should have only the unpublish-on field hidden.
    $this
      ->drupalGet($entity3
      ->toUrl('edit-form'));
    $assert
      ->ElementExists('xpath', '//input[@id = "edit-publish-on-0-value-date"]');
    $assert
      ->ElementNotExists('xpath', '//input[@id = "edit-unpublish-on-0-value-date"]');

    // Entity 4 'Green' should have both publish-on and unpublish-on hidden.
    $this
      ->drupalGet($entity4
      ->toUrl('edit-form'));
    $assert
      ->ElementNotExists('xpath', '//input[@id = "edit-publish-on-0-value-date"]');
    $assert
      ->ElementNotExists('xpath', '//input[@id = "edit-unpublish-on-0-value-date"]');
  }

  /**
   * Tests when other modules execute the 'publish' and 'unpublish' processes.
   *
   * This test covers:
   *   hook_scheduler_publish_process()
   *   hook_scheduler_unpublish_process()
   *   hook_scheduler_{type}_publish_process()
   *   hook_scheduler_{type}_unpublish_process()
   *
   * @dataProvider dataStandardEntityTypes()
   */
  public function testPublishUnpublishProcess($entityTypeId, $bundle) {

    // $this->drupalLogin($this->schedulerUser);
    $storage = $this
      ->entityStorageObject($entityTypeId);

    // Create test entities.
    $entity1 = $this
      ->createEntity($entityTypeId, $bundle, [
      'status' => FALSE,
      'title' => "Red {$entityTypeId} will cause a failure on publishing",
      'publish_on' => strtotime('-1 day'),
    ]);
    $entity2 = $this
      ->createEntity($entityTypeId, $bundle, [
      'status' => TRUE,
      'title' => "Orange {$entityTypeId} will be unpublished by the API test module not Scheduler",
      'unpublish_on' => strtotime('-1 day'),
    ]);
    $entity3 = $this
      ->createEntity($entityTypeId, $bundle, [
      'status' => FALSE,
      'title' => "Yellow {$entityTypeId} will be published by the API test module not Scheduler",
      'publish_on' => strtotime('-1 day'),
    ]);

    // 'Green' will have both fields hidden so is harder to test manually.
    // Therefore introduce a different colour - Blue.
    $entity4 = $this
      ->createEntity($entityTypeId, $bundle, [
      'status' => TRUE,
      'title' => "Blue {$entityTypeId} will cause a failure on unpublishing",
      'unpublish_on' => strtotime('-1 day'),
    ]);

    // Simulate a cron run.
    scheduler_cron();

    // Check red.
    $storage
      ->resetCache([
      $entity1
        ->id(),
    ]);
    $entity1 = $storage
      ->load($entity1
      ->id());
    $this
      ->assertFalse($entity1
      ->isPublished(), 'Red should remain unpublished.');
    $this
      ->assertNotEmpty($entity1->publish_on->value, 'Red should still have a publish-on date.');

    // Check orange.
    $storage
      ->resetCache([
      $entity2
        ->id(),
    ]);
    $entity2 = $storage
      ->load($entity2
      ->id());
    $this
      ->assertFalse($entity2
      ->isPublished(), 'Orange should be unpublished.');
    $this
      ->assertStringContainsString('unpublishing processed by API test module', $entity2
      ->label(), 'Orange should be processed by the API test module.');
    $this
      ->assertEmpty($entity2->unpublish_on->value, 'Orange should not have an unpublish-on date.');

    // Check yellow.
    $storage
      ->resetCache([
      $entity3
        ->id(),
    ]);
    $entity3 = $storage
      ->load($entity3
      ->id());
    $this
      ->assertTrue($entity3
      ->isPublished(), 'Yellow should be published.');
    $this
      ->assertStringContainsString('publishing processed by API test module', $entity3
      ->label(), 'Yellow should be processed by the API test module.');
    $this
      ->assertEmpty($entity3->publish_on->value, 'Yellow should not have a publish-on date.');

    // Check blue.
    $storage
      ->resetCache([
      $entity4
        ->id(),
    ]);
    $entity4 = $storage
      ->load($entity4
      ->id());
    $this
      ->assertTrue($entity4
      ->isPublished(), 'Blue should remain published.');
    $this
      ->assertNotEmpty($entity4->unpublish_on->value, 'Blue should still have an unpublish-on date.');
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AssertLegacyTrait::assert Deprecated protected function
AssertLegacyTrait::assertCacheTag Deprecated protected function Asserts whether an expected cache tag was present in the last response.
AssertLegacyTrait::assertElementNotPresent Deprecated protected function Asserts that the element with the given CSS selector is not present.
AssertLegacyTrait::assertElementPresent Deprecated protected function Asserts that the element with the given CSS selector is present.
AssertLegacyTrait::assertEqual Deprecated protected function
AssertLegacyTrait::assertEscaped Deprecated protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertLegacyTrait::assertField Deprecated protected function Asserts that a field exists with the given name or ID.
AssertLegacyTrait::assertFieldById Deprecated protected function Asserts that a field exists with the given ID and value.
AssertLegacyTrait::assertFieldByName Deprecated protected function Asserts that a field exists with the given name and value.
AssertLegacyTrait::assertFieldByXPath Deprecated protected function Asserts that a field exists in the current page by the given XPath.
AssertLegacyTrait::assertFieldChecked Deprecated protected function Asserts that a checkbox field in the current page is checked.
AssertLegacyTrait::assertFieldsByValue Deprecated protected function Asserts that a field exists in the current page with a given Xpath result.
AssertLegacyTrait::assertHeader Deprecated protected function Checks that current response header equals value.
AssertLegacyTrait::assertIdentical Deprecated protected function
AssertLegacyTrait::assertIdenticalObject Deprecated protected function
AssertLegacyTrait::assertLink Deprecated protected function Passes if a link with the specified label is found.
AssertLegacyTrait::assertLinkByHref Deprecated protected function Passes if a link containing a given href (part) is found.
AssertLegacyTrait::assertNoCacheTag Deprecated protected function Asserts whether an expected cache tag was absent in the last response.
AssertLegacyTrait::assertNoEscaped Deprecated protected function Passes if the raw text is not found escaped on the loaded page.
AssertLegacyTrait::assertNoField Deprecated protected function Asserts that a field does NOT exist with the given name or ID.
AssertLegacyTrait::assertNoFieldById Deprecated protected function Asserts that a field does not exist with the given ID and value.
AssertLegacyTrait::assertNoFieldByName Deprecated protected function Asserts that a field does not exist with the given name and value.
AssertLegacyTrait::assertNoFieldByXPath Deprecated protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertLegacyTrait::assertNoFieldChecked Deprecated protected function Asserts that a checkbox field in the current page is not checked.
AssertLegacyTrait::assertNoLink Deprecated protected function Passes if a link with the specified label is not found.
AssertLegacyTrait::assertNoLinkByHref Deprecated protected function Passes if a link containing a given href (part) is not found.
AssertLegacyTrait::assertNoOption Deprecated protected function Asserts that a select option does NOT exist in the current page.
AssertLegacyTrait::assertNoPattern Deprecated protected function Triggers a pass if the Perl regex pattern is not found in the raw content.
AssertLegacyTrait::assertNoRaw Deprecated protected function Passes if the raw text IS not found on the loaded page, fail otherwise.
AssertLegacyTrait::assertNotEqual Deprecated protected function
AssertLegacyTrait::assertNoText Deprecated protected function Passes if the page (with HTML stripped) does not contains the text.
AssertLegacyTrait::assertNotIdentical Deprecated protected function
AssertLegacyTrait::assertNoUniqueText Deprecated protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertLegacyTrait::assertOption Deprecated protected function Asserts that a select option in the current page exists.
AssertLegacyTrait::assertOptionByText Deprecated protected function Asserts that a select option with the visible text exists.
AssertLegacyTrait::assertOptionSelected Deprecated protected function Asserts that a select option in the current page is checked.
AssertLegacyTrait::assertPattern Deprecated protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertLegacyTrait::assertRaw Deprecated protected function Passes if the raw text IS found on the loaded page, fail otherwise.
AssertLegacyTrait::assertResponse Deprecated protected function Asserts the page responds with the specified response code.
AssertLegacyTrait::assertText Deprecated protected function Passes if the page (with HTML stripped) contains the text.
AssertLegacyTrait::assertTextHelper Deprecated protected function Helper for assertText and assertNoText.
AssertLegacyTrait::assertTitle Deprecated protected function Pass if the page title is the given string.
AssertLegacyTrait::assertUniqueText Deprecated protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertLegacyTrait::assertUrl Deprecated protected function Passes if the internal browser's URL matches the given path.
AssertLegacyTrait::buildXPathQuery Deprecated protected function Builds an XPath query.
AssertLegacyTrait::constructFieldXpath Deprecated protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertLegacyTrait::getAllOptions Deprecated protected function Get all option elements, including nested options, in a select.
AssertLegacyTrait::getRawContent Deprecated protected function Gets the current raw content.
AssertLegacyTrait::pass Deprecated protected function
AssertLegacyTrait::verbose Deprecated protected function
BlockCreationTrait::placeBlock protected function Creates a block instance based on default settings. Aliased as: drupalPlaceBlock
BrowserHtmlDebugTrait::$htmlOutputBaseUrl protected property The Base URI to use for links to the output files.
BrowserHtmlDebugTrait::$htmlOutputClassName protected property Class name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounter protected property Counter for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounterStorage protected property Counter storage for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputDirectory protected property Directory name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputEnabled protected property HTML output output enabled.
BrowserHtmlDebugTrait::$htmlOutputFile protected property The file name to write the list of URLs to.
BrowserHtmlDebugTrait::$htmlOutputTestId protected property HTML output test ID.
BrowserHtmlDebugTrait::formatHtmlOutputHeaders protected function Formats HTTP headers as string for HTML output logging.
BrowserHtmlDebugTrait::getHtmlOutputHeaders protected function Returns headers in HTML output format. 1
BrowserHtmlDebugTrait::getResponseLogHandler protected function Provides a Guzzle middleware handler to log every response received.
BrowserHtmlDebugTrait::htmlOutput protected function Logs a HTML output message in a text file.
BrowserHtmlDebugTrait::initBrowserOutputFile protected function Creates the directory to store browser output.
BrowserTestBase::$baseUrl protected property The base URL.
BrowserTestBase::$configImporter protected property The config importer that can be used in a test.
BrowserTestBase::$customTranslations protected property An array of custom translations suitable for drupal_rewrite_settings().
BrowserTestBase::$databasePrefix protected property The database prefix of this test run.
BrowserTestBase::$mink protected property Mink session manager.
BrowserTestBase::$minkDefaultDriverArgs protected property Mink default driver params.
BrowserTestBase::$minkDefaultDriverClass protected property Mink class for the default driver to use. 1
BrowserTestBase::$originalContainer protected property The original container.
BrowserTestBase::$originalShutdownCallbacks protected property The original array of shutdown function callbacks.
BrowserTestBase::$preserveGlobalState protected property
BrowserTestBase::$root protected property The app root.
BrowserTestBase::$runTestInSeparateProcess protected property Browser tests are run in separate processes to prevent collisions between code that may be loaded by tests.
BrowserTestBase::$timeLimit protected property Time limit in seconds for the test.
BrowserTestBase::$translationFilesDirectory protected property The translation file directory for the test environment.
BrowserTestBase::cleanupEnvironment protected function Clean up the Simpletest environment.
BrowserTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
BrowserTestBase::drupalGetHeader Deprecated protected function Gets the value of an HTTP response header.
BrowserTestBase::filePreDeleteCallback public static function Ensures test files are deletable.
BrowserTestBase::getDefaultDriverInstance protected function Gets an instance of the default Mink driver.
BrowserTestBase::getDrupalSettings protected function Gets the JavaScript drupalSettings variable for the currently-loaded page. 1
BrowserTestBase::getHttpClient protected function Obtain the HTTP client for the system under test.
BrowserTestBase::getMinkDriverArgs protected function Get the Mink driver args from an environment variable, if it is set. Can be overridden in a derived class so it is possible to use a different value for a subset of tests, e.g. the JavaScript tests. 1
BrowserTestBase::getOptions protected function Helper function to get the options of select field.
BrowserTestBase::getSession public function Returns Mink session.
BrowserTestBase::getSessionCookies protected function Get session cookies from current session.
BrowserTestBase::getTestMethodCaller protected function Retrieves the current calling line in the class under test. Overrides BrowserHtmlDebugTrait::getTestMethodCaller
BrowserTestBase::initFrontPage protected function Visits the front page when initializing Mink. 3
BrowserTestBase::initMink protected function Initializes Mink sessions. 1
BrowserTestBase::installDrupal public function Installs Drupal into the Simpletest site. 1
BrowserTestBase::registerSessions protected function Registers additional Mink sessions.
BrowserTestBase::setUpAppRoot protected function Sets up the root application path.
BrowserTestBase::setUpBeforeClass public static function 1
BrowserTestBase::tearDown protected function 3
BrowserTestBase::translatePostValues protected function Transforms a nested array into a flat array suitable for submitForm().
BrowserTestBase::xpath protected function Performs an xpath search on the contents of the internal browser.
BrowserTestBase::__sleep public function Prevents serializing any properties.
ConfigTestTrait::configImporter protected function Returns a ConfigImporter object to import test configuration.
ConfigTestTrait::copyConfig protected function Copies configuration objects from source storage to target storage.
ContentTypeCreationTrait::createContentType protected function Creates a custom content type based on default settings. Aliased as: drupalCreateContentType 1
CronRunTrait::cronRun protected function Runs cron on the test site.
ExtensionListTestTrait::getModulePath protected function Gets the path for the specified module.
ExtensionListTestTrait::getThemePath protected function Gets the path for the specified theme.
FunctionalTestSetupTrait::$apcuEnsureUniquePrefix protected property The flag to set 'apcu_ensure_unique_prefix' setting. 1
FunctionalTestSetupTrait::$classLoader protected property The class loader to use for installation and initialization of setup.
FunctionalTestSetupTrait::$rootUser protected property The "#1" admin user.
FunctionalTestSetupTrait::doInstall protected function Execute the non-interactive installer. 1
FunctionalTestSetupTrait::getDatabaseTypes protected function Returns all supported database driver installer objects.
FunctionalTestSetupTrait::initConfig protected function Initialize various configurations post-installation. 1
FunctionalTestSetupTrait::initKernel protected function Initializes the kernel after installation.
FunctionalTestSetupTrait::initSettings protected function Initialize settings created during install.
FunctionalTestSetupTrait::initUserSession protected function Initializes user 1 for the site to be installed.
FunctionalTestSetupTrait::installDefaultThemeFromClassProperty protected function Installs the default theme defined by `static::$defaultTheme` when needed.
FunctionalTestSetupTrait::installModulesFromClassProperty protected function Install modules defined by `static::$modules`. 1
FunctionalTestSetupTrait::installParameters protected function Returns the parameters that will be used when Simpletest installs Drupal. 9
FunctionalTestSetupTrait::prepareEnvironment protected function Prepares the current environment for running the test. 20
FunctionalTestSetupTrait::prepareRequestForGenerator protected function Creates a mock request and sets it on the generator.
FunctionalTestSetupTrait::prepareSettings protected function Prepares site settings and services before installation. 2
FunctionalTestSetupTrait::rebuildAll protected function Resets and rebuilds the environment after setup.
FunctionalTestSetupTrait::rebuildContainer protected function Rebuilds \Drupal::getContainer().
FunctionalTestSetupTrait::resetAll protected function Resets all data structures after having enabled new modules.
FunctionalTestSetupTrait::setContainerParameter protected function Changes parameters in the services.yml file.
FunctionalTestSetupTrait::setupBaseUrl protected function Sets up the base URL based upon the environment variable.
FunctionalTestSetupTrait::writeSettings protected function Rewrites the settings.php file of the test site. 1
MediaTypeCreationTrait::createMediaType protected function Create a media type for a source plugin.
NodeCreationTrait::createNode protected function Creates a node based on default settings. Aliased as: drupalCreateNode
NodeCreationTrait::getNodeByTitle public function Get a node from the database based on its title. Aliased as: drupalGetNodeByTitle
PhpUnitWarnings::$deprecationWarnings private static property Deprecation warnings from PHPUnit to raise with @trigger_error().
PhpUnitWarnings::addWarning public function Converts PHPUnit deprecation warnings to E_USER_DEPRECATED.
RandomGeneratorTrait::$randomGenerator protected property The random generator.
RandomGeneratorTrait::getRandomGenerator protected function Gets the random generator for the utility methods.
RandomGeneratorTrait::randomMachineName protected function Generates a unique random string containing letters and numbers. 1
RandomGeneratorTrait::randomObject public function Generates a random PHP object.
RandomGeneratorTrait::randomString public function Generates a pseudo-random string of ASCII characters of codes 32 to 126.
RandomGeneratorTrait::randomStringValidate public function Callback for random string validation.
RefreshVariablesTrait::refreshVariables protected function Refreshes in-memory configuration and state information. 1
SchedulerBrowserTestBase::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
SchedulerBrowserTestBase::$profile protected property The profile to install as a basis for testing. Overrides BrowserTestBase::$profile
SchedulerCommerceProductSetupTrait::$nonSchedulerProductType protected property The product type object which is not enabled for scheduling.
SchedulerCommerceProductSetupTrait::$nonSchedulerProductTypeLabel protected property The readable label of the product type not enabled for scheduling.
SchedulerCommerceProductSetupTrait::$nonSchedulerProductTypeName protected property The internal name of the product type not enabled for scheduling.
SchedulerCommerceProductSetupTrait::$productStorage protected property The product entity storage.
SchedulerCommerceProductSetupTrait::$productType protected property The product type object which is enabled for scheduling.
SchedulerCommerceProductSetupTrait::$productTypeLabel protected property The readable label of the standard product type for testing.
SchedulerCommerceProductSetupTrait::$productTypeName protected property The internal name of the standard product type for testing.
SchedulerCommerceProductSetupTrait::$store protected property The default commerce store to which all products are added.
SchedulerCommerceProductSetupTrait::createProduct public function Creates a product entity.
SchedulerCommerceProductSetupTrait::getProduct public function Gets a product from storage.
SchedulerCommerceProductSetupTrait::schedulerCommerceProductSetUp public function Set common properties, define content types and create users.
SchedulerHooksTest::$modules protected static property Additional modules required. Overrides SchedulerBrowserTestBase::$modules
SchedulerHooksTest::approveEntity protected function Approves an entity for publication or unpublication.
SchedulerHooksTest::createUnapprovedEntity protected function Creates a new entity that is not approved.
SchedulerHooksTest::dataCustomEntityTypes public function Provides test data containing the custom entity types.
SchedulerHooksTest::setUp protected function Overrides SchedulerBrowserTestBase::setUp
SchedulerHooksTest::testHideDateField public function Tests the hooks which allow hiding of scheduler input fields.
SchedulerHooksTest::testList public function Covers hook_scheduler_list() and hook_scheduler_{type}_list()
SchedulerHooksTest::testListAlter public function Covers hook_scheduler_list_alter() and hook_scheduler_{type}_list_alter()
SchedulerHooksTest::testPublishingAllowed public function Covers hook_scheduler_{type}_publishing_allowed()
SchedulerHooksTest::testPublishUnpublishProcess public function Tests when other modules execute the 'publish' and 'unpublish' processes.
SchedulerHooksTest::testUnpublishingAllowed public function Covers hook_scheduler_{type}_unpublishing_allowed()
SchedulerMediaSetupTrait::$mediaStorage protected property The media entity storage.
SchedulerMediaSetupTrait::$mediaType protected property The media type object which is enabled for scheduling.
SchedulerMediaSetupTrait::$mediaTypeLabel protected property The readable label of the standard media type created for testing.
SchedulerMediaSetupTrait::$mediaTypeName protected property The internal name of the standard media type created for testing.
SchedulerMediaSetupTrait::$nonSchedulerMediaType protected property The media type object which is not enabled for scheduling.
SchedulerMediaSetupTrait::$nonSchedulerMediaTypeLabel protected property The readable label of the media type not enabled for scheduling.
SchedulerMediaSetupTrait::$nonSchedulerMediaTypeName protected property The internal name of the media type not enabled for scheduling.
SchedulerMediaSetupTrait::createMediaItem public function Creates a media entity.
SchedulerMediaSetupTrait::getMediaItem public function Gets a media item from storage.
SchedulerMediaSetupTrait::schedulerMediaSetUp public function Set common properties, define content types and create users.
SchedulerSetupTrait::$adminUser protected property A user with administration rights.
SchedulerSetupTrait::$database protected property The Database Connection.
SchedulerSetupTrait::$dateFormatter protected property The date formatter service.
SchedulerSetupTrait::$nodeStorage protected property The node storage object.
SchedulerSetupTrait::$nodetype protected property The node type object.
SchedulerSetupTrait::$nonSchedulerNodeType protected property The node type object which is not enabled for scheduling.
SchedulerSetupTrait::$nonSchedulerType protected property The machine name of the content type which is not enabled for scheduling.
SchedulerSetupTrait::$nonSchedulerTypeName protected property The readable name of content type which is not enabled for scheduling.
SchedulerSetupTrait::$requestTime protected property The request time stored as interger for direct re-use in many tests.
SchedulerSetupTrait::$schedulerUser protected property A user with permission to schedule content.
SchedulerSetupTrait::$type protected property The internal name of the standard content type created for testing.
SchedulerSetupTrait::$typeName protected property The readable name of the standard content type created for testing.
SchedulerSetupTrait::addPermissionsToUser public function Adds a set of permissions to an existing user.
SchedulerSetupTrait::createEntity public function Creates a test entity.
SchedulerSetupTrait::dataStandardEntityTypes public function Provides test data containing the standard entity types.
SchedulerSetupTrait::entityAddUrl public function Returns the url for adding an entity, for use in drupalGet().
SchedulerSetupTrait::entityStorageObject public function Returns the storage object of the entity type passed by string.
SchedulerSetupTrait::entityTypeObject public function Returns the stored entity type object from a type id and bundle id.
SchedulerSetupTrait::getEntityByTitle public function Gets an entity by title, a direct replacement of drupalGetNodeByTitle().
SchedulerSetupTrait::schedulerSetUp public function Set common properties, define content types and create users.
SessionTestTrait::$sessionName protected property The name of the session cookie.
SessionTestTrait::generateSessionName protected function Generates a session cookie name.
SessionTestTrait::getSessionName protected function Returns the session name in use on the child site.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
TestRequirementsTrait::checkModuleRequirements private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements protected function Check module requirements for the Drupal use case. 1
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.
TestSetupTrait::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking.
TestSetupTrait::$container protected property The dependency injection container used in the test.
TestSetupTrait::$kernel protected property The DrupalKernel instance used in the test.
TestSetupTrait::$originalSite protected property The site directory of the original parent site.
TestSetupTrait::$privateFilesDirectory protected property The private file directory for the test environment.
TestSetupTrait::$publicFilesDirectory protected property The public file directory for the test environment.
TestSetupTrait::$siteDirectory protected property The site directory of this test run.
TestSetupTrait::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 1
TestSetupTrait::$tempFilesDirectory protected property The temporary file directory for the test environment.
TestSetupTrait::$testId protected property The test run ID.
TestSetupTrait::changeDatabasePrefix protected function Changes the database connection to the prefixed one.
TestSetupTrait::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
TestSetupTrait::getDatabaseConnection public static function Returns the database connection to the site running Simpletest.
TestSetupTrait::prepareDatabasePrefix protected function Generates a database prefix for running tests. 1
UiHelperTrait::$loggedInUser protected property The current user logged in using the Mink controlled browser.
UiHelperTrait::$maximumMetaRefreshCount protected property The number of meta refresh redirects to follow, or NULL if unlimited.
UiHelperTrait::$metaRefreshCount protected property The number of meta refresh redirects followed during ::drupalGet().
UiHelperTrait::assertSession public function Returns WebAssert object. 1
UiHelperTrait::buildUrl protected function Builds an absolute URL from a system path or a URL object.
UiHelperTrait::checkForMetaRefresh protected function Checks for meta refresh tag and if found call drupalGet() recursively.
UiHelperTrait::click protected function Clicks the element with the given CSS selector.
UiHelperTrait::clickLink protected function Follows a link by complete name.
UiHelperTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
UiHelperTrait::cssSelectToXpath protected function Translates a CSS expression to its XPath equivalent.
UiHelperTrait::drupalGet protected function Retrieves a Drupal path or an absolute path. 2
UiHelperTrait::drupalLogin protected function Logs in a user using the Mink controlled browser.
UiHelperTrait::drupalLogout protected function Logs a user out of the Mink controlled browser and confirms.
UiHelperTrait::drupalPostForm Deprecated protected function Executes a form submission.
UiHelperTrait::drupalUserIsLoggedIn protected function Returns whether a given user account is logged in.
UiHelperTrait::getAbsoluteUrl protected function Takes a path and returns an absolute path.
UiHelperTrait::getTextContent protected function Retrieves the plain-text content from the current page.
UiHelperTrait::getUrl protected function Get the current URL from the browser.
UiHelperTrait::isTestUsingGuzzleClient protected function Determines if test is using DrupalTestBrowser.
UiHelperTrait::prepareRequest protected function Prepare for a request to testing site. 1
UiHelperTrait::submitForm protected function Fills and submits a form.
UserCreationTrait::checkPermissions protected function Checks whether a given list of permission names is valid.
UserCreationTrait::createAdminRole protected function Creates an administrative role.
UserCreationTrait::createRole protected function Creates a role with specified permissions. Aliased as: drupalCreateRole
UserCreationTrait::createUser protected function Create a user with a given set of permissions. Aliased as: drupalCreateUser
UserCreationTrait::grantPermissions protected function Grant permissions to a user role.
UserCreationTrait::setCurrentUser protected function Switch the current logged in user.
UserCreationTrait::setUpCurrentUser protected function Creates a random user account and sets it as current user.
XdebugRequestTrait::extractCookiesFromRequest protected function Adds xdebug cookies, from request setup.