You are here

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

class ApigeeEdgeManagementCliServiceTest in Apigee Edge 8

Same name in this branch
  1. 8 tests/src/Kernel/Util/ApigeeEdgeManagementCliServiceTest.php \Drupal\Tests\apigee_edge\Kernel\Util\ApigeeEdgeManagementCliServiceTest
  2. 8 tests/src/Unit/Command/Util/ApigeeEdgeManagementCliServiceTest.php \Drupal\Tests\apigee_edge\Unit\Command\Util\ApigeeEdgeManagementCliServiceTest

ApigeeEdgeManagementCliService Edge tests.

Make sure Edge API works as expected for the ApigeeEdgeManagementCliService.

These tests validate Edge API request/responses needed for ApigeeEdgeManagementCliService are valid.

@group apigee_edge @group apigee_edge_kernel

Hierarchy

Expanded class hierarchy of ApigeeEdgeManagementCliServiceTest

File

tests/src/Kernel/Util/ApigeeEdgeManagementCliServiceTest.php, line 39

Namespace

Drupal\Tests\apigee_edge\Kernel\Util
View source 
class ApigeeEdgeManagementCliServiceTest extends KernelTestBase implements ServiceModifierInterface {
  use ApigeeMockApiClientHelperTrait;

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

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

  /**
   * Apigee API endpoint.
   *
   * @var array|false|string
   */
  protected $endpoint;

  /**
   * Apigee Edge organization.
   *
   * @var array|false|string
   */
  protected $organization;

  /**
   * Email of an account with the organization admin Apigee role.
   *
   * @var array|false|string
   */
  protected $orgadminEmail;

  /**
   * The password of the orgadmin account.
   *
   * @var array|false|string
   */
  protected $orgadminPassword;

  /**
   * A GuzzleHttp\Client object.
   *
   * @var object|null
   */
  protected $httpClient;

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();
    $this
      ->installSchema('system', [
      'sequences',
    ]);
    $this
      ->installSchema('user', [
      'users_data',
    ]);
    $this
      ->installEntitySchema('user');
    $this
      ->apigeeTestHelperSetup();
    $environment_vars = [
      'APIGEE_EDGE_ENDPOINT',
      'APIGEE_EDGE_ORGANIZATION',
      'APIGEE_EDGE_USERNAME',
      'APIGEE_EDGE_PASSWORD',
    ];
    foreach ($environment_vars as $environment_var) {
      if (!getenv($environment_var)) {
        $this
          ->markTestSkipped('Environment variable ' . $environment_var . ' is not set, cannot run tests. See CONTRIBUTING.md for more information.');
      }
    }

    // Get environment variables for Edge connection.
    $this->endpoint = getenv('APIGEE_EDGE_ENDPOINT');
    $this->organization = getenv('APIGEE_EDGE_ORGANIZATION');
    $this->orgadminEmail = getenv('APIGEE_EDGE_USERNAME');
    $this->orgadminPassword = getenv('APIGEE_EDGE_PASSWORD');

    /** @var \GuzzleHttp\Client $client */
    $this->httpClient = $this->sdkConnector
      ->getClient();
  }

  /**
   * {@inheritdoc}
   */
  protected function tearDown() {
    $url = $this->endpoint . '/o/' . $this->organization . '/userroles/' . self::TEST_ROLE_NAME;
    try {
      $this->stack
        ->queueMockResponse('get_not_found');
      $response = $this->httpClient
        ->get($url);
      if ($response
        ->getStatusCode() == 200) {
        $url = $this->endpoint . '/o/' . $this->organization . '/userroles/' . self::TEST_ROLE_NAME;
        $this->httpClient
          ->delete($url);
      }
    } catch (\Exception $exception) {
      watchdog_exception('apigee_edge', $exception);
    }
    parent::tearDown();
  }

  /**
   * Fix for outbound HTTP requests fail with KernelTestBase.
   *
   * See comment #10:
   * https://www.drupal.org/project/drupal/issues/2571475#comment-11938008
   */
  public function alter(ContainerBuilder $container) {
    $container
      ->removeDefinition('test.http_client.middleware');
  }

  /**
   * Test actual call to Edge API that IsValidEdgeCredentials() uses.
   */
  public function testIsValidEdgeCredentialsEdgeApi() {
    $this->stack
      ->queueMockResponse([
      'get_organization' => [
        'org_name' => $this->organization,
      ],
    ]);
    $url = $this->endpoint . '/o/' . $this->organization;
    $response = $this->httpClient
      ->get($url);
    $body = json_decode($response
      ->getBody());
    $this
      ->assertTrue(isset($body->name), 'Edge org entity should contain "name" attribute.');
    $this
      ->assertEquals($this->organization, $body->name, 'Edge org name attribute should match org being called in url.');
  }

  /**
   * Test Edge API response/request for doesRoleExist()
   */
  public function testDoesRoleExist() {

    // Role should not exist.
    $url = $this->endpoint . '/o/' . $this->organization . '/userroles/' . self::TEST_ROLE_NAME;
    $errorMsg = 'Userrole temp_role does not exist';
    $this->stack
      ->queueMockResponse([
      'get_not_found' => [
        'status_code' => 404,
        'message' => $errorMsg,
      ],
    ]);
    $this
      ->expectException(ClientErrorException::class);
    $this
      ->expectExceptionMessage($errorMsg);
    $response = $this->httpClient
      ->get($url);
    $this
      ->assertEquals('404', $response
      ->getStatusCode(), 'Role that does not exist should return 404.');
  }

  /**
   * Test Edge API for creating role and setting permissions.
   */
  public function testCreateEdgeRoleAndSetPermissions() {
    $this->stack
      ->queueMockResponse([
      'no_content' => [
        'status_code' => 201,
      ],
    ]);
    $url = $this->endpoint . '/o/' . $this->organization . '/userroles';
    $response = $this->httpClient
      ->post($url, json_encode([
      'role' => [
        self::TEST_ROLE_NAME,
      ],
    ]));
    $this
      ->assertEquals('201', $response
      ->getStatusCode(), 'Role should be created.');

    // Add permissions to this role.
    $this->stack
      ->queueMockResponse([
      'no_content' => [
        'status_code' => 201,
      ],
    ]);
    $url = $this->endpoint . '/o/' . $this->organization . '/userroles/' . self::TEST_ROLE_NAME . '/permissions';
    $body = json_encode([
      'path' => '/developers',
      'permissions' => [
        'get',
        'put',
        'delete',
      ],
    ]);
    $response = $this->httpClient
      ->post($url, $body);
    $this
      ->assertEquals('201', $response
      ->getStatusCode(), 'Permission on role should be created.');
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ApigeeEdgeManagementCliServiceTest::$endpoint protected property Apigee API endpoint.
ApigeeEdgeManagementCliServiceTest::$httpClient protected property A GuzzleHttp\Client object.
ApigeeEdgeManagementCliServiceTest::$mock_api_client_ready protected static property Indicates this test class is mock API client ready.
ApigeeEdgeManagementCliServiceTest::$modules protected static property Modules to enable. Overrides KernelTestBase::$modules
ApigeeEdgeManagementCliServiceTest::$orgadminEmail protected property Email of an account with the organization admin Apigee role.
ApigeeEdgeManagementCliServiceTest::$orgadminPassword protected property The password of the orgadmin account.
ApigeeEdgeManagementCliServiceTest::$organization protected property Apigee Edge organization.
ApigeeEdgeManagementCliServiceTest::alter public function Fix for outbound HTTP requests fail with KernelTestBase. Overrides ServiceModifierInterface::alter
ApigeeEdgeManagementCliServiceTest::setUp protected function Overrides KernelTestBase::setUp
ApigeeEdgeManagementCliServiceTest::tearDown protected function Overrides KernelTestBase::tearDown
ApigeeEdgeManagementCliServiceTest::testCreateEdgeRoleAndSetPermissions public function Test Edge API for creating role and setting permissions.
ApigeeEdgeManagementCliServiceTest::testDoesRoleExist public function Test Edge API response/request for doesRoleExist()
ApigeeEdgeManagementCliServiceTest::testIsValidEdgeCredentialsEdgeApi public function Test actual call to Edge API that IsValidEdgeCredentials() uses.
ApigeeEdgeManagementCliServiceTest::TEST_ROLE_NAME protected constant
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.
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.