add fake time utility

Author: NautiluX

Makefile

@@ -10,7 +10,7 @@ lint: install-build-deps
 	golangci-lint run
 
 test:
-	go test ./...
+	go test ./... -count=1
 
 generate:
 	go generate ./...

api/workspace.go

@@ -46,15 +46,8 @@ func (c *Client) SetEnvVarOnWorkspace(workspaceId int, envVars map[string]string
 // Waits for a given workspace to be running.
 //
 // Returns [TimedOut] error if the workspace does not become running in time.
-func (client *Client) WaitForWorkspaceRunning(workspace *Workspace, opts WaitForWorkspaceRunningOptions) error {
-	timeout := opts.Timeout
-	if timeout == 0 {
-		timeout = 20 * time.Minute
-	}
-	delay := opts.Delay
-	if delay == 0 {
-		delay = 5 * time.Second
-	}
+func (client *Client) WaitForWorkspaceRunning(workspace *Workspace, timeout time.Duration) error {
+	delay := 5 * time.Second
 
 	maxWaitTime := time.Now().Add(timeout)
 	for {
@@ -83,15 +76,15 @@ type DeployWorkspaceArgs struct {
 	PlanId        int
 	Name          string
 	EnvVars       map[string]string
-	VpnConfigName *string
+	VpnConfigName string
 
 	Timeout time.Duration
 }
 
 // Deploys a workspace with the given configuration.
 //
 // Returns [TimedOut] error if the timeout is reached
-func (client Client) DeployWorkspace(args DeployWorkspaceArgs) error {
+func (client Client) DeployWorkspace(args DeployWorkspaceArgs) (*Workspace, error) {
 	workspace, err := client.CreateWorkspace(CreateWorkspaceArgs{
 		TeamId:            args.TeamId,
 		Name:              args.Name,
@@ -102,19 +95,19 @@ func (client Client) DeployWorkspace(args DeployWorkspaceArgs) error {
 		SourceWorkspaceId: nil,
 		WelcomeMessage:    nil,
 		Replicas:          1,
-		VpnConfig:         args.VpnConfigName,
+		VpnConfig:         &args.VpnConfigName,
 	})
 	if err != nil {
-		return err
+		return nil, err
 	}
-	if err := client.WaitForWorkspaceRunning(workspace, WaitForWorkspaceRunningOptions{Timeout: args.Timeout}); err != nil {
-		return err
+	if err := client.WaitForWorkspaceRunning(workspace, args.Timeout); err != nil {
+		return workspace, err
 	}
 
 	if len(args.EnvVars) != 0 {
 		if err := client.SetEnvVarOnWorkspace(workspace.Id, args.EnvVars); err != nil {
-			return err
+			return workspace, err
 		}
 	}
-	return nil
+	return workspace, nil
 }

api/workspace_test.go

@@ -1,14 +1,14 @@
 package api_test
 
 import (
+	"context"
 	"testing"
 	"time"
 
-	"context"
-
 	"github.com/codesphere-cloud/cs-go/api"
 	"github.com/codesphere-cloud/cs-go/api/errors"
 	"github.com/codesphere-cloud/cs-go/api/openapi_client"
+	tu "github.com/codesphere-cloud/cs-go/pkg/testutils"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/mock"
 )
@@ -18,9 +18,27 @@ func getTestingClient(t *testing.T) (*api.Client, *openapi_client.MockWorkspaces
 	apis := openapi_client.APIClient{
 		WorkspacesAPI: wsApiMock,
 	}
+	tu.PatchTimeFuncs(t)
 	return api.NewClientWithCustomApi(context.TODO(), api.Configuration{}, &apis), wsApiMock
 }
 
+func mockWorkspaceStatus(wsApiMock *openapi_client.MockWorkspacesAPI, workspaceId int, isRunning ...bool) {
+	wsApiMock.EXPECT().WorkspacesGetWorkspaceStatus(mock.Anything, float32(workspaceId)).
+		Return(openapi_client.ApiWorkspacesGetWorkspaceStatusRequest{ApiService: wsApiMock})
+	for _, running := range isRunning {
+		wsApiMock.EXPECT().WorkspacesGetWorkspaceStatusExecute(mock.Anything).Once().Return(&api.WorkspaceStatus{
+			IsRunning: running,
+		}, nil, nil)
+	}
+	mock.InOrder(wsApiMock.ExpectedCalls...)
+}
+
+func mockCreateWorkspace(wsApiMock *openapi_client.MockWorkspacesAPI, ws api.Workspace) {
+	wsApiMock.EXPECT().WorkspacesCreateWorkspace(mock.Anything).
+		Return(openapi_client.ApiWorkspacesCreateWorkspaceRequest{ApiService: wsApiMock})
+	wsApiMock.EXPECT().WorkspacesCreateWorkspaceExecute(mock.Anything).Return(&ws, nil, nil)
+}
+
 func TestListWorkspaces(t *testing.T) {
 	client, wsApiMock := getTestingClient(t)
 
@@ -45,16 +63,9 @@ func TestWaitForWorkspaceRunningSuccess(t *testing.T) {
 		Id: 0, Name: "fakeWorkspace",
 	}
 
-	wsApiMock.EXPECT().WorkspacesGetWorkspaceStatus(mock.Anything, float32(0)).
-		Return(openapi_client.ApiWorkspacesGetWorkspaceStatusRequest{ApiService: wsApiMock})
-	wsApiMock.EXPECT().WorkspacesGetWorkspaceStatusExecute(mock.Anything).Return(&api.WorkspaceStatus{
-		IsRunning: true,
-	}, nil, nil)
+	mockWorkspaceStatus(wsApiMock, ws.Id, true)
 
-	err := client.WaitForWorkspaceRunning(
-		&ws,
-		api.WaitForWorkspaceRunningOptions{Timeout: 1 * time.Millisecond, Delay: 1 * time.Millisecond},
-	)
+	err := client.WaitForWorkspaceRunning(&ws, 1*time.Millisecond)
 
 	assert.Nil(t, err, "should be nil")
 }
@@ -66,16 +77,9 @@ func TestWaitForWorkspaceRunningTimeout(t *testing.T) {
 		Id: 0, Name: "fakeWorkspace",
 	}
 
-	wsApiMock.EXPECT().WorkspacesGetWorkspaceStatus(mock.Anything, float32(0)).
-		Return(openapi_client.ApiWorkspacesGetWorkspaceStatusRequest{ApiService: wsApiMock})
-	wsApiMock.EXPECT().WorkspacesGetWorkspaceStatusExecute(mock.Anything).Return(&api.WorkspaceStatus{
-		IsRunning: false,
-	}, nil, nil)
+	mockWorkspaceStatus(wsApiMock, ws.Id, false, false)
 
-	err := client.WaitForWorkspaceRunning(
-		&ws,
-		api.WaitForWorkspaceRunningOptions{Timeout: 1 * time.Millisecond, Delay: 1 * time.Millisecond},
-	)
+	err := client.WaitForWorkspaceRunning(&ws, 1*time.Second)
 
 	assert.IsType(t, err, &errors.TimedOutError{}, "expected timeout error")
 }
@@ -87,19 +91,8 @@ func TestWaitForWorkspaceRunningOnRetry(t *testing.T) {
 		Id: 42, Name: "fakeWorkspace",
 	}
 
-	wsApiMock.EXPECT().WorkspacesGetWorkspaceStatus(mock.Anything, float32(42)).
-		Return(openapi_client.ApiWorkspacesGetWorkspaceStatusRequest{ApiService: wsApiMock})
-	wsApiMock.EXPECT().WorkspacesGetWorkspaceStatusExecute(mock.Anything).Return(&api.WorkspaceStatus{
-		IsRunning: false,
-	}, nil, nil).Once()
-	wsApiMock.EXPECT().WorkspacesGetWorkspaceStatusExecute(mock.Anything).Return(&api.WorkspaceStatus{
-		IsRunning: true,
-	}, nil, nil).Once()
-
-	err := client.WaitForWorkspaceRunning(
-		&ws,
-		api.WaitForWorkspaceRunningOptions{Timeout: 10 * time.Millisecond, Delay: 1 * time.Millisecond},
-	)
+	mockWorkspaceStatus(wsApiMock, ws.Id, false, true)
+	err := client.WaitForWorkspaceRunning(&ws, 1*time.Millisecond)
 
 	assert.Nil(t, err, "should be nil")
 }
@@ -115,17 +108,14 @@ func TestDeployWorkspace(t *testing.T) {
 		Return(openapi_client.ApiWorkspacesCreateWorkspaceRequest{ApiService: wsApiMock})
 	wsApiMock.EXPECT().WorkspacesCreateWorkspaceExecute(mock.Anything).Return(&ws, nil, nil)
 
-	wsApiMock.EXPECT().WorkspacesGetWorkspaceStatus(mock.Anything, float32(42)).
-		Return(openapi_client.ApiWorkspacesGetWorkspaceStatusRequest{ApiService: wsApiMock})
-	wsApiMock.EXPECT().WorkspacesGetWorkspaceStatusExecute(mock.Anything).Return(&api.WorkspaceStatus{
-		IsRunning: true,
-	}, nil, nil)
+	mockWorkspaceStatus(wsApiMock, ws.Id, true)
 
-	err := client.DeployWorkspace(
+	newWs, err := client.DeployWorkspace(
 		api.DeployWorkspaceArgs{Timeout: 1 * time.Millisecond},
 	)
 
 	assert.Nil(t, err, "should be nil")
+	assert.Equal(t, newWs.Name, ws.Name, "Should have the same name")
 }
 
 func TestDeployWorkspaceWithEnvVars(t *testing.T) {
@@ -142,21 +132,15 @@ func TestDeployWorkspaceWithEnvVars(t *testing.T) {
 		},
 	}
 
-	wsApiMock.EXPECT().WorkspacesCreateWorkspace(mock.Anything).
-		Return(openapi_client.ApiWorkspacesCreateWorkspaceRequest{ApiService: wsApiMock})
-	wsApiMock.EXPECT().WorkspacesCreateWorkspaceExecute(mock.Anything).Return(&ws, nil, nil)
-
-	wsApiMock.EXPECT().WorkspacesGetWorkspaceStatus(mock.Anything, float32(42)).
-		Return(openapi_client.ApiWorkspacesGetWorkspaceStatusRequest{ApiService: wsApiMock})
-	wsApiMock.EXPECT().WorkspacesGetWorkspaceStatusExecute(mock.Anything).Return(&api.WorkspaceStatus{
-		IsRunning: true,
-	}, nil, nil)
+	mockCreateWorkspace(wsApiMock, ws)
+	mockWorkspaceStatus(wsApiMock, ws.Id, true)
 
 	wsApiMock.EXPECT().WorkspacesSetEnvVar(mock.Anything, float32(42)).
 		Return(openapi_client.ApiWorkspacesSetEnvVarRequest{ApiService: wsApiMock})
 	wsApiMock.EXPECT().WorkspacesSetEnvVarExecute(mock.Anything).Return(nil, nil).Once()
 
-	err := client.DeployWorkspace(args)
+	newWs, err := client.DeployWorkspace(args)
 
 	assert.Nil(t, err, "should be nil")
+	assert.Equal(t, newWs.Name, ws.Name, "Should have the same name")
 }

go.mod

@@ -3,6 +3,7 @@ module github.com/codesphere-cloud/cs-go
 go 1.24.2
 
 require (
+	github.com/agiledragon/gomonkey/v2 v2.13.0
 	github.com/jedib0t/go-pretty/v6 v6.6.7
 	github.com/spf13/cobra v1.9.1
 	github.com/stretchr/testify v1.10.0

go.sum

@@ -1,11 +1,15 @@
+github.com/agiledragon/gomonkey/v2 v2.13.0 h1:B24Jg6wBI1iB8EFR1c+/aoTg7QN/Cum7YffG8KMIyYo=
+github.com/agiledragon/gomonkey/v2 v2.13.0/go.mod h1:ap1AmDzcVOAz1YpeJ3TCzIgstoaWLA6jbbgxfB4w2iY=
 github.com/cpuguy83/go-md2man/v2 v2.0.6/go.mod h1:oOW0eioCTA6cOiMLiUPZOpcVxMig6NIQQ7OS05n1F4g=
 github.com/creack/pty v1.1.9/go.mod h1:oKZEueFk5CKHvIhNR5MUki03XCEU+Q6VDXinZuGJ33E=
 github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/gopherjs/gopherjs v0.0.0-20181017120253-0766667cb4d1/go.mod h1:wJfORRmW1u3UXTncJ5qlYoELFm8eSnnEO6hX4iZ3EWY=
 github.com/inconshreveable/mousetrap v1.1.0 h1:wN+x4NVGpMsO7ErUn/mUI3vEoE6Jt13X2s0bqwp9tc8=
 github.com/inconshreveable/mousetrap v1.1.0/go.mod h1:vpF70FUmC8bwa3OWnCshd2FqLfsEA9PFc4w1p2J65bw=
 github.com/jedib0t/go-pretty/v6 v6.6.7 h1:m+LbHpm0aIAPLzLbMfn8dc3Ht8MW7lsSO4MPItz/Uuo=
 github.com/jedib0t/go-pretty/v6 v6.6.7/go.mod h1:YwC5CE4fJ1HFUDeivSV1r//AmANFHyqczZk+U6BDALU=
+github.com/jtolds/gls v4.20.0+incompatible/go.mod h1:QJZ7F/aHp+rZTRtaJ1ow/lLfFfVYBRgL+9YlvaHOwJU=
 github.com/kr/pretty v0.2.1 h1:Fmg33tUaq4/8ym9TJN1x7sLJnHVwhP33CNkpYV/7rwI=
 github.com/kr/pretty v0.2.1/go.mod h1:ipq/a2n7PKx3OHsz4KJII5eveXtPO4qwEXGdVfWzfnI=
 github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY=
@@ -18,6 +22,8 @@ github.com/rivo/uniseg v0.2.0/go.mod h1:J6wj4VEh+S6ZtnVlnTBMWIodfgj8LQOQFoIToxlJ
 github.com/rivo/uniseg v0.4.7 h1:WUdvkW8uEhrYfLC4ZzdpI2ztxP1I582+49Oc5Mq64VQ=
 github.com/rivo/uniseg v0.4.7/go.mod h1:FN3SvrM+Zdj16jyLfmOkMNblXMcoc8DfTHruCPUcx88=
 github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
+github.com/smartystreets/assertions v0.0.0-20180927180507-b2de0cb4f26d/go.mod h1:OnSkiWE9lh6wB0YB77sQom3nweQdgAjqCqsofrRNTgc=
+github.com/smartystreets/goconvey v1.6.4/go.mod h1:syvi0/a8iFYH4r/RixwvyeAJjdLS9QV7WQ/tjFTllLA=
 github.com/spf13/cobra v1.9.1 h1:CXSaggrXdbHK9CF+8ywj8Amf7PBRmPCOJugH954Nnlo=
 github.com/spf13/cobra v1.9.1/go.mod h1:nDyEzZ8ogv936Cinf6g1RU9MRY64Ir93oCnqb9wxYW0=
 github.com/spf13/pflag v1.0.6 h1:jFzHGLGAlb3ruxLB8MhbI6A8+AQX/2eW4qeyNZXNp2o=
@@ -26,10 +32,15 @@ github.com/stretchr/objx v0.5.2 h1:xuMeJ0Sdp5ZMRXx/aWO6RZxdr3beISkG5/G/aIRr3pY=
 github.com/stretchr/objx v0.5.2/go.mod h1:FRsXN1f5AsAjCGJKqEizvkpNtU+EGNCLh3NxZ/8L+MA=
 github.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA=
 github.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
+golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
+golang.org/x/net v0.0.0-20190311183353-d8887717615a/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
+golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
 golang.org/x/sys v0.30.0 h1:QjkSwP/36a20jFYWkSue1YwXzLmsV5Gfq7Eiy72C1uc=
 golang.org/x/sys v0.30.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
+golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
 golang.org/x/text v0.22.0 h1:bofq7m3/HAFvbF51jz3Q9wLg3jkvSPuiZu/pD1XwgtM=
 golang.org/x/text v0.22.0/go.mod h1:YRoo4H8PVmsu+E3Ou7cqLVH8oXWIHVoX0jqUWALQhfY=
+golang.org/x/tools v0.0.0-20190328211700-ab21143f2384/go.mod h1:LCzVGOaR6xXOjkQ3onu1FJEFr0SW1gC7cKk1uF8kGRs=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c h1:Hei/4ADfdWqJk1ZMxUNpqntNwaWcugrBjAiHlqqRiVk=
 gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c/go.mod h1:JHkPIbrfpd72SG/EVd6muEfDQjcINNoR0C8j2r3qZ4Q=

pkg/testutils/time.go

@@ -0,0 +1,67 @@
+package testutils
+
+import (
+	"github.com/agiledragon/gomonkey/v2"
+	"regexp"
+	"runtime"
+	"strings"
+	"sync"
+	"testing"
+	"time"
+)
+
+type TestTimer struct {
+	Timestamp map[string]time.Time
+	Patches   gomonkey.Patches
+	mu        sync.Mutex
+}
+
+func (t *TestTimer) GetTestFunc() string {
+	for i := range 100 {
+		pc, _, _, _ := runtime.Caller(i)
+		fn := runtime.FuncForPC(pc)
+		if fn == nil {
+			break
+		}
+		name := fn.Name()
+		re := regexp.MustCompile(`^.*\.`)
+		name = re.ReplaceAllString(name, "")
+
+		if strings.HasPrefix(name, "Test") {
+			return name
+		}
+	}
+	return "main"
+}
+
+func (t *TestTimer) Now() time.Time {
+	t.mu.Lock()
+	defer t.mu.Unlock()
+	return t.Timestamp[t.GetTestFunc()]
+}
+
+func (t *TestTimer) Sleep(delay time.Duration) {
+	t.mu.Lock()
+	f := t.GetTestFunc()
+	t.Timestamp[f] = t.Timestamp[f].Add(delay)
+	time.Tick(1 * time.Millisecond)
+	t.mu.Unlock()
+}
+
+func (t *TestTimer) Patch() {
+	patches := gomonkey.ApplyFunc(time.Now, t.Now)
+	patches.ApplyFunc(time.Sleep, t.Sleep)
+}
+
+var testTimer TestTimer
+
+func PatchTimeFuncs(t *testing.T) {
+	testTimer.mu.Lock()
+	if testTimer.Timestamp == nil {
+		testTimer.Timestamp = map[string]time.Time{}
+	}
+	testTimer.Timestamp[testTimer.GetTestFunc()] = time.Unix(1745900000, 0)
+	testTimer.mu.Unlock()
+	testTimer.Patch()
+	t.Cleanup(testTimer.Patches.Reset)
+}