refactor: updated Visual Studio setup process for required components installation

Author: soumyamahunt

__tests__/utils/visual_studio/setup.test.ts

@@ -1,8 +1,12 @@
 import * as path from 'path'
 import {promises as fs} from 'fs'
 import os from 'os'
+import crypto from 'crypto'
 import * as exec from '@actions/exec'
-import {VisualStudio} from '../../../src/utils/visual_studio'
+import {
+  VisualStudio,
+  VisualStudioConfig
+} from '../../../src/utils/visual_studio'
 
 describe('visual studio setup validation', () => {
   const env = process.env
@@ -21,11 +25,13 @@ describe('visual studio setup validation', () => {
 
   beforeEach(() => {
     process.env = {...env}
+    VisualStudio.shared = undefined
   })
 
   afterEach(() => {
     jest.restoreAllMocks()
     process.env = env
+    VisualStudio.shared = undefined
   })
 
   it('tests visual studio setup fails when invalid path', async () => {
@@ -58,6 +64,59 @@ describe('visual studio setup validation', () => {
     await expect(
       VisualStudio.setup({version: '16', components: visualStudio.components})
     ).resolves.toMatchObject(visualStudio)
+    expect(VisualStudio.shared).toStrictEqual(visualStudio)
+  })
+
+  it('tests visual studio duplicate setup', async () => {
+    VisualStudio.shared = visualStudio
+    const fsAccessSpy = jest.spyOn(fs, 'access')
+    const execSpy = jest.spyOn(exec, 'exec')
+    const getExecOutputSpy = jest.spyOn(exec, 'getExecOutput')
+    await expect(
+      VisualStudio.setup({version: '16', components: visualStudio.components})
+    ).resolves.toMatchObject(visualStudio)
+    expect(VisualStudio.shared).toBe(visualStudio)
+    for (const spy of [fsAccessSpy, execSpy, getExecOutputSpy]) {
+      expect(spy).not.toHaveBeenCalled()
+    }
+  })
+
+  it('tests visual studio setup successfully skipping components installation', async () => {
+    process.env.VSWHERE_PATH = path.join('C:', 'Visual Studio')
+    const ucrtVersion = '1'
+    const ucrtSdkDir = path.join('C:', 'UniversalCRTSdkDir')
+    const vcToolsInstallDir = path.join('C:', 'VCToolsInstallDir')
+    const tmpDir = process.env.RUNNER_TEMP || os.tmpdir()
+    const configId = '792a1d5c-ef88-45da-858c-baf3e6e0d048'
+    const configFileName = `swift-setup-installation-${configId}.vsconfig`
+    const vsConfig: VisualStudioConfig = {
+      version: visualStudio.installationVersion,
+      components: visualStudio.components
+    }
+
+    jest.spyOn(fs, 'access').mockResolvedValue()
+    jest.spyOn(exec, 'exec').mockResolvedValue(0)
+    jest.spyOn(crypto, 'randomUUID').mockReturnValue(configId)
+    jest
+      .spyOn(exec, 'getExecOutput')
+      .mockResolvedValueOnce({
+        exitCode: 0,
+        stdout: JSON.stringify([visualStudio]),
+        stderr: ''
+      })
+      .mockResolvedValueOnce({
+        exitCode: 0,
+        stdout: `UniversalCRTSdkDir=${ucrtSdkDir}\nUCRTVersion=${ucrtVersion}\nVCToolsInstallDir=${vcToolsInstallDir}`,
+        stderr: ''
+      })
+    const readFileSpy = jest.spyOn(fs, 'readFile')
+    readFileSpy.mockResolvedValue(JSON.stringify(vsConfig))
+
+    await expect(
+      VisualStudio.setup({version: '16', components: visualStudio.components})
+    ).resolves.toMatchObject(visualStudio)
+    expect(readFileSpy.mock.calls[0][0]).toBe(path.join(tmpDir, configFileName))
+    expect(VisualStudio.shared).toStrictEqual(visualStudio)
   })
 
   it('tests visual studio environment setup', async () => {

dist/index.js

@@ -7,6 +7,7 @@ import {env, fallback} from './fallback'
 declare module './base' {
   // eslint-disable-next-line no-shadow, @typescript-eslint/no-namespace
   export namespace Installation {
+    let lastInstallation: Installation | CustomInstallation
     export function get(
       install?: string
     ): Promise<Installation | CustomInstallation | undefined>
@@ -20,9 +21,9 @@ declare module './base' {
   }
 }
 
-Installation.get = async (install?: string) => {
+Installation.get = async function (install?: string) {
   if (!(install?.length ?? 1)) {
-    return lastInstallation
+    return this.lastInstallation
   }
 
   const approaches = [
@@ -47,14 +48,13 @@ Installation.get = async (install?: string) => {
   return undefined
 }
 
-let lastInstallation: Installation | CustomInstallation
-Installation.install = async (exe: string) => {
+Installation.install = async function (exe: string) {
   core.debug(`Installing toolchain from "${exe}"`)
   const oldEnv = await env()
   await exec(`"${exe}"`, ['-q'])
   const newEnv = await env()
-  lastInstallation = await Installation.detect(oldEnv, newEnv)
-  return lastInstallation
+  this.lastInstallation = await Installation.detect(oldEnv, newEnv)
+  return this.lastInstallation
 }
 
 Installation.detect = async (

src/installer/windows/installation/index.ts

@@ -92,3 +92,49 @@ export interface VisualStudioEnv {
   readonly VCToolsInstallDir?: string
   readonly [name: string]: string | undefined
 }
+
+/**
+ * Represents the structure of a Visual Studio .vsconfig file
+ */
+export interface VisualStudioConfig {
+  /**
+   * The version of the .vsconfig file format
+   */
+  version: string
+
+  /**
+   * List of workloads and components to be installed
+   */
+  components: string[]
+
+  /**
+   * Optional installation channel URI
+   * Example: https://aka.ms/vs/17/release/channel
+   */
+  installChannelUri?: string
+
+  /**
+   * Runtime components to be installed (e.g., .NET Core, ASP.NET Core runtimes)
+   */
+  runtimeComponents?: string[]
+
+  /**
+   * Installation-related properties
+   */
+  properties?: {
+    /**
+     * A custom name for the configuration
+     */
+    nickname?: string
+
+    /**
+     * Channel ID to use for installation, e.g., VisualStudio.17.Release
+     */
+    channelId?: string
+
+    /**
+     * Installation path for Visual Studio
+     */
+    installPath?: string
+  }
+}

src/utils/visual_studio/base.ts

@@ -1,21 +1,24 @@
+import * as os from 'os'
+import * as path from 'path'
+import {promises as fs} from 'fs'
+import {randomUUID} from 'crypto'
 import * as core from '@actions/core'
 import {exec, getExecOutput} from '@actions/exec'
-import {VisualStudio, VisualStudioRequirement} from './base'
+import {VisualStudio, VisualStudioRequirement, VisualStudioConfig} from './base'
 import {VSWhere} from './vswhere'
 
 declare module './base' {
   // eslint-disable-next-line no-shadow, @typescript-eslint/no-namespace
   export namespace VisualStudio {
+    let shared: VisualStudio | undefined
     function setup(requirement: VisualStudioRequirement): Promise<VisualStudio>
   }
 }
 
-let shared: VisualStudio
-
 /// set up required visual studio tools for swift on windows
 VisualStudio.setup = async function (requirement: VisualStudioRequirement) {
-  if (shared) {
-    return shared
+  if (this.shared) {
+    return this.shared
   }
   /// https://github.com/microsoft/vswhere/wiki/Find-MSBuild
   /// get visual studio properties
@@ -46,16 +49,33 @@ VisualStudio.setup = async function (requirement: VisualStudioRequirement) {
   }
 
   const vsEnv = await vs.env()
-  const comps = requirement.components
+  let comps = requirement.components
   if (
     vsEnv.UCRTVersion &&
     vsEnv.UniversalCRTSdkDir &&
-    vsEnv.VCToolsInstallDir &&
-    comps.length < 3
+    vsEnv.VCToolsInstallDir
   ) {
-    core.debug('VS components already setup, skipping installation')
-    shared = vs
-    return vs
+    const tmpDir = process.env.RUNNER_TEMP || os.tmpdir()
+    const configFileName = `swift-setup-installation-${randomUUID()}.vsconfig`
+    const configPath = path.join(tmpDir, configFileName)
+    core.debug(`Exporting VS installation config to "${configPath}"`)
+    await exec(`"${vs.properties.setupEngineFilePath}"`, [
+      'export',
+      '--path',
+      tmpDir,
+      '--config',
+      configFileName
+    ])
+
+    const configContent = await fs.readFile(configPath, 'utf-8')
+    const vsConfig: VisualStudioConfig = JSON.parse(configContent)
+    const installedComponents = new Set(vsConfig.components)
+    comps = comps.filter(comp => !installedComponents.has(comp))
+    if (comps.length == 0) {
+      core.debug('VS components already setup, skipping installation')
+      this.shared = vs
+      return vs
+    }
   }
 
   /// https://docs.microsoft.com/en-us/visualstudio/install/use-command-line-parameters-to-install-visual-studio?view=vs-2022
@@ -70,6 +90,6 @@ VisualStudio.setup = async function (requirement: VisualStudioRequirement) {
     '--force',
     '--quiet'
   ])
-  shared = vs
+  this.shared = vs
   return vs
 }