New expectations: toHaveKeys() & toContainAll()

[alexmartinfr]

Q	A
Bug fix?	no
New feature?	yes
Fixed tickets	-

Adds new expectations:

• toHaveKeys(array $keys)
• toContainAll(array $needles)

Inspired by Freek in a recent livestream: https://youtu.be/KXUVnu-fTIM?t=3625

[owenvoke]

LGTM, is it worth using generics syntax for the doc blocks to be in line with other declarations? array<mixed> or array<int, mixed>

[alexmartinfr]

I'm not familiar with doc blocks best practices yet.
Thanks for the reviews and explanations!

I'll commit this change 👍

[nunomaduro]

There are missing tests, thank you for this!

[nunomaduro]

@param array<int, int|string> $keys.

[alexmartinfr]

Of course!
Forgot about the tests, I'll get on it 😌

[alexmartinfr]

Writing the tests made me stumble upon a logic pitfall with the not() modifier.

When all values that shouldn't be here exist, the expected exception is thrown:

test('not - fails when all strings exist')
    ->expect('Pest is awesome')
    ->not()->toContainAll(['Pest', 'awesome'])
    ->throws(ExpectationFailedException::class);
    // OK.

However, when only parts of the condition are met, the exception is not thrown, and the test doesn't fail as it should:

test('not - fails when at least one string exists')
    ->expect('Pest is awesome')
    ->not()->toContainAll(['Pest', 'clever'])
    ->throws(ExpectationFailedException::class);
    // Should fail, but is passing.

The same problem is encountered with toHaveKeys.

I have no clue how to circle around that, any idea?

[nunomaduro]

@alexmartinfr You code is correct:

test('not - fail when at least one string exists')
    ->expect('Pest is awesome')
    ->not()->toContainAll(['Pest', 'clever'])
    ->throws(ExpectationFailedException::class);

Pest is awesome does NOT contains all those keys. It contains some. 👍

[nunomaduro]

@alexmartinfr But maybe I expect that to contain none of the give values. Can you update the code?

[alexmartinfr]

You are right @nunomaduro, not->toContainAll() is working correctly, thanks to the word all.

I should have mentioned the real issue, not->toHaveKeys():

test('not - fails when at least one key exists')
    ->expect(['a' => 1, 'b', 'c' => 'world'])
    ->not()->toHaveKeys(['hello', 'a'])
    ->throws(ExpectationFailedException::class);

    // An exception should be thrown for 'a'.
    // However it's not the case.

I've been scratching my head around this one and can't find a way to make it work as I intend.

I could rename the expectation to toHaveAllKeys(), so that it matches the actual behaviour, but it doesn't seem ideal.

---

Another strategy to reach my initial goal would be to have specific expectations leveraging PHPUnit's negative assertions for these purposes:

• toContainNone() would use assertNotContains & assertStringNotContainsString
• toHaveNone() would use assertArrayNotHasKey

(I haven't tried that yet. Even if it works, it would need a better name for the second one.)

[nunomaduro]

Can we keep this on old @alexmartinfr? I will get back to it this month.

[alexmartinfr]

Sure!

[nunomaduro]

Going to hold this for now, we maybe re-open this pull request later.