Updating NuGet lock files will fail when running on Windows #25583

reduckted · 2023-11-05T11:24:45Z

reduckted
Nov 5, 2023

How are you running Renovate?

Self-hosted Renovate

If you're self-hosting Renovate, tell us what version of Renovate you run.

37.45.0

If you're self-hosting Renovate, select which platform you are using.

github.com

Was this something which used to work for you, and then stopped?

I am trying to get this working for the first time

Describe the problem

When running Renovate on Windows, updating NuGet lock files fails with the error:

The type initializer for 'NuGet.Configuration.ConfigurationDefaults' threw an exception. 
Value cannot be null. (Parameter 'path1')

When the ConfigurationDefaults class in the error message is initialized, it finds a number of different directories. Some of those directories are found by using environment variables.

This problem occurs because Renovate only passes a limited set of environment variables to package managers. When running on Windows, NuGet looks for a "machine-wide" settings directory which it looks for in the "Program Files" directory. It finds the path of that directory using the PROGRAMFILES environment variable. Since Renovate doesn't pass that environment variable through, the value ends up being null, which causes the error mentioned above.

The environment variables that NuGet can use are found here (though only a subset seem to be needed when updating lock files):
https://github.com/NuGet/NuGet.Client/blob/7bff2239195640e51193a8640a153a570e4cabba/src/NuGet.Core/NuGet.Common/PathUtil/NuGetEnvironment.cs#L159-L229

I've been able to work around this problem by using customEnvVariables. There are a few environment variables that NuGet needs. I was able to get it working by specifying the current value for these environment variables:

PROGRAMFILES
PROGRAMFILES(X86)
APPDATA
LOCALAPPDATA

It would be great if Renovate automatically passed those environment variables through when running dotnet restore to update the lock files.

Minimal reproduction repository:
https://github.com/reduckted/repro-renovate-nuget-windows-bug/

Relevant debug logs

Logs

DEBUG: Executing command (repository=reduckted/repro-renovate-nuget-windows-bug, branch=renovate/newtonsoft.json-13.x)
       "command": "dotnet restore RenovateBug/RenovateBug.csproj --force-evaluate --configfile C:/Users/reduckted/AppData/Local/Temp/renovate/cache/__renovate-private-cache/nuget/nuget.config"   
DEBUG: rawExec err (repository=reduckted/repro-renovate-nuget-windows-bug, branch=renovate/newtonsoft.json-13.x)
       "err": {
         "cmd": "C:\\WINDOWS\\system32\\cmd.exe /d /s /c \"dotnet restore RenovateBug/RenovateBug.csproj --force-evaluate --configfile C:/Users/reduckted/AppData/Local/Temp/renovate/cache/__renovate-private-cache/nuget/nuget.config\"",
         "stderr": "",
         "stdout": "  Determining projects to restore...\r\nC:\\Program Files\\dotnet\\sdk\\8.0.100-rc.2.23502.2\\NuGet.targets(679,5): error : The type initializer for 'NuGet.Configuration.ConfigurationDefaults' threw an exception. [C:\\Users\\reduckted\\AppData\\Local\\Temp\\renovate\\repos\\github\\reduckted\\repro-renovate-nuget-windows-bug\\RenovateBug\\RenovateBug.csproj]\r\nC:\\Program Files\\dotnet\\sdk\\8.0.100-rc.2.23502.2\\NuGet.targets(679,5): error :   Value cannot be null. (Parameter 'path1') [C:\\Users\\reduckted\\AppData\\Local\\Temp\\renovate\\repos\\github\\reduckted\\repro-renovate-nuget-windows-bug\\RenovateBug\\RenovateBug.csproj]\r\n",
         "options": {
           "cwd": "C:/Users/reduckted/AppData/Local/Temp/renovate/repos/github/reduckted/repro-renovate-nuget-windows-bug",
           "encoding": "utf-8",
           "env": {
             "NUGET_PACKAGES": "D:\\Cache\\nuget\\packages",
             "MSBUILDDISABLENODEREUSE": "1",
             "HOME": "C:\\Users\\reduckted",
             "PATH": "*********",
             "LANG": "en_US.UTF-8",
             "CONTAINERBASE_CACHE_DIR": "C:/Users/reduckted/AppData/Local/Temp/renovate/cache/containerbase"
           },
           "maxBuffer": 10485760,
           "timeout": 900000
         },
         "exitCode": 1,
         "name": "ExecError",
         "message": "Command failed: dotnet restore RenovateBug/RenovateBug.csproj --force-evaluate --configfile C:/Users/reduckted/AppData/Local/Temp/renovate/cache/__renovate-private-cache/nuget/nuget.config\n",
         "stack": "ExecError: Command failed: dotnet restore RenovateBug/RenovateBug.csproj --force-evaluate --configfile C:/Users/reduckted/AppData/Local/Temp/renovate/cache/__renovate-private-cache/nuget/nuget.config\n\n    at ChildProcess.<anonymous> (D:\\Code\\GitHub\\reduckted\\repro-renovate-nuget-windows-bug\\node_modules\\renovate\\lib\\util\\exec\\common.ts:99:11)\n    at ChildProcess.emit (node:events:529:35)\n    at ChildProcess.emit (node:domain:489:12)\n    at Process.ChildProcess._handle.onexit (node:internal/child_process:292:12)"
       },
       "durationMs": 1020
DEBUG: Failed to generate lock file (repository=reduckted/repro-renovate-nuget-windows-bug, branch=renovate/newtonsoft.json-13.x)
       "err": {
         "cmd": "C:\\WINDOWS\\system32\\cmd.exe /d /s /c \"dotnet restore RenovateBug/RenovateBug.csproj --force-evaluate --configfile C:/Users/reduckted/AppData/Local/Temp/renovate/cache/__renovate-private-cache/nuget/nuget.config\"",
         "stderr": "",
         "stdout": "  Determining projects to restore...\r\nC:\\Program Files\\dotnet\\sdk\\8.0.100-rc.2.23502.2\\NuGet.targets(679,5): error : The type initializer for 'NuGet.Configuration.ConfigurationDefaults' threw an exception. [C:\\Users\\reduckted\\AppData\\Local\\Temp\\renovate\\repos\\github\\reduckted\\repro-renovate-nuget-windows-bug\\RenovateBug\\RenovateBug.csproj]\r\nC:\\Program Files\\dotnet\\sdk\\8.0.100-rc.2.23502.2\\NuGet.targets(679,5): error :   Value cannot be null. (Parameter 'path1') [C:\\Users\\reduckted\\AppData\\Local\\Temp\\renovate\\repos\\github\\reduckted\\repro-renovate-nuget-windows-bug\\RenovateBug\\RenovateBug.csproj]\r\n",
         "options": {
           "cwd": "C:/Users/reduckted/AppData/Local/Temp/renovate/repos/github/reduckted/repro-renovate-nuget-windows-bug",
           "encoding": "utf-8",
           "env": {
             "NUGET_PACKAGES": "D:\\Cache\\nuget\\packages",
             "MSBUILDDISABLENODEREUSE": "1",
             "HOME": "C:\\Users\\reduckted",
             "PATH": "*********",
             "LANG": "en_US.UTF-8",
             "CONTAINERBASE_CACHE_DIR": "C:/Users/reduckted/AppData/Local/Temp/renovate/cache/containerbase"
           },
           "maxBuffer": 10485760,
           "timeout": 900000
         },
         "exitCode": 1,
         "name": "ExecError",
         "message": "Command failed: dotnet restore RenovateBug/RenovateBug.csproj --force-evaluate --configfile C:/Users/reduckted/AppData/Local/Temp/renovate/cache/__renovate-private-cache/nuget/nuget.config\n",
         "stack": "ExecError: Command failed: dotnet restore RenovateBug/RenovateBug.csproj --force-evaluate --configfile C:/Users/reduckted/AppData/Local/Temp/renovate/cache/__renovate-private-cache/nuget/nuget.config\n\n    at ChildProcess.<anonymous> (D:\\Code\\GitHub\\reduckted\\repro-renovate-nuget-windows-bug\\node_modules\\renovate\\lib\\util\\exec\\common.ts:99:11)\n    at ChildProcess.emit (node:events:529:35)\n    at ChildProcess.emit (node:domain:489:12)\n    at Process.ChildProcess._handle.onexit (node:internal/child_process:292:12)"
       }
DEBUG: Updated 1 package files (repository=reduckted/repro-renovate-nuget-windows-bug, branch=renovate/newtonsoft.json-13.x)