|
| 1 | +import { describe, it, expect, beforeEach, vi } from "vitest"; |
| 2 | + |
| 3 | +describe("check_membership.cjs", () => { |
| 4 | + let mockCore; |
| 5 | + let mockGithub; |
| 6 | + let mockContext; |
| 7 | + let checkMembershipScript; |
| 8 | + |
| 9 | + beforeEach(() => { |
| 10 | + // Mock core actions methods |
| 11 | + mockCore = { |
| 12 | + debug: vi.fn(), |
| 13 | + info: vi.fn(), |
| 14 | + warning: vi.fn(), |
| 15 | + error: vi.fn(), |
| 16 | + setFailed: vi.fn(), |
| 17 | + setOutput: vi.fn(), |
| 18 | + summary: { |
| 19 | + addRaw: vi.fn().mockReturnThis(), |
| 20 | + write: vi.fn().mockResolvedValue(), |
| 21 | + }, |
| 22 | + }; |
| 23 | + |
| 24 | + // Mock GitHub API |
| 25 | + mockGithub = { |
| 26 | + rest: { |
| 27 | + repos: { |
| 28 | + getCollaboratorPermissionLevel: vi.fn(), |
| 29 | + }, |
| 30 | + }, |
| 31 | + }; |
| 32 | + |
| 33 | + // Mock context |
| 34 | + mockContext = { |
| 35 | + eventName: "issues", |
| 36 | + actor: "testuser", |
| 37 | + repo: { |
| 38 | + owner: "testorg", |
| 39 | + repo: "testrepo", |
| 40 | + }, |
| 41 | + }; |
| 42 | + |
| 43 | + global.core = mockCore; |
| 44 | + global.github = mockGithub; |
| 45 | + global.context = mockContext; |
| 46 | + }); |
| 47 | + |
| 48 | + afterEach(() => { |
| 49 | + delete global.core; |
| 50 | + delete global.github; |
| 51 | + delete global.context; |
| 52 | + delete process.env.GH_AW_REQUIRED_ROLES; |
| 53 | + }); |
| 54 | + |
| 55 | + const runScript = async () => { |
| 56 | + const fs = await import("fs"); |
| 57 | + const path = await import("path"); |
| 58 | + const scriptPath = path.join(import.meta.dirname, "check_membership.cjs"); |
| 59 | + const scriptContent = fs.readFileSync(scriptPath, "utf8"); |
| 60 | + |
| 61 | + // Remove the main() call at the end and execute |
| 62 | + const scriptWithoutMain = scriptContent.replace("await main();", ""); |
| 63 | + const scriptFunction = new Function("core", "github", "context", "process", scriptWithoutMain + "\nreturn main();"); |
| 64 | + await scriptFunction(mockCore, mockGithub, mockContext, process); |
| 65 | + }; |
| 66 | + |
| 67 | + describe("safe events", () => { |
| 68 | + it("should skip check for workflow_run events", async () => { |
| 69 | + mockContext.eventName = "workflow_run"; |
| 70 | + await runScript(); |
| 71 | + |
| 72 | + expect(mockCore.info).toHaveBeenCalledWith("✅ Event workflow_run does not require validation"); |
| 73 | + expect(mockCore.setOutput).toHaveBeenCalledWith("is_team_member", "true"); |
| 74 | + expect(mockCore.setOutput).toHaveBeenCalledWith("result", "safe_event"); |
| 75 | + }); |
| 76 | + |
| 77 | + it("should skip check for schedule events", async () => { |
| 78 | + mockContext.eventName = "schedule"; |
| 79 | + await runScript(); |
| 80 | + |
| 81 | + expect(mockCore.info).toHaveBeenCalledWith("✅ Event schedule does not require validation"); |
| 82 | + expect(mockCore.setOutput).toHaveBeenCalledWith("is_team_member", "true"); |
| 83 | + expect(mockCore.setOutput).toHaveBeenCalledWith("result", "safe_event"); |
| 84 | + }); |
| 85 | + |
| 86 | + it("should skip check for workflow_dispatch when write role is allowed", async () => { |
| 87 | + mockContext.eventName = "workflow_dispatch"; |
| 88 | + process.env.GH_AW_REQUIRED_ROLES = "write,read"; |
| 89 | + |
| 90 | + await runScript(); |
| 91 | + |
| 92 | + expect(mockCore.info).toHaveBeenCalledWith("✅ Event workflow_dispatch does not require validation (write role allowed)"); |
| 93 | + expect(mockCore.setOutput).toHaveBeenCalledWith("is_team_member", "true"); |
| 94 | + expect(mockCore.setOutput).toHaveBeenCalledWith("result", "safe_event"); |
| 95 | + }); |
| 96 | + |
| 97 | + it("should validate workflow_dispatch when write role is not allowed", async () => { |
| 98 | + mockContext.eventName = "workflow_dispatch"; |
| 99 | + process.env.GH_AW_REQUIRED_ROLES = "admin,maintainer"; |
| 100 | + |
| 101 | + mockGithub.rest.repos.getCollaboratorPermissionLevel.mockResolvedValue({ |
| 102 | + data: { permission: "admin" }, |
| 103 | + }); |
| 104 | + |
| 105 | + await runScript(); |
| 106 | + |
| 107 | + expect(mockCore.info).toHaveBeenCalledWith("Event workflow_dispatch requires validation (write role not allowed)"); |
| 108 | + expect(mockGithub.rest.repos.getCollaboratorPermissionLevel).toHaveBeenCalled(); |
| 109 | + }); |
| 110 | + }); |
| 111 | + |
| 112 | + describe("configuration validation", () => { |
| 113 | + it("should fail when no required permissions are specified", async () => { |
| 114 | + delete process.env.GH_AW_REQUIRED_ROLES; |
| 115 | + |
| 116 | + await runScript(); |
| 117 | + |
| 118 | + expect(mockCore.warning).toHaveBeenCalledWith( |
| 119 | + "❌ Configuration error: Required permissions not specified. Contact repository administrator." |
| 120 | + ); |
| 121 | + expect(mockCore.setOutput).toHaveBeenCalledWith("is_team_member", "false"); |
| 122 | + expect(mockCore.setOutput).toHaveBeenCalledWith("result", "config_error"); |
| 123 | + expect(mockCore.setOutput).toHaveBeenCalledWith("error_message", "Configuration error: Required permissions not specified"); |
| 124 | + }); |
| 125 | + |
| 126 | + it("should fail when required permissions is empty string", async () => { |
| 127 | + process.env.GH_AW_REQUIRED_ROLES = ""; |
| 128 | + |
| 129 | + await runScript(); |
| 130 | + |
| 131 | + expect(mockCore.warning).toHaveBeenCalledWith( |
| 132 | + "❌ Configuration error: Required permissions not specified. Contact repository administrator." |
| 133 | + ); |
| 134 | + expect(mockCore.setOutput).toHaveBeenCalledWith("is_team_member", "false"); |
| 135 | + expect(mockCore.setOutput).toHaveBeenCalledWith("result", "config_error"); |
| 136 | + }); |
| 137 | + |
| 138 | + it("should filter out empty permission values", async () => { |
| 139 | + process.env.GH_AW_REQUIRED_ROLES = "admin, , write, "; |
| 140 | + |
| 141 | + mockGithub.rest.repos.getCollaboratorPermissionLevel.mockResolvedValue({ |
| 142 | + data: { permission: "admin" }, |
| 143 | + }); |
| 144 | + |
| 145 | + await runScript(); |
| 146 | + |
| 147 | + // Check that the log contains filtered permissions (note: there's no trimming of the space after comma in actual code) |
| 148 | + expect(mockCore.info).toHaveBeenCalled(); |
| 149 | + const logCalls = mockCore.info.mock.calls.map(call => call[0]); |
| 150 | + const permissionsLog = logCalls.find(log => log.includes("Required permissions:")); |
| 151 | + expect(permissionsLog).toBeTruthy(); |
| 152 | + }); |
| 153 | + }); |
| 154 | + |
| 155 | + describe("permission checks", () => { |
| 156 | + beforeEach(() => { |
| 157 | + process.env.GH_AW_REQUIRED_ROLES = "admin,write"; |
| 158 | + }); |
| 159 | + |
| 160 | + it("should authorize user with exact permission match", async () => { |
| 161 | + mockGithub.rest.repos.getCollaboratorPermissionLevel.mockResolvedValue({ |
| 162 | + data: { permission: "admin" }, |
| 163 | + }); |
| 164 | + |
| 165 | + await runScript(); |
| 166 | + |
| 167 | + expect(mockCore.info).toHaveBeenCalledWith("Checking if user 'testuser' has required permissions for testorg/testrepo"); |
| 168 | + expect(mockCore.info).toHaveBeenCalledWith("Required permissions: admin, write"); |
| 169 | + expect(mockCore.info).toHaveBeenCalledWith("Repository permission level: admin"); |
| 170 | + expect(mockCore.info).toHaveBeenCalledWith("✅ User has admin access to repository"); |
| 171 | + expect(mockCore.setOutput).toHaveBeenCalledWith("is_team_member", "true"); |
| 172 | + expect(mockCore.setOutput).toHaveBeenCalledWith("result", "authorized"); |
| 173 | + expect(mockCore.setOutput).toHaveBeenCalledWith("user_permission", "admin"); |
| 174 | + }); |
| 175 | + |
| 176 | + it("should handle maintainer/maintain alias", async () => { |
| 177 | + process.env.GH_AW_REQUIRED_ROLES = "maintainer"; |
| 178 | + |
| 179 | + mockGithub.rest.repos.getCollaboratorPermissionLevel.mockResolvedValue({ |
| 180 | + data: { permission: "maintain" }, |
| 181 | + }); |
| 182 | + |
| 183 | + await runScript(); |
| 184 | + |
| 185 | + expect(mockCore.info).toHaveBeenCalledWith("✅ User has maintain access to repository"); |
| 186 | + expect(mockCore.setOutput).toHaveBeenCalledWith("is_team_member", "true"); |
| 187 | + expect(mockCore.setOutput).toHaveBeenCalledWith("result", "authorized"); |
| 188 | + expect(mockCore.setOutput).toHaveBeenCalledWith("user_permission", "maintain"); |
| 189 | + }); |
| 190 | + |
| 191 | + it("should deny user with insufficient permissions", async () => { |
| 192 | + mockGithub.rest.repos.getCollaboratorPermissionLevel.mockResolvedValue({ |
| 193 | + data: { permission: "read" }, |
| 194 | + }); |
| 195 | + |
| 196 | + await runScript(); |
| 197 | + |
| 198 | + expect(mockCore.warning).toHaveBeenCalledWith("User permission 'read' does not meet requirements: admin, write"); |
| 199 | + expect(mockCore.setOutput).toHaveBeenCalledWith("is_team_member", "false"); |
| 200 | + expect(mockCore.setOutput).toHaveBeenCalledWith("result", "insufficient_permissions"); |
| 201 | + expect(mockCore.setOutput).toHaveBeenCalledWith("user_permission", "read"); |
| 202 | + expect(mockCore.setOutput).toHaveBeenCalledWith( |
| 203 | + "error_message", |
| 204 | + "Access denied: User 'testuser' is not authorized. Required permissions: admin, write" |
| 205 | + ); |
| 206 | + }); |
| 207 | + |
| 208 | + it("should authorize user with write permission when write is in allowed list", async () => { |
| 209 | + mockGithub.rest.repos.getCollaboratorPermissionLevel.mockResolvedValue({ |
| 210 | + data: { permission: "write" }, |
| 211 | + }); |
| 212 | + |
| 213 | + await runScript(); |
| 214 | + |
| 215 | + expect(mockCore.info).toHaveBeenCalledWith("✅ User has write access to repository"); |
| 216 | + expect(mockCore.setOutput).toHaveBeenCalledWith("is_team_member", "true"); |
| 217 | + expect(mockCore.setOutput).toHaveBeenCalledWith("result", "authorized"); |
| 218 | + }); |
| 219 | + }); |
| 220 | + |
| 221 | + describe("API error handling", () => { |
| 222 | + beforeEach(() => { |
| 223 | + process.env.GH_AW_REQUIRED_ROLES = "admin"; |
| 224 | + }); |
| 225 | + |
| 226 | + it("should handle API errors gracefully", async () => { |
| 227 | + const apiError = new Error("API rate limit exceeded"); |
| 228 | + mockGithub.rest.repos.getCollaboratorPermissionLevel.mockRejectedValue(apiError); |
| 229 | + |
| 230 | + await runScript(); |
| 231 | + |
| 232 | + expect(mockCore.warning).toHaveBeenCalledWith("Repository permission check failed: API rate limit exceeded"); |
| 233 | + expect(mockCore.setOutput).toHaveBeenCalledWith("is_team_member", "false"); |
| 234 | + expect(mockCore.setOutput).toHaveBeenCalledWith("result", "api_error"); |
| 235 | + expect(mockCore.setOutput).toHaveBeenCalledWith("error_message", "Repository permission check failed: API rate limit exceeded"); |
| 236 | + }); |
| 237 | + |
| 238 | + it("should handle non-Error API failures", async () => { |
| 239 | + mockGithub.rest.repos.getCollaboratorPermissionLevel.mockRejectedValue("String error"); |
| 240 | + |
| 241 | + await runScript(); |
| 242 | + |
| 243 | + expect(mockCore.warning).toHaveBeenCalledWith("Repository permission check failed: String error"); |
| 244 | + expect(mockCore.setOutput).toHaveBeenCalledWith("is_team_member", "false"); |
| 245 | + expect(mockCore.setOutput).toHaveBeenCalledWith("result", "api_error"); |
| 246 | + }); |
| 247 | + |
| 248 | + it("should handle network errors", async () => { |
| 249 | + const networkError = new Error("Network request failed"); |
| 250 | + mockGithub.rest.repos.getCollaboratorPermissionLevel.mockRejectedValue(networkError); |
| 251 | + |
| 252 | + await runScript(); |
| 253 | + |
| 254 | + expect(mockCore.warning).toHaveBeenCalledWith("Repository permission check failed: Network request failed"); |
| 255 | + expect(mockCore.setOutput).toHaveBeenCalledWith("result", "api_error"); |
| 256 | + }); |
| 257 | + }); |
| 258 | + |
| 259 | + describe("multiple permission levels", () => { |
| 260 | + it("should check multiple permission levels in order", async () => { |
| 261 | + process.env.GH_AW_REQUIRED_ROLES = "admin,maintainer,write"; |
| 262 | + |
| 263 | + mockGithub.rest.repos.getCollaboratorPermissionLevel.mockResolvedValue({ |
| 264 | + data: { permission: "write" }, |
| 265 | + }); |
| 266 | + |
| 267 | + await runScript(); |
| 268 | + |
| 269 | + expect(mockCore.setOutput).toHaveBeenCalledWith("is_team_member", "true"); |
| 270 | + expect(mockCore.setOutput).toHaveBeenCalledWith("result", "authorized"); |
| 271 | + expect(mockCore.setOutput).toHaveBeenCalledWith("user_permission", "write"); |
| 272 | + }); |
| 273 | + |
| 274 | + it("should stop checking after first match", async () => { |
| 275 | + process.env.GH_AW_REQUIRED_ROLES = "write,read"; |
| 276 | + |
| 277 | + mockGithub.rest.repos.getCollaboratorPermissionLevel.mockResolvedValue({ |
| 278 | + data: { permission: "write" }, |
| 279 | + }); |
| 280 | + |
| 281 | + await runScript(); |
| 282 | + |
| 283 | + expect(mockCore.info).toHaveBeenCalledWith("✅ User has write access to repository"); |
| 284 | + }); |
| 285 | + }); |
| 286 | +}); |
0 commit comments