ElyBy-Mirror/accounts
1
0
Fork 0
mirror of https://github.com/elyby/accounts.git synced 2024-12-25 06:39:46 +05:30
Code Issues Packages Projects Releases Wiki Activity

Подрефакторена форма отправки нового письма с активацией аккаунта, дописаны юнит и функциональные тесты

Browse Source
This commit is contained in:
ErickSkrauch 2016-03-13 21:24:49 +03:00
parent b9ee667829
commit 7343a3b506
10 changed files with 238 additions and 48 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
api/controllers/SignupController.php
View File

@ -2,7 +2,7 @@
namespace api\controllers;
use api\models\ConfirmEmailForm;
use api\models\NewAccountActivationForm;
use api\models\RepeatAccountActivationForm;
use api\models\RegistrationForm;
use Yii;
use yii\filters\AccessControl;
@ -13,13 +13,13 @@ class SignupController extends Controller {
public function behaviors() {
return ArrayHelper::merge(parent::behaviors(), [
'authenticator' => [
'except' => ['index', 'new-message', 'confirm'],
'except' => ['index', 'repeat-message', 'confirm'],
],
'access' => [
'class' => AccessControl::class,
'rules' => [
[
'actions' => ['index', 'new-message', 'confirm'],
'actions' => ['index', 'repeat-message', 'confirm'],
'allow' => true,
'roles' => ['?'],
],
@ -51,10 +51,10 @@ class SignupController extends Controller {
];
}
public function actionNewMessage() {
$model = new NewAccountActivationForm();
public function actionRepeatMessage() {
$model = new RepeatAccountActivationForm();
$model->load(Yii::$app->request->post());
if (!$model->sendNewMessage()) {
if (!$model->sendRepeatMessage()) {
$response = [
'success' => false,
'errors' => $this->normalizeModelErrors($model->getErrors()),
@ -63,8 +63,8 @@ class SignupController extends Controller {
if ($response['errors']['email'] === 'error.recently_sent_message') {
$activeActivation = $model->getActiveActivation();
$response['data'] = [
'can_repeat_in' => $activeActivation->created_at - time() + NewAccountActivationForm::REPEAT_FREQUENCY,
'repeat_frequency' => NewAccountActivationForm::REPEAT_FREQUENCY,
'canRepeatIn' => $activeActivation->created_at - time() + RepeatAccountActivationForm::REPEAT_FREQUENCY,
'repeatFrequency' => RepeatAccountActivationForm::REPEAT_FREQUENCY,
];
}

6
api/exceptions/Exception.php Normal file
View File

@ -0,0 +1,6 @@
<?php
namespace api\exceptions;
class Exception extends \Exception {
}

11
api/exceptions/ThisShouldNotHaveHappenedException.php Normal file
View File

@ -0,0 +1,11 @@
<?php
namespace api\exceptions;
/**
* Исключение можно использовать для тех кейсов, где вроде указанных исход не продполагается,
* но теоретически может произойти. Целью является отлавливание таких участков и доработка логики,
* если такие ситуации всё же будут иметь место случаться.
*/
class ThisShouldNotHaveHappenedException extends Exception {
}

30
api/models/NewAccountActivationForm.php → api/models/RepeatAccountActivationForm.php
View File

@ -7,7 +7,7 @@ use common\models\EmailActivation;
use Yii;
use yii\base\ErrorException;
class NewAccountActivationForm extends BaseApiForm {
class RepeatAccountActivationForm extends BaseApiForm {
// Частота повтора отправки нового письма
const REPEAT_FREQUENCY = 5 * 60;
@ -18,18 +18,21 @@ class NewAccountActivationForm extends BaseApiForm {
return [
['email', 'filter', 'filter' => 'trim'],
['email', 'required', 'message' => 'error.email_required'],
['email', 'validateAccountForEmail'],
['email', 'validateEmailForAccount'],
['email', 'validateExistsActivation'],
];
}
public function validateAccountForEmail($attribute) {
public function validateEmailForAccount($attribute) {
if (!$this->hasErrors($attribute)) {
$account = $this->getAccount();
if ($account && $account->status === Account::STATUS_ACTIVE) {
$this->addError($attribute, "error.account_already_activated");
} elseif (!$account) {
if ($account === null) {
$this->addError($attribute, "error.{$attribute}_not_found");
} elseif ($account->status === Account::STATUS_ACTIVE) {
$this->addError($attribute, "error.account_already_activated");
} elseif ($account->status !== Account::STATUS_REGISTERED) {
// TODO: такие аккаунты следует логировать за попытку к саботажу
$this->addError($attribute, "error.account_cannot_resend_message");
}
}
}
@ -42,7 +45,7 @@ class NewAccountActivationForm extends BaseApiForm {
}
}
public function sendNewMessage() {
public function sendRepeatMessage() {
if (!$this->validate()) {
return false;
}
@ -50,15 +53,10 @@ class NewAccountActivationForm extends BaseApiForm {
$account = $this->getAccount();
$transaction = Yii::$app->db->beginTransaction();
try {
// Удаляем все активации аккаунта для пользователя этого E-mail адреса
/** @var EmailActivation[] $activations */
$activations = $account->getEmailActivations()
->andWhere(['type' => EmailActivation::TYPE_REGISTRATION_EMAIL_CONFIRMATION])
->all();
foreach ($activations as $activation) {
$activation->delete();
}
EmailActivation::deleteAll([
'account_id' => $account->id,
'type' => EmailActivation::TYPE_REGISTRATION_EMAIL_CONFIRMATION,
]);
$activation = new EmailActivation();
$activation->account_id = $account->id;

4
tests/codeception/api/_pages/SignupRoute.php
View File

@ -13,8 +13,8 @@ class SignupRoute extends BasePage {
$this->actor->sendPOST($this->getUrl(), $registrationData);
}
public function sendNewMessage($email = '') {
$this->route = ['signup/new-message'];
public function sendRepeatMessage($email = '') {
$this->route = ['signup/repeat-message'];
$this->actor->sendPOST($this->getUrl(), ['email' => $email]);
}

21
tests/codeception/api/functional/NewAccountActivationCest.php
View File

@ -1,21 +0,0 @@
<?php
namespace tests\codeception\api\functional;
use Codeception\Specify;
use tests\codeception\api\_pages\SignupRoute;
use tests\codeception\api\FunctionalTester;
class NewAccountActivationCest {
public function testSuccess(FunctionalTester $I) {
$route = new SignupRoute($I);
$I->wantTo('ensure that signup works');
$route->sendNewMessage('achristiansen@gmail.com');
$I->canSeeResponseCodeIs(200);
$I->canSeeResponseIsJson();
$I->canSeeResponseContainsJson(['success' => true]);
$I->cantSeeResponseJsonMatchesJsonPath('$.errors');
}
}

71
tests/codeception/api/functional/RepeatAccountActivationCest.php Normal file
View File

@ -0,0 +1,71 @@
<?php
namespace tests\codeception\api\functional;
use Codeception\Specify;
use tests\codeception\api\_pages\SignupRoute;
use tests\codeception\api\FunctionalTester;
class RepeatAccountActivationCest {
public function testInvalidEmailOrAccountState(FunctionalTester $I) {
$route = new SignupRoute($I);
$I->wantTo('error.email_required on empty for submitting');
$route->sendRepeatMessage();
$I->canSeeResponseCodeIs(200);
$I->canSeeResponseIsJson();
$I->canSeeResponseContainsJson([
'success' => false,
'errors' => [
'email' => 'error.email_required',
],
]);
$I->wantTo('error.email_not_found if email is not presented in db');
$route->sendRepeatMessage('im-not@exists.net');
$I->canSeeResponseCodeIs(200);
$I->canSeeResponseIsJson();
$I->canSeeResponseContainsJson([
'success' => false,
'errors' => [
'email' => 'error.email_not_found',
],
]);
$I->wantTo('error.account_already_activated if passed email matches with already activated account');
$route->sendRepeatMessage('admin@ely.by');
$I->canSeeResponseCodeIs(200);
$I->canSeeResponseIsJson();
$I->canSeeResponseContainsJson([
'success' => false,
'errors' => [
'email' => 'error.account_already_activated',
],
]);
$I->wantTo('error.recently_sent_message if last message was send too recently');
$route->sendRepeatMessage('achristiansen@gmail.com');
$I->canSeeResponseCodeIs(200);
$I->canSeeResponseIsJson();
$I->canSeeResponseContainsJson([
'success' => false,
'errors' => [
'email' => 'error.recently_sent_message',
],
]);
$I->canSeeResponseJsonMatchesJsonPath('$.data.canRepeatIn');
$I->canSeeResponseJsonMatchesJsonPath('$.data.repeatFrequency');
}
public function testSuccess(FunctionalTester $I) {
$route = new SignupRoute($I);
$I->wantTo('successfully resend account activation message');
$route->sendRepeatMessage('jon@ely.by');
$I->canSeeResponseCodeIs(200);
$I->canSeeResponseIsJson();
$I->canSeeResponseContainsJson(['success' => true]);
$I->cantSeeResponseJsonMatchesJsonPath('$.errors');
}
}

106
tests/codeception/api/unit/models/RepeatAccountActivationFormTest.php Normal file
View File

@ -0,0 +1,106 @@
<?php
namespace tests\codeception\api\models;
use api\models\RepeatAccountActivationForm;
use Codeception\Specify;
use tests\codeception\api\unit\DbTestCase;
use tests\codeception\common\fixtures\AccountFixture;
use tests\codeception\common\fixtures\EmailActivationFixture;
use Yii;
/**
* @property array $accounts
* @property array $activations
*/
class RepeatAccountActivationFormTest extends DbTestCase {
use Specify;
public function setUp() {
parent::setUp();
/** @var \yii\swiftmailer\Mailer $mailer */
$mailer = Yii::$app->mailer;
$mailer->fileTransportCallback = function () {
return 'testing_message.eml';
};
}
protected function tearDown() {
if (file_exists($this->getMessageFile())) {
unlink($this->getMessageFile());
}
parent::tearDown();
}
public function fixtures() {
return [
'accounts' => [
'class' => AccountFixture::class,
'dataFile' => '@tests/codeception/common/fixtures/data/accounts.php',
],
'activations' => [
'class' => EmailActivationFixture::class,
'dataFile' => '@tests/codeception/common/fixtures/data/email-activations.php',
],
];
}
public function testValidateEmailForAccount() {
$this->specify('error.email_not_found if passed valid email, but it don\'t exists in database', function() {
$model = new RepeatAccountActivationForm(['email' => 'me-is-not@exists.net']);
$model->validateEmailForAccount('email');
expect($model->getErrors('email'))->equals(['error.email_not_found']);
});
$this->specify('error.account_already_activated if passed valid email, but account already activated', function() {
$model = new RepeatAccountActivationForm(['email' => $this->accounts['admin']['email']]);
$model->validateEmailForAccount('email');
expect($model->getErrors('email'))->equals(['error.account_already_activated']);
});
$this->specify('no errors if passed valid email for not activated account', function() {
$model = new RepeatAccountActivationForm(['email' => $this->accounts['not-activated-account']['email']]);
$model->validateEmailForAccount('email');
expect($model->getErrors('email'))->isEmpty();
});
}
public function testValidateExistsActivation() {
$this->specify('error.recently_sent_message if passed email has recently sent message', function() {
$model = new RepeatAccountActivationForm(['email' => $this->accounts['not-activated-account']['email']]);
$model->validateExistsActivation('email');
expect($model->getErrors('email'))->equals(['error.recently_sent_message']);
});
$this->specify('no errors if passed email has expired activation message', function() {
$email = $this->accounts['not-activated-account-with-expired-message']['email'];
$model = new RepeatAccountActivationForm(['email' => $email]);
$model->validateExistsActivation('email');
expect($model->getErrors('email'))->isEmpty();
});
}
public function testSendRepeatMessage() {
$this->specify('no magic if we don\'t pass validation', function() {
$model = new RepeatAccountActivationForm();
expect($model->sendRepeatMessage())->false();
expect_file($this->getMessageFile())->notExists();
});
$this->specify('successfully send new message if previous message has expired', function() {
$email = $this->accounts['not-activated-account-with-expired-message']['email'];
$model = new RepeatAccountActivationForm(['email' => $email]);
expect($model->sendRepeatMessage())->true();
expect($model->getActiveActivation())->notNull();
expect_file($this->getMessageFile())->exists();
});
}
private function getMessageFile() {
/** @var \yii\swiftmailer\Mailer $mailer */
$mailer = Yii::$app->mailer;
return Yii::getAlias($mailer->fileTransportPath) . '/testing_message.eml';
}
}

15
tests/codeception/common/fixtures/data/accounts.php
View File

@ -38,5 +38,18 @@ return [
'status' => \common\models\Account::STATUS_REGISTERED,
'created_at' => 1453146616,
'updated_at' => 1453146616,
]
],
'not-activated-account-with-expired-message' => [
'id' => 4,
'uuid' => '58a7bfdc-ad0f-44c3-9197-759cb9220895',
'username' => 'Jon',
'email' => 'jon@ely.by',
'password_hash' => '$2y$13$2rYkap5T6jG8z/mMK8a3Ou6aZxJcmAaTha6FEuujvHEmybSHRzW5e', # password_0
'password_hash_strategy' => \common\models\Account::PASS_HASH_STRATEGY_YII2,
'password_reset_token' => null,
'auth_key' => '45DsaEQ7U8lU9umIyCWk5iCnpdPvZ8Up',
'status' => \common\models\Account::STATUS_REGISTERED,
'created_at' => 1457890086,
'updated_at' => 1457890086,
],
];

6
tests/codeception/common/fixtures/data/email-activations.php
View File

@ -6,4 +6,10 @@ return [
'type' => \common\models\EmailActivation::TYPE_REGISTRATION_EMAIL_CONFIRMATION,
'created_at' => time(),
],
[
'key' => 'H23HBDCHHAG2HGHGHS',
'account_id' => 4,
'type' => \common\models\EmailActivation::TYPE_REGISTRATION_EMAIL_CONFIRMATION,
'created_at' => time() - \api\models\RepeatAccountActivationForm::REPEAT_FREQUENCY - 10,
],
];