class WorkflowUiTest in Drupal 9

Tests workflow creation UI.

@group workflows

Hierarchy

• class \Drupal\Tests\BrowserTestBase extends \PHPUnit\Framework\TestCase uses \Symfony\Bridge\PhpUnit\ExpectDeprecationTrait, FunctionalTestSetupTrait, TestSetupTrait, AssertLegacyTrait, BlockCreationTrait, ConfigTestTrait, ExtensionListTestTrait, ContentTypeCreationTrait, NodeCreationTrait, PhpUnitCompatibilityTrait, RandomGeneratorTrait, TestRequirementsTrait, PhpUnitWarnings, UiHelperTrait, UserCreationTrait, XdebugRequestTrait
  • class \Drupal\Tests\workflows\Functional\WorkflowUiTest

File

core/modules/workflows/tests/src/Functional/WorkflowUiTest.php, line 14

Namespace

Drupal\Tests\workflows\Functional

class WorkflowUiTest extends BrowserTestBase {

  /**
   * Modules to enable.
   *
   * @var array
   */
  protected static $modules = [
    'workflows',
    'workflow_type_test',
    'block',
  ];

  /**
   * {@inheritdoc}
   */
  protected $defaultTheme = 'stark';

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

    // We're testing local actions.
    $this
      ->drupalPlaceBlock('local_actions_block');
  }

  /**
   * Tests route access/permissions.
   */
  public function testAccess() {

    // Create a minimal workflow for testing.
    $workflow = Workflow::create([
      'id' => 'test',
      'type' => 'workflow_type_test',
    ]);
    $workflow
      ->getTypePlugin()
      ->addState('draft', 'Draft')
      ->addState('published', 'Published')
      ->addTransition('publish', 'Publish', [
      'draft',
      'published',
    ], 'published');
    $workflow
      ->save();
    $paths = [
      'admin/config/workflow/workflows',
      'admin/config/workflow/workflows/add',
      'admin/config/workflow/workflows/manage/test',
      'admin/config/workflow/workflows/manage/test/delete',
      'admin/config/workflow/workflows/manage/test/add_state',
      'admin/config/workflow/workflows/manage/test/state/published',
      'admin/config/workflow/workflows/manage/test/state/published/delete',
      'admin/config/workflow/workflows/manage/test/add_transition',
      'admin/config/workflow/workflows/manage/test/transition/publish',
      'admin/config/workflow/workflows/manage/test/transition/publish/delete',
    ];
    foreach ($paths as $path) {
      $this
        ->drupalGet($path);

      // No access.
      $this
        ->assertSession()
        ->statusCodeEquals(403);
    }
    $this
      ->drupalLogin($this
      ->createUser([
      'administer workflows',
    ]));
    foreach ($paths as $path) {
      $this
        ->drupalGet($path);

      // User has access.
      $this
        ->assertSession()
        ->statusCodeEquals(200);
    }

    // Ensure that default states can not be deleted.
    \Drupal::state()
      ->set('workflow_type_test.required_states', [
      'published',
    ]);
    $this
      ->drupalGet('admin/config/workflow/workflows/manage/test/state/published/delete');
    $this
      ->assertSession()
      ->statusCodeEquals(403);
    \Drupal::state()
      ->set('workflow_type_test.required_states', []);

    // Delete one of the states and ensure the other test cannot be deleted.
    $this
      ->drupalGet('admin/config/workflow/workflows/manage/test/state/published/delete');
    $this
      ->submitForm([], 'Delete');
    $this
      ->drupalGet('admin/config/workflow/workflows/manage/test/state/draft/delete');
    $this
      ->assertSession()
      ->statusCodeEquals(403);
  }

  /**
   * Tests the machine name validation of the state add form.
   */
  public function testStateMachineNameValidation() {
    Workflow::create([
      'id' => 'test_workflow',
      'type' => 'workflow_type_test',
    ])
      ->save();
    $this
      ->drupalLogin($this
      ->createUser([
      'administer workflows',
    ]));
    $this
      ->drupalGet('admin/config/workflow/workflows/manage/test_workflow/add_state');
    $this
      ->submitForm([
      'label' => 'Test State',
      'id' => 'Invalid ID',
    ], 'Save');
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->assertSession()
      ->pageTextContains('The machine-readable name must contain only lowercase letters, numbers, and underscores.');
    $this
      ->drupalGet('admin/config/workflow/workflows/manage/test_workflow/add_transition');
    $this
      ->submitForm([
      'label' => 'Test Transition',
      'id' => 'Invalid ID',
    ], 'Save');
    $this
      ->assertSession()
      ->pageTextContains('The machine-readable name must contain only lowercase letters, numbers, and underscores.');
  }

  /**
   * Tests the creation of a workflow through the UI.
   */
  public function testWorkflowCreation() {
    $workflow_storage = $this->container
      ->get('entity_type.manager')
      ->getStorage('workflow');

    /** @var \Drupal\workflows\WorkflowInterface $workflow */
    $this
      ->drupalLogin($this
      ->createUser([
      'access administration pages',
      'administer workflows',
    ]));
    $this
      ->drupalGet('admin/config/workflow');
    $this
      ->assertSession()
      ->linkByHrefExists('admin/config/workflow/workflows');
    $this
      ->clickLink('Workflows');
    $this
      ->assertSession()
      ->pageTextContains('Workflows');
    $this
      ->assertSession()
      ->pageTextContains('There are no workflows yet.');
    $this
      ->clickLink('Add workflow');
    $this
      ->submitForm([
      'label' => 'Test',
      'id' => 'test',
      'workflow_type' => 'workflow_type_test',
    ], 'Save');
    $this
      ->assertSession()
      ->pageTextContains('Created the Test Workflow.');
    $this
      ->assertSession()
      ->addressEquals('admin/config/workflow/workflows/manage/test/add_state');
    $this
      ->drupalGet('/admin/config/workflow/workflows/manage/test');
    $this
      ->assertSession()
      ->pageTextContains('This workflow has no states and will be disabled until there is at least one, add a new state.');
    $this
      ->assertSession()
      ->pageTextContains('There are no states yet.');
    $this
      ->clickLink('Add a new state');
    $this
      ->submitForm([
      'label' => 'Published',
      'id' => 'published',
    ], 'Save');
    $this
      ->assertSession()
      ->pageTextContains('Created Published state.');
    $workflow = $workflow_storage
      ->loadUnchanged('test');
    $this
      ->assertFalse($workflow
      ->getTypePlugin()
      ->getState('published')
      ->canTransitionTo('published'), 'No default transition from published to published exists.');
    $this
      ->clickLink('Add a new state');

    // Don't create a draft to draft transition by default.
    $this
      ->submitForm([
      'label' => 'Draft',
      'id' => 'draft',
    ], 'Save');
    $this
      ->assertSession()
      ->pageTextContains('Created Draft state.');
    $workflow = $workflow_storage
      ->loadUnchanged('test');
    $this
      ->assertFalse($workflow
      ->getTypePlugin()
      ->getState('draft')
      ->canTransitionTo('draft'), 'Can not transition from draft to draft');
    $this
      ->clickLink('Add a new transition');
    $this
      ->submitForm([
      'id' => 'publish',
      'label' => 'Publish',
      'from[draft]' => 'draft',
      'to' => 'published',
    ], 'Save');
    $this
      ->assertSession()
      ->pageTextContains('Created Publish transition.');
    $workflow = $workflow_storage
      ->loadUnchanged('test');
    $this
      ->assertTrue($workflow
      ->getTypePlugin()
      ->getState('draft')
      ->canTransitionTo('published'), 'Can transition from draft to published');
    $this
      ->clickLink('Add a new transition');
    $this
      ->assertCount(2, $this
      ->cssSelect('input[name="to"][type="radio"]'));
    $this
      ->assertCount(0, $this
      ->cssSelect('input[name="to"][checked="checked"][type="radio"]'));
    $this
      ->submitForm([
      'id' => 'create_new_draft',
      'label' => 'Create new draft',
      'from[draft]' => 'draft',
      'to' => 'draft',
    ], 'Save');
    $this
      ->assertSession()
      ->pageTextContains('Created Create new draft transition.');
    $workflow = $workflow_storage
      ->loadUnchanged('test');
    $this
      ->assertTrue($workflow
      ->getTypePlugin()
      ->getState('draft')
      ->canTransitionTo('draft'), 'Can transition from draft to draft');

    // The fist state to edit on the page should be published.
    $this
      ->clickLink('Edit');
    $this
      ->assertSession()
      ->fieldValueEquals('label', 'Published');

    // Change the label.
    $this
      ->submitForm([
      'label' => 'Live',
    ], 'Save');
    $this
      ->assertSession()
      ->pageTextContains('Saved Live state.');

    // Allow published to draft.
    $this
      ->clickLink('Edit', 3);
    $this
      ->submitForm([
      'from[published]' => 'published',
    ], 'Save');
    $this
      ->assertSession()
      ->pageTextContains('Saved Create new draft transition.');
    $workflow = $workflow_storage
      ->loadUnchanged('test');
    $this
      ->assertTrue($workflow
      ->getTypePlugin()
      ->getState('published')
      ->canTransitionTo('draft'), 'Can transition from published to draft');

    // Try creating a duplicate transition.
    $this
      ->clickLink('Add a new transition');
    $this
      ->submitForm([
      'id' => 'create_new_draft',
      'label' => 'Create new draft',
      'from[published]' => 'published',
      'to' => 'draft',
    ], 'Save');
    $this
      ->assertSession()
      ->pageTextContains('The machine-readable name is already in use. It must be unique.');

    // Try creating a transition which duplicates the states of another.
    $this
      ->submitForm([
      'id' => 'create_new_draft2',
      'label' => 'Create new draft again',
      'from[published]' => 'published',
      'to' => 'draft',
    ], 'Save');
    $this
      ->assertSession()
      ->pageTextContains('The transition from Live to Draft already exists.');

    // Create a new transition.
    $this
      ->submitForm([
      'id' => 'save_and_publish',
      'label' => 'Save and publish',
      'from[published]' => 'published',
      'to' => 'published',
    ], 'Save');
    $this
      ->assertSession()
      ->pageTextContains('Created Save and publish transition.');

    // Edit the new transition and try to add an existing transition.
    $this
      ->clickLink('Edit', 4);
    $this
      ->submitForm([
      'from[draft]' => 'draft',
    ], 'Save');
    $this
      ->assertSession()
      ->pageTextContains('The transition from Draft to Live already exists.');

    // Delete the transition.
    $workflow = $workflow_storage
      ->loadUnchanged('test');
    $this
      ->assertTrue($workflow
      ->getTypePlugin()
      ->hasTransitionFromStateToState('published', 'published'), 'Can transition from published to published');
    $this
      ->clickLink('Delete');
    $this
      ->assertSession()
      ->pageTextContains('Are you sure you want to delete Save and publish from Test?');
    $this
      ->submitForm([], 'Delete');
    $workflow = $workflow_storage
      ->loadUnchanged('test');
    $this
      ->assertFalse($workflow
      ->getTypePlugin()
      ->hasTransitionFromStateToState('published', 'published'), 'Cannot transition from published to published');

    // Try creating a duplicate state.
    $this
      ->drupalGet('admin/config/workflow/workflows/manage/test');
    $this
      ->clickLink('Add a new state');
    $this
      ->submitForm([
      'label' => 'Draft',
      'id' => 'draft',
    ], 'Save');
    $this
      ->assertSession()
      ->pageTextContains('The machine-readable name is already in use. It must be unique.');

    // Ensure that weight changes the state ordering.
    $workflow = $workflow_storage
      ->loadUnchanged('test');
    $this
      ->assertEquals('published', $workflow
      ->getTypePlugin()
      ->getInitialState()
      ->id());
    $this
      ->drupalGet('admin/config/workflow/workflows/manage/test');
    $this
      ->submitForm([
      'states[draft][weight]' => '-1',
    ], 'Save');
    $workflow = $workflow_storage
      ->loadUnchanged('test');
    $this
      ->assertEquals('draft', $workflow
      ->getTypePlugin()
      ->getInitialState()
      ->id());

    // Verify that we are still on the workflow edit page.
    $this
      ->assertSession()
      ->addressEquals('admin/config/workflow/workflows/manage/test');

    // Ensure that weight changes the transition ordering.
    $this
      ->assertEquals([
      'publish',
      'create_new_draft',
    ], array_keys($workflow
      ->getTypePlugin()
      ->getTransitions()));
    $this
      ->drupalGet('admin/config/workflow/workflows/manage/test');
    $this
      ->submitForm([
      'transitions[create_new_draft][weight]' => '-1',
    ], 'Save');
    $workflow = $workflow_storage
      ->loadUnchanged('test');
    $this
      ->assertEquals([
      'create_new_draft',
      'publish',
    ], array_keys($workflow
      ->getTypePlugin()
      ->getTransitions()));

    // Verify that we are still on the workflow edit page.
    $this
      ->assertSession()
      ->addressEquals('admin/config/workflow/workflows/manage/test');

    // Ensure that a delete link for the published state exists before deleting
    // the draft state.
    $published_delete_link = Url::fromRoute('entity.workflow.delete_state_form', [
      'workflow' => $workflow
        ->id(),
      'workflow_state' => 'published',
    ])
      ->toString();
    $draft_delete_link = Url::fromRoute('entity.workflow.delete_state_form', [
      'workflow' => $workflow
        ->id(),
      'workflow_state' => 'draft',
    ])
      ->toString();
    $this
      ->assertSession()
      ->elementContains('css', 'tr[data-drupal-selector="edit-states-published"]', 'Delete');
    $this
      ->assertSession()
      ->linkByHrefExists($published_delete_link);
    $this
      ->assertSession()
      ->linkByHrefExists($draft_delete_link);

    // Make the published state a default state and ensure it is no longer
    // linked.
    \Drupal::state()
      ->set('workflow_type_test.required_states', [
      'published',
    ]);
    $this
      ->getSession()
      ->reload();
    $this
      ->assertSession()
      ->linkByHrefNotExists($published_delete_link);
    $this
      ->assertSession()
      ->linkByHrefExists($draft_delete_link);
    $this
      ->assertSession()
      ->elementNotContains('css', 'tr[data-drupal-selector="edit-states-published"]', 'Delete');
    \Drupal::state()
      ->set('workflow_type_test.required_states', []);
    $this
      ->getSession()
      ->reload();
    $this
      ->assertSession()
      ->elementContains('css', 'tr[data-drupal-selector="edit-states-published"]', 'Delete');
    $this
      ->assertSession()
      ->linkByHrefExists($published_delete_link);
    $this
      ->assertSession()
      ->linkByHrefExists($draft_delete_link);

    // Delete the Draft state.
    $this
      ->clickLink('Delete');
    $this
      ->assertSession()
      ->pageTextContains('Are you sure you want to delete Draft from Test?');
    $this
      ->submitForm([], 'Delete');
    $this
      ->assertSession()
      ->pageTextContains('State Draft deleted.');
    $workflow = $workflow_storage
      ->loadUnchanged('test');
    $this
      ->assertFalse($workflow
      ->getTypePlugin()
      ->hasState('draft'), 'Draft state deleted');
    $this
      ->assertTrue($workflow
      ->getTypePlugin()
      ->hasState('published'), 'Workflow still has published state');

    // The last state cannot be deleted so the only delete link on the page will
    // be for the workflow.
    $this
      ->assertSession()
      ->linkByHrefNotExists($published_delete_link);
    $this
      ->clickLink('Delete');
    $this
      ->assertSession()
      ->pageTextContains('Are you sure you want to delete Test?');
    $this
      ->submitForm([], 'Delete');
    $this
      ->assertSession()
      ->pageTextContains('Workflow Test deleted.');
    $this
      ->assertSession()
      ->pageTextContains('There are no workflows yet.');
    $this
      ->assertNull($workflow_storage
      ->loadUnchanged('test'), 'The test workflow has been deleted');

    // Ensure that workflow types with default configuration are initialized
    // correctly.
    $this
      ->drupalGet('admin/config/workflow/workflows');
    $this
      ->clickLink('Add workflow');
    $this
      ->submitForm([
      'label' => 'Test 2',
      'id' => 'test2',
      'workflow_type' => 'workflow_type_required_state_test',
    ], 'Save');
    $this
      ->assertSession()
      ->addressEquals('admin/config/workflow/workflows/manage/test2');
    $workflow = $workflow_storage
      ->loadUnchanged('test2');
    $this
      ->assertTrue($workflow
      ->getTypePlugin()
      ->hasState('fresh'), 'The workflow has the "fresh" state');
    $this
      ->assertTrue($workflow
      ->getTypePlugin()
      ->hasState('rotten'), 'The workflow has the "rotten" state');
    $this
      ->assertTrue($workflow
      ->getTypePlugin()
      ->hasTransition('rot'), 'The workflow has the "rot" transition');
    $this
      ->assertSession()
      ->pageTextContains('Fresh');
    $this
      ->assertSession()
      ->pageTextContains('Rotten');
  }

  /**
   * Tests the workflow configuration form.
   */
  public function testWorkflowConfigurationForm() {
    $workflow = Workflow::create([
      'id' => 'test',
      'type' => 'workflow_type_complex_test',
      'label' => 'Test',
    ]);
    $workflow
      ->getTypePlugin()
      ->addState('published', 'Published')
      ->addTransition('publish', 'Publish', [
      'published',
    ], 'published');
    $workflow
      ->save();
    $this
      ->drupalLogin($this
      ->createUser([
      'administer workflows',
    ]));

    // Add additional information to the workflow via the configuration form.
    $this
      ->drupalGet('admin/config/workflow/workflows/manage/test');
    $this
      ->assertSession()
      ->pageTextContains('Example global workflow setting');
    $this
      ->submitForm([
      'type_settings[example_setting]' => 'Extra global settings',
    ], 'Save');
    $workflow_storage = $this->container
      ->get('entity_type.manager')
      ->getStorage('workflow');
    $workflow = $workflow_storage
      ->loadUnchanged('test');
    $this
      ->assertEquals('Extra global settings', $workflow
      ->getTypePlugin()
      ->getConfiguration()['example_setting']);
  }

  /**
   * Tests a workflow, state, and transition can have a numeric ID and label.
   */
  public function testNumericIds() {
    $this
      ->drupalLogin($this
      ->createUser([
      'administer workflows',
    ]));
    $this
      ->drupalGet('admin/config/workflow/workflows');
    $this
      ->clickLink('Add workflow');
    $this
      ->submitForm([
      'label' => 123,
      'id' => 123,
      'workflow_type' => 'workflow_type_complex_test',
    ], 'Save');
    $this
      ->assertSession()
      ->addressEquals('admin/config/workflow/workflows/manage/123/add_state');
    $this
      ->submitForm([
      'label' => 456,
      'id' => 456,
    ], 'Save');
    $this
      ->assertSession()
      ->pageTextContains('Created 456 state.');
    $this
      ->clickLink('Add a new state');
    $this
      ->submitForm([
      'label' => 789,
      'id' => 789,
    ], 'Save');
    $this
      ->assertSession()
      ->pageTextContains('Created 789 state.');
    $this
      ->clickLink('Add a new transition');
    $this
      ->submitForm([
      'id' => 101112,
      'label' => 101112,
      'from[456]' => 456,
      'to' => 789,
    ], 'Save');
    $this
      ->assertSession()
      ->pageTextContains('Created 101112 transition.');
    $workflow = $this->container
      ->get('entity_type.manager')
      ->getStorage('workflow')
      ->loadUnchanged(123);
    $this
      ->assertEquals(123, $workflow
      ->id());
    $this
      ->assertEquals(456, $workflow
      ->getTypePlugin()
      ->getState(456)
      ->id());
    $this
      ->assertEquals(101112, $workflow
      ->getTypePlugin()
      ->getTransition(101112)
      ->id());
    $this
      ->assertEquals(789, $workflow
      ->getTypePlugin()
      ->getTransition(101112)
      ->to()
      ->id());
  }

  /**
   * Tests the sorting of states and transitions by weight and label.
   */
  public function testSorting() {
    $workflow = Workflow::create([
      'id' => 'test',
      'type' => 'workflow_type_complex_test',
      'label' => 'Test',
    ]);
    $workflow
      ->getTypePlugin()
      ->setConfiguration([
      'states' => [
        'two_a' => [
          'label' => 'two a',
          'weight' => 2,
        ],
        'three' => [
          'label' => 'three',
          'weight' => 3,
        ],
        'two_b' => [
          'label' => 'two b',
          'weight' => 2,
        ],
        'one' => [
          'label' => 'one',
          'weight' => 1,
        ],
      ],
      'transitions' => [
        'three' => [
          'label' => 'three',
          'from' => [
            'three',
          ],
          'to' => 'three',
          'weight' => 3,
        ],
        'two_a' => [
          'label' => 'two a',
          'from' => [
            'two_a',
          ],
          'to' => 'two_a',
          'weight' => 2,
        ],
        'one' => [
          'label' => 'one',
          'from' => [
            'one',
          ],
          'to' => 'one',
          'weight' => 1,
        ],
        'two_b' => [
          'label' => 'two b',
          'from' => [
            'two_b',
          ],
          'to' => 'two_b',
          'weight' => 2,
        ],
      ],
    ]);
    $workflow
      ->save();
    $this
      ->drupalLogin($this
      ->createUser([
      'administer workflows',
    ]));
    $this
      ->drupalGet('admin/config/workflow/workflows/manage/test');
    $expected_states = [
      'one',
      'two a',
      'two b',
      'three',
    ];
    $elements = $this
      ->xpath('//details[@id="edit-states-container"]//table/tbody/tr');
    foreach ($elements as $key => $element) {
      $this
        ->assertEquals($expected_states[$key], $element
        ->find('xpath', 'td')
        ->getText());
    }
    $expected_transitions = [
      'one',
      'two a',
      'two b',
      'three',
    ];
    $elements = $this
      ->xpath('//details[@id="edit-transitions-container"]//table/tbody/tr');
    foreach ($elements as $key => $element) {
      $this
        ->assertEquals($expected_transitions[$key], $element
        ->find('xpath', 'td')
        ->getText());
    }

    // Ensure that there are enough weights to satisfy the potential number of
    // states and transitions.
    $this
      ->assertSession()
      ->selectExists('states[three][weight]')
      ->selectOption('2');
    $this
      ->assertSession()
      ->selectExists('states[three][weight]')
      ->selectOption('-2');
    $this
      ->assertSession()
      ->selectExists('transitions[three][weight]')
      ->selectOption('2');
    $this
      ->assertSession()
      ->selectExists('transitions[three][weight]')
      ->selectOption('-2');
  }

}

Members

Name	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::$profile	protected	property	The profile to install as a basis for testing.	39
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
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
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
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.
WorkflowUiTest::$defaultTheme	protected	property	The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
WorkflowUiTest::$modules	protected static	property	Modules to enable. Overrides BrowserTestBase::$modules
WorkflowUiTest::setUp	protected	function	Overrides BrowserTestBase::setUp
WorkflowUiTest::testAccess	public	function	Tests route access/permissions.
WorkflowUiTest::testNumericIds	public	function	Tests a workflow, state, and transition can have a numeric ID and label.
WorkflowUiTest::testSorting	public	function	Tests the sorting of states and transitions by weight and label.
WorkflowUiTest::testStateMachineNameValidation	public	function	Tests the machine name validation of the state add form.
WorkflowUiTest::testWorkflowConfigurationForm	public	function	Tests the workflow configuration form.
WorkflowUiTest::testWorkflowCreation	public	function	Tests the creation of a workflow through the UI.
XdebugRequestTrait::extractCookiesFromRequest	protected	function	Adds xdebug cookies, from request setup.