Functional Tests. The api error handler throw error

artemvolt · November 19, 2021, 8:44am

Hello everybody!

When i run api test with phpBrowser and controller has other errors (domain, error, throwable), i see this error in json response:

1) AuthCest: Try to test
 Test  tests/api/AuthCest.php:tryToTest
 Step  See response contains json {"data":[]}
 Fail  Response JSON does not contain the provided JSON

- Expected | + Actual
@@ @@
Array (
-    'data' => Array ()
+    'errors' => Array (...)
)

Scenario Steps:

 2. $I->seeResponseContainsJson({"data":[]}) at tests/api/AuthCest.php:23
 1. $I->sendPost("/brand/list") at tests/api/AuthCest.php:20

When i use functional tests, i have error in tests. I see this:

How can i change this behaviour and see like api tests?

I change some settings in error handler component silentExitOnException => true and YII_ENV_TEST => true , but nothing.

I got error because DomainExeception is not HttpException:

github.com

Codeception/Codeception/blob/198769e19a3f4f313b623386e1d558f5bfcce61d/src/Codeception/Lib/Connector/Yii2.php#L343

    
      
              $app->trigger($app::EVENT_AFTER_REQUEST);
              $response->send();
          } catch (\Exception $e) {
              if ($e instanceof HttpException) {
                  // Don't discard output and pass exception handling to Yii to be able
                  // to expect error response codes in tests.
                  $app->errorHandler->discardExistingOutput = false;
                  $app->errorHandler->handleException($e);
              } elseif (!$e instanceof ExitException) {
                  // for exceptions not related to Http, we pass them to Codeception
                  throw $e;
              }
              $response = $app->response;
          }
          
          
$this->encodeCookies($response, $yiiRequest, $app->security);
          
          
if ($response->isRedirection) {
              Debug::debug("[Redirect with headers]" . print_r($response->getHeaders()->toArray(), true));
          }

My config in api.suite.yml:

actor: ApiTester
modules:
    enabled:
        - Yii2
        - REST:
            depends: Yii2
            part: json
            shortDebugResponse: 600
        - Db
        - \Helper\Api

Code for test:

<?php

use Codeception\Util\Debug;
use cosmetic\entity\user\User;
use cosmetic\store\db\UsersStore;
use yii\helpers\VarDumper;

class AuthCest
{
    public function _before(ApiTester $I)
    {
    }

    // tests
    public function tryToTest(ApiTester $I)
    {
        $I->sendPost("/brand/list");
        $I->seeResponseContainsJson([
            'data' => []
        ]);
    }
}

bpanatta · November 25, 2021, 12:53pm

Your test is generating an error, which by the API definition (using the default ActiveController) will return a list of errors, with the index error in the response.

Still you are NOT expecting to receive an error:

        $I->seeResponseContainsJson([
            'data' => []
        ]);

You have two options here:

Update the test so it doesn’t generate errors! ← best choice!!
Change the data in the expected JSON to error (this would make sense if is a test that expects that error).

If you are expecting to discover what is the error with this test, then you should compare, or log, the returned error list.