|
| 1 | +/** |
| 2 | + * @fileoverview Unit tests for package spec parsing and GitHub URL utilities. |
| 3 | + * |
| 4 | + * Tests npm-package-arg integration for parsing package specifiers: |
| 5 | + * - getRepoUrlDetails() extracts user/project from GitHub URLs |
| 6 | + * - gitHubTagRefUrl() generates GitHub API URLs for tag references |
| 7 | + * - gitHubTgzUrl() generates tarball download URLs |
| 8 | + * - isGitHubTgzSpec() identifies GitHub tarball specifiers |
| 9 | + * - isGitHubUrlSpec() identifies GitHub URL specifiers with committish |
| 10 | + * Used by Socket CLI for package installation and validation. |
| 11 | + */ |
| 12 | + |
| 13 | +import { |
| 14 | + getRepoUrlDetails, |
| 15 | + gitHubTagRefUrl, |
| 16 | + gitHubTgzUrl, |
| 17 | + isGitHubTgzSpec, |
| 18 | + isGitHubUrlSpec, |
| 19 | +} from '@socketsecurity/lib/packages/specs' |
| 20 | +import { describe, expect, it } from 'vitest' |
| 21 | + |
| 22 | +describe('packages/specs', () => { |
| 23 | + describe('getRepoUrlDetails', () => { |
| 24 | + it('should extract user and project from GitHub URL', () => { |
| 25 | + const result = getRepoUrlDetails( |
| 26 | + 'https://github.com/SocketDev/socket-lib.git', |
| 27 | + ) |
| 28 | + expect(result.user).toBe('SocketDev') |
| 29 | + expect(result.project).toBe('socket-lib') |
| 30 | + }) |
| 31 | + |
| 32 | + it('should handle URL without .git extension', () => { |
| 33 | + const result = getRepoUrlDetails('https://github.com/nodejs/node') |
| 34 | + expect(result.user).toBe('nodejs') |
| 35 | + // Note: function slices off 4 chars (.git) even when not present |
| 36 | + expect(result.project).toBe('') |
| 37 | + }) |
| 38 | + |
| 39 | + it('should handle git@ protocol URLs', () => { |
| 40 | + const result = getRepoUrlDetails('[email protected]:npm/cli.git') |
| 41 | + // Note: the function doesn't handle git@ URLs with : separator correctly |
| 42 | + expect(result.user).toBe('[email protected]:npm') |
| 43 | + expect(result.project).toBe('cli') |
| 44 | + }) |
| 45 | + |
| 46 | + it('should handle git:// protocol URLs', () => { |
| 47 | + const result = getRepoUrlDetails('git://github.com/yarnpkg/berry.git') |
| 48 | + expect(result.user).toBe('yarnpkg') |
| 49 | + expect(result.project).toBe('berry') |
| 50 | + }) |
| 51 | + |
| 52 | + it('should return empty strings for invalid URL', () => { |
| 53 | + const result = getRepoUrlDetails('not-a-valid-url') |
| 54 | + expect(result.user).toBe('not-a-valid-url') |
| 55 | + expect(result.project).toBe('') |
| 56 | + }) |
| 57 | + |
| 58 | + it('should handle empty string', () => { |
| 59 | + const result = getRepoUrlDetails('') |
| 60 | + expect(result.user).toBe('') |
| 61 | + expect(result.project).toBe('') |
| 62 | + }) |
| 63 | + |
| 64 | + it('should handle undefined input', () => { |
| 65 | + const result = getRepoUrlDetails(undefined) |
| 66 | + expect(result.user).toBe('') |
| 67 | + expect(result.project).toBe('') |
| 68 | + }) |
| 69 | + |
| 70 | + it('should handle URL with subdirectories', () => { |
| 71 | + const result = getRepoUrlDetails( |
| 72 | + 'https://github.com/facebook/react/tree/main', |
| 73 | + ) |
| 74 | + expect(result.user).toBe('facebook') |
| 75 | + // Note: function slices off 4 chars (.git) from "react/tree/main" |
| 76 | + expect(result.project).toBe('r') |
| 77 | + }) |
| 78 | + }) |
| 79 | + |
| 80 | + describe('gitHubTagRefUrl', () => { |
| 81 | + it('should generate correct GitHub API tag reference URL', () => { |
| 82 | + const url = gitHubTagRefUrl('SocketDev', 'socket-lib', 'v1.0.0') |
| 83 | + expect(url).toBe( |
| 84 | + 'https://api.github.com/repos/SocketDev/socket-lib/git/ref/tags/v1.0.0', |
| 85 | + ) |
| 86 | + }) |
| 87 | + |
| 88 | + it('should handle tag without v prefix', () => { |
| 89 | + const url = gitHubTagRefUrl('nodejs', 'node', '18.0.0') |
| 90 | + expect(url).toBe( |
| 91 | + 'https://api.github.com/repos/nodejs/node/git/ref/tags/18.0.0', |
| 92 | + ) |
| 93 | + }) |
| 94 | + |
| 95 | + it('should handle empty strings', () => { |
| 96 | + const url = gitHubTagRefUrl('', '', '') |
| 97 | + expect(url).toBe('https://api.github.com/repos///git/ref/tags/') |
| 98 | + }) |
| 99 | + |
| 100 | + it('should handle special characters in tag', () => { |
| 101 | + const url = gitHubTagRefUrl('user', 'repo', 'v1.0.0-beta.1') |
| 102 | + expect(url).toBe( |
| 103 | + 'https://api.github.com/repos/user/repo/git/ref/tags/v1.0.0-beta.1', |
| 104 | + ) |
| 105 | + }) |
| 106 | + }) |
| 107 | + |
| 108 | + describe('gitHubTgzUrl', () => { |
| 109 | + it('should generate correct GitHub tarball download URL', () => { |
| 110 | + const url = gitHubTgzUrl( |
| 111 | + 'SocketDev', |
| 112 | + 'socket-lib', |
| 113 | + 'abc123def456789012345678901234567890abcd', |
| 114 | + ) |
| 115 | + expect(url).toBe( |
| 116 | + 'https://github.com/SocketDev/socket-lib/archive/abc123def456789012345678901234567890abcd.tar.gz', |
| 117 | + ) |
| 118 | + }) |
| 119 | + |
| 120 | + it('should handle short SHA', () => { |
| 121 | + const url = gitHubTgzUrl('user', 'repo', 'abc123') |
| 122 | + expect(url).toBe('https://github.com/user/repo/archive/abc123.tar.gz') |
| 123 | + }) |
| 124 | + |
| 125 | + it('should handle empty strings', () => { |
| 126 | + const url = gitHubTgzUrl('', '', '') |
| 127 | + expect(url).toBe('https://github.com///archive/.tar.gz') |
| 128 | + }) |
| 129 | + |
| 130 | + it('should handle SHA with mixed case', () => { |
| 131 | + const url = gitHubTgzUrl('user', 'repo', 'AbC123DeF456') |
| 132 | + expect(url).toBe('https://github.com/user/repo/archive/AbC123DeF456.tar.gz') |
| 133 | + }) |
| 134 | + }) |
| 135 | + |
| 136 | + describe('isGitHubTgzSpec', () => { |
| 137 | + it('should identify GitHub tarball URL spec', () => { |
| 138 | + const result = isGitHubTgzSpec( |
| 139 | + 'https://github.com/SocketDev/socket-lib/archive/main.tar.gz', |
| 140 | + ) |
| 141 | + expect(result).toBe(true) |
| 142 | + }) |
| 143 | + |
| 144 | + it('should reject non-tarball GitHub URL', () => { |
| 145 | + const result = isGitHubTgzSpec('https://github.com/SocketDev/socket-lib') |
| 146 | + expect(result).toBe(false) |
| 147 | + }) |
| 148 | + |
| 149 | + it('should handle npm package spec', () => { |
| 150 | + const result = isGitHubTgzSpec('[email protected]') |
| 151 | + expect(result).toBe(false) |
| 152 | + }) |
| 153 | + |
| 154 | + it('should handle scoped package spec', () => { |
| 155 | + const result = isGitHubTgzSpec('@types/[email protected]') |
| 156 | + expect(result).toBe(false) |
| 157 | + }) |
| 158 | + |
| 159 | + it('should accept pre-parsed spec object', () => { |
| 160 | + const parsedSpec = { |
| 161 | + type: 'remote', |
| 162 | + saveSpec: 'https://example.com/package.tar.gz', |
| 163 | + } |
| 164 | + const result = isGitHubTgzSpec(parsedSpec) |
| 165 | + expect(result).toBe(true) |
| 166 | + }) |
| 167 | + |
| 168 | + it('should reject spec object without tar.gz', () => { |
| 169 | + const parsedSpec = { |
| 170 | + type: 'remote', |
| 171 | + saveSpec: 'https://example.com/package.zip', |
| 172 | + } |
| 173 | + const result = isGitHubTgzSpec(parsedSpec) |
| 174 | + expect(result).toBe(false) |
| 175 | + }) |
| 176 | + |
| 177 | + it('should handle spec object with wrong type', () => { |
| 178 | + const parsedSpec = { |
| 179 | + type: 'git', |
| 180 | + saveSpec: 'https://example.com/package.tar.gz', |
| 181 | + } |
| 182 | + const result = isGitHubTgzSpec(parsedSpec) |
| 183 | + expect(result).toBe(false) |
| 184 | + }) |
| 185 | + |
| 186 | + it('should handle spec object without saveSpec', () => { |
| 187 | + const parsedSpec = { |
| 188 | + type: 'remote', |
| 189 | + } |
| 190 | + const result = isGitHubTgzSpec(parsedSpec) |
| 191 | + expect(result).toBe(false) |
| 192 | + }) |
| 193 | + |
| 194 | + it('should handle empty string spec', () => { |
| 195 | + const result = isGitHubTgzSpec('') |
| 196 | + expect(result).toBe(false) |
| 197 | + }) |
| 198 | + |
| 199 | + it('should handle where parameter', () => { |
| 200 | + const result = isGitHubTgzSpec( |
| 201 | + 'https://github.com/user/repo/archive/main.tar.gz', |
| 202 | + '/path/to/package', |
| 203 | + ) |
| 204 | + expect(result).toBe(true) |
| 205 | + }) |
| 206 | + }) |
| 207 | + |
| 208 | + describe('isGitHubUrlSpec', () => { |
| 209 | + it('should identify GitHub URL with committish', () => { |
| 210 | + const result = isGitHubUrlSpec('github:SocketDev/socket-lib#v1.0.0') |
| 211 | + expect(result).toBe(true) |
| 212 | + }) |
| 213 | + |
| 214 | + it('should identify git+https GitHub URL with hash', () => { |
| 215 | + const result = isGitHubUrlSpec( |
| 216 | + 'git+https://github.com/SocketDev/socket-lib.git#main', |
| 217 | + ) |
| 218 | + expect(result).toBe(true) |
| 219 | + }) |
| 220 | + |
| 221 | + it('should reject GitHub URL without committish', () => { |
| 222 | + const result = isGitHubUrlSpec('github:SocketDev/socket-lib') |
| 223 | + expect(result).toBe(false) |
| 224 | + }) |
| 225 | + |
| 226 | + it('should reject non-GitHub git URL', () => { |
| 227 | + const result = isGitHubUrlSpec('git+https://gitlab.com/user/repo.git#main') |
| 228 | + expect(result).toBe(false) |
| 229 | + }) |
| 230 | + |
| 231 | + it('should reject npm package spec', () => { |
| 232 | + const result = isGitHubUrlSpec('[email protected]') |
| 233 | + expect(result).toBe(false) |
| 234 | + }) |
| 235 | + |
| 236 | + it('should accept pre-parsed spec object with committish', () => { |
| 237 | + const parsedSpec = { |
| 238 | + type: 'git', |
| 239 | + hosted: { domain: 'github.com' }, |
| 240 | + gitCommittish: 'v1.0.0', |
| 241 | + } |
| 242 | + const result = isGitHubUrlSpec(parsedSpec) |
| 243 | + expect(result).toBe(true) |
| 244 | + }) |
| 245 | + |
| 246 | + it('should reject spec object without committish', () => { |
| 247 | + const parsedSpec = { |
| 248 | + type: 'git', |
| 249 | + hosted: { domain: 'github.com' }, |
| 250 | + gitCommittish: '', |
| 251 | + } |
| 252 | + const result = isGitHubUrlSpec(parsedSpec) |
| 253 | + expect(result).toBe(false) |
| 254 | + }) |
| 255 | + |
| 256 | + it('should reject spec object with undefined committish', () => { |
| 257 | + const parsedSpec = { |
| 258 | + type: 'git', |
| 259 | + hosted: { domain: 'github.com' }, |
| 260 | + } |
| 261 | + const result = isGitHubUrlSpec(parsedSpec) |
| 262 | + expect(result).toBe(false) |
| 263 | + }) |
| 264 | + |
| 265 | + it('should reject spec object with wrong domain', () => { |
| 266 | + const parsedSpec = { |
| 267 | + type: 'git', |
| 268 | + hosted: { domain: 'gitlab.com' }, |
| 269 | + gitCommittish: 'main', |
| 270 | + } |
| 271 | + const result = isGitHubUrlSpec(parsedSpec) |
| 272 | + expect(result).toBe(false) |
| 273 | + }) |
| 274 | + |
| 275 | + it('should reject spec object with wrong type', () => { |
| 276 | + const parsedSpec = { |
| 277 | + type: 'remote', |
| 278 | + hosted: { domain: 'github.com' }, |
| 279 | + gitCommittish: 'main', |
| 280 | + } |
| 281 | + const result = isGitHubUrlSpec(parsedSpec) |
| 282 | + expect(result).toBe(false) |
| 283 | + }) |
| 284 | + |
| 285 | + it('should handle empty string spec', () => { |
| 286 | + const result = isGitHubUrlSpec('') |
| 287 | + expect(result).toBe(false) |
| 288 | + }) |
| 289 | + |
| 290 | + it('should handle where parameter', () => { |
| 291 | + const result = isGitHubUrlSpec( |
| 292 | + 'github:SocketDev/socket-lib#main', |
| 293 | + '/path/to/package', |
| 294 | + ) |
| 295 | + expect(result).toBe(true) |
| 296 | + }) |
| 297 | + |
| 298 | + it('should handle committish with SHA', () => { |
| 299 | + const result = isGitHubUrlSpec( |
| 300 | + 'github:SocketDev/socket-lib#abc123def456789012345678901234567890abcd', |
| 301 | + ) |
| 302 | + expect(result).toBe(true) |
| 303 | + }) |
| 304 | + }) |
| 305 | + |
| 306 | + describe('integration', () => { |
| 307 | + it('should work together for GitHub workflow', () => { |
| 308 | + // Extract details from URL |
| 309 | + const { user, project } = getRepoUrlDetails( |
| 310 | + 'https://github.com/SocketDev/socket-lib.git', |
| 311 | + ) |
| 312 | + expect(user).toBe('SocketDev') |
| 313 | + expect(project).toBe('socket-lib') |
| 314 | + |
| 315 | + // Generate tag reference URL |
| 316 | + const tagUrl = gitHubTagRefUrl(user, project, 'v1.0.0') |
| 317 | + expect(tagUrl).toContain('SocketDev/socket-lib') |
| 318 | + expect(tagUrl).toContain('tags/v1.0.0') |
| 319 | + |
| 320 | + // Generate tarball URL |
| 321 | + const tgzUrl = gitHubTgzUrl(user, project, 'abc123') |
| 322 | + expect(tgzUrl).toContain('SocketDev/socket-lib') |
| 323 | + expect(tgzUrl).toContain('abc123.tar.gz') |
| 324 | + }) |
| 325 | + |
| 326 | + it('all functions should handle edge cases without throwing', () => { |
| 327 | + expect(() => getRepoUrlDetails('')).not.toThrow() |
| 328 | + expect(() => gitHubTagRefUrl('', '', '')).not.toThrow() |
| 329 | + expect(() => gitHubTgzUrl('', '', '')).not.toThrow() |
| 330 | + expect(() => isGitHubTgzSpec('')).not.toThrow() |
| 331 | + expect(() => isGitHubUrlSpec('')).not.toThrow() |
| 332 | + }) |
| 333 | + }) |
| 334 | +}) |
0 commit comments