-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
PLAT-1242 - Add DataStudio start command.
- Loading branch information
1 parent
bcb3d9d
commit e5dc023
Showing
13 changed files
with
980 additions
and
311 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
41 changes: 41 additions & 0 deletions
41
src/main/java/io/seqera/tower/cli/commands/datastudios/DataStudioConfigurationOptions.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| /* | ||
| * Copyright 2021-2023, Seqera. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| * | ||
| */ | ||
|
|
||
| package io.seqera.tower.cli.commands.datastudios; | ||
|
|
||
| import java.util.List; | ||
|
|
||
| import picocli.CommandLine; | ||
|
|
||
| public class DataStudioConfigurationOptions { | ||
|
|
||
| @CommandLine.Option(names = {"-g", "--gpu"}, description = "Optional configuration override for 'gpu' setting (Integer representing number of cores)") | ||
| public Integer gpu; | ||
|
|
||
| @CommandLine.Option(names = {"-c", "--cpu"}, description = "Optional configuration override for 'cpu' setting (Integer representing number of cores)") | ||
| public Integer cpu; | ||
|
|
||
| @CommandLine.Option(names = {"-m", "--memory"}, description = "Optional configuration override for 'memory' setting (Integer representing memory in MBs)") | ||
| public Integer memory; | ||
|
|
||
| @CommandLine.Option(names = {"--mount-data"}, description = "Optional configuration override for 'mountData' setting (comma separate list of datalinkIds)", split = ",") | ||
| public List<String> mountData; | ||
|
|
||
| @CommandLine.Option(names = {"--conda-env"}, description = "Optional configuration override for 'condaEnvironment' setting (YAML conda packages configurations)") | ||
| public String condaEnvironment; | ||
|
|
||
| } |
155 changes: 155 additions & 0 deletions
155
src/main/java/io/seqera/tower/cli/commands/datastudios/StartCmd.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,155 @@ | ||
| /* | ||
| * Copyright 2021-2023, Seqera. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| * | ||
| */ | ||
|
|
||
| package io.seqera.tower.cli.commands.datastudios; | ||
|
|
||
| import io.seqera.tower.ApiException; | ||
| import io.seqera.tower.cli.commands.enums.OutputType; | ||
| import io.seqera.tower.cli.commands.global.WorkspaceOptionalOptions; | ||
| import io.seqera.tower.cli.exceptions.DataStudioNotFoundException; | ||
| import io.seqera.tower.cli.exceptions.TowerException; | ||
| import io.seqera.tower.cli.responses.Response; | ||
| import io.seqera.tower.cli.responses.datastudios.DataStudioStartSubmitted; | ||
| import io.seqera.tower.model.DataStudioConfiguration; | ||
| import io.seqera.tower.model.DataStudioDto; | ||
| import io.seqera.tower.model.DataStudioStartRequest; | ||
| import io.seqera.tower.model.DataStudioStartResponse; | ||
| import io.seqera.tower.model.DataStudioStatus; | ||
| import picocli.CommandLine; | ||
|
|
||
| import static io.seqera.tower.cli.utils.ResponseHelper.waitStatus; | ||
| import static java.lang.Boolean.FALSE; | ||
|
|
||
| @CommandLine.Command( | ||
| name = "start", | ||
| description = "Start a data studio." | ||
| ) | ||
| public class StartCmd extends AbstractStudiosCmd { | ||
|
|
||
| @CommandLine.Mixin | ||
| public WorkspaceOptionalOptions workspace; | ||
|
|
||
| @CommandLine.Mixin | ||
| public DataStudioRefOptions dataStudioRefOptions; | ||
|
|
||
| @CommandLine.Mixin | ||
| public DataStudioConfigurationOptions dataStudioConfigOptions; | ||
|
|
||
| @CommandLine.Option(names = {"--wait"}, description = "Wait until given status or fail. Valid options: ${COMPLETION-CANDIDATES}.") | ||
| public DataStudioStatus wait; | ||
|
|
||
| @CommandLine.Option(names = {"--description"}, description = "Optional configuration override for 'description'.") | ||
| public String description; | ||
|
|
||
| @Override | ||
| protected Response exec() throws ApiException { | ||
| Long wspId = workspaceId(workspace.workspace); | ||
|
|
||
| try { | ||
| DataStudioDto dataStudioDto = fetchDataStudio(dataStudioRefOptions, wspId); | ||
|
|
||
| DataStudioStartRequest request = getStartRequestWithOverridesApplied(dataStudioDto); | ||
|
|
||
| DataStudioStartResponse response = api().startDataStudio(dataStudioRefOptions.dataStudio.sessionId, request, wspId); | ||
|
|
||
| return new DataStudioStartSubmitted(dataStudioRefOptions.dataStudio.sessionId, wspId, workspaceRef(wspId), dataStudioDto.getStudioUrl(), response.getJobSubmitted()); | ||
| } catch (ApiException e) { | ||
| if (e.getCode() == 404) { | ||
| throw new DataStudioNotFoundException(dataStudioRefOptions.dataStudio.sessionId, wspId); | ||
| } | ||
| if (e.getCode() == 403) { | ||
| throw new TowerException(String.format("User not entitled to view studio '%s' at %s workspace", dataStudioRefOptions.dataStudio.sessionId, wspId)); | ||
| } | ||
| throw e; | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| protected Integer onBeforeExit(int exitCode, Response response) { | ||
|
|
||
| if (exitCode != 0 || wait == null || response == null) { | ||
| return exitCode; | ||
| } | ||
|
|
||
| DataStudioStartSubmitted submitted = (DataStudioStartSubmitted) response; | ||
|
|
||
| // If response declares job failed to submit, don't wait and exit early. | ||
| if (FALSE.equals(submitted.jobSubmitted)) { | ||
| return exitCode; | ||
| } | ||
|
|
||
| boolean showProgress = app().output != OutputType.json; | ||
|
|
||
| try { | ||
| return waitStatus( | ||
| app().getOut(), | ||
| showProgress, | ||
| new ProgressStepMessageSupplier(submitted.sessionId, submitted.workspaceId), | ||
| wait, | ||
| DataStudioStatus.values(), | ||
| () -> checkDataStudioStatus(submitted.sessionId, submitted.workspaceId), | ||
| DataStudioStatus.STOPPED, DataStudioStatus.ERRORED, DataStudioStatus.RUNNING | ||
| ); | ||
| } catch (InterruptedException e) { | ||
| return exitCode; | ||
| } | ||
| } | ||
|
|
||
| private DataStudioStatus checkDataStudioStatus(String sessionId, Long workspaceId) { | ||
| try { | ||
| return api().describeDataStudio(sessionId, workspaceId).getStatusInfo().getStatus(); | ||
| } catch (ApiException | NullPointerException e) { | ||
| return null; | ||
| } | ||
| } | ||
|
|
||
| private DataStudioStartRequest getStartRequestWithOverridesApplied(DataStudioDto dataStudioDto) { | ||
| DataStudioConfiguration dataStudioConfiguration = dataStudioDto.getConfiguration() == null | ||
| ? new DataStudioConfiguration() | ||
| : dataStudioDto.getConfiguration(); | ||
|
|
||
| dataStudioConfiguration.setGpu(dataStudioConfigOptions.gpu == null | ||
| ? dataStudioConfiguration.getGpu() | ||
| : dataStudioConfigOptions.gpu); | ||
| dataStudioConfiguration.setCpu(dataStudioConfigOptions.cpu == null | ||
| ? dataStudioConfiguration.getCpu() | ||
| : dataStudioConfigOptions.cpu); | ||
| dataStudioConfiguration.setMemory(dataStudioConfigOptions.memory == null | ||
| ? dataStudioConfiguration.getMemory() | ||
| : dataStudioConfigOptions.memory); | ||
| dataStudioConfiguration.setMountData(dataStudioConfigOptions.mountData == null | ||
| ? dataStudioConfiguration.getMountData() | ||
| : dataStudioConfigOptions.mountData); | ||
| dataStudioConfiguration.setCondaEnvironment(dataStudioConfigOptions.condaEnvironment == null | ||
| ? dataStudioConfiguration.getCondaEnvironment() | ||
| : dataStudioConfigOptions.condaEnvironment); | ||
|
|
||
| String appliedDescription = description == null | ||
| ? dataStudioDto.getDescription() | ||
| : description; | ||
|
|
||
| DataStudioStartRequest request = new DataStudioStartRequest(); | ||
|
|
||
| request.setConfiguration(dataStudioConfiguration); | ||
| request.setDescription(appliedDescription); | ||
|
|
||
| return request; | ||
| } | ||
|
|
||
|
|
||
|
|
||
| } |
46 changes: 46 additions & 0 deletions
46
src/main/java/io/seqera/tower/cli/responses/datastudios/DataStudioStartSubmitted.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,46 @@ | ||
| /* | ||
| * Copyright 2021-2023, Seqera. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| * | ||
| */ | ||
|
|
||
| package io.seqera.tower.cli.responses.datastudios; | ||
|
|
||
| import io.seqera.tower.cli.responses.Response; | ||
|
|
||
| public class DataStudioStartSubmitted extends Response { | ||
|
|
||
| public final String sessionId; | ||
|
|
||
| public final String studioUrl; | ||
|
|
||
| public final Long workspaceId; | ||
| public final String workspaceRef; | ||
| public final Boolean jobSubmitted; | ||
|
|
||
| public DataStudioStartSubmitted(String sessionId, Long workspaceId, String workspaceRef, String studioUrl, Boolean jobSubmitted) { | ||
| this.sessionId = sessionId; | ||
| this.workspaceId = workspaceId; | ||
| this.workspaceRef = workspaceRef; | ||
| this.studioUrl = studioUrl; | ||
| this.jobSubmitted = jobSubmitted; | ||
| } | ||
|
|
||
| @Override | ||
| public String toString() { | ||
| String isSuccess = jobSubmitted ? "successfully submitted" : "failed to submit"; | ||
| return ansi(String.format("%n @|yellow Data Studio %s START %s at %s workspace.|@%n%n @|bold %s|@%n", sessionId, isSuccess, workspaceRef, studioUrl)); | ||
| } | ||
|
|
||
| } |
Oops, something went wrong.