class InvoiceConfirmationTest in Commerce Invoice 8.2
Tests the sending of multilingual invoice confirmation emails.
@group commerce_invoice
Hierarchy
- class \Drupal\KernelTests\KernelTestBase extends \PHPUnit\Framework\TestCase implements ServiceProviderInterface uses AssertContentTrait, AssertLegacyTrait, AssertHelperTrait, ConfigTestTrait, PhpunitCompatibilityTrait, RandomGeneratorTrait, TestRequirementsTrait
- class \Drupal\KernelTests\Core\Entity\EntityKernelTestBase uses DeprecatedServicePropertyTrait, UserCreationTrait
- class \Drupal\Tests\commerce\Kernel\CommerceKernelTestBase uses StoreCreationTrait, DeprecationSuppressionTrait
- class \Drupal\Tests\commerce_order\Kernel\OrderKernelTestBase
- class \Drupal\Tests\commerce_invoice\Kernel\InvoiceKernelTestBase
- class \Drupal\Tests\commerce_invoice\Kernel\InvoiceConfirmationTest uses AssertMailTrait
- class \Drupal\Tests\commerce_invoice\Kernel\InvoiceKernelTestBase
- class \Drupal\Tests\commerce_order\Kernel\OrderKernelTestBase
- class \Drupal\Tests\commerce\Kernel\CommerceKernelTestBase uses StoreCreationTrait, DeprecationSuppressionTrait
- class \Drupal\KernelTests\Core\Entity\EntityKernelTestBase uses DeprecatedServicePropertyTrait, UserCreationTrait
Expanded class hierarchy of InvoiceConfirmationTest
File
- tests/
src/ Kernel/ InvoiceConfirmationTest.php, line 22
Namespace
Drupal\Tests\commerce_invoice\KernelView source
class InvoiceConfirmationTest extends InvoiceKernelTestBase {
use AssertMailTrait;
/**
* A sample order.
*
* @var \Drupal\commerce_order\Entity\OrderInterface
*/
protected $order;
/**
* The profile.
*
* @var \Drupal\profile\Entity\Profile
*/
protected $profile;
/**
* A sample user.
*
* @var \Drupal\user\UserInterface
*/
protected $user;
/**
* Translated strings used in the invoice confirmation.
*
* @var array
*/
protected $translations = [
'fr' => [
'Invoice #@number' => 'Facture #@number',
'A new invoice has been created for you.' => 'Une nouvelle facture a été créée pour vous.',
'Default store' => 'Magasin par défaut',
],
'es' => [
'Invoice #@number' => 'Factura #@number',
'A new invoice has been created for you.' => 'Se ha creado una nueva factura para usted.',
'Default store' => 'Tienda por defecto',
],
];
/**
* {@inheritdoc}
*/
public static $modules = [
'language',
'locale',
'content_translation',
];
/**
* {@inheritdoc}
*/
protected function setUp() : void {
parent::setUp();
$this
->installConfig([
'language',
]);
$this
->installSchema('locale', [
'locales_source',
'locales_target',
'locales_location',
]);
foreach (array_keys($this->translations) as $langcode) {
ConfigurableLanguage::createFromLangcode($langcode)
->save();
}
// Provide the translated strings by overriding in-memory settings.
$settings = Settings::getAll();
foreach ($this->translations as $langcode => $custom_translation) {
foreach ($custom_translation as $untranslated => $translated) {
$settings['locale_custom_strings_' . $langcode][''][$untranslated] = $translated;
}
}
new Settings($settings);
/** @var \Drupal\commerce_price\CurrencyImporterInterface $currency_importer */
$currency_importer = $this->container
->get('commerce_price.currency_importer');
$currency_importer
->importTranslations(array_keys($this->translations));
/** @var \Drupal\language\ConfigurableLanguageManagerInterface $language_manager */
$language_manager = $this->container
->get('language_manager');
// The translated USD symbol is $US in both French and Spanish.
// Invent a new symbol translation for French, to test translations.
$fr_usd = $language_manager
->getLanguageConfigOverride('fr', 'commerce_price.commerce_currency.USD');
$fr_usd
->set('symbol', 'U$D');
$fr_usd
->save();
$this->store = $this
->reloadEntity($this->store);
$this->store
->addTranslation('es', [
'name' => $this->translations['es']['Default store'],
]);
$this->store
->addTranslation('fr', [
'name' => $this->translations['fr']['Default store'],
]);
$this->store
->save();
$user = $this
->createUser();
$this->user = $this
->reloadEntity($user);
$profile = Profile::create([
'type' => 'customer',
'address' => [
'country_code' => 'US',
'postal_code' => '53177',
'locality' => 'Milwaukee',
'address_line1' => 'Pabst Blue Ribbon Dr',
'administrative_area' => 'WI',
'given_name' => 'Frederick',
'family_name' => 'Pabst',
],
'uid' => $this->user
->id(),
]);
$profile
->save();
$this->profile = $this
->reloadEntity($profile);
$order_item = OrderItem::create([
'type' => 'test',
'quantity' => 1,
'title' => $this
->randomString(),
'unit_price' => new Price('12.00', 'USD'),
]);
$order_item
->save();
$this->order = Order::create([
'type' => 'default',
'mail' => $this->user
->getEmail(),
'state' => 'completed',
'store_id' => $this->store,
'billing_profile' => $this->profile,
'uid' => $this->user
->id(),
'order_items' => [
$order_item,
],
]);
$this->order
->save();
$this->order = $this
->reloadEntity($this->order);
}
/**
* Tests default disabled invoice confirmation.
*/
public function testInvoiceConfirmationDisabled() {
$invoice = Invoice::create([
'type' => 'default',
'mail' => $this->user
->getEmail(),
'invoice_number' => '10',
'orders' => [
$this->order,
],
'store_id' => $this->store
->id(),
'billing_profile' => $this->profile,
'uid' => $this->user
->id(),
]);
$invoice
->getState()
->applyTransitionById('confirm');
$invoice
->save();
// Confirm that pdf file has not been created for the invoice.
$this
->assertEmpty($invoice
->getFile());
$this
->assertCount(0, $this
->getMails());
}
/**
* Tests that the email is sent and translated to the customer's language.
*
* The email is sent in the customer's langcode if the user is not anonymous,
* otherwise it is the site's default langcode. In #2603482 this could
* be changed to use the invoice's langcode.
*
* @param string $langcode
* The langcode to test with.
* @param string $expected_langcode
* The expected langcode.
*
* @dataProvider providerInvoiceConfirmationMultilingualData
*/
public function testInvoiceConfirmation($langcode, $expected_langcode) {
$customer = $this->order
->getCustomer();
$customer
->set('preferred_langcode', $langcode);
$customer
->save();
$invoice_type = InvoiceType::load('default');
$invoice_type
->setSendConfirmation(TRUE);
$invoice_type
->setConfirmationBcc('bcc@example.com');
$invoice_type
->save();
if ($langcode) {
$config = ContentLanguageSettings::loadByEntityTypeBundle('commerce_invoice', 'default');
$config
->setDefaultLangcode($langcode);
$config
->setLanguageAlterable(FALSE);
$config
->save();
}
$invoice = Invoice::create([
'type' => 'default',
'mail' => $this->user
->getEmail(),
'invoice_number' => '10',
'orders' => [
$this->order,
],
'store_id' => $this->store
->id(),
'billing_profile' => $this->profile,
'state' => 'draft',
'uid' => $this->user
->id(),
]);
$invoice
->getState()
->applyTransitionById('confirm');
$invoice
->save();
$this->container
->get('commerce_invoice.invoice_confirmation_subscriber')
->destruct();
$invoice = $this
->reloadEntity($invoice);
if (isset($this->translations[$expected_langcode])) {
$strings = $this->translations[$expected_langcode];
}
else {
// Use the untranslated strings.
$strings = array_keys($this->translations['fr']);
$strings = array_combine($strings, $strings);
}
$subject = new FormattableMarkup($strings['Invoice #@number'], [
'@number' => $invoice
->getInvoiceNumber(),
]);
$emails = $this
->getMails();
$email = reset($emails);
$this
->assertEquals($invoice
->getEmail(), $email['to']);
$this
->assertEquals('bcc@example.com', $email['headers']['Bcc']);
$this
->assertEquals($expected_langcode, $email['langcode']);
$this
->assertEquals((string) $subject, $email['subject']);
$this
->assertStringContainsString('A new invoice has been created for you.', $email['body']);
$this
->assertNotEmpty($email['params']['attachments']);
// Confirm that pdf file has been created for the invoice.
$file = $invoice
->getFile();
$this
->assertNotEmpty($file);
$this
->assertRegExp('#private://(.*)\\.pdf#', $file
->getFileUri());
$this
->assertEquals('10-' . $expected_langcode . '-pending.pdf', $file
->getFilename());
$this
->assertEquals('application/pdf', $file
->getMimeType());
$attachments = $email['params']['attachments'];
$attachment = reset($attachments);
$this
->assertEquals($file
->getFileUri(), $attachment['filepath']);
}
/**
* Provides data for the multilingual email confirmation test.
*
* @return array
* The data.
*/
public function providerInvoiceConfirmationMultilingualData() {
return [
[
NULL,
'en',
],
[
'es',
'es',
],
[
'fr',
'fr',
],
[
'en',
'en',
],
];
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
AssertContentTrait:: |
protected | property | The current raw content. | |
AssertContentTrait:: |
protected | property | The drupalSettings value from the current raw $content. | |
AssertContentTrait:: |
protected | property | The XML structure parsed from the current raw $content. | 1 |
AssertContentTrait:: |
protected | property | The plain-text content of raw $content (text nodes). | |
AssertContentTrait:: |
protected | function | Passes if the raw text IS found escaped on the loaded page, fail otherwise. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists with the given name or ID. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists with the given ID and value. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists with the given name and value. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists in the current page by the given XPath. | |
AssertContentTrait:: |
protected | function | Asserts that a checkbox field in the current page is checked. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists in the current page with a given Xpath result. | |
AssertContentTrait:: |
protected | function | Passes if a link with the specified label is found. | |
AssertContentTrait:: |
protected | function | Passes if a link containing a given href (part) is found. | |
AssertContentTrait:: |
protected | function | Asserts that each HTML ID is used for just a single element. | |
AssertContentTrait:: |
protected | function | Passes if the raw text IS NOT found escaped on the loaded page, fail otherwise. | |
AssertContentTrait:: |
protected | function | Asserts that a field does not exist with the given name or ID. | |
AssertContentTrait:: |
protected | function | Asserts that a field does not exist with the given ID and value. | |
AssertContentTrait:: |
protected | function | Asserts that a field does not exist with the given name and value. | |
AssertContentTrait:: |
protected | function | Asserts that a field does not exist or its value does not match, by XPath. | |
AssertContentTrait:: |
protected | function | Asserts that a checkbox field in the current page is not checked. | |
AssertContentTrait:: |
protected | function | Passes if a link with the specified label is not found. | |
AssertContentTrait:: |
protected | function | Passes if a link containing a given href (part) is not found. | |
AssertContentTrait:: |
protected | function | Passes if a link containing a given href is not found in the main region. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page does not exist. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page is not checked. | |
AssertContentTrait:: |
protected | function | Triggers a pass if the perl regex pattern is not found in raw content. | |
AssertContentTrait:: |
protected | function | Passes if the raw text is NOT found on the loaded page, fail otherwise. | |
AssertContentTrait:: |
protected | function | Passes if the page (with HTML stripped) does not contains the text. | |
AssertContentTrait:: |
protected | function | Pass if the page title is not the given string. | |
AssertContentTrait:: |
protected | function | Passes if the text is found MORE THAN ONCE on the text version of the page. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page exists. | |
AssertContentTrait:: |
protected | function | Asserts that a select option with the visible text exists. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page is checked. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page is checked. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page exists. | |
AssertContentTrait:: |
protected | function | Triggers a pass if the Perl regex pattern is found in the raw content. | |
AssertContentTrait:: |
protected | function | Passes if the raw text IS found on the loaded page, fail otherwise. | |
AssertContentTrait:: |
protected | function | Passes if the page (with HTML stripped) contains the text. | |
AssertContentTrait:: |
protected | function | Helper for assertText and assertNoText. | |
AssertContentTrait:: |
protected | function | Asserts that a Perl regex pattern is found in the plain-text content. | |
AssertContentTrait:: |
protected | function | Asserts themed output. | |
AssertContentTrait:: |
protected | function | Pass if the page title is the given string. | |
AssertContentTrait:: |
protected | function | Passes if the text is found ONLY ONCE on the text version of the page. | |
AssertContentTrait:: |
protected | function | Helper for assertUniqueText and assertNoUniqueText. | |
AssertContentTrait:: |
protected | function | Builds an XPath query. | |
AssertContentTrait:: |
protected | function | Helper: Constructs an XPath for the given set of attributes and value. | |
AssertContentTrait:: |
protected | function | Searches elements using a CSS selector in the raw content. | |
AssertContentTrait:: |
protected | function | Get all option elements, including nested options, in a select. | |
AssertContentTrait:: |
protected | function | Gets the value of drupalSettings for the currently-loaded page. | |
AssertContentTrait:: |
protected | function | Gets the current raw content. | |
AssertContentTrait:: |
protected | function | Get the selected value from a select field. | |
AssertContentTrait:: |
protected | function | Retrieves the plain-text content from the current raw content. | |
AssertContentTrait:: |
protected | function | Get the current URL from the cURL handler. | 1 |
AssertContentTrait:: |
protected | function | Parse content returned from curlExec using DOM and SimpleXML. | |
AssertContentTrait:: |
protected | function | Removes all white-space between HTML tags from the raw content. | |
AssertContentTrait:: |
protected | function | Sets the value of drupalSettings for the currently-loaded page. | |
AssertContentTrait:: |
protected | function | Sets the raw content (e.g. HTML). | |
AssertContentTrait:: |
protected | function | Performs an xpath search on the contents of the internal browser. | |
AssertHelperTrait:: |
protected static | function | Casts MarkupInterface objects into strings. | |
AssertLegacyTrait:: |
protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead. | |
AssertLegacyTrait:: |
protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead. | |
AssertLegacyTrait:: |
protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertSame() instead. | |
AssertLegacyTrait:: |
protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead. | |
AssertLegacyTrait:: |
protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotEquals() instead. | |
AssertLegacyTrait:: |
protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotSame() instead. | |
AssertLegacyTrait:: |
protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead. | |
AssertLegacyTrait:: |
protected | function | ||
AssertMailTrait:: |
protected | function | Asserts that the most recently sent email message has the given value. | |
AssertMailTrait:: |
protected | function | Asserts that the most recently sent email message has the pattern in it. | |
AssertMailTrait:: |
protected | function | Asserts that the most recently sent email message has the string in it. | |
AssertMailTrait:: |
protected | function | Gets an array containing all emails sent during this test case. | |
AssertMailTrait:: |
protected | function | Outputs to verbose the most recent $count emails sent. | |
CommerceKernelTestBase:: |
protected | property | The default store. | 1 |
CommerceKernelTestBase:: |
protected | function |
Overrides KernelTestBase:: |
|
ConfigTestTrait:: |
protected | function | Returns a ConfigImporter object to import test configuration. | |
ConfigTestTrait:: |
protected | function | Copies configuration objects from source storage to target storage. | |
DeprecatedServicePropertyTrait:: |
public | function | Allows to access deprecated/removed properties. | |
DeprecationSuppressionTrait:: |
protected | function | Restores the original error handler. | |
DeprecationSuppressionTrait:: |
protected | function | Sets an error handler to suppress specified deprecation messages. | |
EntityKernelTestBase:: |
protected | property | The list of deprecated services. | |
EntityKernelTestBase:: |
protected | property | The entity type manager service. | 1 |
EntityKernelTestBase:: |
protected | property | A list of generated identifiers. | |
EntityKernelTestBase:: |
protected | property | The state service. | |
EntityKernelTestBase:: |
protected | function | Creates a user. | |
EntityKernelTestBase:: |
protected | function | Generates a random ID avoiding collisions. | |
EntityKernelTestBase:: |
protected | function | Returns the entity_test hook invocation info. | |
EntityKernelTestBase:: |
protected | function | Installs a module and refreshes services. | |
EntityKernelTestBase:: |
protected | function | Refresh services. | 1 |
EntityKernelTestBase:: |
protected | function | Reloads the given entity from the storage and returns it. | |
EntityKernelTestBase:: |
protected | function | Uninstalls a module and refreshes services. | |
InvoiceConfirmationTest:: |
public static | property |
Modules to enable. Overrides InvoiceKernelTestBase:: |
|
InvoiceConfirmationTest:: |
protected | property | A sample order. | |
InvoiceConfirmationTest:: |
protected | property | The profile. | |
InvoiceConfirmationTest:: |
protected | property | Translated strings used in the invoice confirmation. | |
InvoiceConfirmationTest:: |
protected | property | A sample user. | |
InvoiceConfirmationTest:: |
public | function | Provides data for the multilingual email confirmation test. | |
InvoiceConfirmationTest:: |
protected | function |
Overrides InvoiceKernelTestBase:: |
|
InvoiceConfirmationTest:: |
public | function | Tests that the email is sent and translated to the customer's language. | |
InvoiceConfirmationTest:: |
public | function | Tests default disabled invoice confirmation. | |
InvoiceKernelTestBase:: |
public | function |
Registers test-specific services. Overrides KernelTestBase:: |
|
KernelTestBase:: |
protected | property | Back up and restore any global variables that may be changed by tests. | |
KernelTestBase:: |
protected | property | Back up and restore static class properties that may be changed by tests. | |
KernelTestBase:: |
protected | property | Contains a few static class properties for performance. | |
KernelTestBase:: |
protected | property | ||
KernelTestBase:: |
protected | property | @todo Move into Config test base class. | 7 |
KernelTestBase:: |
protected static | property | An array of config object names that are excluded from schema checking. | |
KernelTestBase:: |
protected | property | ||
KernelTestBase:: |
protected | property | ||
KernelTestBase:: |
protected | property | Do not forward any global state from the parent process to the processes that run the actual tests. | |
KernelTestBase:: |
protected | property | The app root. | |
KernelTestBase:: |
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:: |
protected | property | ||
KernelTestBase:: |
protected | property | Set to TRUE to strict check all configuration saved. | 6 |
KernelTestBase:: |
protected | property | The virtual filesystem root directory. | |
KernelTestBase:: |
protected | function | 1 | |
KernelTestBase:: |
protected | function | Bootstraps a basic test environment. | |
KernelTestBase:: |
private | function | Bootstraps a kernel for a test. | |
KernelTestBase:: |
protected | function | Configuration accessor for tests. Returns non-overridden configuration. | |
KernelTestBase:: |
protected | function | Disables modules for this test. | |
KernelTestBase:: |
protected | function | Enables modules for this test. | |
KernelTestBase:: |
protected | function | Gets the config schema exclusions for this test. | |
KernelTestBase:: |
protected | function | Returns the Database connection info to be used for this test. | 1 |
KernelTestBase:: |
public | function | ||
KernelTestBase:: |
private | function | Returns Extension objects for $modules to enable. | |
KernelTestBase:: |
private static | function | Returns the modules to enable for this test. | |
KernelTestBase:: |
protected | function | Initializes the FileCache component. | |
KernelTestBase:: |
protected | function | Installs default configuration for a given list of modules. | |
KernelTestBase:: |
protected | function | Installs the storage schema for a specific entity type. | |
KernelTestBase:: |
protected | function | Installs database tables from a module schema definition. | |
KernelTestBase:: |
protected | function | Returns whether the current test method is running in a separate process. | |
KernelTestBase:: |
protected | function | ||
KernelTestBase:: |
protected | function | Renders a render array. | 1 |
KernelTestBase:: |
protected | function | Sets the install profile and rebuilds the container to update it. | |
KernelTestBase:: |
protected | function | Sets an in-memory Settings variable. | |
KernelTestBase:: |
public static | function | 1 | |
KernelTestBase:: |
protected | function | Sets up the filesystem, so things like the file directory. | 2 |
KernelTestBase:: |
protected | function | Stops test execution. | |
KernelTestBase:: |
public | function | @after | |
KernelTestBase:: |
protected | function | Dumps the current state of the virtual filesystem to STDOUT. | |
KernelTestBase:: |
public | function | Prevents serializing any properties. | |
PhpunitCompatibilityTrait:: |
public | function | Returns a mock object for the specified class using the available method. | |
PhpunitCompatibilityTrait:: |
public | function | Compatibility layer for PHPUnit 6 to support PHPUnit 4 code. | |
RandomGeneratorTrait:: |
protected | property | The random generator. | |
RandomGeneratorTrait:: |
protected | function | Gets the random generator for the utility methods. | |
RandomGeneratorTrait:: |
protected | function | Generates a unique random string containing letters and numbers. | 1 |
RandomGeneratorTrait:: |
public | function | Generates a random PHP object. | |
RandomGeneratorTrait:: |
public | function | Generates a pseudo-random string of ASCII characters of codes 32 to 126. | |
RandomGeneratorTrait:: |
public | function | Callback for random string validation. | |
StorageCopyTrait:: |
protected static | function | Copy the configuration from one storage to another and remove stale items. | |
StoreCreationTrait:: |
protected | function | Creates a store for the test. | |
TestRequirementsTrait:: |
private | function | Checks missing module requirements. | |
TestRequirementsTrait:: |
protected | function | Check module requirements for the Drupal use case. | 1 |
TestRequirementsTrait:: |
protected static | function | Returns the Drupal root directory. | |
UserCreationTrait:: |
protected | function | Checks whether a given list of permission names is valid. Aliased as: drupalCheckPermissions | |
UserCreationTrait:: |
protected | function | Creates an administrative role. Aliased as: drupalCreateAdminRole | |
UserCreationTrait:: |
protected | function | Creates a role with specified permissions. Aliased as: drupalCreateRole | |
UserCreationTrait:: |
protected | function | Create a user with a given set of permissions. Aliased as: drupalCreateUser | |
UserCreationTrait:: |
protected | function | Grant permissions to a user role. Aliased as: drupalGrantPermissions | |
UserCreationTrait:: |
protected | function | Switch the current logged in user. Aliased as: drupalSetCurrentUser | |
UserCreationTrait:: |
protected | function | Creates a random user account and sets it as current user. Aliased as: drupalSetUpCurrentUser |