Codeception:保持登录状态


Codeception: Keep a logged in state

我想在大多数测试之前保留或运行登录。但是,如果我试图将登录代码移动到_before,它就不起作用,因为我没有可用的webguy实例。

在多个测试之间保持会话的最佳方式是什么?到目前为止,这是我的代码,很高兴能得到一些帮助。我已经在谷歌上搜索并检查了文档,但我找不到任何关于会话内容的信息。

<?php
use 'WebGuy;
class ProductCest
{
    private $product_id = '1';
    public function _before()
    {
    }
    public function _after()
    {
    }
    // tests
    public function login(WebGuy $I) {
        $I->seeInCurrentUrl('/auth/login');
        $I->fillField("//input[@type='email']", "username@email.com");
        $I->fillField("//input[@type='password']", "1234");
        $I->click('#signIn .submit');
        $I->wait(500);
        $I->seeInCurrentUrl('/account');
    }
    /**
     * @depends login
     */
    public function chooseProduct(WebGuy $I) {
        $I->wantTo('go to products and choose one');
        $I->amOnPage('/?product=' . $this->client_id);
    }
}

我认为接受的答案是实现它的一种方式,但不是最好的。这样,当您只需要共享用户会话时,您将始终需要重现登录系统的所有步骤。我认为获取会话cookie并将其通过所需的用户日志测试会更好。要做到这一点,您需要创建一个登录函数,获取cookie,并使您的测试首先取决于登录测试:

<?php
use 'AcceptanceTester;
class testingCest
{
    private $cookie = null;
    public function _before(AcceptanceTester $I)
    {
    }
    public function _after(AcceptanceTester $I)
    {
    }

    // tests
    public function login(AcceptanceTester $I)
    {
        $I->wantTo('entrar al sistema');
        $I->amOnPage('/');
        $I->seeInCurrentUrl('/admin/login');
        $I->fillField('user','perry');
        $I->fillField('pass','pass-perry');
        $I->click('Login');
        $I->see('You''re logged!');
        $this->cookie   = $I->grabCookie('your-session-cookie-name');
    }
    /**
     * @depends login
     */
    public function listUsers(AcceptanceTester $I)
    {
        $I->setCookie( 'your-session-cookie-name', $this->cookie );
        $I->amOnPage('/admin/users');
        $I->seeInCurrentUrl('/admin/users/1');
    }
    /**
     * @depends login
     */
    public function listRols(AcceptanceTester $I)
    {
        $I->setCookie( 'your-session-cookie-name', $this->cookie );
        $I->amOnPage('/admin/rols');
        $I->seeInCurrentUrl('/admin/rols/1');
    }
}

这样,如果登录测试失败,您将无法获得cookie,也无法通过其他测试。

我更喜欢这个@depends注释,而不是另一个答案中提出的@before,因为如果您使用@depends,您将始终在之前执行测试中的代码,并且测试将仅在登录后执行。

更新

下面还有另一个答案,https://stackoverflow.com/a/41109855/1168804这也可能对您有所帮助,因为自从编写这个答案以来,Codeception的框架已经发生了变化。

所有早期的答案都是旧的,现在直接在_before方法中完成,该方法将Actor类作为参数。

<?php
namespace Test'Api;
use ApiTester;
class TrainingCest
{
    public function _before(ApiTester $I)
    {
        $I->amLoggedInAs('kgkg');
    }
    public function _after(ApiTester $I)
    {
    }
    // tests
    public function testForLoggedInUser(ApiTester $I)
    {
    }
    public function anotherTestForLoggedInUser(ApiTester $I)
    {
    }
}

如果您只想为所有CEST文件登录一次,您可以使用实现Registry设计模式的全局Registry类(请参阅https://dzone.com/articles/practical-php-patterns/basic/practical-php-patterns-0)还有一些懒散的东西。以下是Actor类(在我的例子中是ApiTester)中定义的api集成测试的工作代码:

public function amLoggedInAs($userLogin)
{
    $I = $this;
    if (Registry::getInstance()->exists($userLogin)) {
        // get data from registry
        $storedUserData = Registry::getInstance()->get($userLogin);
        $newAccessToken = $storedUserData['accessToken'];
        $playerId = $storedUserData['playerId'];
    }
    else {
        // no registry data - log in and save data in registry
        $I->tryToLogin($userLogin);
        $newAccessToken = $I->grabDataFromResponseByJsonPath('data.newToken');
        $playerId = (int)$I->grabDataFromResponseByJsonPath('data.userId');
        Registry::getInstance()->set($userLogin, [
            'accessToken' => $newAccessToken,
            'playerId' => $playerId
        ]);
    }
    // finally set headers and some other data
    $I->haveHttpHeader('X-Token', $newAccessToken);
    $I->havePlayerId($playerId);
}
protected function tryToLogin($userLogin)
{
    $I = $this;
    $I->wantTo('login into api');
    $I->amGoingTo('try to log to API using login and password');
    $I->sendPOST('/system/login', ['login' => $userLogin, 'password' => self::getPassword($userLogin)]);
    // ...some other checking if user was correctly logged in ...
}

这段代码基本上是在用户第一次登录后将accessToken和一些额外的数据存储在注册表中。若调用另一个对$I->amLoggedInAs("kgkg")的调用,它将从注册表中获取这些值。通过这种方式可以有许多登录用户,每个用户在每个套件中只登录一次。

您可以使用另一种方法进行自动授权,而不是自定义令牌,逻辑仍然相同。

此外,如果您使用的是WebDriver(而不是PhpBrowser),则可以使用loadSessionSnapshot和saveSessionSnapshot而不是Registry来获得完全相同的结果。

现在Codeception通过saveSessionSnapshot和loadSessionSnapshot方法来处理这一问题。

<?php
// inside AcceptanceTester class:
public function login()
{
     // if snapshot exists - skipping login
     if ($I->loadSessionSnapshot('login')) return;
     // logging in
     $I->amOnPage('/login');
     $I->fillField('name', 'jon');
     $I->fillField('password', '123345');
     $I->click('Login');
     // saving snapshot
     $I->saveSessionSnapshot('login');
}
?>

然后在你的测试课上,你就这样做了

public function _before(AcceptanceTester $I)
{
    $I->login();
}
<?php
use 'WebGuy;
class ProductCest
{
    private $product_id = '1';
    public function _before()
    {
    }
    public function _after()
    {
    }
    private function executeLogin(WebGuy $I){
        $I->seeInCurrentUrl('/auth/login');
        $I->fillField("//input[@type='email']", "username@email.com");
        $I->fillField("//input[@type='password']", "1234");
        $I->click('#signIn .submit');
        $I->wait(500);
        return $I;
    }
    // tests
    public function login(WebGuy $I) {
        $I = $this->executeLogin($I);
        $I->seeInCurrentUrl('/account');
    }
    /**
     * @depends login
     */
    public function chooseProduct(WebGuy $I) {
        $I = $this->executeLogin($I);
        $I->wantTo('go to products and choose one');
        $I->amOnPage('/?product=' . $this->client_id);
    }
}

这应该行得通。

2021年,在我的情况下,它很简单,只需在.yml文件中将clear_cookies设置为false即可。。

Codeception会在测试之间删除cookie,因为作为最佳实践,您应该在测试之间保持登录状态。

但是,如果你想持久保存cookie,只需声明:

actor: AcceptanceTester
modules:
    enabled:
        - WebDriver:
              clear_cookies: false

我认为@Sinisa的答案是"有效的",但不是"正确的"。

您想要的不是@dependents注释,而是@before。

不同之处在于,使用@dependent不保留当前上下文,而在保留上下文之前使用@。

public function foo(WebGuy $I)
{
    $I->amOnPage('/foobar');
}
/**
 * @depends foo
 */
public function bar(WebGuy $I)
{
    $I->seeInCurrentUrl('foobar'); // Wil fail
}
/**
 * @before foo
 */
public function baz(WebGuy $I)
{
    $I->seeInCurrentUrl('foobar'); // Will pass
}

需要注意的是,如果您正在测试WordPress,WP浏览器模块有"sugar"登录方法:

loginAsAdmin();
loginAs($username, $password);

https://github.com/lucatume/wp-browser

请记住,如果使用SaveSessionSnapshot,则必须确保在登录完成后调用该函数。这意味着,如果您的登录需要一些时间(ldap登录或安全检查),则SaveSessionSnapshot将在登录完成之前执行,并保存一个空会话。如果是这样,你必须告诉你的程序等待($I->wait()),或者检查登录是否完成。