8000 Standardize test structure for codersdk · coder/coder@e202b2d · GitHub
[go: up one dir, main page]
Skip to content

Commit e202b2d

Browse files
kylecarbskylecarbs
committed
Standardize test structure for codersdk
1 parent c50cee0 commit e202b2d

10 files changed

+451
-288
lines changed

‎coderd/coderd.go

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,6 @@ func New(options *Options) http.Handler {
8686
r.Get("/", api.workspaces)
8787
r.Route("/{user}", func(r chi.Router) {
8888
r.Use(httpmw.ExtractUserParam(options.Database))
89-
r.Get("/", api.workspaces)
9089
r.Post("/", api.postWorkspaceByUser)
9190
r.Route("/{workspace}", func(r chi.Router) {
9291
r.Use(httpmw.ExtractWorkspaceParam(options.Database))

‎coderd/provisionerdaemons.go

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,15 +36,16 @@ func (api *api) provisionerDaemons(rw http.ResponseWriter, r *http.Request) {
3636
daemons, err := api.Database.GetProvisionerDaemons(r.Context())
3737
if errors.Is(err, sql.ErrNoRows) {
3838
err = nil
39-
daemons = []database.ProvisionerDaemon{}
4039
}
4140
if err != nil {
4241
httpapi.Write(rw, http.StatusInternalServerError, httpapi.Response{
4342
Message: fmt.Sprintf("get provisioner daemons: %s", err),
4443
})
4544
return
4645
}
47-
46+
if daemons == nil {
47+
daemons = []database.ProvisionerDaemon{}
48+
}
4849
render.Status(r, http.StatusOK)
4950
render.JSON(rw, r, daemons)
5051
}

‎coderd/provisionerdaemons_test.go

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -11,16 +11,18 @@ import (
1111
)
1212

1313
func TestProvisionerDaemons(t *testing.T) {
14+
// Tests for properly processing specific job
15+
// types should be placed in their respective
16+
// resource location.
17+
//
18+
// eg. project import is a project-related job
1419
t.Parallel()
1520

16-
t.Run("Register", func(t *testing.T) {
17-
t.Parallel()
18-
client := coderdtest.New(t)
19-
_ = coderdtest.NewProvisionerDaemon(t, client)
20-
require.Eventually(t, func() bool {
21-
daemons, err := client.ProvisionerDaemons(context.Background())
22-
require.NoError(t, err)
23-
return len(daemons) > 0
24-
}, time.Second, 10*time.Millisecond)
25-
})
21+
client := coderdtest.New(t)
22+
_ = coderdtest.NewProvisionerDaemon(t, client)
23+
require.Eventually(t, func() bool {
24+
daemons, err := client.ProvisionerDaemons(context.Background())
25+
require.NoError(t, err)
26+
return len(daemons) > 0
27+
}, time.Second, 25*time.Millisecond)
2628
}

‎coderd/workspaces.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ func (api *api) postWorkspaceByUser(rw http.ResponseWriter, r *http.Request) {
137137
render.JSON(rw, r, convertWorkspace(workspace))
138138
}
139139

140-
// Returns a single singleWorkspace.
140+
// Returns a single single workspace.
141141
func (*api) workspaceByUser(rw http.ResponseWriter, r *http.Request) {
142142
workspace := httpmw.WorkspaceParam(r)
143143

‎coderd/workspaces_test.go

Lines changed: 74 additions & 81 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ package coderd_test
22

33
import (
44
"context"
5+
"net/http"
56
"testing"
67

78
"github.com/google/uuid"
@@ -10,143 +11,135 @@ import (
1011
"github.com/coder/coder/coderd"
1112
"github.com/coder/coder/coderd/coderdtest"
1213
"github.com/coder/coder/codersdk"
13-
"github.com/coder/coder/database"
1414
)
1515

1616
func TestWorkspaces(t *testing.T) {
1717
t.Parallel()
18-
1918
t.Run("ListNone", func(t *testing.T) {
2019
t.Parallel()
2120
client := coderdtest.New(t)
2221
_ = coderdtest.CreateInitialUser(t, client)
23-
workspaces, err := client.WorkspacesByUser(context.Background(), "")
22+
workspaces, err := client.Workspaces(context.Background(), "")
2423
require.NoError(t, err)
24+
require.NotNil(t, workspaces)
2525
require.Len(t, workspaces, 0)
2626
})
2727

28-
setupProjectAndWorkspace := func(t *testing.T, client *codersdk.Client, user coderd.CreateInitialUserRequest) (coderd.Project, coderd.Workspace) {
29-
project, err := client.CreateProject(context.Background(), user.Organization, coderd.CreateProjectRequest{
30-
Name: "banana",
31-
Provisioner: database.ProvisionerTypeEcho,
32-
})
33-
require.NoError(t, err)
34-
workspace, err := client.CreateWorkspace(context.Background(), "", coderd.CreateWorkspaceRequest{
35-
Name: "example",
36-
ProjectID: project.ID,
37-
})
38-
require.NoError(t, err)
39-
return project, workspace
40-
}
41-
4228
t.Run("List", func(t *testing.T) {
4329
t.Parallel()
4430
client := coderdtest.New(t)
4531
user := coderdtest.CreateInitialUser(t, client)
46-
_, _ = setupProjectAndWorkspace(t, client, user)
47-
workspaces, err := client.WorkspacesByUser(context.Background(), "")
32+
project := coderdtest.CreateProject(t, client, user.Organization)
33+
_ = coderdtest.CreateWorkspace(t, client, "", project.ID)
34+
workspaces, err := client.Workspaces(context.Background(), "")
4835
require.NoError(t, err)
4936
require.Len(t, workspaces, 1)
5037
})
38+
}
5139

52-
t.Run("ListNoneForProject", func(t *testing.T) {
40+
func TestPostWorkspaceByUser(t *testing.T) {
41+
t.Parallel()
42+
t.Run("InvalidProject", func(t *testing.T) {
5343
t.Parallel()
5444
client := coderdtest.New(t)
55-
user := coderdtest.CreateInitialUser(t, client)
56-
project, err := client.CreateProject(context.Background(), user.Organization, coderd.CreateProjectRequest{
57-
Name: "banana",
58-
Provisioner: database.ProvisionerTypeEcho,
45+
_ = coderdtest.CreateInitialUser(t, client)
46+
_, err := client.CreateWorkspace(context.Background(), "", coderd.CreateWorkspaceRequest{
47+
ProjectID: uuid.New(),
48+
Name: "workspace",
5949
})
60-
require.NoError(t, err)
61-
workspaces, err := client.WorkspacesByProject(context.Background(), user.Organization, project.Name)
62-
require.NoError(t, err)
63-
require.Len(t, workspaces, 0)
50+
require.Error(t, err)
51+
var apiErr *codersdk.Error
52+
require.ErrorAs(t, err, &apiErr)
53+
require.Equal(t, http.StatusBadRequest, apiErr.StatusCode())
6454
})
6555

66-
t.Run("ListForProject", func(t *testing.T) {
56+
t.Run("NoProjectAccess", func(t *testing.T) {
6757
t.Parallel()
6858
client := coderdtest.New(t)
6959
user := coderdtest.CreateInitialUser(t, client)
70-
project, _ := setupProjectAndWorkspace(t, client, user)
71-
workspaces, err := client.WorkspacesByProject(context.Background(), user.Organization, project.Name)
72-
require.NoError(t, err)
73-
require.Len(t, workspaces, 1)
74-
})
60+
project := coderdtest.CreateProject(t, client, user.Organization)
7561

76-
t.Run("CreateInvalidInput", func(t *testing.T) {
77-
t.Parallel()
78-
client := coderdtest.New(t)
79-
user := coderdtest.CreateInitialUser(t, client)
80-
project, err := client.CreateProject(context.Background(), user.Organization, coderd.CreateProjectRequest{
81-
Name: "banana",
82-
Provisioner: database.ProvisionerTypeEcho,
62+
anotherUser := coderd.CreateUserRequest{
63+
Email: "another@user.org",
64+
Username: "someuser",
65+
Password: "somepass",
66+
}
67+
_, err := client.CreateUser(context.Background(), anotherUser)
68+
require.NoError(t, err)
69+
token, err := client.LoginWithPassword(context.Background(), coderd.LoginWithPasswordRequest{
70+
Email: anotherUser.Email,
71+
Password: anotherUser.Password,
8372
})
8473
require.NoError(t, err)
74+
err = client.SetSessionToken(token.SessionToken)
75+
require.NoError(t, err)
76+
8577
_, err = client.CreateWorkspace(context.Background(), "", coderd.CreateWorkspaceRequest{
8678
ProjectID: project.ID,
87-
Name: "$$$",
79+
Name: "workspace",
8880
})
8981
require.Error(t, err)
82+
var apiErr *codersdk.Error
83+
require.ErrorAs(t, err, &apiErr)
84+
require.Equal(t, http.StatusUnauthorized, apiErr.StatusCode())
9085
})
9186

92-
t.Run("CreateInvalidProject", func(t *testing.T) {
87+
t.Run("AlreadyExists", func(t *testing.T) {
9388
t.Parallel()
9489
client := coderdtest.New(t)
95-
_ = coderdtest.CreateInitialUser(t, client)
90+
user := coderdtest.CreateInitialUser(t, client)
91+
project := coderdtest.CreateProject(t, client, user.Organization)
92+
workspace := coderdtest.CreateWorkspace(t, client, "", project.ID)
9693
_, err := client.CreateWorkspace(context.Background(), "", coderd.CreateWorkspaceRequest{
97-
ProjectID: uuid.New(),
98-
Name: "moo",
94+
ProjectID: project.ID,
95+
Name: workspace.Name,
9996
})
10097
require.Error(t, err)
98+
var apiErr *codersdk.Error
99+
require.ErrorAs(t, err, &apiErr)
100+
require.Equal(t, http.StatusConflict, apiErr.StatusCode())
101101
})
102102

103-
t.Run("CreateNotInProjectOrganization", func(t *testing.T) {
103+
t.Run("Create", func(t *testing.T) {
104104
t.Parallel()
105105
client := coderdtest.New(t)
106-
initial := coderdtest.CreateInitialUser(t, client)
107-
project, err := client.CreateProject(context.Background(), initial.Organization, coderd.CreateProjectRequest{
108-
Name: "banana",
109-
Provisioner: database.ProvisionerTypeEcho,
110-
})
111-
require.NoError(t, err)
112-
_, err = client.CreateUser(context.Background(), coderd.CreateUserRequest{
113-
Email: "hello@ok.io",
114-
Username: "example",
115-
Password: "password",
116-
})
117-
require.NoError(t, err)
118-
token, err := client.LoginWithPassword(context.Background(), coderd.LoginWithPasswordRequest{
119-
Email: "hello@ok.io",
120-
Password: "password",
121-
})
122-
require.NoError(t, err)
123-
err = client.SetSessionToken(token.SessionToken)
124-
require.NoError(t, err)
125-
_, err = client.CreateWorkspace(context.Background(), "", coderd.CreateWorkspaceRequest{
126-
ProjectID: project.ID,
127-
Name: "moo",
128-
})
129-
require.Error(t, err)
106+
user := coderdtest.CreateInitialUser(t, client)
107+
project := coderdtest.CreateProject(t, client, user.Organization)
108+
_ = coderdtest.CreateWorkspace(t, client, "", project.ID)
130109
})
110+
}
111+
112+
func TestWorkspaceByUser(t *testing.T) {
113+
t.Parallel()
114+
client := coderdtest.New(t)
115+
user := coderdtest.CreateInitialUser(t, client)
116+
project := coderdtest.CreateProject(t, client, user.Organization)
117+
workspace := coderdtest.CreateWorkspace(t, client, "", project.ID)
118+
_, err := client.Workspace(context.Background(), "", workspace.Name)
119+
require.NoError(t, err)
120+
}
131121

132-
t.Run("CreateAlreadyExists", func(t *testing.T) {
122+
func TestWorkspacesByProject(t *testing.T) {
123+
t.Parallel()
124+
t.Run("ListEmpty", func(t *testing.T) {
133125
t.Parallel()
134126
client := coderdtest.New(t)
135127
user := coderdtest.CreateInitialUser(t, client)
136-
project, workspace := setupProjectAndWorkspace(t, client, user)
137-
_, err := client.CreateWorkspace(context.Background(), "", coderd.CreateWorkspaceRequest{
138-
Name: workspace.Name,
139-
ProjectID: project.ID,
140-
})
141-
require.Error(t, err)
128+
project := coderdtest.CreateProject(t, client, user.Organization)
129+
workspaces, err := client.WorkspacesByProject(context.Background(), user.Organization, project.Name)
130+
require.NoError(t, err)
131+
require.NotNil(t, workspaces)
142132
})
143133

144-
t.Run("Single", func(t *testing.T) {
134+
t.Run("List", func(t *testing.T) {
145135
t.Parallel()
146136
client := coderdtest.New(t)
147137
user := coderdtest.CreateInitialUser(t, client)
148-
_, workspace := setupProjectAndWorkspace(t, client, user)
149-
_, err := client.Workspace(context.Background(), "", workspace.Name)
138+
project := coderdtest.CreateProject(t, client, user.Organization)
139+
_ = coderdtest.CreateWorkspace(t, client, "", project.ID)
140+
workspaces, err := client.WorkspacesByProject(context.Background(), user.Organization, project.Name)
150141
require.NoError(t, err)
142+
require.NotNil(t, workspaces)
143+
require.Len(t, workspaces, 1)
151144
})
152145
}

0 commit comments

Comments
 (0)
0