You are here

Home » API reference » Apigee Edge 8 » ApiProductAccessTest.php

class ApiProductAccessTest in Apigee Edge 8

Validates built-in access control on API products.

@group apigee_edge @group apigee_edge_access @group apigee_edge_api_product @group apigee_edge_api_product_access

Hierarchy

Expanded class hierarchy of ApiProductAccessTest

1 file declares its use of ApiProductAccessTest
ApiProductRoleBasedAccessTestBase.php in modules/apigee_edge_apiproduct_rbac/tests/src/FunctionalJavascript/ApiProductRoleBasedAccessTestBase.php

File

tests/src/FunctionalJavascript/ApiProductAccessTest.php, line 40

Namespace

Drupal\Tests\apigee_edge\FunctionalJavascript
View source 
class ApiProductAccessTest extends ApigeeEdgeFunctionalJavascriptTestBase {
  protected const USER_WITH_BYPASS_PERM = 'user_with_bypass_perm';
  protected const INTERNAL_ROLE = 'internal';
  protected const PUBLIC_VISIBILITY = 'public';
  protected const PRIVATE_VISIBILITY = 'private';
  protected const INTERNAL_VISIBILITY = 'internal';
  protected const VISIBILITIES = [
    self::PUBLIC_VISIBILITY,
    self::PRIVATE_VISIBILITY,
    self::INTERNAL_VISIBILITY,
  ];
  protected const SUPPORTED_OPERATIONS = [
    'view',
    'view label',
    'assign',
  ];

  /**
   * Array of created API products.
   *
   * @var \Drupal\apigee_edge\Entity\ApiProductInterface[]
   */
  protected $apiProducts = [];

  /**
   * Array of created developer apps.
   *
   * @var \Drupal\apigee_edge\Entity\DeveloperAppInterface[]
   */
  protected $developerApps = [];

  /**
   * Array of created Drupal users.
   *
   * @var \Drupal\user\UserInterface[]
   */
  protected $users = [];

  /**
   * User role storage.
   *
   * @var \Drupal\user\RoleStorageInterface
   */
  protected $roleStorage;

  /**
   * API product access control handler.
   *
   * @var \Drupal\Core\Entity\EntityAccessControlHandlerInterface
   */
  protected $accessControlHandler;

  /**
   * All possible role combinations.
   *
   * @var array
   */
  protected $ridCombinations;

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();
    $this->roleStorage = $this->container
      ->get('entity_type.manager')
      ->getStorage('user_role');
    $this->accessControlHandler = $this->container
      ->get('entity_type.manager')
      ->getAccessControlHandler('api_product');
    $this->users[AccountInterface::ANONYMOUS_ROLE] = User::getAnonymousUser();
    $this->users[AccountInterface::AUTHENTICATED_ROLE] = $this
      ->createAccount();

    // We granted "Administer developer apps" permission to this role as well
    // just to be able to test the UI.
    $this->users[self::USER_WITH_BYPASS_PERM] = $this
      ->createAccount([
      'bypass api product access control',
    ]);
    $this
      ->createRole([], self::INTERNAL_ROLE, self::INTERNAL_ROLE);
    $this->users[self::INTERNAL_ROLE] = $this
      ->createAccount([]);
    $this->users[self::INTERNAL_ROLE]
      ->addRole(self::INTERNAL_ROLE);
    $this->users[self::INTERNAL_ROLE]
      ->save();
    foreach (self::VISIBILITIES as $visibility) {

      /** @var \Drupal\apigee_edge\Entity\ApiProductInterface $api_product */
      $api_product = ApiProduct::create([
        'name' => $this
          ->randomMachineName(),
        'displayName' => $this
          ->randomMachineName() . " ({$visibility})",
        'approvalType' => ApiProduct::APPROVAL_TYPE_AUTO,
      ]);
      $api_product
        ->setAttribute('access', $visibility);
      $api_product
        ->save();
      $this->apiProducts[$visibility] = $api_product;
    }
    $this->ridCombinations = $this
      ->calculateRidCombinations(array_keys($this->roleStorage
      ->loadMultiple()));
  }

  /**
   * {@inheritdoc}
   */
  protected function tearDown() {

    /** @var \Drupal\Core\Entity\EntityInterface[] $entities */
    $entities = array_merge($this->users, $this->apiProducts);
    foreach ($entities as $entity) {
      try {
        if ($entity !== NULL) {
          $entity
            ->delete();
        }
      } catch (\Exception $exception) {
        $this
          ->logException($exception);
      }
    }
    parent::tearDown();
  }

  /**
   * Tests API product entity access.
   */
  public function testApiProductAccess() {
    $this
      ->entityAccessTest();
    $this
      ->developerAppEditFormTest();
  }

  /**
   * Tests "Access by visibility" access control.
   */
  protected function entityAccessTest() {
    $authenticatedRoles = array_filter(array_keys($this->roleStorage
      ->loadMultiple()), function ($rid) {
      return $rid !== AccountInterface::ANONYMOUS_ROLE;
    });
    $visibilityCombinations = $this
      ->calculateTestCombinations();

    // We calculated all possible combinations from roles and visibilities
    // but existence of Authenticated user role introduces redundant tests.
    $testScenarios = [];
    foreach ($visibilityCombinations as $visibilityCombination) {
      foreach ($this->ridCombinations as $ridCombination) {
        $settings = array_combine($visibilityCombination, array_fill(0, count($visibilityCombination), $ridCombination));

        // Ensure we always have these 3 keys.
        $settings += [
          self::PUBLIC_VISIBILITY => [],
          self::PRIVATE_VISIBILITY => [],
          self::INTERNAL_VISIBILITY => [],
        ];
        $this
          ->saveAccessSettings($settings);

        // We have to clear entity access control handler's static cache because
        // otherwise access results comes from there instead of getting
        // recalculated.
        $this->accessControlHandler
          ->resetCache();
        foreach ($this->users as $userRole => $user) {
          foreach ($this->apiProducts as $product) {
            $rolesWithAccess = $this
              ->getRolesWithAccess($product);

            // Saved configuration designedly contains only the authenticated
            // role and not all (authenticated) roles.
            if (in_array(AccountInterface::AUTHENTICATED_ROLE, $rolesWithAccess)) {
              $rolesWithAccess = array_merge($rolesWithAccess, $authenticatedRoles);
            }

            // Eliminate redundant test scenarios caused by auth.user role.
            sort($rolesWithAccess);
            $testId = md5(sprintf('test-%s-%s-%s', $product
              ->id(), $user
              ->id(), implode('-', $rolesWithAccess) ?? 'empty'));
            if (array_key_exists($testId, $testScenarios)) {
              continue;
            }
            $testScenarios[$testId] = $rolesWithAccess;
            foreach (self::SUPPORTED_OPERATIONS as $operation) {
              $accessGranted = $product
                ->access($operation, $user);
              if (in_array($userRole, $rolesWithAccess)) {
                $this
                  ->assertTrue($accessGranted, $this
                  ->messageIfUserShouldHaveAccessByRole($operation, $user, $userRole, $rolesWithAccess, $product));
              }
              elseif ($this->users[self::USER_WITH_BYPASS_PERM]
                ->id() === $user
                ->id()) {
                $this
                  ->assertTrue($accessGranted, $this
                  ->messageIfUserShouldHaveAccessWithBypassPerm($operation, $user));
              }
              else {
                $this
                  ->assertFalse($accessGranted, $this
                  ->messageIfUserShouldNotHaveAccess($operation, $user, $userRole, $rolesWithAccess, $product));
              }
            }
          }
        }
      }
    }
  }

  /**
   * Test for developer app/edit form.
   *
   * The testEntityAccess() has already ensured that "Access by visibility"
   * access control is working properly on API products. We just have to
   * confirm that developer app/edit forms as leveraging it properly.
   */
  protected function developerAppEditFormTest() {

    // Some utility functions that we are going to use here.
    $onlyPublicProductVisible = function () {
      $this
        ->checkProductVisibility([
        self::PUBLIC_VISIBILITY,
      ], [
        self::PRIVATE_VISIBILITY,
        self::INTERNAL_VISIBILITY,
      ]);
    };
    $allProductsVisible = function () {
      $this
        ->checkProductVisibility([
        self::PUBLIC_VISIBILITY,
        self::PRIVATE_VISIBILITY,
        self::INTERNAL_VISIBILITY,
      ]);
    };
    $justPublicAndPrivateVisible = function () {
      $this
        ->checkProductVisibility([
        self::PUBLIC_VISIBILITY,
        self::PRIVATE_VISIBILITY,
      ], [
        self::INTERNAL_VISIBILITY,
      ]);
    };

    // Enforce this "Access by visibility" configuration.
    $this
      ->saveAccessSettings([
      self::PUBLIC_VISIBILITY => [
        AccountInterface::AUTHENTICATED_ROLE,
      ],
      self::PRIVATE_VISIBILITY => [],
      self::INTERNAL_VISIBILITY => [],
    ]);

    /** @var \Drupal\apigee_edge\Entity\DeveloperAppInterface $auth_user_app */
    $auth_user_app = DeveloperApp::create([
      'name' => $this
        ->randomMachineName(),
      'status' => App::STATUS_APPROVED,
      'developerId' => $this->users[AccountInterface::AUTHENTICATED_ROLE]
        ->get('apigee_edge_developer_id')->value,
    ]);
    $auth_user_app
      ->setOwner($this->users[AccountInterface::AUTHENTICATED_ROLE]);
    $auth_user_app
      ->save();

    /** @var \Drupal\apigee_edge\Entity\DeveloperAppInterface $bypass_user_app */
    $bypass_user_app = DeveloperApp::create([
      'name' => $this
        ->randomMachineName(),
      'status' => App::STATUS_APPROVED,
      'developerId' => $this->users[self::USER_WITH_BYPASS_PERM]
        ->get('apigee_edge_developer_id')->value,
    ]);
    $bypass_user_app
      ->setOwner($this->users[self::USER_WITH_BYPASS_PERM]);
    $bypass_user_app
      ->save();

    // >> Authenticated user.
    $this
      ->drupalLogin($this->users[AccountInterface::AUTHENTICATED_ROLE]);

    // Only public API products should be visible by default on the add/edit
    // app forms for authenticated user.
    $this
      ->drupalGet(Url::fromRoute('entity.developer_app.add_form_for_developer', [
      'user' => $this->users[AccountInterface::AUTHENTICATED_ROLE]
        ->id(),
    ]));
    $onlyPublicProductVisible();
    $this
      ->drupalGet(Url::fromRoute('entity.developer_app.edit_form_for_developer', [
      'user' => $this->users[AccountInterface::AUTHENTICATED_ROLE]
        ->id(),
      'app' => $auth_user_app
        ->getName(),
    ]));
    $onlyPublicProductVisible();
    $this
      ->drupalLogout();

    // << Authenticated user.
    // Ensure that user can access to other's developer app add/edit form.

    /** @var \Drupal\user\RoleStorageInterface $roleStorage */
    $role = $this
      ->createRole([
      'administer developer_app',
    ]);
    $this->users[self::USER_WITH_BYPASS_PERM]
      ->addRole($role);
    $this->users[self::USER_WITH_BYPASS_PERM]
      ->save();

    // >> Bypass user.
    $this
      ->drupalLogin($this->users[self::USER_WITH_BYPASS_PERM]);

    // Even if a user has bypass permission they should see only those API
    // Products on another user's add/edit form that the other user has
    // access.
    $this
      ->drupalGet(Url::fromRoute('entity.developer_app.add_form_for_developer', [
      'user' => $this->users[AccountInterface::AUTHENTICATED_ROLE]
        ->id(),
    ]));
    $onlyPublicProductVisible();
    $this
      ->drupalGet(Url::fromRoute('entity.developer_app.edit_form_for_developer', [
      'user' => $this->users[AccountInterface::AUTHENTICATED_ROLE]
        ->id(),
      'app' => $auth_user_app
        ->getName(),
    ]));
    $onlyPublicProductVisible();

    // But on the its own add/edit app forms they should see all API products.
    $this
      ->drupalGet(Url::fromRoute('entity.developer_app.add_form_for_developer', [
      'user' => $this->users[self::USER_WITH_BYPASS_PERM]
        ->id(),
    ]));
    $allProductsVisible();
    $this
      ->drupalGet(Url::fromRoute('entity.developer_app.edit_form_for_developer', [
      'user' => $this->users[self::USER_WITH_BYPASS_PERM]
        ->id(),
      'app' => $bypass_user_app
        ->getName(),
    ]));
    $allProductsVisible();
    $this
      ->drupalLogout();

    // Remove extra role from the user.
    $this->users[self::USER_WITH_BYPASS_PERM]
      ->removeRole($role);
    $this->users[self::USER_WITH_BYPASS_PERM]
      ->save();

    // << Bypass user.
    // Add a private API Product to auth. user's app.

    /** @var \Drupal\apigee_edge\SDKConnectorInterface $connector */
    $dacc = $this->container
      ->get('apigee_edge.controller.developer_app_credential_factory')
      ->developerAppCredentialController($this->users[AccountInterface::AUTHENTICATED_ROLE]
      ->get('apigee_edge_developer_id')->value, $auth_user_app
      ->getName());

    /** @var \Apigee\Edge\Api\Management\Entity\AppCredentialInterface $credential */
    $credentials = $auth_user_app
      ->getCredentials();
    $credential = reset($credentials);
    $dacc
      ->addProducts($credential
      ->getConsumerKey(), [
      $this->apiProducts[self::PRIVATE_VISIBILITY]
        ->id(),
    ]);

    // >> Auth. user.
    $this
      ->drupalLogin($this->users[AccountInterface::AUTHENTICATED_ROLE]);

    // On the add app form still only public API products should be
    // visible.
    $this
      ->drupalGet(Url::fromRoute('entity.developer_app.add_form_for_developer', [
      'user' => $this->users[AccountInterface::AUTHENTICATED_ROLE]
        ->id(),
    ]));
    $onlyPublicProductVisible();

    // But on the app's edit form that contains the private API product that
    // should be visible as well.
    $this
      ->drupalGet(Url::fromRoute('entity.developer_app.edit_form_for_developer', [
      'user' => $this->users[AccountInterface::AUTHENTICATED_ROLE]
        ->id(),
      'app' => $auth_user_app
        ->getName(),
    ]));
    $justPublicAndPrivateVisible();
    $this
      ->drupalLogout();

    // << Auth. user.
  }

  /**
   * Calculates all possible combinations from role ids.
   *
   * @param array $rids
   *   Array of role ids.
   *
   * @return array
   *   All possible combinations calculated from rids.
   */
  protected function calculateRidCombinations(array $rids) : array {
    $ridCombinations = [
      [],
    ];
    foreach ($rids as $rid) {
      foreach ($ridCombinations as $ridCombination) {
        array_push($ridCombinations, array_merge([
          $rid,
        ], $ridCombination));
      }
    }
    return $ridCombinations;
  }

  /**
   * Calculates test combination from roles and product visibility options.
   *
   * @return array
   *   Multidimensional array with all possible combinations.
   */
  private function calculateTestCombinations() : array {
    $ridCombinations = $this->ridCombinations;
    $visibilityCombinations = [
      [],
    ];
    foreach (self::VISIBILITIES as $visibility) {
      foreach ($visibilityCombinations as $visibilityCombination) {
        array_push($visibilityCombinations, array_merge([
          $visibility,
        ], $visibilityCombination));
      }
    }

    // Do not test the empty matrix (roles * visibility) times.
    array_shift($ridCombinations);
    array_shift($visibilityCombinations);

    // Only test it once.
    $visibilityCombinations[] = [];
    return $visibilityCombinations;
  }

  /**
   * Saves access settings to its appreciated place.
   *
   * @param array $settings
   *   Associate array where keys are public, private, internal and values are
   *   role ids.
   */
  protected function saveAccessSettings(array $settings) {
    $this
      ->config('apigee_edge.api_product_settings')
      ->set('access', $settings)
      ->save();
  }

  /**
   * Returns roles (role ids) with access to an API product.
   *
   * @param \Drupal\apigee_edge\Entity\ApiProductInterface $product
   *   API product.
   *
   * @return array
   *   Array of role ids.
   */
  protected function getRolesWithAccess(ApiProductInterface $product) : array {
    $prodVisibility = $product
      ->getAttributeValue('access');
    return $this
      ->config('apigee_edge.api_product_settings')
      ->get('access')[$prodVisibility] ?? [];
  }

  /**
   * Error message, when a user should have access to an API product by role.
   *
   * @param string $operation
   *   Operation on API product.
   * @param \Drupal\user\UserInterface $user
   *   User object.
   * @param string $user_rid
   *   Currently tested role of the user.
   * @param array $rids_with_access
   *   Roles with access to the API product.
   * @param \Drupal\apigee_edge\Entity\ApiProductInterface $product
   *   API Product.
   *
   * @return string
   *   Error message.
   */
  protected function messageIfUserShouldHaveAccessByRole(string $operation, UserInterface $user, string $user_rid, array $rids_with_access, ApiProductInterface $product) : string {
    return sprintf('User with "%s" role should have "%s" access to an API Product with "%s" visibility. Roles with access granted: %s.', $user_rid, $operation, $product
      ->getAttributeValue('access') ?? 'public', empty($rids_with_access) ? 'none' : implode(', ', $rids_with_access));
  }

  /**
   * Error message, when a user should have access because they have bypass perm.
   *
   * @param string $operation
   *   Operation on API product.
   * @param \Drupal\user\UserInterface $user
   *   User object.
   *
   * @return string
   *   Error message.
   */
  protected function messageIfUserShouldHaveAccessWithBypassPerm(string $operation, UserInterface $user) : string {
    return "User with \"Bypass API Product access control\" permission should have \"{$operation}\" access to the API product.";
  }

  /**
   * Error message, when a user should not have access to an API product.
   *
   * @param string $operation
   *   Operation on API product.
   * @param \Drupal\user\UserInterface $user
   *   User object.
   * @param string $user_rid
   *   Currently tested role of the user.
   * @param array $rids_with_access
   *   Roles with access to the API product.
   * @param \Drupal\apigee_edge\Entity\ApiProductInterface $product
   *   API Product.
   *
   * @return string
   *   Error message.
   */
  protected function messageIfUserShouldNotHaveAccess(string $operation, UserInterface $user, string $user_rid, array $rids_with_access, ApiProductInterface $product) : string {
    return sprintf('"%s" user without "Bypass API Product access control" permission should not have "%s" access to an API Product with "%s" visibility. Roles with access granted: %s.', $user_rid, $operation, $product
      ->getAttributeValue('access') ?? 'public', empty($rids_with_access) ? 'none' : implode(', ', $rids_with_access));
  }

  /**
   * Validates visible and hidden API products on a page.
   *
   * @param array $visible
   *   Array of API product visibilities that should be on the page.
   * @param array $hidden
   *   Array of API product visibilities that should not be on the page.
   */
  protected function checkProductVisibility(array $visible = [], array $hidden = []) {
    foreach ($visible as $visibility) {
      $this
        ->assertSession()
        ->pageTextContains($this->apiProducts[$visibility]
        ->label());
    }
    foreach ($hidden as $visibility) {
      $this
        ->assertSession()
        ->pageTextNotContains($this->apiProducts[$visibility]
        ->label());
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ApigeeEdgeFunctionalJavascriptTestBase::$defaultTheme protected property For tests relying on no markup at all or at least no core markup. Overrides BrowserTestBase::$defaultTheme 1
ApigeeEdgeFunctionalJavascriptTestBase::createScreenshot public function Creates a screenshot. Overrides WebDriverTestBase::createScreenshot
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.
ApiProductAccessTest::$accessControlHandler protected property API product access control handler.
ApiProductAccessTest::$apiProducts protected property Array of created API products.
ApiProductAccessTest::$developerApps protected property Array of created developer apps.
ApiProductAccessTest::$ridCombinations protected property All possible role combinations.
ApiProductAccessTest::$roleStorage protected property User role storage.
ApiProductAccessTest::$users protected property Array of created Drupal users.
ApiProductAccessTest::calculateRidCombinations protected function Calculates all possible combinations from role ids.
ApiProductAccessTest::calculateTestCombinations private function Calculates test combination from roles and product visibility options.
ApiProductAccessTest::checkProductVisibility protected function Validates visible and hidden API products on a page.
ApiProductAccessTest::developerAppEditFormTest protected function Test for developer app/edit form.
ApiProductAccessTest::entityAccessTest protected function Tests "Access by visibility" access control. 1
ApiProductAccessTest::getRolesWithAccess protected function Returns roles (role ids) with access to an API product. 1
ApiProductAccessTest::INTERNAL_ROLE protected constant
ApiProductAccessTest::INTERNAL_VISIBILITY protected constant
ApiProductAccessTest::messageIfUserShouldHaveAccessByRole protected function Error message, when a user should have access to an API product by role. 1
ApiProductAccessTest::messageIfUserShouldHaveAccessWithBypassPerm protected function Error message, when a user should have access because they have bypass perm.
ApiProductAccessTest::messageIfUserShouldNotHaveAccess protected function Error message, when a user should not have access to an API product. 1
ApiProductAccessTest::PRIVATE_VISIBILITY protected constant
ApiProductAccessTest::PUBLIC_VISIBILITY protected constant
ApiProductAccessTest::saveAccessSettings protected function Saves access settings to its appreciated place. 1
ApiProductAccessTest::setUp protected function Overrides ApigeeEdgeFunctionalJavascriptTestBase::setUp 1
ApiProductAccessTest::SUPPORTED_OPERATIONS protected constant
ApiProductAccessTest::tearDown protected function Overrides WebDriverTestBase::tearDown
ApiProductAccessTest::testApiProductAccess public function Tests API product entity access. 3
ApiProductAccessTest::USER_WITH_BYPASS_PERM protected constant
ApiProductAccessTest::VISIBILITIES protected constant
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::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::$modules protected static property Modules to enable. 621
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::getHttpClient protected function Obtain the HTTP client for the system under test.
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::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
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::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::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.
WebDriverTestBase::$disableCssAnimations protected property Disables CSS animations in tests for more reliable testing.
WebDriverTestBase::$minkDefaultDriverClass protected property To use a legacy phantomjs based approach, please use PhantomJSDriver::class. Overrides BrowserTestBase::$minkDefaultDriverClass 2
WebDriverTestBase::assertElementNotVisible Deprecated protected function Asserts that the element with the given CSS selector is not visible.
WebDriverTestBase::assertElementVisible Deprecated protected function Asserts that the element with the given CSS selector is visible.
WebDriverTestBase::assertJsCondition protected function Waits for the given time or until the given JS condition becomes TRUE.
WebDriverTestBase::assertSession public function Returns WebAssert object. Overrides UiHelperTrait::assertSession 1
WebDriverTestBase::getDrupalSettings protected function Gets the current Drupal javascript settings and parses into an array. Overrides BrowserTestBase::getDrupalSettings
WebDriverTestBase::getHtmlOutputHeaders protected function Returns headers in HTML output format. Overrides BrowserHtmlDebugTrait::getHtmlOutputHeaders
WebDriverTestBase::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. Overrides BrowserTestBase::getMinkDriverArgs
WebDriverTestBase::initFrontPage protected function Visits the front page when initializing Mink. Overrides BrowserTestBase::initFrontPage
WebDriverTestBase::initMink protected function Initializes Mink sessions. Overrides BrowserTestBase::initMink 1
WebDriverTestBase::installModulesFromClassProperty protected function Install modules defined by `static::$modules`. Overrides FunctionalTestSetupTrait::installModulesFromClassProperty
XdebugRequestTrait::extractCookiesFromRequest protected function Adds xdebug cookies, from request setup.