Azure虚拟机MSBuild构建VS2017项目MSB3644报错排查问询

背景 #

• 团队开发人员在本地PC使用Visual Studio 2017可成功构建目标项目，需要在Azure虚拟机上通过Azure Pipeline完成该项目的自动化构建
• 流水线构建无法调用Visual Studio图形界面，因此先通过命令行执行构建验证可行性，验证通过后再添加对应流水线任务
• 项目通过NuGet安装了若干MongoDB相关依赖包，初期排查时曾误判问题由MongoDB组件导致，后续确认根因与MongoDB组件无关

第一个问题：MSB4186 静态方法调用语法错误 #

报错日志 #

"C:\workspace\xxxxx\xxxxx.sln" (default target) (1) ->
"C:\workspace\xxxxx\xxxxx.csproj" (default target) (2) ->
C:\workspace\xxxxx\packages\MongoDB.Libmongocrypt.1.0.0\build\MongoDB.Libmongocrypt.targets(4,16):
 error MSB4186: Invalid static method invocation syntax: "MSBuild]::IsOsPlatform('Windows')".
 Method '[MSBuild]::IsOsPlatform' not found. Static method invocation should be of the form:
 $([FullTypeName]::Method()), e.g. $([System.IO.Path]::Combine(`a`, `b`)).

排查与解决 #

对比环境版本发现MSBuild版本差异是问题根源：

• 构建成功的本地PC：MSBuild版本为15.9.21
• 构建失败的Azure VM：MSBuild版本为15.1.155

考虑到单独升级MSBuild或零散更新组件容易出现版本不兼容问题，选择对VS2017执行全量更新：

• 所用Azure VM为自托管Standard DS3 v2机型，采用VS-2017-Ent-WS2016镜像，预装VS2017基础环境
• 通过Windows「应用和功能」面板选中VS2017，启动安装管理器执行全量更新
• 更新完成后Azure VM上的MSBuild版本升级为15.9.21，上述MSB4186报错消失，第一个问题解决

第二个问题：MSB3644 找不到.NET Framework 4.7.2引用程序集 #

报错日志 #

"C:\workspace\xxxxx\xxxxx.sln" (default target) (1) ->
"C:\workspace\xxxxx\xxxxx.csproj" (default target) (2) ->
(GetReferenceAssemblyPaths target) ->
  C:\Program Files (x86)\Microsoft Visual Studio\2017\Enterprise\MSBuild\15.0\
bin\Microsoft.Common.CurrentVersion.targets(1179,5):
 error MSB3644: The reference assemblies for framework ".NETFramework,Version=v4.7.2" were not found.
 To resolve this, install the SDK or Targeting Pack for this framework version or retarget your application 
to a version of the framework for which you have the SDK or Targeting Pack installed. 
Note that assemblies will be resolved from the Global Assembly Cache (GAC) and will be used in place of reference assemblies. 
Therefore your assembly may not be correctly targeted for the framework you intend.
[C:\workspace\xxxxxx\xxxxx.csproj]

报错中文翻译：未找到框架“.NETFramework,Version=v4.7.2”的引用程序集。若要解决此问题，请安装该框架版本的SDK或目标包，或将应用程序重定向到已安装对应SDK/目标包的框架版本。注意，程序集将从全局程序集缓存（GAC）解析并替换引用程序集，因此生成的程序集可能无法正确适配预期目标框架。

已排查信息 #

• 执行命令 ls "C:\Program Files (x86)\Reference Assemblies\Microsoft\Framework" 后，列出的最高版本框架为v4.6.1、v4.6.2、v4.7.1以及v4.X，所有目录时间戳均为操作当日，是本次VS2017更新后生成的
• 从官方渠道下载.NET Framework v4.7.2 web安装包 ndp472-kb4054531-web.exe 运行，安装被拦截，提示：.NET Framework 4.7.2或更高版本的更新已安装在此计算机上。

问题根因 #

这是典型的.NET Framework运行时与开发目标包不匹配问题：系统中已经安装了.NET 4.7.2及以上版本的运行时（所以运行独立安装包会被拦截），但缺少编译必需的4.7.2版本目标包（Targeting Pack）——目标包内存储MSBuild编译时需要的引用程序集，普通运行时安装包不会携带这类开发专用文件，因此才会出现“系统提示已装高版本框架，但编译找不到对应引用”的矛盾。

修复步骤 #

1. 打开之前更新VS2017用的Visual Studio Installer，找到已安装的VS2017 Enterprise实例，点击「修改」
2. 切换到「单个组件」标签页，在.NET分类下勾选 .NET Framework 4.7.2 目标包
3. 点击「修改」等待组件安装完成
4. 安装完成后重新执行构建命令即可

如果需要无图形界面静默安装（适配后续流水线环境初始化场景），可以直接在管理员权限的命令提示符/PowerShell中执行以下命令：

"C:\Program Files (x86)\Microsoft Visual Studio\Installer\vs_installer.exe" modify --installPath "C:\Program Files (x86)\Microsoft Visual Studio\2017\Enterprise" --add Microsoft.Net.Component.4.7.2.TargetingPack --passive --norestart

安装完成后重新查看Reference Assemblies目录，确认存在v4.7.2子目录即可，此时再执行构建不会再触发MSB3644错误。

内容的提问来源于stack exchange，提问作者Ray Depew