Skip to content

feat: add replacements for deprecated assertContainsOnly() and assertNotContainsOnly() #19

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

Merged
W0rma merged 1 commit into from
Dec 22, 2025
Merged

feat: add replacements for deprecated assertContainsOnly() and assertNotContainsOnly() #19

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions docs/supported_asserts.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,35 @@ assertClassNotHasAttribute
assertClassNotHasStaticAttribute
assertContains
assertContainsEquals
assertContainsNotOnlyArray
assertContainsNotOnlyBool
assertContainsNotOnlyCallable
assertContainsNotOnlyClosedResource
assertContainsNotOnlyFloat
assertContainsNotOnlyInstancesOf
assertContainsNotOnlyInt
assertContainsNotOnlyIterable
assertContainsNotOnlyNull
assertContainsNotOnlyNumeric
assertContainsNotOnlyObject
assertContainsNotOnlyResource
assertContainsNotOnlyScalar
assertContainsNotOnlyString
assertContainsOnly
assertContainsOnlyArray
assertContainsOnlyBool
assertContainsOnlyCallable
assertContainsOnlyClosedResource
assertContainsOnlyFloat
assertContainsOnlyInstancesOf
assertContainsOnlyInt
assertContainsOnlyIterable
assertContainsOnlyNull
assertContainsOnlyNumeric
assertContainsOnlyObject
assertContainsOnlyResource
assertContainsOnlyScalar
assertContainsOnlyString
assertCount
assertDirectoryDoesNotExist
assertDirectoryExists
Expand Down
9 changes: 8 additions & 1 deletion phpstan.neon
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,11 @@ parameters:
level: 9
paths:
- tests/
- src/
- src/
ignoreErrors:
-
message: '#Parameter \#1 \$className of static method PHPUnit\\Framework\\Assert::assertContainsOnlyInstancesOf\(\) expects class-string<object>, string given\.#'
path: src/Codeception/Util/Shared/InheritedAsserts.php
-
message: '#Parameter \#1 \$className of static method PHPUnit\\Framework\\Assert::assertContainsNotOnlyInstancesOf\(\) expects class-string, string given\.#'
path: src/Codeception/Util/Shared/InheritedAsserts.php
307 changes: 302 additions & 5 deletions src/Codeception/Util/Shared/InheritedAsserts.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,14 +99,167 @@ protected function assertNotContainsEquals(mixed $needle, iterable $haystack, st
Assert::assertNotContainsEquals($needle, $haystack, $message);
}

/**
* @param iterable<mixed> $haystack
*/
protected function assertContainsNotOnlyArray(iterable $haystack, string $message = ''): void
{
Assert::assertContainsNotOnlyArray($haystack, $message);
}

/**
* @param iterable<mixed> $haystack
*/
protected function assertContainsNotOnlyBool(iterable $haystack, string $message = ''): void
{
Assert::assertContainsNotOnlyBool($haystack, $message);
}

/**
* @param iterable<mixed> $haystack
*/
protected function assertContainsNotOnlyCallable(iterable $haystack, string $message = ''): void
{
Assert::assertContainsNotOnlyCallable($haystack, $message);
}

/**
* @param iterable<mixed> $haystack
*/
protected function assertContainsNotOnlyFloat(iterable $haystack, string $message = ''): void
{
Assert::assertContainsNotOnlyFloat($haystack, $message);
}

/**
* @param class-string $className
* @param iterable<mixed> $haystack
*/
protected function assertContainsNotOnlyInstancesOf(string $className, iterable $haystack, string $message = ''): void
{
Assert::assertContainsNotOnlyInstancesOf($className, $haystack, $message);
}

/**
* @param iterable<mixed> $haystack
*/
protected function assertContainsNotOnlyInt(iterable $haystack, string $message = ''): void
{
Assert::assertContainsNotOnlyInt($haystack, $message);
}

/**
* @param iterable<mixed> $haystack
*/
protected function assertContainsNotOnlyIterable(iterable $haystack, string $message = ''): void
{
Assert::assertContainsNotOnlyIterable($haystack, $message);
}

/**
* @param iterable<mixed> $haystack
*/
protected function assertContainsNotOnlyNull(iterable $haystack, string $message = ''): void
{
Assert::assertContainsNotOnlyNull($haystack, $message);
}

/**
* @param iterable<mixed> $haystack
*/
protected function assertContainsNotOnlyNumeric(iterable $haystack, string $message = ''): void
{
Assert::assertContainsNotOnlyNumeric($haystack, $message);
}

/**
* @param iterable<mixed> $haystack
*/
protected function assertContainsNotOnlyObject(iterable $haystack, string $message = ''): void
{
Assert::assertContainsNotOnlyObject($haystack, $message);
}

/**
* @param iterable<mixed> $haystack
*/
protected function assertContainsNotOnlyResource(iterable $haystack, string $message = ''): void
{
Assert::assertContainsNotOnlyResource($haystack, $message);
}

/**
* @param iterable<mixed> $haystack
*/
protected function assertContainsNotOnlyClosedResource(iterable $haystack, string $message = ''): void
{
Assert::assertContainsNotOnlyClosedResource($haystack, $message);
}

/**
* @param iterable<mixed> $haystack
*/
protected function assertContainsNotOnlyScalar(iterable $haystack, string $message = ''): void
{
Assert::assertContainsNotOnlyScalar($haystack, $message);
}

/**
* @param iterable<mixed> $haystack
*/
protected function assertContainsNotOnlyString(iterable $haystack, string $message = ''): void
{
Assert::assertContainsNotOnlyString($haystack, $message);
}

/**
* Asserts that a haystack contains only values of a given type.
* @param 'array'|'bool'|'boolean'|'callable'|'double'|'float'|'int'|'integer'|'iterable'|'null'|'numeric'|'object'|'real'|'resource'|'resource (closed)'|'scalar'|'string' $type
* @param 'array'|'bool'|'boolean'|'callable'|'double'|'float'|'int'|'integer'|'iterable'|'null'|'numeric'|'object'|'real'|'resource'|'resource (closed)'|'scalar'|'string'|class-string $type
* @param iterable<mixed> $haystack
*/
protected function assertContainsOnly(string $type, iterable $haystack, ?bool $isNativeType = null, string $message = ''): void
{
Assert::assertContainsOnly($type, $haystack, $isNativeType, $message);
$replacement = match ($type) {
'array' => 'assertContainsOnlyArray',
'bool', 'boolean' => 'assertContainsOnlyBool',
'callable' => 'assertContainsOnlyCallable',
'double', 'float', 'real' => 'assertContainsOnlyFloat',
'int', 'integer' => 'assertContainsOnlyInt',
'iterable' => 'assertContainsOnlyIterable',
'null' => 'assertContainsOnlyNull',
'numeric' => 'assertContainsOnlyNumeric',
'object' => 'assertContainsOnlyObject',
'resource' => 'assertContainsOnlyResource',
'resource (closed)' => 'assertContainsOnlyClosedResource',
'scalar' => 'assertContainsOnlyScalar',
'string' => 'assertContainsOnlyString',
default => null,
};

if (is_string($replacement)) {
trigger_error(
sprintf(
'%s is deprecated since PHPUnit 11.5. Please use %s($haystack) instead of assertContainsOnly(\'%s\', $haystack)',
__FUNCTION__,
$replacement,
$type,
),
E_USER_DEPRECATED,
);

$this->$replacement($haystack, $message);
} else {
trigger_error(
sprintf(
'assertContainsOnly() is deprecated since PHPUnit 11.5. Please use assertContainsOnlyInstancesOf(\'%s\', $haystack) instead of assertContainsOnly(\'%s\', $haystack).',
$type,
$type,
),
E_USER_DEPRECATED,
);

Assert::assertContainsOnlyInstancesOf($type, $haystack, $message);
}
}

/**
Expand All @@ -119,6 +272,110 @@ protected function assertContainsOnlyInstancesOf(string $className, iterable $ha
Assert::assertContainsOnlyInstancesOf($className, $haystack, $message);
}

/**
* @param iterable<mixed> $haystack
*/
protected function assertContainsOnlyArray(iterable $haystack, string $message = ''): void
{
Assert::assertContainsOnlyArray($haystack, $message);
}

/**
* @param iterable<mixed> $haystack
*/
protected function assertContainsOnlyBool(iterable $haystack, string $message = ''): void
{
Assert::assertContainsOnlyBool($haystack, $message);
}

/**
* @param iterable<mixed> $haystack
*/
protected function assertContainsOnlyCallable(iterable $haystack, string $message = ''): void
{
Assert::assertContainsOnlyCallable($haystack, $message);
}

/**
* @param iterable<mixed> $haystack
*/
protected function assertContainsOnlyFloat(iterable $haystack, string $message = ''): void
{
Assert::assertContainsOnlyFloat($haystack, $message);
}

/**
* @param iterable<mixed> $haystack
*/
protected function assertContainsOnlyInt(iterable $haystack, string $message = ''): void
{
Assert::assertContainsOnlyInt($haystack, $message);
}

/**
* @param iterable<mixed> $haystack
*/
protected function assertContainsOnlyIterable(iterable $haystack, string $message = ''): void
{
Assert::assertContainsOnlyIterable($haystack, $message);
}

/**
* @param iterable<mixed> $haystack
*/
protected function assertContainsOnlyNull(iterable $haystack, string $message = ''): void
{
Assert::assertContainsOnlyNull($haystack, $message);
}

/**
* @param iterable<mixed> $haystack
*/
protected function assertContainsOnlyNumeric(iterable $haystack, string $message = ''): void
{
Assert::assertContainsOnlyNumeric($haystack, $message);
}

/**
* @param iterable<mixed> $haystack
*/
protected function assertContainsOnlyObject(iterable $haystack, string $message = ''): void
{
Assert::assertContainsOnlyObject($haystack, $message);
}

/**
* @param iterable<mixed> $haystack
*/
protected function assertContainsOnlyResource(iterable $haystack, string $message = ''): void
{
Assert::assertContainsOnlyResource($haystack, $message);
}

/**
* @param iterable<mixed> $haystack
*/
protected function assertContainsOnlyClosedResource(iterable $haystack, string $message = ''): void
{
Assert::assertContainsOnlyClosedResource($haystack, $message);
}

/**
* @param iterable<mixed> $haystack
*/
protected function assertContainsOnlyScalar(iterable $haystack, string $message = ''): void
{
Assert::assertContainsOnlyScalar($haystack, $message);
}

/**
* @param iterable<mixed> $haystack
*/
protected function assertContainsOnlyString(iterable $haystack, string $message = ''): void
{
Assert::assertContainsOnlyString($haystack, $message);
}

/**
* Asserts the number of elements of an array, Countable or Traversable.
*
Expand Down Expand Up @@ -833,14 +1090,54 @@ protected function assertNotContains(mixed $needle, iterable $haystack, string $

/**
* Asserts that a haystack does not contain only values of a given type.
* @param 'array'|'bool'|'boolean'|'callable'|'double'|'float'|'int'|'integer'|'iterable'|'null'|'numeric'|'object'|'real'|'resource'|'resource (closed)'|'scalar'|'string' $type
* @param 'array'|'bool'|'boolean'|'callable'|'double'|'float'|'int'|'integer'|'iterable'|'null'|'numeric'|'object'|'real'|'resource'|'resource (closed)'|'scalar'|'string'|class-string $type
* @param iterable<mixed> $haystack
*/
protected function assertNotContainsOnly(string $type, iterable $haystack, ?bool $isNativeType = null, string $message = ''): void
{
Assert::assertNotContainsOnly($type, $haystack, $isNativeType, $message);
$replacement = match ($type) {
'array' => 'assertContainsNotOnlyArray',
'bool', 'boolean' => 'assertContainsNotOnlyBool',
'callable' => 'assertContainsNotOnlyCallable',
'double', 'float', 'real' => 'assertContainsNotOnlyFloat',
'int', 'integer' => 'assertContainsNotOnlyInt',
'iterable' => 'assertContainsNotOnlyIterable',
'null' => 'assertContainsNotOnlyNull',
'numeric' => 'assertContainsNotOnlyNumeric',
'object' => 'assertContainsNotOnlyObject',
'resource' => 'assertContainsNotOnlyResource',
'resource (closed)' => 'assertContainsNotOnlyClosedResource',
'scalar' => 'assertContainsNotOnlyScalar',
'string' => 'assertContainsNotOnlyString',
default => null,
};

if (is_string($replacement)) {
trigger_error(
sprintf(
'%s is deprecated since PHPUnit 11.5. Please use %s($haystack) instead of assertContainsNotOnly(\'%s\', $haystack)',
__FUNCTION__,
$replacement,
$type,
),
E_USER_DEPRECATED,
);

$this->$replacement($haystack, $message);
} else {
trigger_error(
sprintf(
'assertNotContainsOnly() is deprecated since PHPUnit 11.5. Please use assertContainsNotOnlyInstancesOf(\'%s\', $haystack) instead of assertNotContainsOnly(\'%s\', $haystack).',
$type,
$type,
),
E_USER_DEPRECATED,
);

Assert::assertContainsNotOnlyInstancesOf($type, $haystack, $message);
}
}

/**
* Asserts the number of elements of an array, Countable or Traversable.
*
Expand Down