Skip to content

Commit

Permalink
test: fix module mocking and cleanup in CLI tests
Browse files Browse the repository at this point in the history
  • Loading branch information
@AndrewBarber
AndrewBarber committed Dec 20, 2024
1 parent 6e0d6e6 commit df9b253
Show file tree
Hide file tree
Showing 3 changed files with 133 additions and 152 deletions.
162 changes: 75 additions & 87 deletions cli/__tests__/build.test.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,45 +4,45 @@
* as well as the proper invocation of the underlying build functionality.
*/

import { jest } from '@jest/globals';
import { cmdBuild } from '../build';
import * as utils from '../utils';
import * as fs from 'fs';
import * as path from 'path';
import build from '../../build';
import { jest } from "@jest/globals";
import { cmdBuild } from "../build";
import * as utils from "../utils";
import * as fs from "fs";
import * as path from "path";
import build from "../../build";

// Mock dependencies
jest.mock('../utils', () => ({
jest.mock("../utils", () => ({
printAndExit: jest.fn((message: string, exitCode?: number) => {
if (exitCode === undefined) exitCode = 1;
return message;
})
}),
}));
jest.mock('fs');
jest.mock('path');
jest.mock('../../build');
jest.mock("fs");
jest.mock("path");
jest.mock("../../build");

/**
* Test suite for the build command
* Verifies command-line argument handling, help display, validation,
* and proper invocation of the build functionality
*/
describe('cmdBuild', () => {
describe("cmdBuild", () => {
// Store original console.log
const originalConsoleLog = console.log;
let mockExistsSync: jest.SpiedFunction<typeof fs.existsSync>;
let mockResolve: jest.SpiedFunction<typeof path.resolve>;

beforeEach(() => {
// Reset all mocks before each test
jest.clearAllMocks();

// Setup fs.existsSync mock
mockExistsSync = jest.spyOn(fs, 'existsSync').mockReturnValue(true);
mockExistsSync = jest.spyOn(fs, "existsSync").mockReturnValue(true);

// Setup path.resolve mock
mockResolve = jest.spyOn(path, 'resolve').mockImplementation((...args) => args.join('/'));
mockResolve = jest.spyOn(path, "resolve").mockImplementation((...args) => args.join("/"));

// Mock console.log
console.log = jest.fn();
});
Expand All @@ -63,154 +63,142 @@ describe('cmdBuild', () => {
* Verify that the help message is displayed when --help flag is used
* The command should exit with status code 0 after displaying help
*/
test('displays help message when --help flag is used', () => {
test("displays help message when --help flag is used", () => {
const mockPrintAndExit = utils.printAndExit as jest.MockedFunction<typeof utils.printAndExit>;

cmdBuild(['--help']);

expect(mockPrintAndExit).toHaveBeenCalledWith(
expect.stringContaining('Usage'),
0
);

cmdBuild(["--help"]);

expect(mockPrintAndExit).toHaveBeenCalledWith(expect.stringContaining("Usage"), 0);
});

/**
* Verify that the help message is displayed when -h flag is used
* This tests the short form of the help flag
*/
test('displays help message when -h flag is used', () => {
test("displays help message when -h flag is used", () => {
const mockPrintAndExit = utils.printAndExit as jest.MockedFunction<typeof utils.printAndExit>;

cmdBuild(['-h']);

expect(mockPrintAndExit).toHaveBeenCalledWith(
expect.stringContaining('Usage'),
0
);

cmdBuild(["-h"]);

expect(mockPrintAndExit).toHaveBeenCalledWith(expect.stringContaining("Usage"), 0);
});

/**
* Verify that the environment flag is required
* The command should exit with an error if --env is not provided
*/
test('requires environment flag', () => {
test("requires environment flag", () => {
const mockPrintAndExit = utils.printAndExit as jest.MockedFunction<typeof utils.printAndExit>;

cmdBuild([]);

expect(mockPrintAndExit).toHaveBeenCalledWith(
expect.stringContaining('--env')
);

expect(mockPrintAndExit).toHaveBeenCalledWith(expect.stringContaining("--env"));
});

/**
* Verify that the project directory exists
* The command should exit with an error if the specified directory doesn't exist
*/
test('validates project directory exists', () => {
test("validates project directory exists", () => {
const mockPrintAndExit = utils.printAndExit as jest.MockedFunction<typeof utils.printAndExit>;
mockExistsSync.mockReturnValue(false);

cmdBuild(['--env', 'prod', '/non/existent/dir']);

expect(mockPrintAndExit).toHaveBeenCalledWith(
expect.stringContaining('/non/existent/dir')
);

cmdBuild(["--env", "prod", "/non/existent/dir"]);

expect(mockPrintAndExit).toHaveBeenCalledWith(expect.stringContaining("/non/existent/dir"));
});

/**
* Verify that the build function is called with correct parameters
* Tests the proper parsing and forwarding of all command line arguments
*/
test('calls build with correct parameters', () => {
test("calls build with correct parameters", () => {
const mockBuild = build as jest.MockedFunction<typeof build>;
const args = ['--env', 'prod', '--src-dir', 'src', '--out-dir', 'dist', '/project/dir'];
const args = ["--env", "prod", "--src-dir", "src", "--out-dir", "dist", "/project/dir"];

cmdBuild(args);

expect(mockBuild).toHaveBeenCalledWith({
rootDir: '/project/dir',
environment: 'prod',
srcDir: 'src',
outDir: 'dist',
debug: false
rootDir: "/project/dir",
environment: "prod",
srcDir: "src",
outDir: "dist",
debug: false,
});
});

/**
* Verify that the debug flag is properly set when --debug is used
* Tests the long form of the debug flag
*/
test('sets debug flag when --debug is used', () => {
test("sets debug flag when --debug is used", () => {
const mockBuild = build as jest.MockedFunction<typeof build>;
const args = ['--env', 'prod', '--debug', '/project/dir'];
const args = ["--env", "prod", "--debug", "/project/dir"];

cmdBuild(args);

expect(mockBuild).toHaveBeenCalledWith({
rootDir: '/project/dir',
environment: 'prod',
debug: true
rootDir: "/project/dir",
environment: "prod",
debug: true,
});
});

/**
* Verify that the debug flag is properly set when -d is used
* Tests the short form of the debug flag
*/
test('sets debug flag when -d is used', () => {
test("sets debug flag when -d is used", () => {
const mockBuild = build as jest.MockedFunction<typeof build>;
const args = ['--env', 'prod', '-d', '/project/dir'];
const args = ["--env", "prod", "-d", "/project/dir"];

cmdBuild(args);

expect(mockBuild).toHaveBeenCalledWith({
rootDir: '/project/dir',
environment: 'prod',
debug: true
rootDir: "/project/dir",
environment: "prod",
debug: true,
});
});

/**
* Verify that the current directory is used when no project directory is specified
* Tests the default behavior for project directory
*/
test('uses current directory when no project directory is specified', () => {
test("uses current directory when no project directory is specified", () => {
const mockBuild = build as jest.MockedFunction<typeof build>;
const args = ['--env', 'prod'];
const args = ["--env", "prod"];

cmdBuild(args);

expect(mockBuild).toHaveBeenCalledWith({
rootDir: '.',
environment: 'prod',
debug: false
rootDir: ".",
environment: "prod",
debug: false,
});
});

/**
* Verify that unknown command line options are handled gracefully
* The command should exit with an error message for unknown flags
*/
test('handles unknown options gracefully', () => {
test("handles unknown options gracefully", () => {
const mockPrintAndExit = utils.printAndExit as jest.MockedFunction<typeof utils.printAndExit>;

cmdBuild(['--unknown-flag']);

expect(mockPrintAndExit).toHaveBeenCalledWith(
expect.stringContaining('--unknown-flag')
);

cmdBuild(["--unknown-flag"]);

expect(mockPrintAndExit).toHaveBeenCalledWith(expect.stringContaining("--unknown-flag"));
});

/**
* Verify that non-ARG_UNKNOWN_OPTION errors are properly propagated
* Any unexpected errors should be thrown rather than handled silently
*/
test('throws error for non-ARG_UNKNOWN_OPTION errors', () => {
test("throws error for non-ARG_UNKNOWN_OPTION errors", () => {
mockExistsSync.mockImplementation(() => {
throw new Error('Some other error');
throw new Error("Some other error");
});

expect(() => cmdBuild(['--env', 'prod'])).toThrow('Some other error');
expect(() => cmdBuild(["--env", "prod"])).toThrow("Some other error");
});
});
Loading

0 comments on commit df9b253

Please sign in to comment.