You are here

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

class DeveloperTest in Apigee Edge 8

Create, delete, update developer entity tests.

@group apigee_edge @group apigee_edge_developer

Hierarchy

Expanded class hierarchy of DeveloperTest

File

tests/src/Functional/DeveloperTest.php, line 36

Namespace

Drupal\Tests\apigee_edge\Functional
View source 
class DeveloperTest extends ApigeeEdgeFunctionalTestBase {
  const USER_REGISTRATION_UNAVAILABLE = 'User registration is temporarily unavailable. Try again later or contact the site administrator.';

  /**
   * {@inheritdoc}
   */
  protected static $mock_api_client_ready = TRUE;

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

  /**
   * The developer entity storage.
   *
   * @var \Drupal\apigee_edge\Entity\Storage\DeveloperStorageInterface
   */
  protected $developerStorage;

  /**
   * The SDK connector service.
   *
   * @var \Drupal\apigee_edge\SDKConnectorInterface
   */
  protected $sdkConnector;

  /**
   * Developer entity to test.
   *
   * @var \Drupal\apigee_edge\Entity\DeveloperInterface
   */
  protected $developer;

  /**
   * Company to test.
   *
   * @var \Apigee\Edge\Api\Management\Entity\CompanyInterface
   */
  protected $company;

  /**
   * The registered developer entity.
   *
   * @var \Drupal\apigee_edge\Entity\DeveloperInterface
   */
  protected $developerRegistered;

  /**
   * The developer created by admin.
   *
   * @var \Drupal\apigee_edge\Entity\DeveloperInterface
   */
  protected $developerCreatedByAdmin;

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

    // Allow visitor account creation with administrative approval.
    $user_settings = $this
      ->config('user.settings');
    $user_settings
      ->set('register', UserInterface::REGISTER_VISITORS_ADMINISTRATIVE_APPROVAL)
      ->save(TRUE);
    $this->developerStorage = $this->container
      ->get('entity_type.manager')
      ->getStorage('developer');
    $this->sdkConnector = $this->container
      ->get('apigee_edge.sdk_connector');
  }

  /**
   * {@inheritdoc}
   */
  protected function tearDown() {
    $this->stack
      ->reset();
    try {
      if ($this->developer !== NULL) {
        $this
          ->queueDeveloperResponseFromDeveloper($this->developer);
        $this->developer
          ->delete();
      }
    } catch (\Exception $exception) {
      $this
        ->logException($exception);
    }
    try {
      if ($this->company !== NULL) {
        $this->stack
          ->queueMockResponse([
          'company' => [
            'company' => $this->company,
          ],
        ]);
        $company_controller = new CompanyController($this->sdkConnector
          ->getOrganization(), $this->sdkConnector
          ->getClient());
        $company_controller
          ->delete($this->company
          ->id());
      }
    } catch (\Exception $exception) {
      $this
        ->logException($exception);
    }
    try {
      if ($this->developerRegistered !== NULL) {
        $this
          ->queueDeveloperResponseFromDeveloper($this->developerRegistered);
        $this->developerRegistered
          ->delete();
      }
    } catch (\Exception $exception) {
      $this
        ->logException($exception);
    }
    try {
      if ($this->developerCreatedByAdmin !== NULL) {
        $this
          ->queueDeveloperResponseFromDeveloper($this->developerCreatedByAdmin);
        $this->developerCreatedByAdmin
          ->delete();
      }
    } catch (\Exception $exception) {
      $this
        ->logException($exception);
    }
    parent::tearDown();
  }

  /**
   * Tests developer registration and create by admin.
   */
  public function testDeveloperRegisterAndCreate() {
    $this
      ->developerRegisterTest();
    $this
      ->developerCreateByAdminTest();
    $this
      ->developerGetCompanyListTest();
  }

  /**
   * Tests user/developer registration and edit.
   */
  protected function developerRegisterTest() {
    $test_user = [
      'email' => $this
        ->randomMachineName() . '@example.com',
      'username' => $this
        ->randomMachineName(),
      'first_name' => $this
        ->getRandomGenerator()
        ->word(16),
      'last_name' => $this
        ->getRandomGenerator()
        ->word(16),
    ];
    $formdata = [
      'mail' => $test_user['email'],
      'first_name[0][value]' => $test_user['first_name'],
      'last_name[0][value]' => $test_user['last_name'],
      'name' => $test_user['username'],
    ];

    // Try to register with incorrect API credentials.
    $this
      ->invalidateKey();
    $this
      ->drupalPostForm(Url::fromRoute('user.register'), $formdata, 'Create new account');
    $this
      ->assertSession()
      ->pageTextContains(self::USER_REGISTRATION_UNAVAILABLE);

    // Try to register with correct API credentials.
    $this
      ->restoreKey();
    $account = $this->entityTypeManager
      ->getStorage('user')
      ->create([
      'mail' => $test_user['email'],
      'name' => $test_user['username'],
      'first_name' => $test_user['first_name'],
      'last_name' => $test_user['last_name'],
    ]);
    $this->entityTypeManager
      ->getStorage('user')
      ->resetCache();
    $this->developerStorage
      ->resetCache();

    // Add matched organization response so it returns the org whenever called.
    $this
      ->addOrganizationMatchedResponse();

    // Add other responses needed to create an account. In order:
    // - 'get_not_found' - when creating an account `apigee_edge` module checks
    //   that the email does not already exist in Edge.
    // - 'get_not_found' - @to-do: why is this needed again?
    // - stack a mocked developer created response.
    $this->stack
      ->queueMockResponse('get_not_found');
    $this->stack
      ->queueMockResponse('get_not_found');
    $this
      ->queueDeveloperResponse($account, 201);
    $this
      ->drupalPostForm(Url::fromRoute('user.register'), $formdata, 'Create new account');

    /** @var \Drupal\user\Entity\User $account */
    $account = user_load_by_mail($test_user['email']);
    $this
      ->assertNotEmpty($account, 'Account is created');

    // Queue a developer response to mock the loading of a developer.
    $this
      ->queueDeveloperResponse($account);
    $this->developerRegistered = $this->developerStorage
      ->load($test_user['email']);
    $this
      ->assertNotEmpty($this->developerRegistered);
    $this
      ->assertEquals($this->developerRegistered
      ->getEmail(), $test_user['email']);
    $this
      ->assertEquals($this->developerRegistered
      ->getFirstName(), $test_user['first_name']);
    $this
      ->assertEquals($this->developerRegistered
      ->getLastName(), $test_user['last_name']);
    $this
      ->assertEquals($this->developerRegistered
      ->getUserName(), $test_user['username']);
    $this
      ->assertEquals($this->developerRegistered
      ->getStatus(), DeveloperInterface::STATUS_INACTIVE);

    // Attribute is set by mock twig template.
    $this
      ->assertEqual($this->developerRegistered
      ->getAttributeValue('IS_MOCK_CLIENT'), !$this->integration_enabled);
    $this
      ->drupalLogin($this->rootUser);
    $this
      ->drupalPostForm(Url::fromRoute('entity.user.edit_form', [
      'user' => $account
        ->id(),
    ]), [
      'status' => '1',
    ], 'Save');

    // Ensure status change was saved.
    $this->entityTypeManager
      ->getStorage('user')
      ->resetCache();
    $account = user_load_by_mail($test_user['email']);
    $this
      ->assertTrue($account
      ->isActive());

    // Ensure that entity static cache is also invalidated in this scope too.
    $this->developerStorage
      ->resetCache([
      $test_user['email'],
    ]);

    // Queue a developer response to mock the loading of a developer.
    $this
      ->queueDeveloperResponse($account);
    $this->developerRegistered = $this->developerStorage
      ->loadUnchanged($test_user['email']);
    $this
      ->assertEquals($this->developerRegistered
      ->getEmail(), $test_user['email']);
    $this
      ->assertEquals($this->developerRegistered
      ->getFirstName(), $test_user['first_name']);
    $this
      ->assertEquals($this->developerRegistered
      ->getLastName(), $test_user['last_name']);
    $this
      ->assertEquals($this->developerRegistered
      ->getUserName(), $test_user['username']);
    $this
      ->assertEquals($this->developerRegistered
      ->getStatus(), DeveloperInterface::STATUS_ACTIVE);
  }

  /**
   * Tests creating, editing and deleting developer entity by admin.
   */
  protected function developerCreateByAdminTest() {

    // Create blocked user by admin.
    $this
      ->drupalLogin($this->rootUser);
    $test_user = [
      'email' => $this
        ->randomMachineName() . '@example.com',
      'first_name' => $this
        ->getRandomGenerator()
        ->word(16),
      'last_name' => $this
        ->getRandomGenerator()
        ->word(16),
      'username' => $this
        ->randomMachineName(),
      'password' => user_password(),
      'status' => '0',
    ];
    $formdata = [
      'mail' => $test_user['email'],
      'first_name[0][value]' => $test_user['first_name'],
      'last_name[0][value]' => $test_user['last_name'],
      'name' => $test_user['username'],
      'pass[pass1]' => $test_user['password'],
      'pass[pass2]' => $test_user['password'],
      'status' => $test_user['status'],
    ];

    // Try to register with incorrect API credentials.
    $this
      ->invalidateKey();
    $this
      ->drupalPostForm(Url::fromRoute('user.admin_create'), $formdata, 'Create new account');
    $this
      ->assertSession()
      ->pageTextContains(self::USER_REGISTRATION_UNAVAILABLE);

    // Try to register with correct API credentials.
    $this
      ->restoreKey();
    $account = $this->entityTypeManager
      ->getStorage('user')
      ->create([
      'mail' => $test_user['email'],
      'name' => $test_user['username'],
      'first_name' => $test_user['first_name'],
      'last_name' => $test_user['last_name'],
    ]);
    $this->entityTypeManager
      ->getStorage('user')
      ->resetCache();
    $this->developerStorage
      ->resetCache();

    // Stack responses needed to create a new developer account for the account.
    $this
      ->addOrganizationMatchedResponse();
    $this->stack
      ->queueMockResponse('get_not_found');
    $this->stack
      ->queueMockResponse('get_not_found');
    $this
      ->queueDeveloperResponse($account, 201);
    $this
      ->drupalPostForm(Url::fromRoute('user.admin_create'), $formdata, 'Create new account');

    /** @var \Drupal\user\Entity\User $account */
    $account = user_load_by_mail($test_user['email']);
    $this
      ->assertNotEmpty($account);

    // Queue a developer response to mock the loading of a developer.
    $this
      ->queueDeveloperResponse($account);
    $this->developerCreatedByAdmin = $this->developerStorage
      ->load($test_user['email']);
    $this
      ->assertNotEmpty($this->developerCreatedByAdmin);
    $this
      ->assertEquals($this->developerCreatedByAdmin
      ->getEmail(), $test_user['email']);
    $this
      ->assertEquals($this->developerCreatedByAdmin
      ->getFirstName(), $test_user['first_name']);
    $this
      ->assertEquals($this->developerCreatedByAdmin
      ->getLastName(), $test_user['last_name']);
    $this
      ->assertEquals($this->developerCreatedByAdmin
      ->getUserName(), $test_user['username']);
    $this
      ->assertEquals($this->developerCreatedByAdmin
      ->getStatus(), DeveloperInterface::STATUS_INACTIVE);

    // Unblock and edit the user's email, first name, last name by the admin.
    $test_user['email'] = "mod.{$test_user['email']}";
    $test_user['first_name'] = "(mod) {$test_user['first_name']}";
    $test_user['last_name'] = "(mod) {$test_user['last_name']}";
    $test_user['status'] = '1';
    $formdata['mail'] = $test_user['email'];
    $formdata['first_name[0][value]'] = $test_user['first_name'];
    $formdata['last_name[0][value]'] = $test_user['last_name'];
    $formdata['status'] = $test_user['status'];
    $this
      ->drupalPostForm(Url::fromRoute('entity.user.edit_form', [
      'user' => $account
        ->id(),
    ]), $formdata, 'Save');

    // Flush user entity cache to ensure the updated user gets loaded.
    // (Especially in apigee_edge_developer_app_storage_load().)
    $this->entityTypeManager
      ->getStorage('user')
      ->resetCache([
      $account
        ->id(),
    ]);
    $account = user_load_by_mail($test_user['email']);
    $this
      ->assertNotEmpty($account);

    // Queue a developer response to mock the loading of a developer.
    $this
      ->queueDeveloperResponse($account);

    // Ensure that entity static cache is also invalidated in this scope.
    $this->developerCreatedByAdmin = $this->developerStorage
      ->loadUnchanged($test_user['email']);
    $this
      ->assertNotEmpty($this->developerCreatedByAdmin);
    $this
      ->assertEquals($this->developerCreatedByAdmin
      ->getEmail(), $test_user['email']);
    $this
      ->assertEquals($this->developerCreatedByAdmin
      ->getFirstName(), $test_user['first_name']);
    $this
      ->assertEquals($this->developerCreatedByAdmin
      ->getLastName(), $test_user['last_name']);
    $this
      ->assertEquals($this->developerCreatedByAdmin
      ->getUserName(), $test_user['username']);
    $this
      ->assertEquals($this->developerCreatedByAdmin
      ->getStatus(), DeveloperInterface::STATUS_ACTIVE);

    // Block the user's account on the people form.
    $this
      ->drupalGet(Url::fromRoute('entity.user.collection'));
    $this
      ->getSession()
      ->getPage()
      ->selectFieldOption('edit-action', 'user_block_user_action');
    $this
      ->getSession()
      ->getPage()
      ->checkField('edit-user-bulk-form-0');
    $this
      ->getSession()
      ->getPage()
      ->pressButton('edit-submit');

    // Ensure that entity static cache is also invalidated in this scope
    // too.
    // - Stack response with the blocked developer.
    $modified_dev = clone $this->developerCreatedByAdmin;
    $modified_dev
      ->setStatus(DeveloperInterface::STATUS_INACTIVE);
    $this
      ->queueDeveloperResponseFromDeveloper($modified_dev);
    $this->developerCreatedByAdmin = $this->developerStorage
      ->loadUnchanged($test_user['email']);
    $this
      ->assertEquals($this->developerCreatedByAdmin
      ->getStatus(), DeveloperInterface::STATUS_INACTIVE);

    // Block user on the cancel form using the user_cancel_block method.
    $test_user['status'] = '1';
    $formdata = [
      'mail' => $test_user['email'],
      'first_name[0][value]' => $test_user['first_name'],
      'last_name[0][value]' => $test_user['last_name'],
      'name' => $test_user['username'],
      'pass[pass1]' => $test_user['password'],
      'pass[pass2]' => $test_user['password'],
      'status' => $test_user['status'],
    ];
    $this
      ->drupalPostForm(Url::fromRoute('entity.user.edit_form', [
      'user' => $account
        ->id(),
    ]), $formdata, 'Save');
    $formdata = [
      'user_cancel_method' => 'user_cancel_block',
    ];
    $this
      ->drupalPostForm($account
      ->toUrl('cancel-form')
      ->toString(), $formdata, 'Cancel account');
    $this->developerCreatedByAdmin = $this->developerStorage
      ->load($test_user['email']);
    $this
      ->assertNotEmpty($this->developerCreatedByAdmin);
    $this
      ->assertEquals($this->developerCreatedByAdmin
      ->getStatus(), DeveloperInterface::STATUS_INACTIVE);

    // Block user on the cancel form using the user_cancel_reassign method.
    $test_user['status'] = '1';
    $formdata = [
      'mail' => $test_user['email'],
      'first_name[0][value]' => $test_user['first_name'],
      'last_name[0][value]' => $test_user['last_name'],
      'name' => $test_user['username'],
      'pass[pass1]' => $test_user['password'],
      'pass[pass2]' => $test_user['password'],
      'status' => $test_user['status'],
    ];
    $this
      ->drupalPostForm(Url::fromRoute('entity.user.edit_form', [
      'user' => $account
        ->id(),
    ]), $formdata, 'Save');
    $formdata = [
      'user_cancel_method' => 'user_cancel_block_unpublish',
    ];
    $this
      ->drupalPostForm($account
      ->toUrl('cancel-form')
      ->toString(), $formdata, 'Cancel account');
    $this->developerCreatedByAdmin = $this->developerStorage
      ->load($test_user['email']);
    $this
      ->assertNotEmpty($this->developerCreatedByAdmin);
    $this
      ->assertEquals($this->developerCreatedByAdmin
      ->getStatus(), DeveloperInterface::STATUS_INACTIVE);

    // Delete user by admin.
    $formdata = [
      'user_cancel_method' => 'user_cancel_delete',
    ];
    $this
      ->drupalPostForm($account
      ->toUrl('cancel-form')
      ->toString(), $formdata, 'Cancel account');

    // Ensure that entity static cache is also invalidated in this scope
    // too.
    $this->stack
      ->queueMockResponse('get_not_found');
    $loaded = $this->developerStorage
      ->loadUnchanged($test_user['email']);
    $this
      ->assertEmpty($loaded, 'Developer does not exists anymore.');
  }

  /**
   * Tests getCompanies() and hasCompany() methods on the developer entity.
   *
   * @see \Drupal\apigee_edge\Entity\Developer::getCompanies()
   * @see \Drupal\apigee_edge\Entity\Developer::hasCompany()
   */
  public function developerGetCompanyListTest() {

    // Add matched organization response so it returns the org whenever called.
    $this
      ->addOrganizationMatchedResponse();

    // Create a new developer.
    $name = strtolower($this
      ->randomMachineName());
    $this->developer = $this->developerStorage
      ->create([
      'email' => $name . '@example.com',
      'userName' => $name,
      'firstName' => $this
        ->getRandomGenerator()
        ->word(8),
      'lastName' => $this
        ->getRandomGenerator()
        ->word(8),
    ]);

    // Stack a created developer response, and an empty response
    // mocking the status change to active.
    $account = $this
      ->queueDeveloperResponseFromDeveloper($this->developer, 201);
    $this->stack
      ->queueMockResponse('no_content');
    $this->developer
      ->save();

    // Result of getCompanies() function should be an empty array.
    // - Queue a developer response, as method getCompanies() loads the dev if
    // the companies are null initially.
    $this
      ->queueDeveloperResponse($account);
    $this->developer
      ->getCompanies();
    $this
      ->assertNotNull($this->developer
      ->getCompanies());
    $this
      ->assertEmpty($this->developer
      ->getCompanies());

    // Create a new company and add developer as a member to it.
    $this->company = new Company([
      'name' => $this
        ->getRandomGenerator()
        ->name(),
      'displayName' => $this
        ->getRandomGenerator()
        ->name(),
    ]);
    $company_controller = new CompanyController($this->sdkConnector
      ->getOrganization(), $this->sdkConnector
      ->getClient());

    // Queue a created company response.
    $this
      ->queueCompanyResponse($this->company, 201);
    $company_controller
      ->create($this->company);

    // Queue a developers in a company response.
    $this
      ->queueDevsInCompanyResponse([
      [
        'email' => $this->developer
          ->getEmail(),
        'role' => '',
      ],
    ]);
    $company_membership_controller = new CompanyMembersController($this->company
      ->getName(), $this->sdkConnector
      ->getOrganization(), $this->sdkConnector
      ->getClient());
    $company_membership = new CompanyMembership([
      $this->developer
        ->getEmail() => NULL,
    ]);
    $company_membership_controller
      ->setMembers($company_membership);

    // Ensure that the developer is reloaded from Apigee Edge so remove the
    // developer entity from the cache.
    $this->developerStorage
      ->resetCache([
      $this->developer
        ->id(),
    ]);

    // resetCache() does not clear controller's cache by default.
    // @see \Drupal\apigee_edge\Entity\Storage\EdgeEntityStorageBase::resetCache()
    $developer_cache = $this->container
      ->get('apigee_edge.controller.cache.developer');
    $developer_cache
      ->removeEntities([
      $this->developer
        ->id(),
    ]);

    // Check the companies array if the developer is reloaded.

    /** @var \Drupal\apigee_edge\Entity\DeveloperInterface $developer */
    $this->stack
      ->queueMockResponse([
      'developers' => [
        'developers' => [
          $account,
        ],
        'expand' => TRUE,
      ],
    ]);
    $this
      ->queueDeveloperResponse($account, NULL, [
      'companies' => [
        $this->company
          ->getName(),
      ],
    ]);
    $developer = $this->developerStorage
      ->loadMultiple()[$this->developer
      ->id()];
    $this
      ->assertContains($this->company
      ->getName(), $developer
      ->getCompanies());
    self::assertTrue($developer
      ->hasCompany($this->company
      ->getName()));

    // Check the companies array if the developer is removed from the member
    // list.
    // - Add an empty response simulating when a member is deleted.
    $this->stack
      ->queueMockResponse('no_content');
    $company_membership_controller
      ->removeMember($this->developer
      ->getEmail());
    $developer_cache
      ->removeEntities([
      $this->developer
        ->id(),
    ]);
    $this
      ->queueDeveloperResponse($account);
    $developer = $this->developerStorage
      ->loadUnchanged($this->developer
      ->id());
    $this
      ->queueDeveloperResponse($account);
    $this
      ->assertNotContains($this->company
      ->getName(), $developer
      ->getCompanies());
    self::assertFalse($developer
      ->hasCompany($this->company
      ->getName()));
  }

}

Members

Namesort descending 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::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::$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
DeveloperTest::$company protected property Company to test.
DeveloperTest::$developer protected property Developer entity to test.
DeveloperTest::$developerCreatedByAdmin protected property The developer created by admin.
DeveloperTest::$developerRegistered protected property The registered developer entity.
DeveloperTest::$developerStorage protected property The developer entity storage.
DeveloperTest::$mock_api_client_ready protected static property Use the mock_api_client or not. Overrides ApigeeEdgeFunctionalTestTrait::$mock_api_client_ready
DeveloperTest::$modules protected static property Modules to enable. Overrides BrowserTestBase::$modules
DeveloperTest::$sdkConnector protected property The SDK connector service. Overrides ApigeeMockApiClientHelperTrait::$sdkConnector
DeveloperTest::developerCreateByAdminTest protected function Tests creating, editing and deleting developer entity by admin.
DeveloperTest::developerGetCompanyListTest public function Tests getCompanies() and hasCompany() methods on the developer entity.
DeveloperTest::developerRegisterTest protected function Tests user/developer registration and edit.
DeveloperTest::setUp protected function Overrides ApigeeEdgeFunctionalTestBase::setUp
DeveloperTest::tearDown protected function Overrides BrowserTestBase::tearDown
DeveloperTest::testDeveloperRegisterAndCreate public function Tests developer registration and create by admin.
DeveloperTest::USER_REGISTRATION_UNAVAILABLE constant
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.