You are here

Home » API reference » Simplenews 8.2 » SimplenewsSynchronizeFieldsTest.php

class SimplenewsSynchronizeFieldsTest in Simplenews 8.2

Same name and namespace in other branches
  1. 8 tests/src/Kernel/SimplenewsSynchronizeFieldsTest.php \Drupal\Tests\simplenews\Kernel\SimplenewsSynchronizeFieldsTest
  2. 3.x tests/src/Kernel/SimplenewsSynchronizeFieldsTest.php \Drupal\Tests\simplenews\Kernel\SimplenewsSynchronizeFieldsTest

Tests that fields shared by user account and subscribers are synchronized.

@group simplenews

Hierarchy

Expanded class hierarchy of SimplenewsSynchronizeFieldsTest

File

tests/src/Kernel/SimplenewsSynchronizeFieldsTest.php, line 17

Namespace

Drupal\Tests\simplenews\Kernel
View source 
class SimplenewsSynchronizeFieldsTest extends KernelTestBase {

  /**
   * Modules to enable.
   *
   * @var array
   */
  public static $modules = [
    'simplenews',
    'user',
    'field',
    'system',
    'language',
  ];

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();
    $this
      ->installEntitySchema('user');
    $this
      ->installEntitySchema('simplenews_subscriber');
    $this
      ->installSchema('system', [
      'sequences',
      'sessions',
    ]);
    $this
      ->config('system.mail')
      ->set('interface.default', 'test_mail_collector')
      ->save();
    $this
      ->config('simplenews.settings')
      ->set('subscriber.sync_fields', TRUE)
      ->save();
    ConfigurableLanguage::create([
      'id' => 'fr',
    ])
      ->save();
  }

  /**
   * Tests that creating/updating User updates existing Subscriber base fields.
   */
  public function testSynchronizeBaseFields() {

    // Create subscriber.

    /** @var \Drupal\simplenews\Entity\Subscriber $subscriber */
    $subscriber = Subscriber::create([
      'mail' => 'user@example.com',
    ]);
    $subscriber
      ->save();

    // Create user with same email.

    /** @var \Drupal\user\Entity\User $user */
    $user = User::create([
      'name' => 'user',
      'mail' => 'user@example.com',
      'preferred_langcode' => 'fr',
    ]);
    $user
      ->save();

    // Assert that subscriber's fields are updated.
    $subscriber = Subscriber::load($subscriber
      ->id());
    $this
      ->assertEqual($subscriber
      ->getUserId(), $user
      ->id());
    $this
      ->assertEqual($subscriber
      ->getLangcode(), 'fr');
    $this
      ->assertFalse($subscriber
      ->getStatus());

    // Update user fields.
    $user
      ->setEmail('user2@example.com');
    $user
      ->set('preferred_langcode', 'en');
    $user
      ->activate();
    $user
      ->save();

    // Assert that subscriber's fields are updated again.
    $subscriber = Subscriber::load($subscriber
      ->id());
    $this
      ->assertEqual($subscriber
      ->getMail(), 'user2@example.com');
    $this
      ->assertEqual($subscriber
      ->getLangcode(), 'en');
    $this
      ->assertTrue($subscriber
      ->getStatus());

    // Status is still synced even if sync_fields is not set.
    $this
      ->config('simplenews.settings')
      ->set('subscriber.sync_fields', FALSE)
      ->save();
    $user
      ->block();
    $user
      ->save();
    $subscriber = Subscriber::load($subscriber
      ->id());
    $this
      ->assertFalse($subscriber
      ->getStatus());
  }

  /**
   * Tests that shared fields are synchronized.
   */
  public function testSynchronizeConfigurableFields() {

    // Create and attach a field to both.
    $this
      ->addField('string', 'field_on_both', 'simplenews_subscriber');
    $this
      ->addField('string', 'field_on_both', 'user');

    // Create a user and a subscriber.

    /** @var \Drupal\simplenews\Entity\Subscriber $subscriber */
    $subscriber = Subscriber::create([
      'field_on_both' => 'foo',
      'mail' => 'user@example.com',
      'created' => 2000,
    ]);
    $subscriber
      ->save();

    /** @var \Drupal\user\Entity\User $user */
    $user = User::create([
      'name' => 'user',
      'field_on_both' => 'foo',
      'mail' => 'user@example.com',
      'created' => 1000,
    ]);
    $user
      ->save();

    // Update the fields on the subscriber.
    $subscriber = Subscriber::load($subscriber
      ->id());
    $subscriber
      ->set('field_on_both', 'bar');
    $subscriber
      ->set('created', 3000);
    $subscriber
      ->save();

    // Assert that (only) the shared field is also updated on the user.
    $user = User::load($user
      ->id());
    $this
      ->assertEqual($user
      ->get('field_on_both')->value, 'bar');
    $this
      ->assertEqual($user
      ->get('created')->value, 1000);

    // Update the fields on the user.
    $user
      ->set('field_on_both', 'baz');
    $user
      ->set('created', 4000);
    $user
      ->save();

    // Assert that (only) the shared field is also updated on the subscriber.
    $subscriber = Subscriber::load($subscriber
      ->id());
    $this
      ->assertEqual($subscriber
      ->get('field_on_both')->value, 'baz');
    $this
      ->assertEqual($subscriber
      ->get('created')->value, 3000);
  }

  /**
   * Tests that new entities copy values from corresponding user/subscriber.
   */
  public function testSetSharedFieldAutomatically() {

    // Create and attach a field to both.
    $this
      ->addField('string', 'field_on_both', 'simplenews_subscriber');
    $this
      ->addField('string', 'field_on_both', 'user');

    // Create a user with values for the fields.

    /** @var \Drupal\user\Entity\User $user */
    $user = User::create([
      'name' => 'user',
      'field_on_both' => 'foo',
      'mail' => 'user@example.com',
    ]);
    $user
      ->save();

    // Create a subscriber.

    /** @var \Drupal\simplenews\Entity\Subscriber $subscriber */
    $subscriber = Subscriber::create([
      'mail' => 'user@example.com',
    ]);

    // Assert that the shared field already has a value.
    $this
      ->assertEqual($subscriber
      ->get('field_on_both')->value, $user
      ->get('field_on_both')->value);

    // Create a subscriber with values for the fields.
    $subscriber = Subscriber::create([
      'field_on_both' => 'bar',
      'mail' => 'user@example.com',
    ]);
    $subscriber
      ->save();

    // Create a user.
    $user = User::create([
      'name' => 'user',
      'mail' => 'user@example.com',
    ]);

    // Assert that the shared field already has a value.
    $this
      ->assertEqual($user
      ->get('field_on_both')->value, $subscriber
      ->get('field_on_both')->value);
  }

  /**
   * Unsets the sync setting and asserts that fields are not synced.
   */
  public function testDisableSync() {

    // Disable sync.
    $this
      ->config('simplenews.settings')
      ->set('subscriber.sync_fields', FALSE)
      ->save();

    // Create and attach a field to both.
    $this
      ->addField('string', 'field_on_both', 'simplenews_subscriber');
    $this
      ->addField('string', 'field_on_both', 'user');

    // Create a user with a value for the field.
    $user = User::create([
      'name' => 'user',
      'field_on_both' => 'foo',
      'mail' => 'user@example.com',
    ]);
    $user
      ->save();

    // Create a subscriber.
    $subscriber = Subscriber::create([
      'mail' => 'user@example.com',
    ]);

    // Assert that the shared field does not get the value from the user.
    $this
      ->assertNull($subscriber
      ->get('field_on_both')->value);

    // Update the subscriber and assert that it is not synced to the user.
    $subscriber
      ->set('field_on_both', 'bar');
    $subscriber
      ->save();
    $user = User::load($user
      ->id());
    $this
      ->assertEqual($user
      ->get('field_on_both')->value, 'foo');

    // Create a subscriber with a value for the field.
    $subscriber = Subscriber::create([
      'field_on_both' => 'foo',
      'mail' => 'user2@example.com',
    ]);
    $subscriber
      ->save();

    // Create a user.
    $user = User::create([
      'name' => 'user2',
      'mail' => 'user2@example.com',
    ]);

    // Assert that the shared field does not get the value from the subscriber.
    $this
      ->assertNull($user
      ->get('field_on_both')->value);

    // Update the user and assert that it is not synced to the subscriber.
    $user
      ->set('field_on_both', 'bar');
    $user
      ->save();
    $subscriber = Subscriber::load($subscriber
      ->id());
    $this
      ->assertEqual($subscriber
      ->get('field_on_both')->value, 'foo');
  }

  /**
   * Tests that recursion is prevented when a user is updated.
   *
   * If the synchronization between fields is active, whenever a user gets saved
   * the related subscriber gets its fields updated and viceversa.
   *
   * This test covers a bug that happened when a user gets saved. The checks
   * to prevent circular updates were not working correctly if the user entity
   * is the one being saved first.
   * The bug appeared when trying to use the AddRoleUser or RemoveRoleUser
   * actions on users with subscriptions.
   *
   * @see \Drupal\user\Plugin\Action\AddRoleUser
   * @see \Drupal\user\Plugin\Action\RemoveRoleUser
   */
  public function testUserRecursionPrevention() {

    // Create a subscriber.

    /** @var \Drupal\simplenews\Entity\Subscriber $subscriber */
    $subscriber = Subscriber::create([
      'mail' => 'user@example.com',
    ]);
    $subscriber
      ->save();

    // Create a user with same email.

    /** @var \Drupal\user\Entity\User $user */
    $user = User::create([
      'name' => 'user',
      'mail' => 'user@example.com',
      'preferred_langcode' => 'fr',
    ]);
    $user
      ->save();

    // Load the user, so that the static cache in the storage gets populated.
    $user = User::load($user
      ->id());

    // Replicate the behaviour of two actions mentioned. The user entity gets
    // cloned and set in the original property. This will prevent a call to
    // ContentEntityStorageBase::loadUnchanged(), so the user entity available
    // in the static cache is the same object being used here.
    // @see \Drupal\user\Plugin\Action\AddRoleUser::execute()
    // @see \Drupal\user\Plugin\Action\RemoveRoleUser::execute()
    // @see \Drupal\Core\Entity\ContentEntityStorageBase::loadUnchanged()
    $user->original = clone $user;

    // Make a change to the user.
    $user
      ->set('preferred_langcode', 'en');

    // Save the user. This will invoke simplenews_user_presave(), which will
    // sync the fields on the related subscriber entity and save it.
    // On post save of the subscriber entity, the user fields should be updated,
    // but not in this case since the updates are already coming from the user.
    // If this is not prevented, the user will be loaded (hitting the static
    // cache) and then saved again. Then, the user object, which is still the
    // same from the original request, will be modified during the
    // EntityStorageBase::doPostSave() method.
    // At this point the initial user presave will continue, but the entity
    // "original" property has been unset and a critical error will be thrown.
    // @see \Drupal\Core\Entity\EntityStorageBase::doPostSave()
    // @see \Drupal\Core\Entity\ContentEntityStorageBase::doPreSave()
    $user
      ->save();

    // Assert that the field has been synced properly.
    $this
      ->assertEquals($subscriber
      ->getLangcode(), 'en');
  }

  /**
   * Creates and saves a field storage and instance.
   *
   * @param string $type
   *   The field type.
   * @param string $field_name
   *   The name of the new field.
   * @param string $entity_type
   *   The ID of the entity type to attach the field instance to.
   * @param string $bundle
   *   (optional) The entity bundle. Defaults to same as $entity_type.
   */
  protected function addField($type, $field_name, $entity_type, $bundle = NULL) {
    if (!isset($bundle)) {
      $bundle = $entity_type;
    }
    FieldStorageConfig::create([
      'field_name' => $field_name,
      'entity_type' => $entity_type,
      'type' => $type,
    ])
      ->save();
    FieldConfig::create([
      'field_name' => $field_name,
      'entity_type' => $entity_type,
      'bundle' => $bundle,
    ])
      ->save();
  }

}

Members

Namesort descending 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.
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.
SimplenewsSynchronizeFieldsTest::$modules public static property Modules to enable. Overrides KernelTestBase::$modules
SimplenewsSynchronizeFieldsTest::addField protected function Creates and saves a field storage and instance.
SimplenewsSynchronizeFieldsTest::setUp protected function Overrides KernelTestBase::setUp
SimplenewsSynchronizeFieldsTest::testDisableSync public function Unsets the sync setting and asserts that fields are not synced.
SimplenewsSynchronizeFieldsTest::testSetSharedFieldAutomatically public function Tests that new entities copy values from corresponding user/subscriber.
SimplenewsSynchronizeFieldsTest::testSynchronizeBaseFields public function Tests that creating/updating User updates existing Subscriber base fields.
SimplenewsSynchronizeFieldsTest::testSynchronizeConfigurableFields public function Tests that shared fields are synchronized.
SimplenewsSynchronizeFieldsTest::testUserRecursionPrevention public function Tests that recursion is prevented when a user is updated.
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.