Add functions to convert version specifications and resolve module dependencies

Author: MariusStorhaug

scripts/Helpers/Convert-VersionSpec.ps1

@@ -0,0 +1,98 @@
+function Convert-VersionSpec {
+    <#
+            .SYNOPSIS
+            Converts legacy version parameters into a NuGet version range string.
+
+            .DESCRIPTION
+            This function takes minimum, maximum, or required version parameters
+            and constructs a NuGet-compatible version range string.
+
+            - If `RequiredVersion` is specified, the output is an exact match range.
+            - If both `MinimumVersion` and `MaximumVersion` are provided,
+              an inclusive range is returned.
+            - If only `MinimumVersion` is provided, it returns a minimum-inclusive range.
+            - If only `MaximumVersion` is provided, it returns an upper-bound range.
+            - If no parameters are provided, `$null` is returned.
+
+            .EXAMPLE
+            Convert-VersionSpec -MinimumVersion "1.0.0" -MaximumVersion "2.0.0"
+
+            Output:
+            ```powershell
+            [1.0.0,2.0.0]
+            ```
+
+            Returns an inclusive version range from 1.0.0 to 2.0.0.
+
+            .EXAMPLE
+            Convert-VersionSpec -RequiredVersion "1.5.0"
+
+            Output:
+            ```powershell
+            [1.5.0]
+            ```
+
+            Returns an exact match for version 1.5.0.
+
+            .EXAMPLE
+            Convert-VersionSpec -MinimumVersion "1.0.0"
+
+            Output:
+            ```powershell
+            [1.0.0, ]
+            ```
+
+            Returns a minimum-inclusive version range starting at 1.0.0.
+
+            .EXAMPLE
+            Convert-VersionSpec -MaximumVersion "2.0.0"
+
+            Output:
+            ```powershell
+            (, 2.0.0]
+            ```
+
+            Returns an upper-bound range up to version 2.0.0.
+
+            .OUTPUTS
+            string
+
+            .NOTES
+            The NuGet version range string based on the provided parameters.
+            The returned string follows NuGet versioning syntax.
+
+            .LINK
+            https://psmodule.io/Convert/Functions/Convert-VersionSpec
+        #>
+    [OutputType([string])]
+    [CmdletBinding()]
+    param(
+        # The minimum version for the range. If specified alone, the range is open-ended upwards.
+        [Parameter()]
+        [string] $MinimumVersion,
+
+        # The maximum version for the range. If specified alone, the range is open-ended downwards.
+        [Parameter()]
+        [string] $MaximumVersion,
+
+        # Specifies an exact required version. If set, an exact version range is returned.
+        [Parameter()]
+        [string] $RequiredVersion
+    )
+
+    if ($RequiredVersion) {
+        # Use exact match in bracket notation.
+        return "[$RequiredVersion]"
+    } elseif ($MinimumVersion -and $MaximumVersion) {
+        # Both bounds provided; both are inclusive.
+        return "[$MinimumVersion,$MaximumVersion]"
+    } elseif ($MinimumVersion) {
+        # Only a minimum is provided. Use a minimum-inclusive range.
+        return "[$MinimumVersion, ]"
+    } elseif ($MaximumVersion) {
+        # Only a maximum is provided; lower bound open.
+        return "(, $MaximumVersion]"
+    } else {
+        return $null
+    }
+}

scripts/Helpers/Resolve-PSModuleDependency.ps1

@@ -0,0 +1,105 @@
+function Resolve-PSModuleDependency {
+    <#
+        .SYNOPSIS
+            Resolves module dependencies from a manifest file using Install-PSResource.
+
+        .DESCRIPTION
+            Reads a module manifest (PSD1) and for each required module converts the old
+            Install-Module parameters (MinimumVersion, MaximumVersion, RequiredVersion)
+            into a single NuGet version range string for Install-PSResource's –Version parameter.
+            (Note: If RequiredVersion is set, that value takes precedence.)
+
+        .EXAMPLE
+            Resolve-PSModuleDependency -ManifestFilePath 'C:\MyModule\MyModule.psd1'
+    Installs all modules defined in the manifest file, following PSModuleInfo structure.
+
+        .NOTES
+        Should later be adapted to support both pre-reqs, and dependencies.
+        Should later be adapted to take 4 parameters sets: specific version ("requiredVersion" | "GUID"), latest version ModuleVersion,
+        and latest version within a range MinimumVersion - MaximumVersion.
+    #>
+    [Diagnostics.CodeAnalysis.SuppressMessageAttribute(
+        'PSAvoidUsingWriteHost', '', Scope = 'Function',
+        Justification = 'Want to just write to the console, not the pipeline.'
+    )]
+    [CmdletBinding()]
+    param(
+        # The path to the manifest file.
+        [Parameter(Mandatory)]
+        [string] $ManifestFilePath
+    )
+
+    Write-Host 'Resolving dependencies'
+    $manifest = Import-PowerShellDataFile -Path $ManifestFilePath
+    Write-Host " - Reading [$ManifestFilePath]"
+    Write-Host " - Found [$($manifest.RequiredModules.Count)] module(s) to install"
+
+    foreach ($requiredModule in $manifest.RequiredModules) {
+        # Build parameters for Install-PSResource (new version spec).
+        $psResourceParams = @{
+            TrustRepository = $true
+        }
+        # Build parameters for Import-Module (legacy version spec).
+        $importParams = @{
+            Force   = $true
+            Verbose = $false
+        }
+
+        if ($requiredModule -is [string]) {
+            $psResourceParams.Name = $requiredModule
+            $importParams.Name = $requiredModule
+        } else {
+            $psResourceParams.Name = $requiredModule.ModuleName
+            $importParams.Name = $requiredModule.ModuleName
+
+            # Convert legacy version info for Install-PSResource.
+            $versionSpec = Convert-VersionSpec `
+                -MinimumVersion $requiredModule.ModuleVersion `
+                -MaximumVersion $requiredModule.MaximumVersion `
+                -RequiredVersion $requiredModule.RequiredVersion
+
+            if ($versionSpec) {
+                $psResourceParams.Version = $versionSpec
+            }
+
+            # For Import-Module, keep the original version parameters.
+            if ($requiredModule.ModuleVersion) {
+                $importParams.MinimumVersion = $requiredModule.ModuleVersion
+            }
+            if ($requiredModule.RequiredVersion) {
+                $importParams.RequiredVersion = $requiredModule.RequiredVersion
+            }
+            if ($requiredModule.MaximumVersion) {
+                $importParams.MaximumVersion = $requiredModule.MaximumVersion
+            }
+        }
+
+        Write-Host " - [$($psResourceParams.Name)] - Installing module with Install-PSResource using version spec: $($psResourceParams.Version)"
+        $VerbosePreferenceOriginal = $VerbosePreference
+        $VerbosePreference = 'SilentlyContinue'
+        $retryCount = 5
+        $retryDelay = 10
+        for ($i = 0; $i -lt $retryCount; $i++) {
+            try {
+                Install-PSResource @psResourceParams
+                break
+            } catch {
+                Write-Warning "Installation of $($psResourceParams.Name) failed with error: $_"
+                if ($i -eq $retryCount - 1) {
+                    throw
+                }
+                Write-Warning "Retrying in $retryDelay seconds..."
+                Start-Sleep -Seconds $retryDelay
+            }
+        }
+        $VerbosePreference = $VerbosePreferenceOriginal
+
+        Write-Host " - [$($importParams.Name)] - Importing module with legacy version spec"
+        $VerbosePreferenceOriginal = $VerbosePreference
+        $VerbosePreference = 'SilentlyContinue'
+        Import-Module @importParams
+        $VerbosePreference = $VerbosePreferenceOriginal
+        Write-Host " - [$($importParams.Name)] - Done"
+    }
+    Write-Host ' - Resolving dependencies - Done'
+}