class DeveloperAppFieldTest in Apigee Edge 8

Fieldable developer app test.

@group apigee_edge @group apigee_edge_developer_app @group apigee_edge_field

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\apigee_edge\Functional\ApigeeEdgeFunctionalTestBase uses ApigeeEdgeFunctionalTestTrait
    • class \Drupal\Tests\apigee_edge\Functional\DeveloperAppFieldTest uses FieldUiTestTrait

File

tests/src/Functional/DeveloperAppFieldTest.php, line 39

Namespace

Drupal\Tests\apigee_edge\Functional

class DeveloperAppFieldTest extends ApigeeEdgeFunctionalTestBase {
  use FieldUiTestTrait;

  /**
   * {@inheritdoc}
   */
  protected static $modules = [
    'link',
    'block',
    'field_ui',
  ];

  /**
   * The Drupal user that belongs to the developer app's developer.
   *
   * @var \Drupal\user\UserInterface
   */
  protected $account;

  /**
   * The owner of the developer app.
   *
   * @var \Drupal\apigee_edge\Entity\DeveloperInterface
   */
  protected $developer;

  /**
   * Developer app to test.
   *
   * @var \Drupal\apigee_edge\Entity\DeveloperAppInterface
   */
  protected $developerApp;

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();
    $this
      ->drupalPlaceBlock('system_breadcrumb_block');
    $this->account = $this
      ->createAccount([
      'administer apigee edge',
      'administer developer_app',
      'administer display modes',
      'administer developer_app fields',
      'administer developer_app form display',
      'administer developer_app display',
    ]);
    $this->developer = Developer::load($this->account
      ->getEmail());
    $this->developerApp = DeveloperApp::create([
      'name' => $this
        ->randomMachineName(),
      'status' => App::STATUS_APPROVED,
      'developerId' => $this->developer
        ->getDeveloperId(),
    ]);
    $this->developerApp
      ->setOwner($this->account);
    $this->developerApp
      ->save();
    $this
      ->drupalLogin($this->account);
  }

  /**
   * {@inheritdoc}
   */
  protected function tearDown() {
    try {
      if ($this->account !== NULL) {
        $this->account
          ->delete();
      }
    } catch (\Exception $exception) {
      $this
        ->logException($exception);
    }
    parent::tearDown();
  }

  /**
   * Tests fieldable developer app entity.
   */
  public function testFieldableDeveloperApp() {
    $this
      ->fieldStorageFormattersTest();
    $this
      ->typesTest();
    $this
      ->requiredFieldTest();
    $this
      ->formRegionTest();
    $this
      ->viewRegionTest();
    $this
      ->credentialsViewTest();
  }

  /**
   * Tests field storage formatters (CSV and JSON).
   */
  protected function fieldStorageFormattersTest() {
    $field_name_prefix = (string) $this
      ->config('field_ui.settings')
      ->get('field_prefix');
    $paragraph = trim($this
      ->getRandomGenerator()
      ->paragraphs(1));
    $paragraphs = trim($this
      ->getRandomGenerator()
      ->paragraphs());
    $link = [
      [
        'uri' => 'http://example.com',
        'title' => 'Example',
        'options' => [],
        'attributes' => [],
      ],
    ];
    $fields = [
      strtolower($this
        ->randomMachineName()) => [
        'type' => 'boolean',
        'data' => [
          [
            'value' => TRUE,
          ],
        ],
        'encoded' => '1',
      ],
      strtolower($this
        ->randomMachineName()) => [
        'type' => 'float',
        'data' => [
          [
            'value' => M_PI,
          ],
          [
            'value' => M_E,
          ],
          [
            'value' => M_EULER,
          ],
        ],
        'encoded' => implode(',', [
          M_PI,
          M_E,
          M_EULER,
        ]),
      ],
      strtolower($this
        ->randomMachineName()) => [
        'type' => 'integer',
        'data' => [
          [
            'value' => 4,
          ],
          [
            'value' => 9,
          ],
        ],
        'encoded' => '4,9',
      ],
      strtolower($this
        ->randomMachineName()) => [
        'type' => 'decimal',
        'data' => [
          [
            'value' => '0.1',
          ],
        ],
        'encoded' => '0.1',
      ],
      strtolower($this
        ->randomMachineName()) => [
        'type' => 'list_float',
        'settings' => [
          'settings[allowed_values]' => implode(PHP_EOL, [
            M_PI,
            M_E,
            M_EULER,
          ]),
        ],
        'data' => [
          [
            'value' => M_PI,
          ],
        ],
        'encoded' => (string) M_PI,
      ],
      strtolower($this
        ->randomMachineName()) => [
        'type' => 'list_integer',
        'settings' => [
          'settings[allowed_values]' => implode(PHP_EOL, [
            1,
            2,
            3,
          ]),
        ],
        'data' => [
          [
            'value' => 2,
          ],
          [
            'value' => 3,
          ],
        ],
        'encoded' => '2,3',
      ],
      strtolower($this
        ->randomMachineName()) => [
        'type' => 'list_string',
        'settings' => [
          'settings[allowed_values]' => implode(PHP_EOL, [
            'qwer',
            'asdf',
            'zxcv',
          ]),
        ],
        'data' => [
          [
            'value' => 'qwer',
          ],
          [
            'value' => 'asdf',
          ],
          [
            'value' => 'zxcv',
          ],
        ],
        'encoded' => 'qwer,asdf,zxcv',
      ],
      strtolower($this
        ->randomMachineName()) => [
        'type' => 'string',
        'data' => [
          [
            'value' => $paragraph,
          ],
        ],
        'encoded' => "\"{$paragraph}\"",
      ],
      strtolower($this
        ->randomMachineName()) => [
        'type' => 'string_long',
        'data' => [
          [
            'value' => $paragraphs,
          ],
        ],
        'encoded' => "\"{$paragraphs}\"",
      ],
      strtolower($this
        ->randomMachineName()) => [
        'type' => 'email',
        'data' => [
          [
            'value' => '[e-mail]',
          ],
          [
            'value' => '[e-mail]',
          ],
        ],
        'encoded' => '[e-mail],[e-mail]',
      ],
      strtolower($this
        ->randomMachineName()) => [
        'type' => 'timestamp',
        'data' => [
          [
            'value' => 1531212177,
          ],
          [
            'value' => 1531234234,
          ],
        ],
        'encoded' => '1531212177,1531234234',
      ],
      strtolower($this
        ->randomMachineName()) => [
        'type' => 'link',
        'data' => $link,
        'encoded' => json_encode($link),
      ],
    ];

    // Add fields to developer app.
    $add_field_path = Url::fromRoute('apigee_edge.settings.developer_app')
      ->toString();
    foreach ($fields as $name => $data) {
      $this
        ->fieldUIAddNewField($add_field_path, $name, mb_strtoupper($name), $data['type'], ($data['settings'] ?? []) + [
        'cardinality' => -1,
      ], []);
    }
    drupal_flush_all_caches();
    $this->developerApp = DeveloperApp::load($this->developerApp
      ->id());

    // Save field values as developer app entity attributes.
    foreach ($fields as $name => $data) {
      $full_field_name = "{$field_name_prefix}{$name}";
      $this->developerApp
        ->set($full_field_name, $data['data']);
    }
    $this->developerApp
      ->save();

    /** @var \Drupal\apigee_edge\Entity\DeveloperApp $loaded_app */
    $loaded_app = DeveloperApp::load($this->developerApp
      ->id());

    /** @var \Drupal\apigee_edge\SDKConnectorInterface $connector */
    $connector = $this->container
      ->get('apigee_edge.sdk_connector');
    $controller = new DeveloperAppController($connector
      ->getOrganization(), $this->developer
      ->getDeveloperId(), $connector
      ->getClient());

    /** @var \Apigee\Edge\Api\Management\Entity\DeveloperApp $rawLoadedApp */
    $rawLoadedApp = $controller
      ->load($this->developerApp
      ->getName());
    foreach ($fields as $name => $data) {
      $full_field_name = "{$field_name_prefix}{$name}";
      $this
        ->assertEquals($data['data'], $loaded_app
        ->get($full_field_name)
        ->getValue());
      $this
        ->assertEquals($data['encoded'], $rawLoadedApp
        ->getAttributeValue($name));
    }
  }

  /**
   * Tests developer app entity preSave().
   */
  protected function typesTest() {
    $field_values = [
      'scopes' => [
        'a',
        'b',
        'c',
      ],
      'displayName' => $this
        ->getRandomGenerator()
        ->word(16),
    ];
    foreach ($field_values as $field_name => $field_value) {
      $this->developerApp
        ->set($field_name, $field_value);
    }
    $this->developerApp
      ->preSave(new class implements EntityStorageInterface {

      /**
       * {@inheritdoc}
       */
      public function resetCache(array $ids = NULL) {
      }

      /**
       * {@inheritdoc}
       */
      public function loadMultiple(array $ids = NULL) {
      }

      /**
       * {@inheritdoc}
       */
      public function load($id) {
      }

      /**
       * {@inheritdoc}
       */
      public function loadUnchanged($id) {
      }

      /**
       * {@inheritdoc}
       */
      public function loadRevision($revision_id) {
      }

      /**
       * {@inheritdoc}
       */
      public function deleteRevision($revision_id) {
      }

      /**
       * {@inheritdoc}
       */
      public function loadByProperties(array $values = []) {
      }

      /**
       * {@inheritdoc}
       */
      public function create(array $values = []) {
      }

      /**
       * {@inheritdoc}
       */
      public function delete(array $entities) {
      }

      /**
       * {@inheritdoc}
       */
      public function save(EntityInterface $entity) {
      }

      /**
       * {@inheritdoc}
       */
      public function hasData() {
      }

      /**
       * {@inheritdoc}
       */
      public function getQuery($conjunction = 'AND') {
      }

      /**
       * {@inheritdoc}
       */
      public function getAggregateQuery($conjunction = 'AND') {
      }

      /**
       * {@inheritdoc}
       */
      public function getEntityTypeId() {
      }

      /**
       * {@inheritdoc}
       */
      public function getEntityType() {
      }

      /**
       * {@inheritdoc}
       */
      public function restore(EntityInterface $entity) {
      }

    });
    foreach ($field_values as $field_name => $field_value) {
      $getter = 'get' . ucfirst($field_name);
      $value = call_user_func([
        $this->developerApp,
        $getter,
      ]);
      if ($value instanceof \DateTimeImmutable) {
        $value = $value
          ->getTimestamp();
      }
      $this
        ->assertEquals($field_value, $value);
    }
  }

  /**
   * Tests settings base fields required.
   */
  protected function requiredFieldTest() {

    // The form can be saved with default settings.
    $this
      ->submitBaseFieldConfigForm();

    // Move the callbackUrl to hidden.
    $this
      ->submitFormDisplay([
      'callbackUrl' => 'hidden',
    ]);

    // The callbackUrl can't be required.
    $this
      ->submitBaseFieldConfigForm(TRUE, TRUE, FALSE);

    // Move back callbackUrl to visible.
    $this
      ->submitFormDisplay([
      'callbackUrl' => 'content',
    ]);

    // The callbackUrl can be required.
    $this
      ->submitBaseFieldConfigForm(TRUE, TRUE);

    // The callbackUrl can't be hidden.
    $this
      ->submitFormDisplay([
      'callbackUrl' => 'hidden',
    ], FALSE);

    // The callbackUrl is not required.
    $this
      ->submitBaseFieldConfigForm(FALSE, FALSE);
  }

  /**
   * Tests form regions.
   */
  protected function formRegionTest() {
    $this
      ->assertFieldVisibleOnEntityForm('Callback URL');
    $this
      ->submitFormDisplay([
      'callbackUrl' => 'hidden',
    ]);
    $this
      ->assertFieldVisibleOnEntityForm('Callback URL', FALSE);
    $this
      ->submitFormDisplay([
      'callbackUrl' => 'content',
    ]);
    $this
      ->assertFieldVisibleOnEntityForm('Callback URL');
  }

  /**
   * Tests the view regions.
   */
  protected function viewRegionTest() {
    $callbackUrl = 'https://' . strtolower($this
      ->randomMachineName()) . '.example.com';
    $this->developerApp
      ->setCallbackUrl($callbackUrl);
    $this->developerApp
      ->save();
    $assert = function (bool $visible = TRUE) use ($callbackUrl) {
      $this
        ->assertFieldVisibleOnEntityDisplay($this->developerApp
        ->getName(), 'Callback URL', $callbackUrl, $visible);
    };
    $this
      ->submitViewDisplay([
      'callbackUrl' => 'content',
    ]);
    $assert(TRUE);
    $this
      ->submitViewDisplay([
      'callbackUrl' => 'hidden',
    ]);
    $assert(FALSE);
  }

  /**
   * Tests showing and hiding credentials on the developer app view.
   */
  protected function credentialsViewTest() {
    $assert = function (bool $visible = TRUE) {
      $this
        ->assertFieldVisibleOnEntityDisplay($this->developerApp
        ->getName(), 'Credential', 'Key Status', $visible);
    };
    $this
      ->submitViewDisplay([
      'credentials' => 'hidden',
    ]);
    $assert(FALSE);
    $this
      ->submitViewDisplay([
      'credentials' => 'content',
    ]);
    $assert(TRUE);
  }

  /**
   * Saves the developer app's base field config form.
   *
   * @param bool $description_required
   *   Whether the description must be required.
   * @param bool $callback_url_required
   *   Whether the callback url must be required.
   * @param bool $expect_success
   *   Whether to expect success or a validation error.
   */
  protected function submitBaseFieldConfigForm(bool $description_required = FALSE, bool $callback_url_required = FALSE, bool $expect_success = TRUE) {
    $this
      ->drupalPostForm(Url::fromRoute('entity.developer_app.field_ui_fields'), [
      'table[description][required]' => $description_required,
      'table[callbackUrl][required]' => $callback_url_required,
    ], 'Save');
    if ($expect_success) {
      $this
        ->assertSession()
        ->pageTextContains('Field settings have been saved successfully.');
    }
    else {
      $this
        ->assertSession()
        ->pageTextContains('is hidden on the default form display.');
    }
  }

  /**
   * Saves the developer app's form display settings.
   *
   * @param array $region_overrides
   *   Which field's regions should be changed. Key is the field name, value is
   *   the region.
   * @param bool $expect_success
   *   Whether to expect success or a validation error.
   */
  protected function submitFormDisplay(array $region_overrides = [], bool $expect_success = TRUE) {
    $edit = [];
    foreach ($region_overrides as $field => $region) {
      $edit["fields[{$field}][region]"] = $region;
    }
    $this
      ->drupalPostForm(Url::fromRoute('entity.entity_form_display.developer_app.default'), $edit, 'Save');
    if ($expect_success) {
      $this
        ->assertSession()
        ->pageTextContains('Your settings have been saved.');
    }
    else {
      $this
        ->assertSession()
        ->pageTextContains('is required.');
    }
  }

  /**
   * Saves the developer app's view display settings.
   *
   * @param array $region_overrides
   *   Which field's regions should be changed. Key is the field name, value is
   *   the region.
   */
  protected function submitViewDisplay(array $region_overrides = []) {
    $edit = [];
    foreach ($region_overrides as $field => $region) {
      $edit["fields[{$field}][region]"] = $region;
    }
    $this
      ->drupalPostForm(Url::fromRoute('entity.entity_view_display.developer_app.default'), $edit, 'Save');
    $this
      ->assertSession()
      ->pageTextContains('Your settings have been saved.');
  }

  /**
   * Asserts whether a field is visible on the entity form.
   *
   * @param string $field_label
   *   Label of the field.
   * @param bool $visible
   *   Whether it should be visible or not.
   */
  protected function assertFieldVisibleOnEntityForm(string $field_label, bool $visible = TRUE) {
    $this
      ->drupalGet(Url::fromRoute('entity.developer_app.add_form_for_developer', [
      'user' => $this->account
        ->id(),
    ]));
    $this
      ->assertEquals(Response::HTTP_OK, $this
      ->getSession()
      ->getStatusCode());
    if ($visible) {
      $this
        ->assertSession()
        ->pageTextContains($field_label);
    }
    else {
      $this
        ->assertSession()
        ->pageTextNotContains($field_label);
    }
  }

  /**
   * Asserts whether a field is visible on the entity view.
   *
   * @param string $app_name
   *   Name of the app.
   * @param string $field_label
   *   Label of the field.
   * @param string $field_value
   *   Value of the field to assert.
   * @param bool $visible
   *   Whether it should be visible or not.
   */
  protected function assertFieldVisibleOnEntityDisplay(string $app_name, string $field_label, string $field_value, bool $visible = TRUE) {
    $this
      ->drupalGet(Url::fromRoute('entity.developer_app.canonical_by_developer', [
      'user' => $this->account
        ->id(),
      'app' => $app_name,
    ]));
    if ($visible) {
      $this
        ->assertSession()
        ->pageTextContains($field_label);
      $this
        ->assertSession()
        ->pageTextContains($field_value);
    }
    else {
      $this
        ->assertSession()
        ->pageTextNotContains($field_label);
      $this
        ->assertSession()
        ->pageTextNotContains($field_value);
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ApigeeEdgeFunctionalTestBase::$defaultTheme	protected	property	For tests relying on no markup at all or at least no core markup. Overrides BrowserTestBase::$defaultTheme
ApigeeEdgeFunctionalTestTrait::$mock_api_client_ready	protected static	property	Use the mock_api_client or not.	9
ApigeeEdgeFunctionalTestTrait::clickLinkProperly	protected	function	Implements link clicking properly.
ApigeeEdgeFunctionalTestTrait::createAccount	protected	function	Creates a Drupal account.
ApigeeEdgeFunctionalTestTrait::createDeveloperApp	protected	function	Creates an app for a user. Overrides ApigeeMockApiClientHelperTrait::createDeveloperApp
ApigeeEdgeFunctionalTestTrait::createProduct	protected	function	Creates a product.
ApigeeEdgeFunctionalTestTrait::disableUserPresave	protected	function	The corresponding developer will not be created if a Drupal user is saved.
ApigeeEdgeFunctionalTestTrait::drupalGetNoMetaRefresh	protected	function	The same as drupalGet(), but ignores the meta refresh.
ApigeeEdgeFunctionalTestTrait::enableUserPresave	protected	function	The corresponding developer will be created if a Drupal user is saved.
ApigeeEdgeFunctionalTestTrait::findLink	protected	function	Finds a link on the current page.
ApigeeEdgeFunctionalTestTrait::fixUrl	protected static	function	Returns absolute URL starts with a slash.
ApigeeEdgeFunctionalTestTrait::getApps	protected	function	Loads all apps for a given user.	1
ApigeeEdgeFunctionalTestTrait::getRandomUniqueId	protected	function	Gets a random unique ID.
ApigeeEdgeFunctionalTestTrait::initTestEnv	protected	function	Initializes test environment with required configuration.
ApigeeEdgeFunctionalTestTrait::logException	protected	function	Log the given exception using the class short name as type.
ApigeeEdgeUtilTestTrait::createTestKey	protected	function	Creates a test key from environment variables, using config key storage.
ApigeeEdgeUtilTestTrait::invalidateKey	protected	function	Removes the active key for testing with unset API credentials.
ApigeeEdgeUtilTestTrait::restoreKey	protected	function	Restores the active key.
ApigeeEdgeUtilTestTrait::setKey	protected	function	Set active authentication keys in config.
ApigeeMockApiClientHelperTrait::$entityTypeManager	protected	property	The entity type manager.
ApigeeMockApiClientHelperTrait::$integration_enabled	protected	property	If integration (real API connection) is enabled.
ApigeeMockApiClientHelperTrait::$mockResponseFactory	protected	property	The mock response factory service.
ApigeeMockApiClientHelperTrait::$sdkConnector	protected	property	The SDK connector service.	1
ApigeeMockApiClientHelperTrait::$stack	protected	property	The mock handler stack is responsible for serving queued api responses.
ApigeeMockApiClientHelperTrait::addDeveloperMatchedResponse	protected	function	Add matched developer response.
ApigeeMockApiClientHelperTrait::addOrganizationMatchedResponse	protected	function	Add matched org response.
ApigeeMockApiClientHelperTrait::addUserToTeam	public	function	Adds a user to a team.
ApigeeMockApiClientHelperTrait::apigeeTestHelperSetup	protected	function	Setup.
ApigeeMockApiClientHelperTrait::apigeeTestPropertiesSetup	protected	function	Setup.
ApigeeMockApiClientHelperTrait::createTeam	protected	function	Helper to create a Team entity.
ApigeeMockApiClientHelperTrait::initAuth	protected	function	Initialize SDK connector.
ApigeeMockApiClientHelperTrait::installExtraModules	protected	function	Installs a given list of modules and rebuilds the cache.
ApigeeMockApiClientHelperTrait::queueCompaniesResponse	protected	function	Queues up a mock companies response.
ApigeeMockApiClientHelperTrait::queueCompanyResponse	protected	function	Queues up a mock company response.
ApigeeMockApiClientHelperTrait::queueDeveloperAppResponse	protected	function	Helper to add Edge entity response to stack.
ApigeeMockApiClientHelperTrait::queueDeveloperResponse	protected	function	Queues up a mock developer response.
ApigeeMockApiClientHelperTrait::queueDeveloperResponseFromDeveloper	protected	function	Queues up a mock developer response.
ApigeeMockApiClientHelperTrait::queueDevsInCompanyResponse	protected	function	Queues up a mock developers in a company response.
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::$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::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::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
DeveloperAppFieldTest::$account	protected	property	The Drupal user that belongs to the developer app's developer.
DeveloperAppFieldTest::$developer	protected	property	The owner of the developer app.
DeveloperAppFieldTest::$developerApp	protected	property	Developer app to test.
DeveloperAppFieldTest::$modules	protected static	property	Modules to enable. Overrides BrowserTestBase::$modules
DeveloperAppFieldTest::assertFieldVisibleOnEntityDisplay	protected	function	Asserts whether a field is visible on the entity view.
DeveloperAppFieldTest::assertFieldVisibleOnEntityForm	protected	function	Asserts whether a field is visible on the entity form.
DeveloperAppFieldTest::credentialsViewTest	protected	function	Tests showing and hiding credentials on the developer app view.
DeveloperAppFieldTest::fieldStorageFormattersTest	protected	function	Tests field storage formatters (CSV and JSON).
DeveloperAppFieldTest::formRegionTest	protected	function	Tests form regions.
DeveloperAppFieldTest::requiredFieldTest	protected	function	Tests settings base fields required.
DeveloperAppFieldTest::setUp	protected	function	Overrides ApigeeEdgeFunctionalTestBase::setUp
DeveloperAppFieldTest::submitBaseFieldConfigForm	protected	function	Saves the developer app's base field config form.
DeveloperAppFieldTest::submitFormDisplay	protected	function	Saves the developer app's form display settings.
DeveloperAppFieldTest::submitViewDisplay	protected	function	Saves the developer app's view display settings.
DeveloperAppFieldTest::tearDown	protected	function	Overrides BrowserTestBase::tearDown
DeveloperAppFieldTest::testFieldableDeveloperApp	public	function	Tests fieldable developer app entity.
DeveloperAppFieldTest::typesTest	protected	function	Tests developer app entity preSave().
DeveloperAppFieldTest::viewRegionTest	protected	function	Tests the view regions.
FieldUiTestTrait::fieldUIAddExistingField	public	function	Adds an existing field through the Field UI.
FieldUiTestTrait::fieldUIAddNewField	public	function	Creates a new field through the Field UI.
FieldUiTestTrait::fieldUIDeleteField	public	function	Deletes a field through the Field UI.
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
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.