You are here

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

class DeveloperSyncTest in Apigee Edge 8

Developer-user synchronization test.

@group apigee_edge @group apigee_edge_developer @group apigee_edge_field

Hierarchy

Expanded class hierarchy of DeveloperSyncTest

File

tests/src/Functional/DeveloperSyncTest.php, line 40

Namespace

Drupal\Tests\apigee_edge\Functional
View source 
class DeveloperSyncTest extends ApigeeEdgeFunctionalTestBase {
  use FieldUiTestTrait;

  /**
   * Number of developers to create from each type.
   *
   * Exists only in Drupal, exists only on Apigee Edge, most recent in Drupal,
   * most recent on Apigee Edge.
   */
  const DEVELOPER_TO_CREATE_PER_TYPE = 1;

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

  /**
   * Random property prefix.
   *
   * @var string
   */
  protected $prefix;

  /**
   * Email filter.
   *
   * @var string
   */
  protected $filter;

  /**
   * Array of Apigee Edge developers.
   *
   * @var \Drupal\apigee_edge\Entity\DeveloperInterface[]
   */
  protected $edgeDevelopers = [];

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

  /**
   * Array of modified Apigee Edge developers.
   *
   * @var \Drupal\apigee_edge\Entity\DeveloperInterface[]
   */
  protected $modifiedEdgeDevelopers = [];

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

  /**
   * Inactive Apigee Edge developer assigned to an active Drupal user.
   *
   * @var \Drupal\apigee_edge\Entity\DeveloperInterface
   */
  protected $inactiveDeveloper;

  /**
   * Array of Drupal user fields.
   *
   * @var array
   */
  protected $fields = [];

  /**
   * Field name prefix.
   *
   * @var string
   */
  protected $fieldNamePrefix;

  /**
   * The field storage format manager service.
   *
   * @var \Drupal\apigee_edge\Plugin\FieldStorageFormatManager
   */
  protected $formatManager;

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();
    $this
      ->drupalPlaceBlock('system_breadcrumb_block');
    $this->fieldNamePrefix = $this
      ->config('field_ui.settings')
      ->get('field_prefix');
    $this->formatManager = $this->container
      ->get('plugin.manager.apigee_field_storage_format');
    $this->prefix = $this
      ->randomMachineName();
    $escaped_prefix = preg_quote($this->prefix);
    $this->filter = "/^{$escaped_prefix}\\.[a-zA-Z0-9]*@example\\.com\$/";
    $this->container
      ->get('config.factory')
      ->getEditable('apigee_edge.sync')
      ->set('filter', $this->filter)
      ->save();
    $this
      ->drupalLogin($this->rootUser);
    $this
      ->setUpUserFields();

    // Create developers on Apigee Edge.
    for ($i = 0; $i < self::DEVELOPER_TO_CREATE_PER_TYPE; $i++) {
      $mail = "{$this->prefix}.{$this->randomMachineName()}@example.com";
      $this->edgeDevelopers[$mail] = Developer::create([
        'email' => $mail,
        'userName' => $this
          ->randomMachineName(),
        'firstName' => $this
          ->randomMachineName(64),
        'lastName' => $this
          ->randomMachineName(64),
      ]);
      foreach ($this->fields as $field_type => $data) {
        $formatter = $this->formatManager
          ->lookupPluginForFieldType($field_type);
        $this->edgeDevelopers[$mail]
          ->setAttribute($data['name'], $formatter
          ->encode($data['data']));
      }
      $this->edgeDevelopers[$mail]
        ->setAttribute('invalid_email', 'invalid_email_address');
      $this->edgeDevelopers[$mail]
        ->save();
    }

    // Create users in Drupal. Do not let run apigee_edge_user_presave(), so
    // the corresponding developer won't be created.
    $this
      ->disableUserPresave();
    for ($i = 0; $i < self::DEVELOPER_TO_CREATE_PER_TYPE; $i++) {
      $user = $this
        ->createAccount([], TRUE, $this->prefix);
      foreach ($this->fields as $field_type => $data) {
        $user
          ->set($this->fieldNamePrefix . $data['name'], $data['data']);
      }
      $user
        ->save();
      $this->drupalUsers[$user
        ->getEmail()] = $user;
    }
    $this
      ->enableUserPresave();

    // Create synchronized users and change attribute values only on Apigee
    // Edge.
    for ($i = 0; $i < self::DEVELOPER_TO_CREATE_PER_TYPE; $i++) {
      $user = $this
        ->createAccount([], TRUE, $this->prefix);
      foreach ($this->fields as $field_type => $data) {
        $user
          ->set($this->fieldNamePrefix . $data['name'], $data['data']);
      }

      // Set unlinked field on the user.
      $user
        ->set($this->fieldNamePrefix . 'invalid_email', 'valid.email@example.com');

      // Set valid email field on the user.
      $user
        ->set($this->fieldNamePrefix . 'one_track_field', 'user');
      $user
        ->setChangedTime($this->container
        ->get('datetime.time')
        ->getCurrentTime() - 100);
      $user
        ->save();
      $this->modifiedEdgeDevelopers[$user
        ->getEmail()] = Developer::load($user
        ->getEmail());
      foreach ($this->fields as $field_type => $data) {
        $formatter = $this->formatManager
          ->lookupPluginForFieldType($field_type);
        $this->modifiedEdgeDevelopers[$user
          ->getEmail()]
          ->setAttribute($data['name'], $formatter
          ->encode($data['data_changed']));
      }

      // Change first name and last name.
      $this->modifiedEdgeDevelopers[$user
        ->getEmail()]
        ->setFirstName($this->randomGenerator
        ->word(8));
      $this->modifiedEdgeDevelopers[$user
        ->getEmail()]
        ->setLastName($this->randomGenerator
        ->word(8));

      // Set unlinked attribute on the developer.
      $this->modifiedEdgeDevelopers[$user
        ->getEmail()]
        ->setAttribute('one_track_field', 'developer');

      // Set invalid email attribute value on the developer.
      $this->modifiedEdgeDevelopers[$user
        ->getEmail()]
        ->setAttribute('invalid_email', 'invalid_email_address');
      $this->modifiedEdgeDevelopers[$user
        ->getEmail()]
        ->save();
    }

    // Create synchronized users and change field values only in Drupal.
    for ($i = 0; $i < self::DEVELOPER_TO_CREATE_PER_TYPE; $i++) {
      $user = $this
        ->createAccount([], TRUE, $this->prefix);
      foreach ($this->fields as $field_type => $data) {
        $user
          ->set($this->fieldNamePrefix . $data['name'], $data['data']);
      }
      $user
        ->save();
      $this->modifiedDrupalUsers[$user
        ->getEmail()] = $user;

      // Set unlinked field on Apigee Edge.

      /** @var \Drupal\apigee_edge\Entity\DeveloperInterface $developer */
      $developer = Developer::load($user
        ->getEmail());
      $developer
        ->setAttribute('one_track_field', 'developer');
      $developer
        ->save();

      // Do not let run apigee_edge_user_presave(), so the corresponding
      // developer won't be updated.
      $this
        ->disableUserPresave();
      foreach ($this->fields as $field_type => $data) {
        $this->modifiedDrupalUsers[$user
          ->getEmail()]
          ->set($this->fieldNamePrefix . $data['name'], $data['data_changed']);
      }

      // Change first name, last name and username.
      $this->modifiedDrupalUsers[$user
        ->getEmail()]
        ->set('first_name', $this->randomGenerator
        ->word(8));
      $this->modifiedDrupalUsers[$user
        ->getEmail()]
        ->set('last_name', $this->randomGenerator
        ->word(8));
      $this->modifiedDrupalUsers[$user
        ->getEmail()]
        ->set('name', $this->randomGenerator
        ->word(8));

      // Set unlinked field in Drupal.
      $this->modifiedDrupalUsers[$user
        ->getEmail()]
        ->set($this->fieldNamePrefix . 'one_track_field', 'user');

      // It's necessary because changed time is automatically updated on the UI
      // only.
      $this->modifiedDrupalUsers[$user
        ->getEmail()]
        ->setChangedTime($this->container
        ->get('datetime.time')
        ->getCurrentTime() + 100);
      $this->modifiedDrupalUsers[$user
        ->getEmail()]
        ->save();
      $this
        ->enableUserPresave();
    }

    // Developer's username already exists. Should not be copied into Drupal.
    Developer::create([
      'email' => "{$this->prefix}.reserved@example.com",
      'userName' => reset($this->drupalUsers)
        ->getAccountName(),
      'firstName' => $this
        ->randomMachineName(),
      'lastName' => $this
        ->randomMachineName(),
    ])
      ->save();

    // Do not block Drupal user if the corresponding developer's status is
    // inactive.
    $active_user = $this
      ->createAccount([], TRUE, $this->prefix);
    $dc = new DeveloperController($this->container
      ->get('apigee_edge.sdk_connector')
      ->getOrganization(), $this->container
      ->get('apigee_edge.sdk_connector')
      ->getClient());
    $dc
      ->setStatus($active_user
      ->getEmail(), Developer::STATUS_INACTIVE);
    $this->inactiveDeveloper = Developer::load($active_user
      ->getEmail());
    $this
      ->assertEquals($this->inactiveDeveloper
      ->getStatus(), Developer::STATUS_INACTIVE);
  }

  /**
   * Creates fields for Drupal users.
   */
  protected function setUpUserFields() {
    $text = $this
      ->getRandomGenerator()
      ->sentences(5);
    $link = [
      [
        'title' => 'Example',
        'options' => [],
        'uri' => 'http://example.com',
      ],
    ];
    $link_changed = [
      [
        'title' => 'Example_Changed',
        'options' => [],
        'uri' => 'http://example.com/changed',
      ],
    ];
    $this->fields = [
      'boolean' => [
        'name' => strtolower($this
          ->randomMachineName()),
        'data' => [
          [
            'value' => 1,
          ],
        ],
        'data_changed' => [
          [
            'value' => 0,
          ],
        ],
      ],
      'email' => [
        'name' => strtolower($this
          ->randomMachineName()),
        'data' => [
          [
            'value' => 'test@example.com',
          ],
        ],
        'data_changed' => [
          [
            'value' => 'test.changed@example.com',
          ],
        ],
      ],
      'timestamp' => [
        'name' => strtolower($this
          ->randomMachineName()),
        'data' => [
          [
            'value' => 1531212177,
          ],
        ],
        'data_changed' => [
          [
            'value' => 1531000000,
          ],
        ],
      ],
      'integer' => [
        'name' => strtolower($this
          ->randomMachineName()),
        'data' => [
          [
            'value' => 4,
          ],
          [
            'value' => 9,
          ],
        ],
        'data_changed' => [
          [
            'value' => 2,
          ],
          [
            'value' => 8,
          ],
          [
            'value' => 1,
          ],
        ],
      ],
      'list_integer' => [
        'name' => strtolower($this
          ->randomMachineName()),
        'settings' => [
          'settings[allowed_values]' => implode(PHP_EOL, [
            1,
            2,
            3,
          ]),
        ],
        'data' => [
          [
            'value' => 2,
          ],
          [
            'value' => 3,
          ],
        ],
        'data_changed' => [
          [
            'value' => 1,
          ],
          [
            'value' => 3,
          ],
        ],
      ],
      'list_string' => [
        'name' => strtolower($this
          ->randomMachineName()),
        'settings' => [
          'settings[allowed_values]' => implode(PHP_EOL, [
            'qwer',
            'asdf',
            'zxcv',
          ]),
        ],
        'data' => [
          [
            'value' => 'qwer',
          ],
          [
            'value' => 'asdf',
          ],
          [
            'value' => 'zxcv',
          ],
        ],
        'data_changed' => [
          [
            'value' => 'qwer',
          ],
          [
            'value' => 'asdf',
          ],
        ],
      ],
      'string' => [
        'name' => strtolower($this
          ->randomMachineName()),
        'data' => [
          [
            'value' => $text,
          ],
        ],
        'data_changed' => [
          [
            'value' => strrev($text),
          ],
        ],
      ],
      'string_long' => [
        'name' => strtolower($this
          ->randomMachineName()),
        'data' => [
          [
            'value' => $text,
          ],
        ],
        'data_changed' => [
          [
            'value' => strrev($text),
          ],
        ],
      ],
      'link' => [
        'name' => strtolower($this
          ->randomMachineName()),
        'data' => $link,
        'data_changed' => $link_changed,
      ],
    ];
    foreach ($this->fields as $field_type => $data) {
      $this
        ->fieldUIAddNewField(Url::fromRoute('entity.user.admin_form')
        ->toString(), $data['name'], mb_strtoupper($data['name']), $field_type, ($data['settings'] ?? []) + [
        'cardinality' => -1,
      ], []);
    }

    // Create a Drupal user field that is not linked to any Apigee Edge
    // developer attribute. It should be unchanged after sync on both sides.
    $this
      ->fieldUIAddNewField(Url::fromRoute('entity.user.admin_form')
      ->toString(), 'one_track_field', strtoupper('one_track_field'), 'string', [
      'cardinality' => -1,
    ], []);

    // Create a Drupal user email field that has an invalid value on Apigee Edge
    // (invalid email address). The invalid value should not be copied into the
    // Drupal user's field.
    $this
      ->fieldUIAddNewField(Url::fromRoute('entity.user.admin_form')
      ->toString(), 'invalid_email', strtoupper('invalid_email'), 'email', [
      'cardinality' => -1,
    ], []);
    drupal_flush_all_caches();

    // Set the fields to be synchronized.
    $this
      ->drupalGet(Url::fromRoute('apigee_edge.settings.developer.attributes'));
    $full_field_names = [];
    foreach ($this->fields as $field_type => $data) {
      $full_field_name = "{$this->fieldNamePrefix}{$data['name']}";
      $this
        ->getSession()
        ->getPage()
        ->checkField("attributes[{$full_field_name}]");
      $full_field_names[] = $full_field_name;
    }
    $this
      ->getSession()
      ->getPage()
      ->checkField("attributes[{$this->fieldNamePrefix}invalid_email]");
    $full_field_names[] = "{$this->fieldNamePrefix}invalid_email";
    $this
      ->getSession()
      ->getPage()
      ->pressButton('Save configuration');
    $this
      ->assertSession()
      ->pageTextContains('The configuration options have been saved.');
    $user_fields_to_sync = $this
      ->config('apigee_edge.sync')
      ->get('user_fields_to_sync');
    $this
      ->assertEquals(asort($user_fields_to_sync), asort($full_field_names));
  }

  /**
   * {@inheritdoc}
   */
  protected function tearDown() {
    $developers_to_delete = array_merge($this->edgeDevelopers, $this->drupalUsers, $this->modifiedEdgeDevelopers, $this->modifiedDrupalUsers);
    foreach ($developers_to_delete as $email => $entity) {
      try {

        /** @var \Drupal\apigee_edge\Entity\DeveloperInterface $developer */
        if (($developer = Developer::load($email)) !== NULL) {
          $developer
            ->delete();
        }
      } catch (\Exception $exception) {
        $this
          ->logException($exception);
      }
    }
    try {

      /** @var \Drupal\apigee_edge\Entity\DeveloperInterface $developer */
      if (($developer = Developer::load("{$this->prefix}.reserved@example.com")) !== NULL) {
        $developer
          ->delete();
      }
    } catch (\Exception $exception) {
      $this
        ->logException($exception);
    }
    try {
      if ($this->inactiveDeveloper !== NULL) {
        $this->inactiveDeveloper
          ->delete();
      }
    } catch (\Exception $exception) {
      $this
        ->logException($exception);
    }
    parent::tearDown();
  }

  /**
   * Verifies that the Drupal users and the Edge developers are synchronized.
   */
  protected function verify() {
    $developers_to_verify = array_merge($this->edgeDevelopers, $this->drupalUsers, $this->modifiedEdgeDevelopers, $this->modifiedDrupalUsers);
    foreach ($developers_to_verify as $email => $entity) {

      /** @var \Drupal\user\UserInterface $user */
      $user = user_load_by_mail($email);

      /** @var \Drupal\apigee_edge\Entity\DeveloperInterface $developer */
      $developer = Developer::load($email);
      $this
        ->assertNotEmpty($user, 'User found: ' . $email);
      $this
        ->assertNotEmpty($developer, 'Developer found: ' . $email);
      $this
        ->assertEquals($developer
        ->getUserName(), $user
        ->getAccountName());
      $this
        ->assertEquals($developer
        ->getFirstName(), $user
        ->get('first_name')->value);
      $this
        ->assertEquals($developer
        ->getLastName(), $user
        ->get('last_name')->value);
      if (array_key_exists($email, $this->modifiedDrupalUsers) || array_key_exists($email, $this->modifiedEdgeDevelopers)) {

        // Unlinked field/attribute should be unchanged on both sides.
        $this
          ->assertEquals($developer
          ->getAttributeValue('one_track_field'), 'developer');
        $this
          ->assertEquals($user
          ->get($this->fieldNamePrefix . 'one_track_field')->value, 'user');
        foreach ($this->fields as $field_type => $data) {
          $formatter = $this->formatManager
            ->lookupPluginForFieldType($field_type);
          if ($formatter instanceof JSON) {
            $this
              ->assertJsonStringEqualsJsonString($developer
              ->getAttributeValue($data['name']), $formatter
              ->encode($user
              ->get($this->fieldNamePrefix . $data['name'])
              ->getValue()));
            $this
              ->assertJsonStringEqualsJsonString($developer
              ->getAttributeValue($data['name']), $formatter
              ->encode($data['data_changed']));
          }
          elseif ($formatter instanceof CSV) {
            $this
              ->assertEquals($developer
              ->getAttributeValue($data['name']), $formatter
              ->encode($user
              ->get($this->fieldNamePrefix . $data['name'])
              ->getValue()));
            $this
              ->assertEquals($developer
              ->getAttributeValue($data['name']), $formatter
              ->encode($data['data_changed']));
          }
        }
      }
      else {
        foreach ($this->fields as $field_type => $data) {
          $formatter = $this->formatManager
            ->lookupPluginForFieldType($field_type);
          if ($formatter instanceof JSON) {
            $this
              ->assertJsonStringEqualsJsonString($developer
              ->getAttributeValue($data['name']), $formatter
              ->encode($user
              ->get($this->fieldNamePrefix . $data['name'])
              ->getValue()));
            $this
              ->assertJsonStringEqualsJsonString($developer
              ->getAttributeValue($data['name']), $formatter
              ->encode($data['data']));
          }
          elseif ($formatter instanceof CSV) {
            $this
              ->assertEquals($developer
              ->getAttributeValue($data['name']), $formatter
              ->encode($user
              ->get($this->fieldNamePrefix . $data['name'])
              ->getValue()));
            $this
              ->assertEquals($developer
              ->getAttributeValue($data['name']), $formatter
              ->encode($data['data']));
          }
        }
      }

      // Invalid email address should not be copied into the corresponding
      // Drupal user field.
      if ($developer
        ->hasAttribute('invalid_email')) {
        if (array_key_exists($email, $this->edgeDevelopers)) {
          $this
            ->assertNull($user
            ->get("{$this->fieldNamePrefix}invalid_email")->value);
        }
        elseif (array_key_exists($email, $this->modifiedEdgeDevelopers)) {
          $this
            ->assertEquals($user
            ->get("{$this->fieldNamePrefix}invalid_email")->value, 'valid.email@example.com');
        }
      }
    }

    // Developer with existing username is not copied into Drupal.
    $this
      ->assertFalse(user_load_by_mail("{$this->prefix}.reserved@example.com"));

    // Drupal user's status is active.

    /** @var \Drupal\user\UserInterface $active_user */
    $active_user = user_load_by_mail($this->inactiveDeveloper
      ->getEmail());
    $this
      ->assertTrue($active_user
      ->isActive());

    // Only the necessary test users were created in Drupal besides the
    // inactive developer's, anonymous and admin users.
    $this
      ->assertEquals(count(User::loadMultiple()), count($developers_to_verify) + 3);
  }

  /**
   * Tests developer synchronization.
   */
  public function testDeveloperSync() {
    $this
      ->drupalGet(Url::fromRoute('apigee_edge.settings.developer.sync'));
    $this
      ->clickLinkProperly('Run developer sync');
    $this
      ->assertSession()
      ->pageTextContains('Apigee Edge developers are in sync with Drupal users.');

    // Fix cache invalidation issue that makes this test fail.
    // It seems clearing user storage's cache with the line below does not
    // clear the _real_ user storage cache which is used by user_load_by_mail().
    // $this->container->get('entity_type.manager')->getStorage('user')->resetCache();
    // On the other hand, when a user gets updated entity cache should be
    // invalidated automatically.
    // @see https://www.drupal.org/project/drupal/issues/3015002
    \Drupal::service('entity_type.manager')
      ->getStorage('user')
      ->resetCache();
    $this
      ->verify();
  }

  /**
   * Tests scheduled developer synchronization.
   */
  public function testDeveloperAsync() {
    $this
      ->drupalGet(Url::fromRoute('apigee_edge.settings.developer.sync'));
    $this
      ->clickLinkProperly('Background');
    $this
      ->assertSession()
      ->pageTextContains('Developer synchronization is scheduled.');

    /** @var \Drupal\Core\Queue\QueueFactory $queue_service */
    $queue_service = $this->container
      ->get('queue');

    /** @var \Drupal\Core\Queue\QueueInterface $queue */
    $queue = $queue_service
      ->get('apigee_edge_job');

    /** @var \Drupal\Core\Queue\QueueWorkerManagerInterface $queue_worker_manager */
    $queue_worker_manager = $this->container
      ->get('plugin.manager.queue_worker');

    /** @var \Drupal\Core\Queue\QueueWorkerInterface $worker */
    $worker = $queue_worker_manager
      ->createInstance('apigee_edge_job');
    while ($item = $queue
      ->claimItem()) {
      $worker
        ->processItem($item->data);
      $queue
        ->deleteItem($item);
    }
    $this
      ->verify();
  }

  /**
   * Tests the developer synchronization started from the CLI.
   */
  public function testCliDeveloperSync() {
    $cli_service = $this->container
      ->get('apigee_edge.cli');
    $input = new ArgvInput();
    $output = new BufferedOutput();
    $cli_service
      ->sync(new SymfonyStyle($input, $output), 't');
    $printed_output = $output
      ->fetch();
    foreach ($this->edgeDevelopers as $email => $developer) {
      $this
        ->assertStringContainsString("Copying developer ({$email}) from Apigee Edge.", $printed_output);
    }
    foreach ($this->drupalUsers as $email => $user) {
      $this
        ->assertStringContainsString("Copying user ({$email}) to Apigee Edge.", $printed_output);
    }
    foreach ($this->modifiedEdgeDevelopers as $email => $developer) {
      $this
        ->assertStringContainsString("Updating user ({$email}) from Apigee Edge.", $printed_output);
    }
    foreach ($this->modifiedDrupalUsers as $email => $user) {
      $this
        ->assertStringContainsString("Updating developer ({$email}) in Apigee Edge.", $printed_output);
    }
    $this
      ->verify();
  }

}

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::$mock_api_client_ready protected static property Use the mock_api_client or not. 9
ApigeeEdgeFunctionalTestTrait::clickLinkProperly protected function Implements link clicking properly.
ApigeeEdgeFunctionalTestTrait::createAccount protected function Creates a Drupal account.
ApigeeEdgeFunctionalTestTrait::createDeveloperApp protected function Creates an app for a user. Overrides ApigeeMockApiClientHelperTrait::createDeveloperApp
ApigeeEdgeFunctionalTestTrait::createProduct protected function Creates a product.
ApigeeEdgeFunctionalTestTrait::disableUserPresave protected function The corresponding developer will not be created if a Drupal user is saved.
ApigeeEdgeFunctionalTestTrait::drupalGetNoMetaRefresh protected function The same as drupalGet(), but ignores the meta refresh.
ApigeeEdgeFunctionalTestTrait::enableUserPresave protected function The corresponding developer will be created if a Drupal user is saved.
ApigeeEdgeFunctionalTestTrait::findLink protected function Finds a link on the current page.
ApigeeEdgeFunctionalTestTrait::fixUrl protected static function Returns absolute URL starts with a slash.
ApigeeEdgeFunctionalTestTrait::getApps protected function Loads all apps for a given user. 1
ApigeeEdgeFunctionalTestTrait::getRandomUniqueId protected function Gets a random unique ID.
ApigeeEdgeFunctionalTestTrait::initTestEnv protected function Initializes test environment with required configuration.
ApigeeEdgeFunctionalTestTrait::logException protected function Log the given exception using the class short name as type.
ApigeeEdgeUtilTestTrait::createTestKey protected function Creates a test key from environment variables, using config key storage.
ApigeeEdgeUtilTestTrait::invalidateKey protected function Removes the active key for testing with unset API credentials.
ApigeeEdgeUtilTestTrait::restoreKey protected function Restores the active key.
ApigeeEdgeUtilTestTrait::setKey protected function Set active authentication keys in config.
ApigeeMockApiClientHelperTrait::$entityTypeManager protected property The entity type manager.
ApigeeMockApiClientHelperTrait::$integration_enabled protected property If integration (real API connection) is enabled.
ApigeeMockApiClientHelperTrait::$mockResponseFactory protected property The mock response factory service.
ApigeeMockApiClientHelperTrait::$sdkConnector protected property The SDK connector service. 1
ApigeeMockApiClientHelperTrait::$stack protected property The mock handler stack is responsible for serving queued api responses.
ApigeeMockApiClientHelperTrait::addDeveloperMatchedResponse protected function Add matched developer response.
ApigeeMockApiClientHelperTrait::addOrganizationMatchedResponse protected function Add matched org response.
ApigeeMockApiClientHelperTrait::addUserToTeam public function Adds a user to a team.
ApigeeMockApiClientHelperTrait::apigeeTestHelperSetup protected function Setup.
ApigeeMockApiClientHelperTrait::apigeeTestPropertiesSetup protected function Setup.
ApigeeMockApiClientHelperTrait::createTeam protected function Helper to create a Team entity.
ApigeeMockApiClientHelperTrait::initAuth protected function Initialize SDK connector.
ApigeeMockApiClientHelperTrait::installExtraModules protected function Installs a given list of modules and rebuilds the cache.
ApigeeMockApiClientHelperTrait::queueCompaniesResponse protected function Queues up a mock companies response.
ApigeeMockApiClientHelperTrait::queueCompanyResponse protected function Queues up a mock company response.
ApigeeMockApiClientHelperTrait::queueDeveloperAppResponse protected function Helper to add Edge entity response to stack.
ApigeeMockApiClientHelperTrait::queueDeveloperResponse protected function Queues up a mock developer response.
ApigeeMockApiClientHelperTrait::queueDeveloperResponseFromDeveloper protected function Queues up a mock developer response.
ApigeeMockApiClientHelperTrait::queueDevsInCompanyResponse protected function Queues up a mock developers in a company response.
AssertHelperTrait::castSafeStrings protected static function Casts MarkupInterface objects into strings.
AssertLegacyTrait::assert protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::assertCacheTag protected function Asserts whether an expected cache tag was present in the last response.
AssertLegacyTrait::assertElementNotPresent protected function Asserts that the element with the given CSS selector is not present.
AssertLegacyTrait::assertElementPresent protected function Asserts that the element with the given CSS selector is present.
AssertLegacyTrait::assertEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertLegacyTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertLegacyTrait::assertFieldById protected function Asserts that a field exists with the given ID and value.
AssertLegacyTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertLegacyTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertLegacyTrait::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
AssertLegacyTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertLegacyTrait::assertHeader protected function Checks that current response header equals value.
AssertLegacyTrait::assertIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertSame() instead.
AssertLegacyTrait::assertIdenticalObject protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertLink protected function Passes if a link with the specified label is found.
AssertLegacyTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertLegacyTrait::assertNoCacheTag protected function Asserts whether an expected cache tag was absent in the last response.
AssertLegacyTrait::assertNoEscaped protected function Passes if the raw text is not found escaped on the loaded page.
AssertLegacyTrait::assertNoField protected function Asserts that a field does NOT exist with the given name or ID.
AssertLegacyTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertLegacyTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertLegacyTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertLegacyTrait::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
AssertLegacyTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertLegacyTrait::assertNoLinkByHref protected function Passes if a link containing a given href (part) is not found.
AssertLegacyTrait::assertNoOption protected function Asserts that a select option does NOT exist in the current page.
AssertLegacyTrait::assertNoPattern protected function Triggers a pass if the Perl regex pattern is not found in the raw content.
AssertLegacyTrait::assertNoRaw protected function Passes if the raw text IS not found on the loaded page, fail otherwise. 1
AssertLegacyTrait::assertNotEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotEquals() instead.
AssertLegacyTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text. 1
AssertLegacyTrait::assertNotIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotSame() instead.
AssertLegacyTrait::assertNoUniqueText protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertLegacyTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertLegacyTrait::assertOptionByText protected function Asserts that a select option with the visible text exists.
AssertLegacyTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertLegacyTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertLegacyTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise. 1
AssertLegacyTrait::assertResponse protected function Asserts the page responds with the specified response code. 1
AssertLegacyTrait::assertText protected function Passes if the page (with HTML stripped) contains the text. 1
AssertLegacyTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertLegacyTrait::assertTitle protected function Pass if the page title is the given string.
AssertLegacyTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertLegacyTrait::assertUrl protected function Passes if the internal browser's URL matches the given path.
AssertLegacyTrait::buildXPathQuery protected function Builds an XPath query.
AssertLegacyTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertLegacyTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertLegacyTrait::getRawContent protected function Gets the current raw content.
AssertLegacyTrait::pass protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::verbose protected function
BlockCreationTrait::placeBlock protected function Creates a block instance based on default settings. Aliased as: drupalPlaceBlock
BrowserHtmlDebugTrait::$htmlOutputBaseUrl protected property The Base URI to use for links to the output files.
BrowserHtmlDebugTrait::$htmlOutputClassName protected property Class name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounter protected property Counter for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounterStorage protected property Counter storage for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputDirectory protected property Directory name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputEnabled protected property HTML output output enabled.
BrowserHtmlDebugTrait::$htmlOutputFile protected property The file name to write the list of URLs to.
BrowserHtmlDebugTrait::$htmlOutputTestId protected property HTML output test ID.
BrowserHtmlDebugTrait::formatHtmlOutputHeaders protected function Formats HTTP headers as string for HTML output logging.
BrowserHtmlDebugTrait::getHtmlOutputHeaders protected function Returns headers in HTML output format. 1
BrowserHtmlDebugTrait::htmlOutput protected function Logs a HTML output message in a text file.
BrowserHtmlDebugTrait::initBrowserOutputFile protected function Creates the directory to store browser output.
BrowserTestBase::$baseUrl protected property The base URL.
BrowserTestBase::$configImporter protected property The config importer that can be used in a test.
BrowserTestBase::$customTranslations protected property An array of custom translations suitable for drupal_rewrite_settings().
BrowserTestBase::$databasePrefix protected property The database prefix of this test run.
BrowserTestBase::$mink protected property Mink session manager.
BrowserTestBase::$minkDefaultDriverArgs protected property
BrowserTestBase::$minkDefaultDriverClass protected property 1
BrowserTestBase::$originalContainer protected property The original container.
BrowserTestBase::$originalShutdownCallbacks protected property The original array of shutdown function callbacks.
BrowserTestBase::$preserveGlobalState protected property
BrowserTestBase::$profile protected property The profile to install as a basis for testing. 39
BrowserTestBase::$root protected property The app root.
BrowserTestBase::$runTestInSeparateProcess protected property Browser tests are run in separate processes to prevent collisions between code that may be loaded by tests.
BrowserTestBase::$timeLimit protected property Time limit in seconds for the test.
BrowserTestBase::$translationFilesDirectory protected property The translation file directory for the test environment.
BrowserTestBase::cleanupEnvironment protected function Clean up the Simpletest environment.
BrowserTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
BrowserTestBase::cssSelectToXpath protected function Translates a CSS expression to its XPath equivalent.
BrowserTestBase::drupalGetHeader protected function Gets the value of an HTTP response header.
BrowserTestBase::drupalGetHeaders Deprecated protected function Returns all response headers.
BrowserTestBase::filePreDeleteCallback public static function Ensures test files are deletable.
BrowserTestBase::getDefaultDriverInstance protected function Gets an instance of the default Mink driver.
BrowserTestBase::getDrupalSettings protected function Gets the JavaScript drupalSettings variable for the currently-loaded page. 1
BrowserTestBase::getHttpClient protected function Obtain the HTTP client for the system under test.
BrowserTestBase::getMinkDriverArgs protected function Get the Mink driver args from an environment variable, if it is set. Can be overridden in a derived class so it is possible to use a different value for a subset of tests, e.g. the JavaScript tests. 1
BrowserTestBase::getOptions protected function Helper function to get the options of select field.
BrowserTestBase::getResponseLogHandler protected function Provides a Guzzle middleware handler to log every response received. Overrides BrowserHtmlDebugTrait::getResponseLogHandler
BrowserTestBase::getSession public function Returns Mink session.
BrowserTestBase::getSessionCookies protected function Get session cookies from current session.
BrowserTestBase::getTestMethodCaller protected function Retrieves the current calling line in the class under test. Overrides BrowserHtmlDebugTrait::getTestMethodCaller
BrowserTestBase::initFrontPage protected function Visits the front page when initializing Mink. 3
BrowserTestBase::initMink protected function Initializes Mink sessions. 1
BrowserTestBase::installDrupal public function Installs Drupal into the Simpletest site. 1
BrowserTestBase::registerSessions protected function Registers additional Mink sessions.
BrowserTestBase::translatePostValues protected function Transforms a nested array into a flat array suitable for drupalPostForm().
BrowserTestBase::xpath protected function Performs an xpath search on the contents of the internal browser.
BrowserTestBase::__construct public function 1
BrowserTestBase::__sleep public function Prevents serializing any properties.
ConfigTestTrait::configImporter protected function Returns a ConfigImporter object to import test configuration.
ConfigTestTrait::copyConfig protected function Copies configuration objects from source storage to target storage.
ContentTypeCreationTrait::createContentType protected function Creates a custom content type based on default settings. Aliased as: drupalCreateContentType 1
DeveloperSyncTest::$drupalUsers protected property Array of Drupal users.
DeveloperSyncTest::$edgeDevelopers protected property Array of Apigee Edge developers.
DeveloperSyncTest::$fieldNamePrefix protected property Field name prefix.
DeveloperSyncTest::$fields protected property Array of Drupal user fields.
DeveloperSyncTest::$filter protected property Email filter.
DeveloperSyncTest::$formatManager protected property The field storage format manager service.
DeveloperSyncTest::$inactiveDeveloper protected property Inactive Apigee Edge developer assigned to an active Drupal user.
DeveloperSyncTest::$modifiedDrupalUsers protected property Array of modified Drupal users.
DeveloperSyncTest::$modifiedEdgeDevelopers protected property Array of modified Apigee Edge developers.
DeveloperSyncTest::$modules protected static property Modules to enable. Overrides BrowserTestBase::$modules
DeveloperSyncTest::$prefix protected property Random property prefix.
DeveloperSyncTest::DEVELOPER_TO_CREATE_PER_TYPE constant Number of developers to create from each type.
DeveloperSyncTest::setUp protected function Overrides ApigeeEdgeFunctionalTestBase::setUp
DeveloperSyncTest::setUpUserFields protected function Creates fields for Drupal users.
DeveloperSyncTest::tearDown protected function Overrides BrowserTestBase::tearDown
DeveloperSyncTest::testCliDeveloperSync public function Tests the developer synchronization started from the CLI.
DeveloperSyncTest::testDeveloperAsync public function Tests scheduled developer synchronization.
DeveloperSyncTest::testDeveloperSync public function Tests developer synchronization.
DeveloperSyncTest::verify protected function Verifies that the Drupal users and the Edge developers are synchronized.
FieldUiTestTrait::fieldUIAddExistingField public function Adds an existing field through the Field UI.
FieldUiTestTrait::fieldUIAddNewField public function Creates a new field through the Field UI.
FieldUiTestTrait::fieldUIDeleteField public function Deletes a field through the Field UI.
FunctionalTestSetupTrait::$apcuEnsureUniquePrefix protected property The flag to set 'apcu_ensure_unique_prefix' setting. 1
FunctionalTestSetupTrait::$classLoader protected property The class loader to use for installation and initialization of setup.
FunctionalTestSetupTrait::$configDirectories Deprecated protected property The config directories used in this test.
FunctionalTestSetupTrait::$rootUser protected property The "#1" admin user.
FunctionalTestSetupTrait::doInstall protected function Execute the non-interactive installer. 1
FunctionalTestSetupTrait::getDatabaseTypes protected function Returns all supported database driver installer objects.
FunctionalTestSetupTrait::initConfig protected function Initialize various configurations post-installation. 2
FunctionalTestSetupTrait::initKernel protected function Initializes the kernel after installation.
FunctionalTestSetupTrait::initSettings protected function Initialize settings created during install.
FunctionalTestSetupTrait::initUserSession protected function Initializes user 1 for the site to be installed.
FunctionalTestSetupTrait::installDefaultThemeFromClassProperty protected function Installs the default theme defined by `static::$defaultTheme` when needed.
FunctionalTestSetupTrait::installModulesFromClassProperty protected function Install modules defined by `static::$modules`. 1
FunctionalTestSetupTrait::installParameters protected function Returns the parameters that will be used when Simpletest installs Drupal. 9
FunctionalTestSetupTrait::prepareEnvironment protected function Prepares the current environment for running the test. 23
FunctionalTestSetupTrait::prepareRequestForGenerator protected function Creates a mock request and sets it on the generator.
FunctionalTestSetupTrait::prepareSettings protected function Prepares site settings and services before installation. 2
FunctionalTestSetupTrait::rebuildAll protected function Resets and rebuilds the environment after setup.
FunctionalTestSetupTrait::rebuildContainer protected function Rebuilds \Drupal::getContainer().
FunctionalTestSetupTrait::resetAll protected function Resets all data structures after having enabled new modules.
FunctionalTestSetupTrait::setContainerParameter protected function Changes parameters in the services.yml file.
FunctionalTestSetupTrait::setupBaseUrl protected function Sets up the base URL based upon the environment variable.
FunctionalTestSetupTrait::writeSettings protected function Rewrites the settings.php file of the test site.
NodeCreationTrait::createNode protected function Creates a node based on default settings. Aliased as: drupalCreateNode
NodeCreationTrait::getNodeByTitle public function Get a node from the database based on its title. Aliased as: drupalGetNodeByTitle
PhpunitCompatibilityTrait::getMock Deprecated public function Returns a mock object for the specified class using the available method.
PhpunitCompatibilityTrait::setExpectedException Deprecated public function Compatibility layer for PHPUnit 6 to support PHPUnit 4 code.
RandomGeneratorTrait::$randomGenerator protected property The random generator.
RandomGeneratorTrait::getRandomGenerator protected function Gets the random generator for the utility methods.
RandomGeneratorTrait::randomMachineName protected function Generates a unique random string containing letters and numbers. 1
RandomGeneratorTrait::randomObject public function Generates a random PHP object.
RandomGeneratorTrait::randomString public function Generates a pseudo-random string of ASCII characters of codes 32 to 126.
RandomGeneratorTrait::randomStringValidate public function Callback for random string validation.
RefreshVariablesTrait::refreshVariables protected function Refreshes in-memory configuration and state information. 3
SessionTestTrait::$sessionName protected property The name of the session cookie.
SessionTestTrait::generateSessionName protected function Generates a session cookie name.
SessionTestTrait::getSessionName protected function Returns the session name in use on the child site.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
TestRequirementsTrait::checkModuleRequirements private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements protected function Check module requirements for the Drupal use case. 1
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.
TestSetupTrait::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking.
TestSetupTrait::$container protected property The dependency injection container used in the test.
TestSetupTrait::$kernel protected property The DrupalKernel instance used in the test.
TestSetupTrait::$originalSite protected property The site directory of the original parent site.
TestSetupTrait::$privateFilesDirectory protected property The private file directory for the test environment.
TestSetupTrait::$publicFilesDirectory protected property The public file directory for the test environment.
TestSetupTrait::$siteDirectory protected property The site directory of this test run.
TestSetupTrait::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 2
TestSetupTrait::$tempFilesDirectory protected property The temporary file directory for the test environment.
TestSetupTrait::$testId protected property The test run ID.
TestSetupTrait::changeDatabasePrefix protected function Changes the database connection to the prefixed one.
TestSetupTrait::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
TestSetupTrait::getDatabaseConnection public static function Returns the database connection to the site running Simpletest.
TestSetupTrait::prepareDatabasePrefix protected function Generates a database prefix for running tests. 2
UiHelperTrait::$loggedInUser protected property The current user logged in using the Mink controlled browser.
UiHelperTrait::$maximumMetaRefreshCount protected property The number of meta refresh redirects to follow, or NULL if unlimited.
UiHelperTrait::$metaRefreshCount protected property The number of meta refresh redirects followed during ::drupalGet().
UiHelperTrait::assertSession public function Returns WebAssert object. 1
UiHelperTrait::buildUrl protected function Builds an a absolute URL from a system path or a URL object.
UiHelperTrait::checkForMetaRefresh protected function Checks for meta refresh tag and if found call drupalGet() recursively.
UiHelperTrait::click protected function Clicks the element with the given CSS selector.
UiHelperTrait::clickLink protected function Follows a link by complete name.
UiHelperTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
UiHelperTrait::drupalGet protected function Retrieves a Drupal path or an absolute path. 3
UiHelperTrait::drupalLogin protected function Logs in a user using the Mink controlled browser.
UiHelperTrait::drupalLogout protected function Logs a user out of the Mink controlled browser and confirms.
UiHelperTrait::drupalPostForm protected function Executes a form submission.
UiHelperTrait::drupalUserIsLoggedIn protected function Returns whether a given user account is logged in.
UiHelperTrait::getAbsoluteUrl protected function Takes a path and returns an absolute path.
UiHelperTrait::getTextContent protected function Retrieves the plain-text content from the current page.
UiHelperTrait::getUrl protected function Get the current URL from the browser.
UiHelperTrait::prepareRequest protected function Prepare for a request to testing site. 1
UiHelperTrait::submitForm protected function Fills and submits a form.
UserCreationTrait::checkPermissions protected function Checks whether a given list of permission names is valid.
UserCreationTrait::createAdminRole protected function Creates an administrative role.
UserCreationTrait::createRole protected function Creates a role with specified permissions. Aliased as: drupalCreateRole
UserCreationTrait::createUser protected function Create a user with a given set of permissions. Aliased as: drupalCreateUser
UserCreationTrait::grantPermissions protected function Grant permissions to a user role.
UserCreationTrait::setCurrentUser protected function Switch the current logged in user.
UserCreationTrait::setUpCurrentUser protected function Creates a random user account and sets it as current user.
XdebugRequestTrait::extractCookiesFromRequest protected function Adds xdebug cookies, from request setup.