You are here

class TaxNumberItemTest in Commerce Core 8.2

Tests the 'commerce_tax_number' field type.

@group commerce

Hierarchy

Expanded class hierarchy of TaxNumberItemTest

File

modules/tax/tests/src/Kernel/TaxNumberItemTest.php, line 17

Namespace

Drupal\Tests\commerce_tax\Kernel
View source
class TaxNumberItemTest extends CommerceKernelTestBase {

  /**
   * A test field.
   *
   * @var \Drupal\field\Entity\FieldConfig
   */
  protected $field;

  /**
   * Modules to enable.
   *
   * @var array
   */
  public static $modules = [
    'entity_reference_revisions',
    'path',
    'profile',
    'state_machine',
    'commerce_order',
    'commerce_tax',
    'commerce_tax_test',
  ];

  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    parent::setUp();
    $field_storage = FieldStorageConfig::create([
      'field_name' => 'test_tax_number',
      'entity_type' => 'entity_test',
      'type' => 'commerce_tax_number',
    ]);
    $field_storage
      ->save();
    $this->field = FieldConfig::create([
      'field_name' => 'test_tax_number',
      'entity_type' => 'entity_test',
      'bundle' => 'entity_test',
      'label' => 'VAT Number',
      'settings' => [
        'countries' => [],
        'verify' => TRUE,
        'allow_unverified' => TRUE,
      ],
    ]);
    $this->field
      ->save();
  }

  /**
   * Tests the field.
   */
  public function testField() {
    $entity = EntityTest::create([
      'test_tax_number' => [
        'type' => 'serbian_vat',
        'value' => '123',
        'verification_state' => VerificationResult::STATE_SUCCESS,
        'verification_timestamp' => strtotime('2019/08/08'),
        'verification_result' => [
          'name' => 'Bryan Centarro',
        ],
      ],
    ]);
    $entity
      ->save();
    $entity = $this
      ->reloadEntity($entity);

    /** @var \Drupal\commerce_tax\Plugin\Field\FieldType\TaxNumberItemInterface $tax_number_item */
    $tax_number_item = $entity
      ->get('test_tax_number')
      ->first();
    $this
      ->assertEquals('serbian_vat', $tax_number_item->type);
    $this
      ->assertEquals('123', $tax_number_item->value);
    $this
      ->assertEquals(VerificationResult::STATE_SUCCESS, $tax_number_item->verification_state);
    $this
      ->assertEquals(strtotime('2019/08/08'), $tax_number_item->verification_timestamp);
    $this
      ->assertEquals([
      'name' => 'Bryan Centarro',
    ], $tax_number_item->verification_result);
    $type_plugin = $tax_number_item
      ->getTypePlugin();
    $this
      ->assertNotEmpty($type_plugin);
    $this
      ->assertEquals('serbian_vat', $type_plugin
      ->getPluginId());

    // Confirm that changing the type resets the verification state.
    $tax_number_item->type = 'invalid';
    $this
      ->assertNull($tax_number_item->verification_state);
    $this
      ->assertNull($tax_number_item->verification_timestamp);
    $this
      ->assertNull($tax_number_item->verification_result);

    // Test type fallback.
    $type_plugin = $tax_number_item
      ->getTypePlugin();
    $this
      ->assertNotEmpty($type_plugin);
    $this
      ->assertEquals('other', $type_plugin
      ->getPluginId());
  }

  /**
   * Tests checking whether value can be used for tax calculation.
   */
  public function testCheckValue() {
    $entity = EntityTest::create([
      'test_tax_number' => [
        'type' => 'serbian_vat',
        'value' => '123456',
        'verification_state' => VerificationResult::STATE_UNKNOWN,
      ],
    ]);
    $entity
      ->save();
    $entity = $this
      ->reloadEntity($entity);

    /** @var \Drupal\commerce_tax\Plugin\Field\FieldType\TaxNumberItemInterface $tax_number_item */
    $tax_number_item = $entity
      ->get('test_tax_number')
      ->first();
    $this
      ->assertTrue($tax_number_item
      ->checkValue('serbian_vat'));

    // Type mismatch.
    $this
      ->assertFalse($tax_number_item
      ->checkValue('european_union_vat'));

    // Empty value.
    $tax_number_item->value = '';
    $this
      ->assertFalse($tax_number_item
      ->checkValue('other'));

    // No verification_state specified.
    $tax_number_item->value = '123456';
    $tax_number_item->verification_state = NULL;
    $this
      ->assertFalse($tax_number_item
      ->checkValue('serbian_vat'));

    // Verification required.
    $this->field
      ->setSetting('allow_unverified', FALSE);
    $this->field
      ->save();
    $entity = $this
      ->reloadEntity($entity);

    /** @var \Drupal\commerce_tax\Plugin\Field\FieldType\TaxNumberItemInterface $tax_number_item */
    $tax_number_item = $entity
      ->get('test_tax_number')
      ->first();
    $this
      ->assertFalse($tax_number_item
      ->checkValue('serbian_vat'));
    $tax_number_item->verification_state = VerificationResult::STATE_SUCCESS;
    $this
      ->assertTrue($tax_number_item
      ->checkValue('serbian_vat'));
    $entity = EntityTest::create([
      'test_tax_number' => [
        'type' => 'other',
        'value' => '123',
      ],
    ]);
    $entity
      ->save();
    $entity = $this
      ->reloadEntity($entity);

    /** @var \Drupal\commerce_tax\Plugin\Field\FieldType\TaxNumberItemInterface $tax_number_item */
    $tax_number_item = $entity
      ->get('test_tax_number')
      ->first();

    // Confirm that the verification_state is not checked
    // if the type doesn't support verification.
    $this
      ->assertTrue($tax_number_item
      ->checkValue('other'));
  }

  /**
   * Tests the allowed countries setting.
   */
  public function testCountries() {
    $entity = EntityTest::create([
      'test_tax_number' => [
        'type' => 'other',
        'value' => '123',
      ],
    ]);
    $entity
      ->save();
    $entity = $this
      ->reloadEntity($entity);

    /** @var \Drupal\commerce_tax\Plugin\Field\FieldType\TaxNumberItemInterface $tax_number_item */
    $tax_number_item = $entity
      ->get('test_tax_number')
      ->first();

    // Unrestricted country list.
    $country_repository = $this->container
      ->get('address.country_repository');
    $country_list = $country_repository
      ->getList();
    $this
      ->assertEquals(array_keys($country_list), $tax_number_item
      ->getAllowedCountries());
    $this
      ->assertEquals([
      'european_union_vat',
      'other',
      'serbian_vat',
    ], $tax_number_item
      ->getAllowedTypes());

    // Restricted to the EU.
    $this->field
      ->setSetting('countries', [
      'EU',
    ]);
    $this->field
      ->save();
    $entity = $this
      ->reloadEntity($entity);

    /** @var \Drupal\commerce_tax\Plugin\Field\FieldType\TaxNumberItemInterface $tax_number_item */
    $tax_number_item = $entity
      ->get('test_tax_number')
      ->first();

    // Confirm that "EU" expands to the full list of EU countries.
    $this
      ->assertNotContains('EU', $tax_number_item
      ->getAllowedCountries());
    $this
      ->assertCount(29, $tax_number_item
      ->getAllowedCountries());
    $this
      ->assertEquals([
      'european_union_vat',
    ], $tax_number_item
      ->getAllowedTypes());

    // Restricted to EU + a non-EU country.
    $this->field
      ->setSetting('countries', [
      'EU',
      'US',
    ]);
    $this->field
      ->save();
    $entity = $this
      ->reloadEntity($entity);

    /** @var \Drupal\commerce_tax\Plugin\Field\FieldType\TaxNumberItemInterface $tax_number_item */
    $tax_number_item = $entity
      ->get('test_tax_number')
      ->first();

    // Confirm that "EU" expands to the full list of EU countries.
    $this
      ->assertNotContains('EU', $tax_number_item
      ->getAllowedCountries());
    $this
      ->assertContains('US', $tax_number_item
      ->getAllowedCountries());
    $this
      ->assertCount(30, $tax_number_item
      ->getAllowedCountries());
    $this
      ->assertEquals([
      'european_union_vat',
      'other',
    ], $tax_number_item
      ->getAllowedTypes());

    // Restricted to a non-EU country.
    $this->field
      ->setSetting('countries', [
      'US',
    ]);
    $this->field
      ->save();
    $entity = $this
      ->reloadEntity($entity);

    /** @var \Drupal\commerce_tax\Plugin\Field\FieldType\TaxNumberItemInterface $tax_number_item */
    $tax_number_item = $entity
      ->get('test_tax_number')
      ->first();
    $this
      ->assertEquals([
      'US',
    ], $tax_number_item
      ->getAllowedCountries());
    $this
      ->assertEquals([
      'other',
    ], $tax_number_item
      ->getAllowedTypes());
  }

  /**
   * Tests the validation.
   */
  public function testValidation() {
    $entity = EntityTest::create([
      'test_tax_number' => [
        'type' => 'other',
        'value' => 'MK1234567',
      ],
    ]);

    /** @var \Drupal\commerce_tax\Plugin\Field\FieldType\TaxNumberItemInterface $tax_number_item */
    $tax_number_item = $entity
      ->get('test_tax_number')
      ->first();

    // Fallback plugin, value always accepted (no validation/verification).
    $violations = $tax_number_item
      ->validate();
    $this
      ->assertCount(0, $violations);

    // Missing type.
    $tax_number_item
      ->setValue([
      'value' => 'MK1234567',
    ]);
    $violations = $tax_number_item
      ->validate();
    $this
      ->assertCount(1, $violations);
    $this
      ->assertEquals('type', $violations[0]
      ->getPropertyPath());
    $this
      ->assertEquals('This value should not be null.', $violations[0]
      ->getMessage());

    // Unrecognized type.
    $tax_number_item
      ->setValue([
      'type' => 'INVALID',
      'value' => 'MK1234567',
    ]);
    $violations = $tax_number_item
      ->validate();
    $this
      ->assertCount(1, $violations);
    $this
      ->assertEquals('type', $violations[0]
      ->getPropertyPath());
    $this
      ->assertEquals('Invalid type specified.', $violations[0]
      ->getMessage());

    // Unrecognized verification_state.
    $tax_number_item
      ->setValue([
      'type' => 'other',
      'value' => 'MK1234567',
      'verification_state' => 'INVALID',
    ]);
    $violations = $tax_number_item
      ->validate();
    $this
      ->assertCount(1, $violations);
    $this
      ->assertEquals('verification_state', $violations[0]
      ->getPropertyPath());
    $this
      ->assertEquals('Invalid verification_state specified.', $violations[0]
      ->getMessage());

    // Value too long.
    $entity
      ->set('test_tax_number', [
      'type' => 'serbian_vat',
      'value' => hash('sha512', 'TEST'),
    ]);

    /** @var \Drupal\commerce_tax\Plugin\Field\FieldType\TaxNumberItemInterface $tax_number_item */
    $tax_number_item = $entity
      ->get('test_tax_number')
      ->first();
    $expected_message = new FormattableMarkup('%name: may not be longer than 64 characters.', [
      '%name' => $this->field
        ->label(),
    ]);
    $violations = $tax_number_item
      ->validate();
    $this
      ->assertCount(1, $violations);
    $this
      ->assertEquals('value', $violations[0]
      ->getPropertyPath());
    $this
      ->assertEquals($expected_message
      ->__toString(), $violations[0]
      ->getMessage());

    // Invalid format.
    $tax_number_item
      ->setValue([
      'type' => 'serbian_vat',
      'value' => '1234',
    ]);
    $expected_message = new FormattableMarkup('%name is not in the right format. Example: 901.', [
      '%name' => $this->field
        ->label(),
    ]);
    $violations = $tax_number_item
      ->validate();
    $this
      ->assertCount(1, $violations);
    $this
      ->assertEquals('value', $violations[0]
      ->getPropertyPath());
    $this
      ->assertEquals($expected_message
      ->__toString(), $violations[0]
      ->getMessage());

    // Invalid format (verification failed).
    $tax_number_item
      ->setValue([
      'type' => 'serbian_vat',
      'value' => '402',
    ]);
    $expected_message = new FormattableMarkup('%name could not be verified.', [
      '%name' => $this->field
        ->label(),
    ]);
    $violations = $tax_number_item
      ->validate();
    $this
      ->assertCount(1, $violations);
    $this
      ->assertEquals('value', $violations[0]
      ->getPropertyPath());
    $this
      ->assertEquals($expected_message
      ->__toString(), $violations[0]
      ->getMessage());

    // Valid format (verification succeeded).
    $tax_number_item
      ->setValue([
      'type' => 'serbian_vat',
      'value' => '403',
    ]);
    $violations = $tax_number_item
      ->validate();
    $this
      ->assertCount(0, $violations);

    // Valid format (verification service unavailable).
    $tax_number_item
      ->setValue([
      'type' => 'serbian_vat',
      'value' => '190',
    ]);
    $violations = $tax_number_item
      ->validate();
    $this
      ->assertCount(0, $violations);

    // Verification required, verification service unavailable.
    $this->field
      ->setSetting('allow_unverified', FALSE);
    $this->field
      ->save();
    $entity = EntityTest::create([
      'test_tax_number' => [
        'type' => 'serbian_vat',
        'value' => '190',
      ],
    ]);

    /** @var \Drupal\commerce_tax\Plugin\Field\FieldType\TaxNumberItemInterface $tax_number_item */
    $tax_number_item = $entity
      ->get('test_tax_number')
      ->first();
    $expected_message = new FormattableMarkup('%name could not be verified.', [
      '%name' => $this->field
        ->label(),
    ]);
    $violations = $tax_number_item
      ->validate();
    $this
      ->assertCount(1, $violations);
    $this
      ->assertEquals('value', $violations[0]
      ->getPropertyPath());
    $this
      ->assertEquals($expected_message
      ->__toString(), $violations[0]
      ->getMessage());
  }

  /**
   * Tests the preSave() logic.
   */
  public function testPreSave() {

    // Verification failed.
    $entity = EntityTest::create([
      'test_tax_number' => [
        'type' => 'serbian_vat',
        'value' => '402',
      ],
    ]);
    $entity
      ->save();

    /** @var \Drupal\commerce_tax\Plugin\Field\FieldType\TaxNumberItemInterface $tax_number_item */
    $tax_number_item = $entity
      ->get('test_tax_number')
      ->first();
    $this
      ->assertEquals(VerificationResult::STATE_FAILURE, $tax_number_item->verification_state);
    $this
      ->assertEquals(\Drupal::time()
      ->getRequestTime(), $tax_number_item->verification_timestamp);
    $this
      ->assertEmpty($tax_number_item->verification_result);

    // Verification service unavailable.
    $tax_number_item
      ->setValue([
      'type' => 'serbian_vat',
      'value' => '190',
    ]);
    $entity
      ->save();
    $this
      ->assertEquals(VerificationResult::STATE_UNKNOWN, $tax_number_item->verification_state);
    $this
      ->assertEquals(\Drupal::time()
      ->getRequestTime(), $tax_number_item->verification_timestamp);
    $this
      ->assertEquals([
      'error' => 'http_429',
    ], $tax_number_item->verification_result);

    // Verification succeeded.
    $tax_number_item
      ->setValue([
      'type' => 'serbian_vat',
      'value' => '403',
    ]);
    $entity
      ->save();
    $this
      ->assertEquals(VerificationResult::STATE_SUCCESS, $tax_number_item->verification_state);
    $this
      ->assertEquals(\Drupal::time()
      ->getRequestTime(), $tax_number_item->verification_timestamp);
    $verification_result = $tax_number_item->verification_result;
    $this
      ->assertArrayHasKey('name', $verification_result);
    $this
      ->assertEquals('John Smith', $verification_result['name']);
    $original_nonce = $verification_result['nonce'];

    // Confirm that verification only runs once.
    $this->container
      ->get('entity.memory_cache')
      ->deleteAll();
    $entity
      ->save();

    /** @var \Drupal\commerce_tax\Plugin\Field\FieldType\TaxNumberItemInterface $tax_number_item */
    $tax_number_item = $entity
      ->get('test_tax_number')
      ->first();
    $this
      ->assertEquals($original_nonce, $tax_number_item->verification_result['nonce']);
  }

}

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
CommerceKernelTestBase::$store protected property The default store. 1
CommerceKernelTestBase::tearDown protected function Overrides KernelTestBase::tearDown
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.
DeprecatedServicePropertyTrait::__get public function Allows to access deprecated/removed properties.
DeprecationSuppressionTrait::restoreErrorHandler protected function Restores the original error handler.
DeprecationSuppressionTrait::setErrorHandler protected function Sets an error handler to suppress specified deprecation messages.
EntityKernelTestBase::$deprecatedProperties protected property The list of deprecated services.
EntityKernelTestBase::$entityTypeManager protected property The entity type manager service. 1
EntityKernelTestBase::$generatedIds protected property A list of generated identifiers.
EntityKernelTestBase::$state protected property The state service.
EntityKernelTestBase::createUser protected function Creates a user.
EntityKernelTestBase::generateRandomEntityId protected function Generates a random ID avoiding collisions.
EntityKernelTestBase::getHooksInfo protected function Returns the entity_test hook invocation info.
EntityKernelTestBase::installModule protected function Installs a module and refreshes services.
EntityKernelTestBase::refreshServices protected function Refresh services. 1
EntityKernelTestBase::reloadEntity protected function Reloads the given entity from the storage and returns it.
EntityKernelTestBase::uninstallModule protected function Uninstalls a module and refreshes services.
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::tearDownCloseDatabaseConnection public function @after
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
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.
StoreCreationTrait::createStore protected function Creates a store for the test.
TaxNumberItemTest::$field protected property A test field.
TaxNumberItemTest::$modules public static property Modules to enable. Overrides CommerceKernelTestBase::$modules
TaxNumberItemTest::setUp protected function Overrides CommerceKernelTestBase::setUp
TaxNumberItemTest::testCheckValue public function Tests checking whether value can be used for tax calculation.
TaxNumberItemTest::testCountries public function Tests the allowed countries setting.
TaxNumberItemTest::testField public function Tests the field.
TaxNumberItemTest::testPreSave public function Tests the preSave() logic.
TaxNumberItemTest::testValidation public function Tests the validation.
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.
UserCreationTrait::checkPermissions protected function Checks whether a given list of permission names is valid. Aliased as: drupalCheckPermissions
UserCreationTrait::createAdminRole protected function Creates an administrative role. Aliased as: drupalCreateAdminRole
UserCreationTrait::createRole protected function Creates a role with specified permissions. Aliased as: drupalCreateRole
UserCreationTrait::createUser protected function Create a user with a given set of permissions. Aliased as: drupalCreateUser
UserCreationTrait::grantPermissions protected function Grant permissions to a user role. Aliased as: drupalGrantPermissions
UserCreationTrait::setCurrentUser protected function Switch the current logged in user. Aliased as: drupalSetCurrentUser
UserCreationTrait::setUpCurrentUser protected function Creates a random user account and sets it as current user. Aliased as: drupalSetUpCurrentUser