diff --git a/api/models/authentication/RepeatAccountActivationForm.php b/api/models/authentication/RepeatAccountActivationForm.php index a56d226..9cbec46 100644 --- a/api/models/authentication/RepeatAccountActivationForm.php +++ b/api/models/authentication/RepeatAccountActivationForm.php @@ -78,6 +78,8 @@ class RepeatAccountActivationForm extends ApiForm { throw new ThisShouldNotHappenException('Unable save email-activation model.'); } + $this->emailActivation = $activation; + Yii::$app->queue->push(SendRegistrationEmail::createFromConfirmation($activation)); $transaction->commit(); diff --git a/common/tasks/SendCurrentEmailConfirmation.php b/common/tasks/SendCurrentEmailConfirmation.php index 3f5362a..55e96ef 100644 --- a/common/tasks/SendCurrentEmailConfirmation.php +++ b/common/tasks/SendCurrentEmailConfirmation.php @@ -1,4 +1,5 @@ $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'); $activation = $model->getEmailActivation(); $this->assertInstanceOf(EmailActivation::class, $activation, 'getEmailActivation should return valid object instance'); - $this->tester->canSeeEmailIsSent(1); - /** @var \yii\swiftmailer\Message $email */ - $email = $this->tester->grabSentEmails()[0]; - $body = $email->getSwiftMessage()->getBody(); - $this->assertContains($activation->key, $body); - $this->assertContains('/recover-password/' . $activation->key, $body); + + $this->assertTaskCreated($this->tester->grabLastQueuedJob(), $account, $activation); } public function testForgotPasswordResend() { - $fixture = $this->tester->grabFixture('accounts', 'account-with-expired-forgot-password-message'); - $model = new ForgotPasswordForm([ - 'login' => $fixture['username'], - ]); + /** @var Account $account */ + $account = $this->tester->grabFixture('accounts', 'account-with-expired-forgot-password-message'); + $model = new ForgotPasswordForm(['login' => $account->username]); $callTime = time(); $this->assertTrue($model->forgotPassword(), 'form should be successfully processed'); $emailActivation = $model->getEmailActivation(); $this->assertInstanceOf(EmailActivation::class, $emailActivation); $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); } /** diff --git a/tests/codeception/api/unit/models/authentication/RegistrationFormTest.php b/tests/codeception/api/unit/models/authentication/RegistrationFormTest.php index e957e74..bd76a40 100644 --- a/tests/codeception/api/unit/models/authentication/RegistrationFormTest.php +++ b/tests/codeception/api/unit/models/authentication/RegistrationFormTest.php @@ -7,6 +7,7 @@ use Codeception\Specify; use common\models\Account; use common\models\EmailActivation; use common\models\UsernameHistory; +use common\tasks\SendRegistrationEmail; use GuzzleHttp\ClientInterface; use tests\codeception\api\unit\TestCase; use tests\codeception\common\fixtures\AccountFixture; @@ -40,23 +41,19 @@ class RegistrationFormTest extends TestCase { } public function testValidatePasswordAndRePasswordMatch() { - $this->specify('error.rePassword_does_not_match if password and rePassword not match', function() { - $model = new RegistrationForm([ - 'password' => 'enough-length', - 'rePassword' => 'password', - ]); - expect($model->validate(['rePassword']))->false(); - expect($model->getErrors('rePassword'))->equals(['error.rePassword_does_not_match']); - }); + $model = new RegistrationForm([ + 'password' => 'enough-length', + 'rePassword' => 'but-mismatch', + ]); + $this->assertFalse($model->validate(['rePassword'])); + $this->assertSame(['error.rePassword_does_not_match'], $model->getErrors('rePassword')); - $this->specify('no errors if password and rePassword match', function() { - $model = new RegistrationForm([ - 'password' => 'enough-length', - 'rePassword' => 'enough-length', - ]); - expect($model->validate(['rePassword']))->true(); - expect($model->getErrors('rePassword'))->isEmpty(); - }); + $model = new RegistrationForm([ + 'password' => 'enough-length', + 'rePassword' => 'enough-length', + ]); + $this->assertTrue($model->validate(['rePassword'])); + $this->assertEmpty($model->getErrors('rePassword')); } public function testSignup() { @@ -118,12 +115,15 @@ class RegistrationFormTest extends TestCase { 'account_id' => $account->id, 'applied_in' => $account->created_at, ])->exists(), 'username history record exists in database'); - $this->tester->canSeeEmailIsSent(1); - /** @var \yii\swiftmailer\Message $email */ - $email = $this->tester->grabSentEmails()[0]; - $body = $email->getSwiftMessage()->getBody(); - $this->assertContains($activation->key, $body); - $this->assertContains('/activation/' . $activation->key, $body); + + /** @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); } private function mockRequest($ip = '88.225.20.236') { diff --git a/tests/codeception/api/unit/models/authentication/RepeatAccountActivationFormTest.php b/tests/codeception/api/unit/models/authentication/RepeatAccountActivationFormTest.php index 23acf22..6dbebb1 100644 --- a/tests/codeception/api/unit/models/authentication/RepeatAccountActivationFormTest.php +++ b/tests/codeception/api/unit/models/authentication/RepeatAccountActivationFormTest.php @@ -5,6 +5,7 @@ use api\components\ReCaptcha\Validator as ReCaptchaValidator; use api\models\authentication\RepeatAccountActivationForm; use Codeception\Specify; use common\models\EmailActivation; +use common\tasks\SendRegistrationEmail; use GuzzleHttp\ClientInterface; use tests\codeception\api\unit\TestCase; use tests\codeception\common\fixtures\AccountFixture; @@ -69,19 +70,24 @@ class RepeatAccountActivationFormTest extends TestCase { } public function testSendRepeatMessage() { - $this->specify('no magic if we don\'t pass validation', function() { - $model = new RepeatAccountActivationForm(); - expect($model->sendRepeatMessage())->false(); - $this->tester->cantSeeEmailIsSent(); - }); + $model = new RepeatAccountActivationForm(); + $this->assertFalse($model->sendRepeatMessage(), 'no magic if we don\'t pass validation'); + $this->assertEmpty($this->tester->grabQueueJobs()); - $this->specify('successfully send new message if previous message has expired', function() { - $email = $this->tester->grabFixture('accounts', 'not-activated-account-with-expired-message')['email']; - $model = new RepeatAccountActivationForm(['email' => $email]); - expect($model->sendRepeatMessage())->true(); - expect($model->getActivation())->notNull(); - $this->tester->canSeeEmailIsSent(1); - }); + /** @var \common\models\Account $account */ + $account = $this->tester->grabFixture('accounts', 'not-activated-account-with-expired-message'); + $model = new RepeatAccountActivationForm(['email' => $account->email]); + $this->assertTrue($model->sendRepeatMessage()); + $activation = $model->getActivation(); + $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); } /** diff --git a/tests/codeception/api/unit/modules/accounts/models/SendEmailVerificationFormTest.php b/tests/codeception/api/unit/modules/accounts/models/SendEmailVerificationFormTest.php index 4a34e36..dbee640 100644 --- a/tests/codeception/api/unit/modules/accounts/models/SendEmailVerificationFormTest.php +++ b/tests/codeception/api/unit/modules/accounts/models/SendEmailVerificationFormTest.php @@ -5,6 +5,7 @@ use api\modules\accounts\models\SendEmailVerificationForm; use common\models\Account; use common\models\confirmations\CurrentEmailConfirmation; use common\models\EmailActivation; +use common\tasks\SendCurrentEmailConfirmation; use tests\codeception\api\unit\TestCase; use tests\codeception\common\fixtures\AccountFixture; use tests\codeception\common\fixtures\EmailActivationFixture; @@ -35,11 +36,19 @@ class SendEmailVerificationFormTest extends TestCase { 'password' => 'password_0', ]); $this->assertTrue($model->performAction()); - $this->assertTrue(EmailActivation::find()->andWhere([ + /** @var EmailActivation $activation */ + $activation = EmailActivation::findOne([ 'account_id' => $account->id, '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); } } diff --git a/tests/codeception/api/unit/modules/accounts/models/SendNewEmailVerificationFormTest.php b/tests/codeception/api/unit/modules/accounts/models/SendNewEmailVerificationFormTest.php index 0802019..addee2c 100644 --- a/tests/codeception/api/unit/modules/accounts/models/SendNewEmailVerificationFormTest.php +++ b/tests/codeception/api/unit/modules/accounts/models/SendNewEmailVerificationFormTest.php @@ -5,6 +5,7 @@ use api\modules\accounts\models\SendNewEmailVerificationForm; use common\models\Account; use common\models\confirmations\NewEmailConfirmation; use common\models\EmailActivation; +use common\tasks\SendNewEmailConfirmation; use tests\codeception\api\unit\TestCase; use tests\codeception\common\fixtures\AccountFixture; use tests\codeception\common\fixtures\EmailActivationFixture; @@ -44,11 +45,19 @@ class SendNewEmailVerificationFormTest extends TestCase { Mock::func(EmailValidator::class, 'checkdnsrr')->andReturn(true); $this->assertTrue($model->performAction()); $this->assertNull(EmailActivation::findOne($key)); - $this->assertNotNull(EmailActivation::findOne([ + /** @var EmailActivation $activation */ + $activation = EmailActivation::findOne([ 'account_id' => $account->id, '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); } } diff --git a/tests/codeception/common/_support/queue/CodeceptionQueueHelper.php b/tests/codeception/common/_support/queue/CodeceptionQueueHelper.php new file mode 100644 index 0000000..8878ea3 --- /dev/null +++ b/tests/codeception/common/_support/queue/CodeceptionQueueHelper.php @@ -0,0 +1,51 @@ +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; + } + +} diff --git a/tests/codeception/common/_support/queue/Queue.php b/tests/codeception/common/_support/queue/Queue.php new file mode 100644 index 0000000..169da26 --- /dev/null +++ b/tests/codeception/common/_support/queue/Queue.php @@ -0,0 +1,32 @@ +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 + } + +} diff --git a/tests/codeception/common/unit/emails/EmailHelperTest.php b/tests/codeception/common/unit/emails/EmailHelperTest.php index 9b9d011..0f1f62d 100644 --- a/tests/codeception/common/unit/emails/EmailHelperTest.php +++ b/tests/codeception/common/unit/emails/EmailHelperTest.php @@ -2,17 +2,12 @@ namespace tests\codeception\common\unit\emails; use common\emails\EmailHelper; -use common\models\Account; use tests\codeception\common\unit\TestCase; class EmailHelperTest extends TestCase { public function testBuildTo() { - /** @var Account|\Mockery\MockInterface $account */ - $account = mock(Account::class)->makePartial(); - $account->username = 'mock-username'; - $account->email = 'mock@ely.by'; - $this->assertEquals(['mock@ely.by' => 'mock-username'], EmailHelper::buildTo($account)); + $this->assertSame(['mock@ely.by' => 'username'], EmailHelper::buildTo('username', 'mock@ely.by')); } } diff --git a/tests/codeception/common/unit/tasks/SendCurrentEmailConfirmationTest.php b/tests/codeception/common/unit/tasks/SendCurrentEmailConfirmationTest.php new file mode 100644 index 0000000..eb81b0a --- /dev/null +++ b/tests/codeception/common/unit/tasks/SendCurrentEmailConfirmationTest.php @@ -0,0 +1,47 @@ +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()); + } + +} diff --git a/tests/codeception/common/unit/tasks/SendNewEmailConfirmationTest.php b/tests/codeception/common/unit/tasks/SendNewEmailConfirmationTest.php new file mode 100644 index 0000000..a0fcb12 --- /dev/null +++ b/tests/codeception/common/unit/tasks/SendNewEmailConfirmationTest.php @@ -0,0 +1,47 @@ +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()); + } + +} diff --git a/tests/codeception/common/unit/tasks/SendPasswordRecoveryEmailTest.php b/tests/codeception/common/unit/tasks/SendPasswordRecoveryEmailTest.php new file mode 100644 index 0000000..b7c887b --- /dev/null +++ b/tests/codeception/common/unit/tasks/SendPasswordRecoveryEmailTest.php @@ -0,0 +1,53 @@ +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); + } + +} diff --git a/tests/codeception/common/unit/tasks/SendRegistrationEmailTest.php b/tests/codeception/common/unit/tasks/SendRegistrationEmailTest.php new file mode 100644 index 0000000..41ace9b --- /dev/null +++ b/tests/codeception/common/unit/tasks/SendRegistrationEmailTest.php @@ -0,0 +1,53 @@ +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); + } + +} diff --git a/tests/codeception/config/config.php b/tests/codeception/config/config.php index edd34d4..78b097c 100644 --- a/tests/codeception/config/config.php +++ b/tests/codeception/config/config.php @@ -9,6 +9,9 @@ return [ 'namespace' => 'tests\codeception\common\fixtures', ], ], + 'params' => [ + 'fromEmail' => 'ely@ely.by', + ], 'components' => [ 'urlManager' => [ 'showScriptName' => true, @@ -20,6 +23,9 @@ return [ 'amqp' => [ 'class' => tests\codeception\common\_support\amqp\TestComponent::class, ], + 'queue' => [ + 'class' => tests\codeception\common\_support\queue\Queue::class, + ], 'sentry' => [ 'enabled' => false, ],