-
Notifications
You must be signed in to change notification settings - Fork 66.9k
Expand file tree
/
Copy pathmetadata-permissions.ts
More file actions
338 lines (281 loc) · 13 KB
/
metadata-permissions.ts
File metadata and controls
338 lines (281 loc) · 13 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
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
import { describe, expect, test } from 'vitest'
import { shouldFilterMetadataPermission, calculateAdditionalPermissions } from '../scripts/sync'
type PermissionSet = Record<string, string>
interface Operation {
operationId: string
permissionSets: PermissionSet[]
}
interface ProgAccessData {
userToServerRest: boolean
serverToServer: boolean
permissions: PermissionSet[]
}
interface ActorResource {
title: string
visibility: string
}
interface FilteredOperation {
operationId: string
permission: string
additionalPermissions: boolean
}
interface MetadataPermission {
operationId: string
additionalPermissions: boolean
}
describe('metadata permissions filtering', () => {
// Mock data structure representing operations with metadata permissions
const mockOperationsWithMetadata: Operation[] = [
{
operationId: 'repos/enable-automated-security-fixes',
permissionSets: [{ metadata: 'read', administration: 'write' }],
},
{
operationId: 'repos/get-readme',
permissionSets: [{ metadata: 'read' }],
},
{
operationId: 'orgs/update-webhook',
permissionSets: [{ metadata: 'read', organization_administration: 'write' }],
},
{
operationId: 'repos/get-content',
permissionSets: [{ contents: 'read' }],
},
]
// Mock programmatic access data
const mockProgAccessData: Record<string, ProgAccessData> = {
'repos/enable-automated-security-fixes': {
userToServerRest: true,
serverToServer: true,
permissions: [{ metadata: 'read', administration: 'write' }],
},
'repos/get-readme': {
userToServerRest: true,
serverToServer: true,
permissions: [{ metadata: 'read' }],
},
'orgs/update-webhook': {
userToServerRest: true,
serverToServer: true,
permissions: [{ metadata: 'read', organization_administration: 'write' }],
},
'repos/get-content': {
userToServerRest: true,
serverToServer: true,
permissions: [{ contents: 'read' }],
},
}
// Mock actor resources
const mockProgActorResources: Record<string, ActorResource> = {
metadata: {
title: 'Metadata',
visibility: 'public',
},
administration: {
title: 'Administration',
visibility: 'public',
},
organization_administration: {
title: 'Organization administration',
visibility: 'public',
},
contents: {
title: 'Contents',
visibility: 'public',
},
}
test('calculateAdditionalPermissions works correctly', () => {
// Single permission set with multiple permissions
expect(calculateAdditionalPermissions([{ metadata: 'read', admin: 'write' }])).toBe(true)
// Single permission set with single permission
expect(calculateAdditionalPermissions([{ metadata: 'read' }])).toBe(false)
// Multiple permission sets
expect(calculateAdditionalPermissions([{ metadata: 'read' }, { admin: 'write' }])).toBe(true)
// Empty permission sets
expect(calculateAdditionalPermissions([])).toBe(false)
})
test('identifies metadata with additional permissions correctly', () => {
// Case 1: metadata + administration (should be filtered)
const metadataWithAdmin = [{ metadata: 'read', administration: 'write' }]
expect(shouldFilterMetadataPermission('metadata', metadataWithAdmin)).toBe(true)
// Case 2: metadata only (should NOT be filtered)
const metadataOnly = [{ metadata: 'read' }]
expect(shouldFilterMetadataPermission('metadata', metadataOnly)).toBe(false)
// Case 3: non-metadata permission (should NOT be filtered)
const nonMetadata = [{ contents: 'read' }]
expect(shouldFilterMetadataPermission('contents', nonMetadata)).toBe(false)
})
test('filters metadata operations with additional permissions', () => {
const filteredOperations: FilteredOperation[] = []
const metadataPermissions: MetadataPermission[] = []
for (const operation of mockOperationsWithMetadata) {
const progData = mockProgAccessData[operation.operationId]
for (const permissionSet of progData.permissions) {
for (const [permissionName] of Object.entries(permissionSet)) {
if (mockProgActorResources[permissionName]?.visibility === 'private') continue
const additionalPermissions = calculateAdditionalPermissions(progData.permissions)
// Apply metadata filtering logic
if (shouldFilterMetadataPermission(permissionName, progData.permissions)) {
// Skip this metadata permission as it has additional permissions
continue
}
if (permissionName === 'metadata') {
metadataPermissions.push({
operationId: operation.operationId,
additionalPermissions,
})
} else {
filteredOperations.push({
operationId: operation.operationId,
permission: permissionName,
additionalPermissions,
})
}
}
}
}
// Should only have metadata permission from the metadata-only operation
expect(metadataPermissions).toHaveLength(1)
expect(metadataPermissions[0].operationId).toBe('repos/get-readme')
expect(metadataPermissions[0].additionalPermissions).toBe(false)
// Should have other permissions from operations with additional permissions
const adminPermission = filteredOperations.find((op) => op.permission === 'administration')
expect(adminPermission).toBeDefined()
expect(adminPermission!.operationId).toBe('repos/enable-automated-security-fixes')
expect(adminPermission!.additionalPermissions).toBe(true)
const orgAdminPermission = filteredOperations.find(
(op) => op.permission === 'organization_administration',
)
expect(orgAdminPermission).toBeDefined()
expect(orgAdminPermission!.operationId).toBe('orgs/update-webhook')
expect(orgAdminPermission!.additionalPermissions).toBe(true)
})
test('preserves non-metadata permissions regardless of additional permissions', () => {
const nonMetadataOperations = mockOperationsWithMetadata.filter(
(op) =>
!mockProgAccessData[op.operationId].permissions.some((permSet) => 'metadata' in permSet),
)
expect(nonMetadataOperations).toHaveLength(1)
expect(nonMetadataOperations[0].operationId).toBe('repos/get-content')
// Verify contents permission would be preserved
const contentsPermissionSet = mockProgAccessData['repos/get-content'].permissions[0]
expect('contents' in contentsPermissionSet).toBe(true)
expect('metadata' in contentsPermissionSet).toBe(false)
})
test('handles edge cases in permission sets', () => {
// Empty permission set
expect(shouldFilterMetadataPermission('metadata', [])).toBe(false)
// Permission set with empty object (edge case)
const edgeCase1: Record<string, string>[] = [{ metadata: 'read' }, {}]
expect(shouldFilterMetadataPermission('metadata', edgeCase1)).toBe(true)
// Multiple permission sets with metadata in different sets
const edgeCase2: Record<string, string>[] = [{ metadata: 'read' }, { admin: 'write' }]
expect(shouldFilterMetadataPermission('metadata', edgeCase2)).toBe(true)
})
test('filters metadata permissions that match the GitHub issue examples', () => {
// These are examples from the GitHub issue that should be filtered out
// PUT /orgs/{org}/actions/permissions/repositories/{repository_id}
const putActionsPermissions = [{ metadata: 'read', organization_administration: 'write' }]
// DELETE /orgs/{org}/actions/permissions/repositories/{repository_id}
const deleteActionsPermissions = [{ metadata: 'read', organization_administration: 'write' }]
// These should be filtered out because they have metadata + additional permissions
expect(shouldFilterMetadataPermission('metadata', putActionsPermissions)).toBe(true)
expect(shouldFilterMetadataPermission('metadata', deleteActionsPermissions)).toBe(true)
// But the organization_administration permissions should NOT be filtered
expect(
shouldFilterMetadataPermission('organization_administration', putActionsPermissions),
).toBe(false)
expect(
shouldFilterMetadataPermission('organization_administration', deleteActionsPermissions),
).toBe(false)
})
test('preserves metadata permissions that are standalone', () => {
// Example of a metadata-only permission that should be preserved
const metadataOnlyPermissions = [{ metadata: 'read' }]
// This should NOT be filtered out
expect(shouldFilterMetadataPermission('metadata', metadataOnlyPermissions)).toBe(false)
})
test('handles complex permission structures from real data', () => {
// Multiple permission sets (should filter metadata)
const multiplePermissionSets: Record<string, string>[] = [
{ metadata: 'read' },
{ administration: 'write' },
]
expect(shouldFilterMetadataPermission('metadata', multiplePermissionSets)).toBe(true)
// Single permission set with multiple permissions (should filter metadata)
const multiplePermissionsInSet: Record<string, string>[] = [
{ metadata: 'read', contents: 'write', pull_requests: 'write' },
]
expect(shouldFilterMetadataPermission('metadata', multiplePermissionsInSet)).toBe(true)
// Multiple permission sets where metadata is not in the first set
const metadataInSecondSet: Record<string, string>[] = [
{ administration: 'write' },
{ metadata: 'read' },
]
expect(shouldFilterMetadataPermission('metadata', metadataInSecondSet)).toBe(true)
})
test('validates filtering logic against known problematic endpoints', () => {
// Based on the issue description, these types of operations should have
// their metadata permissions filtered out:
// Runner group operations
const runnerGroupPermissions = [{ metadata: 'read', organization_administration: 'write' }]
// Organization secrets operations
const orgSecretsPermissions = [{ metadata: 'read', organization_secrets: 'write' }]
// Repository operations with admin permissions
const repoAdminPermissions = [{ metadata: 'read', administration: 'write' }]
// All of these should filter out metadata
expect(shouldFilterMetadataPermission('metadata', runnerGroupPermissions)).toBe(true)
expect(shouldFilterMetadataPermission('metadata', orgSecretsPermissions)).toBe(true)
expect(shouldFilterMetadataPermission('metadata', repoAdminPermissions)).toBe(true)
// But should preserve the actual required permissions
expect(
shouldFilterMetadataPermission('organization_administration', runnerGroupPermissions),
).toBe(false)
expect(shouldFilterMetadataPermission('organization_secrets', orgSecretsPermissions)).toBe(
false,
)
expect(shouldFilterMetadataPermission('administration', repoAdminPermissions)).toBe(false)
})
test('verifies consistency with additional-permissions flag calculation', () => {
const testCases: Array<{ permissionSets: Record<string, string>[]; expected: boolean }> = [
// Single permission, single set - no additional permissions
{ permissionSets: [{ metadata: 'read' }], expected: false },
// Multiple permissions, single set - has additional permissions
{ permissionSets: [{ metadata: 'read', admin: 'write' }], expected: true },
// Single permission, multiple sets - has additional permissions
{ permissionSets: [{ metadata: 'read' }, { admin: 'write' }], expected: true },
// Multiple permissions, multiple sets - has additional permissions
{
permissionSets: [{ metadata: 'read', contents: 'read' }, { admin: 'write' }],
expected: true,
},
]
for (const testCase of testCases) {
const additionalPermissions = calculateAdditionalPermissions(testCase.permissionSets)
const shouldFilter = shouldFilterMetadataPermission('metadata', testCase.permissionSets)
// The filtering logic should match the additional permissions calculation
expect(shouldFilter).toBe(additionalPermissions)
expect(additionalPermissions).toBe(testCase.expected)
}
})
test('validates filtering logic matches expected behavior from issue', () => {
// Based on the GitHub issue, these operations should be filtered out from metadata:
// - PUT /orgs/{org}/actions/permissions/repositories/{repository_id}
// - DELETE /orgs/{org}/actions/permissions/repositories/{repository_id}
// Because they have metadata + organization_administration permissions
const progData: ProgAccessData = {
userToServerRest: true,
serverToServer: true,
permissions: [{ metadata: 'read', organization_administration: 'write' }],
}
// This should be filtered out from metadata permissions
expect(shouldFilterMetadataPermission('metadata', progData.permissions)).toBe(true)
// But organization_administration permission should still be included
expect(
shouldFilterMetadataPermission('organization_administration', progData.permissions),
).toBe(false)
// Verify additional permissions flag is set correctly
expect(calculateAdditionalPermissions(progData.permissions)).toBe(true)
})
})