Address review comments

NautiluX · NautiluX · commit 5a1192ea6d4e · 2025-06-06T06:14:59.000+02:00
Signed-off-by: Manuel Dewald &lt;manuel@codesphere.com&gt;
diff --git a/cli/cmd/create-workspace.go b/cli/cmd/create-workspace.go
@@ -11,11 +11,10 @@ import (
 
 	"github.com/codesphere-cloud/cs-go/api"
 	"github.com/codesphere-cloud/cs-go/pkg/cs"
-	"github.com/codesphere-cloud/cs-go/pkg/out"
+	"github.com/codesphere-cloud/cs-go/pkg/io"
 	"github.com/spf13/cobra"
 )
 
-// CreateWorkspaceCmd represents the workspace command
 type CreateWorkspaceCmd struct {
 	cmd  *cobra.Command
 	Opts CreateWorkspaceOpts
@@ -78,15 +77,15 @@ func AddCreateWorkspaceCmd(create *cobra.Command, opts GlobalOptions) {
 			Use:   "workspace",
 			Short: "Create a workspace",
 			Args:  cobra.RangeArgs(1, 1),
-			Long: out.Long(`Create a workspace in Codesphere.
+			Long: io.Long(`Create a workspace in Codesphere.
 
 				Specify a (private) git repository or start an empty workspace.
 				Environment variables can be set to initialize the workspace with a specific environment.
 				The command will wait for the workspace to become running or a timeout is reached.
 
 				To decide which plan suits your needs, run 'cs list plans'
 			`),
-			Example: out.FormatExampleCommands("create workspace my-workspace", []out.Example{
+			Example: io.FormatExampleCommands("create workspace my-workspace", []io.Example{
 				{Cmd: "-p 20", Desc: "Create an empty workspace, using plan 20"},
 				{Cmd: "-r https://github.com/codesphere-cloud/landingpage-temp.git", Desc: "Create a workspace from a git repository"},
 				{Cmd: "-r https://github.com/codesphere-cloud/landingpage-temp.git -e DEPLOYMENT=prod -e A=B", Desc: "Create a workspace and set environment variables"},
diff --git a/cli/cmd/create.go b/cli/cmd/create.go
@@ -7,7 +7,6 @@ import (
 	"github.com/spf13/cobra"
 )
 
-// CreateCmd represents the create command
 type CreateCmd struct {
 	cmd *cobra.Command
 }
diff --git a/cli/cmd/delete-workspace.go b/cli/cmd/delete-workspace.go
@@ -4,15 +4,14 @@ import (
 	"errors"
 	"fmt"
 
-	"github.com/codesphere-cloud/cs-go/pkg/out"
+	"github.com/codesphere-cloud/cs-go/pkg/io"
 	"github.com/spf13/cobra"
 )
 
 type Prompt interface {
 	InputPrompt(prompt string) string
 }
 
-// DeleteWorkspaceCmd represents the workspace command
 type DeleteWorkspaceCmd struct {
 	cmd    *cobra.Command
 	Opts   DeleteWorkspaceOpts
@@ -43,12 +42,12 @@ func AddDeleteWorkspaceCmd(delete *cobra.Command, opts GlobalOptions) {
 		cmd: &cobra.Command{
 			Use:   "workspace",
 			Short: "Delete workspace",
-			Long: out.Long(`Delete workspace after confirmation.
+			Long: io.Long(`Delete workspace after confirmation.
 
 			Confirmation can be given interactively or with the --yes flag`),
 		},
 		Opts:   DeleteWorkspaceOpts{GlobalOptions: opts},
-		Prompt: &out.Prompt{},
+		Prompt: &io.Prompt{},
 	}
 	workspace.Opts.Confirmed = workspace.cmd.Flags().Bool("yes", false, "Confirm deletion of workspace")
 	delete.AddCommand(workspace.cmd)
diff --git a/cli/cmd/delete.go b/cli/cmd/delete.go
@@ -4,7 +4,6 @@ import (
 	"github.com/spf13/cobra"
 )
 
-// DeleteCmd represents the delete command
 type DeleteCmd struct {
 	cmd *cobra.Command
 }
diff --git a/cli/cmd/exec.go b/cli/cmd/exec.go
@@ -9,12 +9,11 @@ import (
 	"strings"
 
 	"github.com/codesphere-cloud/cs-go/pkg/cs"
-	"github.com/codesphere-cloud/cs-go/pkg/out"
+	"github.com/codesphere-cloud/cs-go/pkg/io"
 
 	"github.com/spf13/cobra"
 )
 
-// ExecCmd represents the exec command
 type ExecCmd struct {
 	cmd  *cobra.Command
 	Opts ExecOptions
@@ -44,9 +43,9 @@ func AddExecCmd(rootCmd *cobra.Command, opts GlobalOptions) {
 			Use:   "exec",
 			Args:  cobra.MinimumNArgs(1),
 			Short: "Run a command in Codesphere workspace",
-			Long: out.Long(`Run a command in a Codesphere workspace.
+			Long: io.Long(`Run a command in a Codesphere workspace.
 				Output will be printed to STDOUT, errors to STDERR.`),
-			Example: out.FormatExampleCommands("exec", []out.Example{
+			Example: io.FormatExampleCommands("exec", []io.Example{
 				{Cmd: "-- echo hello world", Desc: "Print `hello world`"},
 				{Cmd: "-- find .", Desc: "List all files in workspace"},
 				{Cmd: "-d user -- find .", Desc: "List all files in the user directory"},
diff --git a/cli/cmd/licenses.go b/cli/cmd/licenses.go
@@ -11,7 +11,6 @@ import (
 	"github.com/spf13/cobra"
 )
 
-// LicensesCmd represents the licenses command
 type LicensesCmd struct {
 	cmd *cobra.Command
 }
diff --git a/cli/cmd/list-plans.go b/cli/cmd/list-plans.go
@@ -6,14 +6,13 @@ package cmd
 import (
 	"fmt"
 
-	"github.com/codesphere-cloud/cs-go/pkg/out"
+	"github.com/codesphere-cloud/cs-go/pkg/io"
 
 	"github.com/jedib0t/go-pretty/v6/table"
 	"github.com/jedib0t/go-pretty/v6/text"
 	"github.com/spf13/cobra"
 )
 
-// ListPlansCmd represents the plans command
 type ListPlansCmd struct {
 	cmd  *cobra.Command
 	Opts GlobalOptions
@@ -31,7 +30,7 @@ func (c *ListPlansCmd) RunE(_ *cobra.Command, args []string) error {
 		return fmt.Errorf("failed to list plans: %s", err)
 	}
 
-	t := out.GetTableWriter()
+	t := io.GetTableWriter()
 	t.AppendHeader(table.Row{"ID", "Name", "On Demand", "CPU", "RAM(GiB)", "SSD(GiB)", "Price(USD)", "Max Replicas"})
 	t.SetColumnConfigs([]table.ColumnConfig{
 		{Name: "Price(USD)", Align: text.AlignRight},
@@ -71,7 +70,7 @@ func AddListPlansCmd(list *cobra.Command, opts GlobalOptions) {
 		cmd: &cobra.Command{
 			Use:   "plans",
 			Short: "List available plans",
-			Long: out.Long(`List available workpace plans.
+			Long: io.Long(`List available workpace plans.
 
 				When creating new workspaces you need to select a specific plan.`),
 		},
diff --git a/cli/cmd/list-teams.go b/cli/cmd/list-teams.go
@@ -7,7 +7,7 @@ import (
 	"fmt"
 
 	"github.com/codesphere-cloud/cs-go/pkg/cs"
-	"github.com/codesphere-cloud/cs-go/pkg/out"
+	"github.com/codesphere-cloud/cs-go/pkg/io"
 	"github.com/jedib0t/go-pretty/v6/table"
 
 	"github.com/spf13/cobra"
@@ -24,7 +24,7 @@ func addListTeamsCmd(p *cobra.Command, opts GlobalOptions) {
 			Use:   "teams",
 			Short: "List teams",
 			Long:  `List teams available in Codesphere`,
-			Example: out.FormatExampleCommands("list teams", []out.Example{
+			Example: io.FormatExampleCommands("list teams", []io.Example{
 				{Desc: "List all teams"},
 			}),
 		},
@@ -45,7 +45,7 @@ func (l *ListTeamsCmd) RunE(_ *cobra.Command, args []string) (err error) {
 		return fmt.Errorf("failed to list teams: %w", err)
 	}
 
-	t := out.GetTableWriter()
+	t := io.GetTableWriter()
 	t.AppendHeader(table.Row{"P", "ID", "Name", "Role", "Default DC"})
 	for _, team := range teams {
 		first := ""
diff --git a/cli/cmd/list-workspaces.go b/cli/cmd/list-workspaces.go
@@ -7,7 +7,7 @@ import (
 	"fmt"
 
 	"github.com/codesphere-cloud/cs-go/api"
-	"github.com/codesphere-cloud/cs-go/pkg/out"
+	"github.com/codesphere-cloud/cs-go/pkg/io"
 	"github.com/jedib0t/go-pretty/v6/table"
 
 	"github.com/spf13/cobra"
@@ -24,7 +24,7 @@ func addListWorkspacesCmd(p *cobra.Command, opts GlobalOptions) {
 			Use:   "workspaces",
 			Short: "List workspaces",
 			Long:  `List workspaces available in Codesphere`,
-			Example: out.FormatExampleCommands("list workspaces", []out.Example{
+			Example: io.FormatExampleCommands("list workspaces", []io.Example{
 				{Cmd: "--team-id <team-id>", Desc: "List all workspaces"},
 			}),
 		},
@@ -45,7 +45,7 @@ func (l *ListWorkspacesCmd) RunE(_ *cobra.Command, args []string) (err error) {
 		return fmt.Errorf("failed to list workspaces: %w", err)
 	}
 
-	t := out.GetTableWriter()
+	t := io.GetTableWriter()
 	t.AppendHeader(table.Row{"Team ID", "ID", "Name", "Repository"})
 	for _, w := range workspaces {
 		gitUrl := ""
diff --git a/cli/cmd/list.go b/cli/cmd/list.go
@@ -4,7 +4,7 @@
 package cmd
 
 import (
-	"github.com/codesphere-cloud/cs-go/pkg/out"
+	"github.com/codesphere-cloud/cs-go/pkg/io"
 	"github.com/spf13/cobra"
 )
 
@@ -18,7 +18,7 @@ func AddListCmd(rootCmd *cobra.Command, opts GlobalOptions) {
 			Use:   "list",
 			Short: "List resources",
 			Long:  `List resources available in Codesphere`,
-			Example: out.FormatExampleCommands("list", []out.Example{
+			Example: io.FormatExampleCommands("list", []io.Example{
 				{Cmd: "workspaces", Desc: "List all workspaces"},
 			}),
 		},
diff --git a/cli/cmd/log.go b/cli/cmd/log.go
@@ -18,7 +18,7 @@ import (
 	"sync"
 
 	"github.com/codesphere-cloud/cs-go/pkg/cs"
-	"github.com/codesphere-cloud/cs-go/pkg/out"
+	csio "github.com/codesphere-cloud/cs-go/pkg/io"
 	"github.com/spf13/cobra"
 )
 
@@ -58,14 +58,14 @@ func AddLogCmd(rootCmd *cobra.Command, opts GlobalOptions) {
 		cmd: &cobra.Command{
 			Use:   "log",
 			Short: "Retrieve run logs from services",
-			Long: `You can retrieve logs based on the given scope.
+			Long: csio.Long(`You can retrieve logs based on the given scope.
 
-If you provide the step number and server, it returns all logs from
-all replicas of that server.
+				If you provide the step number and server, it returns all logs from
+				all replicas of that server.
 
-If you provide a specific replica id, it will return the logs of
-that replica only.`,
-			Example: out.FormatExampleCommands("log", []out.Example{
+				If you provide a specific replica id, it will return the logs of
+				that replica only.`),
+			Example: csio.FormatExampleCommands("log", []csio.Example{
 				{Cmd: "-w 637128 -s app", Desc: "Get logs from a server"},
 				{Cmd: "-w 637128", Desc: "Get all logs of all servers"},
 				{Cmd: "-w 637128 -r workspace-213d7a8c-48b4-42e2-8f70-c905ab04abb5-58d657cdc5-m8rrp", Desc: "Get logs from a replica"},
diff --git a/cli/cmd/open-workspace.go b/cli/cmd/open-workspace.go
@@ -7,11 +7,10 @@ import (
 	"fmt"
 
 	"github.com/codesphere-cloud/cs-go/pkg/cs"
-	"github.com/codesphere-cloud/cs-go/pkg/out"
+	"github.com/codesphere-cloud/cs-go/pkg/io"
 	"github.com/spf13/cobra"
 )
 
-// OpenWorkspaceCmd represents the workspace command
 type OpenWorkspaceCmd struct {
 	cmd  *cobra.Command
 	Opts GlobalOptions
@@ -41,7 +40,7 @@ func AddOpenWorkspaceCmd(open *cobra.Command, opts GlobalOptions) {
 			Use:   "workspace",
 			Short: "Open workspace in the Codesphere IDE",
 			Long:  `Open workspace in the Codesphere IDE in your web browser.`,
-			Example: out.FormatExampleCommands("open workspace", []out.Example{
+			Example: io.FormatExampleCommands("open workspace", []io.Example{
 				{Cmd: "-w 42", Desc: "open workspace 42 in web browser"},
 				{Cmd: "", Desc: "open workspace set by environment variable CS_WORKSPACE_ID"},
 			}),
diff --git a/cli/cmd/open.go b/cli/cmd/open.go
@@ -11,14 +11,11 @@ import (
 	"github.com/codesphere-cloud/cs-go/pkg/cs"
 )
 
-// OpenCmd represents the open command
 type OpenCmd struct {
 	cmd *cobra.Command
 }
 
 func (c *OpenCmd) RunE(_ *cobra.Command, args []string) error {
-	//Command execution goes here
-
 	fmt.Println("Opening Codesphere IDE")
 	return cs.NewBrowser().OpenIde("")
 }
diff --git a/cli/cmd/set-env-vars.go b/cli/cmd/set-env-vars.go
@@ -7,7 +7,7 @@ import (
 	"fmt"
 
 	"github.com/codesphere-cloud/cs-go/pkg/cs"
-	"github.com/codesphere-cloud/cs-go/pkg/out"
+	"github.com/codesphere-cloud/cs-go/pkg/io"
 	"github.com/spf13/cobra"
 )
 
@@ -27,7 +27,7 @@ func AddSetEnvVarCmd(p *cobra.Command, opts GlobalOptions) {
 			Use:   "set-env",
 			Short: "Set environment varariables",
 			Long:  `Set environment variables in a workspace`,
-			Example: out.FormatExampleCommands("set-env", []out.Example{
+			Example: io.FormatExampleCommands("set-env", []io.Example{
 				{Cmd: "--workspace <workspace-id> --env-var foo=bar", Desc: "Set single environment variable"},
 				{Cmd: "--workspace <workspace-id> --env-var foo=bar --env-var hello=world", Desc: "Set multiple environment variables"},
 			}),
diff --git a/cli/cmd/version.go b/cli/cmd/version.go
@@ -10,7 +10,6 @@ import (
 	"github.com/spf13/cobra"
 )
 
-// VersionCmd represents the version command
 type VersionCmd struct {
 	cmd *cobra.Command
 }
diff --git a/pkg/io/io.go b/pkg/io/io.go
@@ -1,7 +1,7 @@
 // Copyright (c) Codesphere Inc.
 // SPDX-License-Identifier: Apache-2.0
 
-package out
+package io
 
 import (
 	"bufio"
@@ -51,16 +51,13 @@ type Prompt struct{}
 
 // Prompt for non-empty user input from STDIN
 func (p *Prompt) InputPrompt(prompt string) string {
-	var input string
 	r := bufio.NewReader(os.Stdin)
 	for {
 		fmt.Printf("%s: ", prompt)
-		input, _ = r.ReadString('\n')
-
+		input, err := r.ReadString('\n')
 		input = strings.TrimSpace(input)
-		if input != "" {
-			break
+		if input != "" || err != nil {
+			return input
 		}
 	}
-	return input
 }

Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,6 @@ import (`
`7`	`7`	`"github.com/spf13/cobra"`
`8`	`8`	`)`
`9`	`9`
`10`		`-// CreateCmd represents the create command`
`11`	`10`	`type CreateCmd struct {`
`12`	`11`	`cmd *cobra.Command`
`13`	`12`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,6 @@ import (`
`4`	`4`	`"github.com/spf13/cobra"`
`5`	`5`	`)`
`6`	`6`
`7`		`-// DeleteCmd represents the delete command`
`8`	`7`	`type DeleteCmd struct {`
`9`	`8`	`cmd *cobra.Command`
`10`	`9`	`}`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,6 @@ import (`
`11`	`11`	`"github.com/spf13/cobra"`
`12`	`12`	`)`
`13`	`13`
`14`		`-// LicensesCmd represents the licenses command`
`15`	`14`	`type LicensesCmd struct {`
`16`	`15`	`cmd *cobra.Command`
`17`	`16`	`}`