default for XDG_RUNTIME_DIR for mac/linux

Author: eleanorjboyd

.vscode/launch.json

@@ -144,14 +144,15 @@
             "stopOnEntry": false,
             "sourceMaps": true,
             "args": [
-                "./out/test/**/*.unit.test.js",
-                "--require=out/test/unittests.js",
-                "--ui=tdd",
-                "--recursive",
-                "--colors",
-                //"--grep", "<suite name>",
-                "--timeout=300000"
-            ],
+                        "./out/test/**/*.unit.test.js",
+                        "--require=out/test/unittests.js",
+                        "--ui=tdd",
+                        "--recursive",
+                        "--colors",
+                        "--grep",
+                        "getTempDir tests",
+                        "--timeout=300000"
+                    ],
             "outFiles": ["${workspaceFolder}/out/**/*.js", "!${workspaceFolder}/**/node_modules**/*"],
             "preLaunchTask": "Compile",
             "skipFiles": ["<node_internals>/**"]

src/client/testing/testController/common/utils.ts

@@ -38,6 +38,22 @@ interface ExecutionResultMessage extends Message {
     params: ExecutionTestPayload;
 }
 
+/**
+ * Retrieves the path to the temporary directory.
+ * 
+ * On Windows, it returns the default temporary directory.
+ * On macOS/Linux, it prefers the `XDG_RUNTIME_DIR` environment variable if set,
+ * otherwise, it falls back to the default temporary directory.
+ * 
+ * @returns {string} The path to the temporary directory.
+ */
+function getTempDir(): string {
+    if (process.platform === 'win32') {
+        return os.tmpdir(); // Default Windows behavior
+    }
+    return process.env.XDG_RUNTIME_DIR || os.tmpdir(); // Prefer XDG_RUNTIME_DIR on macOS/Linux
+}
+
 /**
  * Writes an array of test IDs to a temporary file.
  *
@@ -50,11 +66,12 @@ export async function writeTestIdsFile(testIds: string[]): Promise<string> {
     const tempName = `test-ids-${randomSuffix}.txt`;
     // create temp file
     let tempFileName: string;
+    const tempDir: string = getTempDir();
     try {
         traceLog('Attempting to use temp directory for test ids file, file name:', tempName);
-        tempFileName = path.join(os.tmpdir(), tempName);
+        tempFileName = path.join(tempDir, tempName);
         // attempt access to written file to check permissions
-        await fs.promises.access(os.tmpdir());
+        await fs.promises.access(tempDir);
     } catch (error) {
         // Handle the error when accessing the temp directory
         traceError('Error accessing temp directory:', error, ' Attempt to use extension root dir instead');

src/test/testing/testController/utils.unit.test.ts

@@ -48,3 +48,79 @@ suite('writeTestIdsFile tests', () => {
         assert.ok(writeFileStub.calledOnceWith(sinon.match.string, testIds.join('\n')));
     });
 });
+
+suite('getTempDir tests', () => {
+    let sandbox: sinon.SinonSandbox;
+    let originalPlatform: NodeJS.Platform;
+    let originalEnv: NodeJS.ProcessEnv;
+
+    setup(() => {
+        sandbox = sinon.createSandbox();
+        originalPlatform = process.platform;
+        originalEnv = process.env;
+    });
+
+    teardown(() => {
+        sandbox.restore();
+        Object.defineProperty(process, 'platform', { value: originalPlatform });
+        process.env = originalEnv;
+    });
+
+    test('should use os.tmpdir on Windows', async () => {
+        // Force platform to be Windows
+        Object.defineProperty(process, 'platform', { value: 'win32' });
+
+        const tmpDirStub = sandbox.stub(os, 'tmpdir').returns('/windows/temp/path');
+
+        const testIds = ['test1', 'test2', 'test3'];
+        sandbox.stub(fs.promises, 'access').resolves();
+        sandbox.stub(fs.promises, 'writeFile').resolves();
+
+        // This will use getTempDir internally
+        const result = await writeTestIdsFile(testIds);
+
+        assert.ok(result.startsWith('/windows/temp/path'));
+        assert.strictEqual(tmpDirStub.callCount, 1);
+    });
+
+    test('should use XDG_RUNTIME_DIR on non-Windows if available', async () => {
+        // Force platform to be Linux
+        Object.defineProperty(process, 'platform', { value: 'linux' });
+
+        // Set up XDG_RUNTIME_DIR
+        process.env = { ...process.env, XDG_RUNTIME_DIR: '/xdg/runtime/dir' };
+
+        const tmpDirStub = sandbox.stub(os, 'tmpdir').returns('/fallback/tmp/dir');
+
+        const testIds = ['test1', 'test2', 'test3'];
+        sandbox.stub(fs.promises, 'access').resolves();
+        sandbox.stub(fs.promises, 'writeFile').resolves();
+
+        // This will use getTempDir internally
+        const result = await writeTestIdsFile(testIds);
+
+        assert.ok(result.startsWith('/xdg/runtime/dir'));
+        assert.strictEqual(tmpDirStub.callCount, 0); // tmpdir should not be called
+    });
+
+    test('should fall back to os.tmpdir on non-Windows if XDG_RUNTIME_DIR not available', async () => {
+        // Force platform to be macOS
+        Object.defineProperty(process, 'platform', { value: 'darwin' });
+
+        // Ensure XDG_RUNTIME_DIR is not set
+        process.env = { ...process.env };
+        delete process.env.XDG_RUNTIME_DIR;
+
+        const tmpDirStub = sandbox.stub(os, 'tmpdir').returns('/fallback/tmp/dir');
+
+        const testIds = ['test1', 'test2', 'test3'];
+        sandbox.stub(fs.promises, 'access').resolves();
+        sandbox.stub(fs.promises, 'writeFile').resolves();
+
+        // This will use getTempDir internally
+        const result = await writeTestIdsFile(testIds);
+
+        assert.ok(result.startsWith('/fallback/tmp/dir'));
+        assert.strictEqual(tmpDirStub.callCount, 1);
+    });
+});