mirror of
https://github.com/electron/node-gyp.git
synced 2025-08-15 12:58:19 +02:00
810 lines
31 KiB
JavaScript
810 lines
31 KiB
JavaScript
'use strict'
|
|
|
|
const { describe, it } = require('mocha')
|
|
const assert = require('assert')
|
|
const fs = require('fs')
|
|
const path = require('path')
|
|
const VisualStudioFinder = require('../lib/find-visualstudio')
|
|
const { poison } = require('./common')
|
|
|
|
const semverV1 = { major: 1, minor: 0, patch: 0 }
|
|
|
|
delete process.env.VCINSTALLDIR
|
|
|
|
class TestVisualStudioFinder extends VisualStudioFinder {
|
|
async findVisualStudio () {
|
|
try {
|
|
return { err: null, info: await super.findVisualStudio() }
|
|
} catch (err) {
|
|
return { err, info: null }
|
|
}
|
|
}
|
|
}
|
|
|
|
describe('find-visualstudio', function () {
|
|
this.beforeAll(function () {
|
|
// Condition to skip the test suite
|
|
if (process.env.SystemRoot === undefined) {
|
|
process.env.SystemRoot = '/'
|
|
}
|
|
})
|
|
|
|
it('VS2013', async function () {
|
|
const finder = new TestVisualStudioFinder(semverV1, null)
|
|
finder.findNewVSUsingSetupModule = async () => null
|
|
finder.findNewVS = async () => null
|
|
finder.regSearchKeys = async (keys, value, addOpts) => {
|
|
for (let i = 0; i < keys.length; ++i) {
|
|
const fullName = `${keys[i]}\\${value}`
|
|
switch (fullName) {
|
|
case 'HKLM\\Software\\Microsoft\\VisualStudio\\SxS\\VC7\\14.0':
|
|
case 'HKLM\\Software\\Wow6432Node\\Microsoft\\VisualStudio\\SxS\\VC7\\14.0':
|
|
continue
|
|
case 'HKLM\\Software\\Microsoft\\VisualStudio\\SxS\\VC7\\12.0':
|
|
assert.ok(true, `expected search for registry value ${fullName}`)
|
|
return 'C:\\VS2013\\VC\\'
|
|
case 'HKLM\\Software\\Microsoft\\MSBuild\\ToolsVersions\\12.0\\MSBuildToolsPath':
|
|
assert.ok(true, `expected search for registry value ${fullName}`)
|
|
return 'C:\\MSBuild12\\'
|
|
default:
|
|
assert.fail(`unexpected search for registry value ${fullName}`)
|
|
}
|
|
}
|
|
throw new Error()
|
|
}
|
|
|
|
const { err, info } = await finder.findVisualStudio()
|
|
assert.strictEqual(err, null)
|
|
assert.deepStrictEqual(info, {
|
|
msBuild: 'C:\\MSBuild12\\MSBuild.exe',
|
|
path: 'C:\\VS2013',
|
|
sdk: null,
|
|
toolset: 'v120',
|
|
version: '12.0',
|
|
versionMajor: 12,
|
|
versionMinor: 0,
|
|
versionYear: 2013
|
|
})
|
|
})
|
|
|
|
it('VS2013 should not be found on new node versions', async function () {
|
|
const finder = new TestVisualStudioFinder({
|
|
major: 10,
|
|
minor: 0,
|
|
patch: 0
|
|
}, null)
|
|
|
|
finder.findNewVSUsingSetupModule = async () => null
|
|
finder.findVisualStudio2019OrNewer = async () => {
|
|
const file = path.join(__dirname, 'fixtures', 'VS_2017_Unusable.txt')
|
|
const data = fs.readFileSync(file)
|
|
const parsedData = finder.parseData(null, data, '', { checkIsArray: true })
|
|
return finder.processData(parsedData, [2019, 2022])
|
|
}
|
|
finder.findVisualStudio2017 = async () => {
|
|
const file = path.join(__dirname, 'fixtures', 'VS_2017_Unusable.txt')
|
|
const data = fs.readFileSync(file)
|
|
const parsedData = finder.parseData(null, data, '', { checkIsArray: true })
|
|
return finder.processData(parsedData, [2017])
|
|
}
|
|
finder.regSearchKeys = async (keys, value, addOpts) => {
|
|
for (let i = 0; i < keys.length; ++i) {
|
|
const fullName = `${keys[i]}\\${value}`
|
|
switch (fullName) {
|
|
case 'HKLM\\Software\\Microsoft\\VisualStudio\\SxS\\VC7\\14.0':
|
|
case 'HKLM\\Software\\Wow6432Node\\Microsoft\\VisualStudio\\SxS\\VC7\\14.0':
|
|
continue
|
|
default:
|
|
assert.fail(`unexpected search for registry value ${fullName}`)
|
|
}
|
|
}
|
|
throw new Error()
|
|
}
|
|
|
|
const { err, info } = await finder.findVisualStudio()
|
|
assert.ok(/find .* Visual Studio/i.test(err), 'expect error')
|
|
assert.ok(!info, 'no data')
|
|
})
|
|
|
|
it('VS2015', async function () {
|
|
const finder = new TestVisualStudioFinder(semverV1, null)
|
|
finder.findNewVSUsingSetupModule = async () => null
|
|
finder.findNewVS = async () => null
|
|
finder.regSearchKeys = async (keys, value, addOpts) => {
|
|
for (let i = 0; i < keys.length; ++i) {
|
|
const fullName = `${keys[i]}\\${value}`
|
|
switch (fullName) {
|
|
case 'HKLM\\Software\\Microsoft\\VisualStudio\\SxS\\VC7\\14.0':
|
|
assert.ok(true, `expected search for registry value ${fullName}`)
|
|
return 'C:\\VS2015\\VC\\'
|
|
case 'HKLM\\Software\\Microsoft\\MSBuild\\ToolsVersions\\14.0\\MSBuildToolsPath':
|
|
assert.ok(true, `expected search for registry value ${fullName}`)
|
|
return 'C:\\MSBuild14\\'
|
|
default:
|
|
assert.fail(`unexpected search for registry value ${fullName}`)
|
|
}
|
|
}
|
|
throw new Error()
|
|
}
|
|
const { err, info } = await finder.findVisualStudio()
|
|
assert.strictEqual(err, null)
|
|
assert.deepStrictEqual(info, {
|
|
msBuild: 'C:\\MSBuild14\\MSBuild.exe',
|
|
path: 'C:\\VS2015',
|
|
sdk: null,
|
|
toolset: 'v140',
|
|
version: '14.0',
|
|
versionMajor: 14,
|
|
versionMinor: 0,
|
|
versionYear: 2015
|
|
})
|
|
})
|
|
|
|
it('error from PowerShell', async function () {
|
|
const finder = new TestVisualStudioFinder(semverV1, null, null)
|
|
|
|
const vsInfo = finder.parseData(new Error('Error msg'), '', '')
|
|
assert.ok(/use PowerShell/i.test(finder.errorLog[0]), `expect error, output: ${finder.errorLog[0]}`)
|
|
assert.ok(/error msg/i.test(finder.errorLog[0]), `expect error, output: ${finder.errorLog[0]}`)
|
|
assert.equal(vsInfo, null)
|
|
})
|
|
|
|
it('empty output from PowerShell', async function () {
|
|
const finder = new TestVisualStudioFinder(semverV1, null, null)
|
|
|
|
const vsInfo = finder.parseData(null, '', '', { checkIsArray: true })
|
|
assert.ok(/use PowerShell/i.test(finder.errorLog[0]), `expect error, output: ${finder.errorLog[0]}`)
|
|
assert.equal(vsInfo, null)
|
|
})
|
|
|
|
it('output from PowerShell not JSON', async function () {
|
|
const finder = new TestVisualStudioFinder(semverV1, null, null)
|
|
|
|
const vsInfo = finder.parseData(null, 'AAAABBBB', '', { checkIsArray: true })
|
|
assert.ok(/use PowerShell/i.test(finder.errorLog[0]), `expect error, output: ${finder.errorLog[0]}`)
|
|
assert.equal(vsInfo, null)
|
|
})
|
|
|
|
it('wrong JSON from PowerShell', async function () {
|
|
const finder = new TestVisualStudioFinder(semverV1, null, null)
|
|
|
|
const vsInfo = finder.parseData(null, '{}', '', { checkIsArray: true })
|
|
assert.ok(/use PowerShell/i.test(finder.errorLog[0]), `expect error, output: ${finder.errorLog[0]}`)
|
|
assert.ok(/expected array/i.test(finder.errorLog[0]), `expect error, output: ${finder.errorLog[0]}`)
|
|
assert.equal(vsInfo, null)
|
|
})
|
|
|
|
it('empty JSON from PowerShell', async function () {
|
|
const finder = new TestVisualStudioFinder(semverV1, null, null)
|
|
|
|
const vsInfo = finder.parseData(null, '[]', '', { checkIsArray: true })
|
|
assert.equal(finder.errorLog.length, 0)
|
|
assert.equal(vsInfo.length, 0)
|
|
})
|
|
|
|
it('future version', async function () {
|
|
const finder = new TestVisualStudioFinder(semverV1, null, null)
|
|
|
|
const vsInfo = finder.parseData(null, JSON.stringify([{
|
|
packages: [
|
|
'Microsoft.VisualStudio.Component.VC.Tools.x86.x64',
|
|
'Microsoft.VisualStudio.Component.Windows10SDK.17763',
|
|
'Microsoft.VisualStudio.VC.MSBuild.Base'
|
|
],
|
|
path: 'C:\\VS',
|
|
version: '9999.9999.9999.9999'
|
|
}]), '', { checkIsArray: true })
|
|
assert.equal(finder.errorLog.length, 0)
|
|
assert.equal(vsInfo[0].packages.length, 3)
|
|
})
|
|
|
|
it('single unusable VS2017', async function () {
|
|
const finder = new TestVisualStudioFinder(semverV1, null, null)
|
|
|
|
const file = path.join(__dirname, 'fixtures', 'VS_2017_Unusable.txt')
|
|
const data = fs.readFileSync(file)
|
|
const vsInfo = finder.parseData(null, data, '', { checkIsArray: true })
|
|
assert.equal(finder.errorLog.length, 0)
|
|
assert.equal(vsInfo.length, 1)
|
|
assert.equal(vsInfo[0].InstallationPath, undefined)
|
|
assert.notEqual(vsInfo[0].path, undefined)
|
|
assert.ok(vsInfo[0].packages.length > 1)
|
|
})
|
|
|
|
it('minimal VS2017 Build Tools', async function () {
|
|
const finder = new TestVisualStudioFinder(semverV1, null)
|
|
|
|
poison(finder, 'regSearchKeys')
|
|
finder.findNewVSUsingSetupModule = async () => null
|
|
finder.findVisualStudio2019OrNewer = async () => {
|
|
const file = path.join(__dirname, 'fixtures',
|
|
'VS_2017_BuildTools_minimal.txt')
|
|
const data = fs.readFileSync(file)
|
|
const parsedData = finder.parseData(null, data, '', { checkIsArray: true })
|
|
return finder.processData(parsedData, [2019, 2022])
|
|
}
|
|
finder.findVisualStudio2017 = async () => {
|
|
const file = path.join(__dirname, 'fixtures',
|
|
'VS_2017_BuildTools_minimal.txt')
|
|
const data = fs.readFileSync(file)
|
|
const parsedData = finder.parseData(null, data, '', { checkIsArray: true })
|
|
return finder.processData(parsedData, [2017])
|
|
}
|
|
const { err, info } = await finder.findVisualStudio()
|
|
assert.strictEqual(err, null)
|
|
assert.deepStrictEqual(info, {
|
|
msBuild: 'C:\\Program Files (x86)\\Microsoft Visual Studio\\2017\\' +
|
|
'BuildTools\\MSBuild\\15.0\\Bin\\MSBuild.exe',
|
|
path:
|
|
'C:\\Program Files (x86)\\Microsoft Visual Studio\\2017\\BuildTools',
|
|
sdk: '10.0.17134.0',
|
|
toolset: 'v141',
|
|
version: '15.9.28307.665',
|
|
versionMajor: 15,
|
|
versionMinor: 9,
|
|
versionYear: 2017
|
|
})
|
|
})
|
|
|
|
it('VS2017 Community with C++ workload', async function () {
|
|
const finder = new TestVisualStudioFinder(semverV1, null)
|
|
|
|
poison(finder, 'regSearchKeys')
|
|
finder.findNewVSUsingSetupModule = async () => null
|
|
finder.findVisualStudio2019OrNewer = async () => {
|
|
const file = path.join(__dirname, 'fixtures',
|
|
'VS_2017_Community_workload.txt')
|
|
const data = fs.readFileSync(file)
|
|
const parsedData = finder.parseData(null, data, '', { checkIsArray: true })
|
|
return finder.processData(parsedData, [2019, 2022])
|
|
}
|
|
finder.findVisualStudio2017 = async () => {
|
|
const file = path.join(__dirname, 'fixtures',
|
|
'VS_2017_Community_workload.txt')
|
|
const data = fs.readFileSync(file)
|
|
const parsedData = finder.parseData(null, data, '', { checkIsArray: true })
|
|
return finder.processData(parsedData, [2017])
|
|
}
|
|
const { err, info } = await finder.findVisualStudio()
|
|
assert.strictEqual(err, null)
|
|
assert.deepStrictEqual(info, {
|
|
msBuild: 'C:\\Program Files (x86)\\Microsoft Visual Studio\\2017\\' +
|
|
'Community\\MSBuild\\15.0\\Bin\\MSBuild.exe',
|
|
path:
|
|
'C:\\Program Files (x86)\\Microsoft Visual Studio\\2017\\Community',
|
|
sdk: '10.0.17763.0',
|
|
toolset: 'v141',
|
|
version: '15.9.28307.665',
|
|
versionMajor: 15,
|
|
versionMinor: 9,
|
|
versionYear: 2017
|
|
})
|
|
})
|
|
|
|
it('VS2017 Express', async function () {
|
|
const finder = new TestVisualStudioFinder(semverV1, null)
|
|
|
|
poison(finder, 'regSearchKeys')
|
|
finder.findNewVSUsingSetupModule = async () => null
|
|
finder.findVisualStudio2019OrNewer = async () => {
|
|
const file = path.join(__dirname, 'fixtures', 'VS_2017_Express.txt')
|
|
const data = fs.readFileSync(file)
|
|
const parsedData = finder.parseData(null, data, '', { checkIsArray: true })
|
|
return finder.processData(parsedData, [2019, 2022])
|
|
}
|
|
finder.findVisualStudio2017 = async () => {
|
|
const file = path.join(__dirname, 'fixtures', 'VS_2017_Express.txt')
|
|
const data = fs.readFileSync(file)
|
|
const parsedData = finder.parseData(null, data, '', { checkIsArray: true })
|
|
return finder.processData(parsedData, [2017])
|
|
}
|
|
const { err, info } = await finder.findVisualStudio()
|
|
assert.strictEqual(err, null)
|
|
assert.deepStrictEqual(info, {
|
|
msBuild: 'C:\\Program Files (x86)\\Microsoft Visual Studio\\2017\\' +
|
|
'WDExpress\\MSBuild\\15.0\\Bin\\MSBuild.exe',
|
|
path:
|
|
'C:\\Program Files (x86)\\Microsoft Visual Studio\\2017\\WDExpress',
|
|
sdk: '10.0.17763.0',
|
|
toolset: 'v141',
|
|
version: '15.9.28307.858',
|
|
versionMajor: 15,
|
|
versionMinor: 9,
|
|
versionYear: 2017
|
|
})
|
|
})
|
|
|
|
it('VS2019 Preview with C++ workload', async function () {
|
|
const finder = new TestVisualStudioFinder(semverV1, null)
|
|
|
|
poison(finder, 'regSearchKeys')
|
|
finder.findNewVSUsingSetupModule = async () => null
|
|
finder.findVisualStudio2019OrNewer = async () => {
|
|
const file = path.join(__dirname, 'fixtures',
|
|
'VS_2019_Preview.txt')
|
|
const data = fs.readFileSync(file)
|
|
const parsedData = finder.parseData(null, data, '', { checkIsArray: true })
|
|
return finder.processData(parsedData, [2019, 2022])
|
|
}
|
|
finder.findVisualStudio2017 = async () => {
|
|
const file = path.join(__dirname, 'fixtures',
|
|
'VS_2019_Preview.txt')
|
|
const data = fs.readFileSync(file)
|
|
const parsedData = finder.parseData(null, data, '', { checkIsArray: true })
|
|
return finder.processData(parsedData, [2017])
|
|
}
|
|
const { err, info } = await finder.findVisualStudio()
|
|
assert.strictEqual(err, null)
|
|
assert.deepStrictEqual(info, {
|
|
msBuild: 'C:\\Program Files (x86)\\Microsoft Visual Studio\\2019\\' +
|
|
'Preview\\MSBuild\\Current\\Bin\\MSBuild.exe',
|
|
path:
|
|
'C:\\Program Files (x86)\\Microsoft Visual Studio\\2019\\Preview',
|
|
sdk: '10.0.17763.0',
|
|
toolset: 'v142',
|
|
version: '16.0.28608.199',
|
|
versionMajor: 16,
|
|
versionMinor: 0,
|
|
versionYear: 2019
|
|
})
|
|
})
|
|
|
|
it('minimal VS2019 Build Tools', async function () {
|
|
const finder = new TestVisualStudioFinder(semverV1, null)
|
|
|
|
poison(finder, 'regSearchKeys')
|
|
finder.findNewVSUsingSetupModule = async () => null
|
|
finder.findVisualStudio2019OrNewer = async () => {
|
|
const file = path.join(__dirname, 'fixtures',
|
|
'VS_2019_BuildTools_minimal.txt')
|
|
const data = fs.readFileSync(file)
|
|
const parsedData = finder.parseData(null, data, '', { checkIsArray: true })
|
|
return finder.processData(parsedData, [2019, 2022])
|
|
}
|
|
finder.findVisualStudio2017 = async () => {
|
|
const file = path.join(__dirname, 'fixtures',
|
|
'VS_2019_BuildTools_minimal.txt')
|
|
const data = fs.readFileSync(file)
|
|
const parsedData = finder.parseData(null, data, '', { checkIsArray: true })
|
|
return finder.processData(parsedData, [2017])
|
|
}
|
|
const { err, info } = await finder.findVisualStudio()
|
|
assert.strictEqual(err, null)
|
|
assert.deepStrictEqual(info, {
|
|
msBuild: 'C:\\Program Files (x86)\\Microsoft Visual Studio\\2019\\' +
|
|
'BuildTools\\MSBuild\\Current\\Bin\\MSBuild.exe',
|
|
path:
|
|
'C:\\Program Files (x86)\\Microsoft Visual Studio\\2019\\BuildTools',
|
|
sdk: '10.0.17134.0',
|
|
toolset: 'v142',
|
|
version: '16.1.28922.388',
|
|
versionMajor: 16,
|
|
versionMinor: 1,
|
|
versionYear: 2019
|
|
})
|
|
})
|
|
|
|
it('VS2019 Community with C++ workload', async function () {
|
|
const finder = new TestVisualStudioFinder(semverV1, null)
|
|
|
|
poison(finder, 'regSearchKeys')
|
|
finder.findNewVSUsingSetupModule = async () => null
|
|
finder.findVisualStudio2019OrNewer = async () => {
|
|
const file = path.join(__dirname, 'fixtures',
|
|
'VS_2019_Community_workload.txt')
|
|
const data = fs.readFileSync(file)
|
|
const parsedData = finder.parseData(null, data, '', { checkIsArray: true })
|
|
return finder.processData(parsedData, [2019, 2022])
|
|
}
|
|
finder.findVisualStudio2017 = async () => {
|
|
const file = path.join(__dirname, 'fixtures',
|
|
'VS_2019_Community_workload.txt')
|
|
const data = fs.readFileSync(file)
|
|
const parsedData = finder.parseData(null, data, '', { checkIsArray: true })
|
|
return finder.processData(parsedData, [2017])
|
|
}
|
|
const { err, info } = await finder.findVisualStudio()
|
|
assert.strictEqual(err, null)
|
|
assert.deepStrictEqual(info, {
|
|
msBuild: 'C:\\Program Files (x86)\\Microsoft Visual Studio\\2019\\' +
|
|
'Community\\MSBuild\\Current\\Bin\\MSBuild.exe',
|
|
path:
|
|
'C:\\Program Files (x86)\\Microsoft Visual Studio\\2019\\Community',
|
|
sdk: '10.0.17763.0',
|
|
toolset: 'v142',
|
|
version: '16.1.28922.388',
|
|
versionMajor: 16,
|
|
versionMinor: 1,
|
|
versionYear: 2019
|
|
})
|
|
})
|
|
|
|
it('VS2022 Preview with C++ workload', async function () {
|
|
const msBuildPath = process.arch === 'arm64'
|
|
? 'C:\\Program Files\\Microsoft Visual Studio\\2022\\' +
|
|
'Community\\MSBuild\\Current\\Bin\\arm64\\MSBuild.exe'
|
|
: 'C:\\Program Files\\Microsoft Visual Studio\\2022\\' +
|
|
'Community\\MSBuild\\Current\\Bin\\MSBuild.exe'
|
|
|
|
const finder = new TestVisualStudioFinder(semverV1, null)
|
|
|
|
poison(finder, 'regSearchKeys')
|
|
finder.msBuildPathExists = (path) => {
|
|
return true
|
|
}
|
|
finder.findNewVSUsingSetupModule = async () => null
|
|
finder.findVisualStudio2019OrNewer = async () => {
|
|
const file = path.join(__dirname, 'fixtures',
|
|
'VS_2022_Community_workload.txt')
|
|
const data = fs.readFileSync(file)
|
|
const parsedData = finder.parseData(null, data, '', { checkIsArray: true })
|
|
return finder.processData(parsedData, [2019, 2022])
|
|
}
|
|
finder.findVisualStudio2017 = async () => {
|
|
const file = path.join(__dirname, 'fixtures',
|
|
'VS_2022_Community_workload.txt')
|
|
const data = fs.readFileSync(file)
|
|
const parsedData = finder.parseData(null, data, '', { checkIsArray: true })
|
|
return finder.processData(parsedData, [2017])
|
|
}
|
|
const { err, info } = await finder.findVisualStudio()
|
|
assert.strictEqual(err, null)
|
|
assert.deepStrictEqual(info, {
|
|
msBuild: msBuildPath,
|
|
path:
|
|
'C:\\Program Files\\Microsoft Visual Studio\\2022\\Community',
|
|
sdk: '10.0.22621.0',
|
|
toolset: 'v143',
|
|
version: '17.4.33213.308',
|
|
versionMajor: 17,
|
|
versionMinor: 4,
|
|
versionYear: 2022
|
|
})
|
|
})
|
|
|
|
it('VSSetup: VS2022 with C++ workload without SDK', async function () {
|
|
const finder = new TestVisualStudioFinder(semverV1, null)
|
|
finder.msBuildPathExists = (path) => {
|
|
return true
|
|
}
|
|
finder.findNewVS = async () => null
|
|
finder.findOldVS = async () => null
|
|
setupExecFixture(finder, 'VSSetup_VS_2022_workload_missing_sdk.txt')
|
|
const { err, info } = await finder.findVisualStudio()
|
|
assert.match(err.message, /could not find/i)
|
|
assert.strictEqual(info, null)
|
|
})
|
|
|
|
it('VSSetup: VS2019 with C++ workload', async function () {
|
|
await verifyVSSetupData('VSSetup_VS_2019_Professional_workload.txt', 'Professional', 2019,
|
|
'10.0.19041.0', 'v142', '16.11.34407.143', 'Program Files (x86)')
|
|
})
|
|
|
|
it('VSSetup: VS2022 with C++ workload', async function () {
|
|
await verifyVSSetupData('VSSetup_VS_2022_workload.txt', 'Enterprise', 2022,
|
|
'10.0.22000.0', 'v143', '17.8.34330.188', 'Program Files')
|
|
})
|
|
|
|
it('VSSetup: VS2022 and VS2019 with C++ workload', async function () {
|
|
await verifyVSSetupData('VSSetup_VS_2022_VS2019_workload.txt', 'Enterprise', 2022,
|
|
'10.0.22000.0', 'v143', '17.8.34330.188', 'Program Files')
|
|
})
|
|
|
|
it('VSSetup: VS2022 with multiple installations', async function () {
|
|
await verifyVSSetupData('VSSetup_VS_2022_multiple_install.txt', 'Enterprise', 2022,
|
|
'10.0.22000.0', 'v143', '17.8.34330.188', 'Program Files')
|
|
})
|
|
|
|
async function verifyVSSetupData (fixtureName, vsType, vsYear, sdkVersion, toolsetVersion, vsVersion, expectedProgramFilesPath) {
|
|
const msBuildPath = process.arch === 'arm64'
|
|
? `C:\\${expectedProgramFilesPath}\\Microsoft Visual Studio\\${vsYear}\\` +
|
|
`${vsType}\\MSBuild\\Current\\Bin\\arm64\\MSBuild.exe`
|
|
: `C:\\${expectedProgramFilesPath}\\Microsoft Visual Studio\\${vsYear}\\` +
|
|
`${vsType}\\MSBuild\\Current\\Bin\\MSBuild.exe`
|
|
|
|
const finder = new TestVisualStudioFinder(semverV1, null)
|
|
|
|
poison(finder, 'regSearchKeys')
|
|
const expectedVSPath = `C:\\${expectedProgramFilesPath}\\Microsoft Visual Studio\\${vsYear}\\${vsType}`
|
|
finder.msBuildPathExists = (path) => {
|
|
if (path.startsWith(expectedVSPath) && path.endsWith('MSBuild.exe')) {
|
|
return true
|
|
}
|
|
return false
|
|
}
|
|
finder.findVisualStudio2019OrNewer = async () => {
|
|
throw new Error("findVisualStudio2019OrNewer shouldn't be called")
|
|
}
|
|
finder.findVisualStudio2017 = async () => {
|
|
throw new Error("findVisualStudio2017 shouldn't be called")
|
|
}
|
|
setupExecFixture(finder, fixtureName)
|
|
const { err, info } = await finder.findVisualStudio()
|
|
assert.strictEqual(err, null)
|
|
const vsVersionTokens = vsVersion.split('.')
|
|
assert.deepStrictEqual(info, {
|
|
msBuild: msBuildPath,
|
|
path:
|
|
`C:\\${expectedProgramFilesPath}\\Microsoft Visual Studio\\${vsYear}\\${vsType}`,
|
|
sdk: sdkVersion,
|
|
toolset: toolsetVersion,
|
|
version: vsVersion,
|
|
versionMajor: parseInt(vsVersionTokens[0]),
|
|
versionMinor: parseInt(vsVersionTokens[1]),
|
|
versionYear: vsYear
|
|
})
|
|
}
|
|
|
|
function setupExecFixture (finder, fixtureName) {
|
|
finder.execFile = async (exec, args) => {
|
|
if (args.length > 2 && args[2].includes('Get-Module')) {
|
|
return [null, '1.0.0', '']
|
|
} else if (args.length > 2 && args.at(-1).includes('Get-VSSetupInstance')) {
|
|
const file = path.join(__dirname, 'fixtures', fixtureName)
|
|
return [null, fs.readFileSync(file), '']
|
|
}
|
|
return [new Error(), '', '']
|
|
}
|
|
}
|
|
|
|
function allVsVersions (finder) {
|
|
finder.findVisualStudio2017OrNewerUsingSetupModule = async () => {
|
|
return null
|
|
}
|
|
finder.findVisualStudio2017 = async () => {
|
|
const data0 = JSON.parse(fs.readFileSync(path.join(__dirname, 'fixtures',
|
|
'VS_2017_Unusable.txt')))
|
|
const data1 = JSON.parse(fs.readFileSync(path.join(__dirname, 'fixtures',
|
|
'VS_2017_BuildTools_minimal.txt')))
|
|
const data2 = JSON.parse(fs.readFileSync(path.join(__dirname, 'fixtures',
|
|
'VS_2017_Community_workload.txt')))
|
|
const data3 = JSON.parse(fs.readFileSync(path.join(__dirname, 'fixtures',
|
|
'VS_2017_Express.txt')))
|
|
const data = JSON.stringify(data0.concat(data1, data2, data3))
|
|
const parsedData = finder.parseData(null, data, '', { checkIsArray: true })
|
|
return finder.processData(parsedData, [2017])
|
|
}
|
|
finder.findVisualStudio2019OrNewer = async () => {
|
|
const data0 = JSON.parse(fs.readFileSync(path.join(__dirname, 'fixtures',
|
|
'VS_2019_Preview.txt')))
|
|
const data1 = JSON.parse(fs.readFileSync(path.join(__dirname, 'fixtures',
|
|
'VS_2019_BuildTools_minimal.txt')))
|
|
const data2 = JSON.parse(fs.readFileSync(path.join(__dirname, 'fixtures',
|
|
'VS_2019_Community_workload.txt')))
|
|
const data3 = JSON.parse(fs.readFileSync(path.join(__dirname, 'fixtures',
|
|
'VS_2022_Community_workload.txt')))
|
|
const data = JSON.stringify(data0.concat(data1, data2, data3))
|
|
const parsedData = finder.parseData(null, data, '', { checkIsArray: true })
|
|
return finder.processData(parsedData, [2019, 2022])
|
|
}
|
|
finder.regSearchKeys = async (keys, value, addOpts) => {
|
|
for (let i = 0; i < keys.length; ++i) {
|
|
const fullName = `${keys[i]}\\${value}`
|
|
switch (fullName) {
|
|
case 'HKLM\\Software\\Microsoft\\VisualStudio\\SxS\\VC7\\14.0':
|
|
case 'HKLM\\Software\\Microsoft\\VisualStudio\\SxS\\VC7\\12.0':
|
|
continue
|
|
case 'HKLM\\Software\\Wow6432Node\\Microsoft\\VisualStudio\\SxS\\VC7\\12.0':
|
|
return 'C:\\VS2013\\VC\\'
|
|
case 'HKLM\\Software\\Microsoft\\MSBuild\\ToolsVersions\\12.0\\MSBuildToolsPath':
|
|
return 'C:\\MSBuild12\\'
|
|
case 'HKLM\\Software\\Wow6432Node\\Microsoft\\VisualStudio\\SxS\\VC7\\14.0':
|
|
return 'C:\\VS2015\\VC\\'
|
|
case 'HKLM\\Software\\Microsoft\\MSBuild\\ToolsVersions\\14.0\\MSBuildToolsPath':
|
|
return 'C:\\MSBuild14\\'
|
|
default:
|
|
assert.fail(`unexpected search for registry value ${fullName}`)
|
|
}
|
|
}
|
|
throw new Error()
|
|
}
|
|
}
|
|
|
|
it('fail when looking for invalid path', async function () {
|
|
const finder = new TestVisualStudioFinder(semverV1, 'AABB')
|
|
|
|
allVsVersions(finder)
|
|
const { err, info } = await finder.findVisualStudio()
|
|
assert.ok(/find .* Visual Studio/i.test(err), 'expect error')
|
|
assert.ok(!info, 'no data')
|
|
})
|
|
|
|
it('look for VS2013 by version number', async function () {
|
|
const finder = new TestVisualStudioFinder(semverV1, '2013')
|
|
|
|
allVsVersions(finder)
|
|
const { err, info } = await finder.findVisualStudio()
|
|
assert.strictEqual(err, null)
|
|
assert.deepStrictEqual(info.versionYear, 2013)
|
|
})
|
|
|
|
it('look for VS2013 by installation path', async function () {
|
|
const finder = new TestVisualStudioFinder(semverV1, 'C:\\VS2013')
|
|
|
|
allVsVersions(finder)
|
|
const { err, info } = await finder.findVisualStudio()
|
|
assert.strictEqual(err, null)
|
|
assert.deepStrictEqual(info.path, 'C:\\VS2013')
|
|
})
|
|
|
|
it('look for VS2015 by version number', async function () {
|
|
const finder = new TestVisualStudioFinder(semverV1, '2015')
|
|
|
|
allVsVersions(finder)
|
|
const { err, info } = await finder.findVisualStudio()
|
|
assert.strictEqual(err, null)
|
|
assert.deepStrictEqual(info.versionYear, 2015)
|
|
})
|
|
|
|
it('look for VS2015 by installation path', async function () {
|
|
const finder = new TestVisualStudioFinder(semverV1, 'C:\\VS2015')
|
|
|
|
allVsVersions(finder)
|
|
const { err, info } = await finder.findVisualStudio()
|
|
assert.strictEqual(err, null)
|
|
assert.deepStrictEqual(info.path, 'C:\\VS2015')
|
|
})
|
|
|
|
it('look for VS2017 by version number', async function () {
|
|
const finder = new TestVisualStudioFinder(semverV1, '2017')
|
|
|
|
allVsVersions(finder)
|
|
const { err, info } = await finder.findVisualStudio()
|
|
assert.strictEqual(err, null)
|
|
assert.deepStrictEqual(info.versionYear, 2017)
|
|
})
|
|
|
|
it('look for VS2017 by installation path', async function () {
|
|
const finder = new TestVisualStudioFinder(semverV1,
|
|
'C:\\Program Files (x86)\\Microsoft Visual Studio\\2017\\Community')
|
|
|
|
allVsVersions(finder)
|
|
const { err, info } = await finder.findVisualStudio()
|
|
assert.strictEqual(err, null)
|
|
assert.deepStrictEqual(info.path,
|
|
'C:\\Program Files (x86)\\Microsoft Visual Studio\\2017\\Community')
|
|
})
|
|
|
|
it('look for VS2019 by version number', async function () {
|
|
const finder = new TestVisualStudioFinder(semverV1, '2019')
|
|
|
|
allVsVersions(finder)
|
|
const { err, info } = await finder.findVisualStudio()
|
|
assert.strictEqual(err, null)
|
|
assert.deepStrictEqual(info.versionYear, 2019)
|
|
})
|
|
|
|
it('look for VS2019 by installation path', async function () {
|
|
const finder = new TestVisualStudioFinder(semverV1,
|
|
'C:\\Program Files (x86)\\Microsoft Visual Studio\\2019\\BuildTools')
|
|
|
|
allVsVersions(finder)
|
|
const { err, info } = await finder.findVisualStudio()
|
|
assert.strictEqual(err, null)
|
|
assert.deepStrictEqual(info.path,
|
|
'C:\\Program Files (x86)\\Microsoft Visual Studio\\2019\\BuildTools')
|
|
})
|
|
|
|
it('look for VS2022 by version number', async function () {
|
|
const finder = new TestVisualStudioFinder(semverV1, '2022')
|
|
|
|
finder.msBuildPathExists = (path) => {
|
|
return true
|
|
}
|
|
|
|
allVsVersions(finder)
|
|
const { err, info } = await finder.findVisualStudio()
|
|
assert.strictEqual(err, null)
|
|
assert.deepStrictEqual(info.versionYear, 2022)
|
|
})
|
|
|
|
it('msvs_version match should be case insensitive', async function () {
|
|
const finder = new TestVisualStudioFinder(semverV1,
|
|
'c:\\program files (x86)\\microsoft visual studio\\2019\\BUILDTOOLS')
|
|
|
|
allVsVersions(finder)
|
|
const { err, info } = await finder.findVisualStudio()
|
|
assert.strictEqual(err, null)
|
|
assert.deepStrictEqual(info.path,
|
|
'C:\\Program Files (x86)\\Microsoft Visual Studio\\2019\\BuildTools')
|
|
})
|
|
|
|
it('latest version should be found by default', async function () {
|
|
const finder = new TestVisualStudioFinder(semverV1, null)
|
|
|
|
finder.msBuildPathExists = (path) => {
|
|
return true
|
|
}
|
|
|
|
allVsVersions(finder)
|
|
const { err, info } = await finder.findVisualStudio()
|
|
assert.strictEqual(err, null)
|
|
assert.deepStrictEqual(info.versionYear, 2022)
|
|
})
|
|
|
|
it('run on a usable VS Command Prompt', async function () {
|
|
process.env.VCINSTALLDIR = 'C:\\VS2015\\VC'
|
|
// VSINSTALLDIR is not defined on Visual C++ Build Tools 2015
|
|
delete process.env.VSINSTALLDIR
|
|
|
|
const finder = new TestVisualStudioFinder(semverV1, null)
|
|
|
|
allVsVersions(finder)
|
|
const { err, info } = await finder.findVisualStudio()
|
|
assert.strictEqual(err, null)
|
|
assert.deepStrictEqual(info.path, 'C:\\VS2015')
|
|
})
|
|
|
|
it('VCINSTALLDIR match should be case insensitive', async function () {
|
|
process.env.VCINSTALLDIR =
|
|
'c:\\program files (x86)\\microsoft visual studio\\2019\\BUILDTOOLS\\VC'
|
|
|
|
const finder = new TestVisualStudioFinder(semverV1, null)
|
|
|
|
allVsVersions(finder)
|
|
const { err, info } = await finder.findVisualStudio()
|
|
assert.strictEqual(err, null)
|
|
assert.deepStrictEqual(info.path,
|
|
'C:\\Program Files (x86)\\Microsoft Visual Studio\\2019\\BuildTools')
|
|
})
|
|
|
|
it('run on a unusable VS Command Prompt', async function () {
|
|
process.env.VCINSTALLDIR =
|
|
'C:\\Program Files (x86)\\Microsoft Visual Studio\\2019\\BuildToolsUnusable\\VC'
|
|
|
|
const finder = new TestVisualStudioFinder(semverV1, null)
|
|
|
|
allVsVersions(finder)
|
|
const { err, info } = await finder.findVisualStudio()
|
|
assert.ok(/find .* Visual Studio/i.test(err), 'expect error')
|
|
assert.ok(!info, 'no data')
|
|
})
|
|
|
|
it('run on a VS Command Prompt with matching msvs_version', async function () {
|
|
process.env.VCINSTALLDIR = 'C:\\VS2015\\VC'
|
|
|
|
const finder = new TestVisualStudioFinder(semverV1, 'C:\\VS2015')
|
|
|
|
allVsVersions(finder)
|
|
const { err, info } = await finder.findVisualStudio()
|
|
assert.strictEqual(err, null)
|
|
assert.deepStrictEqual(info.path, 'C:\\VS2015')
|
|
})
|
|
|
|
it('run on a VS Command Prompt with mismatched msvs_version', async function () {
|
|
process.env.VCINSTALLDIR =
|
|
'C:\\Program Files (x86)\\Microsoft Visual Studio\\2019\\BuildTools\\VC'
|
|
|
|
const finder = new TestVisualStudioFinder(semverV1, 'C:\\VS2015')
|
|
|
|
allVsVersions(finder)
|
|
const { err, info } = await finder.findVisualStudio()
|
|
assert.ok(/find .* Visual Studio/i.test(err), 'expect error')
|
|
assert.ok(!info, 'no data')
|
|
})
|
|
|
|
it('run on a portable VS Command Prompt with sufficient environs', async function () {
|
|
process.env.VCINSTALLDIR = 'C:\\Program Files (x86)\\Microsoft Visual Studio\\2019\\Community\\VC'
|
|
process.env.VSCMD_VER = '16.0'
|
|
process.env.WindowsSDKVersion = '10.0.17763.0'
|
|
|
|
const finder = new TestVisualStudioFinder(semverV1, null)
|
|
|
|
allVsVersions(finder)
|
|
const { err, info } = await finder.findVisualStudio()
|
|
assert.strictEqual(err, null)
|
|
assert.deepStrictEqual(info, {
|
|
msBuild: 'C:\\Program Files (x86)\\Microsoft Visual Studio\\2019\\' +
|
|
'Community\\MSBuild\\Current\\Bin\\MSBuild.exe',
|
|
path:
|
|
'C:\\Program Files (x86)\\Microsoft Visual Studio\\2019\\Community',
|
|
sdk: '10.0.17763.0',
|
|
toolset: 'v142',
|
|
// Assume version in the environ is correct.
|
|
version: '16.0',
|
|
versionMajor: 16,
|
|
versionMinor: 0,
|
|
versionYear: 2019
|
|
})
|
|
})
|
|
})
|