DSCResources/MSFT_PackageManagementSource/MSFT_PackageManagementSource.psm1
|
# # Copyright (c) Microsoft Corporation. # # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN # THE SOFTWARE. # #This PS DSC resource enables register or unregister a package source through DSC Get, Set and Test operations on DSC managed nodes. Import-LocalizedData -BindingVariable LocalizedData -filename MSFT_PackageManagementSource.strings.psd1 Import-Module -Name "$PSScriptRoot\..\OneGetHelper.psm1" function Get-TargetResource { <# .SYNOPSIS This DSC resource provides a mechanism to register/unregister a package source on your computer. Get-TargetResource returns the current state of the resource. .PARAMETER Name Specifies the name of the package source to be registered or unregistered on your system. .PARAMETER ProviderName Specifies the name of the PackageManagement provider through which you can interop with the package source. .PARAMETER SourceUri Specifies the Uri of the package source. #> [CmdletBinding()] [OutputType([System.Collections.Hashtable])] param ( [parameter(Mandatory = $true)] [System.String] $Name, [parameter(Mandatory = $true)] [System.String] $ProviderName, [parameter(Mandatory = $true)] [System.String] $SourceUri ) #initialize a local var $ensure = "Absent" #Set the installation policy by default, untrusted. $installationPolicy ="Untrusted" $PSBoundParameters.Add("Location", $SourceUri) $PSBoundParameters.Remove("SourceUri") #Validate Uri and add Location because PackageManagement uses Location not SourceUri. #ValidateArgument -Argument $PSBoundParameters['Location'] -Type 'PackageSource' -ProviderName $ProviderName Write-Verbose -Message ($localizedData.StartGetPackageSource -f $($Name)) #check if the package source already registered on the computer $source = PackageManagement\Get-PackageSource @PSBoundParameters -ForceBootstrap -ErrorAction SilentlyContinue -WarningAction SilentlyContinue if (($source.count -gt 0) -and ($source.IsRegistered)) { Write-Verbose -Message ($localizedData.PackageSourceFound -f $($Name)) $ensure = "Present" } else { Write-Verbose -Message ($localizedData.PackageSourceNotFound -f $($Name)) } Write-Debug -Message "Source $($Name) is $($ensure)" if ($ensure -eq 'Absent') { return @{ Ensure = $ensure Name = $Name ProviderName = $ProviderName } } else { #Sometimes Get-PackageSource can return duplicate entries. Below is the workaround to the bug. #Once the bug gets fixed, remove the below if ($source.count -gt 1) block if ($source.count -gt 1) { $source =$source[0] } if ($source.IsTrusted) { $installationPolicy = "Trusted" } return @{ Ensure = $ensure Name = $Name ProviderName = $ProviderName SourceUri = $source.Location InstallationPolicy = $installationPolicy } } } function Test-TargetResource { <# .SYNOPSIS This DSC resource provides a mechanism to register/unregister a package source on your computer. Test-TargetResource validates whether the resource is currently in the desired state. .PARAMETER Name Specifies the name of the package source to be registered or unregistered on your system. .PARAMETER ProviderName Specifies the name of the PackageManagement provider through which you can interop with the package source. .PARAMETER SourceUri Specifies the Uri of the package source. .PARAMETER Ensure Determines whether the package source to be registered or unregistered. .PARAMETER SourceCredential Provides access to the package on a remote source. .PARAMETER InstallationPolicy Determines whether you trust the package�s source. #> [CmdletBinding()] [OutputType([System.Boolean])] param ( [parameter(Mandatory = $true)] [System.String] $Name, [parameter(Mandatory = $true)] [System.String] $ProviderName, [parameter(Mandatory = $true)] [System.String] $SourceUri, [ValidateSet("Present","Absent")] [System.String] $Ensure="Present", [System.Management.Automation.PSCredential] $SourceCredential, [ValidateSet("Trusted","Untrusted")] [System.String] $InstallationPolicy="Untrusted" ) #Get the current status of the package source Write-Debug -Message "Calling Get-TargetResource" $status = Get-TargetResource -Name $Name -ProviderName $ProviderName -SourceUri $SourceUri if($status.Ensure -eq $Ensure) { if ($status.Ensure -eq "Present") { #Check if the source location matches. As get-package takes location (sourceUri) parameter, the result from Get-package should #belong to the particular source location. But currently it does not. Below is the workaround. # if ($status.SourceUri -ine $SourceUri) { Write-Verbose -Message ($localizedData.NotInDesiredStateDuetoLocationMismatch -f $($Name), $($SourceUri), $($status.SourceUri)) return $false } #Check if the installationPolicy matches. Sometimes the registered source and desired source can be the same except for InstallationPolicy # if ($status.InstallationPolicy -ine $InstallationPolicy) { Write-Verbose -Message ($localizedData.NotInDesiredStateDuetoPolicyMismatch -f $($Name), $($InstallationPolicy), $($status.InstallationPolicy)) return $false } } Write-Verbose -Message ($localizedData.InDesiredState -f $($Name), $($Ensure), $($status.Ensure)) return $true } else { Write-Verbose -Message ($localizedData.NotInDesiredState -f $($Name), $($Ensure), $($status.Ensure)) return $false } } function Set-TargetResource { <# .SYNOPSIS This DSC resource provides a mechanism to register/unregister a package source on your computer. Set-TargetResource sets the resource to the desired state. "Make it so". .PARAMETER Name Specifies the name of the package source to be registered or unregistered on your system. .PARAMETER ProviderName Specifies the name of the PackageManagement provider through which you can interop with the package source. .PARAMETER SourceUri Specifies the Uri of the package source. .PARAMETER Ensure Determines whether the package source to be registered or unregistered. .PARAMETER SourceCredential Provides access to the package on a remote source. .PARAMETER InstallationPolicy Determines whether you trust the package�s source. #> [CmdletBinding()] param ( [parameter(Mandatory = $true)] [System.String] $Name, [parameter(Mandatory = $true)] [System.String] $ProviderName, [parameter(Mandatory = $true)] [System.String] $SourceUri, [ValidateSet("Present","Absent")] [System.String] $Ensure="Present", [System.Management.Automation.PSCredential] $SourceCredential, [ValidateSet("Trusted","Untrusted")] [System.String] $InstallationPolicy="Untrusted" ) #Add Location because PackageManagement uses Location not SourceUri. $PSBoundParameters.Add("Location", $SourceUri) if ($PSBoundParameters.ContainsKey("SourceCredential")) { $PSBoundParameters.Add("Credential", $SourceCredential) } if ($InstallationPolicy -ieq "Trusted") { $PSBoundParameters.Add("Trusted", $True) } else { $PSBoundParameters.Add("Trusted", $False) } if($Ensure -ieq "Present") { # #Warn a user about the installation policy # Write-Warning -Message ($localizedData.InstallationPolicyWarning -f $($Name), $($SourceUri), $($InstallationPolicy)) $extractedArguments = ExtractArguments -FunctionBoundParameters $PSBoundParameters ` -ArgumentNames ("Name","ProviderName", "Location", "Credential", "Trusted") Write-Verbose -Message ($localizedData.StartRegisterPackageSource -f $($Name)) PackageManagement\Register-PackageSource @extractedArguments -Force -ErrorVariable ev if($null -ne $ev -and $ev.Count -gt 0) { ThrowError -ExceptionName "System.InvalidOperationException" ` -ExceptionMessage ($localizedData.RegisterFailed -f $Name, $ev.Exception)` -ErrorId "RegisterFailed" ` -ErrorCategory InvalidOperation } else { Write-Verbose -Message ($localizedData.RegisteredSuccess -f $($Name)) } } #Ensure=Absent else { $extractedArguments = ExtractArguments -FunctionBoundParameters $PSBoundParameters ` -ArgumentNames $("Name","ProviderName", "Location", "Credential") Write-Verbose -Message ($localizedData.StartUnRegisterPackageSource -f $($Name)) PackageManagement\Unregister-PackageSource @extractedArguments -Force -ErrorVariable ev if($null -ne $ev -and $ev.Count -gt 0) { ThrowError -ExceptionName "System.InvalidOperationException" ` -ExceptionMessage ($localizedData.UnRegisterFailed -f $Name, $ev.Exception)` -ErrorId "UnRegisterFailed" ` -ErrorCategory InvalidOperation } else { Write-Verbose -Message ($localizedData.UnRegisteredSuccess -f $($Name)) } } } Export-ModuleMember -function Get-TargetResource, Set-TargetResource, Test-TargetResource |