Strip trailing comments from /etc/default/passwd #43931

tomtastic · 2018-08-10T11:32:55Z

SUMMARY

Strip trailling comments from /etc/default/passwd like:
MINWEEKS=1 #MINWEEKS=2
MAXWEEKS=12 # MAXWEEKS=8
Which otherwise cause failures with "failed to read /etc/default/passwd: too many values to unpack"

ISSUE TYPE

Bugfix Pull Request

COMPONENT NAME

user module

ANSIBLE VERSION

ansible 2.4.2.0
  config file = /development/ansible/ansible.cfg
  configured module search path = [u'/root/.ansible/plugins/modules', u'/usr/share/ansible/plugins/modules']
  ansible python module location = /usr/lib/python2.7/site-packages/ansible
  executable location = /usr/bin/ansible
  python version = 2.7.5 (default, May 31 2018, 09:41:32) [GCC 4.8.5 20150623 (Red Hat 4.8.5-28)]

But present in the current 2.6+ releases too.

ADDITIONAL INFORMATION

Example input file

#ident  "@(#)passwd.dfl 1.8     14/01/24 SMI"
#
# Copyright (c) 1989, 2014, Oracle and/or its affiliates. All rights reserved.
#
MAXWEEKS=12 #MAXWEEKS=8
MINWEEKS=0  # MINWEEKS=4
PASSLENGTH=8
MINALPHA=1 # MINALPHA = 2
#WHITESPACE=YES
#

Old code fails with ValueError: too many values to unpack

import sys

def get_password_defaults():
    # Read password aging defaults
    minweeks = ''
    maxweeks = ''
    warnweeks = ''
    for line in open("/tmp/default_passwd", 'r'):
        line = line.strip()
        if (line.startswith('#') or line == ''):
            continue
        key, value = line.split('=')

        if key == "MINWEEKS":
            minweeks = value.rstrip('\n')
        elif key == "MAXWEEKS":
            maxweeks = value.rstrip('\n')
        elif key == "WARNWEEKS":
            warnweeks = value.rstrip('\n')

    return (minweeks, maxweeks, warnweeks)

minweeks, maxweeks, warnweeks = get_password_defaults()

Fixed code strips trailing comments

import sys
import re

def get_password_defaults():
    # Read password aging defaults
    minweeks = ''
    maxweeks = ''
    warnweeks = ''
    for line in open("/tmp/default_passwd", 'r'):
        line = line.strip()
        if (line.startswith('#') or line == ''):
            continue
        m = re.match(r'^([^#]*)#(.*)$', line)
        if m:  # The line contains a hash / comment
            line = m.group(1)
        key, value = line.split('=')

        if key == "MINWEEKS":
            minweeks = value.rstrip('\n')
        elif key == "MAXWEEKS":
            maxweeks = value.rstrip('\n')
        elif key == "WARNWEEKS":
            warnweeks = value.rstrip('\n')

    return (minweeks, maxweeks, warnweeks)

minweeks, maxweeks, warnweeks = get_password_defaults()

Strip trailling comments from /etc/default/passwd like MINWEEKS=1 #MINWEEKS=2 MAXWEEKS=12 # MAXWEEKS=8 Which otherwise cause failures with "failed to read /etc/default/passwd: too many values to unpack"

ansibot · 2018-08-10T11:39:29Z

cc @samdoran @sfromm
click here for bot help

ansibot · 2018-08-10T11:48:49Z

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

lib/ansible/modules/system/user.py:1496:0: syntax-error expected an indented block (&lt;string&gt;, line 1496)

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:1496:20: SyntaxError: line = m.group(1)

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

lib/ansible/modules/system/user.py:1496:20: SyntaxError: line = m.group(1)

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

lib/ansible/modules/system/user.py:1496:20: SyntaxError: line = m.group(1)

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

lib/ansible/modules/system/user.py:1496:20: SyntaxError: line = m.group(1)

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

lib/ansible/modules/system/user.py:1496:20: SyntaxError: line = m.group(1)

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 100, 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:1496:20: IndentationError: expected an indented block

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

lib/ansible/modules/system/user.py:0:0: IndentationError: expected an indented block (user.py, line 1496) (in /root/ansible/test/runner/.tox/minimal-py27/bin/importer.py:82)
lib/ansible/modules/system/user.py:1496:20: IndentationError: expected an indented block

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

lib/ansible/modules/system/user.py:0:0: IndentationError: expected an indented block (user.py, line 1496) (in /root/ansible/test/runner/.tox/minimal-py35/bin/importer.py:82)
lib/ansible/modules/system/user.py:1496:20: IndentationError: expected an indented block

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

lib/ansible/modules/system/user.py:0:0: IndentationError: expected an indented block (user.py, line 1496) (in /root/ansible/test/runner/.tox/minimal-py36/bin/importer.py:82)
lib/ansible/modules/system/user.py:1496:20: IndentationError: expected an indented block

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

lib/ansible/modules/system/user.py:0:0: IndentationError: expected an indented block (user.py, line 1496) (in /root/ansible/test/runner/.tox/minimal-py37/bin/importer.py:82)
lib/ansible/modules/system/user.py:1496:20: IndentationError: expected an indented block

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

lib/ansible/modules/system/user.py:1496:17: E112 expected an indented block

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:1186:1: A102 Remove since "lib/ansible/modules/system/user.py" passes "E324" test
test/sanity/validate-modules/ignore.txt:1187: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:1496:20: python-syntax-error expected an indented block (<unknown>, line 1496)

click here for bot help

samdoran · 2018-08-14T15:49:42Z

I have validated this failure and that your fix works. Please create a changelog fragment and I'll merge this. See fragments for examples.

samdoran · 2018-08-14T20:19:40Z

changelogs/fragments/43931-strip-trailing-comments.yml

@@ -0,0 +1,3 @@
+---
+bugfixes:
+- VMware Strip trailing comments in /etc/default/passwd (https://github.com/ansible/ansible/pull/43931)


I'm not sure about the "VMware" string here. Start the summary with - user - which will help group the changelog entries by module they affect. Here is an example.

Gah, copy paste error.

samdoran · 2018-08-15T19:04:57Z

Please create a backport PR for this to be included in previous versions.

tomtastic · 2018-08-19T15:47:41Z

@samdoran

Backport for stable-2.5 Strip trailing comments from /etc/default/passwd (#43931) #44367
Backport for stable-2.4 Strip trailing comments from /etc/default/passwd (#43931) #44369

samdoran · 2018-08-20T15:18:28Z

@tomtastic Can you please backport to stable-2.6 as well?

tomtastic · 2018-08-20T21:34:08Z

Yes of course, I forgot about that one

Strip trailing comments from /etc/default/passwd (#43931) #44424

samdoran · 2018-08-21T14:15:48Z

Thank you!

* strip additional comments from /etc/default/passwd Strip trailling comments from /etc/default/passwd like MINWEEKS=1 #MINWEEKS=2 MAXWEEKS=12 # MAXWEEKS=8 Which otherwise cause failures with "failed to read /etc/default/passwd: too many values to unpack" * fix carriage return typo in commit * yet another typo in commit * Fix indent problem * add changelog fragment for PR 43931 (cherry picked from commit 5c1e620)

gundalow · 2018-10-27T09:52:08Z

Hi,
I'm randomly selecting some PRs to see how it was for you, with the aim of making it easier for future contributors. As a new contributor I'm particularly interested as you don't have any prior knowledge of the Ansible process.

Generally speaking, how was the process for you?
Did it make sense what to do to progress the PR?
Did you read any of the developer (dev_guide) or contributor documentation?
What in the documentation was useful or confusing, missing or could be improved
Did you know you could run ansible-test locally?
What areas would you be interested in contributing to?

ansible/community#353

Tom Matthews added 3 commits August 10, 2018 12:04

strip additional comments from /etc/default/passwd

c06ee1a

Strip trailling comments from /etc/default/passwd like MINWEEKS=1 #MINWEEKS=2 MAXWEEKS=12 # MAXWEEKS=8 Which otherwise cause failures with "failed to read /etc/default/passwd: too many values to unpack"

fix carriage return typo in commit

dbb8f2b

yet another typo in commit

8e33453

ansibot added 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 Aug 10, 2018

Fix indent problem

330a9a8

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 Aug 10, 2018

sivel removed the needs_triage Needs a first human triage before being processed. label Aug 13, 2018

samdoran self-assigned this Aug 14, 2018

samdoran reviewed Aug 14, 2018

View reviewed changes

add changelog fragment for PR 43931

73512ac

samdoran merged commit 5c1e620 into ansible:devel Aug 15, 2018

This was referenced Aug 19, 2018

Strip trailing comments from /etc/default/passwd (#43931) #44367

Merged

Strip trailing comments from /etc/default/passwd (#43931) #44369

Closed

tomtastic deleted the user_module_strip_comments branch August 19, 2018 15:47

tomtastic mentioned this pull request Aug 20, 2018

Strip trailing comments from /etc/default/passwd (#43931) #44424

Merged

gundalow added the contrib_follow_up https://github.com/ansible/community/issues/353 label Oct 27, 2018

ansible locked and limited conversation to collaborators Jul 22, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Strip trailing comments from /etc/default/passwd #43931

Strip trailing comments from /etc/default/passwd #43931

tomtastic commented Aug 10, 2018

ansibot commented Aug 10, 2018

ansibot commented Aug 10, 2018

samdoran commented Aug 14, 2018

samdoran Aug 14, 2018

tomtastic Aug 14, 2018

samdoran commented Aug 15, 2018

tomtastic commented Aug 19, 2018

samdoran commented Aug 20, 2018

tomtastic commented Aug 20, 2018

samdoran commented Aug 21, 2018

gundalow commented Oct 27, 2018

Strip trailing comments from /etc/default/passwd #43931

Strip trailing comments from /etc/default/passwd #43931

Conversation

tomtastic commented Aug 10, 2018

SUMMARY

ISSUE TYPE

COMPONENT NAME

ANSIBLE VERSION

ADDITIONAL INFORMATION

ansibot commented Aug 10, 2018

ansibot commented Aug 10, 2018

samdoran commented Aug 14, 2018

samdoran Aug 14, 2018

Choose a reason for hiding this comment

tomtastic Aug 14, 2018

Choose a reason for hiding this comment

samdoran commented Aug 15, 2018

tomtastic commented Aug 19, 2018

samdoran commented Aug 20, 2018

tomtastic commented Aug 20, 2018

samdoran commented Aug 21, 2018

gundalow commented Oct 27, 2018