-
-
Notifications
You must be signed in to change notification settings - Fork 112
Expand file tree
/
Copy pathgithub-comments.test.ts
More file actions
285 lines (242 loc) · 7.6 KB
/
github-comments.test.ts
File metadata and controls
285 lines (242 loc) · 7.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
import type { GitHubContext } from '../types'
import * as core from '@actions/core'
import { beforeEach, describe, expect, it, vi } from 'vitest'
import { createCommentOnCommit, createCommentOnPullRequest } from '../github-comments'
vi.mock('@actions/core', () => ({
info: vi.fn(),
debug: vi.fn(),
warning: vi.fn(),
}))
const mockListCommentsForCommit = vi.fn()
const mockCreateCommitComment = vi.fn()
const mockUpdateCommitComment = vi.fn()
const mockListComments = vi.fn()
const mockCreateComment = vi.fn()
const mockUpdateComment = vi.fn()
function createMockOctokit() {
return {
rest: {
repos: {
listCommentsForCommit: mockListCommentsForCommit,
createCommitComment: mockCreateCommitComment,
updateCommitComment: mockUpdateCommitComment,
},
issues: {
listComments: mockListComments,
createComment: mockCreateComment,
updateComment: mockUpdateComment,
},
},
} as any
}
function createContext(overrides: Partial<GitHubContext> = {}): GitHubContext {
return {
eventName: 'push',
sha: 'abc123',
repo: { owner: 'test-owner', repo: 'test-repo' },
issueNumber: 42,
...overrides,
}
}
function createConfig(overrides: Record<string, unknown> = {}) {
return {
githubToken: 'test-token',
githubComment: true as boolean | string,
workingDirectory: '',
vercelToken: 'v-token',
vercelArgs: '',
vercelOrgId: '',
vercelProjectId: '',
vercelScope: '',
vercelProjectName: '',
vercelBin: 'vercel@latest',
aliasDomains: [] as string[],
...overrides,
}
}
describe('createCommentOnCommit', () => {
const ctx = createContext({ eventName: 'push' })
beforeEach(() => {
vi.clearAllMocks()
})
it('creates a new comment when no previous comment exists', async () => {
mockListCommentsForCommit.mockResolvedValue({ data: [] })
mockCreateCommitComment.mockResolvedValue({})
await createCommentOnCommit(
createMockOctokit(),
ctx,
createConfig(),
'abc123',
'https://deploy.vercel.app',
'my-app',
)
expect(mockCreateCommitComment).toHaveBeenCalledTimes(1)
expect(mockUpdateCommitComment).not.toHaveBeenCalled()
const body = mockCreateCommitComment.mock.calls[0][0].body
expect(body).toContain('Deploy preview for _my-app_ ready!')
expect(body).toContain('<table>')
expect(body).toContain('https://deploy.vercel.app')
})
it('updates existing comment when previous comment found', async () => {
mockListCommentsForCommit.mockResolvedValue({
data: [
{ id: 99, body: 'Deploy preview for _my-app_ ready!\n\nold content' },
],
})
mockUpdateCommitComment.mockResolvedValue({})
await createCommentOnCommit(
createMockOctokit(),
ctx,
createConfig(),
'abc123',
'https://deploy.vercel.app',
'my-app',
)
expect(mockUpdateCommitComment).toHaveBeenCalledTimes(1)
expect(mockUpdateCommitComment.mock.calls[0][0].comment_id).toBe(99)
expect(mockCreateCommitComment).not.toHaveBeenCalled()
})
it('skips comment when githubComment is false', async () => {
mockListCommentsForCommit.mockResolvedValue({ data: [] })
await createCommentOnCommit(
createMockOctokit(),
ctx,
createConfig({ githubComment: false }),
'abc123',
'https://deploy.vercel.app',
'my-app',
)
expect(mockListCommentsForCommit).toHaveBeenCalled()
expect(mockCreateCommitComment).not.toHaveBeenCalled()
expect(mockUpdateCommitComment).not.toHaveBeenCalled()
})
it('catches and warns on API errors from findPreviousComment', async () => {
mockListCommentsForCommit.mockRejectedValue(new Error('API rate limit'))
await createCommentOnCommit(
createMockOctokit(),
ctx,
createConfig(),
'abc123',
'https://deploy.vercel.app',
'my-app',
)
expect(core.warning).toHaveBeenCalledWith(
expect.stringContaining('API rate limit'),
)
})
it('catches and warns on create comment errors', async () => {
mockListCommentsForCommit.mockResolvedValue({ data: [] })
mockCreateCommitComment.mockRejectedValue(new Error('403 Forbidden'))
await createCommentOnCommit(
createMockOctokit(),
ctx,
createConfig(),
'abc123',
'https://deploy.vercel.app',
'my-app',
)
expect(core.warning).toHaveBeenCalledWith(
expect.stringContaining('403 Forbidden'),
)
})
it('uses custom template when string provided', async () => {
mockListCommentsForCommit.mockResolvedValue({ data: [] })
mockCreateCommitComment.mockResolvedValue({})
await createCommentOnCommit(
createMockOctokit(),
ctx,
createConfig({ githubComment: 'Custom: {{deploymentUrl}}' }),
'abc123',
'https://deploy.vercel.app',
'my-app',
)
const body = mockCreateCommitComment.mock.calls[0][0].body
expect(body).toContain('Custom: https://deploy.vercel.app')
})
})
describe('createCommentOnPullRequest', () => {
const ctx = createContext({ eventName: 'pull_request' })
beforeEach(() => {
vi.clearAllMocks()
})
it('creates a new PR comment when no previous comment exists', async () => {
mockListComments.mockResolvedValue({ data: [] })
mockCreateComment.mockResolvedValue({})
await createCommentOnPullRequest(
createMockOctokit(),
ctx,
createConfig(),
'abc123',
'https://deploy.vercel.app',
'my-app',
)
expect(mockCreateComment).toHaveBeenCalledTimes(1)
expect(mockUpdateComment).not.toHaveBeenCalled()
expect(mockCreateComment.mock.calls[0][0].issue_number).toBe(42)
})
it('updates existing PR comment when previous comment found', async () => {
mockListComments.mockResolvedValue({
data: [
{ id: 77, body: 'Deploy preview for _my-app_ ready!\n\nold' },
],
})
mockUpdateComment.mockResolvedValue({})
await createCommentOnPullRequest(
createMockOctokit(),
ctx,
createConfig(),
'abc123',
'https://deploy.vercel.app',
'my-app',
)
expect(mockUpdateComment).toHaveBeenCalledTimes(1)
expect(mockUpdateComment.mock.calls[0][0].comment_id).toBe(77)
expect(mockCreateComment).not.toHaveBeenCalled()
})
it('catches and warns on findPreviousComment API errors', async () => {
mockListComments.mockRejectedValue(new Error('network error'))
await createCommentOnPullRequest(
createMockOctokit(),
ctx,
createConfig(),
'abc123',
'https://deploy.vercel.app',
'my-app',
)
expect(core.warning).toHaveBeenCalledWith(
expect.stringContaining('network error'),
)
})
it('catches and warns on update comment errors', async () => {
mockListComments.mockResolvedValue({
data: [{ id: 77, body: 'Deploy preview for _my-app_ ready!' }],
})
mockUpdateComment.mockRejectedValue(new Error('422 Unprocessable'))
await createCommentOnPullRequest(
createMockOctokit(),
ctx,
createConfig(),
'abc123',
'https://deploy.vercel.app',
'my-app',
)
expect(core.warning).toHaveBeenCalledWith(
expect.stringContaining('422 Unprocessable'),
)
})
it('warns for unsupported event types', async () => {
const unsupportedCtx = createContext({ eventName: 'workflow_dispatch' })
mockCreateComment.mockResolvedValue({})
await createCommentOnPullRequest(
createMockOctokit(),
unsupportedCtx,
createConfig(),
'abc123',
'https://deploy.vercel.app',
'my-app',
)
expect(core.warning).toHaveBeenCalledWith(
expect.stringContaining('not supported'),
)
})
})