add --no-admin flag to registration script #3836

bwindels · 2018-09-10T17:34:30Z

As the title says, I would like this option to be able to register non-admin users without interaction for the riot-web end-to-end tests, and thought it was a good way for a first synapse PR :)

erikjohnston

Woo, thanks, just a few nits

erikjohnston · 2018-09-11T08:58:46Z

scripts/register_new_matrix_user

+        help="Register new user as an admin. Will prompt if --regular-user is not set.",
+    )
+    parser.add_argument(
+        "--regular-user",


Traditionally this would probably be called --no-admin, to make it clearer that its the opposite of --admin.

erikjohnston · 2018-09-11T09:00:20Z

scripts/register_new_matrix_user

-    register_new_user(args.user, args.password, args.server_url, secret, args.admin)
+    if args.admin and args.regular_user:
+        print "Both --admin and --regular-user are set, choose either."
+        sys.exit(1)


Rather than doing this manually, we should probably use the inbuilt argparse conflict functionality: https://docs.python.org/2/howto/argparse.html#conflicting-options

erikjohnston · 2018-09-11T09:07:07Z

scripts/register_new_matrix_user

+        print "Both --admin and --regular-user are set, choose either."
+        sys.exit(1)
+
+    admin = True if args.admin else False if args.regular_user else None


I honestly can't remember how multiple if statements like this work, can we write split it out into actual if statements please?

(You can also write this as args.admin or args.regular_user or None, but that's a bit special too)

richvdh · 2018-09-18T18:00:24Z

Fixes #2310

spantaleev · 2018-09-18T19:24:05Z

Instead of having 2 different flags (--admin and --regular-user) and trying to detect conflicts, why not just:

drop the current --admin argument
introduce a new --type=admin|user argument, which defaults to 'user'.. Or defaults to None and asks interactively

It's backward-incompatible, but at least it does things cleanly.

bwindels · 2018-09-19T11:14:33Z

Instead of having 2 different flags (--admin and --regular-user) and trying to detect conflicts, why not just:
* drop the current `--admin` argument

* introduce a new `--type=admin|user` argument, which defaults to `'user'`.. Or defaults to `None` and asks interactively
It's backward-incompatible, but at least it does things cleanly.

Opted for --no-admin because it's backwards compatible as you mentioned.

bwindels · 2018-09-19T11:34:47Z

Not sure why the tests are failing though ...

richvdh · 2018-09-19T15:58:50Z

Not sure why the tests are failing though ...

try merging latest develop; if nothing else, it will make circleci tell us why the tests are failing.

spantaleev · 2018-09-19T16:46:34Z

As it is now:

case 1: if only --admin is passed, admin = True. This is ok. ✔️
case 2: if only --no-admin is passed, args.admin would be False and args.no_admin would be False (?!), which makes admin = False or False or None, which yields admin = None. This is wrong.. And the conditional is also very weird. ❌
case 3: if neither --admin, nor --no-admin is passed, args.admin would be False and args.no_admin would be True (?!), which makes admin = True. This is wrong. ❌

So it seems like it's generally wrong now and also backward-incompatible (see case 3).

…bool

bwindels · 2018-09-19T19:31:44Z

Travis says:

Looking at these files:
----
1. /home/travis/build/matrix-org/synapse/scripts/register_new_matrix_user
----
No new newsfragments found on this branch.
ERROR: InvocationError for command '/home/travis/build/matrix-org/synapse/.tox/check-newsfragment/bin/python -m towncrier.check --compare-with=origin/develop' (exited with code 1)
___________________________________ summary ____________________________________
ERROR:   check-newsfragment: commands failed
The command "tox -e $TOX_ENV" exited with 1.

richvdh · 2018-09-20T08:46:35Z

No new newsfragments found on this branch.

In other words: "Please add a changelog fragment as per CONTRIBUTING.rst"

bwindels · 2018-09-27T18:19:09Z

Not sure why the tests are failing, but trying if merging in develop helps ...

bwindels · 2018-09-28T08:16:27Z

Tests on Travis seem to have passed, but they're still appearing as pending here for some reason ...

richvdh

lgtm

richvdh · 2018-09-28T11:55:58Z

Tests on Travis seem to have passed, but they're still appearing as pending here for some reason ...

this happens occasionally if there is a problem when Travis comes to send the memo to github that the builds completed. I've restarted them.

fixed

richvdh · 2018-09-28T12:36:29Z

(thanks for bearing with us on this, @bwindels!)

add --regular-user flag to registration script

ceec6ce

bwindels requested a review from erikjohnston September 10, 2018 17:35

erikjohnston previously requested changes Sep 11, 2018

View reviewed changes

erikjohnston assigned bwindels Sep 11, 2018

fix PR review

4311f86

remove not as the flags is set to false

d4c389f

bwindels added 2 commits September 19, 2018 18:18

make clear in help text when will be prompted

81b56f8

Merge branch 'develop' into bwindels/registerasregularuser

77f1de1

bwindels added 2 commits September 19, 2018 20:55

fix logic, store_true/false doesn't set None by default but opposite …

bd37c4a

…bool

didnt mean to commit this, obviously

48957d2

bwindels added 2 commits September 21, 2018 12:51

add changelog

a776ccd

Merge branch 'develop' into bwindels/registerasregularuser

c5e1de6

bwindels changed the title ~~add --regular-user flag to registration script~~ add --no-admin flag to registration script Sep 27, 2018

richvdh self-requested a review September 28, 2018 10:31

richvdh approved these changes Sep 28, 2018

View reviewed changes

richvdh merged commit 9a8bbc9 into develop Sep 28, 2018

richvdh mentioned this pull request Sep 28, 2018

register_new_matrix_user - impossible to create non-root user non-interactively #2310

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add --no-admin flag to registration script #3836

add --no-admin flag to registration script #3836

bwindels commented Sep 10, 2018

erikjohnston left a comment

erikjohnston Sep 11, 2018

erikjohnston Sep 11, 2018

erikjohnston Sep 11, 2018

richvdh commented Sep 18, 2018

spantaleev commented Sep 18, 2018

bwindels commented Sep 19, 2018

bwindels commented Sep 19, 2018

richvdh commented Sep 19, 2018

spantaleev commented Sep 19, 2018

bwindels commented Sep 19, 2018

richvdh commented Sep 20, 2018

bwindels commented Sep 27, 2018

bwindels commented Sep 28, 2018

richvdh left a comment

richvdh commented Sep 28, 2018

richvdh commented Sep 28, 2018

add --no-admin flag to registration script #3836

add --no-admin flag to registration script #3836

Conversation

bwindels commented Sep 10, 2018

erikjohnston left a comment

Choose a reason for hiding this comment

erikjohnston Sep 11, 2018

Choose a reason for hiding this comment

erikjohnston Sep 11, 2018

Choose a reason for hiding this comment

erikjohnston Sep 11, 2018

Choose a reason for hiding this comment

richvdh commented Sep 18, 2018

spantaleev commented Sep 18, 2018

bwindels commented Sep 19, 2018

bwindels commented Sep 19, 2018

richvdh commented Sep 19, 2018

spantaleev commented Sep 19, 2018

bwindels commented Sep 19, 2018

richvdh commented Sep 20, 2018

bwindels commented Sep 27, 2018

bwindels commented Sep 28, 2018

richvdh left a comment

Choose a reason for hiding this comment

richvdh commented Sep 28, 2018

richvdh commented Sep 28, 2018