chore: write tests

Signed-off-by: Jakub Freisler <[email protected]>

Author: FRSgit

src/afterScreenshot.hook.test.ts

@@ -1,9 +1,9 @@
 import { it, expect, describe } from "vitest";
 import path from "path";
 import { promises as fs, existsSync } from "fs";
-import { initAfterScreenshotHook } from "./afterScreenshot.hook";
+import { initAfterScreenshotHook, parseAbsolutePath } from "./afterScreenshot.hook";
 import { dir, file, setGracefulCleanup } from "tmp-promise";
-import { IMAGE_SNAPSHOT_PREFIX } from "./constants";
+import { IMAGE_SNAPSHOT_PREFIX, PATH_VARIABLES } from "./constants";
 
 setGracefulCleanup();
 
@@ -31,3 +31,23 @@ describe("initAfterScreenshotHook", () => {
     await fs.unlink(expectedNewPath);
   });
 });
+
+describe('parseAbsolutePath', () => {
+  const projectRoot = '/its/project/root';
+
+  it('resolves relative paths against project root', () => {
+    expect(parseAbsolutePath({ screenshotPath: 'some/path.png', projectRoot }))
+      .toBe('/its/project/root/some/path.png');
+  });
+
+  it('builds proper win paths when found', () => {
+    expect(parseAbsolutePath({ screenshotPath: `${PATH_VARIABLES.winSystemRootPath}/D/some/path.png`, projectRoot }))
+    // that's expected output accorind to https://stackoverflow.com/a/64135721/8805801
+    .toBe('D:\\/some/path.png');
+  });
+
+  it('resolves relative paths against project root', () => {
+    expect(parseAbsolutePath({ screenshotPath: `${PATH_VARIABLES.unixSystemRootPath}/some/path.png`, projectRoot }))
+      .toBe('/some/path.png');
+  });
+});

src/afterScreenshot.hook.ts

@@ -25,7 +25,7 @@ const getConfigVariableOrThrow = <K extends keyof Cypress.PluginConfigOptions>(
 };
 /* c8 ignore stop */
 
-const parseAbsolutePath = ({
+export const parseAbsolutePath = ({
   screenshotPath,
   projectRoot,
 }: {

src/task.hook.test.ts

@@ -22,17 +22,48 @@ const writeTmpFixture = async (pathToWriteTo: string, fixtureName: string) =>
   );
 
 describe("getScreenshotPathTask", () => {
+  const specPath = "some/nested/spec-path/spec.ts";
   it("returns sanitized path", () => {
     expect(
       getScreenshotPathTask({
         title: "some-title-withśpęćiał人物",
-        imagesDir: "nested/images/dir",
-        specPath: "some/nested/spec-path/spec.ts",
+        imagesPath: "nested/images/dir",
+        specPath,
       })
     ).toBe(
-      "__cp-visual-regression-diff_snapshots__/some/nested/spec-path/nested/images/dir/some-title-withśpęćiał人物.actual.png"
+      "__cp-visual-regression-diff_snapshots__/nested/images/dir/some-title-withśpęćiał人物.actual.png"
     );
   });
+
+  it("supports {spec_path} variable", () => {
+    expect(
+      getScreenshotPathTask({
+        title: "some-title",
+        imagesPath: "{spec_path}/images/dir",
+        specPath,
+      })
+    ).toBe(
+      "__cp-visual-regression-diff_snapshots__/some/nested/spec-path/images/dir/some-title.actual.png"
+    );
+  });
+
+  it("supports OS-specific absolute paths", () => {
+    expect(
+      getScreenshotPathTask({
+        title: "some-title",
+        imagesPath: "/images/dir",
+        specPath,
+      })
+    ).toBe("__cp-visual-regression-diff_snapshots__/{unix_system_root_path}/images/dir/some-title.actual.png");
+
+    expect(
+      getScreenshotPathTask({
+        title: "some-title",
+        imagesPath: "C:/images/dir",
+        specPath,
+      })
+    ).toBe("__cp-visual-regression-diff_snapshots__/{win_system_root_path}/C/images/dir/some-title.actual.png");
+  });
 });
 
 describe("approveImageTask", () => {