PLAT-1418 - Workaround fix for mount-data options showing as mandatry in the --help, while they are optional

[georgi-seqera]

Relates to : https://seqera.atlassian.net/browse/PLAT-1418

A known bug in the picocli framework causes even optional params that are grouped together to appear as mandatory in the --help section (as denoted by the *).

This causes the options to mount data to appear as mandatory, while they are optional.

Usage: tw studios start [OPTIONS]

Start a data studio.

Options:
  -w, --workspace=<workspace>       Workspace numeric identifier (TOWER_WORKSPACE_ID as default) or workspace reference as OrganizationName/WorkspaceName
* -i, --id=<sessionId>              DataStudio session ID.
* -n, --name=<dataStudioName>       DataStudio name.
*     --mount-data=<mountDataNames>[,<mountDataNames>...]
                                    Optional configuration override for 'mountData' setting (comma separate list of data-link names)
*     --mount-data-ids=<mountDataIds>[,<mountDataIds>...]
                                    Optional configuration override for 'mountData' setting (comma separate list of data-link Ids)
*     --mount-data-resource-refs=<mountDataResourceRefs>[,<mountDataResourceRefs>...]
                                    Optional configuration override for 'mountData' setting (comma separate list of data-link resource refs)
      --gpu=<gpu>                   Optional configuration override for 'gpu' setting (Integer representing number of cores)
      --cpu=<cpu>                   Optional configuration override for 'cpu' setting (Integer representing number of cores)
      --memory=<memory>             Optional configuration override for 'memory' setting (Integer representing memory in MBs)
      --wait=<wait>                 Wait until given status or fail. Valid options: starting, running, stopping, stopped, errored, building, buildFailed.
      --description=<description>   Optional configuration override for 'description'.
  -h, --help                        Show this help message and exit.
  -V, --version                     Print version information and exit.
$

A workaround (already used in the tower-cli for the PaginationOptions that experience the same issue ) is to add the (validation=false) option and implement our own validation.

After change:

Usage: tw studios start [OPTIONS]

Start a data studio.

Options:
  -w, --workspace=<workspace>       Workspace numeric identifier (TOWER_WORKSPACE_ID as default) or workspace reference as OrganizationName/WorkspaceName
* -i, --id=<sessionId>              DataStudio session ID.
* -n, --name=<dataStudioName>       DataStudio name.
      --gpu=<gpu>                   Optional configuration override for 'gpu' setting (Integer representing number of cores)
      --cpu=<cpu>                   Optional configuration override for 'cpu' setting (Integer representing number of cores)
      --memory=<memory>             Optional configuration override for 'memory' setting (Integer representing memory in MBs)
      --wait=<wait>                 Wait until given status or fail. Valid options: starting, running, stopping, stopped, errored, building, buildFailed.
      --description=<description>   Optional configuration override for 'description'.
  -h, --help                        Show this help message and exit.
  -V, --version                     Print version information and exit.
Option to mount data by passing in one of the below options:
      --mount-data=<mountDataNames>[,<mountDataNames>...]
                                    Optional configuration override for 'mountData' setting (comma separate list of data-link names)
      --mount-data-ids=<mountDataIds>[,<mountDataIds>...]
                                    Optional configuration override for 'mountData' setting (comma separate list of data-link Ids)
      --mount-data-resource-refs=<mountDataResourceRefs>[,<mountDataResourceRefs>...]
                                    Optional configuration override for 'mountData' setting (comma separate list of data-link resource refs)

Trying to supply more than one of the params still throws error:

$ ./tw studios start -w data-studios/data-studios -n studio-ef6b --mount-data adrian-navarro-test --mount-data-ids blabla

 ERROR: --mount-data=<mountDataNames>, --mount-data-ids=<mountDataIds>, --mount-data-resource-refs=<mountDataResourceRefs> are mutually exclusive (specify only one)

[endre-seqera]

minor: this is a bit too clever for my taste, but it checks out :D

[georgi-seqera]

Yeaaah, I felt it as I was writing it too, but I just got excited at the opportunity to use the ^ operator :D

but I agree, it's not worth the weird complexity

[georgi-seqera]

I revised this a bit to make it more readable

[endre-seqera]

Cool solution!