reduce scope of TestWorkspaceFavoriteUnfavorite to not include sorting order

johnstcn · johnstcn · commit d998bc682fb6 · 2024-01-22T22:33:11.000Z
diff --git a/coderd/workspaces_test.go b/coderd/workspaces_test.go
@@ -2931,84 +2931,56 @@ func TestWorkspaceFavoriteUnfavorite(t *testing.T) {
 		client, db    = coderdtest.NewWithDatabase(t, &coderdtest.Options{
 			Auditor: auditRecorder,
 		})
-		owner                = coderdtest.CreateFirstUser(t, client)
-		memberClient, member = coderdtest.CreateAnotherUser(t, client, owner.OrganizationID)
+		owner           = coderdtest.CreateFirstUser(t, client)
+		memberClient, _ = coderdtest.CreateAnotherUser(t, client, owner.OrganizationID)
 		// This will be our 'favorite' workspace
-		wsb1 = dbfake.WorkspaceBuild(t, db, database.Workspace{OwnerID: member.ID, OrganizationID: owner.OrganizationID}).Do()
-		// Another workspace for member, but not their favorite.
-		_ = dbfake.WorkspaceBuild(t, db, database.Workspace{OwnerID: member.ID, OrganizationID: owner.OrganizationID}).Do()
-		// A workspace for another user.
-		_ = dbfake.WorkspaceBuild(t, db, database.Workspace{OwnerID: owner.UserID, OrganizationID: owner.OrganizationID}).Do()
+		wsb = dbfake.WorkspaceBuild(t, db, database.Workspace{OwnerID: owner.UserID, OrganizationID: owner.OrganizationID}).Do()
 	)
 
 	ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
 	defer cancel()
 
 	// Initially, workspace should not be favored for member.
-	workspaces, err := memberClient.Workspaces(ctx, codersdk.WorkspaceFilter{})
+	workspaces, err := client.Workspaces(ctx, codersdk.WorkspaceFilter{})
 	require.NoError(t, err)
-	require.Len(t, workspaces.Workspaces, 2)
+	require.Len(t, workspaces.Workspaces, 1)
 	require.False(t, workspaces.Workspaces[0].Favorite, "no favorites yet")
-	require.False(t, workspaces.Workspaces[1].Favorite, "no favorites yet")
-	ws, err := memberClient.Workspace(ctx, wsb1.Workspace.ID)
+	ws, err := client.Workspace(ctx, wsb.Workspace.ID)
 	require.NoError(t, err)
 	require.False(t, ws.Favorite)
 
-	// Also not for owner.
-	workspaces, err = client.Workspaces(ctx, codersdk.WorkspaceFilter{})
-	require.NoError(t, err)
-	require.Len(t, workspaces.Workspaces, 3)
-	require.False(t, workspaces.Workspaces[0].Favorite, "this user is impartial and has no favorites")
-	require.False(t, workspaces.Workspaces[1].Favorite, "this user is impartial and has no favorites")
-	require.False(t, workspaces.Workspaces[2].Favorite, "this user is impartial and has no favorites")
-
-	// When member favorites workspace
-	err = memberClient.FavoriteWorkspace(ctx, wsb1.Workspace.ID)
+	// When user favorites workspace
+	err = client.FavoriteWorkspace(ctx, wsb.Workspace.ID)
 	require.NoError(t, err)
 
-	// Then it should be favored for them and show up first.
-	workspaces, err = memberClient.Workspaces(ctx, codersdk.WorkspaceFilter{})
+	// Then it should be favored for them.
+	workspaces, err = client.Workspaces(ctx, codersdk.WorkspaceFilter{})
 	require.NoError(t, err)
-	require.Len(t, workspaces.Workspaces, 2)
+	require.Len(t, workspaces.Workspaces, 1)
 	require.True(t, workspaces.Workspaces[0].Favorite, "favorites should come first")
-	require.False(t, workspaces.Workspaces[1].Favorite, "favorites should come first")
-	ws, err = memberClient.Workspace(ctx, wsb1.Workspace.ID)
+	ws, err = client.Workspace(ctx, wsb.Workspace.ID)
 	require.NoError(t, err)
 	require.True(t, ws.Favorite)
 
-	// But not for someone else
-	workspaces, err = client.Workspaces(ctx, codersdk.WorkspaceFilter{})
-	require.NoError(t, err)
-	require.Len(t, workspaces.Workspaces, 3)
-	require.False(t, workspaces.Workspaces[0].Favorite, "this user is impartial and has no favorites")
-	require.False(t, workspaces.Workspaces[1].Favorite, "this user is impartial and has no favorites")
-	require.False(t, workspaces.Workspaces[2].Favorite, "this user is impartial and has no favorites")
-	ws, err = client.Workspace(ctx, wsb1.Workspace.ID)
-	require.NoError(t, err)
-	require.False(t, ws.Favorite)
-
 	// When member unfavorites workspace
-	err = memberClient.UnfavoriteWorkspace(ctx, wsb1.Workspace.ID)
+	err = client.UnfavoriteWorkspace(ctx, wsb.Workspace.ID)
 	require.NoError(t, err)
 
 	// Then it should no longer be favored
-	workspaces, err = memberClient.Workspaces(ctx, codersdk.WorkspaceFilter{})
+	workspaces, err = client.Workspaces(ctx, codersdk.WorkspaceFilter{})
 	require.NoError(t, err)
-	require.Len(t, workspaces.Workspaces, 2)
+	require.Len(t, workspaces.Workspaces, 1)
 	require.False(t, workspaces.Workspaces[0].Favorite, "no longer favorite")
-	require.False(t, workspaces.Workspaces[1].Favorite, "no longer favorite")
-	ws, err = memberClient.Workspace(ctx, wsb1.Workspace.ID)
+	ws, err = client.Workspace(ctx, wsb.Workspace.ID)
 	require.NoError(t, err)
 	require.False(t, ws.Favorite)
 
-	// Assert invariant: workspace should remain unfavorited for a different user
-	workspaces, err = client.Workspaces(ctx, codersdk.WorkspaceFilter{})
-	require.NoError(t, err)
-	require.Len(t, workspaces.Workspaces, 3)
-	require.False(t, workspaces.Workspaces[0].Favorite, "this user is impartial and has no favorites")
-	require.False(t, workspaces.Workspaces[1].Favorite, "this user is impartial and has no favorites")
-	require.False(t, workspaces.Workspaces[2].Favorite, "this user is impartial and has no favorites")
-	ws, err = client.Workspace(ctx, wsb1.Workspace.ID)
-	require.NoError(t, err)
-	require.False(t, ws.Favorite)
+	// Users without write access to the workspace should not be able to perform the above.
+	err = memberClient.FavoriteWorkspace(ctx, wsb.Workspace.ID)
+	var sdkErr *codersdk.Error
+	require.ErrorAs(t, err, &sdkErr)
+	require.Equal(t, http.StatusNotFound, sdkErr.StatusCode())
+	err = memberClient.UnfavoriteWorkspace(ctx, wsb.Workspace.ID)
+	require.ErrorAs(t, err, &sdkErr)
+	require.Equal(t, http.StatusNotFound, sdkErr.StatusCode())
 }
diff --git a/codersdk/workspaces.go b/codersdk/workspaces.go
@@ -479,7 +479,7 @@ func (c *Client) FavoriteWorkspace(ctx context.Context, workspaceID uuid.UUID) e
 	}
 	defer res.Body.Close()
 	if res.StatusCode != http.StatusNoContent {
-		return err
+		return ReadBodyAsError(res)
 	}
 	return nil
 }
@@ -491,7 +491,7 @@ func (c *Client) UnfavoriteWorkspace(ctx context.Context, workspaceID uuid.UUID)
 	}
 	defer res.Body.Close()
 	if res.StatusCode != http.StatusNoContent {
-		return err
+		return ReadBodyAsError(res)
 	}
 	return nil
 }

Original file line number	Diff line number	Diff line change
`@@ -479,7 +479,7 @@ func (c *Client) FavoriteWorkspace(ctx context.Context, workspaceID uuid.UUID) e`
`479`	`479`	`}`
`480`	`480`	`defer res.Body.Close()`
`481`	`481`	`if res.StatusCode != http.StatusNoContent {`
`482`		`- return err`
	`482`	`+ return ReadBodyAsError(res)`
`483`	`483`	`}`
`484`	`484`	`return nil`
`485`	`485`	`}`
`@@ -491,7 +491,7 @@ func (c *Client) UnfavoriteWorkspace(ctx context.Context, workspaceID uuid.UUID)`
`491`	`491`	`}`
`492`	`492`	`defer res.Body.Close()`
`493`	`493`	`if res.StatusCode != http.StatusNoContent {`
`494`		`- return err`
	`494`	`+ return ReadBodyAsError(res)`
`495`	`495`	`}`
`496`	`496`	`return nil`
`497`	`497`	`}`