glob-assets.test.js

import path from "path";
import test from "ava";
import { copy, ensureDir } from "fs-extra";
import { isPlainObject, sortBy } from "lodash-es";
import tempy from "tempy";
import globAssets from "../lib/glob-assets.js";

const sortAssets = (assets) => sortBy(assets, (asset) => (isPlainObject(asset) ? asset.path : asset));

const fixtures = "test/fixtures/files";

test("Retrieve file from single path", async (t) => {
  const cwd = tempy.directory();
  await copy(fixtures, cwd);
  const globbedAssets = await globAssets({ cwd }, ["upload.txt"]);

  t.deepEqual(globbedAssets, ["upload.txt"]);
});

test("Retrieve multiple files from path", async (t) => {
  const cwd = tempy.directory();
  await copy(fixtures, cwd);
  const globbedAssets = await globAssets({ cwd }, ["upload.txt", "upload_other.txt"]);

  t.deepEqual(sortAssets(globbedAssets), sortAssets(["upload_other.txt", "upload.txt"]));
});

test("Include missing files as defined, using Object definition", async (t) => {
  const cwd = tempy.directory();
  await copy(fixtures, cwd);
  const globbedAssets = await globAssets({ cwd }, ["upload.txt", { path: "miss*.txt", label: "Missing" }]);

  t.deepEqual(sortAssets(globbedAssets), sortAssets(["upload.txt", { path: "miss*.txt", label: "Missing" }]));
});

test("Retrieve multiple files from Object", async (t) => {
  const cwd = tempy.directory();
  await copy(fixtures, cwd);
  const globbedAssets = await globAssets({ cwd }, [
    { path: "upload.txt", name: "upload_name", label: "Upload label" },
    "upload_other.txt",
  ]);

  t.deepEqual(
    sortAssets(globbedAssets),
    sortAssets([{ path: "upload.txt", name: "upload_name", label: "Upload label" }, "upload_other.txt"])
  );
});

test("Retrieve multiple files without duplicates", async (t) => {
  const cwd = tempy.directory();
  await copy(fixtures, cwd);
  const globbedAssets = await globAssets({ cwd }, [
    "upload_other.txt",
    "upload.txt",
    "upload_other.txt",
    "upload.txt",
    "upload.txt",
    "upload_other.txt",
  ]);

  t.deepEqual(sortAssets(globbedAssets), sortAssets(["upload_other.txt", "upload.txt"]));
});

test("Favor Object over String values when removing duplicates", async (t) => {
  const cwd = tempy.directory();
  await copy(fixtures, cwd);
  const globbedAssets = await globAssets({ cwd }, [
    "upload_other.txt",
    "upload.txt",
    { path: "upload.txt", name: "upload_name" },
    "upload.txt",
    { path: "upload_other.txt", name: "upload_other_name", filepath: "/path/to/other" },
    "upload.txt",
    "upload_other.txt",
  ]);

  t.deepEqual(
    sortAssets(globbedAssets),
    sortAssets([
      { path: "upload.txt", name: "upload_name" },
      { path: "upload_other.txt", name: "upload_other_name", filepath: "/path/to/other" },
    ])
  );
});

test("Retrieve file from single glob", async (t) => {
  const cwd = tempy.directory();
  await copy(fixtures, cwd);
  const globbedAssets = await globAssets({ cwd }, ["upload.*"]);

  t.deepEqual(globbedAssets, ["upload.txt"]);
});

test("Retrieve multiple files from single glob", async (t) => {
  const cwd = tempy.directory();
  await copy(fixtures, cwd);
  const globbedAssets = await globAssets({ cwd }, ["*.txt"]);

  t.deepEqual(sortAssets(globbedAssets), sortAssets(["upload_other.txt", "upload.txt"]));
});

test("Accept glob array with one value", async (t) => {
  const cwd = tempy.directory();
  await copy(fixtures, cwd);
  const globbedAssets = await globAssets({ cwd }, [["*load.txt"], ["*_other.txt"]]);

  t.deepEqual(sortAssets(globbedAssets), sortAssets(["upload_other.txt", "upload.txt"]));
});

test("Include globs that resolve to no files as defined", async (t) => {
  const cwd = tempy.directory();
  await copy(fixtures, cwd);
  const globbedAssets = await globAssets({ cwd }, [["upload.txt", "!upload.txt"]]);

  t.deepEqual(sortAssets(globbedAssets), sortAssets(["!upload.txt", "upload.txt"]));
});

test("Accept glob array with one value for missing files", async (t) => {
  const cwd = tempy.directory();
  await copy(fixtures, cwd);
  const globbedAssets = await globAssets({ cwd }, [["*missing.txt"], ["*_other.txt"]]);

  t.deepEqual(sortAssets(globbedAssets), sortAssets(["upload_other.txt", "*missing.txt"]));
});

test("Replace name by filename for Object that match multiple files", async (t) => {
  const cwd = tempy.directory();
  await copy(fixtures, cwd);
  const globbedAssets = await globAssets({ cwd }, [{ path: "*.txt", label: "Upload label" }]);

  t.deepEqual(
    sortAssets(globbedAssets),
    sortAssets([
      { path: "upload.txt", label: "upload.txt" },
      { path: "upload_other.txt", label: "upload_other.txt" },
    ])
  );
});

test("Ignore filepath for Object that match multiple files", async (t) => {
  const cwd = tempy.directory();
  await copy(fixtures, cwd);
  const globbedAssets = await globAssets({ cwd }, [{ path: "*.txt", filepath: "/path/to/file" }]);

  t.deepEqual(
    sortAssets(globbedAssets),
    sortAssets([
      { path: "upload.txt", label: "upload.txt" },
      { path: "upload_other.txt", label: "upload_other.txt" },
    ])
  );
});

test("Include dotfiles", async (t) => {
  const cwd = tempy.directory();
  await copy(fixtures, cwd);
  const globbedAssets = await globAssets({ cwd }, [".dot*"]);

  t.deepEqual(globbedAssets, [".dotfile"]);
});

test("Ingnore single negated glob", async (t) => {
  const cwd = tempy.directory();
  await copy(fixtures, cwd);
  const globbedAssets = await globAssets({ cwd }, ["!*.txt"]);

  t.deepEqual(globbedAssets, []);
});

test("Ingnore single negated glob in Object", async (t) => {
  const cwd = tempy.directory();
  await copy(fixtures, cwd);
  const globbedAssets = await globAssets({ cwd }, [{ path: "!*.txt" }]);

  t.deepEqual(globbedAssets, []);
});

test("Accept negated globs", async (t) => {
  const cwd = tempy.directory();
  await copy(fixtures, cwd);
  const globbedAssets = await globAssets({ cwd }, [["*.txt", "!**/*_other.txt"]]);

  t.deepEqual(globbedAssets, ["upload.txt"]);
});

test("Expand directories", async (t) => {
  const cwd = tempy.directory();
  await copy(fixtures, path.resolve(cwd, "dir"));
  const globbedAssets = await globAssets({ cwd }, [["dir"]]);

  t.deepEqual(
    sortAssets(globbedAssets),
    sortAssets(["dir", "dir/upload_other.txt", "dir/upload.txt", "dir/.dotfile", "dir/file.css"])
  );
});

test("Include empty directory as defined", async (t) => {
  const cwd = tempy.directory();
  await copy(fixtures, cwd);
  await ensureDir(path.resolve(cwd, "empty"));
  const globbedAssets = await globAssets({ cwd }, [["empty"]]);

  t.deepEqual(globbedAssets, ["empty"]);
});

test("Deduplicate resulting files path", async (t) => {
  const cwd = tempy.directory();
  await copy(fixtures, cwd);
  const globbedAssets = await globAssets({ cwd }, ["./upload.txt", path.resolve(cwd, "upload.txt"), "upload.txt"]);

  t.is(globbedAssets.length, 1);
});