fix: fixed Visual Studio setup with fallback windows installation (#314)

* chore: check link.exe

* fix: fixed Visual Studio setup with fallback windows installation

* ci: added Visual Studio validation to action

Author: soumyamahunt

.github/workflows/main.yml

@@ -212,6 +212,10 @@ jobs:
     - name: Verify Swift version
       run: swift --version | grep ${{ steps.setup-swift.outputs.swift-version }} || exit 1
 
+    - name: Check link
+      if: runner.os == 'Windows'
+      run: which link | grep "Microsoft Visual Studio" || exit 1
+
   dry-run:
     name: Check action with dry run
     if: needs.ci.outputs.run == 'true'
@@ -332,6 +336,10 @@ jobs:
     - name: Verify Swift version
       run: swift --version | grep ${{ steps.setup-swift.outputs.swift-version }} || exit 1
 
+    - name: Check link
+      if: runner.os == 'Windows'
+      run: which link | grep "Microsoft Visual Studio" || exit 1
+
     - name: Test Swift package
       run: |
         swift package init --type library --name SetupLib

__tests__/installer/windows.test.ts

@@ -154,6 +154,16 @@ describe('windows toolchain installation verification', () => {
     expect(exportVariableSpy).toHaveBeenCalledTimes(1)
     expect(addPathSpy.mock.calls).toStrictEqual([['b'], ['c']])
     expect(exportVariableSpy.mock.calls).toStrictEqual([['SDKROOT', 'root']])
+
+    const setupSpy = jest
+      .spyOn(VisualStudio, 'setup')
+      .mockResolvedValue(visualStudio)
+    const updateSpy = jest
+      .spyOn(VisualStudio.prototype, 'update')
+      .mockResolvedValue()
+    await installer['add']('')
+    expect(setupSpy).toHaveBeenCalled()
+    expect(updateSpy).toHaveBeenCalledWith('root')
   })
 
   it('tests add to PATH', async () => {

dist/index.js

@@ -6,7 +6,7 @@ import * as semver from 'semver'
 import {VerifyingToolchainInstaller} from '../verify'
 import {WindowsToolchainSnapshot} from '../../snapshot'
 import {VisualStudio} from '../../utils'
-import {Installation} from './installation'
+import {Installation, CustomInstallation} from './installation'
 
 export class WindowsToolchainInstaller extends VerifyingToolchainInstaller<WindowsToolchainSnapshot> {
   private get vsRequirement() {
@@ -40,37 +40,47 @@ export class WindowsToolchainInstaller extends VerifyingToolchainInstaller<Windo
 
   protected async unpack(exe: string) {
     const installation = await Installation.install(exe)
-    return installation?.location ?? ''
+    return installation instanceof Installation ? installation.location : ''
   }
 
   protected async add(installLocation: string) {
     const installation = await Installation.get(installLocation)
-    if (!installation) {
-      return
-    }
-    const sdkroot = installation.sdkroot
-    core.exportVariable('SDKROOT', sdkroot)
-    if (installation.devdir) {
-      core.exportVariable('DEVELOPER_DIR', installation.devdir)
-    }
-    const location = installation.location
-    const swiftPath = path.join(installation.toolchain, 'usr', 'bin')
-    const swiftDev = path.join(location, 'Swift-development', 'bin')
-    const icu67 = path.join(location, 'icu-67', 'usr', 'bin')
-    const tools = path.join(location, 'Tools')
-    const runtimePath = path.join(installation.runtime, 'usr', 'bin')
-    const requirePaths = [swiftPath, swiftDev, icu67, tools, runtimePath]
+    const sdkrootKey = 'SDKROOT'
+    let sdkroot: string | undefined
+    if (installation instanceof Installation) {
+      sdkroot = installation?.sdkroot ?? core
+      core.exportVariable(sdkrootKey, sdkroot)
+      if (installation.devdir) {
+        core.exportVariable('DEVELOPER_DIR', installation.devdir)
+      }
+
+      const location = installation.location
+      const swiftPath = path.join(installation.toolchain, 'usr', 'bin')
+      const swiftDev = path.join(location, 'Swift-development', 'bin')
+      const icu67 = path.join(location, 'icu-67', 'usr', 'bin')
+      const tools = path.join(location, 'Tools')
+      const runtimePath = path.join(installation.runtime, 'usr', 'bin')
+      const requirePaths = [swiftPath, swiftDev, icu67, tools, runtimePath]
 
-    for (const envPath of requirePaths) {
-      try {
-        await fs.access(envPath)
-        core.debug(`Adding "${envPath}" to PATH`)
-        core.addPath(envPath)
-      } catch {
-        core.debug(`"${envPath}" doesn't exist. Skip adding to PATH`)
+      for (const envPath of requirePaths) {
+        try {
+          await fs.access(envPath)
+          core.debug(`Adding "${envPath}" to PATH`)
+          core.addPath(envPath)
+        } catch {
+          core.debug(`"${envPath}" doesn't exist. Skip adding to PATH`)
+        }
       }
+      core.debug(`Swift installed at "${swiftPath}"`)
+    } else if (installation instanceof CustomInstallation) {
+      sdkroot = installation.variables[sdkrootKey]
     }
-    core.debug(`Swift installed at "${swiftPath}"`)
+
+    if (!sdkroot) {
+      core.warning(`Failed VS enviroment after installation ${installLocation}`)
+      return
+    }
+
     const visualStudio = await VisualStudio.setup(this.vsRequirement)
     await visualStudio.update(sdkroot)
     const swiftFlags = [

src/installer/windows/index.ts

@@ -7,3 +7,10 @@ export class Installation {
     readonly devdir?: string
   ) {}
 }
+
+export class CustomInstallation {
+  constructor(
+    readonly newPaths: string[],
+    readonly variables: Record<string, string>
+  ) {}
+}

src/installer/windows/installation/base.ts

@@ -1,6 +1,7 @@
 import * as path from 'path'
 import * as core from '@actions/core'
 import {getExecOutput} from '@actions/exec'
+import {CustomInstallation} from './base'
 
 function comapareEnvironment(oldJSON: string, newJSON: string) {
   const difference: Record<string, string> = {}
@@ -65,4 +66,5 @@ export async function fallback(
   for (const pair of Object.entries(data.variables)) {
     core.exportVariable(pair[0], pair[1])
   }
+  return new CustomInstallation(data.newPaths, data.variables)
 }

src/installer/windows/installation/fallback.ts

@@ -1,25 +1,30 @@
 import * as core from '@actions/core'
 import {exec} from '@actions/exec'
-import {Installation} from './base'
+import {Installation, CustomInstallation} from './base'
 import {firstDirectoryLayout, secondDirectoryLayout} from './approach'
 import {env, fallback} from './fallback'
 
 declare module './base' {
   // eslint-disable-next-line no-shadow, @typescript-eslint/no-namespace
   export namespace Installation {
-    export function get(install?: string): Promise<Installation | undefined>
-    export function install(exe: string): Promise<Installation | undefined>
+    export function get(
+      install?: string
+    ): Promise<Installation | CustomInstallation | undefined>
+    export function install(
+      exe: string
+    ): Promise<Installation | CustomInstallation>
     export function detect(
       oldEnv: Record<string, string>,
       newEnv: Record<string, string>
-    ): Promise<Installation | undefined>
+    ): Promise<Installation | CustomInstallation>
   }
 }
 
 Installation.get = async (install?: string) => {
   if (!(install?.length ?? 1)) {
-    return undefined
+    return lastInstallation
   }
+
   const approaches = [
     async () => secondDirectoryLayout(install),
     async () => firstDirectoryLayout(install)
@@ -42,12 +47,14 @@ Installation.get = async (install?: string) => {
   return undefined
 }
 
+let lastInstallation: Installation | CustomInstallation
 Installation.install = async (exe: string) => {
   core.debug(`Installing toolchain from "${exe}"`)
   const oldEnv = await env()
   await exec(`"${exe}"`, ['-q'])
   const newEnv = await env()
-  return Installation.detect(oldEnv, newEnv)
+  lastInstallation = await Installation.detect(oldEnv, newEnv)
+  return lastInstallation
 }
 
 Installation.detect = async (
@@ -56,7 +63,7 @@ Installation.detect = async (
 ) => {
   const installation = await Installation.get()
   if (!installation) {
-    fallback(oldEnv, newEnv)
+    return fallback(oldEnv, newEnv)
   }
   return installation
 }