Ability to share runs via the `pipe` CLI

[NShaforostov]

Background For certain use cases, it is beneficial to be able to share applications with other users/groups. Currently, Cloud Pipeline supports the ability to access runs environments for several users, not only for the user, who launched the run (OWNER). On the GUI, it's implemented via the "Sharing" feature that allows to share runs as the interactive tools endpoints and SSH sessions for several users/groups. It would be convenient to allow users to share runs via the pipe CLI.

Approach

• add a new CLI command pipe share <sub-command> <Run_ID>, that shall manage the sharing of the specified run
• add following sub-commands for this command:
  • pipe share get <Run_ID> - to display a list of users/groups for whom the run is shared Example of the output:

    > pipe share get 2318
    Run with ID 2318 is shared with:
    +------------+------------+
    | User/group | SSH shared |
    +------------+------------+
    | USER1      |      +     |
    | USER2      |            |
    | ROLE_USER  |      +     |
    +------------+------------+

  • pipe share add <Run_ID> [OPTIONS] - to add user(s)/group(s) to a list for whom the run is shared
  • pipe share remove <Run_ID> [OPTIONS] - to remove user(s)/group(s) from a list for whom the run is shared
• both sub-commands shall have an option, that shall allow to specify user(s) for whom the run will be shared/unshared, e.g. -su | --shared-user <user>. In case of several users, they could be specified each with that flag (-su USER1 -su USER2 ...)
• both sub-commands shall have an option, that shall allow to specify user group(s) for whom the run will be shared/unshared, e.g. -sg | --shared-group <group>. In case of several groups, they could be specified each with that flag (-sg GROUP1 -sg GROUP2 ...)
• at least one of the option above (-su or -sg) shall be specified for the add sub-command
• remove sub-command without any options shall clear all list of the shared users/groups
• both sub-commands shall have an option (non-required), that shall allow to share/unshare additionally the SSH session of the specified run, e.g. -ssh | --share-ssh

• command examples:

  # run 2318 with endpoint(s)
  > pipe share add 2318 -su USER3         # to share endpoint(s) of the run 2318 with the user "USER3"
  > pipe share add 2318 -su USER3 -ssh    # to share endpoint(s) and SSH-session of the run 2318 with the user "USER3"
  > pipe share add 2318 -sg GROUP1        # to share endpoint(s) of the run 2318 with the group "GROUP1"
  > pipe share remove 2318                # to remove all users/groups of the run 2318 shared list
  > pipe share remove 2318 -ssh           # to remove only SSH-sharing for all users/groups of the run 2318 shared list
  > pipe share remove 2318 -su USER3      # to unshare endpoint(s) and SSH-session of the run 2318 for the user "USER3"
  > pipe share remove 2318 -su USER3 -ssh # to unshare only SSH-session of the run 2318 for the user "USER3"
  
  # run 2320 without endpoints
  > pipe share add 2320 -su USER3         # error (run hasn't endpoints)
  > pipe share add 2320 -su USER3 -ssh    # to share SSH-session of the run 2320 with the user "USER3"
  > pipe share remove 2320                # to remove all users/groups of the run 2320 shared list
  > pipe share remove 2320 -ssh           # to remove all users/groups of the run 2320 shared list
  > pipe share remove 2320 -su USER3      # to unshare SSH-session of the run 2320 with the user "USER3"
  > pipe share remove 2320 -su USER3 -ssh # to unshare SSH-session of the run 2320 with the user "USER3"

This command shall be available only for admin or the run OWNER.

[NShaforostov]

I've tried to verify this. In common, it works well. Some issues, that were encountered:

1. Attempt to run pipe share get <RUN_ID> prints the error with a traceback, where RUN_ID is the run ID:
   • of the run that isn't accessible for the current user
   • of the completed run
   • of the non-existing/not-found run E.g.: Is it possible to print only short error message in such cases?
2. Attempt to run pipe share add <RUN_ID> without additional options prints the error with a traceback: Is it possible to print only short error message in such cases?
3. Attempt to run pipe share add <RUN_ID> -su/sg <USER>/<GROUP> without specifying -ssh option (for the run without endpoints) prints the error with a traceback: Is it possible to print only short error message in such cases?
4. Attempt to run pipe share remove <RUN_ID> without additional options prints the error, nothing happens: But without any options this command shall clear all list of the shared users/groups.
5. Attempt to run pipe share remove -ssh <RUN_ID> without additional options prints the error, nothing happens: But this command shall remove only SSH-sharing for all users/groups for runs with endpoint(s) or remove all users/groups of the run shared list for runs without endpoints.