@pagopa/dx-cli/dist/domain/__tests__/repository.test.js

A CLI useful to manage DX tools.

import { errAsync, ok, okAsync } from "neverthrow";
import { describe, expect, it } from "vitest";
import { checkPreCommitConfig, checkTurboConfig } from "../repository.js";
import { makeMockConfig, makeMockDependencies, makeMockRepositoryRoot, } from "./data.js";
describe("checkPreCommitConfig", () => {
    it("should return ok result with successful validation when .pre-commit-config.yaml exists", async () => {
        const deps = makeMockDependencies();
        const repositoryRoot = makeMockRepositoryRoot();
        deps.repositoryReader.fileExists.mockReturnValueOnce(okAsync(true));
        const result = await checkPreCommitConfig(deps, repositoryRoot);
        expect(result).toStrictEqual(ok({
            checkName: "Pre-commit Configuration",
            isValid: true,
            successMessage: "Pre-commit configuration is present in the repository root",
        }));
        expect(deps.repositoryReader.fileExists).toHaveBeenCalledWith("a/repo/root/.pre-commit-config.yaml");
    });
    it("should return ok result with failed validation when .pre-commit-config.yaml does not exist", async () => {
        const deps = makeMockDependencies();
        const repositoryRoot = makeMockRepositoryRoot();
        const errorMessage = ".pre-commit-config.yaml not found in repository root. Make sure to have pre-commit configured for the repository.";
        deps.repositoryReader.fileExists.mockReturnValueOnce(errAsync(new Error(errorMessage)));
        const result = await checkPreCommitConfig(deps, repositoryRoot);
        expect(result).toStrictEqual(ok({
            checkName: "Pre-commit Configuration",
            errorMessage,
            isValid: false,
        }));
    });
});
describe("checkTurboConfig", () => {
    const config = makeMockConfig();
    const repositoryRoot = makeMockRepositoryRoot();
    it("should return ok result with successful validation when turbo.json exists and turbo dependency is present", async () => {
        const deps = makeMockDependencies();
        deps.repositoryReader.fileExists.mockReturnValueOnce(okAsync(true));
        deps.packageJsonReader.getDependencies.mockReturnValueOnce(okAsync(new Map().set("turbo", "^2.5.2")));
        const result = await checkTurboConfig(deps, repositoryRoot, config);
        expect(result).toStrictEqual(ok({
            checkName: "Turbo Configuration",
            isValid: true,
            successMessage: "Turbo configuration is present in the monorepo root and turbo dependency is installed",
        }));
        expect(deps.repositoryReader.fileExists).toHaveBeenCalledWith("a/repo/root/turbo.json");
    });
    it("should return ok result with failed validation when turbo.json exists but turbo dependency is missing", async () => {
        const deps = makeMockDependencies();
        deps.repositoryReader.fileExists.mockReturnValueOnce(okAsync(true));
        deps.packageJsonReader.getDependencies.mockReturnValueOnce(okAsync(new Map().set("eslint", "^8.0.0")));
        const result = await checkTurboConfig(deps, repositoryRoot, config);
        expect(result).toStrictEqual(ok({
            checkName: "Turbo Configuration",
            errorMessage: "Turbo dependency not found in devDependencies. Please add 'turbo' to your devDependencies.",
            isValid: false,
        }));
    });
    it("should return ok result with failed validation when turbo.json does not exist", async () => {
        const deps = makeMockDependencies();
        const errorMessage = "turbo.json not found in repository root. Make sure to have Turbo configured for the monorepo.";
        deps.repositoryReader.fileExists.mockReturnValueOnce(errAsync(new Error(errorMessage)));
        const result = await checkTurboConfig(deps, repositoryRoot, config);
        expect(result).toStrictEqual(ok({
            checkName: "Turbo Configuration",
            errorMessage,
            isValid: false,
        }));
    });
    it("should return the error message when turbo is not listed in devDependencies", async () => {
        const deps = makeMockDependencies();
        deps.repositoryReader.fileExists.mockReturnValueOnce(okAsync(true));
        deps.packageJsonReader.getDependencies.mockReturnValueOnce(okAsync(new Map().set("eslint", "^8.0.0")));
        const result = await checkTurboConfig(deps, repositoryRoot, config);
        expect(result).toStrictEqual(ok({
            checkName: "Turbo Configuration",
            errorMessage: "Turbo dependency not found in devDependencies. Please add 'turbo' to your devDependencies.",
            isValid: false,
        }));
    });
    it("should return the error message when turbo version is less than minimum", async () => {
        const deps = makeMockDependencies();
        deps.repositoryReader.fileExists.mockReturnValueOnce(okAsync(true));
        deps.packageJsonReader.getDependencies.mockReturnValueOnce(okAsync(new Map().set("turbo", "1.0.0")));
        const result = await checkTurboConfig(deps, repositoryRoot, config);
        expect(result).toStrictEqual(ok({
            checkName: "Turbo Configuration",
            errorMessage: `Turbo version (1.0.0) is too low. Minimum required version is ${config.minVersions.turbo}.`,
            isValid: false,
        }));
    });
    it("should return the success message when turbo version is ok", async () => {
        const deps = makeMockDependencies();
        deps.repositoryReader.fileExists.mockReturnValueOnce(okAsync(true));
        deps.packageJsonReader.getDependencies.mockReturnValueOnce(okAsync(new Map().set("turbo", config.minVersions.turbo)));
        const result = await checkTurboConfig(deps, repositoryRoot, config);
        expect(result).toStrictEqual(ok({
            checkName: "Turbo Configuration",
            isValid: true,
            successMessage: "Turbo configuration is present in the monorepo root and turbo dependency is installed",
        }));
    });
});