trait DeveloperAppUITestTrait in Apigee Edge 8

trait DeveloperAppUITestTrait {
  use ApigeeEdgeFunctionalTestTrait;

  /**
   * Default user.
   *
   * @var \Drupal\user\UserInterface
   */
  protected $account;

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

  /**
   * Permissions of created users.
   *
   * @var array
   */
  protected static $permissions = [
    'administer apigee edge',
    'create developer_app',
    'view own developer_app',
    'update own developer_app',
    'delete own developer_app',
    'edit_api_products developer_app',
  ];

  /**
   * Goes to the users' create app form.
   *
   * @param \Drupal\user\UserInterface|null $account
   *   The user entity.
   */
  protected function gotoCreateAppForm(?UserInterface $account = NULL) {
    if ($account === NULL) {
      $account = $this->account;
    }
    $this
      ->drupalGet(Url::fromRoute('entity.developer_app.add_form_for_developer', [
      'user' => $account
        ->id(),
    ]));
  }

  /**
   * Submits the create app admin form.
   *
   * @param array $changes
   *   Settings to save.
   */
  protected function submitAdminForm(array $changes = []) {
    $url = Url::fromRoute('apigee_edge.settings.general_app');
    $this
      ->drupalGet($url);
    $data = $changes + [
      'display_as_select' => FALSE,
      'user_select' => TRUE,
      'multiple_products' => TRUE,
    ];
    $multiple_products = $data['multiple_products'];
    unset($data['multiple_products']);
    $this
      ->config('apigee_edge.common_app_settings')
      ->set('multiple_products', $multiple_products)
      ->save();
    $this
      ->drupalPostForm($url, $data, 'Save configuration');
  }

  /**
   * Posts the create app form.
   *
   * @param array $data
   *   Data to post.
   * @param \Drupal\user\UserInterface|null $account
   *   Owner of the form.
   */
  protected function postCreateAppForm(array $data, ?UserInterface $account = NULL) {
    if ($account === NULL) {
      $account = $this->account;
    }
    $this
      ->drupalPostForm(Url::fromRoute('entity.developer_app.add_form_for_developer', [
      'user' => $account
        ->id(),
    ]), $data, 'Add app');
  }

  /**
   * Submit developer app edit form.
   *
   * @param array $data
   *   Form data.
   * @param string $app_name
   *   App name.
   * @param \Drupal\user\UserInterface|null $account
   *   Owner of the developer app.
   */
  protected function postEditAppForm(array $data, string $app_name, ?UserInterface $account = NULL) {
    if ($account === NULL) {
      $account = $this->account;
    }
    $this
      ->drupalPostForm("/user/{$account->id()}/apps/{$app_name}/edit", $data, 'Save');
  }

  /**
   * {@inheritdoc}
   */
  protected function getApps(?string $email = NULL) : ?array {
    if ($email === NULL) {
      $email = $this->account
        ->getEmail();
    }
    return parent::getApps($email);
  }

  /**
   * Asserts that a certain app exists.
   *
   * @param string $name
   *   Name of the app.
   *
   * @return \Drupal\apigee_edge\Entity\DeveloperAppInterface|null
   *   Developer app or null.
   */
  protected function assertDeveloperAppExists(string $name) : ?DeveloperAppInterface {

    /** @var \Drupal\apigee_edge\Entity\DeveloperAppInterface[] $apps */
    $apps = $this
      ->getApps();
    $found = NULL;
    foreach ($apps as $app) {
      if ($app
        ->getName() === $name) {
        $found = $app;
        break;
      }
    }
    $this
      ->assertNotNull($found, 'Developer app name found.');
    return $found;
  }

  /**
   * Goes through a typical CRUD cycle for an app.
   *
   * @param callable|null $beforeCreate
   *   Alters the data that will be posted on the create form.
   * @param callable|null $afterCreate
   *   Additional asserts after the app is created.
   * @param callable|null $beforeUpdate
   *   Alters the data that will be posted on the update form.
   * @param callable|null $afterUpdate
   *   Additional asserts after the app is created.
   * @param \Drupal\user\UserInterface|null $account
   *   Owner of the app.
   */
  protected function assertAppCrud(?callable $beforeCreate = NULL, ?callable $afterCreate = NULL, ?callable $beforeUpdate = NULL, ?callable $afterUpdate = NULL, ?UserInterface $account = NULL) {
    if ($account === NULL) {
      $account = $this->account;
    }
    $name = strtolower($this
      ->randomMachineName());
    $displayName = $this
      ->getRandomGenerator()
      ->word(16);
    $callbackUrl = "http://example.com/{$this->randomMachineName()}";
    $description = trim($this
      ->getRandomGenerator()
      ->paragraphs(1));
    $data = [
      'name' => $name,
      'displayName[0][value]' => $displayName,
      'callbackUrl[0][value]' => $callbackUrl,
      'description[0][value]' => $description,
    ];
    if ($beforeCreate) {
      $data = $beforeCreate($data);
    }
    $this
      ->postCreateAppForm($data, $account);

    /** @var \Drupal\apigee_edge\Entity\Developer $developer */
    $developer = Developer::load($account
      ->getEmail());
    $app = $this
      ->loadDeveloperApp($name, $developer);
    $this
      ->assertSession()
      ->linkByHrefExists("/user/{$account->id()}/apps/{$app->getName()}/edit?destination=/user/{$account->id()}/apps");
    $this
      ->assertSession()
      ->linkByHrefExists("/user/{$account->id()}/apps/{$app->getName()}/delete?destination=/user/{$account->id()}/apps");
    $this
      ->clickLink($displayName);
    $this
      ->assertSession()
      ->pageTextContains($displayName);
    $this
      ->assertSession()
      ->pageTextContains($callbackUrl);
    $this
      ->assertSession()
      ->pageTextContains($description);
    if ($afterCreate) {
      $afterCreate($name);
    }

    /** @var \Drupal\apigee_edge\Entity\Storage\DeveloperAppStorageInterface $storage */
    $storage = \Drupal::entityTypeManager()
      ->getStorage('developer_app');

    /** @var \Drupal\apigee_edge\Entity\DeveloperApp $app */
    $app = $storage
      ->load(array_values($storage
      ->getQuery()
      ->condition('developerId', $developer
      ->uuid())
      ->condition('name', $name)
      ->execute())[0]);
    $this
      ->assertNotNull($app);

    /** @var \Apigee\Edge\Api\Management\Entity\AppCredential[] $credentials */
    $credentials = $app
      ->getCredentials();

    /** @var \Apigee\Edge\Api\Management\Entity\AppCredential $credential */
    $credential = reset($credentials);
    $credential_id = $credential
      ->id();
    $displayName = $this
      ->getRandomGenerator()
      ->word(16);
    $callbackUrl = "{$callbackUrl}/{$this->randomMachineName()}";
    $description = trim($this
      ->getRandomGenerator()
      ->paragraphs(1));
    $data = [
      'displayName[0][value]' => $displayName,
      'callbackUrl[0][value]' => $callbackUrl,
      'description[0][value]' => $description,
    ];
    if ($beforeUpdate) {
      $data = $beforeUpdate($data, $credential_id);
    }
    $this
      ->postEditAppForm($data, $name, $account);
    $this
      ->assertSession()
      ->pageTextContains($displayName);
    $this
      ->assertSession()
      ->pageTextContains($callbackUrl);
    $this
      ->assertSession()
      ->pageTextContains($description);
    if ($afterUpdate) {
      $afterUpdate($name);
    }
    $this
      ->clickLink('Delete');
    $this
      ->submitForm([
      'verification_code' => $name,
    ], 'Delete');
    $this
      ->drupalGet("/user/{$account->id()}/apps");
    $this
      ->assertSession()
      ->pageTextNotContains($displayName);
  }

  /**
   * Creates an app and assigns products to it.
   *
   * @param \Drupal\apigee_edge\Entity\ApiProductInterface[] $products
   *   API products associated with the developer app.
   * @param bool $multiple
   *   Allow submitting multiple products.
   * @param bool $display_as_select
   *   Display the products as a select box.
   */
  protected function assertAppCreationWithProduct(array $products = [], bool $multiple = TRUE, bool $display_as_select = FALSE) {
    $this
      ->submitAdminForm([
      'multiple_products' => $multiple,
      'display_as_select' => $display_as_select,
    ]);
    $name = strtolower($this
      ->randomMachineName());
    $productnum = count($products);
    $formdata = [
      'name' => $name,
      'displayName[0][value]' => $name,
    ];
    if (count($products) === 1) {
      $formdata['api_products'] = reset($products)
        ->getName();
    }
    elseif (count($products) > 1) {
      foreach ($products as $product) {
        $formdata["api_products[{$product->getName()}]"] = $product
          ->getName();
      }
    }
    $this
      ->postCreateAppForm($formdata);
    $app = $this
      ->assertDeveloperAppExists($name);
    if ($app) {

      /** @var \Apigee\Edge\Api\Management\Entity\AppCredential[] $credentials */
      $credentials = $app
        ->getCredentials();
      $this
        ->assertEquals(1, count($credentials), 'Exactly one credential exists.');
      $credential = reset($credentials);
      $apiproducts = $credential
        ->getApiProducts();
      $this
        ->assertEquals($productnum, count($apiproducts), "Exactly {$productnum} product is added.");
      $expected_products = array_map(function (ApiProduct $apiProduct) : string {
        return $apiProduct
          ->getName();
      }, $products);
      $retrieved_products = array_map(function (CredentialProduct $credentialProduct) : string {
        return $credentialProduct
          ->getApiproduct();
      }, $apiproducts);
      sort($expected_products);
      sort($retrieved_products);
      $this
        ->assertEquals($expected_products, $retrieved_products);
      $app
        ->delete();
    }
  }

  /**
   * Loads a developer app by name.
   *
   * @param string $name
   *   Name of the developer app.
   * @param \Drupal\apigee_edge\Entity\Developer $developer
   *   The developer the app belongs to.
   *
   * @return \Drupal\apigee_edge\Entity\DeveloperAppInterface|null
   *   Loaded developer app or null if not found.
   */
  protected function loadDeveloperApp(string $name, Developer $developer = NULL) : ?DeveloperAppInterface {

    /** @var \Drupal\apigee_edge\Entity\DeveloperApp[] $apps */
    if ($developer) {
      $storage = \Drupal::entityTypeManager()
        ->getStorage('developer_app');
      $results_ids = $storage
        ->getQuery()
        ->condition('developerId', $developer
        ->uuid())
        ->condition('name', $name)
        ->execute();
      return $results_ids ? $storage
        ->load(reset($results_ids)) : NULL;
    }
    else {
      $apps = DeveloperApp::loadMultiple();
      foreach ($apps as $app) {
        if ($app
          ->getName() === $name) {
          return $app;
        }
      }
    }
    return NULL;
  }

  /**
   * Gets breadcrumb links of the current page.
   *
   * @return \Behat\Mink\Element\NodeElement[]
   *   Array of breadcrumb links.
   */
  protected function getBreadcrumbLinks() : array {
    return $this
      ->xpath('//nav[@role="navigation"]/ol/li/a');
  }

}