|
| 1 | +import { |
| 2 | + describe, |
| 3 | + it, |
| 4 | + expect |
| 5 | +} from 'vitest' |
| 6 | +import { |
| 7 | + SET_OPTION_COMMAND, |
| 8 | + SET_PREAMBLE_COMMAND, |
| 9 | + isCommandComment, |
| 10 | + parseSetPreambleComment, |
| 11 | + parseSetOptionsComment |
| 12 | +} from './comment.js' |
| 13 | + |
| 14 | +const owner = 'OWNER' |
| 15 | + |
| 16 | +describe('github-action', () => { |
| 17 | + describe('comment', () => { |
| 18 | + describe('parseSetPreambleComment', () => { |
| 19 | + it('should parse a global preamble', () => { |
| 20 | + expect(parseSetPreambleComment({ |
| 21 | + author_association: owner, |
| 22 | + body: `${SET_PREAMBLE_COMMAND}\n\n## What's new?\n\n- x` |
| 23 | + })).toEqual({ |
| 24 | + name: undefined, |
| 25 | + preamble: '## What\'s new?\n\n- x' |
| 26 | + }) |
| 27 | + }) |
| 28 | + |
| 29 | + it('should parse a package-scoped preamble by full name', () => { |
| 30 | + expect(parseSetPreambleComment({ |
| 31 | + author_association: owner, |
| 32 | + body: `${SET_PREAMBLE_COMMAND} @org/core\n\n## Core\n\n- y` |
| 33 | + })).toEqual({ |
| 34 | + name: '@org/core', |
| 35 | + preamble: '## Core\n\n- y' |
| 36 | + }) |
| 37 | + }) |
| 38 | + |
| 39 | + it('should strip backticks around the package name', () => { |
| 40 | + expect(parseSetPreambleComment({ |
| 41 | + author_association: owner, |
| 42 | + body: `${SET_PREAMBLE_COMMAND} \`@org/core\`\n\n## Core` |
| 43 | + })).toEqual({ |
| 44 | + name: '@org/core', |
| 45 | + preamble: '## Core' |
| 46 | + }) |
| 47 | + }) |
| 48 | + |
| 49 | + it('should ignore an empty preamble body', () => { |
| 50 | + expect(parseSetPreambleComment({ |
| 51 | + author_association: owner, |
| 52 | + body: `${SET_PREAMBLE_COMMAND} @org/core\n\n ` |
| 53 | + })).toBeNull() |
| 54 | + }) |
| 55 | + |
| 56 | + it('should ignore a command with a longer suffix', () => { |
| 57 | + expect(parseSetPreambleComment({ |
| 58 | + author_association: owner, |
| 59 | + body: `${SET_PREAMBLE_COMMAND}-foo\n\n## Nope` |
| 60 | + })).toBeNull() |
| 61 | + }) |
| 62 | + |
| 63 | + it('should ignore comments from untrusted authors', () => { |
| 64 | + expect(parseSetPreambleComment({ |
| 65 | + author_association: 'NONE', |
| 66 | + body: `${SET_PREAMBLE_COMMAND}\n\n## Nope` |
| 67 | + })).toBeNull() |
| 68 | + }) |
| 69 | + |
| 70 | + it('should ignore unrelated comments', () => { |
| 71 | + expect(parseSetPreambleComment({ |
| 72 | + author_association: owner, |
| 73 | + body: 'just a normal comment' |
| 74 | + })).toBeNull() |
| 75 | + }) |
| 76 | + }) |
| 77 | + |
| 78 | + describe('parseSetOptionsComment', () => { |
| 79 | + it('should extract the json block', () => { |
| 80 | + expect(parseSetOptionsComment({ |
| 81 | + author_association: owner, |
| 82 | + body: `${SET_OPTION_COMMAND}\n\n\`\`\`json\n{ "bump": { "as": "major" } }\n\`\`\`` |
| 83 | + })).toBe('{ "bump": { "as": "major" } }') |
| 84 | + }) |
| 85 | + |
| 86 | + it('should ignore a set-options comment without a json block', () => { |
| 87 | + expect(parseSetOptionsComment({ |
| 88 | + author_association: owner, |
| 89 | + body: `${SET_OPTION_COMMAND}\n\nno code block here` |
| 90 | + })).toBeNull() |
| 91 | + }) |
| 92 | + |
| 93 | + it('should ignore a command with a longer suffix', () => { |
| 94 | + expect(parseSetOptionsComment({ |
| 95 | + author_association: owner, |
| 96 | + body: `${SET_OPTION_COMMAND}-foo\n\n\`\`\`json\n{}\n\`\`\`` |
| 97 | + })).toBeNull() |
| 98 | + }) |
| 99 | + |
| 100 | + it('should not treat a set-preamble comment as set-options', () => { |
| 101 | + expect(parseSetOptionsComment({ |
| 102 | + author_association: owner, |
| 103 | + body: `${SET_PREAMBLE_COMMAND}\n\n## What's new?` |
| 104 | + })).toBeNull() |
| 105 | + }) |
| 106 | + }) |
| 107 | + |
| 108 | + describe('isCommandComment', () => { |
| 109 | + it('should detect command comments', () => { |
| 110 | + expect(isCommandComment(`${SET_OPTION_COMMAND}\n\n\`\`\`json\n{}\n\`\`\``)).toBe(true) |
| 111 | + expect(isCommandComment(`${SET_PREAMBLE_COMMAND} @org/core\n\n## x`)).toBe(true) |
| 112 | + }) |
| 113 | + |
| 114 | + it('should ignore mentions, suffixes and empty bodies', () => { |
| 115 | + expect(isCommandComment(`please run ${SET_OPTION_COMMAND}`)).toBe(false) |
| 116 | + expect(isCommandComment(`${SET_PREAMBLE_COMMAND}-foo`)).toBe(false) |
| 117 | + expect(isCommandComment(undefined)).toBe(false) |
| 118 | + }) |
| 119 | + }) |
| 120 | + }) |
| 121 | +}) |
0 commit comments