Fix roles not being applied & update tests

Author: jnptk

src/plone/restapi/services/users/add.py

@@ -156,6 +156,14 @@ def reply(self):
             try:
                 reader = csv.DictReader(stream)
                 for row in reader:
+                    # convert to lists
+                    for key in ("roles", "groups"):
+                        if row.get(key):
+                            row[key] = [r.strip() for r in row[key].split(",")]
+                    # remove empty values
+                    for key in list(row.keys()):
+                        if not row[key]:
+                            del row[key]
                     # validate important data
                     self.validate_input_data(portal, row)
                     data.append(row)

src/plone/restapi/tests/http-examples/users_add_csv_format.req

@@ -7,7 +7,9 @@ Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0g
 Content-Disposition: form-data; name="file"; filename="users.csv"
 Content-Type: text/csv
 
-id,username,fullname,email,roles,location,password
-noam,noamchomsky,Noam Avran Chomsky,noam.chomsky@example.com,Contributor,"Cambridge, MA",password1234
+username,email,fullname,description,roles,home_page,password
+jdoe,jdoe@example.com,John Doe,Software developer from Berlin,"Member, Contributor",https://jdoe.dev,pass1234
+asmith,asmith@example.com,Alice Smith,Frontend engineer and designer,Member,https://alice.design,alicePwd!
+bwayne,bwayne@example.com,Bruce Wayne,Tech entrepreneur,,https://wayneenterprises.com,batman42
 
 ------WebKitFormBoundary7MA4YWxkTrZu0gW--

src/plone/restapi/tests/http-examples/users_add_csv_format.resp

@@ -1,13 +1,13 @@
 HTTP/1.1 201 Created
 Content-Type: application/json
-Location: http://localhost:55001/plone/@users/noamchomsky
+Location: http://localhost:55001/plone/@users/bwayne
 
 [
     {
-        "@id": "http://localhost:55001/plone/@users/noamchomsky",
-        "description": null,
-        "email": "noam.chomsky@example.com",
-        "fullname": "Noam Avran Chomsky",
+        "@id": "http://localhost:55001/plone/@users/jdoe",
+        "description": "Software developer from Berlin",
+        "email": "jdoe@example.com",
+        "fullname": "John Doe",
         "groups": {
             "@id": "http://localhost:55001/plone/@users",
             "items": [
@@ -18,11 +18,62 @@ Location: http://localhost:55001/plone/@users/noamchomsky
             ],
             "items_total": 1
         },
-        "home_page": null,
-        "id": "noamchomsky",
-        "location": "Cambridge, MA",
+        "home_page": "https://jdoe.dev",
+        "id": "jdoe",
+        "location": null,
         "portrait": null,
-        "roles": [],
-        "username": "noamchomsky"
+        "roles": [
+            "Contributor",
+            "Member"
+        ],
+        "username": "jdoe"
+    },
+    {
+        "@id": "http://localhost:55001/plone/@users/asmith",
+        "description": "Frontend engineer and designer",
+        "email": "asmith@example.com",
+        "fullname": "Alice Smith",
+        "groups": {
+            "@id": "http://localhost:55001/plone/@users",
+            "items": [
+                {
+                    "id": "AuthenticatedUsers",
+                    "title": "AuthenticatedUsers"
+                }
+            ],
+            "items_total": 1
+        },
+        "home_page": "https://alice.design",
+        "id": "asmith",
+        "location": null,
+        "portrait": null,
+        "roles": [
+            "Member"
+        ],
+        "username": "asmith"
+    },
+    {
+        "@id": "http://localhost:55001/plone/@users/bwayne",
+        "description": "Tech entrepreneur",
+        "email": "bwayne@example.com",
+        "fullname": "Bruce Wayne",
+        "groups": {
+            "@id": "http://localhost:55001/plone/@users",
+            "items": [
+                {
+                    "id": "AuthenticatedUsers",
+                    "title": "AuthenticatedUsers"
+                }
+            ],
+            "items_total": 1
+        },
+        "home_page": "https://wayneenterprises.com",
+        "id": "bwayne",
+        "location": null,
+        "portrait": null,
+        "roles": [
+            "Member"
+        ],
+        "username": "bwayne"
     }
 ]

src/plone/restapi/tests/test_documentation.py

@@ -1096,7 +1096,7 @@ def test_documentation_users_add(self):
     def test_documentation_users_csv_format_add(self):
         url = f"{self.portal.absolute_url()}/@users"
 
-        content = b'id,username,fullname,email,roles,location,password\r\nnoam,noamchomsky,Noam Avran Chomsky,noam.chomsky@example.com,Contributor,"Cambridge, MA",password1234\r\n'
+        content = b'username,email,fullname,description,roles,home_page,password\r\njdoe,jdoe@example.com,John Doe,Software developer from Berlin,"Member, Contributor",https://jdoe.dev,pass1234\nasmith,asmith@example.com,Alice Smith,Frontend engineer and designer,Member,https://alice.design,alicePwd!\r\nbwayne,bwayne@example.com,Bruce Wayne,Tech entrepreneur,,https://wayneenterprises.com,batman42\r\n'
         csv_file = io.BytesIO(content)
         csv_file.name = "users.csv"
 

src/plone/restapi/tests/test_services_users.py

@@ -380,7 +380,7 @@ def test_add_user_with_uuid_as_userid_enabled(self):
     def test_add_users_via_csv(self):
         """Test POST /@users for CSV upload"""
 
-        content = b"username,email,fullname,description,home_page,password\njdoe,jdoe@example.com,John Doe,Software developer from Berlin,https://jdoe.dev,pass1234\nasmith,asmith@example.com,Alice Smith,Frontend engineer and designer,https://alice.design,alicePwd!\nbwayne,bwayne@example.com,Bruce Wayne,Tech entrepreneur,https://wayneenterprises.com,batman42\n"
+        content = b'username,email,fullname,description,roles,home_page,password\njdoe,jdoe@example.com,John Doe,Software developer from Berlin,"Member, Contributor",https://jdoe.dev,pass1234\nasmith,asmith@example.com,Alice Smith,Frontend engineer and designer,,https://alice.design,alicePwd!\nbwayne,bwayne@example.com,Bruce Wayne,Tech entrepreneur,,https://wayneenterprises.com,batman42\n'
 
         resp = self.api_session.post(
             "/@users",