Skip to content

Security/EscapeOutput: add tests for namespaced names #2618

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

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Security/EscapeOutput: add tests for namespaced names #2618

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
59 changes: 57 additions & 2 deletions WordPress/Tests/Security/EscapeOutputUnitTest.1.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -258,7 +258,7 @@ echo esc_html_x( $some_nasty_var, 'context' ); // Ok.
<input type="hidden" name="some-action" value="<?php echo esc_attr_x( 'none', 'context' ); ?>" /><!-- OK. -->
<?php

echo PHP_VERSION_ID, PHP_VERSION, PHP_EOL, PHP_EXTRA_VERSION; // OK.
echo PHP_VERSION_ID, PHP_VERSION, \PHP_EOL, PHP_EXTRA_VERSION; // OK.

trigger_error( 'DEBUG INFO - ' . __METHOD__ . '::internal_domains: domain = ' . $domain ); // Bad.
Trigger_ERROR( $domain ); // Bad.
Expand Down Expand Up @@ -661,7 +661,7 @@ exit( status: esc_html( $foo ) ); // Ok.
die( status: esc_html( $foo ) ); // Ok.

exit( status: $foo ); // Bad.
die( status: $foo ); // Bad.
\die( status: $foo ); // Bad.

/*
* Issue https://github.com/WordPress/WordPress-Coding-Standards/issues/2552
Expand All @@ -687,3 +687,58 @@ _deprecated_function( __METHOD__, 'x.x.x', \ClassName::class ); // OK.
die( \MyNamespace\ClassName::class . ' has been abandoned' ); // OK.
echo 'Do not use ' . MyNamespace\ClassName::class; // OK.
_deprecated_function( __METHOD__, 'x.x.x', namespace\ClassName::class ); // OK.

/*
* Safeguard correct handling of all types of namespaced escaping and printing function calls.
*/
\printf( 'Hello %s', $foo ); // Bad.
MyNamespace\printf( 'Hello %s', $foo ); // Ok.
\MyNamespace\printf( 'Hello %s', $foo ); // Ok.
namespace\printf( 'Hello %s', $foo ); // Ok.
\printf( 'Hello %s', \esc_html( $foo ) ); // Ok.
\printf( 'Hello %s', MyNamespace\esc_html( $foo ) ); // Bad.
\printf( 'Hello %s', \MyNamespace\esc_html( $foo ) ); // Bad.
\printf( 'Hello %s', namespace\esc_html( $foo ) ); // Bad.

/*
* Safeguard correct handling of namespaced auto-escaped functions.
*/
echo \bloginfo( $var ); // Ok.
echo MyNamespace\bloginfo( $var ); // Bad.
echo \MyNamespace\bloginfo( $var ); // Bad.
echo namespace\bloginfo( $var ); // Bad.

/*
* Safeguard correct handling of namespaced unsafe printing functions.
*/
\_e( $text, 'my-domain' ); // Bad.
MyNamespace\_e( $text, 'my-domain' ); // Ok.
\MyNamespace\_e( $text, 'my-domain' ); // Ok.
namespace\_e( $text, 'my-domain' ); // Ok.

/*
* Safeguard correct handling of namespaced formatting functions.
*/
echo \sprintf( '%s', $var ); // Bad.
echo \sprintf( '%s', esc_html( $var ) ); // Ok.
echo MyNamespace\sprintf( '%s', esc_html( $var ) ); // Bad.
echo \MyNamespace\sprintf( '%s', esc_html( $var ) ); // Bad.
echo namespace\sprintf( '%s', esc_html( $var ) ); // Bad.

/*
* Safeguard correct handling of get_search_query() as the sniff has special logic to check the $escaped parameter.
*/
echo \get_search_query( true ); // Ok.
echo \get_search_query( false ); // Bad.
echo MyNamespace\get_search_query( true ); // Bad.
echo \MyNamespace\get_search_query( true ); // Bad.
echo namespace\get_search_query( true ); // Bad.

/*
* Safeguard correct handling of fully qualified functions with special parameter handling.
* These should still be recognized as WordPress functions and use their special logic.
*/
\trigger_error( 'This is fine' ); // Ok.
\trigger_error( error_level: E_USER_NOTICE ); // Ok from the sniff perspective (required $message parameter missing, but that's not our concern)
\trigger_error( esc_html( $message ) ); // Ok.
\trigger_error( $message ); // Bad.
24 changes: 23 additions & 1 deletion WordPress/Tests/Security/EscapeOutputUnitTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
namespace WordPressCS\WordPress\Tests\Security;

use PHP_CodeSniffer\Tests\Standards\AbstractSniffUnitTest;
use PHPCSUtils\BackCompat\Helper;

/**
* Unit test class for the EscapeOutput sniff.
Expand Down Expand Up @@ -37,6 +38,8 @@ final class EscapeOutputUnitTest extends AbstractSniffUnitTest {
public function getErrorList( $testFile = '' ) {
switch ( $testFile ) {
case 'EscapeOutputUnitTest.1.inc':
$phpcs_version = Helper::getVersion();

return array(
17 => 1,
19 => 1,
Expand Down Expand Up @@ -160,10 +163,29 @@ public function getErrorList( $testFile = '' ) {
655 => 1,
657 => 1,
663 => 1,
664 => 1,
// PHPCS 3.13.3 changed the tokenization of FQN exit/die it impacts directly how this test case
// behaves (see https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/1201).
664 => version_compare( $phpcs_version, '3.13.3', '>=' ) ? 1 : 0,
672 => 1,
673 => 1,
678 => 1,
694 => 1,
699 => 1,
700 => 1,
701 => 1,
707 => 1,
708 => 1,
709 => 1,
714 => 1,
722 => 1,
724 => 1,
725 => 1,
726 => 1,
732 => 1,
733 => 1,
734 => 1,
735 => 1,
744 => 1,
);

case 'EscapeOutputUnitTest.6.inc':
Expand Down