-
-
Notifications
You must be signed in to change notification settings - Fork 18
fix(brew): skip prereleases and add mustache templating for formula names #682
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,151 @@ | ||
| import { vi } from 'vitest'; | ||
| import { NoneArtifactProvider } from '../../artifact_providers/none'; | ||
| import { ConfigurationError } from '../../utils/errors'; | ||
| import { BrewTarget } from '../brew'; | ||
|
|
||
| // Mock the GitHub API client | ||
| vi.mock('../../utils/githubApi', () => ({ | ||
| getGitHubClient: vi.fn(() => ({ | ||
| repos: { | ||
| getContent: vi.fn(), | ||
| createOrUpdateFileContents: vi.fn(), | ||
| }, | ||
| })), | ||
| })); | ||
|
|
||
| const DEFAULT_GITHUB_REPO = { | ||
| owner: 'getsentry', | ||
| repo: 'sentry-cli', | ||
| }; | ||
|
|
||
| /** Returns a new BrewTarget test instance. */ | ||
| function getBrewTarget( | ||
| config: Record<string, unknown> = {}, | ||
| githubRepo = DEFAULT_GITHUB_REPO | ||
| ): BrewTarget { | ||
| return new BrewTarget( | ||
| { | ||
| name: 'brew', | ||
| template: 'class TestFormula < Formula\nend', | ||
| tap: 'getsentry/tools', | ||
| ...config, | ||
| }, | ||
| new NoneArtifactProvider(), | ||
| githubRepo | ||
| ); | ||
| } | ||
|
|
||
| describe('BrewTarget configuration', () => { | ||
| test('throws on missing template', () => { | ||
| expect(() => { | ||
| new BrewTarget( | ||
| { name: 'brew' }, | ||
| new NoneArtifactProvider(), | ||
| DEFAULT_GITHUB_REPO | ||
| ); | ||
| }).toThrow(ConfigurationError); | ||
| }); | ||
|
|
||
| test('parses tap correctly', () => { | ||
| const brewTarget = getBrewTarget(); | ||
| expect(brewTarget.brewConfig.tapRepo).toEqual({ | ||
| owner: 'getsentry', | ||
| repo: 'homebrew-tools', | ||
| }); | ||
| }); | ||
|
|
||
| test('defaults to homebrew-core when no tap specified', () => { | ||
| const brewTarget = getBrewTarget({ tap: undefined }); | ||
| expect(brewTarget.brewConfig.tapRepo).toEqual({ | ||
| owner: 'homebrew', | ||
| repo: 'homebrew-core', | ||
| }); | ||
| }); | ||
|
|
||
| test('throws on invalid tap name', () => { | ||
| expect(() => { | ||
| getBrewTarget({ tap: 'invalid' }); | ||
| }).toThrow(ConfigurationError); | ||
| }); | ||
| }); | ||
|
|
||
| describe('formula name templating', () => { | ||
| test('formula name without template variables', () => { | ||
| const brewTarget = getBrewTarget({ formula: 'sentry-cli' }); | ||
| const resolved = brewTarget.resolveFormulaName('10.2.3'); | ||
| expect(resolved).toBe('sentry-cli'); | ||
| }); | ||
|
|
||
| test('formula name with major version variable', () => { | ||
| const brewTarget = getBrewTarget({ formula: 'sentry-cli-v{{{major}}}' }); | ||
| const resolved = brewTarget.resolveFormulaName('10.2.3'); | ||
| expect(resolved).toBe('sentry-cli-v10'); | ||
| }); | ||
|
|
||
| test('formula name with multiple version variables', () => { | ||
| const brewTarget = getBrewTarget({ | ||
| formula: 'sentry-cli-{{{major}}}-{{{minor}}}-{{{patch}}}', | ||
| }); | ||
| const resolved = brewTarget.resolveFormulaName('10.2.3'); | ||
| expect(resolved).toBe('sentry-cli-10-2-3'); | ||
| }); | ||
|
|
||
| test('formula name with full version variable', () => { | ||
| const brewTarget = getBrewTarget({ formula: 'sentry-cli-{{{version}}}' }); | ||
| const resolved = brewTarget.resolveFormulaName('10.2.3'); | ||
| expect(resolved).toBe('sentry-cli-10.2.3'); | ||
| }); | ||
|
|
||
| test('formula name with prerelease version still parses major', () => { | ||
| const brewTarget = getBrewTarget({ formula: 'sentry-cli-v{{{major}}}' }); | ||
| const resolved = brewTarget.resolveFormulaName('10.2.3-alpha.1'); | ||
| expect(resolved).toBe('sentry-cli-v10'); | ||
| }); | ||
|
|
||
| test('falls back to repo name when no formula specified', () => { | ||
| const brewTarget = getBrewTarget({ formula: undefined }); | ||
| const resolved = brewTarget.resolveFormulaName('1.0.0'); | ||
| expect(resolved).toBe('sentry-cli'); | ||
| }); | ||
|
|
||
| test('repo name with version template', () => { | ||
| const brewTarget = getBrewTarget( | ||
| { formula: undefined }, | ||
| { owner: 'getsentry', repo: 'craft-v{{{major}}}' } | ||
| ); | ||
| const resolved = brewTarget.resolveFormulaName('2.5.0'); | ||
| expect(resolved).toBe('craft-v2'); | ||
| }); | ||
| }); | ||
|
|
||
| describe('prerelease skip', () => { | ||
| test('skips publishing for beta version', async () => { | ||
| const brewTarget = getBrewTarget(); | ||
| const result = await brewTarget.publish('2.0.0-beta.0', 'abc123'); | ||
| expect(result).toBeUndefined(); | ||
| }); | ||
|
|
||
| test('skips publishing for alpha version', async () => { | ||
| const brewTarget = getBrewTarget(); | ||
| const result = await brewTarget.publish('1.5.0-alpha.1', 'abc123'); | ||
| expect(result).toBeUndefined(); | ||
| }); | ||
|
|
||
| test('skips publishing for rc version', async () => { | ||
| const brewTarget = getBrewTarget(); | ||
| const result = await brewTarget.publish('3.0.0-rc.1', 'abc123'); | ||
| expect(result).toBeUndefined(); | ||
| }); | ||
|
|
||
| test('skips publishing for preview version', async () => { | ||
| const brewTarget = getBrewTarget(); | ||
| const result = await brewTarget.publish('2.0.0-preview.1', 'abc123'); | ||
| expect(result).toBeUndefined(); | ||
| }); | ||
|
|
||
| test('skips publishing for dev version', async () => { | ||
| const brewTarget = getBrewTarget(); | ||
| const result = await brewTarget.publish('1.0.0-dev.1', 'abc123'); | ||
| expect(result).toBeUndefined(); | ||
| }); | ||
| }); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍🏻