feat: Print requests and responses on when passing -v flag (#191)

NautiluX · web-flow · commit 9892e3d87f52 · 2026-02-25T16:33:03.000+01:00
* feat: Print requests and responses on when passing -v flag

* chore(docs): Auto-update docs and licenses

Signed-off-by: NautiluX &lt;2600004+NautiluX@users.noreply.github.com&gt;

---------

Signed-off-by: NautiluX &lt;2600004+NautiluX@users.noreply.github.com&gt;
Co-authored-by: NautiluX &lt;2600004+NautiluX@users.noreply.github.com&gt;
diff --git a/api/client.go b/api/client.go
@@ -24,6 +24,9 @@ type Configuration struct {
 	BaseUrl *url.URL
 	// Codesphere api token
 	Token string
+
+	// Verbose output for debugging
+	Verbose bool
 }
 
 func (c Configuration) GetApiUrl() *url.URL {
@@ -52,6 +55,7 @@ func NewClient(ctx context.Context, opts Configuration) *Client {
 	cfg.Servers = []openapi_client.ServerConfiguration{{
 		URL: opts.BaseUrl.String(),
 	}}
+	cfg.Debug = opts.Verbose
 	return NewClientWithCustomDeps(ctx, opts, openapi_client.NewAPIClient(cfg), &RealTime{})
 }
 
diff --git a/cli/cmd/client.go b/cli/cmd/client.go
@@ -51,6 +51,7 @@ func NewClient(opts GlobalOptions) (Client, error) {
 	client := api.NewClient(context.Background(), api.Configuration{
 		BaseUrl: apiUrl,
 		Token:   token,
+		Verbose: opts.Verbose,
 	})
 	return client, nil
 }
diff --git a/cli/cmd/create_workspace_test.go b/cli/cmd/create_workspace_test.go
@@ -56,7 +56,7 @@ var _ = Describe("CreateWorkspace", func() {
 			Opts: cmd.CreateWorkspaceOpts{
 				GlobalOptions: cmd.GlobalOptions{
 					Env:    mockEnv,
-					TeamId: &teamId,
+					TeamId: teamId,
 				},
 				Env:       &env,
 				Repo:      repo,
diff --git a/cli/cmd/curl_test.go b/cli/cmd/curl_test.go
@@ -46,7 +46,7 @@ var _ = Describe("Curl", func() {
 			Opts: cmd.CurlOptions{
 				GlobalOptions: cmd.GlobalOptions{
 					Env:         mockEnv,
-					WorkspaceId: &wsId,
+					WorkspaceId: wsId,
 				},
 				Timeout:  30 * time.Second,
 				Executor: mockExecutor,
diff --git a/cli/cmd/delete_workspace_test.go b/cli/cmd/delete_workspace_test.go
@@ -33,7 +33,7 @@ var _ = Describe("DeleteWorkspace", func() {
 			Opts: cmd.DeleteWorkspaceOpts{
 				GlobalOptions: cmd.GlobalOptions{
 					Env:         mockEnv,
-					WorkspaceId: &wsId,
+					WorkspaceId: wsId,
 				},
 				Confirmed: &confirmed,
 			},
diff --git a/cli/cmd/exec_test.go b/cli/cmd/exec_test.go
@@ -34,7 +34,7 @@ var _ = Describe("Exec", func() {
 			Opts: cmd.ExecOptions{
 				GlobalOptions: cmd.GlobalOptions{
 					Env:         mockEnv,
-					WorkspaceId: &wsId,
+					WorkspaceId: wsId,
 				},
 				EnvVar:  &envVars,
 				WorkDir: &workDir,
diff --git a/cli/cmd/generate_docker_test.go b/cli/cmd/generate_docker_test.go
@@ -44,7 +44,8 @@ var _ = Describe("GenerateDocker", func() {
 			Opts: &cmd.GenerateDockerOpts{
 				GenerateOpts: &cmd.GenerateOpts{
 					GlobalOptions: cmd.GlobalOptions{
-						Env: mockEnv,
+						WorkspaceId: -1,
+						Env:         mockEnv,
 					},
 					Input:  defaultInput,
 					Output: defaultOutput,
@@ -109,16 +110,17 @@ var _ = Describe("GenerateDocker", func() {
 		})
 
 		Context("when workspace ID is set in the env var", func() {
+			BeforeEach(func() {
+				wsId = 99
+			})
 			It("should use the workspace ID from environment", func() {
-				envWsId := 99
-				mockEnv.EXPECT().GetWorkspaceId().Return(envWsId, nil)
-
 				cmd := &cmd.GenerateDockerCmd{
 					Opts: &cmd.GenerateDockerOpts{
 						GenerateOpts: &cmd.GenerateOpts{
 							GlobalOptions: cmd.GlobalOptions{
-								Env: mockEnv,
-								// WorkspaceId is nil, so it will use env var
+								Env:         mockEnv,
+								WorkspaceId: -1,
+								// WorkspaceId is -1 (default), so it will use env var
 							},
 						},
 						BaseImage: "alpine:latest",
@@ -128,7 +130,8 @@ var _ = Describe("GenerateDocker", func() {
 				ws := api.Workspace{
 					GitUrl: *openapi_client.NewNullableString(&repoUrl),
 				}
-				mockClient.EXPECT().GetWorkspace(envWsId).Return(ws, nil)
+				mockEnv.EXPECT().GetWorkspaceId().Return(wsId, nil)
+				mockClient.EXPECT().GetWorkspace(99).Return(ws, nil)
 				mockGit.EXPECT().CloneRepository(memoryFs, repoUrl, branch, clonedir).Return(nil, nil)
 
 				err := cmd.CloneRepository(mockClient, memoryFs, mockGit, clonedir)
@@ -144,7 +147,7 @@ var _ = Describe("GenerateDocker", func() {
 						GenerateOpts: &cmd.GenerateOpts{
 							GlobalOptions: cmd.GlobalOptions{
 								Env:         mockEnv,
-								WorkspaceId: &flagWsId,
+								WorkspaceId: flagWsId,
 							},
 						},
 						BaseImage: "alpine:latest",
diff --git a/cli/cmd/generate_images_test.go b/cli/cmd/generate_images_test.go
@@ -42,7 +42,7 @@ var _ = Describe("GenerateImages", func() {
 				GenerateOpts: &cmd.GenerateOpts{
 					GlobalOptions: cmd.GlobalOptions{
 						Env:         mockEnv,
-						WorkspaceId: &wsId,
+						WorkspaceId: wsId,
 					},
 					Input:  defaultInput,
 					Output: defaultOutput,
diff --git a/cli/cmd/generate_kubernetes_test.go b/cli/cmd/generate_kubernetes_test.go
@@ -40,7 +40,7 @@ var _ = Describe("GenerateKubernetes", func() {
 				GenerateOpts: &cmd.GenerateOpts{
 					GlobalOptions: cmd.GlobalOptions{
 						Env:         mockEnv,
-						WorkspaceId: &wsId,
+						WorkspaceId: wsId,
 					},
 					Input:  defaultInput,
 					Output: defaultOutput,
diff --git a/cli/cmd/list_workspaces.go b/cli/cmd/list_workspaces.go
@@ -5,6 +5,7 @@ package cmd
 
 import (
 	"fmt"
+	"log"
 
 	"github.com/codesphere-cloud/cs-go/api"
 	"github.com/codesphere-cloud/cs-go/pkg/io"
@@ -80,14 +81,9 @@ func (l *ListWorkspacesCmd) ListWorkspaces(client Client) ([]api.Workspace, erro
 }
 
 func (l *ListWorkspacesCmd) getTeamIds(client Client) (teams []int, err error) {
-	if l.Opts.TeamId != nil && *l.Opts.TeamId >= 0 {
-		teams = append(teams, *l.Opts.TeamId)
-		return
-	}
-	teamIdEnv, err := l.Opts.Env.GetTeamId()
+	teamIdEnv, err := l.Opts.GetTeamId()
 	if err != nil {
-		err = fmt.Errorf("failed to get team ID from env: %w", err)
-		return
+		log.Println("No team ID provided via flag or environment variable, listing workspaces of all teams")
 	}
 	if teamIdEnv >= 0 {
 		teams = append(teams, teamIdEnv)
diff --git a/cli/cmd/list_workspaces_test.go b/cli/cmd/list_workspaces_test.go
@@ -15,54 +15,54 @@ var _ = Describe("Workspace", func() {
 	var (
 		mockEnv    *cmd.MockEnv
 		mockClient *cmd.MockClient
+		l          cmd.ListWorkspacesCmd
+		teamId     int
 	)
 
 	BeforeEach(func() {
 		mockEnv = cmd.NewMockEnv(GinkgoT())
 		mockClient = cmd.NewMockClient(GinkgoT())
+		teamId = -1
+		l = cmd.ListWorkspacesCmd{
+			Opts: cmd.GlobalOptions{
+				Env:    mockEnv,
+				TeamId: -1, // force using the env mock to get a team ID
+			},
+		}
 	})
 
-	It("lists workspaces of single team", func() {
-		l := newListWorkspacesCmdWithTeam(mockEnv, 0)
-		mockClient.EXPECT().ListWorkspaces(0).Return([]api.Workspace{}, nil)
-
-		w, err := l.ListWorkspaces(mockClient)
-		Expect(w).To(Equal([]api.Workspace{}))
-		Expect(err).NotTo(HaveOccurred())
+	JustBeforeEach(func() {
+		mockEnv.EXPECT().GetTeamId().Return(teamId, nil)
 	})
 
-	It("lists workspaces of all teams when no team ID is set", func() {
-		mockEnv := cmd.NewMockEnv(GinkgoT())
-		l := newListWorkspacesCmd(mockEnv)
-		mockEnv.EXPECT().GetTeamId().Return(-1, nil)
-		mockClient.EXPECT().ListTeams().Return([]api.Team{{Id: 0}, {Id: 1}}, nil)
+	Context("when team ID is set", func() {
+		BeforeEach(func() {
+			teamId = 0
+		})
 
-		expectedWorkspaces := []api.Workspace{
-			{Id: 0, Name: "fakeForTeam0"},
-			{Id: 1, Name: "fakeForTeam1"},
-		}
-		mockClient.EXPECT().ListWorkspaces(0).Return([]api.Workspace{expectedWorkspaces[0]}, nil)
-		mockClient.EXPECT().ListWorkspaces(1).Return([]api.Workspace{expectedWorkspaces[1]}, nil)
+		It("lists workspaces of single team", func() {
+			mockClient.EXPECT().ListWorkspaces(0).Return([]api.Workspace{}, nil)
 
-		w, err := l.ListWorkspaces(mockClient)
-		Expect(w).To(Equal(expectedWorkspaces))
-		Expect(err).NotTo(HaveOccurred())
+			w, err := l.ListWorkspaces(mockClient)
+			Expect(w).To(Equal([]api.Workspace{}))
+			Expect(err).NotTo(HaveOccurred())
+		})
 	})
-})
 
-func newListWorkspacesCmdWithTeam(mockEnv *cmd.MockEnv, teamId int) cmd.ListWorkspacesCmd {
-	return cmd.ListWorkspacesCmd{
-		Opts: cmd.GlobalOptions{
-			TeamId: &teamId,
-			Env:    mockEnv,
-		},
-	}
-}
+	Context("when team ID is not set", func() {
+		It("lists workspaces of all teams when no team ID is set", func() {
+			mockClient.EXPECT().ListTeams().Return([]api.Team{{Id: 0}, {Id: 1}}, nil)
 
-func newListWorkspacesCmd(mockEnv *cmd.MockEnv) cmd.ListWorkspacesCmd {
-	return cmd.ListWorkspacesCmd{
-		Opts: cmd.GlobalOptions{
-			Env: mockEnv,
-		},
-	}
-}
+			expectedWorkspaces := []api.Workspace{
+				{Id: 0, Name: "fakeForTeam0"},
+				{Id: 1, Name: "fakeForTeam1"},
+			}
+			mockClient.EXPECT().ListWorkspaces(0).Return([]api.Workspace{expectedWorkspaces[0]}, nil)
+			mockClient.EXPECT().ListWorkspaces(1).Return([]api.Workspace{expectedWorkspaces[1]}, nil)
+
+			w, err := l.ListWorkspaces(mockClient)
+			Expect(w).To(Equal(expectedWorkspaces))
+			Expect(err).NotTo(HaveOccurred())
+		})
+	})
+})
diff --git a/cli/cmd/open_workspace_test.go b/cli/cmd/open_workspace_test.go
@@ -5,6 +5,7 @@ package cmd_test
 
 import (
 	"fmt"
+
 	. "github.com/onsi/ginkgo/v2"
 	. "github.com/onsi/gomega"
 
@@ -31,7 +32,7 @@ var _ = Describe("GenerateWorkspacePath", func() {
 		o = &cmd.OpenWorkspaceCmd{
 			Opts: cmd.GlobalOptions{
 				Env:         mockEnv,
-				WorkspaceId: &wsId,
+				WorkspaceId: wsId,
 			},
 		}
 	})
diff --git a/cli/cmd/root.go b/cli/cmd/root.go
@@ -12,11 +12,11 @@ import (
 )
 
 type GlobalOptions struct {
-	ApiUrl      *string
-	TeamId      *int
-	WorkspaceId *int
+	ApiUrl      string
+	TeamId      int
+	WorkspaceId int
 	Env         Env
-	Verbose     *bool
+	Verbose     bool
 }
 
 type Env interface {
@@ -27,15 +27,15 @@ type Env interface {
 }
 
 func (o GlobalOptions) GetApiUrl() string {
-	if o.ApiUrl != nil && *o.ApiUrl != "" {
-		return *o.ApiUrl
+	if o.ApiUrl != "" {
+		return o.ApiUrl
 	}
 	return o.Env.GetApiUrl()
 }
 
 func (o GlobalOptions) GetTeamId() (int, error) {
-	if o.TeamId != nil && *o.TeamId != -1 {
-		return *o.TeamId, nil
+	if o.TeamId != -1 {
+		return o.TeamId, nil
 	}
 	wsId, err := o.Env.GetTeamId()
 	if err != nil {
@@ -48,8 +48,8 @@ func (o GlobalOptions) GetTeamId() (int, error) {
 }
 
 func (o GlobalOptions) GetWorkspaceId() (int, error) {
-	if o.WorkspaceId != nil && *o.WorkspaceId != -1 {
-		return *o.WorkspaceId, nil
+	if o.WorkspaceId != -1 {
+		return o.WorkspaceId, nil
 	}
 	wsId, err := o.Env.GetWorkspaceId()
 	if err != nil {
@@ -71,10 +71,10 @@ func GetRootCmd() *cobra.Command {
 
 	opts := GlobalOptions{Env: cs.NewEnv()}
 
-	opts.ApiUrl = rootCmd.PersistentFlags().StringP("api", "a", "", "URL of Codesphere API (can also be CS_API)")
-	opts.TeamId = rootCmd.PersistentFlags().IntP("team", "t", -1, "Team ID (relevant for some commands, can also be CS_TEAM_ID)")
-	opts.WorkspaceId = rootCmd.PersistentFlags().IntP("workspace", "w", -1, "Workspace ID (relevant for some commands, can also be CS_WORKSPACE_ID)")
-	opts.Verbose = rootCmd.PersistentFlags().BoolP("verbose", "v", false, "Verbose output")
+	rootCmd.PersistentFlags().StringVarP(&opts.ApiUrl, "api", "a", "", "URL of Codesphere API (can also be CS_API)")
+	rootCmd.PersistentFlags().IntVarP(&opts.TeamId, "team", "t", -1, "Team ID (relevant for some commands, can also be CS_TEAM_ID)")
+	rootCmd.PersistentFlags().IntVarP(&opts.WorkspaceId, "workspace", "w", -1, "Workspace ID (relevant for some commands, can also be CS_WORKSPACE_ID)")
+	rootCmd.PersistentFlags().BoolVarP(&opts.Verbose, "verbose", "v", false, "Verbose output")
 
 	AddExecCmd(rootCmd, opts)
 	AddLogCmd(rootCmd, opts)
diff --git a/cli/cmd/set_env_vars_test.go b/cli/cmd/set_env_vars_test.go
@@ -27,7 +27,7 @@ var _ = Describe("SetEnvVars", func() {
 			Opts: cmd.SetEnvVarOptions{
 				GlobalOptions: cmd.GlobalOptions{
 					Env:         mockEnv,
-					WorkspaceId: &wsId,
+					WorkspaceId: wsId,
 				},
 				EnvVar: &envVars,
 			},
diff --git a/cli/cmd/start_pipeline.go b/cli/cmd/start_pipeline.go
@@ -164,9 +164,9 @@ func allRunning(status []api.PipelineStatus) bool {
 }
 
 func (c *StartPipelineCmd) allFinished(status []api.PipelineStatus) bool {
-	io.Verboseln(*c.Opts.Verbose, "====")
+	io.Verboseln(c.Opts.Verbose, "====")
 	for _, s := range status {
-		io.Verbosef(*c.Opts.Verbose, "Server: %s, State: %s, Replica: %s\n", s.Server, s.State, s.Replica)
+		io.Verbosef(c.Opts.Verbose, "Server: %s, State: %s, Replica: %s\n", s.Server, s.State, s.Replica)
 	}
 	for _, s := range status {
 		// Prepare and Test stage is only running in the IDE server, ignore customer servers
diff --git a/cli/cmd/start_pipeline_test.go b/cli/cmd/start_pipeline_test.go
@@ -39,8 +39,8 @@ var _ = Describe("StartPipeline", func() {
 		c = &cmd.StartPipelineCmd{
 			Opts: cmd.StartPipelineOpts{
 				GlobalOptions: cmd.GlobalOptions{
-					WorkspaceId: &wsId,
-					Verbose:     &verbose,
+					WorkspaceId: wsId,
+					Verbose:     verbose,
 				},
 				Profile: &profile,
 				Timeout: &timeout,
diff --git a/cli/cmd/wakeup_test.go b/cli/cmd/wakeup_test.go
@@ -33,7 +33,7 @@ var _ = Describe("WakeUp", func() {
 			Opts: cmd.WakeUpOptions{
 				GlobalOptions: cmd.GlobalOptions{
 					Env:         mockEnv,
-					WorkspaceId: &wsId,
+					WorkspaceId: wsId,
 				},
 				Timeout: 120 * time.Second,
 			},

Original file line number	Diff line number	Diff line change
`@@ -51,6 +51,7 @@ func NewClient(opts GlobalOptions) (Client, error) {`
`51`	`51`	`client := api.NewClient(context.Background(), api.Configuration{`
`52`	`52`	`BaseUrl: apiUrl,`
`53`	`53`	`Token: token,`
	`54`	`+ Verbose: opts.Verbose,`
`54`	`55`	`})`
`55`	`56`	`return client, nil`
`56`	`57`	`}`