class SchedulerApiTest in Scheduler 8

Tests the API of the Scheduler module.

@group scheduler

Hierarchy

class \Drupal\Tests\BrowserTestBase extends \PHPUnit\Framework\TestCase uses FunctionalTestSetupTrait, TestSetupTrait, AssertLegacyTrait, BlockCreationTrait, ConfigTestTrait, ContentTypeCreationTrait, NodeCreationTrait, PhpunitCompatibilityTrait, RandomGeneratorTrait, TestRequirementsTrait, UiHelperTrait, UserCreationTrait, XdebugRequestTrait
- class \Drupal\Tests\scheduler\Functional\SchedulerBrowserTestBase uses SchedulerSetupTrait
  - class \Drupal\Tests\scheduler\Functional\SchedulerApiTest

Expanded class hierarchy of SchedulerApiTest

File

tests/src/Functional/SchedulerApiTest.php, line 12

Namespace

Drupal\Tests\scheduler\Functional

View source

class SchedulerApiTest 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. It will be enabled for Scheduler automatically
    // as that is pre-configured in node.type.scheduler_api_test.yml.
    $this->customName = 'scheduler_api_test';
    $this->customNodetype = NodeType::load($this->customName);

    // Check that the custom node type has loaded OK.
    $this
      ->assertNotNull($this->customNodetype, 'Custom node type "' . $this->customName . '"  was created during install');

    // Create a web user for this content type.
    $this->webUser = $this
      ->drupalCreateUser([
      'create ' . $this->customName . ' content',
      'edit any ' . $this->customName . ' content',
      'schedule publishing of nodes',
    ]);
  }

  /**
   * Covers hook_scheduler_allow_publishing()
   *
   * This hook can allow or deny the publishing of individual nodes. This test
   * uses the customised content type which has checkboxes 'Approved for
   * publication' and 'Approved for unpublication'.
   *
   * @todo Create and update the nodes through the interface so we can check if
   *   the correct messages are displayed.
   */
  public function testAllowedPublishing() {
    $this
      ->drupalLogin($this->webUser);

    // Check the 'approved for publishing' field is shown on the node form.
    $this
      ->drupalGet('node/add/' . $this->customName);
    $this
      ->assertSession()
      ->fieldExists('edit-field-approved-publishing-value');

    // Check that the message is shown when scheduling a node for publishing
    // which is not yet allowed to be published.
    $edit = [
      'title[0][value]' => '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
      ->drupalPostForm('node/add/' . $this->customName, $edit, 'Save');
    $this
      ->assertSession()
      ->pageTextContains('is scheduled for publishing, but will not be published until approved.');

    // Create a node that is scheduled but not approved for publication. Then
    // simulate a cron run, and check that the node is still not published.
    $node = $this
      ->createUnapprovedNode('publish_on');
    scheduler_cron();
    $this->nodeStorage
      ->resetCache([
      $node
        ->id(),
    ]);
    $node = $this->nodeStorage
      ->load($node
      ->id());
    $this
      ->assertFalse($node
      ->isPublished(), 'An unapproved node is not published during cron processing.');

    // Create a node and approve it for publication, simulate a cron run and
    // check that the node is published. This is a stronger test than simply
    // approving the previously used node above, as we do not know what publish
    // state that may be in after the cron run above.
    $node = $this
      ->createUnapprovedNode('publish_on');
    $this
      ->approveNode($node
      ->id(), 'field_approved_publishing');
    $this
      ->assertFalse($node
      ->isPublished(), 'A new approved node is initially not published.');
    scheduler_cron();
    $this->nodeStorage
      ->resetCache([
      $node
        ->id(),
    ]);
    $node = $this->nodeStorage
      ->load($node
      ->id());
    $this
      ->assertTrue($node
      ->isPublished(), 'An approved node is published during cron processing.');

    // Turn on immediate publication of nodes with publication dates in the past
    // and repeat the tests. It is not needed to simulate cron runs here.
    $this->customNodetype
      ->setThirdPartySetting('scheduler', 'publish_past_date', 'publish')
      ->save();
    $node = $this
      ->createUnapprovedNode('publish_on');
    $this
      ->assertFalse($node
      ->isPublished(), 'An unapproved node with a date in the past is not published immediately after saving.');

    // Check that the node can be approved and published programatically.
    $this
      ->approveNode($node
      ->id(), 'field_approved_publishing');
    $this->nodeStorage
      ->resetCache([
      $node
        ->id(),
    ]);
    $node = $this->nodeStorage
      ->load($node
      ->id());
    $this
      ->assertTrue($node
      ->isPublished(), 'An approved node with a date in the past is published immediately via $node->set()->save().');

    // Check that a node can be approved and published via edit form.
    $node = $this
      ->createUnapprovedNode('publish_on');
    $this
      ->drupalPostForm('node/' . $node
      ->id() . '/edit', [
      'field_approved_publishing[value]' => '1',
    ], 'Save');
    $this->nodeStorage
      ->resetCache([
      $node
        ->id(),
    ]);
    $node = $this->nodeStorage
      ->load($node
      ->id());
    $this
      ->assertTrue($node
      ->isPublished(), 'An approved node with a date in the past is published immediately after saving via edit form.');

    // Show the dblog messages.
    $this
      ->drupalLogin($this->adminUser);
    $this
      ->drupalGet('admin/reports/dblog');
  }

  /**
   * Covers hook_scheduler_allow_unpublishing()
   *
   * This hook can allow or deny the unpublishing of individual nodes. This test
   * is simpler than the test sequence for allowed publishing, because the past
   * date 'publish' option is not applicable.
   */
  public function testAllowedUnpublishing() {
    $this
      ->drupalLogin($this->webUser);

    // Check the 'approved for unpublishing' field is shown on the node form.
    $this
      ->drupalGet('node/add/' . $this->customName);
    $this
      ->assertSession()
      ->fieldExists('edit-field-approved-unpublishing-value');

    // Check that the message is shown when scheduling a node for unpublishing
    // which is not yet allowed to be unpublished.
    $edit = [
      'title[0][value]' => '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
      ->drupalPostForm('node/add/' . $this->customName, $edit, 'Save');
    $this
      ->assertSession()
      ->pageTextContains('is scheduled for unpublishing, but will not be unpublished until approved.');

    // Create a node that is scheduled but not approved for unpublication. Then
    // simulate a cron run, and check that the node is still published.
    $node = $this
      ->createUnapprovedNode('unpublish_on');
    scheduler_cron();
    $this->nodeStorage
      ->resetCache([
      $node
        ->id(),
    ]);
    $node = $this->nodeStorage
      ->load($node
      ->id());
    $this
      ->assertTrue($node
      ->isPublished(), 'An unapproved node is not unpublished during cron processing.');

    // Create a node, then approve it for unpublishing, simulate a cron run and
    // check that the node is now unpublished.
    $node = $this
      ->createUnapprovedNode('unpublish_on');
    $this
      ->approveNode($node
      ->id(), 'field_approved_unpublishing');
    $this
      ->assertTrue($node
      ->isPublished(), 'A new approved node is initially published.');
    scheduler_cron();
    $this->nodeStorage
      ->resetCache([
      $node
        ->id(),
    ]);
    $node = $this->nodeStorage
      ->load($node
      ->id());
    $this
      ->assertFalse($node
      ->isPublished(), 'An approved node is unpublished during cron processing.');

    // Show the dblog messages.
    $this
      ->drupalLogin($this->adminUser);
    $this
      ->drupalGet('admin/reports/dblog');
  }

  /**
   * Creates a new node that is not approved.
   *
   * The node has a publish/unpublish date in the past to make sure it will be
   * included in the next cron run.
   *
   * @param string $date_field
   *   The Scheduler date field to set, either 'publish_on' or 'unpublish_on'.
   *
   * @return \Drupal\node\NodeInterface
   *   A node object.
   */
  protected function createUnapprovedNode($date_field) {
    $settings = [
      'status' => $date_field == 'unpublish_on',
      $date_field => strtotime('-1 day'),
      'field_approved_publishing' => 0,
      'field_approved_unpublishing' => 0,
      'type' => $this->customName,
    ];
    return $this
      ->drupalCreateNode($settings);
  }

  /**
   * Approves a node for publication or unpublication.
   *
   * @param int $nid
   *   The id of the node to approve.
   * @param string $field_name
   *   The name of the field to set, either 'field_approved_publishing' or
   *   'field_approved_unpublishing'.
   */
  protected function approveNode($nid, $field_name) {
    $this->nodeStorage
      ->resetCache([
      $nid,
    ]);
    $node = $this->nodeStorage
      ->load($nid);
    $node
      ->set($field_name, TRUE)
      ->save();
  }

  /**
   * Covers six events.
   *
   * The events allow other modules to react to the Scheduler process being run.
   * The API test implementations of the event listeners alter the nodes
   * 'promote' and 'sticky' settings and changes the title.
   */
  public function testApiNodeAction() {
    $this
      ->drupalLogin($this->schedulerUser);

    // Create a test node. Having the 'approved' fields here would complicate
    // the tests, so use the ordinary page type.
    $settings = [
      'publish_on' => strtotime('-1 day'),
      'type' => $this->type,
      'promote' => FALSE,
      'sticky' => FALSE,
      'title' => 'API TEST node action',
    ];
    $node = $this
      ->drupalCreateNode($settings);

    // Check that the 'sticky' and 'promote' fields are off for the new node.
    $this
      ->assertFalse($node
      ->isSticky(), 'The unpublished node is not sticky.');
    $this
      ->assertFalse($node
      ->isPromoted(), 'The unpublished node is not promoted.');

    // Run cron and check that hook_scheduler_api() has executed correctly, by
    // verifying that the node has become promoted and is sticky.
    scheduler_cron();
    $this->nodeStorage
      ->resetCache([
      $node
        ->id(),
    ]);
    $node = $this->nodeStorage
      ->load($node
      ->id());
    $this
      ->assertTrue($node
      ->isSticky(), 'API action "PRE_PUBLISH" has changed the node to sticky.');
    $this
      ->assertTrue($node
      ->isPromoted(), 'API action "PUBLISH" has changed the node to promoted.');

    // Now set a date for unpublishing the node. Ensure 'sticky' and 'promote'
    // are set, so that the assertions are not affected by any failures above.
    $node
      ->set('unpublish_on', strtotime('-1 day'))
      ->set('sticky', TRUE)
      ->set('promote', TRUE)
      ->save();

    // Run cron and check that hook_scheduler_api() has executed correctly, by
    // verifying that the node is not promoted and no longer sticky.
    scheduler_cron();
    $this->nodeStorage
      ->resetCache([
      $node
        ->id(),
    ]);
    $node = $this->nodeStorage
      ->load($node
      ->id());
    $this
      ->assertFalse($node
      ->isSticky(), 'API action "PRE_UNPUBLISH" has changed the node to not sticky.');
    $this
      ->assertFalse($node
      ->isPromoted(), 'API action "UNPUBLISH" has changed the node to not promoted.');

    // Turn on immediate publication when a publish date is in the past.
    $this->nodetype
      ->setThirdPartySetting('scheduler', 'publish_past_date', 'publish')
      ->save();

    // Ensure 'sticky' and 'promote' are not set, so that the assertions are not
    // affected by any failures above.
    $node
      ->set('sticky', FALSE)
      ->set('promote', FALSE)
      ->save();

    // Edit the node and set a publish-on date in the past.
    $edit = [
      'publish_on[0][value][date]' => date('Y-m-d', strtotime('-2 day', $this->requestTime)),
      'publish_on[0][value][time]' => date('H:i:s', strtotime('-2 day', $this->requestTime)),
    ];
    $this
      ->drupalPostForm('node/' . $node
      ->id() . '/edit', $edit, 'Save');

    // Verify that the values have been altered as expected.
    $this->nodeStorage
      ->resetCache([
      $node
        ->id(),
    ]);
    $node = $this->nodeStorage
      ->load($node
      ->id());
    $this
      ->assertTrue($node
      ->isSticky(), 'API action "PRE_PUBLISH_IMMEDIATELY" has changed the node to sticky.');
    $this
      ->assertTrue($node
      ->isPromoted(), 'API action "PUBLISH_IMMEDIATELY" has changed the node to promoted.');
    $this
      ->assertEquals('Published immediately', $node->title->value, 'API action "PUBLISH_IMMEDIATELY" has changed the node title correctly.');
  }

  /**
   * Covers hook_scheduler_nid_list($action)
   *
   * Hook_scheduler_nid_list() allows other modules to add more node ids into
   * the list to be processed. In real scenarios, the third-party module would
   * likely have more complex data structures and/or tables from which to
   * identify nodes to add. In this test, to keep it simple, we identify nodes
   * by the text of the title.
   */
  public function testNidList() {
    $this
      ->drupalLogin($this->schedulerUser);

    // Create test nodes. Use the ordinary page type for this test, as having
    // the 'approved' fields here would unnecessarily complicate the processing.
    // Node 1 is not published and has no publishing date set. The test API
    // module will add node 1 into the list to be published.
    $node1 = $this
      ->drupalCreateNode([
      'type' => $this->type,
      'status' => FALSE,
      'title' => 'API TEST nid_list publish me',
    ]);

    // Node 2 is published and has no unpublishing date set. The test API module
    // will add node 2 into the list to be unpublished.
    $node2 = $this
      ->drupalCreateNode([
      'type' => $this->type,
      'status' => TRUE,
      'title' => 'API TEST nid_list unpublish me',
    ]);

    // Before cron, check node 1 is unpublished and node 2 is published.
    $this
      ->assertFalse($node1
      ->isPublished(), 'Before cron, node 1 "' . $node1->title->value . '" is unpublished.');
    $this
      ->assertTrue($node2
      ->isPublished(), 'Before cron, node 2 "' . $node2->title->value . '" is published.');

    // Run cron and refresh the nodes.
    scheduler_cron();
    $this->nodeStorage
      ->resetCache();
    $node1 = $this->nodeStorage
      ->load($node1
      ->id());
    $node2 = $this->nodeStorage
      ->load($node2
      ->id());

    // Check node 1 is published and node 2 is unpublished.
    $this
      ->assertTrue($node1
      ->isPublished(), 'After cron, node 1 "' . $node1->title->value . '" is published.');
    $this
      ->assertFalse($node2
      ->isPublished(), 'After cron, node 2 "' . $node2->title->value . '" is unpublished.');
  }

  /**
   * Covers hook_scheduler_nid_list_alter($action)
   *
   * This hook allows other modules to add or remove node ids from the list to
   * be processed. As in testNidList() we make it simple by using the title text
   * to identify which nodes to act on.
   */
  public function testNidListAlter() {
    $this
      ->drupalLogin($this->schedulerUser);

    // Create test nodes. Use the ordinary page type for this test, as having
    // the 'approved' fields here would unnecessarily complicate the processing.
    // Node 1 is set for scheduled publishing, but will be removed by the test
    // API hook_nid_list_alter().
    $node1 = $this
      ->drupalCreateNode([
      'type' => $this->type,
      'status' => FALSE,
      'title' => 'API TEST nid_list_alter do not publish me',
      'publish_on' => strtotime('-1 day'),
    ]);

    // Node 2 is not published and has no publishing date set. The test API
    // module will add node 2 into the list to be published.
    $node2 = $this
      ->drupalCreateNode([
      'type' => $this->type,
      'status' => FALSE,
      'title' => 'API TEST nid_list_alter publish me',
    ]);

    // Node 3 is set for scheduled unpublishing, but will be removed by the test
    // API hook_nid_list_alter().
    $node3 = $this
      ->drupalCreateNode([
      'type' => $this->type,
      'status' => TRUE,
      'title' => 'API TEST nid_list_alter do not unpublish me',
      'unpublish_on' => strtotime('-1 day'),
    ]);

    // Node 4 is published and has no unpublishing date set. The test API module
    // will add node 4 into the list to be unpublished.
    $node4 = $this
      ->drupalCreateNode([
      'type' => $this->type,
      'status' => TRUE,
      'title' => 'API TEST nid_list_alter unpublish me',
    ]);

    // Check node 1 and 2 are unpublished and node 3 and 4 are published.
    $this
      ->assertFalse($node1
      ->isPublished(), 'Before cron, node 1 "' . $node1->title->value . '" is unpublished.');
    $this
      ->assertFalse($node2
      ->isPublished(), 'Before cron, node 2 "' . $node2->title->value . '" is unpublished.');
    $this
      ->assertTrue($node3
      ->isPublished(), 'Before cron, node 3 "' . $node3->title->value . '" is published.');
    $this
      ->assertTrue($node4
      ->isPublished(), 'Before cron, node 4 "' . $node4->title->value . '" is published.');

    // Run cron and refresh the nodes.
    scheduler_cron();
    $this->nodeStorage
      ->resetCache();
    $node1 = $this->nodeStorage
      ->load($node1
      ->id());
    $node2 = $this->nodeStorage
      ->load($node2
      ->id());
    $node3 = $this->nodeStorage
      ->load($node3
      ->id());
    $node4 = $this->nodeStorage
      ->load($node4
      ->id());

    // Check node 2 and 3 are published and node 1 and 4 are unpublished.
    $this
      ->assertFalse($node1
      ->isPublished(), 'After cron, node 1 "' . $node1->title->value . '" is still unpublished.');
    $this
      ->assertTrue($node2
      ->isPublished(), 'After cron, node 2 "' . $node2->title->value . '" is published.');
    $this
      ->assertTrue($node3
      ->isPublished(), 'After cron, node 3 "' . $node3->title->value . '" is still published.');
    $this
      ->assertFalse($node4
      ->isPublished(), 'After cron, node 4 "' . $node4->title->value . '" is unpublished.');
  }

  /**
   * Test the hooks which allow hiding of scheduler input fields.
   *
   * This covers hook_scheduler_hide_publish_on_field and
   * hook_scheduler_hide_unpublish_on_field.
   */
  public function testHideField() {
    $this
      ->drupalLogin($this->schedulerUser);

    // Create test nodes.
    $node1 = $this
      ->drupalCreateNode([
      'type' => $this->type,
      'title' => 'Red will not have either field hidden',
    ]);
    $node2 = $this
      ->drupalCreateNode([
      'type' => $this->type,
      'title' => 'Orange will have the publish-on field hidden',
    ]);
    $node3 = $this
      ->drupalCreateNode([
      'type' => $this->type,
      'title' => 'Yellow will have the unpublish-on field hidden',
    ]);
    $node4 = $this
      ->drupalCreateNode([
      'type' => $this->type,
      'title' => 'Green will have both Scheduler fields hidden',
    ]);

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

    // Node 1 'red' should have both fields displayed.
    $this
      ->drupalGet('node/' . $node1
      ->id() . '/edit');
    $assert
      ->ElementExists('xpath', '//input[@id = "edit-publish-on-0-value-date"]');
    $assert
      ->ElementExists('xpath', '//input[@id = "edit-unpublish-on-0-value-date"]');

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

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

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

  /**
   * Test when other modules process the publish and unpublish actions.
   *
   * This covers hook_scheduler_publish_action and
   * hook_scheduler_unpublish_action.
   */
  public function testHookPublishUnpublishAction() {
    $this
      ->drupalLogin($this->schedulerUser);

    // Create test nodes.
    $node1 = $this
      ->drupalCreateNode([
      'type' => $this->type,
      'status' => FALSE,
      'title' => 'Red will cause a failure on publishing',
      'publish_on' => strtotime('-1 day'),
    ]);
    $node2 = $this
      ->drupalCreateNode([
      'type' => $this->type,
      'status' => TRUE,
      'title' => 'Orange will be unpublished by the API test module not Scheduler',
      'unpublish_on' => strtotime('-1 day'),
    ]);
    $node3 = $this
      ->drupalCreateNode([
      'type' => $this->type,
      'status' => FALSE,
      'title' => 'Yellow will be published by the API test module not Scheduler',
      'publish_on' => strtotime('-1 day'),
    ]);

    // 'green' nodes will have both fields hidden so is harder to test manually.
    // Therefore introduce a different colour.
    $node4 = $this
      ->drupalCreateNode([
      'type' => $this->type,
      'status' => TRUE,
      'title' => 'Blue will cause a failure on unpublishing',
      'unpublish_on' => strtotime('-1 day'),
    ]);

    // Simulate a cron run.
    scheduler_cron();

    // Check the red node.
    $this->nodeStorage
      ->resetCache([
      $node1
        ->id(),
    ]);
    $node1 = $this->nodeStorage
      ->load($node1
      ->id());
    $this
      ->assertFalse($node1
      ->isPublished(), 'The red node is still unpublished.');
    $this
      ->assertNotEmpty($node1->publish_on->value, 'The red node still has a publish-on date.');

    // Check the orange node.
    $this->nodeStorage
      ->resetCache([
      $node2
        ->id(),
    ]);
    $node2 = $this->nodeStorage
      ->load($node2
      ->id());
    $this
      ->assertFalse($node2
      ->isPublished(), 'The orange node was unpublished by the API test module.');
    $this
      ->assertNotEmpty(stristr($node2->title->value, 'unpublishing processed by API test module'), 'The orange node was processed by the API test module.');
    $this
      ->assertEmpty($node2->unpublish_on->value, 'The orange node no longer has an unpublish-on date.');

    // Check the yellow node.
    $this->nodeStorage
      ->resetCache([
      $node3
        ->id(),
    ]);
    $node3 = $this->nodeStorage
      ->load($node3
      ->id());
    $this
      ->assertTrue($node3
      ->isPublished(), 'The yellow node was published by the API test module.');
    $this
      ->assertNotEmpty(stristr($node3->title->value, 'publishing processed by API test module'), 'The yellow node was processed by the API test module.');
    $this
      ->assertEmpty($node3->publish_on->value, 'The yellow node no longer has a publish-on date.');

    // Check the blue node.
    $this->nodeStorage
      ->resetCache([
      $node4
        ->id(),
    ]);
    $node4 = $this->nodeStorage
      ->load($node4
      ->id());
    $this
      ->assertTrue($node4
      ->isPublished(), 'The green node is still published.');
    $this
      ->assertNotEmpty($node4->unpublish_on->value, 'The green node still has an unpublish-on date.');
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AssertHelperTrait::castSafeStrings	protected static	function	Casts MarkupInterface objects into strings.
AssertLegacyTrait::assert	protected	function	Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::assertCacheTag	protected	function	Asserts whether an expected cache tag was present in the last response.
AssertLegacyTrait::assertElementNotPresent	protected	function	Asserts that the element with the given CSS selector is not present.
AssertLegacyTrait::assertElementPresent	protected	function	Asserts that the element with the given CSS selector is present.
AssertLegacyTrait::assertEqual	protected	function	Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertEscaped	protected	function	Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertLegacyTrait::assertField	protected	function	Asserts that a field exists with the given name or ID.
AssertLegacyTrait::assertFieldById	protected	function	Asserts that a field exists with the given ID and value.
AssertLegacyTrait::assertFieldByName	protected	function	Asserts that a field exists with the given name and value.
AssertLegacyTrait::assertFieldByXPath	protected	function	Asserts that a field exists in the current page by the given XPath.
AssertLegacyTrait::assertFieldChecked	protected	function	Asserts that a checkbox field in the current page is checked.
AssertLegacyTrait::assertFieldsByValue	protected	function	Asserts that a field exists in the current page with a given Xpath result.
AssertLegacyTrait::assertHeader	protected	function	Checks that current response header equals value.
AssertLegacyTrait::assertIdentical	protected	function	Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertSame() instead.
AssertLegacyTrait::assertIdenticalObject	protected	function	Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertLink	protected	function	Passes if a link with the specified label is found.
AssertLegacyTrait::assertLinkByHref	protected	function	Passes if a link containing a given href (part) is found.
AssertLegacyTrait::assertNoCacheTag	protected	function	Asserts whether an expected cache tag was absent in the last response.
AssertLegacyTrait::assertNoEscaped	protected	function	Passes if the raw text is not found escaped on the loaded page.
AssertLegacyTrait::assertNoField	protected	function	Asserts that a field does NOT exist with the given name or ID.
AssertLegacyTrait::assertNoFieldById	protected	function	Asserts that a field does not exist with the given ID and value.
AssertLegacyTrait::assertNoFieldByName	protected	function	Asserts that a field does not exist with the given name and value.
AssertLegacyTrait::assertNoFieldByXPath	protected	function	Asserts that a field does not exist or its value does not match, by XPath.
AssertLegacyTrait::assertNoFieldChecked	protected	function	Asserts that a checkbox field in the current page is not checked.
AssertLegacyTrait::assertNoLink	protected	function	Passes if a link with the specified label is not found.
AssertLegacyTrait::assertNoLinkByHref	protected	function	Passes if a link containing a given href (part) is not found.
AssertLegacyTrait::assertNoOption	protected	function	Asserts that a select option does NOT exist in the current page.
AssertLegacyTrait::assertNoPattern	protected	function	Triggers a pass if the Perl regex pattern is not found in the raw content.
AssertLegacyTrait::assertNoRaw	protected	function	Passes if the raw text IS not found on the loaded page, fail otherwise.	1
AssertLegacyTrait::assertNotEqual	protected	function	Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotEquals() instead.
AssertLegacyTrait::assertNoText	protected	function	Passes if the page (with HTML stripped) does not contains the text.	1
AssertLegacyTrait::assertNotIdentical	protected	function	Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotSame() instead.
AssertLegacyTrait::assertNoUniqueText	protected	function	Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertLegacyTrait::assertOption	protected	function	Asserts that a select option in the current page exists.
AssertLegacyTrait::assertOptionByText	protected	function	Asserts that a select option with the visible text exists.
AssertLegacyTrait::assertOptionSelected	protected	function	Asserts that a select option in the current page is checked.
AssertLegacyTrait::assertPattern	protected	function	Triggers a pass if the Perl regex pattern is found in the raw content.
AssertLegacyTrait::assertRaw	protected	function	Passes if the raw text IS found on the loaded page, fail otherwise.	1
AssertLegacyTrait::assertResponse	protected	function	Asserts the page responds with the specified response code.	1
AssertLegacyTrait::assertText	protected	function	Passes if the page (with HTML stripped) contains the text.	1
AssertLegacyTrait::assertTextHelper	protected	function	Helper for assertText and assertNoText.
AssertLegacyTrait::assertTitle	protected	function	Pass if the page title is the given string.
AssertLegacyTrait::assertUniqueText	protected	function	Passes if the text is found ONLY ONCE on the text version of the page.
AssertLegacyTrait::assertUrl	protected	function	Passes if the internal browser's URL matches the given path.
AssertLegacyTrait::buildXPathQuery	protected	function	Builds an XPath query.
AssertLegacyTrait::constructFieldXpath	protected	function	Helper: Constructs an XPath for the given set of attributes and value.
AssertLegacyTrait::getAllOptions	protected	function	Get all option elements, including nested options, in a select.
AssertLegacyTrait::getRawContent	protected	function	Gets the current raw content.
AssertLegacyTrait::pass	protected	function	Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::verbose	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::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
BrowserTestBase::$minkDefaultDriverClass	protected	property		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::cssSelectToXpath	protected	function	Translates a CSS expression to its XPath equivalent.
BrowserTestBase::drupalGetHeader	protected	function	Gets the value of an HTTP response header.
BrowserTestBase::drupalGetHeaders Deprecated	protected	function	Returns all response headers.
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::getResponseLogHandler	protected	function	Provides a Guzzle middleware handler to log every response received. Overrides BrowserHtmlDebugTrait::getResponseLogHandler
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::tearDown	protected	function		3
BrowserTestBase::translatePostValues	protected	function	Transforms a nested array into a flat array suitable for drupalPostForm().
BrowserTestBase::xpath	protected	function	Performs an xpath search on the contents of the internal browser.
BrowserTestBase::__construct	public	function		1
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.
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::$configDirectories Deprecated	protected	property	The config directories used in this test.
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.	2
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.	23
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.
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
PhpunitCompatibilityTrait::getMock Deprecated	public	function	Returns a mock object for the specified class using the available method.
PhpunitCompatibilityTrait::setExpectedException Deprecated	public	function	Compatibility layer for PHPUnit 6 to support PHPUnit 4 code.
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.	3
SchedulerApiTest::$modules	protected static	property	Additional modules required. Overrides SchedulerBrowserTestBase::$modules
SchedulerApiTest::approveNode	protected	function	Approves a node for publication or unpublication.
SchedulerApiTest::createUnapprovedNode	protected	function	Creates a new node that is not approved.
SchedulerApiTest::setUp	protected	function	Overrides SchedulerBrowserTestBase::setUp
SchedulerApiTest::testAllowedPublishing	public	function	Covers hook_scheduler_allow_publishing()
SchedulerApiTest::testAllowedUnpublishing	public	function	Covers hook_scheduler_allow_unpublishing()
SchedulerApiTest::testApiNodeAction	public	function	Covers six events.
SchedulerApiTest::testHideField	public	function	Test the hooks which allow hiding of scheduler input fields.
SchedulerApiTest::testHookPublishUnpublishAction	public	function	Test when other modules process the publish and unpublish actions.
SchedulerApiTest::testNidList	public	function	Covers hook_scheduler_nid_list($action)
SchedulerApiTest::testNidListAlter	public	function	Covers hook_scheduler_nid_list_alter($action)
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
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::$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::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.	2
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.	2
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 a 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::drupalGet	protected	function	Retrieves a Drupal path or an absolute path.	3
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	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::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.

You are here

class SchedulerApiTest in Scheduler 8

Hierarchy

File

Namespace

Members

API Navigation