Brownserve.PSTools

0.8.2

Public/Build/Send-BuildNotification.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
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 function Send-BuildNotification
{
    [CmdletBinding()]
    param
    (
        # The name of the build that is being reported on.
        [Parameter(
            Mandatory = $false,
            Position = 0
        )]
        [string]
        $BuildName,

        # The status of the build.
        [Parameter(
            Mandatory = $true,
            Position = 1
        )]
        [ValidateSet('Success', 'Fail', 'Information', 'Warning', 'Failure', 'Cancelled')]
        [Alias('Status')]
        [string]
        $BuildStatus,

        # The webhook URL to send the notification to.
        [Parameter(
            Mandatory = $false,
            Position = 2
        )]
        [string]
        $Webhook = $env:BUILD_NOTIFICATION_WEBHOOK,

        # The message to send (optional).
        [Parameter(
            Mandatory = $false, 
            Position = 3
        )]
        [string]
        $Message,

        # The push message to send (optional).
        [Parameter(
            Mandatory = $false,
            Position = 4
        )]
        [string]
        [alias('Push','Title')]
        $PushMessage
    )
    
    begin
    {
        if (!$Webhook)
        {
            throw "No webhook specified."
        }
        if (!$BuildName)
        {
            try
            {
                $BuildName = Split-Path $MyInvocation.PSCommandPath -Leaf
            }
            catch
            {
                throw "Failed to get the name of the build programmatically."
            }
        }
    }
    
    process
    {
        $Fields = @(
            @{
                title = 'Repo:'
                value = $global:RepoName
                short = $true
            },
            @{
                title = 'Build:'
                value = "$BuildName"
                short = $true
            }
        )
        if ($env:BUILD_BRANCH)
        {
            $Fields += @{
                title = 'Branch:'
                value = $env:BUILD_BRANCH
                short = $false
            }
        }
        switch -Regex ($BuildStatus)
        {
            '[Ss]uccess'
            {
                $Colour = '#007C00'
                if (!$PushMessage)
                {
                    $PushMessage = "$BuildName has completed successfully."
                }
                if (!$Message)
                {
                    $Message = "$BuildName has completed successfully."
                }
            }
            '[Ff]ail'
            {
                $Colour = '#FF0000'
                if (!$PushMessage)
                {
                    $PushMessage = "$BuildName has failed."
                }
                if (!$Message)
                {
                    $Message = "$BuildName has failed."
                }
            }
            '[Ii]nformation'
            {
                $Colour = '#00c4ff'
                if (!$PushMessage)
                {
                    $PushMessage = "$BuildName has completed with information."
                }
                if (!$Message)
                {
                    $Message = "$BuildName has completed with information."
                }
            }
            '[Ww]arning'
            {
                $Colour = '#ffc000'
                if (!$PushMessage)
                {
                    $PushMessage = "$BuildName has completed with a warning."
                }
                if (!$Message)
                {
                    $Message = "$BuildName has completed with a warning."
                }
            }
            '[Cc]ancelled'
            {
                $Colour = '#808080'
                if (!$PushMessage)
                {
                    $PushMessage = "$BuildName has been cancelled."
                }
                if (!$Message)
                {
                    $Message = "$BuildName has been cancelled."
                }
            }
        }
        # For now we only support sending to Slack.
        try
        {
            Send-SlackNotification `
                -Message $Message `
                -Webhook $Webhook `
                -Colour $Colour `
                -Title $PushMessage `
                -Fields $Fields
        }
        catch
        {
            Write-Error "Failed to send notification.`n$($_.Exception.Message)"
        }
    }
    end
    {
        
    }
}