StatusCakeTest.psm1
|
enum Ensure { Absent Present } [DscResource()] class StatusCakeTest { [DscProperty(Mandatory)] [Ensure] $Ensure [DscProperty(Key)] [string]$Name [DScProperty()] [PSCredential] $ApiCredential = [PSCredential]::Empty [DscProperty()] [string] $URL [DscProperty()] [int] $Port = 80 [DscProperty()] # [ValidateScript( { $_ -lt 24000 -and $_ -gt 0} )] [int] $CheckRate = 300 # default 300. > 0 and < 24000 [DscProperty()] [int] $Timeout [DscProperty()] [PSCredential]$BasicCredential = [PSCredential]::Empty [DscProperty()] [bool] $Public [DscProperty()] [bool] $Paused = $false [DscProperty()] [ValidateSet('HTTP', 'TCP', 'PING')] [string] $TestType = 'HTTP' [DscProperty()] [string] $FindString [DscProperty()] [string[]] $ContactGroup [DscProperty()] [int] $MaxRetries = 10 # premium features [DscProperty()] [int] $AlertDelayRate = 5 # maps to TriggerRate on the API. default 5, min 0, max 100. How many minutes to wait before sending an alert [DscProperty()] [int] $ConfirmationServers = 5 # maps to 'Confirmation' on the API. min 1 max 9. default varies by plan, I think [DscProperty(NotConfigurable)] [int] $TestID # if the test exists in Statuscake, we populate this with the ID [DscProperty(NotConfigurable)] [int[]] $ContactGroupID [DscProperty(NotConfigurable)] [int] $RetryCount = 0 [void] Set() { $refObject = $this.Get() $status = $null Write-Verbose ("Found testID " + $refObject.TestID) if($this.Ensure -eq [Ensure]::Absent -and $refObject.TestID -ne 0) { # we need to delete it" Write-Verbose ("Deleting Test " + $this.Name) $status = $this.GetApiResponse(("/Tests/Details/?TestID=" + $refObject.TestID), 'DELETE', $null) | select -expand body } elseif($this.Ensure -eq [Ensure]::Present) { if($refObject.TestID -eq 0) { # we need to create it Write-Verbose ("Creating Test " + $this.Name) $status = $this.GetApiResponse(('/Tests/Update/'), "PUT", $this.GetObjectToPost(0, $this.ResolveContactGroups($this.contactGroup))) | select -expand body } else { # we need to update it Write-Verbose ("Updating Test " + $this.Name) $status = $this.GetApiResponse(('/Tests/Update/'), "PUT", $this.GetObjectToPost($refObject.TestId, $this.ResolveContactGroups($this.contactGroup))) | select -expand body } } if($null -ne $status) { Write-Verbose ("Status returned from API: " + ($status | ConvertTo-json -depth 4)) } } [bool] Test() { $testOK = $true # assume it's fine $refobject = $this.Get() if($this.Ensure -ne $refObject.Ensure) { Write-Verbose "Ensure differs" $testOK = $false } if($this.CheckRate -ne $refobject.CheckRate) { Write-Verbose "Check rate differs" $testOK = $false } if($this.URL -ne $refobject.URL) { Write-Verbose "URL has changed" $testOK = $false } if( (Compare-Object $this.ContactGroup $refObject.ContactGroup) -ne $null) # this is an array. we need to compare it like an array { Write-Verbose "Contact Groups have changed" Write-Verbose "Contact Group here: " Write-Verbose ($this.ContactGroup -join ",") Write-Verbose "Contact Group there: " Write-Verbose ($refObject.ContactGroup -join ",") $testOK = $false } if($this.ConfirmationServers -ne $refobject.ConfirmationServers) { Write-Verbose "ConfirmationServers has changed" $testOK = $false } if($this.AlertDelayRate -ne $refobject.AlertDelayRate) { Write-Verbose "AlertDelayRate has changed" $testOK = $false } if($this.Paused -ne $refobject.Paused) { Write-Verbose "Paused has changed" $testOK = $false } return $testOK } [void] Validate() { if($this.CheckRate -ge 24000) { throw "Checkrate cannot be larger than 24000" } if($this.CheckRate -le 0) { throw "Checkrate cannot be zero or negative" } } [StatusCakeTest] Get() { # first things first, validate $this.Validate(); # does it exist? $checkId = $this.GetApiResponse("/Tests/", "GET", $null) | select -expand Body | Where-Object {$_.WebsiteName -eq $this.Name} | Select-Object -expand TestId $returnobject = [StatusCakeTest]::new() # need a check here for duped by name if(($checkId | Measure-Object | Select-Object -expand Count) -gt 1) { throw "Multiple Ids found with the same name. StatusCakeDSC uses Test Name as a unique key, and cannot continue" } if(($checkId | Measure-Object | Select-Object -expand Count) -le 0) { Write-Verbose "Looks like our check doesn't exist" # check doesn't exist $returnObject.Ensure = [Ensure]::Absent $returnobject.Name = $this.Name $returnobject.URL = $this.URL $returnobject.CheckRate = $this.checkrate $returnobject.Paused = $this.Paused $returnobject.ContactGroup = $this.ContactGroup $returnobject.ContactGroupID = $this.ResolveContactGroups($this.contactGroup) $returnobject.TestID = 0 # null misbehaves $returnobject.AlertDelayRate = $this.AlertDelayRate $returnobject.ConfirmationServers = $this.ConfirmationServers #$this.TestID = 0 } else { Write-Verbose "Check exists, fetching details from remote" $testDetails = $this.GetApiResponse("/Tests/Details/?TestID=$checkId", 'GET', $null) | select -expand Body $returnObject.Ensure = [Ensure]::Present $returnobject.Name = $this.Name $returnobject.URL = $testDetails.URI $returnobject.CheckRate = [int]$testdetails.CheckRate $returnobject.Paused = $testdetails.paused $returnobject.ContactGroup = $testDetails.ContactGroups | select-object -expand Name $returnobject.ContactGroupID = $testdetails.ContactGroups | select-object -expand ID $returnObject.TestID = $CheckID $returnobject.AlertDelayRate = [int]$testDetails.TriggerRate $returnobject.ConfirmationServers = [int]$testDetails.Confirmation #$this.TestID = $CheckID } return $returnobject } [Object] ProcessResponseIfJson([object]$in) { if($in.Headers["Content-Type"] -eq "application/json") { $in | Add-Member -name Body -value ($in.Content | ConvertFrom-Json) -MemberType NoteProperty } else { $in | Add-Member -name Body -value ($in.Content) -MemberType NoteProperty Write-Warning "StatusCake API failed to return JSON response" Write-Warning $in.Body } return $in } [Object] GetApiResponse($stem, $method, $body) { if($null -ne $body) { Write-Verbose ($body | convertto-json -depth 4) } $creds = @{} if($this.ApiCredential -eq [PSCredential]::Empty) { # no Api Key provided, grab 'em off the disk if(-not (Test-Path "$env:ProgramFiles\WindowsPowerShell\Modules\StatusCakeDSC\.securecreds" )) { throw "No credentials specified and no .securecreds file found" } else { $creds = Get-Content "$env:ProgramFiles\WindowsPowerShell\Modules\StatusCakeDSC\.securecreds" | ConvertFrom-Json $secapikey = ConvertTo-SecureString $creds.ApiKey $this.ApiCredential = [PSCredential]::new($creds.UserName, $secapikey) } } $headers = @{ API = $this.ApiCredential.GetNetworkCredential().Password; username = $this.ApiCredential.UserName } if($method -ne 'GET') { $splat = @{ uri = "https://app.statuscake.com/API$stem"; method = $method; body = $body; headers = $headers; ContentType = "application/x-www-form-urlencoded"; } } else { $splat = @{ uri = "https://app.statuscake.com/API$stem"; method = "GET"; headers = $headers; } } try { $h = Invoke-WebRequest @splat -UseBasicParsing $httpresponse = $this.CopyObject($h) $httpresponse = $this.ProcessResponseIfJson($httpresponse) return $httpresponse } catch [System.Net.WebException] { # catches non-200 Responses $r = $_.Exception.Response Write-Verbose "Exception thrown in API request. HTTP Response Received : $($r.StatusCode)" $httpresponse = $this.copyObject($r) $httpresponse = $this.ProcessResponseIfJson($httpresponse) throw ($httpresponse.body.issues | out-string) } catch { Write-Verbose "Non-web exception caught: $($_.ToString())" #retry if($this.RetryCount -lt $this.MaxRetries) { $this.RetryCount = $this.RetryCount + 1 Start-Sleep -s 1 Write-Verbose "retrying" $httpresponse = $this.GetApiResponse($stem, $method, $body) } else { throw $_ } } return $httpresponse } [object] CopyObject([object]$from) # needs validation that the incoming object is not null { $to = [pscustomobject]@{} foreach ($p in Get-Member -In $from -MemberType Property, NoteProperty -Name *) { trap { Add-Member -In $To -MemberType NoteProperty -Name $p.Name -Value $From.$($p.Name) -Force continue } $to.$($p.Name) = $from.$($p.Name) # we know this throws, try to remove its error try { $Error.RemoveAt(0) } catch{} } return $to } [int[]] ResolveContactGroups([string[]]$cgNames) { Write-Verbose "Resolving Contact Groups" $groups = $this.GetApiResponse("/ContactGroups", 'GET', $null) | select -expand body $r = @() for($x=0;$x -lt $cgNames.Length;$x++) { Write-Verbose ("Resolving group name " + $cgNames[$x]) $r += ($groups | Where-Object { $_.GroupName -eq $cgNames[$x] } | Select-Object -expand ContactID) } Write-Verbose ("Found Contact Groups " + ($r -join ",")) return $r } [Object] GetObjectToPost([int]$TestID, [int[]]$ContactGroupID) { $p = 0 if($this.Paused -eq $true) { $p = 1 } # mandatories $r = @{ # hashtable WebsiteName = $this.Name WebsiteURL = $this.URL CheckRate = $this.CheckRate TestType = $this.TestType Paused = $p Confirmation = $this.ConfirmationServers TriggerRate = $this.AlertDelayRate } # optionals if($ContactGroupID.length -gt 0) { Write-Verbose "Adding Contact group to post object" $r.add("ContactGroup", ($ContactGroupID -join ",")) } if($this.BasicCredential -ne [PSCredential]::Empty) { Write-Verbose "Adding Basic Password and user" $r.Add("BasicUser", $this.BasicCredential.UserName) $r.Add("BasicPass", $this.BasicCredential.GetNetworkCredential().Password) } if($TestID -ne 0) { Write-Verbose "Adding a checkID to post object, as we're updating" $r.add("TestID", $TestID) } return $r } [Object] InvokeWithBackoff([scriptblock]$ScriptBlock) { # not in use $backoff = 1 $returnvalue = $null while($returnvalue -eq $null -and $this.retrycount -lt $this.MaxRetries) { try { $returnvalue = Invoke-Command $ScriptBlock } catch { Write-Verbose ($error | Select-Object -first 1 ) Start-Sleep -MilliSeconds ($backoff * 500) $backoff = $backoff + $backoff $this.retrycount++ Write-Verbose "invoking a backoff: $backoff. We have tried $($this.retrycount) times" } } return $returnvalue } } <# Node locations: (only valid for premium accounts) Australia � Sydney Austria � Vienna Belgium � Oostkamp Brazil � Sao Paulo Canada � Montreal Canada � Toronto Chile � Vina Del Mar France � Paris France � Lille Germany � Berlin Germany � Frankfurt Hong Kong Hungary � Budapest Ireland � Dublin Japan � Tokyo Mexico � Mexico City Netherlands � Amsterdam Iceland � Reykjav�k India � Bangalore Israel � Tel Aviv Italy � Milano Mexico � Mexico City New Zealand- Auckland Poland � Warsaw Russia � Moscow Russia � Novosibirsk Singapore South Africa � Johannesburg Spain � Madrid Sweden � Stockholm Switzerland � Bern United Kingdom � London United Kingdom � Manchester United States � Atlanta, Georgia United States � Chicago, Illinois United States � Dallas, Texas United States � Jacksonville, Florida United States � Los Angeles, California United Status � San Francisco, California United States � Silicon Valley, California United States � Phoenix, Arizona, United States � New York, New York #> |