Providing null data with Examples annotation fails

[codedge]

Hey 👋

I use the Examples annotation to provide test data to my test case. I want to use null as values.

#[Examples('BILL', null, null, null, null)]
public function canMapValidMessages(FunctionalTester $I, Example $example): void
{
  $data = [
  	'key1' => $example[0],
  	'key2' => $example[1],
  	'key3' => $example[2],
  	'key4' => $example[3],
  ];

  // custom logic

  $I->assertNull($data['key2']);
}

Unfortunately Codeception fails with

 Codeception\Util\Annotation::arrayValue(): Argument #1 ($annotation) must be of type string, null given, called in /var/www/html/vendor/codeception/codeception/src/Codeception/Test/Data/Provider.php on line 35

• Codeception version: 5.0.13
• PHP Version: 8.3
• Operating System: Alpine

[Naktibalda]

Does adding second Examples attribute solves this problem?

[hosseinsalemi]

It fixed when I added second Examples attribute. I need to have only one Examples attribute for some steps.

[xEdelweiss]

Hi! It seems that Util/Annotation::fetchAll() handles the Example attribute incorrectly and returns an array of arrays for multiple attributes and an array of values for a single attribute.

Return structure comparison

Multiple Example annotations:

array (
  0 => '["example 1"]',
  1 => '["example 2"]',
)

Single Example annotation:

array (
  0 => '["example 1"]',
)

Multiple Example attributes:

array (
  0 => array (
    0 => 'example 1',
  ),
  1 => array (
    0 => 'example 2',
  ),
)

Actual Single Example attribute:

array (
  0 => 'example 1', 
)

Expected Single Example attribute:

array (
  0 => array (
    0 => 'example 1',
  ),
)

UPD:
@Naktibalda, I have added a PR for this.

[mgrechanik]

Does adding second Examples attribute solves this problem?

Pity that this bug still exists and not fixed. Met it just now. Documentation does not give a hint that one cannot use a single example case