Skip JSON validation if Test-Json command is not available, for backward compatibility (PowerShell 5.1).

Author: TinaMor

.textlintrc.json

@@ -38,7 +38,6 @@
         "/nat/gi",
         "NatNetwork",
         "nerdctl",
-        "/nuget/gi",
         "PowerShell",
         "/PSCustomObject/gi",
         "subnet",

Tests/CommonToolUtilities.Tests.ps1

@@ -534,15 +534,13 @@ Describe "CommonToolUtilities.psm1" {
                 -ParameterFilter { $Path -eq $Script:ChecksumFile }
         }
 
-        It "should use custom Test-JSON if command not exists" {
-            Mock Get-Command -ModuleName "CommonToolUtilities" -MockWith { return $null }
-            Mock Get-Content -ModuleName "CommonToolUtilities" `
-                -MockWith { return ($SbomJson -replace "__CHECKSUM__", "SampleHash") } `
-                -ParameterFilter { $Path -eq $Script:ChecksumFile }
+        It "should skip JSON validation when Test-Json is not available" {
+            Mock Get-Command -ModuleName "CommonToolUtilities" -MockWith { return $null }-ParameterFilter {
+                $Name -eq 'Test-Json'
+            }
 
-            # We rely on the absence of the required types (Newtonsoft.Json)
-            # to confirm that your fallback logic is being exercised.
-            { & $Script:FunctionToCall } | Should -Throw "*Unable to find type*Newtonsoft.Json*"
+            {& $Script:FunctionToCall} | Should -Not -Throw
+            Should -Invoke Test-Json -Times 0 -Scope It -ModuleName "CommonToolUtilities"
         }
 
         It "should throw an error if checksum file does not exist" {

build/hacks/Load-NewtonsoftDlls.ps1

@@ -67,7 +67,7 @@ public enum ActionConsent {
 }
 '@
 
-$HASH_FUNCTIONS = @("SHA1", "SHA256", "SHA384", "SHA512", "MD5")
+$HASH_FUNCTIONS = @("SHA256", "SHA384", "SHA512")
 $HASH_FUNCTIONS_STR = $HASH_FUNCTIONS -join '|' # SHA1|SHA256|SHA384|SHA512|MD5
 $NERDCTL_CHECKSUM_FILE_PATTERN = "(?<hashfunction>(?:^({0})))" -f ($HASH_FUNCTIONS -join '|')
 $NERDCTL_FILTER_SCRIPTBLOCK_STR = { (("{0}" -match "$NERDCTL_CHECKSUM_FILE_PATTERN") -and "{0}" -notmatch ".*.asc$") }.ToString()
@@ -652,10 +652,8 @@ function ValidateJSONChecksumFile {
     try {
         # Check if Test-Json cmdlet is available
         if (-not (Get-Command -Name Test-Json -ErrorAction SilentlyContinue)) {
-            Write-Debug "Using custom JSON validation module."
-            Import-Module (Join-Path $ModuleParentPath "Private\Json-Validator.psm1") -DisableNameChecking -Force -ErrorAction Stop
-        } else {
-            Write-Debug "Using built-in Test-Json cmdlet."
+            Write-Warning "Couldn't validate JSON checksum file. Test-Json cmdlet is not available. Upgrade to PowerShell 7.0 or later to use this feature."
+            return $false
         }
         $isValidJSON = Test-Json -Json "$(Get-Content -Path $ChecksumFilePath -Raw)" -Schema "$schemaFileContent"
         return $isValidJSON

containers-toolkit/Private/CommonToolUtilities.psm1

@@ -69,7 +69,6 @@ Note that the HostNetworkingService module is available only when the Hyper-V Wi
     NestedModules     = @(
         'Private\CommonToolUtilities.psm1',
         'Private\UpdateEnvironmentPath.psm1',
-        'Private\Json-Validator.psm1',
         'Public\AllToolsUtilities.psm1',
         'Public\BuildkitTools.psm1',
         'Public\ContainerdTools.psm1',
@@ -126,7 +125,6 @@ Note that the HostNetworkingService module is available only when the Hyper-V Wi
     FileList          = @(
         './Private/CommonToolUtilities.psm1',
         './Private/UpdateEnvironmentPath.psm1',
-        './Private/Json-Validator.psm1',
         './Public/AllToolsUtilities.psm1',
         './Public/BuildkitTools.psm1',
         './Public/ContainerdTools.psm1',

containers-toolkit/Private/Json-Validator.psm1

@@ -5,7 +5,6 @@
 - [`Import-Module` issues](#import-module-issues)
 - [Tool uninstall issues](#tool-uninstall-issues)
 - [`Initialize-NatNetwork` issues](#initialize-natnetwork-issues)
-- [`'Test-Json' is not recognized as the name of a cmdlet`](#test-json-is-not-recognized-as-the-name-of-a-cmdlet)
 
 ## `Import-Module` issues
 
@@ -108,42 +107,3 @@ Import-Module HNS
 > [!CAUTION]  
 > **We do not recommend** using the [_third-party_ HNS module](https://www.powershellgallery.com/packages/HNS/0.2.4) available in the PowerShell Gallery. This module is **NOT** maintained and signed by Microsoft and may not be up-to-date with the latest changes in the HNS module.
 > _Microsoft does **NOT** take any responsibility for issues that may arise from installing and/or execution of commands in any third-party modules/scripts. Install the _third-party_ HNS module at your own risk!_
-
-## `'Test-Json' is not recognized as the name of a cmdlet`
-
-This error occurs because the `Test-Json` cmdlet was introduced in **PowerShell 6.1** and is not available in **Windows PowerShell 5.1** or earlier. To maintain compatibility, a custom implementation of `Test-Json` is provided for environments where the native cmdlet is unavailable.
-
-To enable this compatibility, you must ensure that the `Newtonsoft.Json` and `Newtonsoft.Json.Schema` assemblies are loaded in your PowerShell session. You can do this in one of two ways:
-
-**Option 1 – Use the loader script**
-
-Use the `Load-NewtonsoftDlls` script to automatically download and load the required assemblies:
-
-```powershell
-.\build\hacks\Load-NewtonsoftDlls.ps1
-```
-
-**Option 2 – Load the assemblies manually**
-
-1. **Download the NuGet package**:
-
-   ```powershell
-   $newtonsoftDir = \"$env:USERPROFILE\Documents\PowerShell\Modules\Newtonsoft.Json\"
-   nuget.exe install Newtonsoft.Json.Schema -OutputDirectory $newtonsoftDir -Framework \"net45\" -ExcludeVersion
-   ```
-
-2. **Load the assemblies**:
-
-   ```powershell
-   $jsondllPath = \"$newtonsoftDir\\Newtonsoft.Json\\lib\\net45\\Newtonsoft.Json.dll\"
-   [Reflection.Assembly]::LoadFile($jsondllPath) | Out-Null
-
-   $schemadllPath = \"$newtonsoftDir\\Newtonsoft.Json.Schema\\lib\\net45\\Newtonsoft.Json.Schema.dll\"
-   [Reflection.Assembly]::LoadFile($schemadllPath) | Out-Null
-   ```
-
-### Reference
-
-- [Test-Json](https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.utility/test-json?view=powershell-7.4)
-- [Newtonsoft.Json](https://www.nuget.org/packages/Newtonsoft.Json#supportedframeworks-body-tab)
-- [Differences between Windows PowerShell 5.1 and PowerShell 7.x](https://learn.microsoft.com/en-us/powershell/scripting/whats-new/differences-from-windows-powershell?view=powershell-7.5#new-test-json-cmdlet)