Add a "same path" comparer

Author: leeyi45

lib/buildtools/src/testing/utils.ts

@@ -4,7 +4,7 @@ import { gitRoot } from '@sourceacademy/modules-repotools/getGitRoot';
 import { resolveSingleBundle, resolveSingleTab } from '@sourceacademy/modules-repotools/manifest';
 import { baseVitestConfig, loadVitestConfigFromDir, sharedTabsConfig } from '@sourceacademy/modules-repotools/testing';
 import type { ErrorResult } from '@sourceacademy/modules-repotools/types';
-import { isNodeError, mapAsync } from '@sourceacademy/modules-repotools/utils';
+import { isNodeError, isSamePath, mapAsync } from '@sourceacademy/modules-repotools/utils';
 import cloneDeep from 'lodash/cloneDeep.js';
 import partition from 'lodash/partition.js';
 import type { LabelColor } from 'vitest';
@@ -86,7 +86,7 @@ export async function getTestConfiguration(directory: string, watch: boolean): P
    * directory, throw an error.
    */
   async function findPackageJson(directory: string): Promise<['bundle' | 'tab' | 'config', string] | null> {
-    if (directory === gitRoot) return null;
+    if (isSamePath(directory, gitRoot)) return null;
 
     try {
       const jsonPath = pathlib.join(directory, 'package.json');

lib/buildtools/vitest.setup.ts

@@ -1,5 +1,6 @@
 // Buildtools vitest setup
 import pathlib from 'path';
+import { isSamePath } from '@sourceacademy/modules-repotools/utils';
 import { expect, vi } from 'vitest';
 
 class MockProcessError extends Error {
@@ -128,10 +129,10 @@ expect.extend({
     }
   },
   toMatchPath(received: string, expected: string) {
-    const output = pathlib.relative(received, expected);
+    const result = isSamePath(received, expected);
     return {
-      pass: output === '',
-      message: () => `${received} ${output === '' ? 'did not resolve' : 'resolved'} to ${expected}`,
+      pass: result,
+      message: () => `${received} ${result ? 'did not resolve' : 'resolved'} to ${expected}`,
     };
   }
 });

lib/repotools/src/utils.ts

@@ -155,3 +155,21 @@ type ArrayOfLength<T extends number, U = unknown, V extends U[] = []> =
 export function arrayIsLength<T extends number>(obj: unknown, length: T): obj is ArrayOfLength<T> {
   return Array.isArray(obj) && obj.length === length;
 }
+
+/**
+ * If the provided path is already a posix path, then this function does nothing.\
+ * Otherwise, it will return Windows paths with the path separators replaced.
+ */
+export function convertToPosixPath(p: string) {
+  return pathlib.posix.join(...p.split(pathlib.sep));
+}
+
+/**
+ * Returns `true` if both paths refer to the same location. This
+ * function should be OS agnostic
+ */
+export function isSamePath(lhs: string, rhs: string) {
+  const relpath = pathlib.relative(lhs, rhs);
+  console.log('relpath for', lhs, 'and', rhs, 'is', relpath);
+  return relpath === '';
+}

lib/repotools/vitest.config.js

@@ -9,7 +9,7 @@ const config = {
     ...rootConfig.test,
     name: 'Repo Tools',
     root: import.meta.dirname,
-    include: ['**/__tests__/*.test.ts'],
+    include: ['**/__tests__/**/*.test.ts'],
     watch: false,
     projects: undefined
   }