Add the ability to import/export users via CSV

[jnptk]

• As site administrator I can create Plone users by uploading a CSV file
• As site administrator I can export all existing Plone users as CSV file
• Update documentation
• More tests!!

---

📚 Documentation preview 📚: https://plonerestapi--1971.org.readthedocs.build/

[mister-roboto]

@jnptk thanks for creating this Pull Request and helping to improve Plone!

TL;DR: Finish pushing changes, pass all other checks, then paste a comment:

@jenkins-plone-org please run jobs

To ensure that these changes do not break other parts of Plone, the Plone test suite matrix needs to pass, but it takes 30-60 min. Other CI checks are usually much faster and the Plone Jenkins resources are limited, so when done pushing changes and all other checks pass either start all Jenkins PR jobs yourself, or simply add the comment above in this PR to start all the jobs automatically.

Happy hacking!

[jnptk]

DO NOT MERGE YET

Notes:

• test_list_users_via_csv seems to be flaky
• roles don't seem to be applied
• location response header when multiple user are created?

[stevepiercy]

Minor docs tweaks. Looking good so far. Thank you!

[stevepiercy]

Docs LGTM so far.

[stevepiercy]

Additional new docs look good!

https://plonerestapi--1971.org.readthedocs.build/en/1971/endpoints/users.html#list-all-users-via-csv

Needs a technical review.

[jnptk]

@jenkins-plone-org please run jobs

[stevepiercy]

This looks really good. Thank you! Please see my suggestions.

https://plonerestapi--1971.org.readthedocs.build/en/1971/endpoints/users.html#create-users-via-csv

[jnptk]

While writing the docs, I noticed that the roles included in the request are not part of the response, I will investigate...

[stevepiercy]

Docs changes look great! I'm glad you caught the empty roles response. I missed that.

[jnptk]

@davisagli we set the Location header with the location of the newly created user, but in the case of a csv one might create more than one user. Should we set the header in this case or abandon it?

[stevepiercy]

Roles now appear in the response.

https://plonerestapi--1971.org.readthedocs.build/en/1971/endpoints/users.html#create-users-via-csv

Thank you!

[davisagli]

we set the Location header with the location of the newly created user, but in the case of a csv one might create more than one user. Should we set the header in this case or abandon it?

No, I don't think it makes sense to redirect to one particular user if multiple users were created.

[davisagli]

I see the format changed from a list of users to an object with @id, items, and items_total. That's more consistent with what we try to do in the REST API, but unfortunately it's a backwards-incompatible change that will break existing scripts. We can only change this in a major release of plone.restapi.

[jnptk]

So should I undo the format change or do we just wait until the next major release?

[davisagli]

@jnptk Now I remember that we currently are on 10.0.0a1, so we can make other breaking changes in a new alpha release. Make sure we add release note with the .breaking extension for this change, separate from the other new feature.

[davisagli]

@jnptk Hmm, but this change will break everything in Volto that uses the @users endpoint to list users.

We have two options:

1. Go ahead with the change in plone.restapi -- but then we have to first make changes in Volto (at least Volto 19) to handle both the old and new format, before we can merge this.
2. Change this PR back to returning the old format with just a list.

[davisagli]

I think this is just about ready!