Cmdlets/Internal/Octopus/Test-OctopusConnectivity.ps1

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
<#
Copyright 2016 ASOS.com Limited
 
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
 
    http://www.apache.org/licenses/LICENSE-2.0
 
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
#>


<#
.NAME
    Test-OctopusConnectivity
 
.SYNOPSIS
    Verifies that the required octopus environment variables are available, and performs a test API call to ensure the Octopus web api is responding
#>

function Test-OctopusConnectivity {
    param(
        $OctopusUri = $ENV:OctopusURI,
        $OctopusApiKey = $ENV:OctopusApikey,
        [switch]$TestConnection
    )
    
    if ([string]::IsNullOrWhiteSpace($OctopusUri)) {
        throw "The OctopusUri environment variable is not set, please set this variable and execute again."
    }

    if ([string]::IsNullOrWhiteSpace($OctopusApiKey)) {
        throw "The OctopusApiKey environment variables is not set, please set this variable and execute again."
    }
    
    if ($TestConnection) {
        $apiTestCall = Invoke-OctopusOperation -Action Get -ObjectType UserDefined -ApiUri "api" | ? Application -eq "Octopus Deploy"
        
        if ($null -eq $apiTestCall) {
            throw "Octopus Deploy Api is not responding correctly"
        }
    }
}