You are here

Home » API reference » CRM Core 8.3 » IndividualCRUDTest.php

class IndividualCRUDTest in CRM Core 8.3

Same name and namespace in other branches
  1. 8 modules/crm_core_contact/tests/src/Kernel/IndividualCRUDTest.php \Drupal\Tests\crm_core_contact\Kernel\IndividualCRUDTest
  2. 8.2 modules/crm_core_contact/tests/src/Kernel/IndividualCRUDTest.php \Drupal\Tests\crm_core_contact\Kernel\IndividualCRUDTest

Tests CRUD operations for the CRM Core Individual entity.

@group crm_core

Hierarchy

Expanded class hierarchy of IndividualCRUDTest

File

modules/crm_core_contact/tests/src/Kernel/IndividualCRUDTest.php, line 20

Namespace

Drupal\Tests\crm_core_contact\Kernel
View source 
class IndividualCRUDTest extends KernelTestBase {

  /**
   * Modules to enable.
   *
   * @var array
   */
  public static $modules = [
    'field',
    'text',
    'user',
    'crm_core',
    'crm_core_contact',
    'crm_core_activity',
    'dynamic_entity_reference',
    'datetime',
    'relation',
    'relation_endpoint',
    'name',
    'options',
  ];

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();
    $this
      ->installConfig([
      'field',
    ]);
    $this
      ->installEntitySchema('crm_core_individual');
    $this
      ->installEntitySchema('crm_core_organization');
    $this
      ->installEntitySchema('crm_core_activity');
    $this
      ->installEntitySchema('relation');
    $this->pluginManager = $this->container
      ->get('plugin.manager.action');
  }

  /**
   * Tests CRUD of individual types.
   */
  public function testIndividualType() {
    $type = 'dog';

    // Create.
    $individual_type = IndividualType::create([
      'type' => $type,
    ]);
    $this
      ->assertTrue(isset($individual_type->type) && $individual_type->type == $type, 'New individual type exists.');
    $individual_type->name = $this
      ->randomMachineName();
    $individual_type->description = $this
      ->randomString();
    $individual_type->primary_fields = [];
    $this
      ->assertEquals(SAVED_NEW, $individual_type
      ->save(), 'Individual type saved.');

    // Load.
    $individual_type_load = IndividualType::load($type);
    $this
      ->assertEquals($individual_type->type, $individual_type_load->type, 'Loaded individual type has same type.');
    $this
      ->assertEquals($individual_type->name, $individual_type_load->name, 'Loaded individual type has same name.');
    $this
      ->assertEquals($individual_type->description, $individual_type_load->description, 'Loaded individual type has same description.');
    $uuid = $individual_type_load
      ->uuid();
    $this
      ->assertNotEmpty($uuid, 'Loaded individual type has uuid.');

    // Test IndividualType::getNames().
    $individual_type_labels = IndividualType::getNames();
    $this
      ->assertSame($individual_type->name, $individual_type_labels[$individual_type->type]);

    // Delete.
    $individual_type_load
      ->delete();
    $individual_type_load = IndividualType::load($type);
    $this
      ->assertNull($individual_type_load, 'Individual type deleted.');
  }

  /**
   * Tests CRUD of individuals.
   */
  public function testIndividual() {
    $this
      ->installEntitySchema('user');
    $type = IndividualType::create([
      'type' => 'test',
    ]);
    $type->primary_fields = [];
    $type
      ->save();

    // Create.
    $individual = Individual::create([
      'type' => $type->type,
    ]);
    $this
      ->assertEquals(SAVED_NEW, $individual
      ->save(), 'Individual saved.');

    // Create second individual.
    $individual_one = Individual::create([
      'type' => $type->type,
    ]);
    $this
      ->assertEquals(SAVED_NEW, $individual_one
      ->save(), 'Individual saved.');

    // Assert default labels.
    $this
      ->assertEquals('Nameless #' . $individual_one
      ->id(), $individual_one
      ->label());
    $individual_one->name->given = 'First';
    $individual_one->name->family = 'Last';
    $individual_one
      ->save();
    $this
      ->assertEquals('First Last', $individual_one
      ->label());

    // Load.
    $individual_load = Individual::load($individual
      ->id());
    $uuid = $individual_load
      ->uuid();
    $this
      ->assertNotEmpty($uuid, 'Loaded individual has uuid.');
    $activity_type = ActivityType::create([
      'type' => 'activity_test',
    ]);
    $activity_type
      ->save();

    // Create activity and add participants individual.
    $activity = Activity::create([
      'type' => $activity_type->type,
    ]);
    $activity
      ->get('activity_participants')
      ->appendItem($individual);
    $activity
      ->get('activity_participants')
      ->appendItem($individual_one);
    $this
      ->assertEquals(SAVED_NEW, $activity
      ->save(), 'Activity saved.');

    // Load activity.
    $activity_load = Activity::load($activity
      ->id());
    $this
      ->assertNotEmpty($activity_load
      ->uuid(), 'Loaded activity has uuid.');

    // Delete first individual, activity should'n be deleted
    // because it's related to second individual.
    $individual
      ->delete();
    $individual_load = Individual::load($individual
      ->id());
    $this
      ->assertNull($individual_load, 'Individual deleted.');
    $activity_load = Activity::load($activity
      ->id());
    $this
      ->assertNotNull($activity_load, 'Activity not deleted.');

    // Delete second individual and now activity should be deleted too.
    $individual_one
      ->delete();
    $individual_load = Individual::load($individual_one
      ->id());
    $this
      ->assertNull($individual_load, 'Contact deleted.');
    $activity_load = Activity::load($activity
      ->id());
    $this
      ->assertNull($activity_load, 'Activity deleted.');
  }

  /**
   * Tests action plugins.
   */
  public function testActionPlugins() {

    // Create individual types.
    $individual_type_1 = IndividualType::create([
      'type' => 'seller',
    ]);
    $individual_type_1->primary_fields = [];
    $individual_type_1
      ->save();
    $individual_type_2 = IndividualType::create([
      'type' => 'customer',
    ]);
    $individual_type_2->primary_fields = [];
    $individual_type_2
      ->save();
    $organization_type = OrganizationType::create([
      'id' => 'supplier',
      'label' => $this
        ->randomMachineName(),
      'description' => $this
        ->randomString(),
      'primary_fields' => [],
    ]);
    $organization_type
      ->save();

    // Create seller individual.
    $seller_individual = Individual::create([
      'type' => 'seller',
      'name' => [
        'title' => 'Will',
        'family' => 'Smith',
      ],
    ]);
    $seller_individual
      ->save();

    // Create 3 individual customers.
    $individual_customer_1 = Individual::create([
      'type' => 'customer',
      'name' => [
        'given' => 'John',
        'family' => 'Smith',
      ],
    ]);
    $individual_customer_1
      ->save();
    $individual_customer_2 = Individual::create([
      'type' => 'customer',
      'name' => [
        'given' => 'Mark',
        'family' => 'Jones',
      ],
    ]);
    $individual_customer_2
      ->save();
    $individual_customer_3 = Individual::create([
      'type' => 'customer',
      'name' => [
        'given' => 'Joan',
        'family' => 'Johnson',
      ],
    ]);
    $individual_customer_3
      ->save();

    // Create one organization.
    $organization = Organization::create([
      'type' => $organization_type
        ->id(),
    ]);
    $organization
      ->save();

    // Create crm_member relation type.
    $relation_type = RelationType::create([
      'id' => 'crm_member',
      'source_bundles' => [
        'crm_core_individual:*',
        'crm_core_organization:*',
      ],
      'target_bundles' => [
        'crm_core_individual:seller',
      ],
    ]);
    $relation_type
      ->save();

    // Create meeting activity.
    $meeting_activity = Activity::create([
      'type' => 'meeting',
      'title' => $this
        ->randomString(),
      'activity_participants' => [
        $individual_customer_2,
        $individual_customer_3,
      ],
    ]);
    $meeting_activity
      ->save();
    $this
      ->markTestIncomplete('Incomplete port follows.');

    // Test join_into_household_action.
    // @todo there is no more household bundle after we rename contact to individual.
    $join_into_household_action_plugin = $this->pluginManager
      ->createInstance('join_into_household_action', [
      'household' => $household_contact,
    ]);
    $join_into_household_action_plugin
      ->executeMultiple([
      $individual_customer_1,
      $individual_customer_2,
      $organization,
    ]);
    $relations = Relation::loadMultiple();

    // Test that there are two new relations with correct endpoints and types.
    $this
      ->assertEquals(count($relations), 3, 'Three new relations were created during this test.');
    $this
      ->assertEquals($relations[1]->relation_type->target_id, 'crm_member');
    $this
      ->assertEquals($relations[2]->relation_type->target_id, 'crm_member');
    $this
      ->assertEquals($relations[3]->relation_type->target_id, 'crm_member');
    $this
      ->assertEquals($relations[1]->endpoints[0]->entity_id, $individual_customer_1
      ->id());
    $this
      ->assertEquals($relations[1]->endpoints[1]->entity_id, $household_contact
      ->id());
    $this
      ->assertEquals($relations[2]->endpoints[0]->entity_id, $individual_customer_2
      ->id());
    $this
      ->assertEquals($relations[2]->endpoints[1]->entity_id, $household_contact
      ->id());
    $this
      ->assertEquals($relations[3]->endpoints[0]->entity_id, $organization
      ->id());
    $this
      ->assertEquals($relations[3]->endpoints[1]->entity_id, $household_contact
      ->id());

    // Test merge_contacts_action.
    // @todo contacts are now individuals
    $data = [
      'data' => [
        'contact_id' => $individual_customer_1
          ->id(),
        'name' => [
          $individual_customer_3
            ->id() => $individual_customer_3
            ->get('name'),
        ],
      ],
    ];

    // Create relation between two individuals.
    $endpoints = [
      [
        'entity_type' => 'crm_core_individual',
        'entity_id' => $household_contact
          ->id(),
      ],
      [
        'entity_type' => 'crm_core_individual',
        'entity_id' => $individual_customer_3
          ->id(),
      ],
    ];
    $relation = Relation::create([
      'relation_type' => 'crm_member',
    ]);
    $relation->endpoints = $endpoints;
    $relation
      ->save();
    $merge_contacts_action_plugin = $this->pluginManager
      ->createInstance('merge_contacts_action', $data);
    $merge_contacts_action_plugin
      ->executeMultiple([
      $individual_customer_1,
      $individual_customer_3,
    ]);

    // Test that there is no individual_contact_3.
    $individual_customer_3 = Individual::load($individual_customer_3
      ->id());
    $this
      ->assertNull($individual_customer_3);

    // Test that values are updated in meeting_activity.
    $meeting_activity = Activity::load($meeting_activity
      ->id());
    $this
      ->assertEquals($meeting_activity->activity_participants[0]->target_id, $individual_customer_2
      ->id());
    $this
      ->assertEquals($meeting_activity->activity_participants[1]->target_id, $individual_customer_1
      ->id());

    // Test that relation has been created with correct values.
    $relations = Relation::loadMultiple();
    $this
      ->assertEquals($relations[5]->relation_type->target_id, 'crm_member');
    $this
      ->assertEquals($relations[5]->endpoints[0]->entity_id, $individual_customer_1
      ->id());
    $this
      ->assertEquals($relations[5]->endpoints[1]->entity_id, $household_contact
      ->id());
  }

}

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.
IndividualCRUDTest::$modules public static property Modules to enable. Overrides KernelTestBase::$modules
IndividualCRUDTest::setUp protected function Overrides KernelTestBase::setUp
IndividualCRUDTest::testActionPlugins public function Tests action plugins.
IndividualCRUDTest::testIndividual public function Tests CRUD of individuals.
IndividualCRUDTest::testIndividualType public function Tests CRUD of individual types.
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.
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.