class AddressDefaultWidgetTest in Address 8

Tests the default address widget.

@group address

Hierarchy

class \Drupal\Tests\BrowserTestBase extends \PHPUnit\Framework\TestCase uses FunctionalTestSetupTrait, TestSetupTrait, AssertLegacyTrait, BlockCreationTrait, ConfigTestTrait, ContentTypeCreationTrait, NodeCreationTrait, PhpunitCompatibilityTrait, RandomGeneratorTrait, TestRequirementsTrait, UiHelperTrait, UserCreationTrait, XdebugRequestTrait
- class \Drupal\FunctionalJavascriptTests\WebDriverTestBase
  - class \Drupal\Tests\address\FunctionalJavascript\AddressDefaultWidgetTest

Expanded class hierarchy of AddressDefaultWidgetTest

File

tests/src/FunctionalJavascript/AddressDefaultWidgetTest.php, line 17

Namespace

Drupal\Tests\address\FunctionalJavascript

View source

class AddressDefaultWidgetTest extends WebDriverTestBase {

  /**
   * Modules to enable.
   *
   * @var array
   */
  protected static $modules = [
    'system',
    'language',
    'user',
    'field',
    'field_ui',
    'node',
    'address',
  ];

  /**
   * {@inheritdoc}
   */
  protected $defaultTheme = 'stark';

  /**
   * User with permission to administer entities.
   *
   * @var \Drupal\user\UserInterface
   */
  protected $adminUser;

  /**
   * Address field instance.
   *
   * @var \Drupal\field\FieldConfigInterface
   */
  protected $field;

  /**
   * Entity form display.
   *
   * @var \Drupal\Core\Entity\Display\EntityFormDisplayInterface
   */
  protected $formDisplay;

  /**
   * URL to add new content.
   *
   * @var string
   */
  protected $nodeAddUrl;

  /**
   * URL to field's configuration form.
   *
   * @var string
   */
  protected $fieldConfigUrl;

  /**
   * The country repository.
   *
   * @var \CommerceGuys\Addressing\Country\CountryRepositoryInterface
   */
  protected $countryRepository;

  /**
   * The subdivision repository.
   *
   * @var \CommerceGuys\Addressing\Subdivision\SubdivisionRepositoryInterface
   */
  protected $subdivisionRepository;

  /**
   * The address format repository.
   *
   * @var \CommerceGuys\Addressing\AddressFormat\AddressFormatRepositoryInterface
   */
  protected $addressFormatRepository;

  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    parent::setUp();

    // Create node bundle for tests.
    $type = NodeType::create([
      'name' => 'Article',
      'type' => 'article',
    ]);
    $type
      ->save();

    // Create user that will be used for tests.
    $this->adminUser = $this
      ->createUser([
      'create article content',
      'edit own article content',
      'administer content types',
      'administer node fields',
    ]);
    $this
      ->drupalLogin($this->adminUser);

    // Add the address field to the article content type.
    $field_storage = FieldStorageConfig::create([
      'field_name' => 'field_address',
      'entity_type' => 'node',
      'type' => 'address',
    ]);
    $field_storage
      ->save();
    $this->field = FieldConfig::create([
      'field_storage' => $field_storage,
      'bundle' => 'article',
      'label' => 'Address',
      'default_value' => [
        [
          'country_code' => 'US',
        ],
      ],
    ]);
    $this->field
      ->save();

    // Set article's form display.
    $this->formDisplay = EntityFormDisplay::load('node.article.default');
    if (!$this->formDisplay) {
      EntityFormDisplay::create([
        'targetEntityType' => 'node',
        'bundle' => 'article',
        'mode' => 'default',
        'status' => TRUE,
      ])
        ->save();
      $this->formDisplay = EntityFormDisplay::load('node.article.default');
    }
    $this->formDisplay
      ->setComponent($this->field
      ->getName(), [
      'type' => 'address_default',
    ])
      ->save();
    $this->nodeAddUrl = 'node/add/article';
    $this->fieldConfigUrl = 'admin/structure/types/manage/article/fields/node.article.' . $this->field
      ->getName();
    $this->countryRepository = \Drupal::service('address.country_repository');
    $this->subdivisionRepository = \Drupal::service('address.subdivision_repository');
    $this->addressFormatRepository = \Drupal::service('address.address_format_repository');
  }

  /**
   * Tests the country field.
   *
   * Checked:
   * - required/optional status.
   * - available_countries instance setting.
   */
  public function testCountries() {
    $field_name = $this->field
      ->getName();

    // Optional field: Country should be optional and set to default_country.
    $this
      ->drupalGet($this->nodeAddUrl);
    $this
      ->assertEmpty((bool) $this
      ->xpath('//select[@name="' . $field_name . '[0][address][country_code]" and boolean(@required)]'), 'Country is shown as optional.');
    $this
      ->assertOptionSelected($field_name . '[0][address][country_code]', 'US', 'The configured default_country is selected.');

    // Required field: Country should be required and set to default_country.
    $this->field
      ->setRequired(TRUE);
    $this->field
      ->save();
    $this
      ->drupalGet($this->nodeAddUrl);
    $this
      ->assertNotEmpty((bool) $this
      ->xpath('//select[@name="' . $field_name . '[0][address][country_code]" and boolean(@required)]'), 'Country is shown as required.');
    $this
      ->assertOptionSelected($field_name . '[0][address][country_code]', 'US', 'The configured default_country is selected.');

    // All countries should be present in the form.
    $countries = array_keys($this->countryRepository
      ->getList());
    $this
      ->assertOptions($field_name . '[0][address][country_code]', $countries, 'All countries are present.');

    // Limit the list of available countries.
    $countries = [
      'US',
      'FR',
      'BR',
      'JP',
    ];
    $edit = [];
    $edit['settings[available_countries][]'] = array_map(function ($country) {
      return $country;
    }, $countries);
    $this
      ->drupalGet($this->fieldConfigUrl);
    $this
      ->submitForm($edit, t('Save settings'));
    $this
      ->drupalGet($this->nodeAddUrl);
    $this
      ->assertOptions($field_name . '[0][address][country_code]', $countries, 'The restricted list of available countries is present.');

    // Create an article with one of them.
    $country_code = 'US';
    $this
      ->getSession()
      ->getPage()
      ->fillField($field_name . '[0][address][country_code]', 'US');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $address = [
      'given_name' => 'John',
      'family_name' => 'Smith',
      'organization' => 'Some Organization',
      'address_line1' => '1098 Alta Ave',
      'locality' => 'Mountain View',
      'administrative_area' => 'CA',
      'postal_code' => '94043',
    ];
    $edit = [];
    $edit['title[0][value]'] = $this
      ->randomMachineName(8);
    foreach ($address as $property => $value) {
      $path = $field_name . '[0][address][' . $property . ']';
      $edit[$path] = $value;
    }
    $this
      ->submitForm($edit, t('Save'));

    // Check that the article has been created.
    $node = $this
      ->getNodeByTitle($edit['title[0][value]']);
    $this
      ->assertNotEmpty($node, 'Created article ' . $edit['title[0][value]']);

    // Now remove 'US' from the list of available countries.
    $countries = [
      'FR',
    ];
    $edit = [];
    $edit['settings[available_countries][]'] = array_map(function ($country) {
      return $country;
    }, $countries);
    $this
      ->drupalGet($this->fieldConfigUrl);
    $this
      ->submitForm($edit, 'Save settings');

    // Access the article's edit form and confirm the values are unchanged.
    // 'US' should be in the list along with the available countries and should
    // be selected.
    $this
      ->drupalGet('node/' . $node
      ->id() . '/edit');
    $this
      ->assertSession()
      ->fieldValueEquals($field_name . '[0][address][given_name]', $address['given_name']);
    $this
      ->assertSession()
      ->fieldValueEquals($field_name . '[0][address][family_name]', $address['family_name']);
    $this
      ->assertSession()
      ->fieldValueEquals($field_name . '[0][address][organization]', $address['organization']);
    $this
      ->assertSession()
      ->fieldValueEquals($field_name . '[0][address][address_line1]', $address['address_line1']);
    $this
      ->assertSession()
      ->fieldValueEquals($field_name . '[0][address][locality]', $address['locality']);
    $this
      ->assertOptionSelected($field_name . '[0][address][administrative_area]', $address['administrative_area']);
    $this
      ->assertSession()
      ->fieldValueEquals($field_name . '[0][address][postal_code]', $address['postal_code']);
    $this
      ->assertOptionSelected($field_name . '[0][address][country_code]', $country_code);

    // Confirm that it is possible to switch the country to France, and back.
    $this
      ->getSession()
      ->getPage()
      ->fillField($field_name . '[0][address][country_code]', 'FR');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $this
      ->assertSession()
      ->fieldNotExists($field_name . '[0][address][administrative_area]');
    $this
      ->getSession()
      ->getPage()
      ->fillField($field_name . '[0][address][country_code]', 'US');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $this
      ->assertSession()
      ->fieldExists($field_name . '[0][address][administrative_area]');

    // Test the widget with only one available country.
    // Since the field is required, the country selector should be hidden.
    $countries = [
      'US',
    ];
    $edit = [];
    $edit['settings[available_countries][]'] = array_map(function ($country) {
      return $country;
    }, $countries);
    $this
      ->drupalGet($this->fieldConfigUrl);
    $this
      ->submitForm($edit, 'Save settings');
    $this
      ->drupalGet('node/' . $node
      ->id() . '/edit');
    $this
      ->assertSession()
      ->fieldNotExists($field_name . '[0][address][country_code]');

    // Submitting the form should result in no data loss.
    $this
      ->submitForm([], t('Save'));
    $this
      ->drupalGet('node/' . $node
      ->id() . '/edit');
    $this
      ->assertSession()
      ->fieldValueEquals($field_name . '[0][address][given_name]', $address['given_name']);
    $this
      ->assertSession()
      ->fieldValueEquals($field_name . '[0][address][family_name]', $address['family_name']);
    $this
      ->assertSession()
      ->fieldValueEquals($field_name . '[0][address][organization]', $address['organization']);
    $this
      ->assertSession()
      ->fieldValueEquals($field_name . '[0][address][address_line1]', $address['address_line1']);
    $this
      ->assertSession()
      ->fieldValueEquals($field_name . '[0][address][locality]', $address['locality']);
    $this
      ->assertOptionSelected($field_name . '[0][address][administrative_area]', $address['administrative_area']);
    $this
      ->assertSession()
      ->fieldValueEquals($field_name . '[0][address][postal_code]', $address['postal_code']);
  }

  /**
   * Tests the default value functionality.
   */
  public function testDefaultValue() {
    $this
      ->drupalGet($this->fieldConfigUrl);

    // Confirm that the US is selected by default.
    $this
      ->assertSession()
      ->fieldValueEquals('default_value_input[field_address][0][address][country_code]', 'US');

    // Confirm that it is possible to switch the country to France.
    $this
      ->getSession()
      ->getPage()
      ->fillField('default_value_input[field_address][0][address][country_code]', 'FR');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $this
      ->assertSession()
      ->fieldNotExists('default_value_input[field_address][0][address][administrative_area]');

    // Confirm that it is possible to fill-in only certain fields.
    $edit = [
      'default_value_input[field_address][0][address][given_name]' => 'John',
      'default_value_input[field_address][0][address][family_name]' => 'Smith',
    ];
    $this
      ->submitForm($edit, t('Save settings'));
    $this
      ->assertSession()
      ->pageTextContains('Saved Address configuration.');
    $this->container
      ->get('entity_type.manager')
      ->getStorage('field_config')
      ->resetCache();
    $this->field = FieldConfig::load($this->field
      ->id());
    $default_value = $this->field
      ->getDefaultValueLiteral();
    $expected_default_value = [
      'country_code' => 'FR',
      'given_name' => 'John',
      'family_name' => 'Smith',
    ];
    $this
      ->assertCount(1, $default_value);
    $this
      ->assertEquals($expected_default_value, array_filter($default_value[0]));

    // Confirm that the default value is used on the node form.
    $this
      ->drupalGet($this->nodeAddUrl);
    $this
      ->assertSession()
      ->fieldValueEquals('field_address[0][address][country_code]', 'FR');
    $this
      ->assertSession()
      ->fieldValueEquals('field_address[0][address][given_name]', 'John');
    $this
      ->assertSession()
      ->fieldValueEquals('field_address[0][address][family_name]', 'Smith');
    $this
      ->assertSession()
      ->fieldValueEquals('field_address[0][address][postal_code]', '');
  }

  /**
   * Tests the alter events.
   */
  public function testEvents() {
    $field_name = $this->field
      ->getName();

    // The address_test module is installed here, not in setUp().
    // This way the module's events will not affect other tests.
    self::$modules[] = 'address_test';
    $this->container
      ->get('module_installer')
      ->install(self::$modules);
    $this->container = $this->kernel
      ->rebuildContainer();

    // Confirm that the list of available countries was altered.
    $subscriber = \Drupal::service('address_test.event_subscriber');
    $available_countries = array_keys($subscriber
      ->getAvailableCountries());
    $this
      ->drupalGet($this->nodeAddUrl);
    $this
      ->assertOptions($field_name . '[0][address][country_code]', $available_countries);

    // Confirm that counties for Great Britain were added.
    $expected_counties = [
      'Anglesey',
      'Blaenau Gwent',
      'Bridgend',
      'Caerphilly',
      'Cardiff',
      'Carmarthenshire',
      'Ceredigion',
      'Conwy',
      'Denbighshire',
      'Flintshire',
      'Gwynedd',
      'Merthyr Tydfil',
      'Monmouthshire',
      'Neath Port Talbot',
      'Newport',
      'Pembrokeshire',
      'Powys',
      'Rhondda Cynon Taf',
      'Swansea',
      'Tarfaen',
      'Vale of Glamorgan',
      'Wrexham',
    ];
    $this
      ->drupalGet($this->nodeAddUrl);
    $this
      ->getSession()
      ->getPage()
      ->fillField($field_name . '[0][address][country_code]', 'GB');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $this
      ->assertSession()
      ->pageTextContains(t('County'));
    $this
      ->assertSession()
      ->fieldExists($field_name . '[0][address][administrative_area]');
    $this
      ->assertOptions($field_name . '[0][address][administrative_area]', $expected_counties);

    // Uninstall and remove the address_test module.
    $this->container
      ->get('module_installer')
      ->uninstall([
      'address_test',
    ]);
    $this->container = $this->kernel
      ->rebuildContainer();
    array_pop(self::$modules);
  }

  /**
   * Tests expected and overridden fields.
   */
  public function testFields() {
    $field_name = $this->field
      ->getName();

    // Keys are field names from the field instance.
    // Values are corresponding field names from add article form.
    $all_fields = [
      'administrativeArea' => $field_name . '[0][address][administrative_area]',
      'locality' => $field_name . '[0][address][locality]',
      'dependentLocality' => $field_name . '[0][address][dependent_locality]',
      'postalCode' => $field_name . '[0][address][postal_code]',
      'sortingCode' => $field_name . '[0][address][sorting_code]',
      'addressLine1' => $field_name . '[0][address][address_line1]',
      'addressLine2' => $field_name . '[0][address][address_line2]',
      'organization' => $field_name . '[0][address][organization]',
      'givenName' => $field_name . '[0][address][given_name]',
      'familyName' => $field_name . '[0][address][family_name]',
    ];

    // US has all fields except sorting code and dependent locality.
    // France has sorting code, and China has dependent locality, so these
    // countries cover all fields.
    $this
      ->drupalGet($this->nodeAddUrl);
    foreach ([
      'US',
      'FR',
      'CN',
    ] as $country) {

      /** @var \CommerceGuys\Addressing\AddressFormat\AddressFormat $address_format */
      $address_format = $this->addressFormatRepository
        ->get($country);
      $used_fields = $address_format
        ->getUsedFields();
      $this
        ->getSession()
        ->getPage()
        ->fillField($field_name . '[0][address][country_code]', $country);
      $this
        ->assertSession()
        ->assertWaitOnAjaxRequest();

      // Compare the found fields to the address format.
      // Make one assert instead of many asserts for each field's existence.
      $elements = $this
        ->xpath('//input[starts-with(@name,"' . $field_name . '")] | //select[starts-with(@name,"' . $field_name . '")]');
      $form_fields = [];
      foreach ($elements as $element) {
        if ($field = array_search($element
          ->getAttribute('name'), $all_fields)) {
          $form_fields[] = $field;
        }
      }
      $this
        ->assertFieldValues($used_fields, $form_fields, 'Expected fields ' . implode(', ', $used_fields) . ' exists for country ' . $country . ", only found " . implode(', ', $form_fields));
    }

    // Test field overrides.
    $edit = [
      'settings[field_overrides][givenName][override]' => 'optional',
      'settings[field_overrides][familyName][override]' => 'optional',
      'settings[field_overrides][organization][override]' => 'required',
      'settings[field_overrides][postalCode][override]' => 'hidden',
    ];
    $this
      ->drupalGet($this->fieldConfigUrl);
    $this
      ->submitForm($edit, t('Save settings'));
    $this
      ->drupalGet($this->nodeAddUrl);
    $this
      ->assertEmpty((bool) $this
      ->xpath('//input[@name="field_address[0][address][given_name]" and contains(@required, "required")]'));
    $this
      ->assertEmpty((bool) $this
      ->xpath('//input[@name="field_address[0][address][family_name]" and contains(@required, "required")]'));
    $this
      ->assertNotEmpty((bool) $this
      ->xpath('//input[@name="field_address[0][address][organization]" and contains(@required, "required")]'));
    $this
      ->assertEmpty((bool) $this
      ->xpath('//input[@name="field_address[0][address][postal_code]"]'));

    // Test creating an address without the optional and hidden fields.
    $edit = [];
    $edit['title[0][value]'] = $this
      ->randomMachineName(8);

    // Use javascript to fill country_code so other fields can be loaded.
    $this
      ->getSession()
      ->getPage()
      ->fillField($field_name . '[0][address][country_code]', 'US');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $edit[$field_name . '[0][address][organization]'] = 'Some Organization';
    $edit[$field_name . '[0][address][address_line1]'] = '1098 Alta Ave';
    $edit[$field_name . '[0][address][address_line2]'] = 'Street 2';
    $edit[$field_name . '[0][address][locality]'] = 'Mountain View';
    $edit[$field_name . '[0][address][administrative_area]'] = 'CA';
    $this
      ->submitForm($edit, t('Save'));
    $node = $this
      ->getNodeByTitle($edit['title[0][value]']);
    $this
      ->assertNotEmpty($node, 'Created article ' . $edit['title[0][value]']);
  }

  /**
   * Tests the presence of subdivision dropdowns where expected.
   */
  public function testSubdivisions() {
    $field_name = $this->field
      ->getName();

    // Using China since it has predefined subdivisions on all three levels.
    $country = 'CN';
    $administrative_area = 'Hebei Sheng';
    $locality = 'Chengde Shi';
    $administrative_areas = $this->subdivisionRepository
      ->getList([
      $country,
    ]);
    $localities = $this->subdivisionRepository
      ->getList([
      $country,
      $administrative_area,
    ]);
    $dependent_localities = $this->subdivisionRepository
      ->getList([
      $country,
      $administrative_area,
      $locality,
    ]);

    // Confirm the presence and format of the administrative area dropdown.
    $this
      ->drupalGet($this->nodeAddUrl);
    $this
      ->getSession()
      ->getPage()
      ->fillField($field_name . '[0][address][country_code]', $country);
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $this
      ->assertOptions($field_name . '[0][address][administrative_area]', array_keys($administrative_areas), 'All administrative areas for country ' . $country . ' are present.');

    // Confirm the presence and format of the locality dropdown.
    $this
      ->getSession()
      ->getPage()
      ->fillField($field_name . '[0][address][administrative_area]', $administrative_area);
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $this
      ->assertOptionSelected($field_name . '[0][address][administrative_area]', $administrative_area, 'Selected administrative area ' . $administrative_areas[$administrative_area]);
    $this
      ->assertOptions($field_name . '[0][address][locality]', array_keys($localities), 'All localities for administrative area ' . $administrative_areas[$administrative_area] . ' are present.');

    // Confirm the presence and format of the dependent locality dropdown.
    $this
      ->getSession()
      ->getPage()
      ->fillField($field_name . '[0][address][locality]', $locality);
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $this
      ->assertOptionSelected($field_name . '[0][address][locality]', $locality, 'Selected locality ' . $localities[$locality]);
    $this
      ->assertOptions($field_name . '[0][address][dependent_locality]', array_keys($dependent_localities), 'All dependent localities for locality ' . $localities[$locality] . ' are present.');
  }

  /**
   * Tests that changing the country clears the expected values.
   */
  public function testClearValues() {
    $field_name = $this->field
      ->getName();

    // Create an article with all fields filled.
    $this
      ->drupalGet($this->nodeAddUrl);
    $edit = [];
    $edit['title[0][value]'] = $this
      ->randomMachineName(8);

    // Use javascript to fill country_code so other fields can be loaded.
    $this
      ->getSession()
      ->getPage()
      ->fillField($field_name . '[0][address][country_code]', 'US');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $edit[$field_name . '[0][address][given_name]'] = 'John';
    $edit[$field_name . '[0][address][family_name]'] = 'Smith';
    $edit[$field_name . '[0][address][organization]'] = 'Some Organization';
    $edit[$field_name . '[0][address][address_line1]'] = '1098 Alta Ave';
    $edit[$field_name . '[0][address][address_line2]'] = 'Street 2';
    $edit[$field_name . '[0][address][locality]'] = 'Mountain View';
    $edit[$field_name . '[0][address][administrative_area]'] = 'CA';
    $edit[$field_name . '[0][address][postal_code]'] = '94043';
    $this
      ->submitForm($edit, t('Save'));
    $node = $this
      ->getNodeByTitle($edit['title[0][value]']);
    $this
      ->drupalGet('node/' . $node
      ->id() . '/edit');
    $this
      ->assertSession()
      ->fieldValueEquals($field_name . '[0][address][country_code]', 'US');
    $this
      ->assertSession()
      ->fieldValueEquals($field_name . '[0][address][administrative_area]', 'CA');
    $this
      ->assertSession()
      ->fieldValueEquals($field_name . '[0][address][locality]', 'Mountain View');
    $this
      ->assertSession()
      ->fieldValueEquals($field_name . '[0][address][postal_code]', '94043');

    // Now change the country to China, subdivision fields should be cleared.
    $this
      ->drupalGet('node/' . $node
      ->id() . '/edit');
    $this
      ->getSession()
      ->getPage()
      ->fillField($field_name . '[0][address][country_code]', 'CN');
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
    $this
      ->submitForm([], t('Save'));

    // Check that values are cleared.
    $this
      ->assertSession()
      ->fieldValueEquals($field_name . '[0][address][country_code]', 'CN');
    $this
      ->assertSession()
      ->fieldValueEquals($field_name . '[0][address][administrative_area]', '');
    $this
      ->assertSession()
      ->fieldValueEquals($field_name . '[0][address][locality]', '');
    $this
      ->assertSession()
      ->fieldValueEquals($field_name . '[0][address][dependent_locality]', '');
    $this
      ->assertSession()
      ->fieldValueEquals($field_name . '[0][address][postal_code]', '');
  }

  /**
   * Asserts that a select field has all of the provided options.
   *
   * Core only has assertOption(), this helper decreases the number of needed
   * assertions.
   *
   * @param string $id
   *   ID of select field to assert.
   * @param array $options
   *   Options to assert.
   * @param string $message
   *   (optional) A message to display with the assertion. Do not translate
   *   messages: use \Drupal\Component\Utility\SafeMarkup::format() to embed
   *   variables in the message text, not t(). If left blank, a default message
   *   will be displayed.
   */
  protected function assertOptions($id, array $options, $message = '') {
    $elements = $this
      ->xpath('//select[@name="' . $id . '"]/option');
    $found_options = [];
    foreach ($elements as $element) {
      if ($option = $element
        ->getValue()) {
        $found_options[] = $option;
      }
    }
    $this
      ->assertFieldValues($found_options, $options, $message);
  }

  /**
   * Asserts that a select field has a selected option.
   *
   * @param string $id
   *   ID of select field to assert.
   * @param string $option
   *   Option to assert.
   * @param string $message
   *   (optional) A message to display with the assertion. Do not translate
   *   messages: use \Drupal\Component\Utility\SafeMarkup::format() to embed
   *   variables in the message text, not t(). If left blank, a default message
   *   will be displayed.
   */
  protected function assertOptionSelected($id, $option, $message = '') {
    $elements = $this
      ->xpath('//select[@name=:id]//option[@value=:option]', [
      ':id' => $id,
      ':option' => $option,
    ]);
    foreach ($elements as $element) {
      $this
        ->assertNotEmpty($element
        ->isSelected(), $message ? $message : new FormattableMarkup('Option @option for field @id is selected.', [
        '@option' => $option,
        '@id' => $id,
      ]));
    }
  }

  /**
   * Asserts that the passed field values are correct.
   *
   * Ignores differences in ordering.
   *
   * @param array $field_values
   *   The field values.
   * @param array $expected_values
   *   The expected values.
   * @param string $message
   *   (optional) A message to display with the assertion. Do not translate
   *   messages: use \Drupal\Component\Utility\SafeMarkup::format() to embed
   *   variables in the message text, not t(). If left blank, a default message
   *   will be displayed.
   */
  protected function assertFieldValues(array $field_values, array $expected_values, $message = '') {
    $valid = TRUE;
    if (count($field_values) == count($expected_values)) {
      foreach ($expected_values as $value) {
        if (!in_array($value, $field_values)) {
          $valid = FALSE;
          break;
        }
      }
    }
    else {
      $valid = FALSE;
    }
    $this
      ->assertTrue($valid, $message);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AddressDefaultWidgetTest::$addressFormatRepository	protected	property	The address format repository.
AddressDefaultWidgetTest::$adminUser	protected	property	User with permission to administer entities.
AddressDefaultWidgetTest::$countryRepository	protected	property	The country repository.
AddressDefaultWidgetTest::$defaultTheme	protected	property	The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
AddressDefaultWidgetTest::$field	protected	property	Address field instance.
AddressDefaultWidgetTest::$fieldConfigUrl	protected	property	URL to field's configuration form.
AddressDefaultWidgetTest::$formDisplay	protected	property	Entity form display.
AddressDefaultWidgetTest::$modules	protected static	property	Modules to enable. Overrides BrowserTestBase::$modules
AddressDefaultWidgetTest::$nodeAddUrl	protected	property	URL to add new content.
AddressDefaultWidgetTest::$subdivisionRepository	protected	property	The subdivision repository.
AddressDefaultWidgetTest::assertFieldValues	protected	function	Asserts that the passed field values are correct.
AddressDefaultWidgetTest::assertOptions	protected	function	Asserts that a select field has all of the provided options.
AddressDefaultWidgetTest::assertOptionSelected	protected	function	Asserts that a select field has a selected option. Overrides AssertLegacyTrait::assertOptionSelected
AddressDefaultWidgetTest::setUp	protected	function	Overrides BrowserTestBase::setUp
AddressDefaultWidgetTest::testClearValues	public	function	Tests that changing the country clears the expected values.
AddressDefaultWidgetTest::testCountries	public	function	Tests the country field.
AddressDefaultWidgetTest::testDefaultValue	public	function	Tests the default value functionality.
AddressDefaultWidgetTest::testEvents	public	function	Tests the alter events.
AddressDefaultWidgetTest::testFields	public	function	Tests expected and overridden fields.
AddressDefaultWidgetTest::testSubdivisions	public	function	Tests the presence of subdivision dropdowns where expected.
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::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::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::$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::getHttpClient	protected	function	Obtain the HTTP client for the system under test.
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::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
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::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::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.
WebDriverTestBase::$disableCssAnimations	protected	property	Disables CSS animations in tests for more reliable testing.
WebDriverTestBase::$minkDefaultDriverClass	protected	property	To use a legacy phantomjs based approach, please use PhantomJSDriver::class. Overrides BrowserTestBase::$minkDefaultDriverClass	2
WebDriverTestBase::assertElementNotVisible Deprecated	protected	function	Asserts that the element with the given CSS selector is not visible.
WebDriverTestBase::assertElementVisible Deprecated	protected	function	Asserts that the element with the given CSS selector is visible.
WebDriverTestBase::assertJsCondition	protected	function	Waits for the given time or until the given JS condition becomes TRUE.
WebDriverTestBase::assertSession	public	function	Returns WebAssert object. Overrides UiHelperTrait::assertSession	1
WebDriverTestBase::createScreenshot	protected	function	Creates a screenshot.
WebDriverTestBase::getDrupalSettings	protected	function	Gets the current Drupal javascript settings and parses into an array. Overrides BrowserTestBase::getDrupalSettings
WebDriverTestBase::getHtmlOutputHeaders	protected	function	Returns headers in HTML output format. Overrides BrowserHtmlDebugTrait::getHtmlOutputHeaders
WebDriverTestBase::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. Overrides BrowserTestBase::getMinkDriverArgs
WebDriverTestBase::initFrontPage	protected	function	Visits the front page when initializing Mink. Overrides BrowserTestBase::initFrontPage
WebDriverTestBase::initMink	protected	function	Initializes Mink sessions. Overrides BrowserTestBase::initMink	1
WebDriverTestBase::installModulesFromClassProperty	protected	function	Install modules defined by `static::$modules`. Overrides FunctionalTestSetupTrait::installModulesFromClassProperty
WebDriverTestBase::tearDown	protected	function	Overrides BrowserTestBase::tearDown	1
XdebugRequestTrait::extractCookiesFromRequest	protected	function	Adds xdebug cookies, from request setup.

You are here

class AddressDefaultWidgetTest in Address 8

Hierarchy

File

Namespace

Members

API Navigation