Merge branch 'extract_emails_to_queue' into develop

This commit is contained in:
ErickSkrauch
2017-11-28 14:42:01 +03:00
31 changed files with 640 additions and 143 deletions

View File

@@ -2,6 +2,7 @@
## Env приложения ## Env приложения
YII_DEBUG=true YII_DEBUG=true
YII_ENV=dev YII_ENV=dev
DOMAIN=https://account.ely.by
## Параметры, отвечающие за безопасность ## Параметры, отвечающие за безопасность
JWT_USER_SECRET= JWT_USER_SECRET=

View File

@@ -4,13 +4,14 @@ namespace api\models\authentication;
use api\aop\annotations\CollectModelMetrics; use api\aop\annotations\CollectModelMetrics;
use api\components\ReCaptcha\Validator as ReCaptchaValidator; use api\components\ReCaptcha\Validator as ReCaptchaValidator;
use api\models\base\ApiForm; use api\models\base\ApiForm;
use common\emails\EmailHelper;
use common\helpers\Error as E; use common\helpers\Error as E;
use api\traits\AccountFinder; use api\traits\AccountFinder;
use common\components\UserFriendlyRandomKey; use common\components\UserFriendlyRandomKey;
use common\models\Account; use common\models\Account;
use common\models\confirmations\ForgotPassword; use common\models\confirmations\ForgotPassword;
use common\models\EmailActivation; use common\models\EmailActivation;
use common\tasks\SendPasswordRecoveryEmail;
use Yii;
use yii\base\ErrorException; use yii\base\ErrorException;
class ForgotPasswordForm extends ApiForm { class ForgotPasswordForm extends ApiForm {
@@ -80,7 +81,7 @@ class ForgotPasswordForm extends ApiForm {
throw new ErrorException('Cannot create email activation for forgot password form'); throw new ErrorException('Cannot create email activation for forgot password form');
} }
EmailHelper::forgotPassword($emailActivation); Yii::$app->queue->push(SendPasswordRecoveryEmail::createFromConfirmation($emailActivation));
return true; return true;
} }

View File

@@ -3,13 +3,13 @@ namespace api\models\authentication;
use api\aop\annotations\CollectModelMetrics; use api\aop\annotations\CollectModelMetrics;
use api\components\ReCaptcha\Validator as ReCaptchaValidator; use api\components\ReCaptcha\Validator as ReCaptchaValidator;
use common\emails\EmailHelper;
use api\models\base\ApiForm; use api\models\base\ApiForm;
use common\helpers\Error as E; use common\helpers\Error as E;
use common\components\UserFriendlyRandomKey; use common\components\UserFriendlyRandomKey;
use common\models\Account; use common\models\Account;
use common\models\confirmations\RegistrationConfirmation; use common\models\confirmations\RegistrationConfirmation;
use common\models\UsernameHistory; use common\models\UsernameHistory;
use common\tasks\SendRegistrationEmail;
use common\validators\EmailValidator; use common\validators\EmailValidator;
use common\validators\LanguageValidator; use common\validators\LanguageValidator;
use common\validators\PasswordValidator; use common\validators\PasswordValidator;
@@ -104,7 +104,7 @@ class RegistrationForm extends ApiForm {
throw new ErrorException('Cannot save username history record'); throw new ErrorException('Cannot save username history record');
} }
EmailHelper::registration($emailActivation); Yii::$app->queue->push(SendRegistrationEmail::createFromConfirmation($emailActivation));
$transaction->commit(); $transaction->commit();
} catch (Exception $e) { } catch (Exception $e) {

View File

@@ -3,15 +3,15 @@ namespace api\models\authentication;
use api\aop\annotations\CollectModelMetrics; use api\aop\annotations\CollectModelMetrics;
use api\components\ReCaptcha\Validator as ReCaptchaValidator; use api\components\ReCaptcha\Validator as ReCaptchaValidator;
use common\emails\EmailHelper; use api\exceptions\ThisShouldNotHappenException;
use api\models\base\ApiForm; use api\models\base\ApiForm;
use common\helpers\Error as E; use common\helpers\Error as E;
use common\components\UserFriendlyRandomKey; use common\components\UserFriendlyRandomKey;
use common\models\Account; use common\models\Account;
use common\models\confirmations\RegistrationConfirmation; use common\models\confirmations\RegistrationConfirmation;
use common\models\EmailActivation; use common\models\EmailActivation;
use common\tasks\SendRegistrationEmail;
use Yii; use Yii;
use yii\base\ErrorException;
class RepeatAccountActivationForm extends ApiForm { class RepeatAccountActivationForm extends ApiForm {
@@ -57,7 +57,6 @@ class RepeatAccountActivationForm extends ApiForm {
/** /**
* @CollectModelMetrics(prefix="signup.repeatEmail") * @CollectModelMetrics(prefix="signup.repeatEmail")
* @return bool * @return bool
* @throws ErrorException
*/ */
public function sendRepeatMessage() { public function sendRepeatMessage() {
if (!$this->validate()) { if (!$this->validate()) {
@@ -66,27 +65,25 @@ class RepeatAccountActivationForm extends ApiForm {
$account = $this->getAccount(); $account = $this->getAccount();
$transaction = Yii::$app->db->beginTransaction(); $transaction = Yii::$app->db->beginTransaction();
try {
EmailActivation::deleteAll([
'account_id' => $account->id,
'type' => EmailActivation::TYPE_REGISTRATION_EMAIL_CONFIRMATION,
]);
$activation = new RegistrationConfirmation(); EmailActivation::deleteAll([
$activation->account_id = $account->id; 'account_id' => $account->id,
$activation->key = UserFriendlyRandomKey::make(); 'type' => EmailActivation::TYPE_REGISTRATION_EMAIL_CONFIRMATION,
if (!$activation->save()) { ]);
throw new ErrorException('Unable save email-activation model.');
}
EmailHelper::registration($activation); $activation = new RegistrationConfirmation();
$activation->account_id = $account->id;
$transaction->commit(); $activation->key = UserFriendlyRandomKey::make();
} catch (ErrorException $e) { if (!$activation->save()) {
$transaction->rollBack(); throw new ThisShouldNotHappenException('Unable save email-activation model.');
throw $e;
} }
$this->emailActivation = $activation;
Yii::$app->queue->push(SendRegistrationEmail::createFromConfirmation($activation));
$transaction->commit();
return true; return true;
} }

View File

@@ -3,11 +3,11 @@ namespace api\modules\accounts\models;
use api\aop\annotations\CollectModelMetrics; use api\aop\annotations\CollectModelMetrics;
use api\exceptions\ThisShouldNotHappenException; use api\exceptions\ThisShouldNotHappenException;
use common\emails\EmailHelper;
use api\validators\PasswordRequiredValidator; use api\validators\PasswordRequiredValidator;
use common\helpers\Error as E; use common\helpers\Error as E;
use common\models\confirmations\CurrentEmailConfirmation; use common\models\confirmations\CurrentEmailConfirmation;
use common\models\EmailActivation; use common\models\EmailActivation;
use common\tasks\SendCurrentEmailConfirmation;
use Yii; use Yii;
class SendEmailVerificationForm extends AccountActionForm { class SendEmailVerificationForm extends AccountActionForm {
@@ -48,7 +48,7 @@ class SendEmailVerificationForm extends AccountActionForm {
$this->removeOldCode(); $this->removeOldCode();
$activation = $this->createCode(); $activation = $this->createCode();
EmailHelper::changeEmailConfirmCurrent($activation); Yii::$app->queue->push(SendCurrentEmailConfirmation::createFromConfirmation($activation));
$transaction->commit(); $transaction->commit();

View File

@@ -3,10 +3,10 @@ namespace api\modules\accounts\models;
use api\aop\annotations\CollectModelMetrics; use api\aop\annotations\CollectModelMetrics;
use api\exceptions\ThisShouldNotHappenException; use api\exceptions\ThisShouldNotHappenException;
use common\emails\EmailHelper;
use api\validators\EmailActivationKeyValidator; use api\validators\EmailActivationKeyValidator;
use common\models\confirmations\NewEmailConfirmation; use common\models\confirmations\NewEmailConfirmation;
use common\models\EmailActivation; use common\models\EmailActivation;
use common\tasks\SendNewEmailConfirmation;
use common\validators\EmailValidator; use common\validators\EmailValidator;
use Yii; use Yii;
@@ -39,7 +39,7 @@ class SendNewEmailVerificationForm extends AccountActionForm {
$activation = $this->createCode(); $activation = $this->createCode();
EmailHelper::changeEmailConfirmNew($activation); Yii::$app->queue->push(SendNewEmailConfirmation::createFromConfirmation($activation));
$transaction->commit(); $transaction->commit();

View File

@@ -25,6 +25,7 @@ class Yii extends \yii\BaseYii {
* @property \mito\sentry\Component $sentry * @property \mito\sentry\Component $sentry
* @property \api\components\OAuth2\Component $oauth * @property \api\components\OAuth2\Component $oauth
* @property \common\components\StatsD $statsd * @property \common\components\StatsD $statsd
* @property \yii\queue\Queue $queue
*/ */
abstract class BaseApplication extends yii\base\Application { abstract class BaseApplication extends yii\base\Application {
} }

View File

@@ -29,7 +29,7 @@ class EmailRenderer extends Component {
parent::__construct($config); parent::__construct($config);
if ($this->_baseDomain === null) { if ($this->_baseDomain === null) {
$this->_baseDomain = Yii::$app->request->getHostInfo(); $this->_baseDomain = Yii::$app->urlManager->getHostInfo();
if ($this->_baseDomain === null) { if ($this->_baseDomain === null) {
throw new InvalidConfigException('Cannot automatically obtain base domain'); throw new InvalidConfigException('Cannot automatically obtain base domain');
} }
@@ -51,7 +51,7 @@ class EmailRenderer extends Component {
* @param string $templateName * @param string $templateName
* @return TemplateBuilder * @return TemplateBuilder
*/ */
public function getTemplate(string $templateName) : TemplateBuilder { public function getTemplate(string $templateName): TemplateBuilder {
return $this->renderer->getTemplate($templateName); return $this->renderer->getTemplate($templateName);
} }
@@ -60,11 +60,11 @@ class EmailRenderer extends Component {
* @throws \Ely\Email\RendererException * @throws \Ely\Email\RendererException
* @return string * @return string
*/ */
public function render(TemplateBuilder $template) : string { public function render(TemplateBuilder $template): string {
return $this->renderer->render($template); return $this->renderer->render($template);
} }
private function buildBasePath() : string { private function buildBasePath(): string {
return $this->_baseDomain . $this->basePath; return $this->_baseDomain . $this->basePath;
} }

View File

@@ -96,6 +96,16 @@ return [
'port' => getenv('STATSD_PORT') ?: 8125, 'port' => getenv('STATSD_PORT') ?: 8125,
'namespace' => getenv('STATSD_NAMESPACE') ?: 'ely.accounts.' . gethostname() . '.app', 'namespace' => getenv('STATSD_NAMESPACE') ?: 'ely.accounts.' . gethostname() . '.app',
], ],
'queue' => [
'class' => yii\queue\amqp\Queue::class,
'host' => getenv('RABBITMQ_HOST') ?: 'rabbitmq',
'port' => getenv('RABBITMQ_PORT') ?: 5672,
'user' => getenv('RABBITMQ_USER'),
'password' => getenv('RABBITMQ_PASS'),
'vhost' => getenv('RABBITMQ_VHOST'),
'queueName' => 'worker',
'exchangeName' => 'tasks',
],
], ],
'container' => [ 'container' => [
'definitions' => [ 'definitions' => [

View File

@@ -1,56 +1,10 @@
<?php <?php
namespace common\emails; namespace common\emails;
use common\emails\templates\ChangeEmailConfirmCurrentEmail;
use common\emails\templates\ChangeEmailConfirmNewEmail;
use common\emails\templates\ForgotPasswordEmail;
use common\emails\templates\ForgotPasswordParams;
use common\emails\templates\RegistrationEmail;
use common\emails\templates\RegistrationEmailParams;
use common\models\Account;
use common\models\confirmations\CurrentEmailConfirmation;
use common\models\confirmations\ForgotPassword;
use common\models\confirmations\NewEmailConfirmation;
use common\models\confirmations\RegistrationConfirmation;
use Yii;
class EmailHelper { class EmailHelper {
public static function registration(RegistrationConfirmation $emailActivation): void { public static function buildTo(string $username, string $email): array {
$account = $emailActivation->account; return [$email => $username];
$locale = $account->lang;
$params = new RegistrationEmailParams(
$account->username,
$emailActivation->key,
Yii::$app->request->getHostInfo() . '/activation/' . $emailActivation->key
);
(new RegistrationEmail(self::buildTo($account), $locale, $params))->send();
}
public static function forgotPassword(ForgotPassword $emailActivation): void {
$account = $emailActivation->account;
$locale = $account->lang;
$params = new ForgotPasswordParams(
$account->username,
$emailActivation->key,
Yii::$app->request->getHostInfo() . '/recover-password/' . $emailActivation->key
);
(new ForgotPasswordEmail(self::buildTo($account), $locale, $params))->send();
}
public static function changeEmailConfirmCurrent(CurrentEmailConfirmation $emailActivation): void {
(new ChangeEmailConfirmCurrentEmail(self::buildTo($emailActivation->account), $emailActivation->key))->send();
}
public static function changeEmailConfirmNew(NewEmailConfirmation $emailActivation): void {
$account = $emailActivation->account;
(new ChangeEmailConfirmNewEmail(self::buildTo($account), $account->username, $emailActivation->key))->send();
}
public static function buildTo(Account $account): array {
return [$account->email => $account->username];
} }
} }

View File

@@ -0,0 +1,44 @@
<?php
declare(strict_types=1);
namespace common\tasks;
use common\emails\EmailHelper;
use common\emails\templates\ChangeEmailConfirmCurrentEmail;
use common\models\confirmations\CurrentEmailConfirmation;
use yii\queue\RetryableJobInterface;
class SendCurrentEmailConfirmation implements RetryableJobInterface {
public $email;
public $username;
public $code;
public static function createFromConfirmation(CurrentEmailConfirmation $confirmation): self {
$result = new self();
$result->email = $confirmation->account->email;
$result->username = $confirmation->account->username;
$result->code = $confirmation->key;
return $result;
}
public function getTtr() {
return 30;
}
public function canRetry($attempt, $error) {
return true;
}
/**
* @param \yii\queue\Queue $queue
*/
public function execute($queue) {
$to = EmailHelper::buildTo($this->username, $this->email);
$template = new ChangeEmailConfirmCurrentEmail($to, $this->code);
$template->send();
}
}

View File

@@ -0,0 +1,44 @@
<?php
declare(strict_types=1);
namespace common\tasks;
use common\emails\EmailHelper;
use common\emails\templates\ChangeEmailConfirmNewEmail;
use common\models\confirmations\NewEmailConfirmation;
use yii\queue\RetryableJobInterface;
class SendNewEmailConfirmation implements RetryableJobInterface {
public $email;
public $username;
public $code;
public static function createFromConfirmation(NewEmailConfirmation $confirmation): self {
$result = new self();
$result->email = $confirmation->getNewEmail();
$result->username = $confirmation->account->username;
$result->code = $confirmation->key;
return $result;
}
public function getTtr() {
return 30;
}
public function canRetry($attempt, $error) {
return true;
}
/**
* @param \yii\queue\Queue $queue
*/
public function execute($queue) {
$to = EmailHelper::buildTo($this->username, $this->email);
$template = new ChangeEmailConfirmNewEmail($to, $this->username, $this->code);
$template->send();
}
}

View File

@@ -0,0 +1,56 @@
<?php
declare(strict_types=1);
namespace common\tasks;
use common\emails\EmailHelper;
use common\emails\templates\ForgotPasswordEmail;
use common\emails\templates\ForgotPasswordParams;
use common\models\confirmations\ForgotPassword;
use Yii;
use yii\queue\RetryableJobInterface;
class SendPasswordRecoveryEmail implements RetryableJobInterface {
public $username;
public $email;
public $code;
public $link;
public $locale;
public static function createFromConfirmation(ForgotPassword $confirmation): self {
$account = $confirmation->account;
$result = new self();
$result->username = $account->username;
$result->email = $account->email;
$result->code = $confirmation->key;
$result->link = Yii::$app->request->getHostInfo() . '/recover-password/' . $confirmation->key;
$result->locale = $account->lang;
return $result;
}
public function getTtr() {
return 30;
}
public function canRetry($attempt, $error) {
return true;
}
/**
* @param \yii\queue\Queue $queue
* @throws \common\emails\exceptions\CannotSendEmailException
*/
public function execute($queue) {
$params = new ForgotPasswordParams($this->username, $this->code, $this->link);
$to = EmailHelper::buildTo($this->username, $this->email);
$template = new ForgotPasswordEmail($to, $this->locale, $params);
$template->send();
}
}

View File

@@ -0,0 +1,56 @@
<?php
declare(strict_types=1);
namespace common\tasks;
use common\emails\EmailHelper;
use common\emails\templates\RegistrationEmail;
use common\emails\templates\RegistrationEmailParams;
use common\models\confirmations\RegistrationConfirmation;
use Yii;
use yii\queue\RetryableJobInterface;
class SendRegistrationEmail implements RetryableJobInterface {
public $username;
public $email;
public $code;
public $link;
public $locale;
public static function createFromConfirmation(RegistrationConfirmation $confirmation): self {
$account = $confirmation->account;
$result = new self();
$result->username = $account->username;
$result->email = $account->email;
$result->code = $confirmation->key;
$result->link = Yii::$app->request->getHostInfo() . '/activation/' . $confirmation->key;
$result->locale = $account->lang;
return $result;
}
public function getTtr() {
return 30;
}
public function canRetry($attempt, $error) {
return true;
}
/**
* @param \yii\queue\Queue $queue
* @throws \common\emails\exceptions\CannotSendEmailException
*/
public function execute($queue) {
$params = new RegistrationEmailParams($this->username, $this->code, $this->link);
$to = EmailHelper::buildTo($this->username, $this->email);
$template = new RegistrationEmail($to, $this->locale, $params);
$template->send();
}
}

View File

@@ -25,7 +25,8 @@
"paragonie/constant_time_encoding": "^2.0", "paragonie/constant_time_encoding": "^2.0",
"webmozart/assert": "^1.2.0", "webmozart/assert": "^1.2.0",
"goaop/framework": "~2.1.2", "goaop/framework": "~2.1.2",
"domnikl/statsd": "^2.6" "domnikl/statsd": "^2.6",
"yiisoft/yii2-queue": "~2.0.1"
}, },
"require-dev": { "require-dev": {
"yiisoft/yii2-debug": "*", "yiisoft/yii2-debug": "*",

View File

@@ -1,13 +1,13 @@
<?php <?php
$params = array_merge( $params = array_merge(
require(__DIR__ . '/../../common/config/params.php'), require __DIR__ . '/../../common/config/params.php',
require(__DIR__ . '/params.php') require __DIR__ . '/params.php'
); );
return [ return [
'id' => 'accounts-console', 'id' => 'accounts-console',
'basePath' => dirname(__DIR__), 'basePath' => dirname(__DIR__),
'bootstrap' => ['log'], 'bootstrap' => ['log', 'queue'],
'controllerNamespace' => 'console\controllers', 'controllerNamespace' => 'console\controllers',
'params' => $params, 'params' => $params,
'components' => [ 'components' => [
@@ -23,10 +23,13 @@ return [
], ],
], ],
], ],
'urlManager' => [
'hostInfo' => getenv('DOMAIN') ?: 'https://account.ely.by',
],
], ],
'controllerMap' => [ 'controllerMap' => [
'migrate' => [ 'migrate' => [
'class' => yii\console\controllers\MigrateController::class, 'class' => yii\console\controllers\MigrateController::class,
'templateFile' => '@console/views/migration.php', 'templateFile' => '@console/views/migration.php',
], ],
], ],

View File

@@ -0,0 +1,6 @@
[program:account-queue-worker]
directory=/var/www/html
command=wait-for-it rabbitmq:5672 -- php yii queue/listen
autostart=true
autorestart=true
priority=10

View File

@@ -4,6 +4,7 @@ modules:
- Yii2: - Yii2:
part: [orm, email, fixtures] part: [orm, email, fixtures]
- tests\codeception\common\_support\amqp\Helper - tests\codeception\common\_support\amqp\Helper
- tests\codeception\common\_support\queue\CodeceptionQueueHelper
- tests\codeception\common\_support\Mockery - tests\codeception\common\_support\Mockery
config: config:
Yii2: Yii2:

View File

@@ -4,7 +4,9 @@ namespace codeception\api\unit\models\authentication;
use api\components\ReCaptcha\Validator as ReCaptchaValidator; use api\components\ReCaptcha\Validator as ReCaptchaValidator;
use api\models\authentication\ForgotPasswordForm; use api\models\authentication\ForgotPasswordForm;
use Codeception\Specify; use Codeception\Specify;
use common\models\Account;
use common\models\EmailActivation; use common\models\EmailActivation;
use common\tasks\SendPasswordRecoveryEmail;
use GuzzleHttp\ClientInterface; use GuzzleHttp\ClientInterface;
use tests\codeception\api\unit\TestCase; use tests\codeception\api\unit\TestCase;
use tests\codeception\common\fixtures\AccountFixture; use tests\codeception\common\fixtures\AccountFixture;
@@ -78,29 +80,41 @@ class ForgotPasswordFormTest extends TestCase {
} }
public function testForgotPassword() { public function testForgotPassword() {
$model = new ForgotPasswordForm(['login' => $this->tester->grabFixture('accounts', 'admin')['username']]); /** @var Account $account */
$account = $this->tester->grabFixture('accounts', 'admin');
$model = new ForgotPasswordForm(['login' => $account->username]);
$this->assertTrue($model->forgotPassword(), 'form should be successfully processed'); $this->assertTrue($model->forgotPassword(), 'form should be successfully processed');
$activation = $model->getEmailActivation(); $activation = $model->getEmailActivation();
$this->assertInstanceOf(EmailActivation::class, $activation, 'getEmailActivation should return valid object instance'); $this->assertInstanceOf(EmailActivation::class, $activation, 'getEmailActivation should return valid object instance');
$this->tester->canSeeEmailIsSent(1);
/** @var \yii\swiftmailer\Message $email */ $this->assertTaskCreated($this->tester->grabLastQueuedJob(), $account, $activation);
$email = $this->tester->grabSentEmails()[0];
$body = $email->getSwiftMessage()->getBody();
$this->assertContains($activation->key, $body);
$this->assertContains('/recover-password/' . $activation->key, $body);
} }
public function testForgotPasswordResend() { public function testForgotPasswordResend() {
$fixture = $this->tester->grabFixture('accounts', 'account-with-expired-forgot-password-message'); /** @var Account $account */
$model = new ForgotPasswordForm([ $account = $this->tester->grabFixture('accounts', 'account-with-expired-forgot-password-message');
'login' => $fixture['username'], $model = new ForgotPasswordForm(['login' => $account->username]);
]);
$callTime = time(); $callTime = time();
$this->assertTrue($model->forgotPassword(), 'form should be successfully processed'); $this->assertTrue($model->forgotPassword(), 'form should be successfully processed');
$emailActivation = $model->getEmailActivation(); $emailActivation = $model->getEmailActivation();
$this->assertInstanceOf(EmailActivation::class, $emailActivation); $this->assertInstanceOf(EmailActivation::class, $emailActivation);
$this->assertGreaterThanOrEqual($callTime, $emailActivation->created_at); $this->assertGreaterThanOrEqual($callTime, $emailActivation->created_at);
$this->tester->canSeeEmailIsSent(1);
$this->assertTaskCreated($this->tester->grabLastQueuedJob(), $account, $emailActivation);
}
/**
* @param SendPasswordRecoveryEmail $job
* @param Account $account
* @param EmailActivation $activation
*/
private function assertTaskCreated($job, Account $account, EmailActivation $activation) {
$this->assertInstanceOf(SendPasswordRecoveryEmail::class, $job);
$this->assertSame($account->username, $job->username);
$this->assertSame($account->email, $job->email);
$this->assertSame($account->lang, $job->locale);
$this->assertSame($activation->key, $job->code);
$this->assertSame('http://localhost/recover-password/' . $activation->key, $job->link);
} }
/** /**

View File

@@ -7,6 +7,7 @@ use Codeception\Specify;
use common\models\Account; use common\models\Account;
use common\models\EmailActivation; use common\models\EmailActivation;
use common\models\UsernameHistory; use common\models\UsernameHistory;
use common\tasks\SendRegistrationEmail;
use GuzzleHttp\ClientInterface; use GuzzleHttp\ClientInterface;
use tests\codeception\api\unit\TestCase; use tests\codeception\api\unit\TestCase;
use tests\codeception\common\fixtures\AccountFixture; use tests\codeception\common\fixtures\AccountFixture;
@@ -40,23 +41,19 @@ class RegistrationFormTest extends TestCase {
} }
public function testValidatePasswordAndRePasswordMatch() { public function testValidatePasswordAndRePasswordMatch() {
$this->specify('error.rePassword_does_not_match if password and rePassword not match', function() { $model = new RegistrationForm([
$model = new RegistrationForm([ 'password' => 'enough-length',
'password' => 'enough-length', 'rePassword' => 'but-mismatch',
'rePassword' => 'password', ]);
]); $this->assertFalse($model->validate(['rePassword']));
expect($model->validate(['rePassword']))->false(); $this->assertSame(['error.rePassword_does_not_match'], $model->getErrors('rePassword'));
expect($model->getErrors('rePassword'))->equals(['error.rePassword_does_not_match']);
});
$this->specify('no errors if password and rePassword match', function() { $model = new RegistrationForm([
$model = new RegistrationForm([ 'password' => 'enough-length',
'password' => 'enough-length', 'rePassword' => 'enough-length',
'rePassword' => 'enough-length', ]);
]); $this->assertTrue($model->validate(['rePassword']));
expect($model->validate(['rePassword']))->true(); $this->assertEmpty($model->getErrors('rePassword'));
expect($model->getErrors('rePassword'))->isEmpty();
});
} }
public function testSignup() { public function testSignup() {
@@ -118,12 +115,15 @@ class RegistrationFormTest extends TestCase {
'account_id' => $account->id, 'account_id' => $account->id,
'applied_in' => $account->created_at, 'applied_in' => $account->created_at,
])->exists(), 'username history record exists in database'); ])->exists(), 'username history record exists in database');
$this->tester->canSeeEmailIsSent(1);
/** @var \yii\swiftmailer\Message $email */ /** @var SendRegistrationEmail $job */
$email = $this->tester->grabSentEmails()[0]; $job = $this->tester->grabLastQueuedJob();
$body = $email->getSwiftMessage()->getBody(); $this->assertInstanceOf(SendRegistrationEmail::class, $job);
$this->assertContains($activation->key, $body); $this->assertSame($account->username, $job->username);
$this->assertContains('/activation/' . $activation->key, $body); $this->assertSame($account->email, $job->email);
$this->assertSame($account->lang, $job->locale);
$this->assertSame($activation->key, $job->code);
$this->assertSame('http://localhost/activation/' . $activation->key, $job->link);
} }
private function mockRequest($ip = '88.225.20.236') { private function mockRequest($ip = '88.225.20.236') {

View File

@@ -5,6 +5,7 @@ use api\components\ReCaptcha\Validator as ReCaptchaValidator;
use api\models\authentication\RepeatAccountActivationForm; use api\models\authentication\RepeatAccountActivationForm;
use Codeception\Specify; use Codeception\Specify;
use common\models\EmailActivation; use common\models\EmailActivation;
use common\tasks\SendRegistrationEmail;
use GuzzleHttp\ClientInterface; use GuzzleHttp\ClientInterface;
use tests\codeception\api\unit\TestCase; use tests\codeception\api\unit\TestCase;
use tests\codeception\common\fixtures\AccountFixture; use tests\codeception\common\fixtures\AccountFixture;
@@ -69,19 +70,24 @@ class RepeatAccountActivationFormTest extends TestCase {
} }
public function testSendRepeatMessage() { public function testSendRepeatMessage() {
$this->specify('no magic if we don\'t pass validation', function() { $model = new RepeatAccountActivationForm();
$model = new RepeatAccountActivationForm(); $this->assertFalse($model->sendRepeatMessage(), 'no magic if we don\'t pass validation');
expect($model->sendRepeatMessage())->false(); $this->assertEmpty($this->tester->grabQueueJobs());
$this->tester->cantSeeEmailIsSent();
});
$this->specify('successfully send new message if previous message has expired', function() { /** @var \common\models\Account $account */
$email = $this->tester->grabFixture('accounts', 'not-activated-account-with-expired-message')['email']; $account = $this->tester->grabFixture('accounts', 'not-activated-account-with-expired-message');
$model = new RepeatAccountActivationForm(['email' => $email]); $model = new RepeatAccountActivationForm(['email' => $account->email]);
expect($model->sendRepeatMessage())->true(); $this->assertTrue($model->sendRepeatMessage());
expect($model->getActivation())->notNull(); $activation = $model->getActivation();
$this->tester->canSeeEmailIsSent(1); $this->assertNotNull($activation);
}); /** @var SendRegistrationEmail $job */
$job = $this->tester->grabLastQueuedJob();
$this->assertInstanceOf(SendRegistrationEmail::class, $job);
$this->assertSame($account->username, $job->username);
$this->assertSame($account->email, $job->email);
$this->assertSame($account->lang, $job->locale);
$this->assertSame($activation->key, $job->code);
$this->assertSame('http://localhost/activation/' . $activation->key, $job->link);
} }
/** /**

View File

@@ -5,6 +5,7 @@ use api\modules\accounts\models\SendEmailVerificationForm;
use common\models\Account; use common\models\Account;
use common\models\confirmations\CurrentEmailConfirmation; use common\models\confirmations\CurrentEmailConfirmation;
use common\models\EmailActivation; use common\models\EmailActivation;
use common\tasks\SendCurrentEmailConfirmation;
use tests\codeception\api\unit\TestCase; use tests\codeception\api\unit\TestCase;
use tests\codeception\common\fixtures\AccountFixture; use tests\codeception\common\fixtures\AccountFixture;
use tests\codeception\common\fixtures\EmailActivationFixture; use tests\codeception\common\fixtures\EmailActivationFixture;
@@ -35,11 +36,19 @@ class SendEmailVerificationFormTest extends TestCase {
'password' => 'password_0', 'password' => 'password_0',
]); ]);
$this->assertTrue($model->performAction()); $this->assertTrue($model->performAction());
$this->assertTrue(EmailActivation::find()->andWhere([ /** @var EmailActivation $activation */
$activation = EmailActivation::findOne([
'account_id' => $account->id, 'account_id' => $account->id,
'type' => EmailActivation::TYPE_CURRENT_EMAIL_CONFIRMATION, 'type' => EmailActivation::TYPE_CURRENT_EMAIL_CONFIRMATION,
])->exists()); ]);
$this->tester->canSeeEmailIsSent(); $this->assertInstanceOf(EmailActivation::class, $activation);
/** @var SendCurrentEmailConfirmation $job */
$job = $this->tester->grabLastQueuedJob();
$this->assertInstanceOf(SendCurrentEmailConfirmation::class, $job);
$this->assertSame($account->username, $job->username);
$this->assertSame($account->email, $job->email);
$this->assertSame($activation->key, $job->code);
} }
} }

View File

@@ -5,6 +5,7 @@ use api\modules\accounts\models\SendNewEmailVerificationForm;
use common\models\Account; use common\models\Account;
use common\models\confirmations\NewEmailConfirmation; use common\models\confirmations\NewEmailConfirmation;
use common\models\EmailActivation; use common\models\EmailActivation;
use common\tasks\SendNewEmailConfirmation;
use tests\codeception\api\unit\TestCase; use tests\codeception\api\unit\TestCase;
use tests\codeception\common\fixtures\AccountFixture; use tests\codeception\common\fixtures\AccountFixture;
use tests\codeception\common\fixtures\EmailActivationFixture; use tests\codeception\common\fixtures\EmailActivationFixture;
@@ -44,11 +45,19 @@ class SendNewEmailVerificationFormTest extends TestCase {
Mock::func(EmailValidator::class, 'checkdnsrr')->andReturn(true); Mock::func(EmailValidator::class, 'checkdnsrr')->andReturn(true);
$this->assertTrue($model->performAction()); $this->assertTrue($model->performAction());
$this->assertNull(EmailActivation::findOne($key)); $this->assertNull(EmailActivation::findOne($key));
$this->assertNotNull(EmailActivation::findOne([ /** @var EmailActivation $activation */
$activation = EmailActivation::findOne([
'account_id' => $account->id, 'account_id' => $account->id,
'type' => EmailActivation::TYPE_NEW_EMAIL_CONFIRMATION, 'type' => EmailActivation::TYPE_NEW_EMAIL_CONFIRMATION,
])); ]);
$this->tester->canSeeEmailIsSent(); $this->assertNotNull(EmailActivation::class, $activation);
/** @var SendNewEmailConfirmation $job */
$job = $this->tester->grabLastQueuedJob();
$this->assertInstanceOf(SendNewEmailConfirmation::class, $job);
$this->assertSame($account->username, $job->username);
$this->assertSame('my-new-email@ely.by', $job->email);
$this->assertSame($activation->key, $job->code);
} }
} }

View File

@@ -0,0 +1,51 @@
<?php
namespace tests\codeception\common\_support\queue;
use Codeception\Exception\ModuleException;
use Codeception\Module;
use Codeception\Module\Yii2;
class CodeceptionQueueHelper extends Module {
/**
* Returns last sent message
*
* @return \yii\queue\JobInterface|null
*/
public function grabLastQueuedJob() {
$messages = $this->grabQueueJobs();
return end($messages);
}
/**
* Returns array of all sent amqp messages.
* Each message is `\PhpAmqpLib\Message\AMQPMessage` instance.
* Useful to perform additional checks using `Asserts` module.
*
* @param string|null $exchange
* @return \yii\queue\JobInterface[]
* @throws ModuleException
*/
public function grabQueueJobs() {
$amqp = $this->grabComponent('queue');
if (!$amqp instanceof Queue) {
throw new ModuleException($this, 'AMQP module is not mocked, can\'t test messages');
}
return $amqp->getMessages();
}
private function grabComponent(string $component) {
return $this->getYii2()->grabComponent($component);
}
private function getYii2(): Yii2 {
$yii2 = $this->getModule('Yii2');
if (!$yii2 instanceof Yii2) {
throw new ModuleException($this, 'Yii2 module must be configured');
}
return $yii2;
}
}

View File

@@ -0,0 +1,32 @@
<?php
namespace tests\codeception\common\_support\queue;
use yii\base\NotSupportedException;
use yii\queue\Queue as BaseQueue;
class Queue extends BaseQueue {
private $messages = [];
public function push($job) {
$this->messages[] = $job;
}
public function status($id) {
throw new NotSupportedException('Status is not supported in the driver.');
}
public function getMessages() {
return $this->messages;
}
protected function pushMessage($message, $ttr, $delay, $priority) {
// This function is abstract, but will be not called
}
public function __set($name, $value) {
// Yii2 components may contains some configuration
// But we just ignore it for this mock component
}
}

View File

@@ -2,17 +2,12 @@
namespace tests\codeception\common\unit\emails; namespace tests\codeception\common\unit\emails;
use common\emails\EmailHelper; use common\emails\EmailHelper;
use common\models\Account;
use tests\codeception\common\unit\TestCase; use tests\codeception\common\unit\TestCase;
class EmailHelperTest extends TestCase { class EmailHelperTest extends TestCase {
public function testBuildTo() { public function testBuildTo() {
/** @var Account|\Mockery\MockInterface $account */ $this->assertSame(['mock@ely.by' => 'username'], EmailHelper::buildTo('username', 'mock@ely.by'));
$account = mock(Account::class)->makePartial();
$account->username = 'mock-username';
$account->email = 'mock@ely.by';
$this->assertEquals(['mock@ely.by' => 'mock-username'], EmailHelper::buildTo($account));
} }
} }

View File

@@ -0,0 +1,47 @@
<?php
namespace tests\codeception\common\unit\tasks;
use common\models\Account;
use common\models\confirmations\CurrentEmailConfirmation;
use common\tasks\SendCurrentEmailConfirmation;
use tests\codeception\common\unit\TestCase;
use yii\queue\Queue;
class SendCurrentEmailConfirmationTest extends TestCase {
public function testCreateFromConfirmation() {
$account = new Account();
$account->username = 'mock-username';
$account->email = 'mock@ely.by';
$account->lang = 'id';
/** @var \Mockery\Mock|CurrentEmailConfirmation $confirmation */
$confirmation = mock(CurrentEmailConfirmation::class)->makePartial();
$confirmation->key = 'ABCDEFG';
$confirmation->shouldReceive('getAccount')->andReturn($account);
$result = SendCurrentEmailConfirmation::createFromConfirmation($confirmation);
$this->assertInstanceOf(SendCurrentEmailConfirmation::class, $result);
$this->assertSame('mock-username', $result->username);
$this->assertSame('mock@ely.by', $result->email);
$this->assertSame('ABCDEFG', $result->code);
}
public function testExecute() {
$task = new SendCurrentEmailConfirmation();
$task->username = 'mock-username';
$task->email = 'mock@ely.by';
$task->code = 'GFEDCBA';
$task->execute(mock(Queue::class));
$this->tester->canSeeEmailIsSent(1);
/** @var \yii\swiftmailer\Message $email */
$email = $this->tester->grabSentEmails()[0];
$this->assertSame(['mock@ely.by' => 'mock-username'], $email->getTo());
$this->assertSame('Ely.by Account change E-mail confirmation', $email->getSubject());
$children = $email->getSwiftMessage()->getChildren()[0];
$this->assertContains('GFEDCBA', $children->getBody());
}
}

View File

@@ -0,0 +1,47 @@
<?php
namespace tests\codeception\common\unit\tasks;
use common\models\Account;
use common\models\confirmations\NewEmailConfirmation;
use common\tasks\SendNewEmailConfirmation;
use tests\codeception\common\unit\TestCase;
use yii\queue\Queue;
class SendNewEmailConfirmationTest extends TestCase {
public function testCreateFromConfirmation() {
$account = new Account();
$account->username = 'mock-username';
$account->lang = 'id';
/** @var \Mockery\Mock|NewEmailConfirmation $confirmation */
$confirmation = mock(NewEmailConfirmation::class)->makePartial();
$confirmation->key = 'ABCDEFG';
$confirmation->shouldReceive('getAccount')->andReturn($account);
$confirmation->shouldReceive('getNewEmail')->andReturn('new-email@ely.by');
$result = SendNewEmailConfirmation::createFromConfirmation($confirmation);
$this->assertInstanceOf(SendNewEmailConfirmation::class, $result);
$this->assertSame('mock-username', $result->username);
$this->assertSame('new-email@ely.by', $result->email);
$this->assertSame('ABCDEFG', $result->code);
}
public function testExecute() {
$task = new SendNewEmailConfirmation();
$task->username = 'mock-username';
$task->email = 'mock@ely.by';
$task->code = 'GFEDCBA';
$task->execute(mock(Queue::class));
$this->tester->canSeeEmailIsSent(1);
/** @var \yii\swiftmailer\Message $email */
$email = $this->tester->grabSentEmails()[0];
$this->assertSame(['mock@ely.by' => 'mock-username'], $email->getTo());
$this->assertSame('Ely.by Account new E-mail confirmation', $email->getSubject());
$children = $email->getSwiftMessage()->getChildren()[0];
$this->assertContains('GFEDCBA', $children->getBody());
}
}

View File

@@ -0,0 +1,53 @@
<?php
namespace tests\codeception\common\unit\tasks;
use common\models\Account;
use common\models\confirmations\ForgotPassword;
use common\tasks\SendPasswordRecoveryEmail;
use tests\codeception\common\unit\TestCase;
use yii\queue\Queue;
class SendPasswordRecoveryEmailTest extends TestCase {
public function testCreateFromConfirmation() {
$account = new Account();
$account->username = 'mock-username';
$account->email = 'mock@ely.by';
$account->lang = 'id';
/** @var \Mockery\Mock|ForgotPassword $confirmation */
$confirmation = mock(ForgotPassword::class)->makePartial();
$confirmation->key = 'ABCDEFG';
$confirmation->shouldReceive('getAccount')->andReturn($account);
$result = SendPasswordRecoveryEmail::createFromConfirmation($confirmation);
$this->assertInstanceOf(SendPasswordRecoveryEmail::class, $result);
$this->assertSame('mock-username', $result->username);
$this->assertSame('mock@ely.by', $result->email);
$this->assertSame('ABCDEFG', $result->code);
$this->assertSame('http://localhost/recover-password/ABCDEFG', $result->link);
$this->assertSame('id', $result->locale);
}
public function testExecute() {
$task = new SendPasswordRecoveryEmail();
$task->username = 'mock-username';
$task->email = 'mock@ely.by';
$task->code = 'GFEDCBA';
$task->link = 'https://account.ely.by/recover-password/ABCDEFG';
$task->locale = 'ru';
$task->execute(mock(Queue::class));
$this->tester->canSeeEmailIsSent(1);
/** @var \yii\swiftmailer\Message $email */
$email = $this->tester->grabSentEmails()[0];
$this->assertSame(['mock@ely.by' => 'mock-username'], $email->getTo());
$this->assertSame('Ely.by Account forgot password', $email->getSubject());
$body = $email->getSwiftMessage()->getBody();
$this->assertContains('Привет, mock-username', $body);
$this->assertContains('GFEDCBA', $body);
$this->assertContains('https://account.ely.by/recover-password/ABCDEFG', $body);
}
}

View File

@@ -0,0 +1,53 @@
<?php
namespace tests\codeception\common\unit\tasks;
use common\models\Account;
use common\models\confirmations\RegistrationConfirmation;
use common\tasks\SendRegistrationEmail;
use tests\codeception\common\unit\TestCase;
use yii\queue\Queue;
class SendRegistrationEmailTest extends TestCase {
public function testCreateFromConfirmation() {
$account = new Account();
$account->username = 'mock-username';
$account->email = 'mock@ely.by';
$account->lang = 'ru';
/** @var \Mockery\Mock|RegistrationConfirmation $confirmation */
$confirmation = mock(RegistrationConfirmation::class)->makePartial();
$confirmation->key = 'ABCDEFG';
$confirmation->shouldReceive('getAccount')->andReturn($account);
$result = SendRegistrationEmail::createFromConfirmation($confirmation);
$this->assertInstanceOf(SendRegistrationEmail::class, $result);
$this->assertSame('mock-username', $result->username);
$this->assertSame('mock@ely.by', $result->email);
$this->assertSame('ABCDEFG', $result->code);
$this->assertSame('http://localhost/activation/ABCDEFG', $result->link);
$this->assertSame('ru', $result->locale);
}
public function testExecute() {
$task = new SendRegistrationEmail();
$task->username = 'mock-username';
$task->email = 'mock@ely.by';
$task->code = 'GFEDCBA';
$task->link = 'https://account.ely.by/activation/ABCDEFG';
$task->locale = 'ru';
$task->execute(mock(Queue::class));
$this->tester->canSeeEmailIsSent(1);
/** @var \yii\swiftmailer\Message $email */
$email = $this->tester->grabSentEmails()[0];
$this->assertSame(['mock@ely.by' => 'mock-username'], $email->getTo());
$this->assertSame('Ely.by Account registration', $email->getSubject());
$body = $email->getSwiftMessage()->getBody();
$this->assertContains('Привет, mock-username', $body);
$this->assertContains('GFEDCBA', $body);
$this->assertContains('https://account.ely.by/activation/ABCDEFG', $body);
}
}

View File

@@ -9,6 +9,9 @@ return [
'namespace' => 'tests\codeception\common\fixtures', 'namespace' => 'tests\codeception\common\fixtures',
], ],
], ],
'params' => [
'fromEmail' => 'ely@ely.by',
],
'components' => [ 'components' => [
'urlManager' => [ 'urlManager' => [
'showScriptName' => true, 'showScriptName' => true,
@@ -20,6 +23,9 @@ return [
'amqp' => [ 'amqp' => [
'class' => tests\codeception\common\_support\amqp\TestComponent::class, 'class' => tests\codeception\common\_support\amqp\TestComponent::class,
], ],
'queue' => [
'class' => tests\codeception\common\_support\queue\Queue::class,
],
'sentry' => [ 'sentry' => [
'enabled' => false, 'enabled' => false,
], ],