Pentia.Get-RuntimeDependencyPackage

2.0.0

Pentia.Get-RuntimeDependencyPackage.psm1

<#
.SYNOPSIS
Gets all NuGet package references from a well formed NuGet packages.config-file.
 
.DESCRIPTION
See https://docs.microsoft.com/en-us/nuget/schema/packages-config for the correct file format.
Only the "id" and "version" attributes are used.
 
.PARAMETER ConfigurationFilePath
The path of the packages.config file.
 
.EXAMPLE
Get-RuntimeDependencyPackage -ConfigurationFilePath my-solution\runtime-dependencies.config
 
Contents of "runtime-dependencies.config":
<?xml version="1.0" encoding="utf-8"?>
<packages>
  <package id="Sitecore.Full" version="8.2.170728" source="http://tund/nuget/NuGet" />
  <package id="jQuery" version="3.1.1" />
  <package id="NLog" version="4.3.10" />
</packages>
 
Returns an array of objects:
[
    {id:"Sitecore.Full", version:"8.2.170728", source:"http://tund/nuget/NuGet"},
    {id:"jQuery", version:"3.1.1"},
    {id:"NLog", version:"4.3.10"}
]
 
#>
function Get-RuntimeDependencyPackage {
    [CmdletBinding()]
    [OutputType([System.Array])]
    param (
        [Parameter(Mandatory = $true)]
        [string]$ConfigurationFilePath
    )

    if (!(Test-Path $ConfigurationFilePath -PathType Leaf)) {
        $message = "File '$ConfigurationFilePath' not found."
        $argumentException = (New-Object "System.ArgumentException" $message, $_.Exception)
        throw $argumentException
    }

    $configuration = Get-PackageConfiguration -ConfigurationFilePath $ConfigurationFilePath

    if (!($configuration.packages)) {
        throw "No 'packages' root element found in '$ConfigurationFilePath'. Run 'Get-Help Get-RuntimeDependencyPackage -Full' for expected usage."
    }

    $packages = $configuration.packages.package | ForEach-Object { 
        $package = New-Object -TypeName "RuntimeDependencyPackage" 
        $package.id = $_.id
        $package.version = $_.version
        $package.source = $_.source
        $package
    }
    Write-Verbose "Found $($packages.Count) package(s) in '$ConfigurationFilePath'."
    @($packages)
}

function Get-PackageConfiguration {
    [CmdletBinding()]
    param (
        [Parameter(Mandatory = $true)]
        [string]$ConfigurationFilePath
    )

    try {
        [xml]$configuration = Get-Content -Path $ConfigurationFilePath
    }
    catch [System.Management.Automation.RuntimeException] {
        if (Test-XmlParseException $_.Exception) {
            $message = "File '$ConfigurationFilePath' isn't valid XML. Run 'Get-Help Get-RuntimeDependencyPackage -Full' for expected usage."
            $argumentException = (New-Object "System.ArgumentException" $message, $_.Exception)
            throw $argumentException
        }
        throw $_.Exception
    }

    $configuration
}

function Test-XmlParseException {
    [CmdletBinding()]
    param (
        [Parameter(Mandatory = $true)]
        [System.Management.Automation.RuntimeException]$Exception
    )
    $Exception.Message -match "Cannot convert value .* to type ""System\.Xml\.XmlDocument""\."
}

Class RuntimeDependencyPackage {
    [string]$id;
    [string]$version;
    [string]$source;
}

Export-ModuleMember -Function Get-RuntimeDependencyPackage