Files
n8n-enterprise-unlocked/packages/nodes-base/nodes/Git/test/Git.node.test.ts

563 lines
19 KiB
TypeScript

import * as fsPromises from 'fs/promises';
import { mock } from 'jest-mock-extended';
import type { IExecuteFunctions } from 'n8n-workflow';
import type { SimpleGit } from 'simple-git';
import { Git } from '../Git.node';
// Mock simple-git
const mockGit = {
checkout: jest.fn(),
checkoutBranch: jest.fn(),
checkoutLocalBranch: jest.fn(),
add: jest.fn(),
commit: jest.fn(),
push: jest.fn(),
pull: jest.fn(),
clone: jest.fn(),
addConfig: jest.fn(),
fetch: jest.fn(),
log: jest.fn(),
pushTags: jest.fn(),
listConfig: jest.fn(),
status: jest.fn(),
addTag: jest.fn(),
env: jest.fn().mockReturnThis(),
} as unknown as jest.Mocked<SimpleGit>;
jest.mock('simple-git', () => ({
__esModule: true,
default: () => mockGit,
}));
// Mock filesystem operations
jest.mock('fs/promises', () => ({
access: jest.fn(),
mkdir: jest.fn(),
}));
const mockFsPromises = jest.mocked(fsPromises);
describe('Git Node', () => {
let gitNode: Git;
let mockExecuteFunctions: jest.Mocked<IExecuteFunctions>;
beforeEach(() => {
gitNode = new Git();
mockExecuteFunctions = mock<IExecuteFunctions>({
getInputData: jest.fn(() => [{ json: {} }]),
getNodeParameter: jest.fn(),
continueOnFail: jest.fn(() => false),
helpers: {
returnJsonArray: jest.fn((data: any[]) => data.map((item: any) => ({ json: item }))),
},
});
jest.clearAllMocks();
});
describe('Branch switching', () => {
it('should switch to existing branch for commit operation', async () => {
mockExecuteFunctions.getNodeParameter
.mockReturnValueOnce('commit')
.mockReturnValueOnce('/repo')
.mockReturnValueOnce({ branch: 'feature' })
.mockReturnValueOnce('test commit');
await gitNode.execute.call(mockExecuteFunctions);
expect(mockGit.checkout).toHaveBeenCalledWith('feature');
expect(mockGit.commit).toHaveBeenCalledWith('test commit', undefined);
});
it('should commit specific files when pathsToAdd is provided', async () => {
mockExecuteFunctions.getNodeParameter
.mockReturnValueOnce('commit')
.mockReturnValueOnce('/repo')
.mockReturnValueOnce({
branch: 'feature-branch',
files: true,
pathsToAdd: 'src/file1.js,src/file2.js,README.md',
})
.mockReturnValueOnce('Add specific files');
mockGit.checkout.mockResolvedValueOnce('Switched to branch feature-branch' as any);
const result = await gitNode.execute.call(mockExecuteFunctions);
expect(mockGit.checkout).toHaveBeenCalledWith('feature-branch');
expect(mockGit.commit).toHaveBeenCalledWith('Add specific files', [
'src/file1.js',
'src/file2.js',
'README.md',
]);
expect(result[0]).toEqual([{ json: { success: true }, pairedItem: { item: 0 } }]);
});
it('should fail when trying to push to non-existent branch', async () => {
mockExecuteFunctions.getNodeParameter
.mockReturnValueOnce('push')
.mockReturnValueOnce('/repo')
.mockReturnValueOnce({ branch: 'non-existent-branch' })
.mockReturnValueOnce('none');
const error = new Error('Branch not found');
mockGit.checkout.mockRejectedValueOnce(error);
await expect(gitNode.execute.call(mockExecuteFunctions)).rejects.toThrow('Branch not found');
expect(mockGit.checkout).toHaveBeenCalledWith('non-existent-branch');
expect(mockGit.checkoutLocalBranch).not.toHaveBeenCalled();
expect(mockGit.push).not.toHaveBeenCalled();
});
it('should set upstream when creating branch for commit operation', async () => {
mockExecuteFunctions.getNodeParameter
.mockReturnValueOnce('commit')
.mockReturnValueOnce('/repo')
.mockReturnValueOnce({ branch: 'feature-branch' })
.mockReturnValueOnce('commit message');
mockGit.checkout.mockRejectedValueOnce(new Error('Branch not found'));
await gitNode.execute.call(mockExecuteFunctions);
expect(mockGit.checkout).toHaveBeenCalledWith('feature-branch');
expect(mockGit.checkoutLocalBranch).toHaveBeenCalledWith('feature-branch');
expect(mockGit.addConfig).toHaveBeenCalledWith('branch.feature-branch.remote', 'origin');
expect(mockGit.addConfig).toHaveBeenCalledWith(
'branch.feature-branch.merge',
'refs/heads/feature-branch',
);
expect(mockGit.commit).toHaveBeenCalledWith('commit message', undefined);
});
it('should set upstream when switching to existing branch for push operation', async () => {
mockExecuteFunctions.getNodeParameter
.mockReturnValueOnce('push')
.mockReturnValueOnce('/repo')
.mockReturnValueOnce({ branch: 'existing-branch' })
.mockReturnValueOnce('none');
// Branch exists, so checkout succeeds
mockGit.checkout.mockResolvedValueOnce('Switched to branch existing-branch' as any);
await gitNode.execute.call(mockExecuteFunctions);
expect(mockGit.checkout).toHaveBeenCalledWith('existing-branch');
expect(mockGit.checkoutLocalBranch).not.toHaveBeenCalled();
expect(mockGit.addConfig).toHaveBeenCalledWith('branch.existing-branch.remote', 'origin');
expect(mockGit.addConfig).toHaveBeenCalledWith(
'branch.existing-branch.merge',
'refs/heads/existing-branch',
);
expect(mockGit.push).toHaveBeenCalled();
});
it('should push to specific repository when repository option is provided', async () => {
mockExecuteFunctions.getNodeParameter
.mockReturnValueOnce('push')
.mockReturnValueOnce('/repo')
.mockReturnValueOnce({
branch: 'feature-branch',
repository: true,
targetRepository: 'https://github.com/example/repo.git',
})
.mockReturnValueOnce('none');
// Branch exists, so checkout succeeds
mockGit.checkout.mockResolvedValueOnce('Switched to branch feature-branch' as any);
await gitNode.execute.call(mockExecuteFunctions);
expect(mockGit.checkout).toHaveBeenCalledWith('feature-branch');
expect(mockGit.push).toHaveBeenCalledWith('https://github.com/example/repo.git');
});
it('should not switch branch when pushing with empty branch string', async () => {
mockExecuteFunctions.getNodeParameter
.mockReturnValueOnce('push')
.mockReturnValueOnce('/repo')
.mockReturnValueOnce({ branch: '' }) // empty string branch
.mockReturnValueOnce('gitPassword');
// Mock git config for push operation
mockGit.listConfig.mockResolvedValueOnce({
values: { '.git/config': { 'remote.origin.url': 'https://github.com/test/repo.git' } },
} as any);
await gitNode.execute.call(mockExecuteFunctions);
expect(mockGit.checkout).not.toHaveBeenCalled();
expect(mockGit.push).toHaveBeenCalled();
});
it('should handle switchBranch operation to existing branch', async () => {
mockExecuteFunctions.getNodeParameter
.mockReturnValueOnce('switchBranch')
.mockReturnValueOnce('/repo')
.mockReturnValueOnce({})
.mockReturnValueOnce('existing-branch');
const result = await gitNode.execute.call(mockExecuteFunctions);
expect(mockGit.checkout).toHaveBeenCalledWith('existing-branch');
expect(result[0]).toEqual([
{ json: { success: true, branch: 'existing-branch' }, pairedItem: { item: 0 } },
]);
});
it('should create new branch when switchBranch fails and createBranch is true', async () => {
mockExecuteFunctions.getNodeParameter
.mockReturnValueOnce('switchBranch')
.mockReturnValueOnce('/repo')
.mockReturnValueOnce({ createBranch: true })
.mockReturnValueOnce('new-branch');
mockGit.checkout.mockRejectedValueOnce(new Error('Branch not found'));
const result = await gitNode.execute.call(mockExecuteFunctions);
expect(mockGit.checkout).toHaveBeenCalledWith('new-branch');
expect(mockGit.checkoutLocalBranch).toHaveBeenCalledWith('new-branch');
expect(result[0]).toEqual([
{ json: { success: true, branch: 'new-branch' }, pairedItem: { item: 0 } },
]);
});
it('should create branch from start point when specified', async () => {
mockExecuteFunctions.getNodeParameter
.mockReturnValueOnce('switchBranch')
.mockReturnValueOnce('/repo')
.mockReturnValueOnce({ createBranch: true, startPoint: 'main' })
.mockReturnValueOnce('feature-branch');
mockGit.checkout.mockRejectedValueOnce(new Error('Branch not found'));
await gitNode.execute.call(mockExecuteFunctions);
expect(mockGit.checkout).toHaveBeenCalledWith('feature-branch');
expect(mockGit.checkoutBranch).toHaveBeenCalledWith('feature-branch', 'main');
});
it('should force checkout when force option is enabled', async () => {
mockExecuteFunctions.getNodeParameter
.mockReturnValueOnce('switchBranch')
.mockReturnValueOnce('/repo')
.mockReturnValueOnce({ force: true })
.mockReturnValueOnce('force-branch');
await gitNode.execute.call(mockExecuteFunctions);
expect(mockGit.checkout).toHaveBeenCalledWith(['-f', 'force-branch']);
});
it('should throw error when createBranch is false and branch does not exist', async () => {
mockExecuteFunctions.getNodeParameter
.mockReturnValueOnce('switchBranch')
.mockReturnValueOnce('/repo')
.mockReturnValueOnce({ createBranch: false })
.mockReturnValueOnce('nonexistent-branch');
const error = new Error('Branch not found');
mockGit.checkout.mockRejectedValueOnce(error);
await expect(gitNode.execute.call(mockExecuteFunctions)).rejects.toThrow('Branch not found');
});
it('should set upstream tracking when creating new branch with setUpstream option', async () => {
mockExecuteFunctions.getNodeParameter
.mockReturnValueOnce('switchBranch')
.mockReturnValueOnce('/repo')
.mockReturnValueOnce({
createBranch: true,
setUpstream: true,
remoteName: 'origin',
})
.mockReturnValueOnce('feature-branch');
mockGit.checkout.mockRejectedValueOnce(new Error('Branch not found'));
await gitNode.execute.call(mockExecuteFunctions);
expect(mockGit.checkout).toHaveBeenCalledWith('feature-branch');
expect(mockGit.checkoutLocalBranch).toHaveBeenCalledWith('feature-branch');
expect(mockGit.addConfig).toHaveBeenCalledWith('branch.feature-branch.remote', 'origin');
expect(mockGit.addConfig).toHaveBeenCalledWith(
'branch.feature-branch.merge',
'refs/heads/feature-branch',
);
});
it('should use default remote name when not specified', async () => {
mockExecuteFunctions.getNodeParameter
.mockReturnValueOnce('switchBranch')
.mockReturnValueOnce('/repo')
.mockReturnValueOnce({
createBranch: true,
setUpstream: true,
// remoteName not specified, should default to 'origin'
})
.mockReturnValueOnce('feature-branch');
mockGit.checkout.mockRejectedValueOnce(new Error('Branch not found'));
await gitNode.execute.call(mockExecuteFunctions);
expect(mockGit.addConfig).toHaveBeenCalledWith('branch.feature-branch.remote', 'origin');
});
it('should continue successfully even if upstream setup fails', async () => {
mockExecuteFunctions.getNodeParameter
.mockReturnValueOnce('switchBranch')
.mockReturnValueOnce('/repo')
.mockReturnValueOnce({
createBranch: true,
setUpstream: true,
remoteName: 'origin',
})
.mockReturnValueOnce('feature-branch');
mockGit.checkout.mockRejectedValueOnce(new Error('Branch not found'));
mockGit.addConfig.mockRejectedValueOnce(new Error('Remote not found'));
const result = await gitNode.execute.call(mockExecuteFunctions);
expect(mockGit.checkoutLocalBranch).toHaveBeenCalledWith('feature-branch');
expect(result[0]).toEqual([
{
json: { success: true, branch: 'feature-branch' },
pairedItem: { item: 0 },
},
]);
});
it('should not switch branch when not specified', async () => {
mockExecuteFunctions.getNodeParameter
.mockReturnValueOnce('commit')
.mockReturnValueOnce('/repo')
.mockReturnValueOnce({}) // no branch
.mockReturnValueOnce('test commit');
await gitNode.execute.call(mockExecuteFunctions);
expect(mockGit.checkout).not.toHaveBeenCalled();
expect(mockGit.commit).toHaveBeenCalledWith('test commit', undefined);
});
it('should not switch branch when empty string is provided', async () => {
mockExecuteFunctions.getNodeParameter
.mockReturnValueOnce('commit')
.mockReturnValueOnce('/repo')
.mockReturnValueOnce({ branch: '' }) // empty string branch
.mockReturnValueOnce('test commit');
await gitNode.execute.call(mockExecuteFunctions);
expect(mockGit.checkout).not.toHaveBeenCalled();
expect(mockGit.commit).toHaveBeenCalledWith('test commit', undefined);
});
});
describe('All operations coverage', () => {
it('should handle add operation', async () => {
mockExecuteFunctions.getNodeParameter
.mockReturnValueOnce('add')
.mockReturnValueOnce('/repo')
.mockReturnValueOnce({})
.mockReturnValueOnce('file.txt');
const result = await gitNode.execute.call(mockExecuteFunctions);
expect(mockGit.add).toHaveBeenCalledWith(['file.txt']);
expect(result[0]).toEqual([{ json: { success: true }, pairedItem: { item: 0 } }]);
});
it('should handle addConfig operation', async () => {
mockExecuteFunctions.getNodeParameter
.mockReturnValueOnce('addConfig')
.mockReturnValueOnce('/repo')
.mockReturnValueOnce({})
.mockReturnValueOnce('user.name')
.mockReturnValueOnce('test user');
await gitNode.execute.call(mockExecuteFunctions);
expect(mockGit.addConfig).toHaveBeenCalledWith('user.name', 'test user', false);
});
it('should handle clone operation and create directory when it does not exist', async () => {
mockExecuteFunctions.getNodeParameter
.mockReturnValueOnce('clone')
.mockReturnValueOnce('/new-repo')
.mockReturnValueOnce({})
.mockReturnValueOnce('https://github.com/test/repo.git');
// Simulate directory not existing - access() throws
mockFsPromises.access.mockRejectedValueOnce(new Error('Directory does not exist'));
mockFsPromises.mkdir.mockResolvedValueOnce(undefined);
const result = await gitNode.execute.call(mockExecuteFunctions);
expect(mockFsPromises.access).toHaveBeenCalledWith('/new-repo');
expect(mockFsPromises.mkdir).toHaveBeenCalledWith('/new-repo');
expect(mockGit.clone).toHaveBeenCalledWith('https://github.com/test/repo.git', '.');
expect(result[0]).toEqual([{ json: { success: true }, pairedItem: { item: 0 } }]);
});
it('should handle clone operation when directory already exists', async () => {
mockExecuteFunctions.getNodeParameter
.mockReturnValueOnce('clone')
.mockReturnValueOnce('/existing-repo')
.mockReturnValueOnce({})
.mockReturnValueOnce('https://github.com/test/repo.git');
// Simulate directory already exists - access() succeeds
mockFsPromises.access.mockResolvedValueOnce(undefined);
await gitNode.execute.call(mockExecuteFunctions);
expect(mockFsPromises.access).toHaveBeenCalledWith('/existing-repo');
expect(mockFsPromises.mkdir).not.toHaveBeenCalled();
expect(mockGit.clone).toHaveBeenCalledWith('https://github.com/test/repo.git', '.');
});
it('should handle fetch operation', async () => {
mockExecuteFunctions.getNodeParameter
.mockReturnValueOnce('fetch')
.mockReturnValueOnce('/repo')
.mockReturnValueOnce({});
await gitNode.execute.call(mockExecuteFunctions);
expect(mockGit.fetch).toHaveBeenCalled();
});
it('should handle pull operation', async () => {
mockExecuteFunctions.getNodeParameter
.mockReturnValueOnce('pull')
.mockReturnValueOnce('/repo')
.mockReturnValueOnce({});
await gitNode.execute.call(mockExecuteFunctions);
expect(mockGit.pull).toHaveBeenCalled();
});
it('should handle log operation', async () => {
mockExecuteFunctions.getNodeParameter
.mockReturnValueOnce('log')
.mockReturnValueOnce('/repo')
.mockReturnValueOnce({})
.mockReturnValueOnce(false) // returnAll
.mockReturnValueOnce(10); // limit
const mockLogData = [
{ hash: 'abc123', message: 'test commit', author_name: 'John Doe' },
{ hash: 'def456', message: 'another commit', author_name: 'Jane Smith' },
];
mockGit.log.mockResolvedValueOnce({ all: mockLogData } as any);
const result = await gitNode.execute.call(mockExecuteFunctions);
expect(mockGit.log).toHaveBeenCalledWith({ maxCount: 10 });
expect(result[0]).toHaveLength(2);
expect(result[0]).toEqual([
{
json: { hash: 'abc123', message: 'test commit', author_name: 'John Doe' },
pairedItem: { item: 0 },
},
{
json: { hash: 'def456', message: 'another commit', author_name: 'Jane Smith' },
pairedItem: { item: 0 },
},
]);
});
it('should handle pushTags operation', async () => {
mockExecuteFunctions.getNodeParameter
.mockReturnValueOnce('pushTags')
.mockReturnValueOnce('/repo')
.mockReturnValueOnce({});
await gitNode.execute.call(mockExecuteFunctions);
expect(mockGit.pushTags).toHaveBeenCalled();
});
it('should handle listConfig operation', async () => {
mockExecuteFunctions.getNodeParameter
.mockReturnValueOnce('listConfig')
.mockReturnValueOnce('/repo')
.mockReturnValueOnce({});
mockGit.listConfig.mockResolvedValueOnce({
values: { '.git/config': { 'user.name': 'test' } },
} as any);
await gitNode.execute.call(mockExecuteFunctions);
expect(mockGit.listConfig).toHaveBeenCalled();
});
it('should handle status operation', async () => {
mockExecuteFunctions.getNodeParameter
.mockReturnValueOnce('status')
.mockReturnValueOnce('/repo')
.mockReturnValueOnce({});
mockGit.status.mockResolvedValueOnce({ current: 'main' } as any);
await gitNode.execute.call(mockExecuteFunctions);
expect(mockGit.status).toHaveBeenCalled();
});
it('should handle tag operation', async () => {
mockExecuteFunctions.getNodeParameter
.mockReturnValueOnce('tag')
.mockReturnValueOnce('/repo')
.mockReturnValueOnce({})
.mockReturnValueOnce('v1.0.0');
await gitNode.execute.call(mockExecuteFunctions);
expect(mockGit.addTag).toHaveBeenCalledWith('v1.0.0');
});
});
describe('Error handling', () => {
it('should continue on fail when enabled', async () => {
mockExecuteFunctions.getNodeParameter
.mockReturnValueOnce('commit')
.mockReturnValueOnce('/repo')
.mockReturnValueOnce({ branch: 'bad-branch' })
.mockReturnValueOnce('test');
mockExecuteFunctions.continueOnFail.mockReturnValueOnce(true);
mockGit.checkout.mockRejectedValueOnce(new Error('Branch error'));
mockGit.checkoutLocalBranch.mockRejectedValueOnce(new Error('Create error'));
const result = await gitNode.execute.call(mockExecuteFunctions);
expect(result[0]).toEqual([
{
json: { error: 'Error: Create error' },
pairedItem: { item: 0 },
},
]);
});
it('should throw on fail when continueOnFail is disabled', async () => {
mockExecuteFunctions.getNodeParameter
.mockReturnValueOnce('add')
.mockReturnValueOnce('/repo')
.mockReturnValueOnce({})
.mockReturnValueOnce('file.txt');
mockGit.add.mockRejectedValueOnce(new Error('Add failed'));
await expect(gitNode.execute.call(mockExecuteFunctions)).rejects.toThrow('Add failed');
});
});
});