ROAResearch / yii2-roa

src/test/TesterTrait.php

<?php

namespace roaresearch\yii2\roa\test;

trait TesterTrait
{
    /**
     * @var string[] pairs of user_name => oauth2_token for oauth2 auth.
     */
    protected static array $tokens = [];

    /**
     * @var string identificator for the auth/logged user.
     */
    protected string $loggedUsername;

    /**
     * Saves a token and user by an unique name.
     *
     * @param string $tokenName unique name to index the tokens and models
     * @param string $token oauth2 authorization token
     */
    public function storeToken(string $tokenName, string $token)
    {
        static::$tokens[$tokenName] = $token;
    }

    /**
     * Authenticates a user stored in `$tokens`
     *
     * @param string $tokenName
     */
    public function amAuthByToken(string $tokenName)
    {
        $this->amBearerAuthenticated(static::$tokens[$tokenName]);

It seems like amBearerAuthenticated() must be provided by classes using this trait. How about adding it as abstract method to this trait?

    }

    /**
     * Checks over the HTTP pagination headers and (optionally) its values.
     */
    public function seePaginationHttpHeaders()
    {
        $this->seeHttpHeaderOnce('X-Pagination-Total-Count');

It seems like seeHttpHeaderOnce() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        $this->seeHttpHeaderOnce('X-Pagination-Page-Count');
        $this->seeHttpHeaderOnce('X-Pagination-Current-Page');
        $this->seeHttpHeaderOnce('X-Pagination-Per-Page');
    }

    /**
     * Checks over the HTTP content type header value.
     */
    public function seeContentTypeHttpHeader(
        string $contentType = Tester::HAL_JSON_CONTENT_TYPE
    ) {
        $this->seeHttpHeader('Content-Type', $contentType);

It seems like seeHttpHeader() must be provided by classes using this trait. How about adding it as abstract method to this trait?

    }
}