feat: PLAT-1152 / add data studios 'list' command

.gitignore

@@ -7,4 +7,7 @@ build
 **/build-info.properties
 
 # Location for unshared files
-.user/
+.user/
+
+
+*.iml

build.gradle

@@ -27,7 +27,7 @@ dependencies {
     implementation 'org.slf4j:slf4j-api:1.7.36'
     implementation 'ch.qos.logback:logback-core:1.2.11'
     implementation 'ch.qos.logback:logback-classic:1.2.11'
-    implementation 'io.seqera.tower:tower-java-sdk:1.9.7'
+    implementation 'io.seqera.tower:tower-java-sdk:1.9.9'
     implementation 'info.picocli:picocli:4.6.3'
     implementation 'org.apache.commons:commons-compress:1.22'
     implementation 'org.tukaani:xz:1.9'

src/main/java/io/seqera/tower/cli/Tower.java

@@ -27,6 +27,7 @@
 import io.seqera.tower.cli.commands.ComputeEnvsCmd;
 import io.seqera.tower.cli.commands.CredentialsCmd;
 import io.seqera.tower.cli.commands.DataLinksCmd;
+import io.seqera.tower.cli.commands.DataStudiosCmd;
 import io.seqera.tower.cli.commands.DatasetsCmd;
 import io.seqera.tower.cli.commands.InfoCmd;
 import io.seqera.tower.cli.commands.LaunchCmd;
@@ -60,6 +61,7 @@
                 ComputeEnvsCmd.class,
                 CredentialsCmd.class,
                 DataLinksCmd.class,
+                DataStudiosCmd.class,
                 DatasetsCmd.class,
                 GenerateCompletion.class,
                 InfoCmd.class,

src/main/java/io/seqera/tower/cli/commands/DataStudiosCmd.java

@@ -0,0 +1,33 @@
+/*
+ * 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;
+
+import io.seqera.tower.cli.commands.datastudios.ListCmd;
+import io.seqera.tower.cli.commands.datastudios.ViewCmd;
+import picocli.CommandLine;
+
+@CommandLine.Command(
+        name = "studios", // alternative "data-studio"
+        description = "Manage data studios.",
+        subcommands = {
+                ViewCmd.class,
+                ListCmd.class,
+        }
+)
+public class DataStudiosCmd extends AbstractRootCmd {
+}

src/main/java/io/seqera/tower/cli/commands/datastudios/AbstractStudiosCmd.java

@@ -0,0 +1,29 @@
+/*
+ * 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.AbstractApiCmd;
+import io.seqera.tower.model.DataStudioDto;
+
+public class AbstractStudiosCmd extends AbstractApiCmd {
+
+    protected DataStudioDto fetchDataStudio(DataStudioRefOptions dataStudioRefOptions, Long wspId) throws ApiException {
+        return api().describeDataStudio(dataStudioRefOptions.dataStudio.sessionId, wspId);
+    }
+}

src/main/java/io/seqera/tower/cli/commands/datastudios/DataStudioRefOptions.java

@@ -0,0 +1,31 @@
+/*
+ * 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 picocli.CommandLine;
+
+public class DataStudioRefOptions {
+
+    @CommandLine.ArgGroup(multiplicity = "1")
+    public DataStudioRef dataStudio;
+
+    public static class DataStudioRef {
+        @CommandLine.Option(names = {"-i", "--id"}, description = "DataStudio session ID.")
+        public String sessionId;
+    }
+}

src/main/java/io/seqera/tower/cli/commands/datastudios/ListCmd.java

@@ -0,0 +1,71 @@
+/*
+ * 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.global.PaginationOptions;
+import io.seqera.tower.cli.commands.global.WorkspaceOptionalOptions;
+import io.seqera.tower.cli.exceptions.TowerException;
+import io.seqera.tower.cli.exceptions.WorkspaceNotFoundException;
+import io.seqera.tower.cli.responses.Response;
+import io.seqera.tower.cli.responses.datastudios.DataStudiosList;
+import io.seqera.tower.cli.utils.PaginationInfo;
+import io.seqera.tower.model.DataStudioListResponse;
+import picocli.CommandLine;
+import picocli.CommandLine.Command;
+
+import java.io.IOException;
+
+@Command(
+        name = "list",
+        description = "List workspace data studios."
+)
+public class ListCmd extends AbstractStudiosCmd {
+
+    @CommandLine.Mixin
+    public WorkspaceOptionalOptions workspace;
+
+    @CommandLine.Option(names = {"-f", "--filter"}, description = "Optional filter criteria, allowing free text search on name and templateUrl " +
+            "and keywords: `userName`, `computeEnvName` and `status`. Example keyword usage: -f status:RUNNING")
+    public String filter;
+
+    @CommandLine.Mixin
+    PaginationOptions paginationOptions;
+
+    @Override
+    protected Response exec() throws ApiException, IOException {
+        Long wspId = workspaceId(workspace.workspace);
+        Integer max = PaginationOptions.getMax(paginationOptions);
+        Integer offset = PaginationOptions.getOffset(paginationOptions, max);
+
+        DataStudioListResponse response = new DataStudioListResponse();
+
+        try {
+           response = api().listDataStudios(wspId, filter, max, offset);
+        } catch (ApiException e) {
+            if (e.getCode() == 404){
+                throw new WorkspaceNotFoundException(wspId);
+            }
+            if (e.getCode() == 403) {
+                throw new TowerException(String.format("User not entitled to %s workspace", wspId));
+            }
+        }
+
+        return new DataStudiosList(workspaceRef(wspId), response.getStudios(), PaginationInfo.from(paginationOptions, response.getTotalSize()));
+    }
+}

src/main/java/io/seqera/tower/cli/commands/datastudios/ViewCmd.java

@@ -0,0 +1,60 @@
+/*
+ * 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.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.DataStudiosView;
+import io.seqera.tower.model.DataStudioDto;
+import picocli.CommandLine;
+
+@CommandLine.Command(
+        name = "view",
+        description = "View data studio."
+)
+public class ViewCmd extends AbstractStudiosCmd {
+
+    @CommandLine.Mixin
+    public WorkspaceOptionalOptions workspace;
+
+    @CommandLine.Mixin
+    public DataStudioRefOptions dataStudioRefOptions;
+
+    @Override
+    protected Response exec() throws ApiException {
+        Long wspId = workspaceId(workspace.workspace);
+
+        try {
+            DataStudioDto dataStudioDto = fetchDataStudio(dataStudioRefOptions, wspId);
+
+            return new DataStudiosView(dataStudioDto, workspaceRef(wspId));
+        } 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;
+        }
+    }
+
+}

src/main/java/io/seqera/tower/cli/exceptions/DataStudioNotFoundException.java

@@ -0,0 +1,26 @@
+/*
+ * 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.exceptions;
+
+public class DataStudioNotFoundException extends TowerException {
+
+    public DataStudioNotFoundException( String sessionId, Long workspaceId) {
+        super(String.format("DataStudio '%s' not found at workspace '%s'", sessionId, workspaceId));
+    }
+
+}

src/main/java/io/seqera/tower/cli/responses/datastudios/DataStudiosList.java

@@ -0,0 +1,87 @@
+/*
+ * 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 java.io.PrintWriter;
+import java.util.ArrayList;
+import java.util.List;
+import javax.annotation.Nullable;
+
+import com.fasterxml.jackson.annotation.JsonIgnore;
+import io.seqera.tower.cli.responses.Response;
+import io.seqera.tower.cli.utils.PaginationInfo;
+import io.seqera.tower.cli.utils.TableList;
+import io.seqera.tower.model.DataStudioDto;
+import io.seqera.tower.model.DataStudioStatusInfo;
+import io.seqera.tower.model.StudioUser;
+
+import static io.seqera.tower.cli.utils.FormatHelper.formatDataStudioStatus;
+
+public class DataStudiosList extends Response {
+
+    public final String workspaceRef;
+    public final List<DataStudioDto> studios;
+
+    @JsonIgnore
+    @Nullable
+    private final PaginationInfo paginationInfo;
+
+    public DataStudiosList(String workspaceRef, List<DataStudioDto> studios, @Nullable PaginationInfo paginationInfo) {
+        this.workspaceRef = workspaceRef;
+        this.studios = studios;
+        this.paginationInfo = paginationInfo;
+    }
+
+    @Override
+    public void toString(PrintWriter out) {
+
+        out.println(ansi(String.format("%n  @|bold Data Studios at %s workspace:|@%n", workspaceRef)));
+
+        if (studios.isEmpty()) {
+            out.println(ansi("    @|yellow No data studios found|@"));
+            return;
+        }
+
+        List<String> descriptions = new ArrayList<>(List.of("ID", "Name", "Description", "User", "Status"));
+
+        TableList table = new TableList(out, descriptions.size(), descriptions.toArray(new String[descriptions.size()])).sortBy(0);
+        table.setPrefix("    ");
+
+        studios.forEach(studio -> {
+
+            DataStudioStatusInfo statusInfo = studio.getStatusInfo();
+            StudioUser user = studio.getUser();
+            List<String> rows = new ArrayList<>(List.of(
+                    studio.getSessionId() == null ? "" : studio.getSessionId(),
+                    studio.getName() == null ? "" : studio.getName(),
+                    studio.getDescription() == null ? "" : studio.getDescription(),
+                    user == null ? "" : user.getUserName(),
+                    formatDataStudioStatus(statusInfo == null ? null : statusInfo.getStatus())
+            ));
+
+            table.addRow(rows.toArray(new String[rows.size()]));
+        });
+
+        table.print();
+
+        PaginationInfo.addFooter(out, paginationInfo);
+
+        out.println("");
+    }
+
+}