Setup Windows GH actions job (#1195)

* Setup Windows GH actions jobs

We cannot use the existing windows job setup because it launches a
docker container which we cannot open a VS Code window in to run
the tests as no tool like Xvfb exists for Windows

This patch goes through and fixes up tests and behaviours that were
incorrect on Windows.

Co-authored-by: Paul LeMarquand <[email protected]>
Co-authored-by: Michael (SPG) Weng <[email protected]>

.github/workflows/pull_request.yml

@@ -9,6 +9,7 @@ jobs:
     name: Test
     uses: swiftlang/github-workflows/.github/workflows/swift_package_test.yml@main
     with:
+      # Linux
       linux_exclude_swift_versions: '[{"swift_version": "nightly-main"}]'
       linux_env_vars: |
         NODE_VERSION=v18.19.0
@@ -23,7 +24,15 @@ jobs:
         /bin/bash -c "source $NVM_DIR/nvm.sh && nvm install $NODE_VERSION"
         echo "$NODE_PATH" >> $GITHUB_PATH
       linux_build_command: ./docker/test.sh
-      enable_windows_checks: false
+      # Windows
+      windows_exclude_swift_versions: '[{"swift_version": "nightly"}]'
+      windows_env_vars: |
+        CI=1
+        VSCODE_TEST=1
+        FAST_TEST_RUN=1
+      windows_pre_build_command: .github\workflows\scripts\windows\install-nodejs.ps1
+      windows_build_command: docker\test-windows.ps1
+      enable_windows_docker: false
 
   soundness:
     name: Soundness

.github/workflows/scripts/windows/install-nodejs.ps1

@@ -0,0 +1,24 @@
+$NODEJS='https://nodejs.org/dist/v18.20.4/node-v18.20.4-x64.msi'
+$NODEJS_SHA256='c2654d3557abd59de08474c6dd009b1d358f420b8e4010e4debbf130b1dfb90a'
+Set-Variable ErrorActionPreference Stop
+Set-Variable ProgressPreference SilentlyContinue
+Write-Host -NoNewLine ('Downloading {0} ... ' -f ${NODEJS})
+Invoke-WebRequest -Uri ${NODEJS} -OutFile  $env:TEMP\node.msi
+Write-Host 'SUCCESS'
+Write-Host -NoNewLine ('Verifying SHA256 ({0}) ... ' -f ${NODEJS_SHA256})
+$Hash = Get-FileHash $env:TEMP\node.msi -Algorithm sha256
+if ($Hash.Hash -eq ${NODEJS_SHA256}) {
+    Write-Host 'SUCCESS'
+} else {
+    Write-Host  ('FAILED ({0})' -f $Hash.Hash)
+    exit 1
+}
+Write-Host -NoNewLine 'Installing node.js for Windows ... '
+$Process = Start-Process msiexec "/i  $env:TEMP\node.msi /norestart /qn" -Wait -PassThru
+if ($Process.ExitCode -eq 0) {
+    Write-Host 'SUCCESS'
+} else {
+    Write-Host  ('FAILED ({0})' -f $Process.ExitCode)
+    exit 1
+}
+Remove-Item -Force $env:TEMP\node.msi

.vscode-test.js

@@ -53,6 +53,7 @@ module.exports = defineConfig({
                 },
             },
             reuseMachineInstall: !isCIBuild,
+            installExtensions: ["vadimcn.vscode-lldb"],
         },
         {
             label: "unitTests",

docker/test-windows.ps1

@@ -0,0 +1,13 @@
+$env:CI = "1"
+$env:FAST_TEST_RUN = "1"
+npm ci -ignore-script node-pty
+npm run lint
+npm run format
+npm run package
+$Process = Start-Process npm "run integration-test" -Wait -PassThru -NoNewWindow
+if ($Process.ExitCode -eq 0) {
+    Write-Host 'SUCCESS'
+} else {
+    Write-Host  ('FAILED ({0})' -f $Process.ExitCode)
+    exit 1
+}

package.json

@@ -1280,7 +1280,7 @@
     "pretest": "npm run compile-tests",
     "soundness": "docker compose -f docker/docker-compose.yaml -p swift-vscode-soundness-prb run --rm soundness",
     "test-soundness": "scripts/soundness.sh",
-    "test": "VSCODE_TEST=1 vscode-test",
+    "test": "vscode-test",
     "test-ci": "docker/test-ci.sh ci",
     "test-nightly": "docker/test-ci.sh nightly",
     "integration-test": "npm test -- --label integrationTests",

src/DiagnosticsManager.ts

@@ -89,13 +89,13 @@ export class DiagnosticsManager implements vscode.Disposable {
                 .then(map => {
                     // Clean up old "swiftc" diagnostics
                     this.removeSwiftcDiagnostics();
-                    map.forEach((diagnostics, uri) =>
+                    map.forEach((diagnostics, uri) => {
                         this.handleDiagnostics(
                             vscode.Uri.file(uri),
                             DiagnosticsManager.isSwiftc,
                             diagnostics
-                        )
-                    );
+                        );
+                    });
                 })
                 .catch(e =>
                     context.outputChannel.log(`${e}`, 'Failed to provide "swiftc" diagnostics')

src/FolderContext.ts

@@ -152,7 +152,10 @@ export class FolderContext implements vscode.Disposable {
 
     /** Create Test explorer for this folder */
     addTestExplorer() {
-        this.testExplorer = new TestExplorer(this);
+        if (this.testExplorer === undefined) {
+            this.testExplorer = new TestExplorer(this);
+        }
+        return this.testExplorer;
     }
 
     /** Create Test explorer for this folder */

src/TestExplorer/TestParsers/XCTestOutputParser.ts

@@ -15,6 +15,8 @@
 import { ITestRunState, TestIssueDiff } from "./TestRunState";
 import { sourceLocationToVSCodeLocation } from "../../utilities/utilities";
 import { MarkdownString, Location } from "vscode";
+// eslint-disable-next-line @typescript-eslint/no-require-imports
+import stripAnsi = require("strip-ansi");
 
 /** Regex for parsing XCTest output */
 interface TestRegex {
@@ -148,7 +150,10 @@ export class XCTestOutputParser implements IXCTestOutputParser {
      * Parse results from `swift test` and update tests accordingly
      * @param output Output from `swift test`
      */
-    public parseResult(output: string, runState: ITestRunState) {
+    public parseResult(rawOutput: string, runState: ITestRunState) {
+        // Windows is inserting ANSI codes into the output to do things like clear the cursor,
+        // which we don't care about.
+        const output = process.platform === "win32" ? stripAnsi(rawOutput) : rawOutput;
         const output2 = output.replace(/\r\n/g, "\n");
         const lines = output2.split("\n");
         if (runState.excess) {

src/TestExplorer/TestRunner.ts

@@ -40,6 +40,8 @@ import { BuildConfigurationFactory, TestingConfigurationFactory } from "../debug
 import { TestKind, isDebugging, isRelease } from "./TestKind";
 import { reduceTestItemChildren } from "./TestUtils";
 import { CompositeCancellationToken } from "../utilities/cancellation";
+// eslint-disable-next-line @typescript-eslint/no-require-imports
+import stripAnsi = require("strip-ansi");
 
 export enum TestLibrary {
     xctest = "XCTest",
@@ -264,7 +266,7 @@ export class TestRunProxy {
         test?: vscode.TestItem
     ) {
         testRun.appendOutput(output, location, test);
-        this.runState.output.push(output);
+        this.runState.output.push(stripAnsi(output));
     }
 
     private prependIterationToOutput(output: string): string {

src/commands/build.ts

@@ -74,16 +74,28 @@ export async function debugBuildWithOptions(
 ) {
     const current = ctx.currentFolder;
     if (!current) {
+        ctx.outputChannel.appendLine(
+            "debugBuildWithOptions: No current folder on WorkspaceContext"
+        );
         return;
     }
 
     const file = vscode.window.activeTextEditor?.document.fileName;
     if (!file) {
+        ctx.outputChannel.appendLine("debugBuildWithOptions: No active text editor");
         return;
     }
 
     const target = current.swiftPackage.getTarget(file);
-    if (!target || target.type !== "executable") {
+    if (!target) {
+        ctx.outputChannel.appendLine("debugBuildWithOptions: No active target");
+        return;
+    }
+
+    if (target.type !== "executable") {
+        ctx.outputChannel.appendLine(
+            `debugBuildWithOptions: Target is not an executable, instead is ${target.type}`
+        );
         return;
     }
 

src/debugger/launch.ts

@@ -113,17 +113,27 @@ export function getLaunchConfiguration(
     const wsLaunchSection = vscode.workspace.getConfiguration("launch", folderCtx.workspaceFolder);
     const launchConfigs = wsLaunchSection.get<vscode.DebugConfiguration[]>("configurations") || [];
     const { folder } = getFolderAndNameSuffix(folderCtx);
-    const buildDirectory = BuildFlags.buildDirectoryFromWorkspacePath(folder, true);
+    const targetPath = path.join(
+        BuildFlags.buildDirectoryFromWorkspacePath(folder, true),
+        "debug",
+        target
+    );
+    // Users could be on different platforms with different path annotations,
+    // so normalize before we compare.
     return launchConfigs.find(
-        config => config.program === path.join(buildDirectory, "debug", target)
+        config => path.normalize(config.program) === path.normalize(targetPath)
     );
 }
 
 // Return array of DebugConfigurations for executables based on what is in Package.swift
 function createExecutableConfigurations(ctx: FolderContext): vscode.DebugConfiguration[] {
     const executableProducts = ctx.swiftPackage.executableProducts;
+
+    // Windows understand the forward slashes, so make the configuration unified as posix path
+    // to make it easier for users switching between platforms.
     const { folder, nameSuffix } = getFolderAndNameSuffix(ctx, undefined, "posix");
     const buildDirectory = BuildFlags.buildDirectoryFromWorkspacePath(folder, true, "posix");
+
     return executableProducts.flatMap(product => {
         const baseConfig = {
             type: DebugAdapter.getLaunchConfigType(ctx.workspaceContext.swiftVersion),

src/debugger/lldb.ts

@@ -142,15 +142,18 @@ export async function getLldbProcess(
             "platform process list --show-args --all-users",
         ]);
         const entries = stdout.split("\n");
-        return entries.flatMap(line => {
+        const processes = entries.flatMap(line => {
             const match = /^(\d+)\s+\d+\s+\S+\s+\S+\s+(.+)$/.exec(line);
             if (match) {
                 return [{ pid: parseInt(match[1]), label: `${match[1]}: ${match[2]}` }];
             } else {
                 return [];
             }
         });
+        return processes;
     } catch (error) {
-        vscode.window.showErrorMessage(`Failed to run LLDB: ${getErrorDescription(error)}`);
+        const errorMessage = `Failed to run LLDB: ${getErrorDescription(error)}`;
+        ctx.outputChannel.log(errorMessage);
+        vscode.window.showErrorMessage(errorMessage);
     }
 }

src/tasks/SwiftProcess.ts

@@ -104,7 +104,7 @@ export class SwiftPtyProcess implements SwiftProcess {
                 useConpty,
                 // https://github.com/swiftlang/vscode-swift/issues/1074
                 // Causing weird truncation issues
-                cols: !isWindows || useConpty ? undefined : 2147483647, // Max int32
+                cols: isWindows ? 4096 : undefined,
             });
             this.spawnEmitter.fire();
             this.spawnedProcess.onData(data => {

src/toolchain/toolchain.ts

@@ -468,6 +468,7 @@ export class SwiftToolchain {
     get diagnostics(): string {
         let str = "";
         str += this.swiftVersionString;
+        str += `\nPlatform: ${process.platform}`;
         str += `\nSwift Path: ${this.swiftFolderPath}`;
         str += `\nToolchain Path: ${this.toolchainPath}`;
         if (this.runtimePath) {

src/ui/SwiftOutputChannel.ts

@@ -86,15 +86,10 @@ export class SwiftOutputChannel implements vscode.OutputChannel {
     }
 
     logDiagnostic(message: string, label?: string) {
-        if (!configuration.diagnostics) {
+        if (!configuration.diagnostics && process.env["CI"] !== "1") {
             return;
         }
-        let fullMessage: string;
-        if (label !== undefined) {
-            fullMessage = `${label}: ${message}`;
-        } else {
-            fullMessage = message;
-        }
+        const fullMessage = label !== undefined ? `${label}: ${message}` : message;
         this.appendLine(`${this.nowFormatted}: ${fullMessage}`);
     }