HiPoweredDev
/
CakeContactUs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

tests working with emails alsog

This commit is contained in:
Brandon Shipley 2025-11-10 23:51:18 -08:00
parent a659368867
commit f26aa9cbd3
Signed by: bmfs
GPG Key ID: 14E38571D8BB0DE4
11 changed files with 240 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/Controller/Component/ContactUsComponent.php
View File

@ -77,7 +77,7 @@ class ContactUsComponent extends Component
/**
* @return EntityInterface|ContactUsFormSubmission
*/
public function processContactUsForm(EntityInterface $contactUsFormSubmission, array $postData = null)
public function processContactUsForm(EntityInterface $contactUsFormSubmission, array|null $postData)
{
if (!isset($postData)) {
$postData = $this->getController()->getRequest()->getData();

8
src/Mailer/ContactUsFormSubmissionsMailer.php
View File

@ -22,10 +22,8 @@ class ContactUsFormSubmissionsMailer extends Mailer
protected function confirmation(EntityInterface $contactUsFormSubmission, array $options = [])
{
$name = isset($contactUsFormSubmission['name']) ? $contactUsFormSubmission['name'] . ', ' : '';
// un-hide the token to be able to send it in the email content
$subject = __d('cake_contact_us', 'We have received your message');
$this
->setTo($contactUsFormSubmission['email'])
->setSubject($name . $subject)
@ -46,13 +44,11 @@ class ContactUsFormSubmissionsMailer extends Mailer
*/
protected function backend(EntityInterface $contactUsFormSubmission, array $options = [])
{
$name = isset($contactUsFormSubmission['name']) ? ' by ' . $contactUsFormSubmission['name'] : '';
// un-hide the token to be able to send it in the email content
$subject = __d('cake_contact_us', 'Contact Us Form Submitted');
$name = isset($contactUsFormSubmission['name']) ? ' by ' . $contactUsFormSubmission['name'] : '';
$this
->setTo(Configure::readOrFail('ContactUs.email.backend.to'))
->setTo(Configure::readOrFail('ContactUs.fields.email.backend.to'))
->setSubject($subject . $name)
->setEmailFormat(Message::MESSAGE_BOTH)
->setViewVars([

4
src/Model/Table/ContactUsFormSubmissionsTable.php
View File

@ -134,7 +134,6 @@ class ContactUsFormSubmissionsTable extends Table
$this->getMailer($mailer)->send('confirmation', [$contactUsFormSubmission]);
$updateData['confirm_email_sent'] = $now;
} catch (CakeException $exception) {
}
}
@ -144,11 +143,8 @@ class ContactUsFormSubmissionsTable extends Table
$this->getMailer($mailer)->send('backend', [$contactUsFormSubmission]);
$updateData['backend_email_sent'] = $now;
} catch (CakeException $exception) {
}
}
Log::debug(print_r('$updateData', true));
Log::debug(print_r($updateData, true));
if ($updateData) {
$contactUsFormSubmission = $this->patchEntity($contactUsFormSubmission, $updateData, ['validate' => false]);
$this->saveOrFail($contactUsFormSubmission);

8
templates/email/html/backend.php
View File

@ -6,20 +6,21 @@ use Cake\Core\Configure;
* @var \CakeContactUs\Model\Entity\ContactUsFormSubmission $contactUsFormSubmission
*/
?>
<p>
<?= __d('cake_contact_us', "A contact us form submission was received at {0}", $contactUsFormSubmission->submitted_at) ?>,
</p>
<p>
<?= h($contactUsFormSubmission->name); ?>
</p>
<?php if (Configure::readOrFail('ContactUs.fields.email') || isset($contactUsFormSubmission->email)) : ?>
<?php if (Configure::read('ContactUs.fields.email', false) && isset($contactUsFormSubmission->email)) : ?>
<p>
<strong><?= __d('cake_contact_us', 'Email: ') ?></strong>
<?= $this->Html->link($contactUsFormSubmission->email, 'mailto:' . $contactUsFormSubmission->email); ?>
</p>
<?php endif; ?>
<?php if (Configure::readOrFail('ContactUs.fields.subject') || isset($contactUsFormSubmission->subject)) : ?>
<?php if (Configure::read('ContactUs.fields.subject', false) && isset($contactUsFormSubmission->subject)) : ?>
<p>
<strong><?= __d('cake_contact_us', 'Subject: ') ?></strong>
<span><?= h($contactUsFormSubmission->subject); ?></span>
@ -28,5 +29,4 @@ use Cake\Core\Configure;
<p>
<strong><?= __d('cake_contact_us', 'Message: ') ?></strong>
<?= h($contactUsFormSubmission->message); ?>
</p>
</p>

2
templates/email/html/confirmation.php
View File

@ -6,4 +6,4 @@
</p>
<p>
<?= __d('cake_contact_us', 'Thank you') ?>,
</p>
</p>

7
templates/email/text/backend.php
View File

@ -5,21 +5,22 @@ use Cake\Core\Configure;
/**
* @var \CakeContactUs\Model\Entity\ContactUsFormSubmission $contactUsFormSubmission
*/
?>
<?= __d('cake_contact_us', "A contact us form submission was received at {0}", $contactUsFormSubmission->submitted_at) ?>,
<?= __d('cake_contact_us', 'Name: ') ?><?= h($contactUsFormSubmission->name); ?>
<?php if (Configure::readOrFail('ContactUs.fields.email') || isset($contactUsFormSubmission->email)) : ?>
<?php if (Configure::read('ContactUs.fields.email', false) && isset($contactUsFormSubmission->email)) : ?>
<?= __d('cake_contact_us', 'Email: ') ?>
<?= $contactUsFormSubmission->email; ?>
<?php endif; ?>
<?php if (Configure::readOrFail('ContactUs.fields.subject') || isset($contactUsFormSubmission->subject)) : ?>
<?php if (Configure::read('ContactUs.fields.subject', false) && isset($contactUsFormSubmission->subject)) : ?>
<?= __d('cake_contact_us', 'Subject: ') ?>
<?= h($contactUsFormSubmission->subject); ?>
<?php endif; ?>
<?= __d('cake_contact_us', 'Message: ') ?>
<?= h($contactUsFormSubmission->message); ?>
<?= h($contactUsFormSubmission->message); ?>

3
templates/email/text/confirmation.php
View File

@ -9,9 +9,8 @@
* @license MIT License (http://www.opensource.org/licenses/mit-license.php)
*/
?>
<?= __d('cake_contact_us', "Hi {0}", isset($first_name) ? $first_name : '') ?>,
<?= __d('cake_contact_us', "Hi {0}", isset($contactUsFormSubmission->name) ? $contactUsFormSubmission->name : '') ?>,
<?= __d('cake_contact_us','We have received your message. We will be in touch soon.') ?>
<?= __d('cake_contact_us', 'Thank you') ?>,

25
templates/layout/email/html/default.php Normal file
View File

@ -0,0 +1,25 @@
<?php
/**
* CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
*
* Licensed under The MIT License
* For full copyright and license information, please see the LICENSE.txt
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
* @link https://cakephp.org CakePHP(tm) Project
* @since 0.10.0
* @license https://opensource.org/licenses/mit-license.php MIT License
* @var \App\View\AppView $this
*/
?>
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
<html>
<head>
<title><?= $this->fetch('title') ?></title>
</head>
<body>
<?= $this->fetch('content') ?>
</body>
</html>

17
templates/layout/email/text/default.php Normal file
View File

@ -0,0 +1,17 @@
<?php
/**
* CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
*
* Licensed under The MIT License
* For full copyright and license information, please see the LICENSE.txt
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
* @link https://cakephp.org CakePHP(tm) Project
* @since 0.10.0
* @license https://opensource.org/licenses/mit-license.php MIT License
* @var \App\View\AppView $this
*/
echo $this->fetch('content');

155
tests/TestCase/Controller/ContactUsFormSubmissionsControllerTest.php
View File

@ -5,10 +5,13 @@ namespace CakeContactUs\Test\TestCase\Controller;
use App\Model\Table\ContactUsFormSubmissionsTable;
use Cake\Controller\Controller;
use Cake\Core\Configure;
use Cake\Event\EventList;
use Cake\Event\EventManager;
use Cake\Http\ServerRequest;
use Cake\Mailer\Transport\DebugTransport;
use Cake\ORM\Table;
use Cake\TestSuite\EmailTrait;
use Cake\TestSuite\IntegrationTestTrait;
use Cake\TestSuite\TestCase;
use CakeContactUs\CakeContactUsPlugin;
@ -23,6 +26,7 @@ use PHPUnit\Exception;
class ContactUsFormSubmissionsControllerTest extends TestCase
{
use IntegrationTestTrait;
use EmailTrait;
/**
* @var ContactUsFormSubmissionsTable|Table
@ -87,6 +91,8 @@ class ContactUsFormSubmissionsControllerTest extends TestCase
$cntAfter = $this->ContactUsFormSubmissions->find()->count();
$this->assertEquals($cntBefore, $cntAfter);
$this->assertNoMailSent();
}
/**
@ -99,10 +105,59 @@ class ContactUsFormSubmissionsControllerTest extends TestCase
*
* @uses ContactUsFormSubmissionsController::add
*/
public function testAddPostSuccess(): void
public function testAddPostSuccessNoEmail(): void
{
$cntBefore = $this->ContactUsFormSubmissions->find()->count();
$url = [
'plugin' => 'CakeContactUs',
'controller' => 'ContactUsFormSubmissions',
'action' => 'add',
];
$data = [
'name' => 'valid name',
'email' => 'valid_email@test.com',
'message' => 'valid message goes here',
];
$this->post($url, $data);
$this->assertResponseCode(302);
$cntAfter = $this->ContactUsFormSubmissions->find()->count();
$this->assertEquals($cntBefore + 1, $cntAfter);
$this->assertEventFired(CakeContactUsPlugin::EVENT_AFTER_CONTACT_US_FORM_SAVED);
$this->assertNoMailSent();
}
/**
* Test add method
*
* Tests a POST request to the add action with a logged in user
*
* @return void
* @throws Exception
*
* @uses ContactUsFormSubmissionsController::add
*/
public function testAddPostSuccessBothEmailsSent(): void
{
Configure::write('ContactUs', [
'fields' => [
'captcha' => false,
'email' => [
'confirmation' => true,
'backend' => [
'to' => 'test@example.com',
],
],
],
]);
Configure::write('EmailTransport', [
'default' => [
'className' => DebugTransport::class,
]
]);
$cntBefore = $this->ContactUsFormSubmissions->find()->count();
$url = [
'plugin' => 'CakeContactUs',
'controller' => 'ContactUsFormSubmissions',
@ -119,6 +174,102 @@ class ContactUsFormSubmissionsControllerTest extends TestCase
$cntAfter = $this->ContactUsFormSubmissions->find()->count();
$this->assertEquals($cntBefore + 1, $cntAfter);
$this->assertEventFired(CakeContactUsPlugin::EVENT_AFTER_CONTACT_US_FORM_SAVED);
$this->assertMailCount(2); // confirmation + backend emails
}
/**
* Test add method
*
* Tests a POST request to the add action with a logged in user
*
* @return void
* @throws Exception
*
* @uses ContactUsFormSubmissionsController::add
*/
public function testAddPostSuccessConfirmationEmailSent(): void
{
Configure::write('ContactUs', [
'fields' => [
'captcha' => false,
'email' => [
'confirmation' => true,
'backend' => false,
],
],
]);
$cntBefore = $this->ContactUsFormSubmissions->find()->count();
$url = [
'plugin' => 'CakeContactUs',
'controller' => 'ContactUsFormSubmissions',
'action' => 'add',
];
$data = [
'name' => 'valid name',
'email' => 'valid_email@test.com',
'message' => 'valid message goes here',
];
$this->post($url, $data);
$this->assertResponseCode(302);
$cntAfter = $this->ContactUsFormSubmissions->find()->count();
$this->assertEquals($cntBefore + 1, $cntAfter);
$this->assertEventFired(CakeContactUsPlugin::EVENT_AFTER_CONTACT_US_FORM_SAVED);
$this->assertMailCount(1); // confirmation only
}
/**
* Test add method
*
* Tests a POST request to the add action with a logged in user
*
* @return void
* @throws Exception
*
* @uses ContactUsFormSubmissionsController::add
*/
public function testAddPostSuccessBackendEmailSent(): void
{
Configure::write('ContactUs', [
'fields' => [
'captcha' => false,
'email' => [
'confirmation' => false,
'backend' => [
'to' => 'test@example.com',
],
],
],
]);
$cntBefore = $this->ContactUsFormSubmissions->find()->count();
$url = [
'plugin' => 'CakeContactUs',
'controller' => 'ContactUsFormSubmissions',
'action' => 'add',
];
$data = [
'name' => 'valid name',
'email' => 'valid_email@test.com',
'message' => 'valid message goes here',
];
$this->post($url, $data);
$responseBody = (string)$this->_response->getBody();
$tmpLog = fopen(TMP . 'phpunit.log', 'w');
if ($tmpLog) {
fwrite($tmpLog, $responseBody);
}
$this->assertResponseCode(302);
$cntAfter = $this->ContactUsFormSubmissions->find()->count();
$this->assertEquals($cntBefore + 1, $cntAfter);
$this->assertEventFired(CakeContactUsPlugin::EVENT_AFTER_CONTACT_US_FORM_SAVED);
$this->assertMailCount(1); // backend email only
}
/**
@ -152,6 +303,6 @@ class ContactUsFormSubmissionsControllerTest extends TestCase
$cntAfter = $this->ContactUsFormSubmissions->find()->count();
$this->assertEquals($cntBefore, $cntAfter);
$this->assertEventFired(CakeContactUsPlugin::EVENT_BEFORE_CONTACT_US_FORM_SAVED);
$this->assertNoMailSent();
}
}

33
tests/bootstrap.php
View File

@ -7,6 +7,9 @@ use Cake\Core\Configure;
use Cake\Core\Plugin;
use Cake\Database\Connection;
use Cake\Datasource\ConnectionManager;
use Cake\Mailer\Mailer;
use Cake\Mailer\Transport\DebugTransport;
use Cake\Mailer\TransportFactory;
use Cake\TestSuite\Fixture\SchemaLoader;
use CakeContactUs\CakeContactUsPlugin;
use Migrations\TestSuite\Migrator;
@ -66,7 +69,34 @@ Configure::write('ContactUs', [
],
],
]);
Configure::write('EmailTransport', [
'default' => [
'className' => DebugTransport::class,
]
]);
TransportFactory::setConfig('default', [
'className' => DebugTransport::class,
]);
Configure::write('Email', [
/*
* Email delivery profiles
*
* Delivery profiles allow you to predefine various properties about email
* messages from your application and give the settings a name. This saves
* duplication across your application and makes maintenance and development
* easier. Each profile accepts a number of keys. See `Cake\Mailer\Email`
* for more information.
*/
'default' => [
'transport' => 'default',
'from' => 'test@example.com',
/*
* Will by default be set to config value of App.encoding, if that exists otherwise to UTF-8.
*/
//'charset' => 'utf-8',
//'headerCharset' => 'utf-8',
],
]);
$cache = [
'default' => [
'engine' => 'File',
@ -89,6 +119,7 @@ $cache = [
];
Cache::setConfig($cache);
Mailer::setConfig(Configure::consume('Email'));
class_alias(AppController::class, 'App\Controller\AppController');