|
| 1 | +import { execFileSync } from 'child_process'; |
| 2 | +import * as fs from 'fs'; |
| 3 | +import * as os from 'os'; |
| 4 | +import * as path from 'path'; |
| 5 | + |
| 6 | +import { changedSqlFiles, resolveChangedBase } from '../src'; |
| 7 | + |
| 8 | +const CLEAN = `CREATE SCHEMA app_public; |
| 9 | +CREATE FUNCTION app_public.clean() RETURNS int LANGUAGE sql AS $$ SELECT 1 $$; |
| 10 | +`; |
| 11 | + |
| 12 | +function git(cwd: string, ...args: string[]): void { |
| 13 | + execFileSync('git', args, { cwd, stdio: 'ignore' }); |
| 14 | +} |
| 15 | + |
| 16 | +/** A throwaway repo with one commit on `main`. */ |
| 17 | +function repo(): string { |
| 18 | + const dir = fs.realpathSync(fs.mkdtempSync(path.join(os.tmpdir(), 'pgsql-lint-git-'))); |
| 19 | + git(dir, 'init', '-q', '-b', 'main'); |
| 20 | + git(dir, 'config', 'user.email', 'test@example.com'); |
| 21 | + git(dir, 'config', 'user.name', 'test'); |
| 22 | + fs.writeFileSync(path.join(dir, 'base.sql'), CLEAN); |
| 23 | + git(dir, 'add', '.'); |
| 24 | + git(dir, 'commit', '-qm', 'base'); |
| 25 | + return dir; |
| 26 | +} |
| 27 | + |
| 28 | +describe('changedSqlFiles', () => { |
| 29 | + const saved = process.env.GITHUB_BASE_REF; |
| 30 | + beforeEach(() => { |
| 31 | + delete process.env.GITHUB_BASE_REF; |
| 32 | + }); |
| 33 | + afterAll(() => { |
| 34 | + if (saved === undefined) delete process.env.GITHUB_BASE_REF; |
| 35 | + else process.env.GITHUB_BASE_REF = saved; |
| 36 | + }); |
| 37 | + |
| 38 | + it('returns nothing when the branch changed no SQL', () => { |
| 39 | + const dir = repo(); |
| 40 | + expect(changedSqlFiles({ cwd: dir, base: 'main' }).files).toEqual([]); |
| 41 | + }); |
| 42 | + |
| 43 | + it('finds committed .sql changes against the merge base', () => { |
| 44 | + const dir = repo(); |
| 45 | + git(dir, 'checkout', '-q', '-b', 'feature'); |
| 46 | + fs.writeFileSync(path.join(dir, 'added.sql'), CLEAN); |
| 47 | + git(dir, 'add', '.'); |
| 48 | + git(dir, 'commit', '-qm', 'add sql'); |
| 49 | + |
| 50 | + const result = changedSqlFiles({ cwd: dir, base: 'main' }); |
| 51 | + expect(result.files).toEqual([path.join(dir, 'added.sql')]); |
| 52 | + expect(result.base).toBe('main'); |
| 53 | + expect(result.mergeBase).toMatch(/^[0-9a-f]{40}$/); |
| 54 | + }); |
| 55 | + |
| 56 | + it('ignores commits made on the base branch after the merge base', () => { |
| 57 | + const dir = repo(); |
| 58 | + git(dir, 'checkout', '-q', '-b', 'feature'); |
| 59 | + fs.writeFileSync(path.join(dir, 'added.sql'), CLEAN); |
| 60 | + git(dir, 'add', '.'); |
| 61 | + git(dir, 'commit', '-qm', 'add sql'); |
| 62 | + |
| 63 | + git(dir, 'checkout', '-q', 'main'); |
| 64 | + fs.writeFileSync(path.join(dir, 'unrelated.sql'), CLEAN); |
| 65 | + git(dir, 'add', '.'); |
| 66 | + git(dir, 'commit', '-qm', 'other work on main'); |
| 67 | + git(dir, 'checkout', '-q', 'feature'); |
| 68 | + |
| 69 | + expect(changedSqlFiles({ cwd: dir, base: 'main' }).files).toEqual([ |
| 70 | + path.join(dir, 'added.sql') |
| 71 | + ]); |
| 72 | + }); |
| 73 | + |
| 74 | + it('includes uncommitted and untracked files', () => { |
| 75 | + const dir = repo(); |
| 76 | + fs.writeFileSync(path.join(dir, 'untracked.sql'), CLEAN); |
| 77 | + fs.appendFileSync(path.join(dir, 'base.sql'), '\n-- edited\n'); |
| 78 | + |
| 79 | + expect(changedSqlFiles({ cwd: dir, base: 'main' }).files).toEqual([ |
| 80 | + path.join(dir, 'base.sql'), |
| 81 | + path.join(dir, 'untracked.sql') |
| 82 | + ]); |
| 83 | + }); |
| 84 | + |
| 85 | + it('drops deleted and renamed-away paths', () => { |
| 86 | + const dir = repo(); |
| 87 | + git(dir, 'checkout', '-q', '-b', 'feature'); |
| 88 | + git(dir, 'mv', 'base.sql', 'moved.sql'); |
| 89 | + git(dir, 'commit', '-qm', 'move'); |
| 90 | + |
| 91 | + const files = changedSqlFiles({ cwd: dir, base: 'main' }).files; |
| 92 | + expect(files).toEqual([path.join(dir, 'moved.sql')]); |
| 93 | + }); |
| 94 | + |
| 95 | + it('filters out non-SQL changes', () => { |
| 96 | + const dir = repo(); |
| 97 | + fs.writeFileSync(path.join(dir, 'notes.md'), '# hi\n'); |
| 98 | + expect(changedSqlFiles({ cwd: dir, base: 'main' }).files).toEqual([]); |
| 99 | + }); |
| 100 | + |
| 101 | + it('falls back to the working-tree diff when the base does not exist', () => { |
| 102 | + const dir = repo(); |
| 103 | + fs.writeFileSync(path.join(dir, 'untracked.sql'), CLEAN); |
| 104 | + const result = changedSqlFiles({ cwd: dir, base: 'origin/does-not-exist' }); |
| 105 | + expect(result.mergeBase).toBeUndefined(); |
| 106 | + expect(result.files).toEqual([path.join(dir, 'untracked.sql')]); |
| 107 | + }); |
| 108 | + |
| 109 | + it('throws outside a git repository', () => { |
| 110 | + const dir = fs.mkdtempSync(path.join(os.tmpdir(), 'pgsql-lint-nogit-')); |
| 111 | + expect(() => changedSqlFiles({ cwd: dir })).toThrow(/needs a git repository/); |
| 112 | + }); |
| 113 | +}); |
| 114 | + |
| 115 | +describe('resolveChangedBase', () => { |
| 116 | + const saved = process.env.GITHUB_BASE_REF; |
| 117 | + afterEach(() => { |
| 118 | + if (saved === undefined) delete process.env.GITHUB_BASE_REF; |
| 119 | + else process.env.GITHUB_BASE_REF = saved; |
| 120 | + }); |
| 121 | + |
| 122 | + it('prefers an explicit base', () => { |
| 123 | + process.env.GITHUB_BASE_REF = 'develop'; |
| 124 | + expect(resolveChangedBase('release/1.0', repo())).toBe('release/1.0'); |
| 125 | + }); |
| 126 | + |
| 127 | + it('uses the PR base branch in CI, unprefixed when no remote has it', () => { |
| 128 | + process.env.GITHUB_BASE_REF = 'develop'; |
| 129 | + expect(resolveChangedBase(undefined, repo())).toBe('develop'); |
| 130 | + }); |
| 131 | + |
| 132 | + it('falls back to the repository default branch', () => { |
| 133 | + delete process.env.GITHUB_BASE_REF; |
| 134 | + expect(resolveChangedBase(undefined, repo())).toBe('main'); |
| 135 | + }); |
| 136 | +}); |
0 commit comments