DSCResources/cOctopusEnvironment/cOctopusEnvironment.psm1
|
function Get-TargetResource { [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSDSCUseVerboseMessageInDSCResource", "")] [OutputType([HashTable])] param ( [Parameter(Mandatory)] [ValidateNotNullOrEmpty()] [string]$Url, [Parameter(Mandatory)] [ValidateNotNullOrEmpty()] [ValidateSet("Present", "Absent")] [string]$Ensure, [Parameter(Mandatory)] [ValidateNotNullOrEmpty()] [string]$EnvironmentName, [PSCredential]$OctopusCredentials = [PSCredential]::Empty, [PSCredential]$OctopusApiKey = [PSCredential]::Empty ) $environment = Get-Environment -Url $Url ` -EnvironmentName $EnvironmentName ` -OctopusCredentials $OctopusCredentials ` -OctopusApiKey $OctopusApiKey $existingEnsure = 'Present' if ($null -eq $environment) { $existingEnsure = 'Absent' } $result = @{ Url = $Url; Ensure = $existingEnsure EnvironmentName = $EnvironmentName OctopusCredentials = $OctopusCredentials OctopusApiKey = $OctopusApiKey } return $result } function Set-TargetResource { [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSDSCUseVerboseMessageInDSCResource", "")] param ( [Parameter(Mandatory)] [ValidateNotNullOrEmpty()] [string]$Url, [Parameter(Mandatory)] [ValidateNotNullOrEmpty()] [ValidateSet("Present", "Absent")] [string]$Ensure, [Parameter(Mandatory)] [ValidateNotNullOrEmpty()] [string]$EnvironmentName, [PSCredential]$OctopusCredentials = [PSCredential]::Empty, [PSCredential]$OctopusApiKey = [PSCredential]::Empty ) $currentResource = Get-TargetResource -Url $Url ` -Ensure $Ensure ` -EnvironmentName $EnvironmentName ` -OctopusCredentials $OctopusCredentials ` -OctopusApiKey $OctopusApiKey if ($Ensure -eq "Absent" -and $currentResource.Ensure -eq "Present") { Remove-Environment -Url $Url ` -EnvironmentName $EnvironmentName ` -OctopusCredentials $OctopusCredentials ` -OctopusApiKey $OctopusApiKey } elseif ($Ensure -eq "Present" -and $currentResource.Ensure -eq "Absent") { New-Environment -Url $Url ` -EnvironmentName $EnvironmentName ` -OctopusCredentials $OctopusCredentials ` -OctopusApiKey $OctopusApiKey } } function Test-TargetResource { [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSDSCUseVerboseMessageInDSCResource", "")] [OutputType([boolean])] param ( [Parameter(Mandatory)] [ValidateNotNullOrEmpty()] [string]$Url, [Parameter(Mandatory)] [ValidateNotNullOrEmpty()] [ValidateSet("Present", "Absent")] [string]$Ensure, [Parameter(Mandatory)] [ValidateNotNullOrEmpty()] [string]$EnvironmentName, [PSCredential]$OctopusCredentials = [PSCredential]::Empty, [PSCredential]$OctopusApiKey = [PSCredential]::Empty ) $currentResource = (Get-TargetResource -Url $Url ` -Ensure $Ensure ` -EnvironmentName $EnvironmentName ` -OctopusCredentials $OctopusCredentials ` -OctopusApiKey $OctopusApiKey) $params = Get-OctopusDSCParameter $MyInvocation.MyCommand.Parameters $currentConfigurationMatchesRequestedConfiguration = $true foreach ($key in $currentResource.Keys) { $currentValue = $currentResource.Item($key) $requestedValue = $params.Item($key) if ($currentValue -ne $requestedValue) { Write-Verbose "(FOUND MISMATCH) Configuration parameter '$key' with value '$currentValue' mismatched the specified value '$requestedValue'" $currentConfigurationMatchesRequestedConfiguration = $false } else { Write-Verbose "Configuration parameter '$key' matches the requested value '$requestedValue'" } } return $currentConfigurationMatchesRequestedConfiguration } function Remove-Environment { param ( [string]$Url, [string]$EnvironmentName, [PSCredential]$OctopusCredentials = [PSCredential]::Empty, [PSCredential]$OctopusApiKey = [PSCredential]::Empty ) $repository = Get-OctopusClientRepository -Url $Url ` -OctopusCredentials $OctopusCredentials ` -OctopusApiKey $OctopusApiKey $environment = $repository.Environments.FindByName($EnvironmentName) $repository.Environments.Delete($environment) } function New-Environment { param ( [string]$Url, [string]$EnvironmentName, [PSCredential]$OctopusCredentials = [PSCredential]::Empty, [PSCredential]$OctopusApiKey = [PSCredential]::Empty ) $repository = Get-OctopusClientRepository -Url $Url ` -OctopusCredentials $OctopusCredentials ` -OctopusApiKey $OctopusApiKey $environment = New-Object Octopus.Client.Model.EnvironmentResource $environment.Name = $EnvironmentName $repository.Environments.Create($environment) | Out-Null } function Get-Environment { param ( [string]$Url, [string]$EnvironmentName, [PSCredential]$OctopusCredentials = [PSCredential]::Empty, [PSCredential]$OctopusApiKey = [PSCredential]::Empty ) $repository = Get-OctopusClientRepository -Url $Url ` -OctopusCredentials $OctopusCredentials ` -OctopusApiKey $OctopusApiKey $environment = $repository.Environments.FindByName($EnvironmentName) return $environment } function Get-OctopusClientRepository { param ( [string]$Url, [string]$EnvironmentName, [PSCredential]$OctopusCredentials = [PSCredential]::Empty, [PSCredential]$OctopusApiKey = [PSCredential]::Empty ) if ((($null -eq $OctopusCredentials) -or ($OctopusCredentials -eq [PSCredential]::Empty)) -and (($null -eq $OctopusApiKey) -or ($OctopusApiKey -eq [PSCredential]::Empty))) { throw "Please provide either 'OctopusCredentials' or 'OctopusApiKey'." } if ((($null -ne $OctopusCredentials) -and ($OctopusCredentials -ne [PSCredential]::Empty)) -and (($null -ne $OctopusApiKey) -and ($OctopusApiKey -ne [PSCredential]::Empty))) { throw "Please provide either 'OctopusCredentials' or 'OctopusApiKey', not both." } $tempFolder = [System.IO.Path]::GetTempPath() $shadowCopyFolder = Join-Path $tempFolder ([Guid]::NewGuid()) New-Item -type Directory $shadowCopyFolder | Out-Null $filename = "${env:ProgramFiles}\Octopus Deploy\Octopus\Newtonsoft.Json.dll" $version = [System.Diagnostics.FileVersionInfo]::GetVersionInfo($filename) Write-Verbose "Shadow copying '$filename' (version $($version.FileVersion)) to $shadowCopyFolder" Copy-Item $filename $shadowCopyFolder $filename = "${env:ProgramFiles}\Octopus Deploy\Octopus\Octopus.Client.dll" $version = [System.Diagnostics.FileVersionInfo]::GetVersionInfo($filename) Write-Verbose "Shadow copying '$filename' (version $($version.FileVersion)) to $shadowCopyFolder" Copy-Item $filename $shadowCopyFolder $filename = "${env:ProgramFiles}\Octopus Deploy\Octopus\Octopus.Client.Extensibility.dll" if (Test-Path $filename) { $version = [System.Diagnostics.FileVersionInfo]::GetVersionInfo($filename) Write-Verbose "Shadow copying '$filename' (version $($version.FileVersion)) to $shadowCopyFolder" Copy-Item $filename $shadowCopyFolder } #shadow copy these files, so we can uninstall octopus Add-Type -Path (Join-Path $shadowCopyFolder "Newtonsoft.Json.dll") Add-Type -Path (Join-Path $shadowCopyFolder "Octopus.Client.dll") if (($null -ne $OctopusApiKey) -and ($OctopusApiKey -ne [PSCredential]::Empty)) { $apiKey = $OctopusApiKey.GetNetworkCredential().Password $endpoint = New-Object Octopus.Client.OctopusServerEndpoint($Url, $apiKey) $repository = New-Object Octopus.Client.OctopusRepository $endpoint } else { #connect $endpoint = New-Object Octopus.Client.OctopusServerEndpoint $Url $repository = New-Object Octopus.Client.OctopusRepository $endpoint #sign in $credentials = New-Object Octopus.Client.Model.LoginCommand $credentials.Username = $OctopusCredentials.GetNetworkCredential().Username $credentials.Password = $OctopusCredentials.GetNetworkCredential().Password $repository.Users.SignIn($credentials) } return $repository } function Get-OctopusDSCParameter($parameters) { # unfortunately $PSBoundParameters doesn't contain parameters that weren't supplied (because the default value was okay) # credit to https://www.briantist.com/how-to/splatting-psboundparameters-default-values-optional-parameters/ $params = @{} foreach ($h in $parameters.GetEnumerator()) { $key = $h.Key $var = Get-Variable -Name $key -ErrorAction SilentlyContinue if ($null -ne $var) { $val = Get-Variable -Name $key -ErrorAction Stop | Select-Object -ExpandProperty Value -ErrorAction Stop $params[$key] = $val } } return $params } |