Skip to content
zit Artifact [a92c869e62]
Login

Artifact [a92c869e62]

Artifact a92c869e62aed8c8003e4aed991af0aa4047a18217e13995121c5726216176a1:


const std = @import("std");
const support = @import("support.zig");
const addManaged = support.addManaged;
const expectExitDiag = support.expectExitDiag;
const freeResult = support.freeResult;
const initRepo = support.initRepo;
const runZit = support.runZit;
const writeFile = support.writeFile;

// ==========================================================================
// The control files zit reads from the tree (`.zitignore`, `.fossil-settings/`,
// `.zit-settings/`, `.zit-modules`) are offered by the sweep whatever `dotfiles`
// says; every other dot name is still skipped, and a skip is reported once on
// stderr so it can never pass unnoticed.
// ==========================================================================

/// The new-repository shape that once went out without its `.zitignore`.
fn writeDotfileFixture(gpa: std.mem.Allocator, io: std.Io, dir: std.Io.Dir) !void {
    try initRepo(gpa, io, dir);
    try writeFile(io, dir, "a.txt", "a\n");
    try writeFile(io, dir, ".zitignore", "*.tmp\n");
    try dir.createDirPath(io, ".github");
    try writeFile(io, dir, ".github/ci.yml", "x\n");
}

test "dotfiles: addremove adds .zitignore, skips .github, and says one dot-path was skipped" {
    const gpa = std.testing.allocator;
    const io = std.testing.io;
    var tmp = std.testing.tmpDir(.{});
    defer tmp.cleanup();
    try writeDotfileFixture(gpa, io, tmp.dir);

    var res = try runZit(gpa, io, tmp.dir, &.{"addremove"});
    defer freeResult(gpa, &res);
    try expectExitDiag(res.term, 0, res);
    try std.testing.expectEqualStrings("ADDED .zitignore\nADDED a.txt\n", res.stdout);
    try std.testing.expectEqualStrings("zit addremove: 1 dot-path not added (--dotfiles to include)\n", res.stderr);
}

test "dotfiles: extras lists .zitignore and notes the skip; --dotfiles lists all three silently" {
    const gpa = std.testing.allocator;
    const io = std.testing.io;
    var tmp = std.testing.tmpDir(.{});
    defer tmp.cleanup();
    try writeDotfileFixture(gpa, io, tmp.dir);

    var plain = try runZit(gpa, io, tmp.dir, &.{"extras"});
    defer freeResult(gpa, &plain);
    try expectExitDiag(plain.term, 0, plain);
    try std.testing.expectEqualStrings(".zitignore\na.txt\n", plain.stdout);
    try std.testing.expectEqualStrings("zit extras: 1 dot-path not shown (--dotfiles to include)\n", plain.stderr);

    var dotted = try runZit(gpa, io, tmp.dir, &.{ "extras", "--dotfiles" });
    defer freeResult(gpa, &dotted);
    try expectExitDiag(dotted.term, 0, dotted);
    try std.testing.expectEqualStrings(".github/ci.yml\n.zitignore\na.txt\n", dotted.stdout);
    try std.testing.expectEqualStrings("", dotted.stderr);
    // clean, the destructive verb, keeps fossil's rule: an untracked
    // `.zitignore` is not a deletion candidate without --dotfiles.
    var dry = try runZit(gpa, io, tmp.dir, &.{ "clean", "--dry-run" });
    defer freeResult(gpa, &dry);
    try expectExitDiag(dry.term, 0, dry);
    try std.testing.expectEqualStrings("a.txt\n", dry.stdout);
}

test "dotfiles: the settings directories and .zit-modules are listed; each skipped dot entry counts once" {
    const gpa = std.testing.allocator;
    const io = std.testing.io;
    var tmp = std.testing.tmpDir(.{});
    defer tmp.cleanup();
    try initRepo(gpa, io, tmp.dir);
    try tmp.dir.createDirPath(io, ".fossil-settings");
    try writeFile(io, tmp.dir, ".fossil-settings/ignore-glob", "*.o\n");
    try tmp.dir.createDirPath(io, ".zit-settings");
    try writeFile(io, tmp.dir, ".zit-settings/keep-glob", "*.keep\n");
    try writeFile(io, tmp.dir, ".zit-modules", "");
    // Not control files: a dot directory with two files counts once, a dot
    // file once, and a `.zitignore` below the root is an ordinary dot name.
    try tmp.dir.createDirPath(io, ".github/workflows");
    try writeFile(io, tmp.dir, ".github/workflows/a.yml", "a\n");
    try writeFile(io, tmp.dir, ".github/workflows/b.yml", "b\n");
    try writeFile(io, tmp.dir, ".env", "K=1\n");
    try tmp.dir.createDirPath(io, "sub");
    try writeFile(io, tmp.dir, "sub/.zitignore", "*\n");

    var res = try runZit(gpa, io, tmp.dir, &.{"extras"});
    defer freeResult(gpa, &res);
    try expectExitDiag(res.term, 0, res);
    try std.testing.expectEqualStrings(
        ".fossil-settings/ignore-glob\n.zit-modules\n.zit-settings/keep-glob\n",
        res.stdout,
    );
    try std.testing.expectEqualStrings("zit extras: 3 dot-paths not shown (--dotfiles to include)\n", res.stderr);
}

test "dotfiles: an explicitly ignored .zitignore stays out" {
    const gpa = std.testing.allocator;
    const io = std.testing.io;
    var tmp = std.testing.tmpDir(.{});
    defer tmp.cleanup();
    try initRepo(gpa, io, tmp.dir);
    try writeFile(io, tmp.dir, "a.txt", "a\n");
    try writeFile(io, tmp.dir, ".zitignore", "*.tmp\n");
    var set = try runZit(gpa, io, tmp.dir, &.{ "settings", "ignore-glob", ".zitignore" });
    defer freeResult(gpa, &set);
    try expectExitDiag(set.term, 0, set);

    var res = try runZit(gpa, io, tmp.dir, &.{"extras"});
    defer freeResult(gpa, &res);
    try expectExitDiag(res.term, 0, res);
    try std.testing.expectEqualStrings("a.txt\n", res.stdout);
    try std.testing.expectEqualStrings("", res.stderr);

    var ar = try runZit(gpa, io, tmp.dir, &.{"addremove"});
    defer freeResult(gpa, &ar);
    try expectExitDiag(ar.term, 0, ar);
    try std.testing.expectEqualStrings("ADDED a.txt\n", ar.stdout);
    try std.testing.expectEqualStrings("", ar.stderr);
}

test "dotfiles: no notice without a dot entry, nor for dot entries with nothing untracked to show" {
    const gpa = std.testing.allocator;
    const io = std.testing.io;
    var tmp = std.testing.tmpDir(.{});
    defer tmp.cleanup();
    try initRepo(gpa, io, tmp.dir);
    try writeFile(io, tmp.dir, "a.txt", "a\n");

    var none = try runZit(gpa, io, tmp.dir, &.{"extras"});
    defer freeResult(gpa, &none);
    try expectExitDiag(none.term, 0, none);
    try std.testing.expectEqualStrings("a.txt\n", none.stdout);
    try std.testing.expectEqualStrings("", none.stderr);

    // A tracked dot file and a dot directory whose only file is tracked have
    // nothing `--dotfiles` would add to the listing, so nothing was hidden.
    try writeFile(io, tmp.dir, ".gitignore", "x\n");
    try tmp.dir.createDirPath(io, ".github");
    try writeFile(io, tmp.dir, ".github/ci.yml", "x\n");
    try addManaged(gpa, io, tmp.dir, &.{ ".gitignore", ".github/ci.yml" });

    var tracked = try runZit(gpa, io, tmp.dir, &.{"extras"});
    defer freeResult(gpa, &tracked);
    try expectExitDiag(tracked.term, 0, tracked);
    try std.testing.expectEqualStrings("a.txt\n", tracked.stdout);
    try std.testing.expectEqualStrings("", tracked.stderr);

    var ar = try runZit(gpa, io, tmp.dir, &.{ "addremove", "--dry-run" });
    defer freeResult(gpa, &ar);
    try expectExitDiag(ar.term, 0, ar);
    try std.testing.expectEqualStrings("ADDED a.txt\n", ar.stdout);
    try std.testing.expectEqualStrings("", ar.stderr);
}