Using variables within codeception tests

Question

How do we use string replacements and variables in the tests? I suspect this is common and I simply do not know where to look. Example test:

$I = new ApiTester($scenario);
$I->wantTo('Get Stuff');
$I->amHttpAuthenticated('myuser', 'mypass');
$I->haveHttpHeader('Content-Type', 'application/json');
$I->haveHttpHeader('Custom-Header', 'friendlycorp');
$I->sendGet('/a/path/that/contains/variables');
$I->seeResponseCodeIs(\Codeception\Util\HttpCode::OK);

Each REST API location being tested uses different values, and also the URL changes depending on the service being tested. So, perhaps something like:

$I->amHttpAuthenticated('{USERNAME}', '{PASSWORD}');
$I->sendGet('/a/path/{SERVICE_ID}/and/{SOMETHING_ELSE}/and/such');
$I->haveHttpHeader('Custom-Header', '{SERVICE_ID}');

I'm hopeful that a configuration file could then define the likes of {SERVICE_ID} and {FUNCTION} depending on the REST API service location I'm testing, along with other variables. For example:

FriendlyCorp:
    SERVICE_ID: friendlycorp
    SOMETHING_ELSE: foo
    USERNAME: myuser
    PASSWORD: mypass
OpenExample:
    SERVICE_ID: openexample
    SOMETHING_ELSE: bar
    USERNAME: myuser2
    PASSWORD: mypass2

Then when executing codeception I'd choose to run tests against FriendlyCorp or OpenExample and said values would be used within the tests.

Naktibalda · Accepted Answer · 2016-12-04 18:13:03Z

5

Use Cest format with Examples

 /**
  * @example { "service_id": "friendlycorp", "something_else": "foo", "username": "myuser", "password": "mypass" }
  * @example { "service_id": "openexample", "something_else": "bar", "username": "myuser2", "password": "mypass2" }
  */
  public function services(ApiTester $I, \Codeception\Example $example)
  {
    $I->amHttpAuthenticated($example['username'], $example['username']);
    $I->haveHttpHeader('Content-Type', 'application/json');
    $I->haveHttpHeader('Custom-Header', $example['service_id']);
    $I->sendGet("/a/path/{$example['service_id']}/and/{$example['something_else']}/and/such");
    $I->seeResponseCodeIs(\Codeception\Util\HttpCode::OK);
  }

edited Dec 4, 2016 at 18:13

answered Dec 4, 2016 at 13:20

Naktibalda

14.2k5 gold badges37 silver badges53 bronze badges

Sign up to request clarification or add additional context in comments.

Collectives™ on Stack Overflow

Using variables within codeception tests

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related