Merge pull request #424 from soumyamahunt/win-support

Add Windows support

Author: fwal

.github/workflows/ci.yml

@@ -22,8 +22,11 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        os: [ubuntu-latest, macos-latest]
+        os: [ubuntu-latest, macos-latest, windows-latest]
         swift: ["5.6.1"]
+        include:
+        - os: windows-latest
+          swift: "5.3"
     steps:
     - uses: actions/checkout@v3
     - run: npm install

__tests__/os.test.ts

@@ -19,6 +19,13 @@ describe("os resolver", () => {
     expect(mac.os).toBe(os.OS.MacOS);
     expect(mac.version).toBe("latest");
     expect(mac.name).toBe("macOS");
+
+    setSystem({ os: "win32", dist: "Windows", release: "latest" });
+
+    let windows = await os.getSystem();
+    expect(windows.os).toBe(os.OS.Windows);
+    expect(windows.version).toBe("latest");
+    expect(windows.name).toBe("Windows");
   });
 
   it("throws an error if the os is not supported", async () => {

__tests__/swift-versions.test.ts

@@ -3,6 +3,7 @@ import * as versions from "../src/swift-versions";
 
 const macOS: System = { os: OS.MacOS, version: "latest", name: "macOS" };
 const ubuntu: System = { os: OS.Ubuntu, version: "latest", name: "Ubuntu" };
+const windows: System = { os: OS.Windows, version: "latest", name: "Windows" };
 
 describe("swift version resolver", () => {
   it("identifies X.X.X versions", async () => {
@@ -39,12 +40,19 @@ describe("swift version resolver", () => {
   });
 
   it("throws an error if the version isn't available for the system", async () => {
-    expect.assertions(1);
+    expect.assertions(2);
+
     try {
       await versions.verify("5.0.3", macOS);
     } catch (e) {
       expect(e).toEqual(new Error('Version "5.0.3" is not available'));
     }
+
+    try {
+      await versions.verify("5.2", windows);
+    } catch (e) {
+      expect(e).toEqual(new Error('Version "5.2" is not available'));
+    }
   });
 
   it("throws an error if version is invalid", async () => {

__tests__/visual-studio.test.ts

@@ -0,0 +1,85 @@
+import os from "os";
+import * as vs from "../src/visual-studio";
+import { swiftPackage } from "../src/swift-versions";
+import { OS, System } from "../src/os";
+
+jest.mock("fs", () => {
+  const original = jest.requireActual("fs");
+  return {
+    ...original,
+    existsSync: jest.fn((path) => true),
+  };
+});
+
+const windows: System = { os: OS.Windows, version: "latest", name: "Windows" };
+
+describe("visual studio resolver", () => {
+  const env = process.env;
+
+  beforeEach(() => {
+    jest.resetModules();
+    process.env = { ...env };
+  });
+
+  afterEach(() => {
+    process.env = env;
+  });
+
+  it("fetches visual studio requirement for swift version", async () => {
+    jest.spyOn(os, "release").mockReturnValue("10.0.17763");
+
+    const req5_3 = vs.vsRequirement(swiftPackage("5.3", windows));
+    expect(req5_3.version).toBe("16");
+    expect(req5_3.components).toContain(
+      "Microsoft.VisualStudio.Component.VC.Tools.x86.x64"
+    );
+    expect(req5_3.components).toContain(
+      "Microsoft.VisualStudio.Component.Windows10SDK.17763"
+    );
+
+    const req5_6 = vs.vsRequirement(swiftPackage("5.6", windows));
+    expect(req5_6.version).toBe("16");
+    expect(req5_6.components).toContain(
+      "Microsoft.VisualStudio.Component.VC.Tools.x86.x64"
+    );
+    expect(req5_6.components).toContain(
+      "Microsoft.VisualStudio.Component.Windows10SDK.17763"
+    );
+  });
+
+  it("adds latest sdk for release newer than or equal to build 17763", async () => {
+    jest.spyOn(os, "release").mockReturnValue("10.0.17763");
+    const req17763 = vs.vsRequirement(swiftPackage("5.3", windows));
+    expect(req17763.components).toContain(
+      "Microsoft.VisualStudio.Component.Windows10SDK.17763"
+    );
+
+    jest.spyOn(os, "release").mockReturnValue("10.0.18363");
+    const req18363 = vs.vsRequirement(swiftPackage("5.3", windows));
+    expect(req18363.components).toContain(
+      "Microsoft.VisualStudio.Component.Windows10SDK.18363"
+    );
+  });
+
+  it("adds recommended sdk for release older than build 17763", async () => {
+    jest.spyOn(os, "release").mockReturnValue("10.0.16299");
+    const req16299 = vs.vsRequirement(swiftPackage("5.3", windows));
+    expect(req16299.components).toContain(
+      "Microsoft.VisualStudio.Component.Windows10SDK.17763"
+    );
+  });
+
+  it("finds vswhere path from environment value", async () => {
+    const vswherePath = "C:\\bin\\";
+    const vswhereExe = "C:\\bin\\vswhere.exe";
+    process.env.VSWHERE_PATH = vswherePath;
+    expect(await vs.getVsWherePath()).toBe(vswhereExe);
+  });
+
+  it("finds vswhere path from ProgramFiles environment value", async () => {
+    const vswhereExe =
+      "C:\\Program Files (x86)\\Microsoft Visual Studio\\Installer\\vswhere.exe";
+    process.env["ProgramFiles(x86)"] = "C:\\Program Files (x86)";
+    expect(await vs.getVsWherePath()).toBe(vswhereExe);
+  });
+});