You are here

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

class TestFrameworkKernelTest in Apigee Edge 8

Tests the testing framework for testing offline.

@group apigee_edge @group apigee_edge_kernel

Hierarchy

Expanded class hierarchy of TestFrameworkKernelTest

File

tests/src/Kernel/TestFrameworkKernelTest.php, line 36

Namespace

Drupal\Tests\apigee_edge\Kernel
View source 
class TestFrameworkKernelTest extends KernelTestBase {
  use ApigeeMockApiClientHelperTrait;
  use UserCreationTrait;

  /**
   * Indicates this test class is mock API client ready.
   *
   * @var bool
   */
  protected static $mock_api_client_ready = TRUE;

  /**
   * {@inheritdoc}
   */
  protected static $modules = [
    'user',
    'system',
    'key',
    'file',
    'entity',
    'syslog',
    'apigee_edge',
    'apigee_mock_api_client',
  ];

  /**
   * Developer entities to test.
   *
   * @var \Drupal\apigee_edge\Entity\DeveloperInterface[]
   */
  protected $developers = [];

  /**
   * {@inheritdoc}
   *
   * @throws \Exception
   */
  protected function setUp() {
    parent::setUp();
    $this
      ->installConfig([
      'apigee_edge',
    ]);

    // Prepare to create a user.
    $this
      ->installEntitySchema('user');
    $this
      ->installSchema('system', [
      'sequences',
    ]);
    $this
      ->installSchema('user', [
      'users_data',
    ]);
    $this
      ->apigeeTestHelperSetup();
  }

  /**
   * Tests that the service override is working properly.
   */
  public function testServiceModification() {
    self::assertEquals((string) $this->container
      ->getDefinition('apigee_edge.sdk_connector')
      ->getArgument(0), 'apigee_mock_api_client.mock_http_client_factory');
  }

  /**
   * Tests that API responses can be queued.
   */
  public function testInlineResponseQueue() {
    if ($this->integration_enabled) {
      static::markTestSkipped('Only test the response queue when running offline tests.');
      return;
    }

    // Queue a response from the mock server.
    $this->stack
      ->addResponse(new Response(200, [], "{\"status\": \"success\"}"));

    // Execute a client call.
    $response = $this->sdkConnector
      ->buildClient(new AutoBasicAuth())
      ->get('/');
    self::assertEquals("200", $response
      ->getStatusCode());
    self::assertEquals('{"status": "success"}', (string) $response
      ->getBody());
  }

  /**
   * Tests that a response is fetched from the mocks using response matcher.
   */
  public function testMatchedResponse() {
    if ($this->integration_enabled) {
      $this
        ->markTestSkipped('Integration enabled, skipping test.');
    }
    $org_name = $this
      ->randomMachineName();

    // Stack up org response.
    $this
      ->addOrganizationMatchedResponse($org_name);
    $org_controller = $this->container
      ->get('apigee_edge.controller.organization');
    $org = $org_controller
      ->load($org_name);
    $this
      ->assertEqual($org
      ->getName(), $org_name);
  }

  /**
   * Tests that a response is fetched from the stacked mocks.
   */
  public function testStackedMockResponse() {
    if ($this->integration_enabled) {
      $this
        ->markTestSkipped('Integration enabled, skipping test.');
    }
    $test_user = [
      'mail' => $this
        ->randomMachineName() . '@example.com',
      'name' => $this
        ->randomMachineName(),
      'first_name' => $this
        ->getRandomGenerator()
        ->word(16),
      'last_name' => $this
        ->getRandomGenerator()
        ->word(16),
    ];
    $account = $this->entityTypeManager
      ->getStorage('user')
      ->create($test_user);
    $this
      ->assertEquals($test_user['mail'], $account->mail->value);
    $this
      ->queueDeveloperResponse($account);
    $developerStorage = $this->entityTypeManager
      ->getStorage('developer');
    $developerStorage
      ->resetCache([
      $test_user['mail'],
    ]);

    /** @var \Drupal\apigee_edge\Entity\Developer $developer */
    $developer = $developerStorage
      ->load($test_user['mail']);
    $this
      ->assertEqual($developer
      ->getEmail(), $test_user['mail']);

    // Attribute is set by mock twig template.
    $this
      ->assertEqual($developer
      ->getAttributeValue('IS_MOCK_CLIENT'), 1);
  }

  /**
   * Test integration enabled.
   *
   * Tests that responses are not fetched from the stacked mocks when
   * integration is enabled.
   */
  public function testNotStackedMockResponse() {
    if (!$this->integration_enabled) {
      $this
        ->markTestSkipped('Integration not enabled, skipping test.');
    }
    $developerStorage = $this->entityTypeManager
      ->getStorage('developer');

    /** @var \Drupal\apigee_edge\Entity\Developer $developer */
    $developer = $developerStorage
      ->create([
      'email' => $this
        ->randomMachineName() . '@example.com',
      'userName' => $this
        ->randomMachineName(),
      'firstName' => $this
        ->getRandomGenerator()
        ->word(8),
      'lastName' => $this
        ->getRandomGenerator()
        ->word(8),
    ]);
    $developerStorage
      ->resetCache([
      $developer
        ->getEmail(),
    ]);

    // Unsaved developer, should not be found (should ignore the mock stack).
    $this
      ->queueDeveloperResponseFromDeveloper($developer);
    $loaded_developer = $developerStorage
      ->load($developer
      ->getEmail());
    $this
      ->isEmpty($loaded_developer);

    // Saved developer, following calls should load from the real API,
    // and ignore all stacked responses.
    $this
      ->queueDeveloperResponseFromDeveloper($developer, 201);
    $developer
      ->save();

    // Add to the array of developers to be deleted in tearDown().
    $this->developers[] = $developer;
    $this
      ->queueDeveloperResponseFromDeveloper($developer);
    $loaded_developer = $developerStorage
      ->load($developer
      ->getEmail());
    $this
      ->assertInstanceOf(Developer::class, $loaded_developer);
    $this
      ->assertEqual($loaded_developer
      ->getEmail(), $developer
      ->getEmail());

    // This line is what actually tests that the mock is not used since the mock template sets this attribute.
    $this
      ->assertEmpty($developer
      ->getAttributeValue('IS_MOCK_CLIENT'));
  }

  /**
   * Tests a more complex scenario.
   *
   * Registers a user and fetches the "created" developer from the API mocks.
   */
  public function testRegisterUser() {
    if ($this->integration_enabled) {
      $this
        ->markTestSkipped('Integration enabled, skipping test.');
    }

    // Stack up org response.
    $this
      ->addOrganizationMatchedResponse();

    // Run as anonymous user.
    $this
      ->setUpCurrentUser([
      'uid' => 0,
    ]);
    $test_user = [
      'mail' => $this
        ->randomMachineName() . '@example.com',
      'name' => $this
        ->randomMachineName(),
      'first_name' => $this
        ->getRandomGenerator()
        ->word(16),
      'last_name' => $this
        ->getRandomGenerator()
        ->word(16),
    ];
    $form_data = [
      'mail' => $test_user['mail'],
      'name' => $test_user['name'],
      'first_name[0][value]' => $test_user['first_name'],
      'last_name[0][value]' => $test_user['last_name'],
      'op' => 'Create new account',
      'pass' => $this
        ->getRandomGenerator()
        ->word(8),
    ];
    $account = $this->entityTypeManager
      ->getStorage('user')
      ->create($test_user);
    $formObject = $this->entityTypeManager
      ->getFormObject('user', 'register')
      ->setEntity($account);
    $form_state = new FormState();
    $form_state
      ->setUserInput($form_data);
    $form_state
      ->setValues($form_data);
    $this->stack
      ->queueMockResponse('get_not_found');
    $this
      ->queueDeveloperResponse($account);
    \Drupal::formBuilder()
      ->submitForm($formObject, $form_state);
    $developerStorage = $this->entityTypeManager
      ->getStorage('developer');
    $developerStorage
      ->resetCache([
      $test_user['mail'],
    ]);

    /** @var \Drupal\apigee_edge\Entity\Developer $developer */
    $developer = $developerStorage
      ->load($test_user['mail']);
    $this
      ->assertEqual($developer
      ->getEmail(), $test_user['mail']);

    // Attribute is set by mock twig template.
    $this
      ->assertEqual($developer
      ->getAttributeValue('IS_MOCK_CLIENT'), 1);
  }

  /**
   * {@inheritdoc}
   */
  protected function tearDown() {
    if ($this->integration_enabled && !empty($this->developers)) {
      foreach ($this->developers as $developer) {
        $developer
          ->delete();
      }
    }
    parent::tearDown();
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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::createDeveloperApp protected function Helper to create a DeveloperApp entity. 1
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.
AssertContentTrait::$content protected property The current raw content.
AssertContentTrait::$drupalSettings protected property The drupalSettings value from the current raw $content.
AssertContentTrait::$elements protected property The XML structure parsed from the current raw $content. 1
AssertContentTrait::$plainTextContent protected property The plain-text content of raw $content (text nodes).
AssertContentTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertContentTrait::assertFieldById protected function Asserts that a field exists with the given ID and value.
AssertContentTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertContentTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertContentTrait::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
AssertContentTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertContentTrait::assertLink protected function Passes if a link with the specified label is found.
AssertContentTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertContentTrait::assertNoDuplicateIds protected function Asserts that each HTML ID is used for just a single element.
AssertContentTrait::assertNoEscaped protected function Passes if the raw text IS NOT found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertNoField protected function Asserts that a field does not exist with the given name or ID.
AssertContentTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertContentTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertContentTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertContentTrait::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
AssertContentTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertContentTrait::assertNoLinkByHref protected function Passes if a link containing a given href (part) is not found.
AssertContentTrait::assertNoLinkByHrefInMainRegion protected function Passes if a link containing a given href is not found in the main region.
AssertContentTrait::assertNoOption protected function Asserts that a select option in the current page does not exist.
AssertContentTrait::assertNoOptionSelected protected function Asserts that a select option in the current page is not checked.
AssertContentTrait::assertNoPattern protected function Triggers a pass if the perl regex pattern is not found in raw content.
AssertContentTrait::assertNoRaw protected function Passes if the raw text is NOT found on the loaded page, fail otherwise.
AssertContentTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text.
AssertContentTrait::assertNoTitle protected function Pass if the page title is not the given string.
AssertContentTrait::assertNoUniqueText protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertContentTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertOptionByText protected function Asserts that a select option with the visible text exists.
AssertContentTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionSelectedWithDrupalSelector protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionWithDrupalSelector protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertContentTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise.
AssertContentTrait::assertText protected function Passes if the page (with HTML stripped) contains the text.
AssertContentTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertContentTrait::assertTextPattern protected function Asserts that a Perl regex pattern is found in the plain-text content.
AssertContentTrait::assertThemeOutput protected function Asserts themed output.
AssertContentTrait::assertTitle protected function Pass if the page title is the given string.
AssertContentTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertContentTrait::assertUniqueTextHelper protected function Helper for assertUniqueText and assertNoUniqueText.
AssertContentTrait::buildXPathQuery protected function Builds an XPath query.
AssertContentTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertContentTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
AssertContentTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertContentTrait::getDrupalSettings protected function Gets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::getRawContent protected function Gets the current raw content.
AssertContentTrait::getSelectedItem protected function Get the selected value from a select field.
AssertContentTrait::getTextContent protected function Retrieves the plain-text content from the current raw content.
AssertContentTrait::getUrl protected function Get the current URL from the cURL handler. 1
AssertContentTrait::parse protected function Parse content returned from curlExec using DOM and SimpleXML.
AssertContentTrait::removeWhiteSpace protected function Removes all white-space between HTML tags from the raw content.
AssertContentTrait::setDrupalSettings protected function Sets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::setRawContent protected function Sets the raw content (e.g. HTML).
AssertContentTrait::xpath protected function Performs an xpath search on the contents of the internal browser.
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::assertEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
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::assertNotEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotEquals() instead.
AssertLegacyTrait::assertNotIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotSame() instead.
AssertLegacyTrait::pass protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::verbose protected function
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.
KernelTestBase::$backupGlobals protected property Back up and restore any global variables that may be changed by tests.
KernelTestBase::$backupStaticAttributes protected property Back up and restore static class properties that may be changed by tests.
KernelTestBase::$backupStaticAttributesBlacklist protected property Contains a few static class properties for performance.
KernelTestBase::$classLoader protected property
KernelTestBase::$configImporter protected property @todo Move into Config test base class. 7
KernelTestBase::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking.
KernelTestBase::$container protected property
KernelTestBase::$databasePrefix protected property
KernelTestBase::$preserveGlobalState protected property Do not forward any global state from the parent process to the processes that run the actual tests.
KernelTestBase::$root protected property The app root.
KernelTestBase::$runTestInSeparateProcess protected property Kernel tests are run in separate processes because they allow autoloading of code from extensions. Running the test in a separate process isolates this behavior from other tests. Subclasses should not override this property.
KernelTestBase::$siteDirectory protected property
KernelTestBase::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 6
KernelTestBase::$vfsRoot protected property The virtual filesystem root directory.
KernelTestBase::assertPostConditions protected function 1
KernelTestBase::bootEnvironment protected function Bootstraps a basic test environment.
KernelTestBase::bootKernel private function Bootstraps a kernel for a test.
KernelTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
KernelTestBase::disableModules protected function Disables modules for this test.
KernelTestBase::enableModules protected function Enables modules for this test.
KernelTestBase::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
KernelTestBase::getDatabaseConnectionInfo protected function Returns the Database connection info to be used for this test. 1
KernelTestBase::getDatabasePrefix public function
KernelTestBase::getExtensionsForModules private function Returns Extension objects for $modules to enable.
KernelTestBase::getModulesToEnable private static function Returns the modules to enable for this test.
KernelTestBase::initFileCache protected function Initializes the FileCache component.
KernelTestBase::installConfig protected function Installs default configuration for a given list of modules.
KernelTestBase::installEntitySchema protected function Installs the storage schema for a specific entity type.
KernelTestBase::installSchema protected function Installs database tables from a module schema definition.
KernelTestBase::isTestInIsolation Deprecated protected function Returns whether the current test method is running in a separate process.
KernelTestBase::prepareTemplate protected function
KernelTestBase::register public function Registers test-specific services. Overrides ServiceProviderInterface::register 26
KernelTestBase::render protected function Renders a render array. 1
KernelTestBase::setInstallProfile protected function Sets the install profile and rebuilds the container to update it.
KernelTestBase::setSetting protected function Sets an in-memory Settings variable.
KernelTestBase::setUpBeforeClass public static function 1
KernelTestBase::setUpFilesystem protected function Sets up the filesystem, so things like the file directory. 2
KernelTestBase::stop protected function Stops test execution.
KernelTestBase::tearDownCloseDatabaseConnection public function @after
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__get Deprecated public function BC: Automatically resolve former KernelTestBase class properties.
KernelTestBase::__sleep public function Prevents serializing any properties.
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.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
TestFrameworkKernelTest::$developers protected property Developer entities to test.
TestFrameworkKernelTest::$mock_api_client_ready protected static property Indicates this test class is mock API client ready.
TestFrameworkKernelTest::$modules protected static property Modules to enable. Overrides KernelTestBase::$modules
TestFrameworkKernelTest::setUp protected function Overrides KernelTestBase::setUp
TestFrameworkKernelTest::tearDown protected function Overrides KernelTestBase::tearDown
TestFrameworkKernelTest::testInlineResponseQueue public function Tests that API responses can be queued.
TestFrameworkKernelTest::testMatchedResponse public function Tests that a response is fetched from the mocks using response matcher.
TestFrameworkKernelTest::testNotStackedMockResponse public function Test integration enabled.
TestFrameworkKernelTest::testRegisterUser public function Tests a more complex scenario.
TestFrameworkKernelTest::testServiceModification public function Tests that the service override is working properly.
TestFrameworkKernelTest::testStackedMockResponse public function Tests that a response is fetched from the stacked mocks.
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.
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.
UserCreationTrait::createUser protected function Create a user with a given set of permissions.
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.