Skip to content

Use has_config() in get_config() to prevent warnings on null values #5880

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
danielbachhuber merged 3 commits into from
Dec 13, 2023
Merged

Use has_config() in get_config() to prevent warnings on null values #5880

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ccf4e47
In get_config(), use has_config() to test for key existence instead o…
dougaxe1 Nov 21, 2023
8ae1d35
Add test for null config value in get_config
dougaxe1 Nov 22, 2023
a83b6e6
Remove trailing space in test
dougaxe1 Nov 22, 2023
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
2 changes: 1 addition & 1 deletion php/class-wp-cli.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1254,7 +1254,7 @@ public static function get_config( $key = null ) {
return self::get_runner()->config;
}

if ( ! isset( self::get_runner()->config[ $key ] ) ) {
if ( ! self::has_config( $key ) ) {
self::warning( "Unknown config option '$key'." );
return null;
}
Expand Down
26 changes: 26 additions & 0 deletions tests/test-configurator.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
<?php

use WP_CLI\Configurator;
use WP_CLI\Loggers;
use WP_CLI\Tests\TestCase;

class ConfiguratorTest extends TestCase {
Expand Down Expand Up @@ -58,4 +59,29 @@ public function testExtractAssocDoubleDashInValue() {
$this->assertEquals( 'test', $args[1][0][0] );
$this->assertEquals( 'text--text', $args[1][0][1] );
}

/**
* WP_CLI::get_config does not show warnings for null values.
*/
public function testNullGetConfig() {
// Init config so there is a config to check.
$runner = WP_CLI::get_runner();
$runner->init_config();

// Previous
$prev_logger = WP_CLI::get_logger();

$logger = new Loggers\Execution();
WP_CLI::set_logger( $logger );

$has_config = WP_CLI::has_config( 'url' );
$get_config = WP_CLI::get_config( 'url' );

$this->assertTrue( $has_config, 'has_config() is not true' );
$this->assertTrue( false === strpos( $logger->stderr, 'Warning' ), 'Logger contains a "Warning"' );
$this->assertNull( $get_config, 'get_config() is not null' );

// Restore
WP_CLI::set_logger( $prev_logger );
}
}