class AddressDisplayTest in Address Display 8

Tests the address_display_formatter formatter.

@group address_display

Hierarchy

class \Drupal\KernelTests\KernelTestBase extends \PHPUnit\Framework\TestCase implements ServiceProviderInterface uses AssertContentTrait, AssertLegacyTrait, AssertHelperTrait, ConfigTestTrait, PhpunitCompatibilityTrait, RandomGeneratorTrait, TestRequirementsTrait
- class \Drupal\Tests\address_display\Kernel\Formatter\AddressDisplayTest

Expanded class hierarchy of AddressDisplayTest

File

tests/src/Kernel/Formatter/AddressDisplayTest.php, line 15

Namespace

Drupal\Tests\address_display\Kernel\Formatter

View source

class AddressDisplayTest extends KernelTestBase {

  /**
   * Disable strict config schema.
   *
   * @var bool
   */
  protected $strictConfigSchema = FALSE;

  /**
   * {@inheritdoc}
   */
  protected static $modules = [
    'system',
    'field',
    'text',
    'entity_test',
    'user',
    'address',
    'address_display',
  ];

  /**
   * The tested field name.
   *
   * @var string
   */
  protected $fieldName;

  /**
   * The entity display.
   *
   * @var \Drupal\Core\Entity\Display\EntityViewDisplayInterface
   */
  protected $display;

  /**
   * The entity to test.
   *
   * @var \Drupal\entity_test\Entity\EntityTest
   */
  protected $entity;

  /**
   * The default display settings to use for the formatters.
   *
   * @var array
   */
  protected $defaultDisplaySettings = [
    'address_display' => [
      'organization' => [
        'display' => TRUE,
        'glue' => '',
        'weight' => -1,
      ],
      'address_line1' => [
        'display' => TRUE,
        'glue' => '',
        'weight' => 0,
      ],
      'address_line2' => [
        'display' => TRUE,
        'glue' => ',',
        'weight' => 1,
      ],
      'locality' => [
        'display' => TRUE,
        'glue' => ',',
        'weight' => 2,
      ],
      'postal_code' => [
        'display' => TRUE,
        'glue' => '',
        'weight' => 3,
      ],
      'country_code' => [
        'display' => TRUE,
        'glue' => '',
        'weight' => 4,
      ],
      'langcode' => [
        'display' => FALSE,
        'glue' => ',',
        'weight' => 100,
      ],
      'administrative_area' => [
        'display' => FALSE,
        'glue' => ',',
        'weight' => 100,
      ],
      'dependent_locality' => [
        'display' => FALSE,
        'glue' => ',',
        'weight' => 100,
      ],
      'sorting_code' => [
        'display' => FALSE,
        'glue' => ',',
        'weight' => 100,
      ],
      'given_name' => [
        'display' => TRUE,
        'glue' => '',
        'weight' => 100,
      ],
      'family_name' => [
        'display' => TRUE,
        'glue' => ',',
        'weight' => 100,
      ],
    ],
  ];

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();
    $this
      ->installConfig([
      'system',
    ]);
    $this
      ->installConfig([
      'field',
    ]);
    $this
      ->installConfig([
      'text',
    ]);
    $this
      ->installConfig([
      'address',
    ]);
    $this
      ->installConfig([
      'entity_test',
    ]);
    $this
      ->installEntitySchema('entity_test');
    $this->fieldName = mb_strtolower($this
      ->randomMachineName());

    // Create an entity_test field of the 'address' type.
    $field_storage = FieldStorageConfig::create([
      'field_name' => $this->fieldName,
      'entity_type' => 'entity_test',
      'type' => 'address',
    ]);
    $field_storage
      ->save();
    $field_config = FieldConfig::create([
      'field_storage' => $field_storage,
      'bundle' => 'entity_test',
      'label' => $this
        ->randomMachineName(),
    ]);
    $field_config
      ->save();

    // The entity_get_display() procedural function is deprecated in
    // drupal:8.8.0 and above.
    if (version_compare(\Drupal::VERSION, '8.8', '<')) {
      $this->display = \Drupal::service('entity_display.repository')
        ->getViewDisplay('entity_test', 'entity_test', 'default');
    }
    else {
      $this->display = \Drupal::service('entity_display.repository')
        ->getViewDisplay('entity_test', 'entity_test', 'default');
    }
    $this->entity = EntityTest::create([]);
    $this->entity->{$this->fieldName} = [
      'organization' => 'Test company',
      'country_code' => 'PL',
      'locality' => 'Kraków',
      'postal_code' => '31-042',
      'address_line1' => 'Rynek Główny 1/3',
      'given_name' => 'Jan',
      'family_name' => 'Nowak',
    ];
  }

  /**
   * Tests rendering of address components.
   */
  public function testRenderAddressComponents() {

    // Tests default settings.
    $this->display
      ->setComponent($this->fieldName, [
      'type' => 'address_display_formatter',
      'settings' => [],
    ]);
    $this->display
      ->save();

    // Render entity fields.
    $content = $this->display
      ->build($this->entity);
    $this
      ->render($content);
    $expected = implode("\n", [
      '<span class="address-display-element organization-element">Test company</span>',
      '<span class="address-display-element address-line1-element">Rynek Główny 1/3</span>',
      '<span class="address-display-element locality-element">Kraków,</span>',
      '<span class="address-display-element postal-code-element">31-042</span>',
      '<span class="address-display-element country-code-element">Poland</span>',
      '<span class="address-display-element given-name-element">Jan</span>',
      '<span class="address-display-element family-name-element">Nowak</span>',
    ]);
    $this
      ->assertRaw($expected);

    // Tests 'display' option.
    $settings = $this->defaultDisplaySettings;
    $settings['address_display']['country_code']['display'] = FALSE;
    $settings['address_display']['given_name']['display'] = FALSE;
    $settings['address_display']['family_name']['display'] = FALSE;
    $this->display
      ->setComponent($this->fieldName, [
      'type' => 'address_display_formatter',
      'settings' => $settings,
    ]);
    $this->display
      ->save();

    // Render entity fields.
    $content = $this->display
      ->build($this->entity);
    $this
      ->render($content);
    $expected = implode("\n", [
      '<span class="address-display-element organization-element">Test company</span>',
      '<span class="address-display-element address-line1-element">Rynek Główny 1/3</span>',
      '<span class="address-display-element locality-element">Kraków,</span>',
      '<span class="address-display-element postal-code-element">31-042</span>',
    ]);
    $this
      ->assertRaw($expected);

    // Skip hidden items.
    $this
      ->assertNoRaw('<span class="address-display-element country-code-element">Poland</span>');
    $this
      ->assertNoRaw('<span class="address-display-element given-name-element">Jan</span>');
    $this
      ->assertNoRaw('<span class="address-display-element family-name-element">Nowak</span>');

    // Tests 'glue' option.
    $settings = $this->defaultDisplaySettings;
    $settings['address_display']['organization']['glue'] = ':';
    $settings['address_display']['locality']['glue'] = '';
    $settings['address_display']['family_name']['glue'] = ',';
    $this->display
      ->setComponent($this->fieldName, [
      'type' => 'address_display_formatter',
      'settings' => $settings,
    ]);
    $this->display
      ->save();

    // Render entity fields.
    $content = $this->display
      ->build($this->entity);
    $this
      ->render($content);
    $expected = implode("\n", [
      '<span class="address-display-element organization-element">Test company:</span>',
      '<span class="address-display-element address-line1-element">Rynek Główny 1/3</span>',
      '<span class="address-display-element locality-element">Kraków</span>',
      '<span class="address-display-element postal-code-element">31-042</span>',
      '<span class="address-display-element country-code-element">Poland</span>',
      '<span class="address-display-element given-name-element">Jan</span>',
      // Don't display the last item separator.
      '<span class="address-display-element family-name-element">Nowak</span>',
    ]);
    $this
      ->assertRaw($expected);
  }

  /**
   * Tests displaying a single component.
   */
  public function testSingleAddressComponent() {

    // Display only organization name.
    $settings = [
      'address_display' => [
        'organization' => [
          'display' => TRUE,
          'glue' => 'glue',
          'weight' => 0,
        ],
        'address_line1' => [
          'display' => FALSE,
          'glue' => '',
          'weight' => 0,
        ],
      ],
    ];
    $this->display
      ->setComponent($this->fieldName, [
      'type' => 'address_display_formatter',
      'settings' => $settings,
    ]);
    $this->display
      ->save();
    $content = $this->display
      ->build($this->entity);
    $this
      ->render($content);

    // Ensure that 'display' option works.
    $this
      ->assertRaw('<span class="address-display-element organization-element">');
    $this
      ->assertNoRaw('<span class="address-display-element address-line1-element">');

    // A single component should not contain a leading separator.
    $this
      ->assertRaw('<span class="address-display-element organization-element">Test company</span>');

    // Ensure that empty element is hidden.
    $this->entity->{$this->fieldName}->organization = '';
    $content = $this->display
      ->build($this->entity);
    $this
      ->render($content);
    $this
      ->assertNoRaw('<span class="address-display-element organization-element">');
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AddressDisplayTest::$defaultDisplaySettings	protected	property	The default display settings to use for the formatters.
AddressDisplayTest::$display	protected	property	The entity display.
AddressDisplayTest::$entity	protected	property	The entity to test.
AddressDisplayTest::$fieldName	protected	property	The tested field name.
AddressDisplayTest::$modules	protected static	property	Modules to enable. Overrides KernelTestBase::$modules
AddressDisplayTest::$strictConfigSchema	protected	property	Disable strict config schema. Overrides KernelTestBase::$strictConfigSchema
AddressDisplayTest::setUp	protected	function	Overrides KernelTestBase::setUp
AddressDisplayTest::testRenderAddressComponents	public	function	Tests rendering of address components.
AddressDisplayTest::testSingleAddressComponent	public	function	Tests displaying a single component.
AssertContentTrait::$content	protected	property	The current raw content.
AssertContentTrait::$drupalSettings	protected	property	The drupalSettings value from the current raw $content.
AssertContentTrait::$elements	protected	property	The XML structure parsed from the current raw $content.	1
AssertContentTrait::$plainTextContent	protected	property	The plain-text content of raw $content (text nodes).
AssertContentTrait::assertEscaped	protected	function	Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertField	protected	function	Asserts that a field exists with the given name or ID.
AssertContentTrait::assertFieldById	protected	function	Asserts that a field exists with the given ID and value.
AssertContentTrait::assertFieldByName	protected	function	Asserts that a field exists with the given name and value.
AssertContentTrait::assertFieldByXPath	protected	function	Asserts that a field exists in the current page by the given XPath.
AssertContentTrait::assertFieldChecked	protected	function	Asserts that a checkbox field in the current page is checked.
AssertContentTrait::assertFieldsByValue	protected	function	Asserts that a field exists in the current page with a given Xpath result.
AssertContentTrait::assertLink	protected	function	Passes if a link with the specified label is found.
AssertContentTrait::assertLinkByHref	protected	function	Passes if a link containing a given href (part) is found.
AssertContentTrait::assertNoDuplicateIds	protected	function	Asserts that each HTML ID is used for just a single element.
AssertContentTrait::assertNoEscaped	protected	function	Passes if the raw text IS NOT found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertNoField	protected	function	Asserts that a field does not exist with the given name or ID.
AssertContentTrait::assertNoFieldById	protected	function	Asserts that a field does not exist with the given ID and value.
AssertContentTrait::assertNoFieldByName	protected	function	Asserts that a field does not exist with the given name and value.
AssertContentTrait::assertNoFieldByXPath	protected	function	Asserts that a field does not exist or its value does not match, by XPath.
AssertContentTrait::assertNoFieldChecked	protected	function	Asserts that a checkbox field in the current page is not checked.
AssertContentTrait::assertNoLink	protected	function	Passes if a link with the specified label is not found.
AssertContentTrait::assertNoLinkByHref	protected	function	Passes if a link containing a given href (part) is not found.
AssertContentTrait::assertNoLinkByHrefInMainRegion	protected	function	Passes if a link containing a given href is not found in the main region.
AssertContentTrait::assertNoOption	protected	function	Asserts that a select option in the current page does not exist.
AssertContentTrait::assertNoOptionSelected	protected	function	Asserts that a select option in the current page is not checked.
AssertContentTrait::assertNoPattern	protected	function	Triggers a pass if the perl regex pattern is not found in raw content.
AssertContentTrait::assertNoRaw	protected	function	Passes if the raw text is NOT found on the loaded page, fail otherwise.
AssertContentTrait::assertNoText	protected	function	Passes if the page (with HTML stripped) does not contains the text.
AssertContentTrait::assertNoTitle	protected	function	Pass if the page title is not the given string.
AssertContentTrait::assertNoUniqueText	protected	function	Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertContentTrait::assertOption	protected	function	Asserts that a select option in the current page exists.
AssertContentTrait::assertOptionByText	protected	function	Asserts that a select option with the visible text exists.
AssertContentTrait::assertOptionSelected	protected	function	Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionSelectedWithDrupalSelector	protected	function	Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionWithDrupalSelector	protected	function	Asserts that a select option in the current page exists.
AssertContentTrait::assertPattern	protected	function	Triggers a pass if the Perl regex pattern is found in the raw content.
AssertContentTrait::assertRaw	protected	function	Passes if the raw text IS found on the loaded page, fail otherwise.
AssertContentTrait::assertText	protected	function	Passes if the page (with HTML stripped) contains the text.
AssertContentTrait::assertTextHelper	protected	function	Helper for assertText and assertNoText.
AssertContentTrait::assertTextPattern	protected	function	Asserts that a Perl regex pattern is found in the plain-text content.
AssertContentTrait::assertThemeOutput	protected	function	Asserts themed output.
AssertContentTrait::assertTitle	protected	function	Pass if the page title is the given string.
AssertContentTrait::assertUniqueText	protected	function	Passes if the text is found ONLY ONCE on the text version of the page.
AssertContentTrait::assertUniqueTextHelper	protected	function	Helper for assertUniqueText and assertNoUniqueText.
AssertContentTrait::buildXPathQuery	protected	function	Builds an XPath query.
AssertContentTrait::constructFieldXpath	protected	function	Helper: Constructs an XPath for the given set of attributes and value.
AssertContentTrait::cssSelect	protected	function	Searches elements using a CSS selector in the raw content.
AssertContentTrait::getAllOptions	protected	function	Get all option elements, including nested options, in a select.
AssertContentTrait::getDrupalSettings	protected	function	Gets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::getRawContent	protected	function	Gets the current raw content.
AssertContentTrait::getSelectedItem	protected	function	Get the selected value from a select field.
AssertContentTrait::getTextContent	protected	function	Retrieves the plain-text content from the current raw content.
AssertContentTrait::getUrl	protected	function	Get the current URL from the cURL handler.	1
AssertContentTrait::parse	protected	function	Parse content returned from curlExec using DOM and SimpleXML.
AssertContentTrait::removeWhiteSpace	protected	function	Removes all white-space between HTML tags from the raw content.
AssertContentTrait::setDrupalSettings	protected	function	Sets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::setRawContent	protected	function	Sets the raw content (e.g. HTML).
AssertContentTrait::xpath	protected	function	Performs an xpath search on the contents of the internal browser.
AssertHelperTrait::castSafeStrings	protected static	function	Casts MarkupInterface objects into strings.
AssertLegacyTrait::assert	protected	function	Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::assertEqual	protected	function	Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertIdentical	protected	function	Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertSame() instead.
AssertLegacyTrait::assertIdenticalObject	protected	function	Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertNotEqual	protected	function	Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotEquals() instead.
AssertLegacyTrait::assertNotIdentical	protected	function	Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotSame() instead.
AssertLegacyTrait::pass	protected	function	Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::verbose	protected	function
ConfigTestTrait::configImporter	protected	function	Returns a ConfigImporter object to import test configuration.
ConfigTestTrait::copyConfig	protected	function	Copies configuration objects from source storage to target storage.
KernelTestBase::$backupGlobals	protected	property	Back up and restore any global variables that may be changed by tests.
KernelTestBase::$backupStaticAttributes	protected	property	Back up and restore static class properties that may be changed by tests.
KernelTestBase::$backupStaticAttributesBlacklist	protected	property	Contains a few static class properties for performance.
KernelTestBase::$classLoader	protected	property
KernelTestBase::$configImporter	protected	property	@todo Move into Config test base class.	7
KernelTestBase::$configSchemaCheckerExclusions	protected static	property	An array of config object names that are excluded from schema checking.
KernelTestBase::$container	protected	property
KernelTestBase::$databasePrefix	protected	property
KernelTestBase::$preserveGlobalState	protected	property	Do not forward any global state from the parent process to the processes that run the actual tests.
KernelTestBase::$root	protected	property	The app root.
KernelTestBase::$runTestInSeparateProcess	protected	property	Kernel tests are run in separate processes because they allow autoloading of code from extensions. Running the test in a separate process isolates this behavior from other tests. Subclasses should not override this property.
KernelTestBase::$siteDirectory	protected	property
KernelTestBase::$vfsRoot	protected	property	The virtual filesystem root directory.
KernelTestBase::assertPostConditions	protected	function		1
KernelTestBase::bootEnvironment	protected	function	Bootstraps a basic test environment.
KernelTestBase::bootKernel	private	function	Bootstraps a kernel for a test.
KernelTestBase::config	protected	function	Configuration accessor for tests. Returns non-overridden configuration.
KernelTestBase::disableModules	protected	function	Disables modules for this test.
KernelTestBase::enableModules	protected	function	Enables modules for this test.
KernelTestBase::getConfigSchemaExclusions	protected	function	Gets the config schema exclusions for this test.
KernelTestBase::getDatabaseConnectionInfo	protected	function	Returns the Database connection info to be used for this test.	1
KernelTestBase::getDatabasePrefix	public	function
KernelTestBase::getExtensionsForModules	private	function	Returns Extension objects for $modules to enable.
KernelTestBase::getModulesToEnable	private static	function	Returns the modules to enable for this test.
KernelTestBase::initFileCache	protected	function	Initializes the FileCache component.
KernelTestBase::installConfig	protected	function	Installs default configuration for a given list of modules.
KernelTestBase::installEntitySchema	protected	function	Installs the storage schema for a specific entity type.
KernelTestBase::installSchema	protected	function	Installs database tables from a module schema definition.
KernelTestBase::isTestInIsolation Deprecated	protected	function	Returns whether the current test method is running in a separate process.
KernelTestBase::prepareTemplate	protected	function
KernelTestBase::register	public	function	Registers test-specific services. Overrides ServiceProviderInterface::register	26
KernelTestBase::render	protected	function	Renders a render array.	1
KernelTestBase::setInstallProfile	protected	function	Sets the install profile and rebuilds the container to update it.
KernelTestBase::setSetting	protected	function	Sets an in-memory Settings variable.
KernelTestBase::setUpBeforeClass	public static	function		1
KernelTestBase::setUpFilesystem	protected	function	Sets up the filesystem, so things like the file directory.	2
KernelTestBase::stop	protected	function	Stops test execution.
KernelTestBase::tearDown	protected	function		6
KernelTestBase::tearDownCloseDatabaseConnection	public	function	@after
KernelTestBase::vfsDump	protected	function	Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__get Deprecated	public	function	BC: Automatically resolve former KernelTestBase class properties.
KernelTestBase::__sleep	public	function	Prevents serializing any properties.
PhpunitCompatibilityTrait::getMock Deprecated	public	function	Returns a mock object for the specified class using the available method.
PhpunitCompatibilityTrait::setExpectedException Deprecated	public	function	Compatibility layer for PHPUnit 6 to support PHPUnit 4 code.
RandomGeneratorTrait::$randomGenerator	protected	property	The random generator.
RandomGeneratorTrait::getRandomGenerator	protected	function	Gets the random generator for the utility methods.
RandomGeneratorTrait::randomMachineName	protected	function	Generates a unique random string containing letters and numbers.	1
RandomGeneratorTrait::randomObject	public	function	Generates a random PHP object.
RandomGeneratorTrait::randomString	public	function	Generates a pseudo-random string of ASCII characters of codes 32 to 126.
RandomGeneratorTrait::randomStringValidate	public	function	Callback for random string validation.
StorageCopyTrait::replaceStorageContents	protected static	function	Copy the configuration from one storage to another and remove stale items.
TestRequirementsTrait::checkModuleRequirements	private	function	Checks missing module requirements.
TestRequirementsTrait::checkRequirements	protected	function	Check module requirements for the Drupal use case.	1
TestRequirementsTrait::getDrupalRoot	protected static	function	Returns the Drupal root directory.

You are here

class AddressDisplayTest in Address Display 8

Hierarchy

File

Namespace

Members

API Navigation