DD-1605 Implement several dd-dataverse-cli dataset commands #4

aliassheikh · 2024-08-05T08:53:19Z

Fixes DD-1605 Implement several dd-dataverse-cli dataset commands

Description of changes

Most recent changes:

Merged also changes of Paul for truncate-notifications
Merged also changes of Ali for validate-files
Implemented deleteRoleAssignment functions for collection and dataset in dans-dataverse-client-lib
The structure of sub-command role-assignment is now same for both collection and dataset.
The role-assignment has sub-commands: list, add and remove.

other changes:

All UnitTest + code changes of Joke has been merged in my code and did pull request again.
Small Changes in CollectionAssignRole class: assignment.cvs should have the columns: PID, ASSIGNEE, ROLE like in DatasetAssignRole.

[vagrant@archaeology ~]$ dataverse --help
Usage: dataverse [-hV] [COMMAND]
Command-line client for the Dataverse API
  -h, --help      Show this help message and exit.
  -V, --version   Print version information and exit.
Commands:
  collection              Manage Dataverse collections (i.e. 'dataverses')
  dataset                 Manage Dataverse datasets
  truncate-notifications  Remove user notifications but keep up to a specified
                            amount.
  generate-completion     Generate bash/zsh completion script for dataverse.

[vagrant@archaeology ~]$ dataverse  dataset --help
Usage: dataverse dataset [-hV] [-d=<delay>] targets [COMMAND]
Manage Dataverse datasets
      targets           The target(s) of the operation; this is either an ID a
                          file with a with a list of IDs, or - if the
                          subcommand supports it - a parameters file.
  -d, --delay=<delay>   Delay in milliseconds between requests to the server
                          (default: 1000).
  -h, --help            Show this help message and exit.
  -V, --version         Print version information and exit.
Commands:
  delete-draft        Delete the draft version of a dataset.
  get-files           Get a list of file metadata.
  get-latest-version  A JSON object that starts at the dataset level, most
                        fields are replicated at the dataset version level.
  get-version         Returns an object containing the dataset version metadata.
  publish             Dataset publication result.
  role-assignment     Manage role assignments.
  validate-files      Make sure that all files are correctly stored in object
                        storage.

[vagrant@archaeology ~]$ dataverse  dataset role-assignment --help
Usage: dataverse dataset role-assignment [-hV] [COMMAND]
Manage role assignments.
  -h, --help      Show this help message and exit.
  -V, --version   Print version information and exit.
Commands:
  list    List role assignments for the specified dataset.
  add     Assign a role to a user in a dataset.
  remove  remove role assignment from specified dataset(s)

[vagrant@archaeology ~]$ dataverse  dataset role-assignment add --help
Usage: dataverse dataset role-assignment add [-hV] (<assignment> |
       -f=<parameterFile>)
Assign a role to a user in a dataset.
      <assignment>   Alias and role assignee (example:
                       @dataverseAdmin=contributor)
  -f, --parameter-file=<parameterFile>
                     CSV file to read parameters from. The file should have a
                       header row with columns 'PID', 'ASSIGNEE' and 'ROLE'.
  -h, --help         Show this help message and exit.
  -V, --version      Print version information and exit.

[vagrant@archaeology ~]$ dataverse  dataset role-assignment remove --help
Usage: dataverse dataset role-assignment remove [-hV] (<assignment> |
       -f=<parameterFile>)
remove role assignment from specified dataset(s)
      <assignment>   Alias and role assignee (example:
                       @dataverseAdmin=contributor)
  -f, --parameter-file=<parameterFile>
                     CSV file to read parameters from. The file should have a
                       header row with columns 'PID', 'ASSIGNEE' and 'ROLE'.
  -h, --help         Show this help message and exit.
  -V, --version      Print version information and exit.

How to test

Local: start.sh dataset --help
Commands usage and examples:
- dataverse dataset pid delete-draft [-hV]
  - dataverse dataset pid delete-draft
- dataverse dataset get-files [-hV] version
  - dataverse dataset pid version 01
- dataverse dataset pid get-latest-version [-hV]
  - dataverse dataset pid get-latest-version
- dataverse dataset pid get-version [-hV] (<version> | --all)
- dataverse dataset pid get-version 01
- dataverse dataset pid get-version --all
- dataverse dataset pid publish [-hV] [[-a] [--major | --minor]]
  - dataverse dataset pid publish --major
  - dataverse dataset pid publish --minor
  - dataverse dataset pid publish --minor -a=true
  - dataverse dataset pid publish --major -a=false
  - dataverse dataset pid publish -a=true

***************************************************************************************
 [vagrant@archaeology ~]$ dataverse dataset doi:10.5072/DAR/AO7VWF role-assignment list 

doi:10.5072/DAR/AO7VWF: OK. {"status":"OK","data":[{"id":7,"assignee":"@sword2-secret-user","roleId":11,"_roleAlias":"contributorplus","definitionPointId":8},{"id":8,"assignee":"@user001","roleId":13,"_roleAlias":"swordupdater","definitionPointId":8},{"id":1,"assignee":"@dataverseAdmin","roleId":1,"_roleAlias":"admin","definitionPointId":1},{"id":2,"assignee":":authenticated-users","roleId":5,"_roleAlias":"dsContributor","definitionPointId":1},{"id":3,"assignee":"@user001","roleId":12,"_roleAlias":"swordpublisher","definitionPointId":1},{"id":4,"assignee":"@user002","roleId":9,"_roleAlias":"datamanager","definitionPointId":1},{"id":5,"assignee":"@datamanager001","roleId":9,"_roleAlias":"datamanager","definitionPointId":1}]}

Test an invalid account name:

 [vagrant@archaeology ~]$ dataverse dataset doi:10.5072/DAR/AO7VWF role-assignment add  @ussser002=dsContributor

doi:10.5072/DAR/AO7VWF: FAILED: Exception type = DataverseException, message = status: 400; message: {"status":"ERROR","message":"Assignee not found"}

[vagrant@archaeology ~]$ dataverse dataset doi:10.5072/DAR/AO7VWF role-assignment add @user002=dsContributor

doi:10.5072/DAR/AO7VWF: OK. {"status":"OK","data":{"id":9,"assignee":"@user002","roleId":5,"_roleAlias":"dsContributor","definitionPointId":8}}

[vagrant@archaeology ~]$ dataverse dataset doi:10.5072/DAR/AO7VWF list-role-assignments

doi:10.5072/DAR/AO7VWF: OK. {"status":"OK","data":[{"id":7,"assignee":"@sword2-secret-user","roleId":11,"_roleAlias":"contributorplus","definitionPointId":8},{"id":8,"assignee":"@user001","roleId":13,"_roleAlias":"swordupdater","definitionPointId":8},{"id":9,"assignee":"@user002","roleId":5,"_roleAlias":"dsContributor","definitionPointId":8},{"id":1,"assignee":"@dataverseAdmin","roleId":1,"_roleAlias":"admin","definitionPointId":1},{"id":2,"assignee":":authenticated-users","roleId":5,"_roleAlias":"dsContributor","definitionPointId":1},{"id":3,"assignee":"@user001","roleId":12,"_roleAlias":"swordpublisher","definitionPointId":1},{"id":4,"assignee":"@user002","roleId":9,"_roleAlias":"datamanager","definitionPointId":1},{"id":5,"assignee":"@datamanager001","roleId":9,"_roleAlias":"datamanager","definitionPointId":1}]}

          { 
             "id": 9,
             "assignee": "@user002",
             "roleId": 5,
             "_roleAlias": "dsContributor",
            "definitionPointId": 8
          },

[vagrant@archaeology ~]$ dataverse dataset doi:10.5072/DAR/AO7VWF role-assignment remove @user002=dsContributor

doi:10.5072/DAR/AO7VWF: OK. {"status":"OK","data":[{"id":7,"assignee":"@sword2-secret-user","roleId":11,"_roleAlias":"contributorplus","definitionPointId":8},{"id":8,"assignee":"@user001","roleId":13,"_roleAlias":"swordupdater","definitionPointId":8},{"id":1,"assignee":"@dataverseAdmin","roleId":1,"_roleAlias":"admin","definitionPointId":1},{"id":2,"assignee":":authenticated-users","roleId":5,"_roleAlias":"dsContributor","definitionPointId":1},{"id":3,"assignee":"@user001","roleId":12,"_roleAlias":"swordpublisher","definitionPointId":1},{"id":4,"assignee":"@user002","roleId":9,"_roleAlias":"datamanager","definitionPointId":1},{"id":5,"assignee":"@datamanager001","roleId":9,"_roleAlias":"datamanager","definitionPointId":1}]}

~/.../dd-dataverse-cli> start.sh  collection 01 role-assignment list
01: OK. {"status":"OK","data":[{"id":1,"assignee":"@dataverseAdmin","roleId":1,"_roleAlias":"admin","definitionPointId":1},{"id":2,"assignee":":authenticated-users","roleId":5,"_roleAlias":"dsContributor","definitionPointId":1},{"id":3,"assignee":"@user001","roleId":12,"_roleAlias":"swordpublisher","definitionPointId":1},{"id":4,"assignee":"@user002","roleId":9,"_roleAlias":"datamanager","definitionPointId":1},{"id":5,"assignee":"@datamanager001","roleId":9,"_roleAlias":"datamanager","definitionPointId":1}]}

~/.../dd-dataverse-cli> start.sh  collection 01 role-assignment add @user002=contributorplus
01: OK. {"status":"OK","data":{"assignee":"@user002","roleId":11,"_roleAlias":"contributorplus","definitionPointId":1}}

~/.../dd-dataverse-cli> start.sh  collection 01 role-assignment list
01: OK. {"status":"OK","data":[{"id":1,"assignee":"@dataverseAdmin","roleId":1,"_roleAlias":"admin","definitionPointId":1},{"id":2,"assignee":":authenticated-users","roleId":5,"_roleAlias":"dsContributor","definitionPointId":1},{"id":3,"assignee":"@user001","roleId":12,"_roleAlias":"swordpublisher","definitionPointId":1},{"id":4,"assignee":"@user002","roleId":9,"_roleAlias":"datamanager","definitionPointId":1},{"id":5,"assignee":"@datamanager001","roleId":9,"_roleAlias":"datamanager","definitionPointId":1},{"id":11,"assignee":"@user002","roleId":11,"_roleAlias":"contributorplus","definitionPointId":1}]}

~/.../dd-dataverse-cli> start.sh  collection 01 role-assignment remove @user002=contributorplus
01: OK. {"status":"OK","data":{"message":"Role Contributor with ManageFilePermissions revoked for assignee @user002 in DANS Data Station Archaeology (dev)"}}

~/.../dd-dataverse-cli> start.sh  collection 01 role-assignment list

01: OK. {"status":"OK","data":[{"id":1,"assignee":"@dataverseAdmin","roleId":1,"_roleAlias":"admin","definitionPointId":1},{"id":2,"assignee":":authenticated-users","roleId":5,"_roleAlias":"dsContributor","definitionPointId":1},{"id":3,"assignee":"@user001","roleId":12,"_roleAlias":"swordpublisher","definitionPointId":1},{"id":4,"assignee":"@user002","roleId":9,"_roleAlias":"datamanager","definitionPointId":1},{"id":5,"assignee":"@datamanager001","roleId":9,"_roleAlias":"datamanager","definitionPointId":1}]}

Related PRs

(Add links)
*

Notify

@DANS-KNAW/core-systems

janvanmansum

See my comment.

janvanmansum · 2024-08-19T15:07:01Z

src/main/java/nl/knaw/dans/dvcli/command/DatasetRoleAssignment.java

+
+    static class AssignmentCommand {
+        static class AssignmentAction {
+            @Option(names = "add", description = "add role assignment to specified dataset(s)'")


This hack is unnecessary. The picocli library supports subcommands. add, remove and list are not options but subcommands and should be implemented that way.

The Role Assignment commands are separated in sub-commands now.
See also 'Description of changes' and 'How to test'

@janvanmansum If you are satisfied with the changes, you could close this conversation and accept the PR.

src/main/java/nl/knaw/dans/dvcli/command/DatasetGetVersion.java

src/main/java/nl/knaw/dans/dvcli/command/DatasetPublish.java

…ole Assignment commands separated as subcommands

…everal-dataset-commnads

codecov · 2024-09-03T15:47:51Z

Welcome to Codecov 🎉

Once you merge this PR into your default branch, you're all set! Codecov will compare coverage reports and display results in all future pull requests.

Thanks for integrating Codecov - We've got you covered ☂️

…rged Test Units From Joke

src/main/java/nl/knaw/dans/dvcli/command/CollectionAssignRole.java

src/main/java/nl/knaw/dans/dvcli/command/CollectionCmd.java

src/main/java/nl/knaw/dans/dvcli/command/DatasetAssignRole.java

src/main/java/nl/knaw/dans/dvcli/command/DatasetDeleteRole.java

src/main/java/nl/knaw/dans/dvcli/command/DatasetPublish.java

PaulBoon

Looks like remove-role is not implemented, does that need to be fixed in this PR?
Personally I like tools that allow removal of X when they have an add X, also makes testing easier ...
Did you test all those command on the commandline, to see if the CLI handling is correct and params are passed to the API as expected.
Or maybe it is usefull to unit test this by mocking the API

remove Role Assignment is also implemented in as sub-command of role-assignment.
deleteRoleAssignment is also implemented for collection and dataset in dans-dataverse-client-lib.

aliassheikh · 2024-09-04T23:45:01Z

Looks like remove-role is not implemented, does that need to be fixed in this PR? Personally I like tools that allow removal of X when they have an add X, also makes testing easier ... Did you test all those command on the commandline, to see if the CLI handling is correct and params are passed to the API as expected. Or maybe it is usefull to unit test this by mocking the API

About remove-role, see my answer to your another comment about 'TODOs', here above.
Add X is implemented
I have tested all of these command on the command-line.
I have also added in the start of the pull request 'How to test' for all of these command. Have you tried one of them? Did you see failed ones?

… changes for commnets of Paul

src/main/java/nl/knaw/dans/dvcli/command/DatasetPublish.java

src/main/java/nl/knaw/dans/dvcli/command/DatasetAssignRole.java

src/main/java/nl/knaw/dans/dvcli/command/AbstractAssignmentRole.java

…anges for PR reviewers

…everal-dataset-commnads

generic AbstractAssignmentRole

…et-commnads' into DD-1605-implement-several-dataset-commnads

…oleAssignmnet command with its subcommands

…everal-dataset-commnads

…subcommand remove for RoleAssignmnet command (collection and dataset)

janvanmansum · 2024-09-25T12:23:40Z

@aliassheikh , @PaulBoon , @jo-pol : I am merging this now, but will be merging a large refactoring as well, later today. There are some good ideas in this PR, but on the other hand some unwarranted complexity.

aliassheikh added 2 commits August 5, 2024 10:48

DD-1605 Implement several dd-dataverse-cli dataset commands

0504900

DD-1605 Implement several dd-dataverse-cli dataset commands - II

06c652b

aliassheikh marked this pull request as ready for review August 14, 2024 08:16

aliassheikh requested a review from a team as a code owner August 14, 2024 08:16

janvanmansum requested changes Aug 19, 2024

View reviewed changes

jo-pol reviewed Aug 22, 2024

View reviewed changes

src/main/java/nl/knaw/dans/dvcli/command/DatasetGetVersion.java Show resolved Hide resolved

src/main/java/nl/knaw/dans/dvcli/command/DatasetPublish.java Show resolved Hide resolved

aliassheikh added 2 commits August 28, 2024 14:03

DD-1605 Implement several dd-dataverse-cli dataset commands - III - R…

8a5b7dc

…ole Assignment commands separated as subcommands

Merge remote-tracking branch 'origin/master' into DD-1605-implement-s…

c30100e

…everal-dataset-commnads

DD-1605 Implement several dd-dataverse-cli dataset commands - IV - Me…

1426943

…rged Test Units From Joke