Configuration, build and test Powershell scripts fail on older powershell with a confusing error

[guhetier]

Describe the bug

The documentation indicates to run ./scripts/prepare-machine.ps1 to get dependencies and setup a device for building or testing.

This script doesn't work on PowerShell 5, it fails with:

The variable '$IsLinux' cannot be retrieved because it has not been set.
At line:1 char:1
+ scripts/prepare-machine.ps1
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    + CategoryInfo          : InvalidOperation: (IsLinux:String) [prepare-machine.ps1], RuntimeException
    + FullyQualifiedErrorId : VariableIsUndefined,prepare-machine.ps1

Affected OS

• Windows
• Linux
• macOS
• Other (specify below)

Additional OS information

No response

MsQuic version

main

Steps taken to reproduce bug

Run ./scripts/prepare-machine.ps1

Expected behavior

The script works

Actual outcome

The script fails with

The variable '$IsLinux' cannot be retrieved because it has not been set.
At line:1 char:1
+ scripts/prepare-machine.ps1
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    + CategoryInfo          : InvalidOperation: (IsLinux:String) [prepare-machine.ps1], RuntimeException
    + FullyQualifiedErrorId : VariableIsUndefined,prepare-machine.ps1

Additional details

No response

[guhetier]

Same issue with test.ps1

[guhetier]

The issue is that I wasn't running in powershell 7.

I suggest adding a check in the script for the powershell version for a more explicit error: #Requires -Version 7.0

We would then get:

PS C:\Users\AdminUser\Documents\msquic\scripts> .\prepare-machine.ps1
.\prepare-machine.ps1 : The script 'prepare-machine.ps1' cannot be run because it contained a "#requires" statement for Windows PowerShell 7.0. The version of Windows PowerShell that is required by the script does not match the currently running version of Windows PowerShell
5.1.26346.5000.
At line:1 char:1
+ .\prepare-machine.ps1
+ ~~~~~~~~~~~~~~~~~~~~~
    + CategoryInfo          : ResourceUnavailable: (prepare-machine.ps1:String) [], ScriptRequiresException
    + FullyQualifiedErrorId : ScriptRequiresUnmatchedPSVersion