feat: add CLI command to manage users #833

kenjis · 2023-09-14T06:30:35Z

Description
Supersedes #579
Closes #566

Add command shield:user to manage users:

            shield:user create -n newusername -e [email protected]

            shield:user activate -n username
            shield:user activate -e [email protected]

            shield:user deactivate -n username
            shield:user deactivate -e [email protected]

            shield:user changename -n username --new-name newusername
            shield:user changename -e [email protected] --new-name newusername

            shield:user changeemail -n username --new-email [email protected]
            shield:user changeemail -e [email protected] --new-email [email protected]

            shield:user delete -i 123
            shield:user delete -n username
            shield:user delete -e [email protected]

            shield:user password -n username
            shield:user password -e [email protected]

            shield:user list
            shield:user list -n username -e [email protected]

            shield:user addgroup -n username -g mygroup
            shield:user addgroup -e [email protected] -g mygroup

            shield:user removegroup -n username -g mygroup
            shield:user removegroup -e [email protected] -g mygroup

TODO

remove exit()
fix if conditions
fix hard-coded table names
fix hard-coded validation rules

Checklist:

Securely signed commits
Component(s) with PHPDoc blocks, only if necessary or adds value
Unit testing, with >80% coverage
User guide updated
Conforms to style guide

src/Commands/User.php

datamweb · 2023-09-16T07:54:53Z

src/Commands/User.php

+        $action = $params[0] ?? null;
+
+        if ($action === null || ! in_array($action, $this->validActions, true)) {
+            $this->write(


If not valid, display a form to select valid items.

This PR is too big. If you want to add more features, you should send another PR.

I am more concerned about the current features working properly than usability.

I am more concerned about the current features working properly than usability.

Ok I get it, I haven't exactly checked out this PR yet. I will try to continue with this in mind.

datamweb · 2023-09-16T07:55:18Z

src/Commands/User.php

+                    $this->removegroup($group, $username, $email);
+                    break;
+            }
+        } catch (RuntimeException $e) {


Throw exception! If not valid, display a form to select valid items.

datamweb · 2023-09-16T07:58:59Z

src/Commands/User.php

+
+class User extends BaseCommand
+{
+    private static ?InputOutput $io = null;


$io I think it is short, and it is not understandable.
https://phpmd.org/rules/naming.html#shortvariable

datamweb · 2023-09-16T08:02:28Z

src/Commands/User.php

+        if ($password !== $passwordConfirm) {
+            $this->write("The passwords don't match", 'red');
+
+            throw new RuntimeException("The passwords don't match");


Not good. Do not remove the user from the process. Display new form to re-enter data.

src/Commands/User.php

datamweb · 2023-09-16T08:13:45Z

src/Commands/User.php

+        if ($user === null) {
+            $this->write("User doesn't exist", 'red');
+
+            throw new RuntimeException("User doesn't exist");


In all cases, I disagree with throw.

The exception will be caught in run() method.
It is the replacement of exit().

src/Controllers/RegisterController.php

src/Validation/RegistrationValidationRules.php

kenjis · 2023-09-16T10:45:08Z

@robertogerola @cijagani Try this, if you can.

…ed actions

CLI::getOption() cannot use in testing now.

Co-authored-by: Pooya Parsa <[email protected]>

The validation rules may be an array or string.

RuntimeException is too wide.

datamweb

I haven't had a chance to review, and I probably won't be able to for a few days.
It seems that people are waiting for this PR. You can merge.

kenjis · 2023-09-19T20:09:35Z

Okay. The test code has been improved, so there should be no major bugs.
Testing this feature is welcome!

kenjis marked this pull request as draft September 14, 2023 06:30

kenjis added the new feature PRs for new features label Sep 14, 2023

kenjis force-pushed the feat-user-command branch 3 times, most recently from 0d08c19 to 8ead772 Compare September 16, 2023 04:58

kenjis mentioned this pull request Sep 16, 2023

Spark cli user command #579

Closed

kenjis force-pushed the feat-user-command branch 2 times, most recently from 6bb4aba to da466af Compare September 16, 2023 07:09

kenjis marked this pull request as ready for review September 16, 2023 07:10

datamweb reviewed Sep 16, 2023

View reviewed changes

kenjis marked this pull request as draft September 16, 2023 09:05

kenjis marked this pull request as ready for review September 16, 2023 09:28

cijagani approved these changes Sep 16, 2023

View reviewed changes

robertogerola and others added 16 commits September 16, 2023 22:13

Added spark user command to manage users

05c57b5

Added warning on call without action and group option for group relat…

744758a

…ed actions

Ask for group if not specified in group related actions

0e0c64d

Changed the options for passing new username (-n) and new email (-m)

438c868

Improved readability of model loading

8504e0b

Improved readability of model loading

9793acf

docs: composer cs-fix

207721b

docs: fix @param

feca2ee

style: add line breaks

b4f653c

feat: improve help message and change options

c187eb1

refactor: use ::class for model()

5f32cba

fix: list command shows token secrets

010c235

refactor: use camelCase for variable names

f6a451c

feat: remove space in message

1ea6d4d

refactor: remove uneeded join()

3e99226

refactor: use $params

a050366

CLI::getOption() cannot use in testing now.

kenjis and others added 19 commits September 16, 2023 22:13

test: add tests

c5812d2

style: break long line

674a192

refactor: rename method name

b3e278d

feat: add getFirstOutput()

4525299

test: use getFirstOutput()

6e9fb89

test: add tests

df0c515

refactor: extract checkUserExists() method

cd13f0c

fix: remove unused $validationRules default value

69a5497

fix: remove unneeded Validation::setRules()

47fb504

fix: revert method visibility

293d43f

fix: add helper('setting')

b3e13f6

fix: description of the command

6f578b1

Co-authored-by: Pooya Parsa <[email protected]>

fix: validation rules for prompt()

a54e30f

fix: remove strong_password rule that can't be used

1be4d39

feat: run CLI::prompt() for testing validation

ef6b59a

fix: incorrect validation rule for email

c78bcbf

fix: password validation rules manipulation

443f0e2

The validation rules may be an array or string.

refactor: add specific Exceptions

774997b

RuntimeException is too wide.

refactor: put $this->write() in one place

fade2c1

kenjis force-pushed the feat-user-command branch from 8eef957 to fade2c1 Compare September 16, 2023 13:13

fix: typo in Exception classname

e546f27

kenjis changed the title ~~feat: spark shield:user command~~ feat: add CLI command to manage users Sep 16, 2023

robertogerola approved these changes Sep 18, 2023

View reviewed changes

datamweb approved these changes Sep 19, 2023

View reviewed changes

kenjis merged commit fc0926b into codeigniter4:develop Sep 19, 2023
29 checks passed

kenjis deleted the feat-user-command branch September 19, 2023 20:09

yassinedoghri mentioned this pull request Sep 20, 2023

Spark user creation is not working belykhk/castopod-ansible-playbook#1

Closed

This was referenced Sep 22, 2023

docs: add about shield:user command #848

Merged

fix: remove strong_password from shield:user validation rules #853

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add CLI command to manage users #833

feat: add CLI command to manage users #833

kenjis commented Sep 14, 2023 •

edited

Loading

datamweb Sep 16, 2023

kenjis Sep 16, 2023

datamweb Sep 16, 2023

datamweb Sep 16, 2023

datamweb Sep 16, 2023

datamweb Sep 16, 2023

datamweb Sep 16, 2023

kenjis Sep 16, 2023

kenjis commented Sep 16, 2023

datamweb left a comment

kenjis commented Sep 19, 2023

feat: add CLI command to manage users #833

feat: add CLI command to manage users #833

Conversation

kenjis commented Sep 14, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kenjis commented Sep 16, 2023

datamweb left a comment

Choose a reason for hiding this comment

kenjis commented Sep 19, 2023

kenjis commented Sep 14, 2023 •

edited

Loading