Proposal: split assertContains for iterables and non-iterables #3422

keradus · 2018-11-28T01:40:28Z

currently, one can do both with a single assertion:

$this->assertContains('b', ['a', 'b', 'c']);
$this->assertContains('b', 'abc');

which is confusing if someone use it like the following, and for that error prone due to accidental lack of types control

$this->assertContains('b', $haystack);

what about splitting the responsibility of that assertion, to have one for strings and one for iterables ?

ref PHP-CS-Fixer/PHP-CS-Fixer#4061

The text was updated successfully, but these errors were encountered:

sebastianbergmann · 2018-11-28T14:27:14Z

I interpret this as

Add assertIterableContains() and assertStringContains() in PHPUnit 7.5
Deprecate (soft) assertContains() in PHPUnit 7.5
Deprecate (hard) assertContains() in PHPUnit 8.0

Correct?

sebastianbergmann · 2018-11-28T15:42:32Z

Going further, we probably want to get rid of the optional parameters and introduce

assertStringContainsString() (uses new StringContains($needle, false))
assertStringContainsStringIgnoringCase() (uses new StringContains($needle, true))
assertIterableContains() (uses new TraversableContains($needle, false, false))
assertIterableContainsSame() (uses new TraversableContains($needle, true, true))

etc.

sebastianbergmann · 2018-11-28T15:58:46Z

@keradus Can you please have a look at master...686d153? Thanks!

keradus · 2018-11-28T19:23:14Z

Hi ! First of all, glad you like the idea !

Deprecate (soft) assertContains() in PHPUnit 7.5
Deprecate (hard) assertContains() in PHPUnit 8.0

can you elaborate how you define difference of hard and soft deprecation? if hard is removal of functionality, then that's how I would see this to happen indeed ;)

assertIterableContains() (uses new TraversableContains($needle, false, false))
assertIterableContainsSame() (uses new TraversableContains($needle, true, true))

I would rather promote strict comparison by default. Language itself is promoting to be strict about types now, let's not promote (by more convenient (/shorter) name) being not strict.
that saying, I would suggest following naming instead:
assertIterableContains to check strict
assertIterableContainsEqual to check non-strict

Can you please have a look at master...686d153? Thanks!

can you raise it as a PR? with link provided, I can't do the comments :(

sebastianbergmann · 2018-11-28T20:02:25Z

Soft Deprecation in PHPUnit 7.5
Hard Deprecation in PHPUnit 8
Removal in PHPUnit 9

sebastianbergmann · 2018-11-28T20:02:36Z

Sorry, but I do not send myself pull requests.

sebastianbergmann · 2018-11-28T20:03:19Z

I agree with promoting strict comparison, but the naming as-is makes more sense to me somehow.

* Revert deprecation of assertContains() and assertNotContains() * Revert addition of assertIterableContains(), assertIterableContainsSame(), assertIterableNotContains(), and assertIterableNotContainsSame() * Deprecate using assertContains() and assertNotContains() on string haystacks * Deprecate the optional parameters $ignoreCase, $checkForObjectIdentity, and $checkForNonObjectIdentity of assertContains() and assertNotContains()

The old way is deprecated from phpunit 8.0 sebastianbergmann/phpunit#3422

...and require phpunit >7.5 for assertStringContainsString See sebastianbergmann/phpunit#3422

…sString()` ... when used with strings. Using `assertContains()` and `assertNotContains()` with string haystacks was soft deprecated in PHPUnit 7.5, hard deprecated in PHPUnit 8.0 and the functionality was removed in PHPUnit 9.0. For string haystacks, the `assertStringContainsString()`, `assertStringContainsStringIgnoringCase()`, `assertStringNotContainsString()` and `assertStringNotContainsStringIgnoringCase()` were introduced as replacements in PHPUnit 7.5. Ref: * https://github.com/sebastianbergmann/phpunit/blob/7.5.20/ChangeLog-7.5.md#750---2018-12-07 * sebastianbergmann/phpunit#3422

Both assertContains() and assertNotContains() are deprecated in PHPUnit 8 for operations on strings. Also the optional case parameter is. All uses must be changed to one of: - assertStringContainsString() - assertStringContainsStringIgnoringCase() - assertStringNotContainsString() - assertStringNotContainsStringIgnoringCase() More info: sebastianbergmann/phpunit#3422 Regexp to find all uses: ag 'assert(Not)?Contains\('

See sebastianbergmann/phpunit#3422

The old way is deprecated from phpunit 8.0 sebastianbergmann/phpunit#3422

PHPUnit 8 specializes several assertion methods: - sebastianbergmann/phpunit#3368 - sebastianbergmann/phpunit#3422 (comment)

sebastianbergmann self-assigned this Nov 28, 2018

sebastianbergmann added the type/enhancement A new idea that should be implemented label Nov 28, 2018

sebastianbergmann added this to the PHPUnit 7.5 milestone Nov 28, 2018

sebastianbergmann added a commit that referenced this issue Nov 28, 2018

Initial work on #3422

77d079f

This was referenced Nov 29, 2018

Deprecate assertContains() and assertNotContains() #3425

Closed

Clean up assertContains() and assertNotContains() #3426

Closed

sebastianbergmann added a commit that referenced this issue Nov 29, 2018

Closes #3422

420d8ca

sebastianbergmann closed this as completed in 2975888 Nov 29, 2018

Slamdunk mentioned this issue Dec 10, 2018

[PHPUnit] Add migration for 7.5 assertStringContainsString PHP-CS-Fixer/PHP-CS-Fixer#4146

Closed

sebastianbergmann mentioned this issue Feb 5, 2019

assertContains() and object equality #3511

Closed

bjuppa added a commit to bjuppa/laravel-blog that referenced this issue Feb 28, 2019

Test for strings within strings as of phpunit 7.5

1ea4a5f

The old way is deprecated from phpunit 8.0 sebastianbergmann/phpunit#3422

peter279k mentioned this issue Mar 25, 2019

About assert string contains adhocore/asserts#9

Open

3 tasks

carusogabriel mentioned this issue Apr 27, 2019

Update to PHPUnit 8 doctrine/orm#7688

Closed

bjuppa added a commit to kontenta/kontour that referenced this issue Sep 20, 2019

Replace deprecated phpunit assertContains

cc533f2

...and require phpunit >7.5 for assertStringContainsString See sebastianbergmann/phpunit#3422

nielslange mentioned this issue Apr 12, 2021

FIX: Correct unit tests when running WP 5.7 Automattic/Co-Authors-Plus#774

Merged

eliashaeussler added a commit to eliashaeussler/composer-update-reporter that referenced this issue Dec 26, 2021

[BUGFIX] Raise minimum version of phpunit

d2064aa

See sebastianbergmann/phpunit#3422

eliashaeussler added a commit to eliashaeussler/composer-update-reporter that referenced this issue Dec 26, 2021

[BUGFIX] Raise minimum version of phpunit

e3c0583

See sebastianbergmann/phpunit#3422

eliashaeussler added a commit to eliashaeussler/composer-update-check that referenced this issue Dec 26, 2021

[BUGFIX] Raise minimum version of phpunit

63f8ea2

See sebastianbergmann/phpunit#3422

eliashaeussler added a commit to eliashaeussler/cache-warmup that referenced this issue Dec 27, 2021

[BUGFIX] Raise minimum version of phpunit

72e54dd

See sebastianbergmann/phpunit#3422

superstarlancer added a commit to superstarlancer/Laravel-Blog-Client that referenced this issue Mar 27, 2023

Test for strings within strings as of phpunit 7.5

5ffcb42

The old way is deprecated from phpunit 8.0 sebastianbergmann/phpunit#3422

dawitengageiq pushed a commit to dawitengageiq/NLR that referenced this issue Sep 29, 2023

Shift assertion methods

392f19e

PHPUnit 8 specializes several assertion methods: - sebastianbergmann/phpunit#3368 - sebastianbergmann/phpunit#3422 (comment)

debaste pushed a commit to debaste/yii that referenced this issue Nov 25, 2023

Shift assertion methods

565f10e

PHPUnit 8 specializes several assertion methods: - sebastianbergmann/phpunit#3368 - sebastianbergmann/phpunit#3422 (comment)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Proposal: split assertContains for iterables and non-iterables #3422

Proposal: split assertContains for iterables and non-iterables #3422

keradus commented Nov 28, 2018

sebastianbergmann commented Nov 28, 2018

sebastianbergmann commented Nov 28, 2018 •

edited

sebastianbergmann commented Nov 28, 2018 •

edited

keradus commented Nov 28, 2018 •

edited

sebastianbergmann commented Nov 28, 2018

sebastianbergmann commented Nov 28, 2018

sebastianbergmann commented Nov 28, 2018

Proposal: split assertContains for iterables and non-iterables #3422

Proposal: split assertContains for iterables and non-iterables #3422

Comments

keradus commented Nov 28, 2018

sebastianbergmann commented Nov 28, 2018

sebastianbergmann commented Nov 28, 2018 • edited

sebastianbergmann commented Nov 28, 2018 • edited

keradus commented Nov 28, 2018 • edited

sebastianbergmann commented Nov 28, 2018

sebastianbergmann commented Nov 28, 2018

sebastianbergmann commented Nov 28, 2018

sebastianbergmann commented Nov 28, 2018 •

edited

sebastianbergmann commented Nov 28, 2018 •

edited

keradus commented Nov 28, 2018 •

edited