tests: add unit tests

Author: soumyamahunt

__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);
+  });
+});

dist/index.js

@@ -2347,8 +2347,7 @@ function install(version, system) {
         const swiftLibPath = path.join(systemDrive, "Library");
         const swiftInstallPath = path.join(swiftLibPath, "Developer", "Toolchains", "unknown-Asserts-development.xctoolchain", "usr\\bin");
         if (code != 0 || !fs.existsSync(swiftInstallPath)) {
-            core.setFailed(`Swift installer failed with exit code: ${code}`);
-            return;
+            throw new Error(`Swift installer failed with exit code: ${code}`);
         }
         core.addPath(swiftInstallPath);
         const additionalPaths = [
@@ -7625,7 +7624,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.setupVsTools = void 0;
+exports.getVsWherePath = exports.setupVsTools = exports.vsRequirement = void 0;
 const os = __importStar(__webpack_require__(87));
 const fs = __importStar(__webpack_require__(747));
 const path = __importStar(__webpack_require__(622));
@@ -7649,6 +7648,7 @@ function vsRequirement({ version }) {
         ],
     };
 }
+exports.vsRequirement = vsRequirement;
 /// Do swift version based additional support files setup
 function setupSupportFiles({ version }, vsInstallPath) {
     return __awaiter(this, void 0, void 0, function* () {
@@ -7675,10 +7675,10 @@ function setupVsTools(pkg) {
         /// https://github.com/microsoft/vswhere/wiki/Find-MSBuild
         /// get visual studio properties
         const vswhereExe = yield getVsWherePath();
-        const requirement = vsRequirement(pkg);
+        const req = vsRequirement(pkg);
         const vsWhereExec = `-products * ` +
             `-format json -utf8 ` +
-            `-latest -version "${requirement.version}"`;
+            `-latest -version "${req.version}"`;
         let payload = "";
         const options = {};
         options.listeners = {
@@ -7693,19 +7693,17 @@ function setupVsTools(pkg) {
         yield exec_1.exec(`"${vswhereExe}" ${vsWhereExec}`, [], options);
         let vs = JSON.parse(payload)[0];
         if (!vs.installationPath) {
-            core.setFailed(`Unable to find any visual studio installation for version: ${requirement.version}.`);
-            return;
+            throw new Error(`Unable to find any visual studio installation for version: ${req.version}.`);
         }
         /// https://docs.microsoft.com/en-us/visualstudio/install/use-command-line-parameters-to-install-visual-studio?view=vs-2022
         /// install required visual studio components
         const vsInstallerExec = `modify --installPath "${vs.installationPath}"` +
-            requirement.components.reduce((previous, current) => `${previous} --add "${current}"`, "") +
+            req.components.reduce((previous, current) => `${previous} --add "${current}"`, "") +
             ` --quiet`;
         // install required visual studio components
         const code = yield exec_1.exec(`"${vs.properties.setupEngineFilePath}" ${vsInstallerExec}`, []);
         if (code != 0) {
-            core.setFailed(`Visual Studio installer failed to install required components with exit code: ${code}.`);
-            return;
+            throw new Error(`Visual Studio installer failed to install required components with exit code: ${code}.`);
         }
         yield setupSupportFiles(pkg, vs.installationPath);
     });
@@ -7739,12 +7737,12 @@ function getVsWherePath() {
             }
         }
         if (!fs.existsSync(vswhereToolExe)) {
-            core.setFailed("Action requires the path to where vswhere.exe exists");
-            return;
+            throw new Error("Action requires the path to where vswhere.exe exists");
         }
         return vswhereToolExe;
     });
 }
+exports.getVsWherePath = getVsWherePath;
 
 
 /***/ }),
@@ -7852,7 +7850,7 @@ var OS;
 const AVAILABLE_OS = {
     macOS: ["latest", "11.0", "10.15"],
     Ubuntu: ["latest", "20.04", "18.04", "16.04"],
-    Windows: ["latest", "2022", "2019"],
+    Windows: ["latest", "10"],
 };
 function getSystem() {
     return __awaiter(this, void 0, void 0, function* () {

src/os.ts

@@ -15,7 +15,7 @@ export namespace OS {
 const AVAILABLE_OS: { [platform: string]: string[] } = {
   macOS: ["latest", "11.0", "10.15"],
   Ubuntu: ["latest", "20.04", "18.04", "16.04"],
-  Windows: ["latest", "2022", "2019"],
+  Windows: ["latest", "10"],
 };
 
 export interface System {

src/visual-studio.ts

@@ -29,7 +29,7 @@ export interface VsRequirement {
 
 /// Setup different version and component requirement
 /// based on swift versions if required
-function vsRequirement({ version }: Package): VsRequirement {
+export function vsRequirement({ version }: Package): VsRequirement {
   const recVersion = "10.0.17763";
   const currentVersion = os.release();
   const useVersion = semver.gte(currentVersion, recVersion)
@@ -73,11 +73,11 @@ export async function setupVsTools(pkg: Package) {
   /// https://github.com/microsoft/vswhere/wiki/Find-MSBuild
   /// get visual studio properties
   const vswhereExe = await getVsWherePath();
-  const requirement = vsRequirement(pkg);
+  const req = vsRequirement(pkg);
   const vsWhereExec =
     `-products * ` +
     `-format json -utf8 ` +
-    `-latest -version "${requirement.version}"`;
+    `-latest -version "${req.version}"`;
 
   let payload = "";
   const options: ExecOptions = {};
@@ -94,17 +94,16 @@ export async function setupVsTools(pkg: Package) {
   await exec(`"${vswhereExe}" ${vsWhereExec}`, [], options);
   let vs: VisualStudio = JSON.parse(payload)[0];
   if (!vs.installationPath) {
-    core.setFailed(
-      `Unable to find any visual studio installation for version: ${requirement.version}.`
+    throw new Error(
+      `Unable to find any visual studio installation for version: ${req.version}.`
     );
-    return;
   }
 
   /// https://docs.microsoft.com/en-us/visualstudio/install/use-command-line-parameters-to-install-visual-studio?view=vs-2022
   /// install required visual studio components
   const vsInstallerExec =
     `modify --installPath "${vs.installationPath}"` +
-    requirement.components.reduce(
+    req.components.reduce(
       (previous, current) => `${previous} --add "${current}"`,
       ""
     ) +
@@ -116,10 +115,9 @@ export async function setupVsTools(pkg: Package) {
     []
   );
   if (code != 0) {
-    core.setFailed(
+    throw new Error(
       `Visual Studio installer failed to install required components with exit code: ${code}.`
     );
-    return;
   }
 
   await setupSupportFiles(pkg, vs.installationPath);
@@ -128,7 +126,7 @@ export async function setupVsTools(pkg: Package) {
 /// Get vswhere and vs_installer paths
 /// Borrowed from setup-msbuild action: https://github.com/microsoft/setup-msbuild
 /// From source file: https://github.com/microsoft/setup-msbuild/blob/master/src/main.ts
-async function getVsWherePath() {
+export async function getVsWherePath() {
   // check to see if we are using a specific path for vswhere
   let vswhereToolExe = "";
   // Env variable for self-hosted runner to provide custom path
@@ -155,8 +153,7 @@ async function getVsWherePath() {
   }
 
   if (!fs.existsSync(vswhereToolExe)) {
-    core.setFailed("Action requires the path to where vswhere.exe exists");
-    return;
+    throw new Error("Action requires the path to where vswhere.exe exists");
   }
 
   return vswhereToolExe;

src/windows-install.ts

@@ -61,8 +61,7 @@ export async function install(version: string, system: System) {
   );
 
   if (code != 0 || !fs.existsSync(swiftInstallPath)) {
-    core.setFailed(`Swift installer failed with exit code: ${code}`);
-    return;
+    throw new Error(`Swift installer failed with exit code: ${code}`);
   }
 
   core.addPath(swiftInstallPath);