fix: complete build isolation - no HOME pollution, no files outside out/

Author: rockygeekz

.gitignore

@@ -3,8 +3,7 @@
 # about not not using or creating files from user home directory directly (~).
 !media/
 .DS_Store
-.vite-dev-server-url
-.vite-dev.pid
+# Build tool caches (node-gyp, prek, etc.) - tests use out/*/tmp/home/.cache/
 .cache
 .eslintcache
 .idea
@@ -14,6 +13,7 @@
 *.pyc
 *.pyo
 .task
+# VS Code test framework user data - created by @vscode/test-electron
 .vscode-test
 node_modules
 out
@@ -22,14 +22,8 @@ dist
 lib
 
 # TODO: Seek to remove these from this file:
-.ansible
 CHANGELOG.html
 docs/als/settings.md
 examples/.vscode/
-packages/ansible-language-server/test/fixtures/diagnostics/invalid_yaml.yml
-resources/contentCreator/createDevcontainer/.devcontainer
-resources/contentCreator/createDevfile/devfile-template.txt
 test/testFixtures/.vscode/settings.json
-test/testFixtures/diagnostics/yaml/invalid_yaml.yml
-test/unit/lightspeed/utils/samples/collections/ansible_collections/community/broken_MANIFEST/MANIFEST.json
 xunit.xml

Taskfile.base.yml

@@ -30,8 +30,8 @@ tasks:
     generates:
       - "{{ .VIRTUAL_ENV }}/pyvenv.cfg"
       - "{{ .VIRTUAL_ENV }}/CACHEDIR.TAG"
-      - resources/contentCreator/createDevfile/devfile-template.txt
-      - resources/contentCreator/createDevcontainer/
+      - out/resources/contentCreator/createDevfile/devfile-template.txt
+      - out/resources/contentCreator/createDevcontainer/
     dir: "{{ .TASKFILE_DIR }}"
     sources:
       - pyproject.toml

Taskfile.yml

@@ -203,6 +203,7 @@ tasks:
       DONT_PROMPT_WSL_INSTALL: "1"
       # Possible workaround for: https://github.com/microsoft/vscode-test-cli/issues/555
       TMP: "{{ .TASKFILE_DIR }}/out/e2e/tmp"
+      TMPDIR: "{{ .TASKFILE_DIR }}/out/e2e/tmp"
     generates:
       - out/junit/e2e-test-results.xml
       - out/coverage/e2e/cobertura-coverage.xml
@@ -211,10 +212,7 @@ tasks:
     sources:
       - "{src,test}/**/*"
       - .vscode-test.mjs
-      - exclude: "**/.ansible/**/*"
       - exclude: test/testFixtures/.vscode/settings.json
-      - exclude: test/testFixtures/diagnostics/yaml/invalid_yaml.yml
-      - exclude: test/unit/lightspeed/utils/samples/collections/ansible_collections/community/broken_MANIFEST/MANIFEST.json
     cmds:
       - rimraf .vscode-test/user-data/logs/*
       - mkdir -p out/e2e/tmp
@@ -252,6 +250,9 @@ tasks:
     interactive: true
   unit:
     desc: Run unit tests with coverage report
+    env:
+      TMP: "{{ .TASKFILE_DIR }}/out/unit/tmp"
+      TMPDIR: "{{ .TASKFILE_DIR }}/out/unit/tmp"
     deps:
       - build
     sources:
@@ -263,6 +264,7 @@ tasks:
       - out/coverage/unit/lcov.info
       - out/junit/unit-test-results.xml
     cmds:
+      - mkdir -p out/unit/tmp
       - vitest run
     interactive: true
   package:
@@ -276,7 +278,6 @@ tasks:
       - .vscodeignore
       - CHANGELOG.md
       - README.md
-      - exclude: "**/.ansible/**/*"
       - exclude: "test/ui/**/*"
       - package*.json
       - tools/helper

eslint.config.mjs

@@ -6,7 +6,6 @@ import tsParser from "@typescript-eslint/parser";
 import prettierRecommendedConfig from "eslint-plugin-prettier/recommended";
 import globals from "globals";
 import path from "path";
-import { fileURLToPath } from "url";
 import { defineConfig } from "eslint/config";
 import { createRequire } from "module";
 import importPlugin from "eslint-plugin-import";
@@ -15,8 +14,6 @@ const require = createRequire(import.meta.url);
 /** @type {import('eslint').ESLint.Plugin} */
 const eslintPluginLocal = require("./test/eslint/eslint-plugin-local.cjs");
 
-const __filename = fileURLToPath(import.meta.url); // get the resolved path to the file
-const __dirname = path.dirname(__filename); // get the name of the directory
 const gitignorePath = path.resolve(import.meta.dirname, ".gitignore");
 
 export default defineConfig(
@@ -43,7 +40,7 @@ export default defineConfig(
       parser: tsParser,
       parserOptions: {
         projectService: true,
-        tsconfigRootDir: __dirname,
+        tsconfigRootDir: import.meta.dirname,
       },
     },
     plugins: {

packages/ansible-language-server/Taskfile.yml

@@ -46,6 +46,9 @@ tasks:
     desc: Run all tests using node (same version as vscode), will skip @ee tests if both SKIP_PODMAN=1 and SKIP_DOCKER=1.
     dir: "{{ .TASKFILE_DIR }}"
     interactive: true
+    env:
+      TMP: "{{ .TASKFILE_DIR }}/../../out/als/tmp"
+      TMPDIR: "{{ .TASKFILE_DIR }}/../../out/als/tmp"
     deps:
       - build
     sources:
@@ -62,6 +65,7 @@ tasks:
       - ../../out/coverage/unit/lcov.info # sonar
       - ../../out/junit/unit-test-results.xml
     cmds:
+      - mkdir -p ../../out/als/tmp
       - bash -c ". {{.VIRTUAL_ENV}}/bin/activate && command -v ansible-lint && pnpm run test"
   test-with-ee:
     dir: '{{ .TASKFILE_DIR }}'

packages/ansible-language-server/test/fixtures/diagnostics/invalid_yaml.yml

@@ -3,6 +3,6 @@
   hosts: localhost
   tasks:
   # This  following line is invalid and has been kept this way to test the YAML diagnostics features of extension.
-  # The file is ignored while running yammlint pre-commit hook.
+  # The file is ignored while running yamllint pre-commit hook.
     - debug: msg="foo: bar"
 become: true

packages/ansible-language-server/test/globalSetup.ts

@@ -2,6 +2,7 @@
 import { isWindows, console } from "@test/helper.js";
 import { spawn, spawnSync, SpawnSyncOptions } from "child_process";
 import path from "path";
+import fs from "fs";
 import { createRequire } from "module";
 import { quote } from "shell-quote";
 
@@ -66,6 +67,12 @@ function execWithTimeout(
 }
 
 export async function setup() {
+  // Isolate HOME for language server tests to prevent writing to user's home directory
+  const testHome = path.resolve(__dirname, "../../../out/als/tmp/home");
+  fs.mkdirSync(testHome, { recursive: true });
+  process.env.HOME = testHome;
+  process.env.USERPROFILE = testHome; // Windows uses USERPROFILE instead of HOME
+
   // Only run prerequisite checks when actually running tests, not when listing
   // Check if we're in list mode by checking command line arguments
   const isListing =

packages/ansible-language-server/test/helper.ts

@@ -15,7 +15,7 @@ import type { ExtensionSettings } from "@src/interfaces/extensionSettings.js";
 
 import Fuse from "fuse.js";
 
-const FIXTURES_BASE_PATH = path.join(__dirname, "fixtures");
+export const FIXTURES_BASE_PATH = path.join(__dirname, "fixtures");
 const ANSIBLE_COLLECTIONS_FIXTURES_BASE_PATH = path.resolve(
   FIXTURES_BASE_PATH,
   "common",

packages/ansible-language-server/test/utils/getAnsibleMetaData.test.ts

@@ -1,14 +1,13 @@
 import { expect, beforeAll, afterAll } from "vitest";
 import * as path from "path";
-import { fileURLToPath } from "url";
-import { dirname } from "path";
 import {
   ansibleMetaDataEntryType,
   ansibleMetaDataType,
   getAnsibleMetaData,
   getResultsThroughCommandRunner,
 } from "@src/utils/getAnsibleMetaData.js";
 import {
+  FIXTURES_BASE_PATH,
   createTestWorkspaceManager,
   disableExecutionEnvironmentSettings,
   enableExecutionEnvironmentSettings,
@@ -17,30 +16,23 @@ import {
   setFixtureAnsibleCollectionPathEnv,
 } from "@test/helper.js";
 
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = dirname(__filename);
-
 function getAnsibleTestInfo() {
   const ansibleInfo: ansibleMetaDataEntryType = {};
   ansibleInfo["core version"] = ".";
   ansibleInfo["location"] = "/ansible";
   ansibleInfo["config file path"] = path.resolve(
-    __dirname,
-    "..",
-    "fixtures",
+    FIXTURES_BASE_PATH,
     "utils",
     "getAnsibleMetaData",
     "ansible.cfg",
   );
   ansibleInfo["collections location"] = [
-    path.resolve(__dirname, "..", "fixtures", "common", "collections"),
+    path.resolve(FIXTURES_BASE_PATH, "common", "collections"),
   ];
   ansibleInfo["module location"] = ["/modules"];
   ansibleInfo["default host list path"] = [
     path.resolve(
-      __dirname,
-      "..",
-      "fixtures",
+      FIXTURES_BASE_PATH,
       "utils",
       "getAnsibleMetaData",
       "inventory",

packages/ansible-language-server/test/utils/pathUtils.test.ts

@@ -1,14 +1,10 @@
 import { expect } from "vitest";
 import * as path from "path";
-import { fileURLToPath } from "url";
-import { dirname } from "path";
 import { globArray } from "@src/utils/pathUtils.js";
-
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = dirname(__filename);
+import { FIXTURES_BASE_PATH } from "@test/helper.js";
 
 describe("docsFinder", function () {
-  const dir = path.resolve(__dirname, "..", "fixtures", "utils", "docsFinder");
+  const dir = path.resolve(FIXTURES_BASE_PATH, "utils", "docsFinder");
 
   describe("globArray()", function () {
     const tests = [