class MailWithTypeItemTest in CRM Core 8.2

Tests the 'email_with_type' field type.

@group crm_core_contact

Hierarchy

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

Expanded class hierarchy of MailWithTypeItemTest

File

modules/crm_core_contact/tests/src/Kernel/MailWithTypeItemTest.php, line 19

Namespace

Drupal\Tests\crm_core_contact\Kernel

View source

class MailWithTypeItemTest extends KernelTestBase {

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

  /**
   * View display.
   *
   * @var \Drupal\Core\Entity\Display\EntityViewDisplayInterface
   */
  protected $viewDisplay;

  /**
   * Modules to enable.
   *
   * @var array
   */
  public static $modules = [
    'user',
    'field',
    'entity_test',
    'crm_core_contact',
    'options',
  ];

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();
    $this
      ->installEntitySchema('entity_test');
    $this
      ->installEntitySchema('user');

    // Create a 'mail_with_type' field storage and field for validation.
    FieldStorageConfig::create([
      'field_name' => 'field_mail_with_type',
      'entity_type' => 'entity_test',
      'type' => 'email_with_type',
      'settings' => [
        'email_types' => [
          'home' => 'Home',
          'work' => 'Work',
        ],
      ],
    ])
      ->save();
    FieldConfig::create([
      'entity_type' => 'entity_test',
      'field_name' => 'field_mail_with_type',
      'bundle' => 'entity_test',
      'label' => 'Email with type',
    ])
      ->save();

    // Create a form display for the default form mode.
    $this->formDisplay = EntityFormDisplay::create([
      'targetEntityType' => 'entity_test',
      'bundle' => 'entity_test',
      'mode' => 'default',
      'status' => TRUE,
    ]);
    $this->formDisplay
      ->setComponent('field_mail_with_type', [
      'type' => 'email_with_type',
    ])
      ->save();

    // Create view display for the default view mode.
    $this->viewDisplay = EntityViewDisplay::create([
      'targetEntityType' => 'entity_test',
      'bundle' => 'entity_test',
      'mode' => 'default',
      'content' => [],
    ]);
    $this->viewDisplay
      ->setComponent('field_mail_with_type', [
      'type' => 'email_with_type',
    ])
      ->save();
  }

  /**
   * Tests 'mail_with_type' field type.
   */
  public function testMailWithTypeItem() {

    // Verify entity creation.
    $value = 'mail@example.com';
    $type = 'work';

    /** @var \Drupal\Core\Entity\ContentEntityInterface $entity */
    $entity = EntityTest::create();
    $entity
      ->set('field_mail_with_type', [
      'value' => $value,
      'type' => $type,
    ]);
    $entity
      ->save();

    // Verify entity has been created properly.
    $entity = $this->container
      ->get('entity_type.manager')
      ->getStorage('entity_test')
      ->load($entity
      ->id());
    $this
      ->assertEquals($value, $entity->field_mail_with_type->value);
    $this
      ->assertEquals($type, $entity->field_mail_with_type->type);

    // Verify changing the type and value.
    $new_type = 'home';
    $new_value = 'test@example.com';
    $entity->field_mail_with_type->type = $new_type;
    $entity->field_mail_with_type->value = $new_value;
    $this
      ->assertEquals($new_type, $entity->field_mail_with_type->type);
    $this
      ->assertEquals($new_value, $entity->field_mail_with_type->value);

    // Load changed entity and assert changed values.
    $entity
      ->save();
    $entity = $this->container
      ->get('entity_type.manager')
      ->getStorage('entity_test')
      ->load($entity
      ->id());
    $this
      ->assertEquals($new_type, $entity->field_mail_with_type->type);
    $this
      ->assertEquals($new_value, $entity->field_mail_with_type->value);

    // Verify form widget.
    $form = [];
    $form_state = new FormState();
    $this->formDisplay
      ->buildForm($entity, $form, $form_state);
    $widget = $form['field_mail_with_type']['widget'];
    $this
      ->assertEquals('Email with type', $widget['#title'], 'Widget title is correct.');
    $this
      ->assertEquals('Type', $widget['type']['#title'], 'Type element title is correct.');
    $this
      ->assertEquals('home', $widget['type']['#default_value'], 'Type default value is correct.');
    $this
      ->assertEquals([
      'home' => 'Home',
      'work' => 'Work',
    ], $widget['type']['#options'], 'Type options are correct.');
    $this
      ->assertEquals('Email', $widget['value']['#title'], 'Email element title is correct.');
    $this
      ->assertEquals('test@example.com', $widget['value']['#default_value'], 'Email default value is correct.');

    // Verify formatter.
    $build = $this->viewDisplay
      ->build($entity);
    $this->container
      ->get('renderer')
      ->renderRoot($build);
    $this
      ->assertEquals('Home: <a href="mailto:test@example.com">test@example.com</a>', $build['field_mail_with_type']['#markup'], 'Email displayed correctly.');

    // Test storage config form validator.
    // Test invalid mail types configuration value.
    $element = [
      '#value' => "Foo\nwork|Work",
      '#field_has_data' => FALSE,
      '#entity_type' => 'entity_test',
      '#field_name' => 'field_mail_with_type',
      '#email_types' => [
        'home' => 'Home',
        'work' => 'Work',
      ],
    ];
    $form_state = $this
      ->getMock('\\Drupal\\Core\\Form\\FormState');
    $form_state
      ->expects($this
      ->once())
      ->method('setError')
      ->with($element, 'Email types list: invalid input.');
    MailWithTypeItem::validateMailTypes($element, $form_state);

    // Test key that is to long.
    $element['#value'] = "homelonglonglonglonglongwaytolong|Home\nwork|Work";
    $form_state = $this
      ->getMock('\\Drupal\\Core\\Form\\FormState');
    $form_state
      ->expects($this
      ->once())
      ->method('setError')
      ->with($element, 'Email types list: each key must be a string at most 32 characters long.');
    MailWithTypeItem::validateMailTypes($element, $form_state);

    // Test key with invalid characters.
    $element['#value'] = "domači|Home\nslužbeni|Work";
    $form_state = $this
      ->getMock('\\Drupal\\Core\\Form\\FormState');
    $form_state
      ->expects($this
      ->once())
      ->method('setError')
      ->with($element, 'Email types list: only international alphanumeric characters are allowed for keys.');
    MailWithTypeItem::validateMailTypes($element, $form_state);

    // Test valid list of mail types.
    $element['#value'] = "home|Home\nwork|Work";
    $element['#field_has_data'] = TRUE;
    $form_state = $this
      ->getMock('\\Drupal\\Core\\Form\\FormState');
    $form_state
      ->expects($this
      ->never())
      ->method('setError');
    MailWithTypeItem::validateMailTypes($element, $form_state);

    // Test removal of the key that already exists in the database.
    $element['#value'] = "work|Work";
    $form_state = $this
      ->getMock('\\Drupal\\Core\\Form\\FormState');
    $form_state
      ->expects($this
      ->once())
      ->method('setError')
      ->with($element, 'Email types list: some values are being removed while currently in use.');
    MailWithTypeItem::validateMailTypes($element, $form_state);

    // Test MailWithTypeItem::emailTypesString().
    $definition = $this
      ->getMock('\\Drupal\\entity_test\\FieldStorageDefinition');
    $definition
      ->expects($this
      ->once())
      ->method('getPropertyDefinitions')
      ->will($this
      ->returnValue([]));
    $field_item = new MailWithTypeItem($definition);
    $reflection = new \ReflectionClass('Drupal\\crm_core_contact\\Plugin\\Field\\FieldType\\MailWithTypeItem');
    $method = $reflection
      ->getMethod('emailTypesString');
    $method
      ->setAccessible(TRUE);
    $this
      ->assertSame("home|Home\nwork|Work", $method
      ->invokeArgs($field_item, [
      [
        'home' => 'Home',
        'work' => 'Work',
      ],
    ]));
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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::$strictConfigSchema	protected	property	Set to TRUE to strict check all configuration saved.	6
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.
MailWithTypeItemTest::$formDisplay	protected	property	Form display.
MailWithTypeItemTest::$modules	public static	property	Modules to enable. Overrides KernelTestBase::$modules
MailWithTypeItemTest::$viewDisplay	protected	property	View display.
MailWithTypeItemTest::setUp	protected	function	Overrides KernelTestBase::setUp
MailWithTypeItemTest::testMailWithTypeItem	public	function	Tests 'mail_with_type' field type.
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 MailWithTypeItemTest in CRM Core 8.2

Hierarchy

File

Namespace

Members

API Navigation