Skip to content

refactor(tests): migrate trigger tests to shared mocks and factories #1002

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
aaight merged 1 commit into from
Mar 23, 2026
Merged

refactor(tests): migrate trigger tests to shared mocks and factories #1002

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
99 changes: 35 additions & 64 deletions tests/unit/triggers/backlog-status-changed.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,55 +1,33 @@
import { describe, expect, it, vi } from 'vitest';

vi.mock('../../../src/utils/logging.js', () => ({
logger: {
info: vi.fn(),
warn: vi.fn(),
error: vi.fn(),
debug: vi.fn(),
},
}));

vi.mock('../../../src/triggers/config-resolver.js', () => ({
isTriggerEnabled: vi.fn().mockResolvedValue(true),
getTriggerParameters: vi.fn().mockResolvedValue({}),
}));
vi.mock('../../../src/triggers/shared/trigger-check.js', () => ({
checkTriggerEnabled: vi.fn().mockResolvedValue(true),
}));
import {
mockAcknowledgmentsModule,
mockConfigProvider,
mockConfigResolverModule,
mockJiraClientModule,
mockLogger,
mockReactionsModule,
mockTrelloClientModule,
mockTriggerCheckModule,
} from '../../helpers/sharedMocks.js';

vi.mock('../../../src/utils/logging.js', () => ({ logger: mockLogger }));

vi.mock('../../../src/triggers/config-resolver.js', () => mockConfigResolverModule);
vi.mock('../../../src/triggers/shared/trigger-check.js', () => mockTriggerCheckModule);

// Mocks required for PM integration registration (pm/index.js side-effect)
vi.mock('../../../src/config/provider.js', () => ({
getIntegrationCredential: vi.fn(),
loadProjectConfigByBoardId: vi.fn(),
loadProjectConfigByJiraProjectKey: vi.fn(),
findProjectById: vi.fn(),
}));
vi.mock('../../../src/trello/client.js', () => ({
withTrelloCredentials: vi.fn(),
trelloClient: { getCard: vi.fn() },
}));
vi.mock('../../../src/jira/client.js', () => ({
withJiraCredentials: vi.fn(),
jiraClient: {},
}));
vi.mock('../../../src/router/acknowledgments.js', () => ({
postTrelloAck: vi.fn(),
deleteTrelloAck: vi.fn(),
resolveTrelloBotMemberId: vi.fn(),
postJiraAck: vi.fn(),
deleteJiraAck: vi.fn(),
resolveJiraBotAccountId: vi.fn(),
}));
vi.mock('../../../src/router/reactions.js', () => ({
sendAcknowledgeReaction: vi.fn(),
}));
vi.mock('../../../src/config/provider.js', () => mockConfigProvider);
vi.mock('../../../src/trello/client.js', () => mockTrelloClientModule);
vi.mock('../../../src/jira/client.js', () => mockJiraClientModule);
vi.mock('../../../src/router/acknowledgments.js', () => mockAcknowledgmentsModule);
vi.mock('../../../src/router/reactions.js', () => mockReactionsModule);

// Register PM integrations in the registry
import '../../../src/pm/index.js';

import { TrelloStatusChangedBacklogTrigger } from '../../../src/triggers/trello/status-changed.js';
import type { TriggerContext } from '../../../src/triggers/types.js';
import { createMockProject } from '../../helpers/factories.js';
import { createMockProject, createTrelloActionPayload } from '../../helpers/factories.js';

describe('TrelloStatusChangedBacklogTrigger', () => {
const trigger = TrelloStatusChangedBacklogTrigger;
Expand All @@ -71,8 +49,7 @@ describe('TrelloStatusChangedBacklogTrigger', () => {
const ctx: TriggerContext = {
project: mockProject,
source: 'trello',
payload: {
model: { id: 'board123', name: 'Board' },
payload: createTrelloActionPayload({
action: {
id: 'action1',
idMemberCreator: 'member1',
Expand All @@ -84,7 +61,7 @@ describe('TrelloStatusChangedBacklogTrigger', () => {
listAfter: { id: 'backlog-list-id', name: 'Backlog' },
},
},
},
}),
};

expect(trigger.matches(ctx)).toBe(true);
Expand All @@ -94,8 +71,7 @@ describe('TrelloStatusChangedBacklogTrigger', () => {
const ctx: TriggerContext = {
project: mockProject,
source: 'trello',
payload: {
model: { id: 'board123', name: 'Board' },
payload: createTrelloActionPayload({
action: {
id: 'action1',
idMemberCreator: 'member1',
Expand All @@ -107,7 +83,7 @@ describe('TrelloStatusChangedBacklogTrigger', () => {
listAfter: { id: 'backlog-list-id', name: 'Backlog' },
},
},
},
}),
};

expect(trigger.matches(ctx)).toBe(false);
Expand All @@ -117,8 +93,7 @@ describe('TrelloStatusChangedBacklogTrigger', () => {
const ctx: TriggerContext = {
project: mockProject,
source: 'trello',
payload: {
model: { id: 'board123', name: 'Board' },
payload: createTrelloActionPayload({
action: {
id: 'action1',
idMemberCreator: 'member1',
Expand All @@ -129,7 +104,7 @@ describe('TrelloStatusChangedBacklogTrigger', () => {
list: { id: 'backlog-list-id', name: 'Backlog' },
},
},
},
}),
};

expect(trigger.matches(ctx)).toBe(true);
Expand All @@ -139,8 +114,7 @@ describe('TrelloStatusChangedBacklogTrigger', () => {
const ctx: TriggerContext = {
project: mockProject,
source: 'trello',
payload: {
model: { id: 'board123', name: 'Board' },
payload: createTrelloActionPayload({
action: {
id: 'action1',
idMemberCreator: 'member1',
Expand All @@ -152,7 +126,7 @@ describe('TrelloStatusChangedBacklogTrigger', () => {
listAfter: { id: 'todo-list-id', name: 'TODO' },
},
},
},
}),
};

expect(trigger.matches(ctx)).toBe(false);
Expand All @@ -163,8 +137,7 @@ describe('TrelloStatusChangedBacklogTrigger', () => {
const ctx: TriggerContext = {
project: projectWithoutBacklog,
source: 'trello',
payload: {
model: { id: 'board123', name: 'Board' },
payload: createTrelloActionPayload({
action: {
id: 'action1',
idMemberCreator: 'member1',
Expand All @@ -176,7 +149,7 @@ describe('TrelloStatusChangedBacklogTrigger', () => {
listAfter: { id: 'backlog-list-id', name: 'Backlog' },
},
},
},
}),
};

// backlog list not configured, so targetListId is undefined — won't match
Expand All @@ -197,8 +170,7 @@ describe('TrelloStatusChangedBacklogTrigger', () => {
const ctx: TriggerContext = {
project: mockProject,
source: 'trello',
payload: {
model: { id: 'board123', name: 'Board' },
payload: createTrelloActionPayload({
action: {
id: 'action1',
idMemberCreator: 'member1',
Expand All @@ -210,7 +182,7 @@ describe('TrelloStatusChangedBacklogTrigger', () => {
listAfter: { id: 'backlog-list-id', name: 'Backlog' },
},
},
},
}),
};

const result = await trigger.handle(ctx);
Expand All @@ -224,8 +196,7 @@ describe('TrelloStatusChangedBacklogTrigger', () => {
const ctx: TriggerContext = {
project: mockProject,
source: 'trello',
payload: {
model: { id: 'board123', name: 'Board' },
payload: createTrelloActionPayload({
action: {
id: 'action1',
idMemberCreator: 'member1',
Expand All @@ -237,7 +208,7 @@ describe('TrelloStatusChangedBacklogTrigger', () => {
listAfter: { id: 'backlog-list-id', name: 'Backlog' },
},
},
},
}),
};

const result = await trigger.handle(ctx);
Expand Down
55 changes: 24 additions & 31 deletions tests/unit/triggers/check-suite-failure.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,29 +1,24 @@
import { beforeEach, describe, expect, it, vi } from 'vitest';
import {
mockConfigResolverModule,
mockGitHubClientModule,
mockTriggerCheckModule,
} from '../../helpers/sharedMocks.js';

vi.mock('../../../src/triggers/config-resolver.js', () => mockConfigResolverModule);

vi.mock('../../../src/triggers/shared/trigger-check.js', () => mockTriggerCheckModule);

vi.mock('../../../src/github/client.js', () => mockGitHubClientModule);

import {
CheckSuiteFailureTrigger,
resetFixAttempts,
} from '../../../src/triggers/github/check-suite-failure.js';
import type { TriggerContext } from '../../../src/triggers/types.js';
import { createMockProject } from '../../helpers/factories.js';
import { createCheckSuitePayload, createMockProject } from '../../helpers/factories.js';
import { mockPersonaIdentities } from '../../helpers/mockPersonas.js';

vi.mock('../../../src/triggers/config-resolver.js', () => ({
isTriggerEnabled: vi.fn().mockResolvedValue(true),
getTriggerParameters: vi.fn().mockResolvedValue({}),
}));

vi.mock('../../../src/triggers/shared/trigger-check.js', () => ({
checkTriggerEnabled: vi.fn().mockResolvedValue(true),
}));

vi.mock('../../../src/github/client.js', () => ({
githubClient: {
getPR: vi.fn(),
getCheckSuiteStatus: vi.fn(),
createPRComment: vi.fn(),
},
}));

import { githubClient } from '../../../src/github/client.js';

vi.mock('../../../src/db/repositories/prWorkItemsRepository.js', () => ({
Expand All @@ -37,19 +32,17 @@ describe('CheckSuiteFailureTrigger', () => {

const mockProject = createMockProject();

const makeFailurePayload = (overrides: Record<string, unknown> = {}) => ({
action: 'completed',
check_suite: {
id: 1,
status: 'completed',
conclusion: 'failure',
head_sha: 'sha123',
pull_requests: [{ number: 42, head: { ref: 'feature/test', sha: 'sha123' } }],
},
repository: { full_name: 'owner/repo', html_url: 'https://github.com/owner/repo' },
sender: { login: 'github-actions' },
...overrides,
});
const makeFailurePayload = (overrides: Record<string, unknown> = {}) =>
createCheckSuitePayload({
check_suite: {
id: 1,
status: 'completed',
conclusion: 'failure',
head_sha: 'sha123',
pull_requests: [{ number: 42, head: { ref: 'feature/test', sha: 'sha123' } }],
},
...overrides,
} as Parameters<typeof createCheckSuitePayload>[0]);

beforeEach(() => {
resetFixAttempts(42);
Expand Down
28 changes: 9 additions & 19 deletions tests/unit/triggers/check-suite-success.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
import { mockGitHubClientModule, mockTriggerCheckModule } from '../../helpers/sharedMocks.js';
import {
mockConfigResolverModule,
mockGitHubClientModule,
mockTriggerCheckModule,
} from '../../helpers/sharedMocks.js';

vi.mock('../../../src/triggers/config-resolver.js', () => ({
isTriggerEnabled: vi.fn().mockResolvedValue(true),
getTriggerParameters: vi.fn().mockResolvedValue({}),
}));
vi.mock('../../../src/triggers/config-resolver.js', () => mockConfigResolverModule);

vi.mock('../../../src/triggers/shared/trigger-check.js', () => mockTriggerCheckModule);

Expand All @@ -17,7 +18,7 @@ import {
} from '../../../src/triggers/github/check-suite-success.js';
import { ReviewRequestedTrigger } from '../../../src/triggers/github/review-requested.js';
import type { TriggerContext } from '../../../src/triggers/types.js';
import { createMockProject } from '../../helpers/factories.js';
import { createCheckSuitePayload, createMockProject } from '../../helpers/factories.js';
import { mockPersonaIdentities } from '../../helpers/mockPersonas.js';

import { githubClient } from '../../../src/github/client.js';
Expand All @@ -35,19 +36,8 @@ describe('CheckSuiteSuccessTrigger', () => {

const mockProject = createMockProject();

const makeCheckSuitePayload = (overrides: Record<string, unknown> = {}) => ({
action: 'completed',
check_suite: {
id: 1,
status: 'completed',
conclusion: 'success',
head_sha: 'sha123',
pull_requests: [{ number: 42, head: { ref: 'feature/test', sha: 'sha123' } }],
},
repository: { full_name: 'owner/repo', html_url: 'https://github.com/owner/repo' },
sender: { login: 'github-actions' },
...overrides,
});
const makeCheckSuitePayload = (overrides: Record<string, unknown> = {}) =>
createCheckSuitePayload(overrides as Parameters<typeof createCheckSuitePayload>[0]);

beforeEach(() => {
vi.mocked(lookupWorkItemForPR).mockResolvedValue('abc123');
Expand Down
24 changes: 9 additions & 15 deletions tests/unit/triggers/github-pr-comment-mention.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,15 @@ const { mockGetPR, mockIsCascadeBot } = vi.hoisted(() => ({
mockIsCascadeBot: vi.fn(),
}));

vi.mock('../../../src/triggers/config-resolver.js', () => ({
isTriggerEnabled: vi.fn().mockResolvedValue(true),
getTriggerParameters: vi.fn().mockResolvedValue({}),
}));
import {
mockConfigResolverModule,
mockLogger,
mockTriggerCheckModule,
} from '../../helpers/sharedMocks.js';

vi.mock('../../../src/triggers/shared/trigger-check.js', () => ({
checkTriggerEnabled: vi.fn().mockResolvedValue(true),
}));
vi.mock('../../../src/triggers/config-resolver.js', () => mockConfigResolverModule);

vi.mock('../../../src/triggers/shared/trigger-check.js', () => mockTriggerCheckModule);

vi.mock('../../../src/github/client.js', () => ({
githubClient: {
Expand All @@ -25,14 +26,7 @@ vi.mock('../../../src/github/personas.js', () => ({
isCascadeBot: mockIsCascadeBot,
}));

vi.mock('../../../src/utils/logging.js', () => ({
logger: {
warn: vi.fn(),
debug: vi.fn(),
info: vi.fn(),
error: vi.fn(),
},
}));
vi.mock('../../../src/utils/logging.js', () => ({ logger: mockLogger }));

vi.mock('../../../src/db/repositories/prWorkItemsRepository.js', () => ({
lookupWorkItemForPR: vi.fn(),
Expand Down
Loading
Loading