Process/Management/Product/QA changes/tasks (FOLIO-2761)

[FOLIO-2794] Test User Creation script on snapshot Created: 15/Sep/20  Updated: 06/Oct/20  Resolved: 06/Oct/20

Status: Closed
Project: FOLIO
Components: None
Affects versions: None
Fix versions: None
Parent: Process/Management/Product/QA changes/tasks

Type: Task Priority: P2
Reporter: Sergiy Vysotskiy Assignee: Zak Burke
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original estimate: Not Specified

Attachments: File create-add-user-pr-720p.mov     PNG File screenshot-1.png    
Issue links:
Blocks
blocks FOLIO-2797 Apply User Script to snapshot pipeline Closed
Cloners
is cloned by FOLIO-2795 Test User Creation script on BugFest ENV Open
Relates
relates to FOLIO-2763 Create script to create/pre-setup use... Closed
Sprint: Core: F - Sprint 99, Core: F - Sprint 98
Story Points: 0.5
Development Team: Prokopovych
Epic Link: Process/Management/Product/QA changes/tasks

 Comments   
Comment by Zak Burke [ 22/Sep/20 ]

On https://folio-testing.dev.folio.org/, the following accounts were created with matching username/password:

acq-admin
acq-manager
acq-observer
acq-staff
cataloger
checkin-all
checkout-all
circ-admin
circ-manager
circ-observer
circ-staff
circ-student
copy-cataloger
data-export-admin
data-export
data-import
metadata-admin
quick-marc-all
technical-service-staff
user-basic-view

There are 14 invalid permission names, i.e. the input files don’t match permission names in the system, so those will need to be corrected in the add-users repo (if the permission-name is wrong) or created in a UI repo (if the permission-name is correct but the permission is missing):

Acquisitions Staff? (All CRU)  
Fast add: Create  
Fee/Fine History: Can create, edit and remove fee/fine actions  
Inventory: all permissions  
Settings (Users): Can create, edit and remove transfer accounts  
Settings (data-export): display list of settings pages  
Settings (eHoldings): display list of settings pages  
Tags on records: View only  
Tags: All permissions  
UI: Data export module is enabled  
UI: eHoldings module is enabled  
Users: Can pay fee/fine  
Users: Can view fees/fines  
Users: Can view patron blocks  
Comment by Zak Burke [ 22/Sep/20 ]

I create a movie on this ticket showing how to edit files in-place with GitHub but now it occurs to me that most folks who will want to edit permissions probably won't have the necessary permissions on the folio-tools repository to edit those files in place.

Missing/invalid permissions are mentioned immediately above.

  • If the problem is just a typo (e.g. maybe "Users: Can pay fee/fine" should be "Fees/Fines: Can pay") just let me know here in a comment or on Slack and I can make the update.
  • If the problem is that a permission is missing altogether, it will need to be added to the app that owns it (e.g. there is no ui-users permission "Users: Can view patron blocks"). The most correct option there is probably to open a ticket in the project where the permission needs to be created, then ask me to add it once that PR merges.
Comment by Cate Boerema (Inactive) [ 23/Sep/20 ]

This is working great, Zak Burke!

I do have some questions:

  1. There are a few users in the spreadsheet that don't seem to have been created. They may have been added to the spreadsheet after you began development. Can the POs add these themselves?
    1. Circ supervisor
    2. ERM with Admin capabilities
    3. ERM - eholdings app user
    4. All permission
    5. Circ, Users and Inventory all
  2. Can you please describe the steps or record a screencase on how we can correct the permissions where the name was wrong?
Comment by Cate Boerema (Inactive) [ 23/Sep/20 ]

Oh, and one more thing. In testing these circ users, I am realizing that it would be really nice if the script also assigned service point(s) to the user. Because you can't use check in, check out or requests without at least one SP assigned. Would that be possible?

Comment by Zak Burke [ 23/Sep/20 ]

Cate Boerema, this script works by reading permissions from text file locally; it doesn't know about the spreadsheet. Technically, anybody can clone the repository and make whatever changes they want to the text file, and run the script. For the purposes of integrating this with our CI process, that hopefully works well. But for the purposes of POs being able to easily create users and maintain a list of permissions, it's not so great.

There is an API for Google Sheets; would it be worth exploring that so that we could, e.g., point a Postman collection at a Google Sheet? I'm guessing that would make it more accessible to POs etc.

WRT service points, yes, I can add an "add service point" step.

Comment by Cate Boerema (Inactive) [ 23/Sep/20 ]

Technically, anybody can clone the repository and make whatever changes they want to the text file, and run the script.

We'd be open to doing this if we had clear instructions and the right permissions. Can you do a video explaining how this is done?

Comment by Cate Boerema (Inactive) [ 24/Sep/20 ]

Hi Zak Burke. When testing in folio-testing yesterday afternoon, I noticed yesterday that all the users seemed to have service points now! Thank you! I think the only remaining open aspect of this issue is some guidance for POs on how to edit or create users. Should we close this (or mark it Awaiting deployment) and create a separate issue for the guidance documentation?

Comment by Cate Boerema (Inactive) [ 29/Sep/20 ]

Hi Zak Burke. Can you please update me on the status of this issue? Is this script being applied in snapshot now?

I think the only reason why the issue is still open is that I was hoping for some documentation or a screencast showing how POs could create and edit the users on GitHub. Is that in the works?

Comment by Zak Burke [ 30/Sep/20 ]

The create-add-user-pr-720p.mov video shows the process for editing a permission-set file and creating a pull-request to incorporate those changes into the repository. If you have cloned this repository and just want to make changes for when you run the script locally, you can edit the .json files directly with a text editor such as TextPad or BBEdit.

This script is not yet integrated with the nightly builds. There are some mismatch permissions that I wanted to straighten out first, but there would be no harm in putting the integration in place now and updating the permissions on an ongoing basis as we fix them and/or add additional users.

Comment by Cate Boerema (Inactive) [ 06/Oct/20 ]

This is perfect, thank you! Per our discussion on Slack, I'll ask the POs to try to clean up the mismatched permissions you referenced in the comments. If they would prefer to have you do it, they can reach out to you.

Generated at Thu Feb 08 23:23:17 UTC 2024 using Jira 1001.0.0-SNAPSHOT#100246-sha1:7a5c50119eb0633d306e14180817ddef5e80c75d.