MC-38122: Admin: New user notification email: Custom template not picked up

Author: victor-v-rad

app/code/Magento/User/etc/adminhtml/system.xml

@@ -14,6 +14,11 @@
                     <comment>Email template chosen based on theme fallback when "Default" option is selected.</comment>
                     <source_model>Magento\Config\Model\Config\Source\Email\Template</source_model>
                 </field>
+                <field id="new_user_notification_template" translate="label comment" type="select" sortOrder="50" showInDefault="1" canRestore="1">
+                    <label>New User Notification Template</label>
+                    <comment>Email template chosen based on theme fallback when "Default" option is selected.</comment>
+                    <source_model>Magento\Config\Model\Config\Source\Email\Template</source_model>
+                </field>
             </group>
             <group id="security">
                 <field id="lockout_failures" translate="label comment" sortOrder="100" showInDefault="1" canRestore="1">

dev/tests/integration/testsuite/Magento/Email/Model/_files/email_template_new_user_notification.php

@@ -0,0 +1,19 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+$objectManager = \Magento\TestFramework\Helper\Bootstrap::getObjectManager();
+/** @var \Magento\Email\Model\Template $template */
+$template = $objectManager->create(\Magento\Email\Model\Template::class);
+$template->setOptions(['area' => 'test area', 'store' => 1]);
+$template->setData(
+    [
+        'template_text' => 'New User Notification Custom Text',
+        'template_code' => 'New User Notification Custom Code',
+        'template_type' => \Magento\Email\Model\Template::TYPE_TEXT,
+        'orig_template_code' => 'admin_emails_new_user_notification_template'
+    ]
+);
+$template->save();

dev/tests/integration/testsuite/Magento/User/Model/UserTest.php

@@ -13,6 +13,11 @@
 use Magento\Framework\Stdlib\DateTime;
 use Magento\TestFramework\Helper\Bootstrap;
 use Magento\User\Model\User as UserModel;
+use Magento\Email\Model\ResourceModel\Template\Collection as TemplateCollection;
+use Magento\Framework\Exception\NotFoundException;
+use Magento\Framework\Phrase;
+use Magento\Framework\App\Config\MutableScopeConfigInterface;
+use Magento\TestFramework\Mail\Template\TransportBuilderMock;
 
 /**
  * @magentoAppArea adminhtml
@@ -565,4 +570,68 @@ public function testPerformIdentityCheckLockExpires()
             . 'Please wait and try again later.'
         );
     }
+
+    /**
+     * Verify custom notification is sent when new user created
+     *
+     * @magentoDbIsolation enabled
+     * @magentoDataFixture Magento/Email/Model/_files/email_template_new_user_notification.php
+     */
+    public function testSendNotificationEmailsIfRequired()
+    {
+        /** @var MutableScopeConfigInterface $config */
+        $config = Bootstrap::getObjectManager()->get(MutableScopeConfigInterface::class);
+        $config->setValue(
+            'admin/emails/new_user_notification_template',
+            $this->getCustomEmailTemplateIdForNewUserNotification()
+        );
+        $userModel = Bootstrap::getObjectManager()->create(
+            \Magento\User\Model\User::class
+        );
+        $userModel->setFirstname(
+            'John'
+        )->setLastname(
+            'Doe'
+        )->setUsername(
+            'user2'
+        )->setPassword(
+            \Magento\TestFramework\Bootstrap::ADMIN_PASSWORD
+        )->setEmail(
+            'user@magento.com'
+        );
+        $userModel->save();
+        $userModel->sendNotificationEmailsIfRequired();
+        /** @var TransportBuilderMock $transportBuilderMock */
+        $transportBuilderMock = Bootstrap::getObjectManager()->get(TransportBuilderMock::class);
+        $sentMessage = $transportBuilderMock->getSentMessage();
+        $this->assertSame(
+            'New User Notification Custom Text',
+            $sentMessage->getBodyText()
+        );
+    }
+
+    /**
+     * Return email template id for new user notification
+     *
+     * @return int|null
+     * @throws NotFoundException
+     */
+    private function getCustomEmailTemplateIdForNewUserNotification(): ?int
+    {
+        $templateId = null;
+        $templateCollection = Bootstrap::getObjectManager()->get(TemplateCollection::class);
+        $origTemplateCode = 'admin_emails_new_user_notification_template';
+        foreach ($templateCollection as $template) {
+            if ($template->getOrigTemplateCode() == $origTemplateCode) {
+                $templateId = (int) $template->getId();
+            }
+        }
+        if ($templateId === null) {
+            throw new NotFoundException(new Phrase(
+                'Customized %templateCode% email template not found',
+                ['templateCode' => $origTemplateCode]
+            ));
+        }
+        return $templateId;
+    }
 }