CountryTest.php in Ubercart 8.4

Namespace

Drupal\Tests\uc_country\Functional

File

uc_country/tests/src/Functional/CountryTest.php

<?php

namespace Drupal\Tests\uc_country\Functional;

use Drupal\Tests\BrowserTestBase;

/**
 * Import, edit, and remove countries and their settings.
 *
 * @group ubercart
 */
class CountryTest extends BrowserTestBase {

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

  /**
   * Test enable/disable of countries.
   */
  public function testCountryUi() {

    /** @var \Drupal\Tests\WebAssert $assert */
    $assert = $this
      ->assertSession();
    $this
      ->drupalLogin($this
      ->drupalCreateUser([
      'administer countries',
      'administer store',
    ]));

    // Testing all countries is too much, so we just enable a random selection
    // of 8 countries. All countries will then be tested at some point.
    $countries = \Drupal::service('country_manager')
      ->getAvailableList();
    $country_ids = array_rand($countries, 8);
    $last_country = array_pop($country_ids);

    // Loop over the first seven.
    foreach ($country_ids as $country_id) {

      // Verify this country isn't already enabled.
      $this
        ->drupalGet('admin/store/config/country');
      $assert
        ->linkByHrefExists('admin/store/config/country/' . $country_id . '/enable', 0, format_string('%country is not enabled by default.', [
        '%country' => $countries[$country_id],
      ]));

      // Enable this country.
      $this
        ->clickLinkInRow($countries[$country_id], 'Enable');
      $assert
        ->pageTextContains('The country ' . $countries[$country_id] . ' has been enabled.');
      $assert
        ->linkByHrefExists('admin/store/config/country/' . $country_id . '/disable', 0, format_string('%country is now enabled.', [
        '%country' => $countries[$country_id],
      ]));
    }

    // Verify that last random country doesn't show up as available.
    $this
      ->drupalGet('admin/store/config/store');

    // Test that $countries[$last_country] is not listed in uc_address
    // select country field.
    $assert
      ->optionNotExists('edit-address-country', $last_country);

    // Enable the last country.
    $this
      ->drupalGet('admin/store/config/country');
    $this
      ->clickLinkInRow($countries[$last_country], 'Enable');
    $assert
      ->pageTextContains('The country ' . $countries[$last_country] . ' has been enabled.');
    $assert
      ->linkByHrefExists('admin/store/config/country/' . $last_country . '/disable', 0, format_string('%country is now enabled.', [
      '%country' => $countries[$last_country],
    ]));

    // Verify that last random country now shows up as available.
    $this
      ->drupalGet('admin/store/config/store');

    // Test that $countries[$last_country] now IS listed in uc_address
    // select country field.
    $assert
      ->optionExists('edit-address-country', $last_country);

    // Disable the last country using the operations button.
    $this
      ->drupalGet('admin/store/config/country');

    // Click the 8th Disable link.
    $this
      ->clickLink('Disable', 7);
    $assert
      ->pageTextContains('The country ' . $countries[$last_country] . ' has been disabled.');
    $assert
      ->linkByHrefExists('admin/store/config/country/' . $last_country . '/enable', 0, format_string('%country is now disabled.', [
      '%country' => $countries[$last_country],
    ]));
  }

  /**
   * Test functionality with all countries disabled.
   */
  public function testAllDisabled() {

    /** @var \Drupal\Tests\WebAssert $assert */
    $assert = $this
      ->assertSession();
    $this
      ->drupalLogin($this
      ->drupalCreateUser([
      'administer countries',
      'administer store',
      'access administration pages',
    ]));

    // Disable all countries.
    $manager = \Drupal::service('country_manager');
    $countries = $manager
      ->getEnabledList();
    foreach (array_keys($countries) as $code) {
      $manager
        ->getCountry($code)
        ->disable()
        ->save();
    }

    // Verify that an error is shown.
    $this
      ->drupalGet('admin/store');
    $assert
      ->pageTextContains('No countries are enabled.');

    // Verify that the country fields are hidden.
    $this
      ->drupalGet('admin/store/config/store');
    $assert
      ->pageTextNotContains('State/Province');
    $assert
      ->pageTextNotContains('Country');
  }

  /**
   * Follows a link in the same table row as the label text.
   *
   * @param string $label
   *   The label to find in a table column.
   * @param string $link
   *   The link text to find in the same table row.
   *
   * @return bool|string
   *   Page contents on success, or FALSE on failure.
   */
  protected function clickLinkInRow($label, $link) {
    return $this
      ->clickLinkHelper($label, 0, '//td[normalize-space()=:label]/ancestor::tr[1]//a[normalize-space()="' . $link . '"]');
  }

  /**
   * Provides a helper for ::clickLinkInRow().
   *
   * @param string|\Drupal\Component\Render\MarkupInterface $label
   *   Text between the anchor tags, uses starts-with().
   * @param int $index
   *   Link position counting from zero.
   * @param string $pattern
   *   A pattern to use for the XPath.
   *
   * @return bool|string
   *   Page contents on success, or FALSE on failure.
   */
  protected function clickLinkHelper($label, $index, $pattern) {

    // Cast MarkupInterface objects to string.
    $label = (string) $label;
    $url_before = $this
      ->getUrl();
    $urls = $this
      ->xpath($pattern, [
      ':label' => $label,
    ]);
    if (isset($urls[$index])) {
      $url_target = $this
        ->getAbsoluteUrl($urls[$index]
        ->getAttribute('href'));
      $this
        ->assertTrue(TRUE, format_string('Clicked link %label (@url_target) from @url_before', [
        '%label' => $label,
        '@url_target' => $url_target,
        '@url_before' => $url_before,
      ]), 'Browser');
      return $this
        ->drupalGet($url_target);
    }
    $this
      ->fail(format_string('Link %label does not exist on @url_before', [
      '%label' => $label,
      '@url_before' => $url_before,
    ]), 'Browser');
    return FALSE;
  }

}

Classes

Name	Description
CountryTest	Import, edit, and remove countries and their settings.