Merge ~slystopad/cloud-init:merge/chpasswd-data-as-list into cloud-init:master

[Serg Lystopad]

Support data for chpasswd in list or string format.

By default cc_set_passwords supports list of pairs specified as multiline
string:

  chpasswd:
    list: |
      user:pass1
      user015:R

This patch adds support for user/pairs as yaml list:

chpasswd:
  list:
    - user:pass1
    - user015:R

LP: #1665773
LP: #1665694

[Server Team CI bot (server-team-bot)]

FAILED: Continuous integration, rev:53655f74a9a2df7ef05ee48fb5595334bf0ebcc7
No commit message was specified in the merge proposal. Click on the following link and set the commit message (if you want a jenkins rebuild you need to trigger it yourself):
https://code.launchpad.net/~slystopad/cloud-init/+git/cloud-init/+merge/317774/+edit-commit-message

https://jenkins.ubuntu.com/server/job/cloud-init-ci/78/
Executed test runs:
    FAILURE: https://jenkins.ubuntu.com/server/job/cloud-init-ci/nodes=metal-arm64/78/console
    FAILURE: https://jenkins.ubuntu.com/server/job/cloud-init-ci/nodes=metal-ppc64el/78/console
    FAILURE: https://jenkins.ubuntu.com/server/job/cloud-init-ci/nodes=metal-s390x/78/console
    FAILURE: https://jenkins.ubuntu.com/server/job/cloud-init-ci/nodes=vm-amd64/78/console
    FAILURE: https://jenkins.ubuntu.com/server/job/cloud-init-ci/nodes=vm-i386/78/console

Click here to trigger a rebuild:
https://jenkins.ubuntu.com/server/job/cloud-init-ci/78/rebuild

review: Needs Fixing (continuous-integration)

[Scott Moser (smoser)]

Some minor cleanups suggested. Largely looks good.

In order for me to accept this, you will have to sign the contributors agreement. See HACKING.rst for more information, and please feel free to ping me in irc or email if I can help out at all.

I'll put this into 'Work in progress' state. Just move it to Resubmit when you've done that.

Thanks.
Scott

[Server Team CI bot (server-team-bot)]

PASSED: Continuous integration, rev:11b85e45d3b3e493436942ebac46c324a91217f1
https://jenkins.ubuntu.com/server/job/cloud-init-ci/95/
Executed test runs:
    SUCCESS: https://jenkins.ubuntu.com/server/job/cloud-init-ci/nodes=metal-amd64/95
    SUCCESS: https://jenkins.ubuntu.com/server/job/cloud-init-ci/nodes=metal-arm64/95
    SUCCESS: https://jenkins.ubuntu.com/server/job/cloud-init-ci/nodes=metal-ppc64el/95
    SUCCESS: https://jenkins.ubuntu.com/server/job/cloud-init-ci/nodes=metal-s390x/95
    SUCCESS: https://jenkins.ubuntu.com/server/job/cloud-init-ci/nodes=vm-i386/95

Click here to trigger a rebuild:
https://jenkins.ubuntu.com/server/job/cloud-init-ci/95/rebuild

review: Approve (continuous-integration)

[Serg Lystopad (slystopad)]

Scott, I've fixed CI complains and signed the contributors agreement.

review: Needs Resubmitting

[Scott Moser (smoser)]

Thanks! merged with some small changes here.

review: Approve

diff --git a/cloudinit/config/cc_set_passwords.py b/cloudinit/config/cc_set_passwords.py
index af6704c..301d5e9 100755
--- a/cloudinit/config/cc_set_passwords.py
+++ b/cloudinit/config/cc_set_passwords.py
@@ -50,6 +50,16 @@ enabled, disabled, or left to system defaults using ``ssh_pwauth``.
             user2:Random
             user3:password3
             user4:R
+
+    ##
+    # or as yaml list
+    ##
+    chpasswd:
+        list:
+            - user1:password1
+            - user2:Random
+            - user3:password3
+            - user4:R
 """
 
 import sys
@@ -79,7 +89,14 @@ def handle(_name, cfg, cloud, log, args):
 
     if 'chpasswd' in cfg:
         chfg = cfg['chpasswd']
-        plist = util.get_cfg_option_str(chfg, 'list', plist)
+        if isinstance(chfg['list'], list):
+            cfg_type = 'list'
+        else:
+            cfg_type = 'string'
+        if cfg_type == 'list':
+            plist = util.get_cfg_option_list(chfg, 'list', plist)
+        else:
+            plist = util.get_cfg_option_str(chfg, 'list', plist)
         expire = util.get_cfg_option_bool(chfg, 'expire', expire)
 
     if not plist and password:
@@ -95,13 +112,27 @@ def handle(_name, cfg, cloud, log, args):
         plist_in = []
         randlist = []
         users = []
-        for line in plist.splitlines():
+
+        def _prepare_credentials(line, **kwargs):
             u, p = line.split(':', 1)
             if p == "R" or p == "RANDOM":
                 p = rand_user_password()
-                randlist.append("%s:%s" % (u, p))
-            plist_in.append("%s:%s" % (u, p))
-            users.append(u)
+                kwargs['randlist'].append("%s:%s" % (u, p))
+            kwargs['plist_in'].append("%s:%s" % (u, p))
+            kwargs['users'].append(u)
+
+        if cfg_type == 'list':
+            log.warn("Handling input for chpasswd as list.")
+            for line in plist:
+                _prepare_credentials(line, randlist=randlist,
+                                     plist_in=plist_in,
+                                     users=users)
+        else:
+            log.warn("Handling input for chpasswd as multiline string.")
+            for line in plist.splitlines():
+                _prepare_credentials(line, randlist=randlist,
+                                     plist_in=plist_in,
+                                     users=users)
 
         ch_in = '\n'.join(plist_in) + '\n'
         try: