Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

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

Closed
keradus opened this issue Nov 28, 2018 · 7 comments
Closed

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

keradus opened this issue Nov 28, 2018 · 7 comments
Assignees
@sebastianbergmann
Labels
type/enhancement A new idea that should be implemented
Milestone
PHPUnit 7.5

Comments

@keradus
Copy link
Contributor

keradus commented Nov 28, 2018

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
@sebastianbergmann
Copy link
Owner

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
Copy link
Owner

sebastianbergmann commented Nov 28, 2018 •
edited
Loading

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 sebastianbergmann self-assigned this Nov 28, 2018
@sebastianbergmann sebastianbergmann added the type/enhancement A new idea that should be implemented label Nov 28, 2018
@sebastianbergmann sebastianbergmann added this to the PHPUnit 7.5 milestone Nov 28, 2018
sebastianbergmann added a commit that referenced this issue Nov 28, 2018
@sebastianbergmann
Initial work on #3422
77d079f
@sebastianbergmann
Copy link
Owner

sebastianbergmann commented Nov 28, 2018 •
edited
Loading

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

@keradus
Copy link
Contributor Author

keradus commented Nov 28, 2018 •
edited
Loading

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
Copy link
Owner

  1. Soft Deprecation in PHPUnit 7.5
  2. Hard Deprecation in PHPUnit 8
  3. Removal in PHPUnit 9

@sebastianbergmann
Copy link
Owner

Sorry, but I do not send myself pull requests.

@sebastianbergmann
Copy link
Owner

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

This was referenced Nov 29, 2018
Closed
Closed
sebastianbergmann added a commit that referenced this issue Nov 29, 2018
@sebastianbergmann
Closes #3422
420d8ca
sebastianbergmann added a commit that referenced this issue Dec 2, 2018
@sebastianbergmann
More work on #3422.
5a5b982 
* 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()
@Slamdunk Slamdunk mentioned this issue Dec 10, 2018
Closed
@sebastianbergmann sebastianbergmann mentioned this issue Feb 5, 2019
Closed
bjuppa added a commit to bjuppa/laravel-blog that referenced this issue Feb 28, 2019
@bjuppa
Test for strings within strings as of phpunit 7.5
1ea4a5f 
The old way is deprecated from phpunit 8.0

sebastianbergmann/phpunit#3422
@peter279k peter279k mentioned this issue Mar 25, 2019
Open
3 tasks
@carusogabriel carusogabriel mentioned this issue Apr 27, 2019
Closed
bjuppa added a commit to kontenta/kontour that referenced this issue Sep 20, 2019
@bjuppa
Replace deprecated phpunit assertContains
cc533f2 
...and require phpunit  >7.5 for assertStringContainsString

See sebastianbergmann/phpunit#3422
jrfnl added a commit to jrfnl/wordpress-develop that referenced this issue Aug 16, 2020
@jrfnl
Tests: replace assert[Not]Contains() with `assertString[Not]Contain…
9ea46be 
…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
jrfnl added a commit to jrfnl/wordpress-develop that referenced this issue Aug 16, 2020
@jrfnl
Tests: replace assert[Not]Contains() with `assertString[Not]Contain…
ccd4948 
…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
jrfnl added a commit to jrfnl/wordpress-develop that referenced this issue Aug 21, 2020
@jrfnl
Tests: replace assert[Not]Contains() with `assertString[Not]Contain…
548ef78 
…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
stronk7 added a commit to stronk7/moodle that referenced this issue Sep 20, 2020
@stronk7
MDL-67673 phpunit: Remove deprecated assertContains() uses on strings
3801f8d 
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\('
stronk7 added a commit to stronk7/moodle that referenced this issue Oct 21, 2020
@stronk7
MDL-67673 phpunit: Remove deprecated assertContains() uses on strings
35bc26b 
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\('
stronk7 added a commit to stronk7/moodle that referenced this issue Oct 21, 2020
@stronk7
MDL-67673 phpunit: Remove deprecated assertContains() uses on strings
40de097 
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\('
@nielslange nielslange mentioned this issue Apr 12, 2021
Merged
eliashaeussler added a commit to eliashaeussler/composer-update-reporter that referenced this issue Dec 26, 2021
@eliashaeussler
[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
@eliashaeussler
[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
@eliashaeussler
[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
@eliashaeussler
[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
@superstarlancer
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
@laravel-shift
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
@laravel-shift
Shift assertion methods
565f10e 
PHPUnit 8 specializes several assertion methods:

- sebastianbergmann/phpunit#3368
- sebastianbergmann/phpunit#3422 (comment)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@sebastianbergmann sebastianbergmann

Labels
type/enhancement A new idea that should be implemented
Projects
None yet
Milestone
PHPUnit 7.5
Development

No branches or pull requests
2 participants
@sebastianbergmann @keradus