-
Notifications
You must be signed in to change notification settings - Fork 61
/
mattermost_test.go
223 lines (210 loc) · 7.74 KB
/
mattermost_test.go
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
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
package mattermost
import (
"net/url"
"os"
"testing"
"github.com/containrrr/shoutrrr/internal/testutils"
"github.com/containrrr/shoutrrr/pkg/types"
"github.com/jarcoal/httpmock"
. "github.com/onsi/ginkgo"
. "github.com/onsi/gomega"
)
var (
service *Service
envMattermostURL *url.URL
)
func TestMattermost(t *testing.T) {
RegisterFailHandler(Fail)
RunSpecs(t, "Shoutrrr Mattermost Suite")
}
var _ = Describe("the mattermost service", func() {
BeforeSuite(func() {
service = &Service{}
envMattermostURL, _ = url.Parse(os.Getenv("SHOUTRRR_MATTERMOST_URL"))
})
When("running integration tests", func() {
It("should work without errors", func() {
if envMattermostURL.String() == "" {
return
}
serviceURL, _ := url.Parse(envMattermostURL.String())
Expect(service.Initialize(serviceURL, testutils.TestLogger())).To(Succeed())
err := service.Send(
"this is an integration test",
nil,
)
Expect(err).NotTo(HaveOccurred())
})
})
Describe("the mattermost config", func() {
When("generating a config object", func() {
mattermostURL, _ := url.Parse("mattermost://mattermost.my-domain.com/thisshouldbeanapitoken")
config := &Config{}
err := config.SetURL(mattermostURL)
It("should not have caused an error", func() {
Expect(err).NotTo(HaveOccurred())
})
It("should set host", func() {
Expect(config.Host).To(Equal("mattermost.my-domain.com"))
})
It("should set token", func() {
Expect(config.Token).To(Equal("thisshouldbeanapitoken"))
})
It("should not set channel or username", func() {
Expect(config.Channel).To(BeEmpty())
Expect(config.UserName).To(BeEmpty())
})
})
When("generating a new config with url, that has no token", func() {
mattermostURL, _ := url.Parse("mattermost://mattermost.my-domain.com")
config := &Config{}
err := config.SetURL(mattermostURL)
It("should return an error", func() {
Expect(err).To(HaveOccurred())
})
})
When("generating a config object with username only", func() {
mattermostURL, _ := url.Parse("mattermost://testUserName@mattermost.my-domain.com/thisshouldbeanapitoken")
config := &Config{}
err := config.SetURL(mattermostURL)
It("should not have caused an error", func() {
Expect(err).NotTo(HaveOccurred())
})
It("should set username", func() {
Expect(config.UserName).To(Equal("testUserName"))
})
It("should not set channel", func() {
Expect(config.Channel).To(BeEmpty())
})
})
When("generating a config object with channel only", func() {
mattermostURL, _ := url.Parse("mattermost://mattermost.my-domain.com/thisshouldbeanapitoken/testChannel")
config := &Config{}
err := config.SetURL(mattermostURL)
It("should not hav caused an error", func() {
Expect(err).NotTo(HaveOccurred())
})
It("should set channel", func() {
Expect(config.Channel).To(Equal("testChannel"))
})
It("should not set channel", func() {
Expect(config.UserName).To(BeEmpty())
})
})
When("generating a config object with channel an userName", func() {
mattermostURL, _ := url.Parse("mattermost://testUserName@mattermost.my-domain.com/thisshouldbeanapitoken/testChannel")
config := &Config{}
err := config.SetURL(mattermostURL)
It("should not hav caused an error", func() {
Expect(err).NotTo(HaveOccurred())
})
It("should set channel", func() {
Expect(config.Channel).To(Equal("testChannel"))
})
It("should set username", func() {
Expect(config.UserName).To(Equal("testUserName"))
})
})
})
When("generating a config object", func() {
It("should not set icon", func() {
slackURL, _ := url.Parse("mattermost://AAAAAAAAA/BBBBBBBBB")
config, configError := CreateConfigFromURL(slackURL)
Expect(configError).NotTo(HaveOccurred())
Expect(config.Icon).To(BeEmpty())
})
It("should set icon", func() {
slackURL, _ := url.Parse("mattermost://AAAAAAAAA/BBBBBBBBB?icon=test")
config, configError := CreateConfigFromURL(slackURL)
Expect(configError).NotTo(HaveOccurred())
Expect(config.Icon).To(BeIdenticalTo("test"))
})
})
Describe("creating the payload", func() {
Describe("the icon fields", func() {
payload := JSON{}
It("should set IconURL when the configured icon looks like an URL", func() {
payload.SetIcon("https://example.com/logo.png")
Expect(payload.IconURL).To(Equal("https://example.com/logo.png"))
Expect(payload.IconEmoji).To(BeEmpty())
})
It("should set IconEmoji when the configured icon does not look like an URL", func() {
payload.SetIcon("tanabata_tree")
Expect(payload.IconEmoji).To(Equal("tanabata_tree"))
Expect(payload.IconURL).To(BeEmpty())
})
It("should clear both fields when icon is empty", func() {
payload.SetIcon("")
Expect(payload.IconEmoji).To(BeEmpty())
Expect(payload.IconURL).To(BeEmpty())
})
})
})
Describe("Sending messages", func() {
When("sending a message completely without parameters", func() {
mattermostURL, _ := url.Parse("mattermost://mattermost.my-domain.com/thisshouldbeanapitoken")
config := &Config{}
Expect(config.SetURL(mattermostURL)).To(Succeed())
It("should generate the correct url to call", func() {
generatedURL := buildURL(config)
Expect(generatedURL).To(Equal("https://mattermost.my-domain.com/hooks/thisshouldbeanapitoken"))
})
It("should generate the correct JSON body", func() {
json, err := CreateJSONPayload(config, "this is a message", nil)
Expect(err).NotTo(HaveOccurred())
Expect(string(json)).To(Equal("{\"text\":\"this is a message\"}"))
})
})
When("sending a message with pre set username and channel", func() {
mattermostURL, _ := url.Parse("mattermost://testUserName@mattermost.my-domain.com/thisshouldbeanapitoken/testChannel")
config := &Config{}
Expect(config.SetURL(mattermostURL)).To(Succeed())
It("should generate the correct JSON body", func() {
json, err := CreateJSONPayload(config, "this is a message", nil)
Expect(err).NotTo(HaveOccurred())
Expect(string(json)).To(Equal("{\"text\":\"this is a message\",\"username\":\"testUserName\",\"channel\":\"testChannel\"}"))
})
})
When("sending a message with pre set username and channel but overwriting them with parameters", func() {
mattermostURL, _ := url.Parse("mattermost://testUserName@mattermost.my-domain.com/thisshouldbeanapitoken/testChannel")
config := &Config{}
Expect(config.SetURL(mattermostURL)).To(Succeed())
It("should generate the correct JSON body", func() {
params := (*types.Params)(&map[string]string{"username": "overwriteUserName", "channel": "overwriteChannel"})
json, err := CreateJSONPayload(config, "this is a message", params)
Expect(err).NotTo(HaveOccurred())
Expect(string(json)).To(Equal("{\"text\":\"this is a message\",\"username\":\"overwriteUserName\",\"channel\":\"overwriteChannel\"}"))
})
})
})
When("parsing the configuration URL", func() {
It("should be identical after de-/serialization", func() {
input := "mattermost://bot@mattermost.host/token/channel"
config := &Config{}
Expect(config.SetURL(testutils.URLMust(input))).To(Succeed())
Expect(config.GetURL().String()).To(Equal(input))
})
})
Describe("sending the payload", func() {
var err error
BeforeEach(func() {
httpmock.Activate()
})
AfterEach(func() {
httpmock.DeactivateAndReset()
})
It("should not report an error if the server accepts the payload", func() {
config := Config{
Host: "mattermost.host",
Token: "token",
}
serviceURL := config.GetURL()
service := Service{}
err = service.Initialize(serviceURL, nil)
Expect(err).NotTo(HaveOccurred())
httpmock.RegisterResponder("POST", "https://mattermost.host/hooks/token", httpmock.NewStringResponder(200, ``))
err = service.Send("Message", nil)
Expect(err).NotTo(HaveOccurred())
})
})
})