Skip to content

Warn when an invalid role is provided for wp user update #406

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 6 commits into from
May 30, 2023
Merged

Warn when an invalid role is provided for wp user update #406

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
6d8b030
Added the Invalid role check for the wp user update command
SH4LIN May 26, 2023
b0e82e1
- Used validate_role() function to validate the role.
SH4LIN May 26, 2023
5d8ecc0
- Functional test added
SH4LIN May 26, 2023
9403a9d
- Functional test for right scenario added
SH4LIN May 26, 2023
ee96a33
- Setting up the user before testing.
SH4LIN May 26, 2023
e770f5f
- Functional test added for the wp user update and assertion added fo…
SH4LIN May 26, 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
20 changes: 20 additions & 0 deletions features/user.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -239,6 +239,26 @@ Feature: Manage WordPress users
| Field | Value |
| roles | |

Scenario: Invalid User Role
Given a WP install
When I run `wp user create testuser4 [email protected]`
And I try `wp user update testuser4 --role=banana`
Then STDERR should be:
"""
Warning: Role doesn't exist: banana
"""
And STDOUT should contain:
"""
Success:
"""
And the return code should be 0

When I run `wp user get admin --field=roles`
Then STDOUT should be:
"""
administrator
"""

Scenario: Managing user capabilities
Given a WP install

Expand Down
15 changes: 12 additions & 3 deletions src/User_Command.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -529,6 +529,10 @@ public function update( $args, $assoc_args ) {
unset( $assoc_args['user_login'] );
}

if ( isset( $assoc_args['role'] ) ) {
self::validate_role( $assoc_args['role'], true );
}

$user_ids = [];
foreach ( $this->fetcher->get_many( $args ) as $user ) {
$user_ids[] = $user->ID;
Expand Down Expand Up @@ -1156,12 +1160,17 @@ public function reset_password( $args, $assoc_args ) {
/**
* Checks whether the role is valid
*
* @param string
* @param $role string
* @param $warn_user_only bool
*/
private static function validate_role( $role ) {
private static function validate_role( $role, $warn_user_only = false ) {

if ( ! empty( $role ) && null === get_role( $role ) ) {
WP_CLI::error( "Role doesn't exist: {$role}" );
if ( $warn_user_only ) {
WP_CLI::warning( "Role doesn't exist: {$role}" );
} else {
WP_CLI::error( "Role doesn't exist: {$role}" );
}
}

}
Expand Down