[TASK] Add more tests for utils

package.json

@@ -43,8 +43,10 @@
   },
   "devDependencies": {
     "@jest/globals": "^29.7.0",
+    "@types/mock-fs": "^4.13.4",
     "@types/node": "^20.8.2",
     "jest": "^29.7.0",
+    "mock-fs": "^5.2.0",
     "prettier": "^3.0.3",
     "ts-jest": "^29.1.2",
     "typescript": "^5.2.2",

src/utils.ts

@@ -18,7 +18,7 @@ export function initializePluginConfig(
 }
 
 export function readJsonFile(file: string): any {
-    return JSON.parse(readFileSync(file, "utf-8")) || {};
+    return JSON.parse(readFileSync(file, "utf-8"));
 }
 
 export function isComposerRoot(file: string): boolean {

test/fixtures/composerProject/vendor/composer/installed.json

@@ -0,0 +1,5 @@
+{
+    "packages": [
+
+    ]
+}

test/utils.test.ts

@@ -1,27 +1,76 @@
-import { describe, expect, test } from "@jest/globals";
-import { isComposerRoot } from "../src/utils";
+import { describe, expect, test, beforeAll, afterAll } from "@jest/globals";
+import { determineComposerRoot, isComposerRoot, readJsonFile } from "../src/utils";
 import { resolve } from "node:path";
+import mockFs from "mock-fs";
 
-describe("utils module", () => {
-    test("checks projectComposerFile.json to be valid root composer file", () => {
+beforeAll(() => {
+    mockFs({
+        "/path/to/fixtures": mockFs.load(resolve(__dirname, "fixtures"))
+    });
+})
+afterAll(() => {
+    mockFs.restore();
+})
+
+describe("isComposerRoot", () => {
+    test("checks project composer.json to be valid root composer file", () => {
         expect(
-            isComposerRoot(
-                resolve(__dirname, "fixtures/projectComposerFile.json"),
-            ),
+            isComposerRoot("/path/to/fixtures/composerProject/composer.json")
         ).toBe(true);
     });
-    test("checks extensionComposerFile.json to be invalid root composer file", () => {
+    test("checks extension composer.json to be invalid root composer file", () => {
         expect(
-            isComposerRoot(
-                resolve(__dirname, "fixtures/extensionComposerFile.json"),
-            ),
+            isComposerRoot("/path/to/fixtures/composerProject/packages/composerExtension/composer.json")
         ).toBe(false);
     });
-    test("checks libraryComposerFile.json to be invalid root composer file", () => {
+    test("checks library composer.json to be invalid root composer file", () => {
         expect(
-            isComposerRoot(
-                resolve(__dirname, "fixtures/libraryComposerFile.json"),
-            ),
+            isComposerRoot("/path/to/fixtures/composerProject/vendor/namespace/library/composer.json")
         ).toBe(false);
     });
 });
+
+describe("readJsonFile", () => {
+    test("reads composer.json as json", () => {
+        expect(
+            readJsonFile("/path/to/fixtures/composerProject/vendor/namespace/library/composer.json")
+        ).toEqual({"type": "library"});
+    });
+});
+
+describe("determineComposerRoot", () => {
+    test("determines composer root from extension path", () => {
+        expect(
+            determineComposerRoot("/path/to/fixtures/composerProject/packages/composerExtension")
+        ).toBe("/path/to/fixtures/composerProject");
+    });
+    test("determines composer root from library path", () => {
+        expect(
+            determineComposerRoot("/path/to/fixtures/composerProject/vendor/namespace/library")
+        ).toBe("/path/to/fixtures/composerProject");
+    });
+    test("determines composer root from root path", () => {
+        expect(
+            determineComposerRoot("/path/to/fixtures/composerProject")
+        ).toBe("/path/to/fixtures/composerProject");
+    });
+    test("determines composer root from other path", () => {
+        expect(
+            determineComposerRoot("/path/to/fixtures/composerProject/packages")
+        ).toBe("/path/to/fixtures/composerProject");
+    });
+
+    test("fail to determine composer root from extension path", () => {
+        expect(
+            determineComposerRoot("/path/to/fixtures/nonComposerProject/typo3conf/ext/non_composer_extension")
+        ).toBe("/path/to/fixtures/nonComposerProject/typo3conf/ext/non_composer_extension");
+    });
+    test("fail to determine composer root from extension path with fallback root specified", () => {
+        expect(
+            determineComposerRoot(
+                "/path/to/fixtures/nonComposerProject/typo3conf/ext/non_composer_extension",
+                "/path/to/fixtures/nonComposerProject",
+            )
+        ).toBe("/path/to/fixtures/nonComposerProject");
+    });
+});