xrelease/src/core/release/__tests__/gh-cli.test.ts

xrelease (pronounced cross-release) helps you setup automated releases for your project for any language

import { describe, it, expect, vi, beforeEach } from 'vitest';
import { execa } from 'execa';
import { checkGitHubCLI, isGitHubCLIAuthenticated, createGitHubRelease } from '../gh-cli.js';

vi.mock('execa');

describe('GitHub CLI utilities', () => {
  beforeEach(() => {
    vi.resetAllMocks();
  });

  describe('checkGitHubCLI', () => {
    it('should return true if gh CLI is available', async () => {
      vi.mocked(execa).mockResolvedValueOnce({ stdout: 'gh version 2.0.0' } as any);
      expect(await checkGitHubCLI()).toBe(true);
    });

    it('should return false if gh CLI is not available', async () => {
      vi.mocked(execa).mockRejectedValueOnce(new Error('command not found'));
      expect(await checkGitHubCLI()).toBe(false);
    });
  });

  describe('isGitHubCLIAuthenticated', () => {
    it('should return true if gh CLI is authenticated', async () => {
      vi.mocked(execa).mockResolvedValueOnce({ stdout: 'Logged in to github.com' } as any);
      expect(await isGitHubCLIAuthenticated()).toBe(true);
    });

    it('should return false if gh CLI is not authenticated', async () => {
      vi.mocked(execa).mockRejectedValueOnce(new Error('not logged in'));
      expect(await isGitHubCLIAuthenticated()).toBe(false);
    });
  });

  describe('createGitHubRelease', () => {
    it('should create a release with version only', async () => {
      await createGitHubRelease({ version: '1.0.0' });
      expect(execa).toHaveBeenCalledWith('gh', ['release', 'create', 'v1.0.0']);
      expect(execa).toHaveBeenCalledTimes(1);
    });

    it('should create a release with notes', async () => {
      await createGitHubRelease({ version: '1.0.0', body: 'Release notes' });
      expect(execa).toHaveBeenCalledWith('gh', ['release', 'create', 'v1.0.0', '--notes', 'Release notes']);
      expect(execa).toHaveBeenCalledTimes(1);
    });

    it('should create a release and upload assets', async () => {
      await createGitHubRelease({
        version: '1.0.0',
        assets: ['dist/app.js', 'dist/app.css'],
      });

      // Verify create and upload calls
      expect(execa).toHaveBeenCalledTimes(2);
      expect(execa).toHaveBeenNthCalledWith(1, 'gh', ['release', 'create', 'v1.0.0']);
      expect(execa).toHaveBeenNthCalledWith(2, 'gh', ['release', 'upload', 'v1.0.0', 'dist/app.js', 'dist/app.css']);
    });

    it('should create a release with notes and upload assets', async () => {
      await createGitHubRelease({
        version: '1.0.0',
        body: 'Release notes',
        assets: ['dist/app.js'],
      });

      // Verify create with notes and upload calls
      expect(execa).toHaveBeenCalledTimes(2);
      expect(execa).toHaveBeenNthCalledWith(1, 'gh', ['release', 'create', 'v1.0.0', '--notes', 'Release notes']);
      expect(execa).toHaveBeenNthCalledWith(2, 'gh', ['release', 'upload', 'v1.0.0', 'dist/app.js']);
    });

    it('should handle release creation errors', async () => {
      vi.mocked(execa).mockRejectedValueOnce(new Error('Failed to create release'));
      await expect(createGitHubRelease({ version: '1.0.0' })).rejects.toThrow('Failed to create GitHub release: Failed to create release');
    });

    it('should handle asset upload errors', async () => {
      // Mock successful release creation but failed upload
      vi.mocked(execa)
        .mockResolvedValueOnce({ stdout: '' } as any) // release create succeeds
        .mockRejectedValueOnce(new Error('Failed to upload assets')); // upload fails

      await expect(
        createGitHubRelease({
          version: '1.0.0',
          assets: ['dist/app.js'],
        })
      ).rejects.toThrow('Failed to create GitHub release: Failed to upload assets');
    });
  });
});