Add trace log message when failing to find Env Var

[SimonWahlin]

Fixes #13100

If verbose is set to true in bicepconfig.json, bicep now logs the names of all available environment variables when function readEnvironmentVariable fails to find the variable specified. This should hopefully help troubleshoot errors related to this function.

Example of output before:

Example of output after:

Contributing a feature

• I have opened a new issue for the proposal, or commented on an existing one, and ensured that the Bicep maintainers are good with the design of the feature being implemented
• I have included "Fixes #{issue_number}" in the PR description, so GitHub can link to the issue and close it when the PR is merged
• I have appropriate test coverage of my new feature

Microsoft Reviewers: Open in CodeFlow

[codecov-commenter]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 7.71%. Comparing base (108d816) to head (7a8fab9).
Report is 1305 commits behind head on main.

❗ There is a different number of reports uploaded between BASE (108d816) and HEAD (7a8fab9). Click for more details.

HEAD has 4 uploads less than BASE

Flag	BASE (108d816)	HEAD (7a8fab9)
dotnet	4	0

Additional details and impacted files

@@             Coverage Diff             @@
##             main   #13777       +/-   ##
===========================================
- Coverage   94.28%    7.71%   -86.57%     
===========================================
  Files        1113        7     -1106     
  Lines      100791      350   -100441     
  Branches     8734      127     -8607     
===========================================
- Hits        95028       27    -95001     
+ Misses       4595      322     -4273     
+ Partials     1168        1     -1167     

Flag	Coverage Δ
dotnet	?
typescript	7.71% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

see 1104 files with indirect coverage changes

[SimonWahlin]

@StephenWeatherford I see that one test is failing, but I don't really understand why, don't think it is related to the changes made. Can you help me run it again?

[jeskew]

Could this check do something similar to how we handle unknown properties in the type checker? There's a utility method to detect likely typos and include a "did you mean 'x'?" message on

bicep/src/Bicep.Core/TypeSystem/TypeHelper.cs

Line 224 in 126cd59

true => SpellChecker.GetSpellingSuggestion(propertyName, availableProperties) switch

[SimonWahlin]

That's a great idea!
I'll look into that.

[SimonWahlin]

Done, let me know what you think.

[shenglol]

[github-actions]

Test this change out locally with the following install scripts (Action run 9489043222)

VSCode

• Mac/Linux

  bash <(curl -Ls https://aka.ms/bicep/nightly-vsix.sh) --run-id 9489043222

• Windows

  iex "& { $(irm https://aka.ms/bicep/nightly-vsix.ps1) } -RunId 9489043222"

Azure CLI

• Mac/Linux

  bash <(curl -Ls https://aka.ms/bicep/nightly-cli.sh) --run-id 9489043222

• Windows

  iex "& { $(irm https://aka.ms/bicep/nightly-cli.ps1) } -RunId 9489043222"