add user password lock option to user module #37962

lazouz · 2018-03-26T21:44:05Z

SUMMARY

This adds password lock feature (lock -l command) tu user module.

ISSUE TYPE

Feature Pull Request

COMPONENT NAME

module : user

ANSIBLE VERSION

ansible 2.4.3.0

ADDITIONAL INFORMATION

I have not written tests for this feature, because i don't know if it can be useful

fixes #29466

ansibot · 2018-03-26T21:49:20Z

cc @sfromm
click here for bot help

ansibot · 2018-03-26T22:48:17Z

The test ansible-test sanity --test pep8 [explain] failed with 1 error:

lib/ansible/modules/system/user.py:178:161: E501 line too long (169 > 160 characters)

The test ansible-test sanity --test validate-modules [explain] failed with 2 errors:

lib/ansible/modules/system/user.py:0:0: E309 version_added for new option (password_lock) should be 2.6. Currently 2.4
lib/ansible/modules/system/user.py:0:0: E325 argument_spec for "password_lock" defines type="bool" but documentation does not

click here for bot help

Akasurde · 2018-03-27T07:17:43Z

lib/ansible/modules/system/user.py

@@ -173,6 +173,10 @@
            - An expiry time for the user in epoch, it will be ignored on platforms that do not support this.
              Currently supported on Linux, FreeBSD, and DragonFlyBSD.
        version_added: "1.9"
+    password_lock:
+        description:
+            - lock the password (usermod -L ) by adding a '!' at the beggining of the password user entry. This option does not disable the user, only lock the password.


s/beggining/beginning/

Akasurde · 2018-03-27T07:17:53Z

lib/ansible/modules/system/user.py

+    password_lock:
+        description:
+            - lock the password (usermod -L ) by adding a '!' at the beggining of the password user entry. This option does not disable the user, only lock the password.
+        version_added: "2.4"


version_added: "2.6"

lazouz · 2018-03-27T09:02:05Z

I did what @ansibot told me :)

ansibot · 2018-03-27T09:27:53Z

The test ansible-test sanity --test pep8 [explain] failed with 1 error:

lib/ansible/modules/system/user.py:178:107: W291 trailing whitespace

click here for bot help

lazouz · 2018-03-27T09:40:05Z

ooops. I fixed.

lazouz · 2018-03-27T09:57:19Z

now i only need @Akasurde validation ;)

lazouz · 2018-04-04T14:25:37Z

hello @Akasurde
I think I've done what you asked for !
If you have some time, can you give a glance to the code ?

cheers

ansibot · 2018-04-16T17:12:14Z

The test ansible-test sanity --test pep8 [explain] failed with 1 error:

lib/ansible/modules/system/user.py:176:47: W291 trailing whitespace

click here for bot help

lazouz · 2018-04-17T13:19:42Z

hey @Akasurde @bcoca is everything all right for you now ?

bcoca · 2018-04-16T17:07:45Z

lib/ansible/modules/system/user.py

@@ -909,6 +922,9 @@ def modify_user(self):
            cmd.append('-e')
            cmd.append(str(int(days)))

+        if self.password_lock:
+            cmd.append('-L')


this is incorrect for freebsd, -L refers to login class, not password lock, just look at a few lines above

I've rewrited the lock/unlock commands for FreeBSD and NetBSD, finally, and updated the doc.

ansibot · 2018-04-17T16:43:25Z

The test ansible-test sanity --test pylint [explain] failed with 1 error:

lib/ansible/modules/system/user.py:975:0: syntax-error unindent does not match any outer indentation level (&lt;string&gt;, line 975)

The test ansible-test sanity --test ansible-doc --python 2.6 [explain] failed with 1 error:

lib/ansible/modules/system/user.py:0:0: has a documentation error formatting or is missing documentation.

The test ansible-test sanity --test ansible-doc --python 2.7 [explain] failed with 1 error:

lib/ansible/modules/system/user.py:0:0: has a documentation error formatting or is missing documentation.

The test ansible-test sanity --test ansible-doc --python 3.5 [explain] failed with 1 error:

lib/ansible/modules/system/user.py:0:0: has a documentation error formatting or is missing documentation.

The test ansible-test sanity --test ansible-doc --python 3.6 [explain] failed with 1 error:

lib/ansible/modules/system/user.py:0:0: has a documentation error formatting or is missing documentation.

The test ansible-test sanity --test ansible-doc --python 3.7 [explain] failed with 1 error:

lib/ansible/modules/system/user.py:0:0: has a documentation error formatting or is missing documentation.

The test ansible-test sanity --test compile --python 2.6 [explain] failed with 1 error:

lib/ansible/modules/system/user.py:975:66: SyntaxError: if self.uid is not None and info[2] != int(self.uid):

The test ansible-test sanity --test compile --python 2.7 [explain] failed with 1 error:

lib/ansible/modules/system/user.py:975:66: SyntaxError: if self.uid is not None and info[2] != int(self.uid):

The test ansible-test sanity --test compile --python 3.5 [explain] failed with 1 error:

lib/ansible/modules/system/user.py:975:66: SyntaxError: if self.uid is not None and info[2] != int(self.uid):

The test ansible-test sanity --test compile --python 3.6 [explain] failed with 1 error:

lib/ansible/modules/system/user.py:975:66: SyntaxError: if self.uid is not None and info[2] != int(self.uid):

The test ansible-test sanity --test compile --python 3.7 [explain] failed with 1 error:

lib/ansible/modules/system/user.py:975:66: SyntaxError: if self.uid is not None and info[2] != int(self.uid):

The test ansible-test sanity --test docs-build [explain] failed with the error:

Command "/usr/bin/python test/sanity/code-smell/docs-build.py" returned exit status 1.
>>> Standard Error
Traceback (most recent call last):
  File "test/sanity/code-smell/docs-build.py", line 55, in <module>
    main()
  File "test/sanity/code-smell/docs-build.py", line 17, in main
    raise subprocess.CalledProcessError(sphinx.returncode, cmd, output=stdout, stderr=stderr)
subprocess.CalledProcessError: Command '['make', 'singlehtmldocs']' returned non-zero exit status 2.

The test ansible-test sanity --test import --python 2.6 [explain] failed with 1 error:

lib/ansible/modules/system/user.py:975:66: IndentationError: unindent does not match any outer indentation level

The test ansible-test sanity --test import --python 2.7 [explain] failed with 2 errors:

lib/ansible/modules/system/user.py:0:0: IndentationError: unindent does not match any outer indentation level (user.py, line 975) (in /root/ansible/test/runner/.tox/minimal-py27/bin/importer.py:82)
lib/ansible/modules/system/user.py:975:66: IndentationError: unindent does not match any outer indentation level

The test ansible-test sanity --test import --python 3.5 [explain] failed with 2 errors:

lib/ansible/modules/system/user.py:0:0: IndentationError: unindent does not match any outer indentation level (user.py, line 975) (in /root/ansible/test/runner/.tox/minimal-py35/bin/importer.py:82)
lib/ansible/modules/system/user.py:975:66: IndentationError: unindent does not match any outer indentation level

The test ansible-test sanity --test import --python 3.6 [explain] failed with 2 errors:

lib/ansible/modules/system/user.py:0:0: IndentationError: unindent does not match any outer indentation level (user.py, line 975) (in /root/ansible/test/runner/.tox/minimal-py36/bin/importer.py:82)
lib/ansible/modules/system/user.py:975:66: IndentationError: unindent does not match any outer indentation level

The test ansible-test sanity --test import --python 3.7 [explain] failed with 2 errors:

lib/ansible/modules/system/user.py:0:0: IndentationError: unindent does not match any outer indentation level (user.py, line 975) (in /root/ansible/test/runner/.tox/minimal-py37/bin/importer.py:82)
lib/ansible/modules/system/user.py:975:66: IndentationError: unindent does not match any outer indentation level

The test ansible-test sanity --test pep8 [explain] failed with 4 errors:

lib/ansible/modules/system/user.py:969:14: E111 indentation is not a multiple of four
lib/ansible/modules/system/user.py:970:17: E121 continuation line under-indented for hanging indent
lib/ansible/modules/system/user.py:974:13: E122 continuation line missing indentation or outdented
lib/ansible/modules/system/user.py:975:13: E901 IndentationError: unindent does not match any outer indentation level

The test ansible-test sanity --test validate-modules [explain] failed with 3 errors:

lib/ansible/modules/system/user.py:0:0: E401 Python SyntaxError while parsing module
test/sanity/validate-modules/ignore.txt:1685:1: A102 Remove since "lib/ansible/modules/system/user.py" passes "E324" test
test/sanity/validate-modules/ignore.txt:1686:1: A102 Remove since "lib/ansible/modules/system/user.py" passes "E327" test

The test ansible-test sanity --test yamllint [explain] failed with 1 error:

lib/ansible/modules/system/user.py:975:66: python-syntax-error unindent does not match any outer indentation level (<unknown>, line 975)

click here for bot help

Akasurde

LGTM

lazouz · 2018-04-19T08:33:47Z

Thank you very much @bcoca @Akasurde for your time, your reviews and your validation !
It was my first contribution to an open source project, I think it won't be the last :) .

bcoca · 2018-04-19T14:07:05Z

@lazouz ~~just need to fix the CI errors and we can merge this,~~ ... refreshed page... thank you for contributing!

Akasurde · 2018-04-20T02:50:54Z

@lazouz Thanks for your contribution.

* add user password lock option to user module * fixup! add user password lock option to user module * add unlock, set no default * fixup! add unlock, set no default * fixup! fixup! add unlock, set no default * add lock password for FreeBSD, netBSD * fixup! add lock password for FreeBSD, netBSD

gaddman · 2018-07-15T23:14:12Z

Nice update to the module, I've just started using it. Noticed that it's not idempotent though. Do you have plans to add that? Just did some testing and shouldn't take much, something like this (at line 659) :

        if self.password_lock:
            if info[1] and info[1][0] != '!':
                cmd.append('-L')
        elif not self.password_lock:
            if info[1] and info[1][0] == '!':
                cmd.append('-U')

lazouz · 2018-07-18T08:57:07Z

The problem is : the behavior is different on every Operating System, the solution you have works for linux only. We have to find a solution for FreeBSD, etc.

gaddman · 2018-07-18T11:10:15Z

Yeah, there's a bit more to it for sure. Just checking FreeBSD docs, they prepend *LOCKED*, so it's still possible there at least. Also, the code I wrote above is missing logic for the case where no password is present. I'll have a bash at writing a PR in the next couple of weeks.

* add user password lock option to user module * fixup! add user password lock option to user module * add unlock, set no default * fixup! add unlock, set no default * fixup! fixup! add unlock, set no default * add lock password for FreeBSD, netBSD * fixup! add lock password for FreeBSD, netBSD

lazouz force-pushed the add_user_lock_password branch 2 times, most recently from e52e0fd to c027b90 Compare March 26, 2018 21:48

lazouz force-pushed the add_user_lock_password branch 2 times, most recently from 49b891b to 6da3124 Compare March 26, 2018 21:56

ansibot added ci_verified Changes made in this PR are causing tests to fail. needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. and removed core_review In order to be merged, this PR must follow the core review workflow. labels Mar 26, 2018

Akasurde requested changes Mar 27, 2018

View reviewed changes

Akasurde removed the needs_triage Needs a first human triage before being processed. label Mar 27, 2018

add user password lock option to user module

99b986c

lazouz force-pushed the add_user_lock_password branch from 6da3124 to 99b986c Compare March 27, 2018 08:59

ansibot removed the ci_verified Changes made in this PR are causing tests to fail. label Mar 27, 2018

ansibot added the ci_verified Changes made in this PR are causing tests to fail. label Mar 27, 2018

fixup! add user password lock option to user module

13f1f26

ansibot removed the ci_verified Changes made in this PR are causing tests to fail. label Mar 27, 2018

ansibot added stale_ci This PR has been tested by CI more than one week ago. Close and re-open this PR to get it retested. stale_review Updates were made after the last review and the last review is more than 7 days old. labels Apr 4, 2018

fixup! add unlock, set no default

a7f940b

ansibot added the ci_verified Changes made in this PR are causing tests to fail. label Apr 16, 2018

fixup! fixup! add unlock, set no default

4b09f9d

ansibot removed the ci_verified Changes made in this PR are causing tests to fail. label Apr 17, 2018

bcoca requested changes Apr 17, 2018

View reviewed changes

add lock password for FreeBSD, netBSD

1092755

fixup! add lock password for FreeBSD, netBSD

1885008

bcoca approved these changes Apr 18, 2018

View reviewed changes

Akasurde approved these changes Apr 19, 2018

View reviewed changes

ansibot added core_review In order to be merged, this PR must follow the core review workflow. and removed needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. labels Apr 19, 2018

bcoca merged commit a1759b0 into ansible:devel Apr 19, 2018

gaddman mentioned this pull request Aug 5, 2018

User locking is not idempotent #43670

Closed

ansible locked and limited conversation to collaborators Apr 27, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add user password lock option to user module #37962

add user password lock option to user module #37962

lazouz commented Mar 26, 2018 •

edited by bcoca

ansibot commented Mar 26, 2018

ansibot commented Mar 26, 2018

Akasurde Mar 27, 2018

lazouz Mar 27, 2018

Akasurde Mar 27, 2018

lazouz Mar 27, 2018

lazouz commented Mar 27, 2018

ansibot commented Mar 27, 2018

lazouz commented Mar 27, 2018

lazouz commented Mar 27, 2018

lazouz commented Apr 4, 2018

ansibot commented Apr 16, 2018

lazouz commented Apr 17, 2018

bcoca Apr 16, 2018

lazouz Apr 17, 2018

lazouz Apr 17, 2018

ansibot commented Apr 17, 2018

Akasurde left a comment

lazouz commented Apr 19, 2018 •

edited

bcoca commented Apr 19, 2018 •

edited

Akasurde commented Apr 20, 2018

gaddman commented Jul 15, 2018 •

edited

lazouz commented Jul 18, 2018

gaddman commented Jul 18, 2018

add user password lock option to user module #37962

add user password lock option to user module #37962

Conversation

lazouz commented Mar 26, 2018 • edited by bcoca

SUMMARY

ISSUE TYPE

COMPONENT NAME

ANSIBLE VERSION

ADDITIONAL INFORMATION

ansibot commented Mar 26, 2018

ansibot commented Mar 26, 2018

Akasurde Mar 27, 2018

Choose a reason for hiding this comment

lazouz Mar 27, 2018

Choose a reason for hiding this comment

Akasurde Mar 27, 2018

Choose a reason for hiding this comment

lazouz Mar 27, 2018

Choose a reason for hiding this comment

lazouz commented Mar 27, 2018

ansibot commented Mar 27, 2018

lazouz commented Mar 27, 2018

lazouz commented Mar 27, 2018

lazouz commented Apr 4, 2018

ansibot commented Apr 16, 2018

lazouz commented Apr 17, 2018

bcoca Apr 16, 2018

Choose a reason for hiding this comment

lazouz Apr 17, 2018

Choose a reason for hiding this comment

lazouz Apr 17, 2018

Choose a reason for hiding this comment

ansibot commented Apr 17, 2018

Akasurde left a comment

Choose a reason for hiding this comment

lazouz commented Apr 19, 2018 • edited

bcoca commented Apr 19, 2018 • edited

Akasurde commented Apr 20, 2018

gaddman commented Jul 15, 2018 • edited

lazouz commented Jul 18, 2018

gaddman commented Jul 18, 2018

lazouz commented Mar 26, 2018 •

edited by bcoca

lazouz commented Apr 19, 2018 •

edited

bcoca commented Apr 19, 2018 •

edited

gaddman commented Jul 15, 2018 •

edited