Skip to content

Add PHPUnit messages for authentication test assertions. #12898

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
techanvil merged 1 commit into from
Jun 19, 2026
Merged

Add PHPUnit messages for authentication test assertions. #12898

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
26 changes: 12 additions & 14 deletions tests/phpunit/integration/Core/Authentication/Clients/Client_FactoryTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,6 @@
* @link https://sitekit.withgoogle.com
*/

// phpcs:disable PHPCS.PHPUnit.RequireAssertionMessage.MissingAssertionMessage -- Ignoring assertion message rule, messages to be added in #10760

namespace Google\Site_Kit\Tests\Core\Authentication\Clients;

use Google\Site_Kit\Context;
Expand Down Expand Up @@ -47,17 +45,17 @@ public function test_create_client() {
)
);

$this->assertInstanceOf( Google_Site_Kit_Proxy_Client::class, $client );
$this->assertEquals( 3, $client->getConfig( 'retry' )['retries'] );
$this->assertEquals( Google_Proxy::get_application_name(), $client->getHttpClient()->getConfig( 'headers' )['User-Agent'] );
$this->assertEquals( $client_id, $client->getClientId() );
$this->assertEquals( $client_secret, $client->getClientSecret() );
$this->assertEquals( $redirect_uri, $client->getRedirectUri() );
$this->assertEquals( 'offline', $client->getConfig( 'access_type' ) );
$this->assertEquals( 'consent', $client->getConfig( 'prompt' ) );
$this->assertEquals( $required_scopes, $client->getScopes() );
$this->assertEquals( $token, $client->getAccessToken() );
$this->assertEquals( $login_hint, $client->getConfig( 'login_hint' ) );
$this->assertInstanceOf( Google_Site_Kit_Proxy_Client::class, $client, 'Created client should be a Site Kit proxy client.' );
$this->assertEquals( 3, $client->getConfig( 'retry' )['retries'], 'Client should use the default retry count.' );
$this->assertEquals( Google_Proxy::get_application_name(), $client->getHttpClient()->getConfig( 'headers' )['User-Agent'], 'Client user agent should use the proxy application name.' );
$this->assertEquals( $client_id, $client->getClientId(), 'Client ID should match the provided value.' );
$this->assertEquals( $client_secret, $client->getClientSecret(), 'Client secret should match the provided value.' );
$this->assertEquals( $redirect_uri, $client->getRedirectUri(), 'Redirect URI should match the provided value.' );
$this->assertEquals( 'offline', $client->getConfig( 'access_type' ), 'Client access type defaults to offline.' );
$this->assertEquals( 'consent', $client->getConfig( 'prompt' ), 'Client prompt defaults to consent.' );
$this->assertEquals( $required_scopes, $client->getScopes(), 'Client scopes should match the required scopes.' );
$this->assertEquals( $token, $client->getAccessToken(), 'Client access token should match the provided token.' );
$this->assertEquals( $login_hint, $client->getConfig( 'login_hint' ), 'Client login hint should match the provided email.' );
}

/**
Expand All @@ -72,7 +70,7 @@ function () use ( $ip_resolve ) {
);

$client = Client_Factory::create_client( array() );
$this->assertEquals( $expected_value, $client->getHttpClient()->getConfig( 'force_ip_resolve' ) );
$this->assertEquals( $expected_value, $client->getHttpClient()->getConfig( 'force_ip_resolve' ), 'Client IP resolve value should match the expected value.' );
}

public function data_config_ip_resolve_values() {
Expand Down
10 changes: 4 additions & 6 deletions tests/phpunit/integration/Core/Authentication/Clients/Google_Site_Kit_ClientTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,6 @@
* @link https://sitekit.withgoogle.com
*/

// phpcs:disable PHPCS.PHPUnit.RequireAssertionMessage.MissingAssertionMessage -- Ignoring assertion message rule, messages to be added in #10760

namespace Google\Site_Kit\Tests\Core\Authentication\Clients;

use Google\Site_Kit\Core\Authentication\Clients\Google_Site_Kit_Client;
Expand All @@ -32,22 +30,22 @@ public function test_getQuotaUser__basic_url() {
wp_set_current_user( $user_id );
self::force_home_url( 'https://example.com' );

$this->assertEquals( "https://{$user_id}@example.com", Google_Site_Kit_Client::getQuotaUser() );
$this->assertEquals( "https://{$user_id}@example.com", Google_Site_Kit_Client::getQuotaUser(), 'Quota user should include the current user and home URL.' );
}

public function test_getQuotaUser__port_is_ignored() {
$user_id = $this->factory()->user->create();
wp_set_current_user( $user_id );
self::force_home_url( 'https://example.org:9000' );

$this->assertEquals( "https://{$user_id}@example.org", Google_Site_Kit_Client::getQuotaUser() );
$this->assertEquals( "https://{$user_id}@example.org", Google_Site_Kit_Client::getQuotaUser(), 'Quota user should not include the home URL port.' );
}

public function test_getQuotaUser__no_user() {
wp_set_current_user( 0 );
self::force_home_url( 'https://example.com' );

$this->assertEquals( 'https://0@example.com', Google_Site_Kit_Client::getQuotaUser() );
$this->assertEquals( 'https://0@example.com', Google_Site_Kit_Client::getQuotaUser(), 'Quota user ID should be 0 when no user is logged in.' );
}

public function test_getQuotaUser__subdirectory_url() {
Expand All @@ -56,6 +54,6 @@ public function test_getQuotaUser__subdirectory_url() {

self::force_home_url( 'http://example.com/subdirectory' );

$this->assertEquals( "http://{$user_id}@example.com/subdirectory", Google_Site_Kit_Client::getQuotaUser() );
$this->assertEquals( "http://{$user_id}@example.com/subdirectory", Google_Site_Kit_Client::getQuotaUser(), 'Quota user should include the home URL subdirectory.' );
}
}
9 changes: 4 additions & 5 deletions tests/phpunit/integration/Core/Authentication/Clients/OAuth2Test.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,6 @@
* @link https://sitekit.withgoogle.com
*/

// phpcs:disable PHPCS.PHPUnit.RequireAssertionMessage.MissingAssertionMessage -- Ignoring assertion message rule, messages to be added in #10760

namespace Google\Site_Kit\Tests\Core\Authentication\Clients;

use Google\Site_Kit_Dependencies\GuzzleHttp\Psr7\Utils;
Expand Down Expand Up @@ -39,11 +37,11 @@ public function test_generateCredentialsRequest() {

// Request with no params should have an empty body.
$request = $auth->generateCredentialsRequest();
$this->assertEquals( array(), self::get_parsed_request_body( $request ) );
$this->assertEquals( array(), self::get_parsed_request_body( $request ), 'Credentials request body should be empty without params.' );

// Request with params should also have an empty body, unless a refresh token is set.
$request = $auth->generateCredentialsRequest();
$this->assertEquals( array(), self::get_parsed_request_body( $request ) );
$this->assertEquals( array(), self::get_parsed_request_body( $request ), 'Credentials request body should be empty without refresh token.' );

// Request with refresh token and params should have them in the body accordingly.
$refresh_token = 'test-refresh-token';
Expand All @@ -56,7 +54,8 @@ public function test_generateCredentialsRequest() {
'refresh_token' => $refresh_token,
),
),
self::get_parsed_request_body( $request )
self::get_parsed_request_body( $request ),
'Credentials request body should include refresh token params.'
);
}
}
Loading