Skip to content

chore: improve variable names of mocked users #17701

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 8, 2025
Merged

chore: improve variable names of mocked users #17701

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5717c9a
chore: better represent user mocks
BrunoQuaresma May 7, 2025
54e349a
Rollback attributes changes
BrunoQuaresma May 7, 2025
60810b9
Fix imports
BrunoQuaresma May 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,3 +82,5 @@ result

# dlv debug binaries for go tests
__debug_bin*

**/.claude/settings.local.json
2 changes: 1 addition & 1 deletion docs/contributing/frontend.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ export const WithQuota: Story = {
parameters: {
queries: [
{
key: getWorkspaceQuotaQueryKey(MockUser.username),
key: getWorkspaceQuotaQueryKey(MockUserOwner.username),
data: {
credits_consumed: 2,
budget: 40,
Expand Down
6 changes: 3 additions & 3 deletions site/src/components/OrganizationAutocomplete/OrganizationAutocomplete.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import { userEvent, within } from "@storybook/test";
import {
MockOrganization,
MockOrganization2,
MockUser,
MockUserOwner,
} from "testHelpers/entities";
import { OrganizationAutocomplete } from "./OrganizationAutocomplete";

Expand All @@ -22,7 +22,7 @@ type Story = StoryObj<typeof OrganizationAutocomplete>;
export const ManyOrgs: Story = {
parameters: {
showOrganizations: true,
user: MockUser,
user: MockUserOwner,
features: ["multiple_organizations"],
permissions: { viewDeploymentConfig: true },
queries: [
Expand All @@ -42,7 +42,7 @@ export const ManyOrgs: Story = {
export const OneOrg: Story = {
parameters: {
showOrganizations: true,
user: MockUser,
user: MockUserOwner,
features: ["multiple_organizations"],
permissions: { viewDeploymentConfig: true },
queries: [
Expand Down
6 changes: 3 additions & 3 deletions site/src/components/UserAutocomplete/UserAutocomplete.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import type { Meta, StoryObj } from "@storybook/react";
import { MockUser } from "testHelpers/entities";
import { MockUserOwner } from "testHelpers/entities";
import { UserAutocomplete } from "./UserAutocomplete";

const meta: Meta<typeof UserAutocomplete> = {
Expand All @@ -12,13 +12,13 @@ type Story = StoryObj<typeof UserAutocomplete>;

export const WithLabel: Story = {
args: {
value: MockUser,
value: MockUserOwner,
label: "User",
},
};

export const NoLabel: Story = {
args: {
value: MockUser,
value: MockUserOwner,
},
};
6 changes: 3 additions & 3 deletions site/src/contexts/auth/RequireAuth.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import { useAuthenticated } from "hooks";
import { http, HttpResponse } from "msw";
import type { FC, PropsWithChildren } from "react";
import { QueryClientProvider } from "react-query";
import { MockPermissions, MockUser } from "testHelpers/entities";
import { MockPermissions, MockUserOwner } from "testHelpers/entities";
import {
createTestQueryClient,
renderWithAuth,
Expand Down Expand Up @@ -82,7 +82,7 @@ describe("useAuthenticated", () => {

expect(() => {
renderHook(() => useAuthenticated(), {
wrapper: createAuthWrapper({ user: MockUser }),
wrapper: createAuthWrapper({ user: MockUserOwner }),
});
}).toThrow("Permissions are not available.");

Expand All @@ -93,7 +93,7 @@ describe("useAuthenticated", () => {
expect(() => {
renderHook(() => useAuthenticated(), {
wrapper: createAuthWrapper({
user: MockUser,
user: MockUserOwner,
permissions: MockPermissions,
}),
});
Expand Down
6 changes: 3 additions & 3 deletions site/src/hooks/useEmbeddedMetadata.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ import {
MockBuildInfo,
MockEntitlements,
MockExperiments,
MockUser,
MockUserAppearanceSettings,
MockUserOwner,
} from "testHelpers/entities";
import {
DEFAULT_METADATA_KEY,
Expand Down Expand Up @@ -38,7 +38,7 @@ const mockDataForTags = {
"build-info": MockBuildInfo,
entitlements: MockEntitlements,
experiments: MockExperiments,
user: MockUser,
user: MockUserOwner,
userAppearance: MockUserAppearanceSettings,
regions: MockRegions,
} as const satisfies Record<MetadataKey, MetadataValue>;
Expand Down Expand Up @@ -97,7 +97,7 @@ const populatedMetadata: RuntimeHtmlMetadata = {
},
user: {
available: true,
value: MockUser,
value: MockUserOwner,
},
userAppearance: {
available: true,
Expand Down
12 changes: 6 additions & 6 deletions site/src/modules/dashboard/Navbar/MobileMenu.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ import {
MockPrimaryWorkspaceProxy,
MockProxyLatencies,
MockSupportLinks,
MockUser,
MockUser2,
MockUserMember,
MockUserOwner,
MockWorkspaceProxies,
} from "testHelpers/entities";
import { MobileMenu } from "./MobileMenu";
Expand Down Expand Up @@ -36,7 +36,7 @@ const meta: Meta<typeof MobileMenu> = {
proxyLatencies: MockProxyLatencies,
proxies: MockWorkspaceProxies,
},
user: MockUser,
user: MockUserOwner,
supportLinks: MockSupportLinks,
onSignOut: fn(),
isDefaultOpen: true,
Expand All @@ -63,7 +63,7 @@ export const Admin: Story = {

export const Auditor: Story = {
args: {
user: MockUser2,
user: MockUserMember,
canViewAuditLog: true,
canViewDeployment: false,
canViewHealth: false,
Expand All @@ -74,7 +74,7 @@ export const Auditor: Story = {

export const OrgAdmin: Story = {
args: {
user: MockUser2,
user: MockUserMember,
canViewAuditLog: true,
canViewDeployment: false,
canViewHealth: false,
Expand All @@ -85,7 +85,7 @@ export const OrgAdmin: Story = {

export const Member: Story = {
args: {
user: MockUser2,
user: MockUserMember,
canViewAuditLog: false,
canViewDeployment: false,
canViewHealth: false,
Expand Down
10 changes: 5 additions & 5 deletions site/src/modules/dashboard/Navbar/NavbarView.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import type { Meta, StoryObj } from "@storybook/react";
import { userEvent, within } from "@storybook/test";
import { chromaticWithTablet } from "testHelpers/chromatic";
import { MockUser, MockUser2 } from "testHelpers/entities";
import { MockUserMember, MockUserOwner } from "testHelpers/entities";
import { withDashboardProvider } from "testHelpers/storybook";
import { NavbarView } from "./NavbarView";

Expand All @@ -10,7 +10,7 @@ const meta: Meta<typeof NavbarView> = {
parameters: { chromatic: chromaticWithTablet, layout: "fullscreen" },
component: NavbarView,
args: {
user: MockUser,
user: MockUserOwner,
canViewAuditLog: true,
canViewDeployment: true,
canViewHealth: true,
Expand All @@ -33,7 +33,7 @@ export const ForAdmin: Story = {

export const ForAuditor: Story = {
args: {
user: MockUser2,
user: MockUserMember,
canViewAuditLog: true,
canViewDeployment: false,
canViewHealth: false,
Expand All @@ -49,7 +49,7 @@ export const ForAuditor: Story = {

export const ForOrgAdmin: Story = {
args: {
user: MockUser2,
user: MockUserMember,
canViewAuditLog: true,
canViewDeployment: false,
canViewHealth: false,
Expand All @@ -65,7 +65,7 @@ export const ForOrgAdmin: Story = {

export const ForMember: Story = {
args: {
user: MockUser2,
user: MockUserMember,
canViewAuditLog: false,
canViewDeployment: false,
canViewHealth: false,
Expand Down
10 changes: 5 additions & 5 deletions site/src/modules/dashboard/Navbar/NavbarView.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { screen } from "@testing-library/react";
import userEvent from "@testing-library/user-event";
import type { ProxyContextValue } from "contexts/ProxyContext";
import { MockPrimaryWorkspaceProxy, MockUser } from "testHelpers/entities";
import { MockPrimaryWorkspaceProxy, MockUserOwner } from "testHelpers/entities";
import { renderWithAuth } from "testHelpers/renderHelpers";
import { NavbarView } from "./NavbarView";

Expand All @@ -26,7 +26,7 @@ describe("NavbarView", () => {
renderWithAuth(
<NavbarView
proxyContextValue={proxyContextValue}
user={MockUser}
user={MockUserOwner}
onSignOut={noop}
canViewDeployment
canViewOrganizations
Expand All @@ -43,7 +43,7 @@ describe("NavbarView", () => {
renderWithAuth(
<NavbarView
proxyContextValue={proxyContextValue}
user={MockUser}
user={MockUserOwner}
onSignOut={noop}
canViewDeployment
canViewOrganizations
Expand All @@ -60,7 +60,7 @@ describe("NavbarView", () => {
renderWithAuth(
<NavbarView
proxyContextValue={proxyContextValue}
user={MockUser}
user={MockUserOwner}
onSignOut={noop}
canViewDeployment
canViewOrganizations
Expand All @@ -78,7 +78,7 @@ describe("NavbarView", () => {
renderWithAuth(
<NavbarView
proxyContextValue={proxyContextValue}
user={MockUser}
user={MockUserOwner}
onSignOut={noop}
canViewDeployment
canViewOrganizations
Expand Down
4 changes: 2 additions & 2 deletions site/src/modules/dashboard/Navbar/ProxyMenu.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import {
MockAuthMethodsAll,
MockPermissions,
MockProxyLatencies,
MockUser,
MockUserOwner,
MockWorkspaceProxies,
} from "testHelpers/entities";
import { withDesktopViewport } from "testHelpers/storybook";
Expand Down Expand Up @@ -41,7 +41,7 @@ const meta: Meta<typeof ProxyMenu> = {
],
parameters: {
queries: [
{ key: ["me"], data: MockUser },
{ key: ["me"], data: MockUserOwner },
{ key: ["authMethods"], data: MockAuthMethodsAll },
{ key: ["hasFirstUser"], data: true },
{
Expand Down
4 changes: 2 additions & 2 deletions site/src/modules/dashboard/Navbar/UserDropdown/UserDropdown.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
import type { Meta, StoryObj } from "@storybook/react";
import { expect, screen, userEvent, waitFor, within } from "@storybook/test";
import { MockBuildInfo, MockUser } from "testHelpers/entities";
import { MockBuildInfo, MockUserOwner } from "testHelpers/entities";
import { withDashboardProvider } from "testHelpers/storybook";
import { UserDropdown } from "./UserDropdown";

const meta: Meta<typeof UserDropdown> = {
title: "modules/dashboard/UserDropdown",
component: UserDropdown,
args: {
user: MockUser,
user: MockUserOwner,
buildInfo: MockBuildInfo,
supportLinks: [
{ icon: "docs", name: "Documentation", target: "" },
Expand Down
6 changes: 3 additions & 3 deletions site/src/modules/dashboard/Navbar/UserDropdown/UserDropdownContent.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
import { screen } from "@testing-library/react";
import { Popover } from "components/deprecated/Popover/Popover";
import { MockUser } from "testHelpers/entities";
import { MockUserOwner } from "testHelpers/entities";
import { render, waitForLoaderToBeRemoved } from "testHelpers/renderHelpers";
import { Language, UserDropdownContent } from "./UserDropdownContent";

describe("UserDropdownContent", () => {
it("has the correct link for the account item", async () => {
render(
<Popover>
<UserDropdownContent user={MockUser} onSignOut={jest.fn()} />
<UserDropdownContent user={MockUserOwner} onSignOut={jest.fn()} />
</Popover>,
);
await waitForLoaderToBeRemoved();
Expand All @@ -25,7 +25,7 @@ describe("UserDropdownContent", () => {
const onSignOut = jest.fn();
render(
<Popover>
<UserDropdownContent user={MockUser} onSignOut={onSignOut} />
<UserDropdownContent user={MockUserOwner} onSignOut={onSignOut} />
</Popover>,
);
await waitForLoaderToBeRemoved();
Expand Down
4 changes: 2 additions & 2 deletions site/src/pages/AuditPage/AuditLogRow/AuditLogRow.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ import {
MockAuditLogRequestPasswordReset,
MockAuditLogWithDeletedResource,
MockAuditLogWithWorkspaceBuild,
MockUser,
MockUserOwner,
} from "testHelpers/entities";
import { AuditLogRow } from "./AuditLogRow";

Expand Down Expand Up @@ -155,7 +155,7 @@ export const NoUserAgent: Story = {
description: "{user} deleted workspace {target}",
resource_link: "/@jon/yeee/builds/35",
is_deleted: false,
user: MockUser,
user: MockUserOwner,
},
},
};
Expand Down
4 changes: 2 additions & 2 deletions site/src/pages/AuditPage/AuditPageView.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ import {
MockAuditLog,
MockAuditLog2,
MockAuditLog3,
MockUser,
MockUserOwner,
} from "testHelpers/entities";
import { AuditPageView } from "./AuditPageView";

Expand All @@ -23,7 +23,7 @@ type FilterProps = ComponentProps<typeof AuditPageView>["filterProps"];
const defaultFilterProps = getDefaultFilterProps<FilterProps>({
query: "owner:me",
values: {
username: MockUser.username,
username: MockUserOwner.username,
action: undefined,
resource_type: undefined,
organization: undefined,
Expand Down
Loading
Loading