File: ifttt_test.go

package info (click to toggle)
golang-github-nicholas-fedor-shoutrrr 0.8.17-1
  • links: PTS, VCS
  • area: main
  • in suites: forky
  • size: 4,332 kB
  • sloc: sh: 61; makefile: 5
file content (335 lines) | stat: -rw-r--r-- 12,202 bytes parent folder | download | duplicates (2)
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
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
package ifttt_test

import (
	"encoding/json"
	"errors"
	"fmt"
	"io"
	"log"
	"net/http"
	"os"
	"testing"

	"github.com/jarcoal/httpmock"
	"github.com/onsi/ginkgo/v2"
	"github.com/onsi/gomega"

	"github.com/nicholas-fedor/shoutrrr/internal/testutils"
	"github.com/nicholas-fedor/shoutrrr/pkg/services/ifttt"
	"github.com/nicholas-fedor/shoutrrr/pkg/types"
)

// TestIFTTT runs the Ginkgo test suite for the IFTTT package.
func TestIFTTT(t *testing.T) {
	gomega.RegisterFailHandler(ginkgo.Fail)
	ginkgo.RunSpecs(t, "Shoutrrr IFTTT Suite")
}

var (
	service    *ifttt.Service
	logger     *log.Logger
	envTestURL string
	_          = ginkgo.BeforeSuite(func() {
		service = &ifttt.Service{}
		logger = testutils.TestLogger()
		envTestURL = os.Getenv("SHOUTRRR_IFTTT_URL")
	})
)

var _ = ginkgo.Describe("the IFTTT service", func() {
	ginkgo.When("running integration tests", func() {
		ginkgo.It("sends a message successfully with a valid ENV URL", func() {
			if envTestURL == "" {
				ginkgo.Skip("No integration test ENV URL was set")

				return
			}
			serviceURL := testutils.URLMust(envTestURL)
			err := service.Initialize(serviceURL, logger)
			gomega.Expect(err).NotTo(gomega.HaveOccurred())
			err = service.Send("This is an integration test", nil)
			gomega.Expect(err).NotTo(gomega.HaveOccurred())
		})
	})

	ginkgo.Describe("the service", func() {
		ginkgo.BeforeEach(func() {
			service = &ifttt.Service{}
			service.SetLogger(logger)
		})
		ginkgo.It("returns the correct service identifier", func() {
			gomega.Expect(service.GetID()).To(gomega.Equal("ifttt"))
		})
	})

	ginkgo.When("parsing the configuration URL", func() {
		ginkgo.BeforeEach(func() {
			service = &ifttt.Service{}
			service.SetLogger(logger)
		})
		ginkgo.It("returns an error if no arguments are supplied", func() {
			serviceURL := testutils.URLMust("ifttt://")
			err := service.Initialize(serviceURL, logger)
			gomega.Expect(err).To(gomega.HaveOccurred())
		})
		ginkgo.It("returns an error if no webhook ID is given", func() {
			serviceURL := testutils.URLMust("ifttt:///?events=event1")
			err := service.Initialize(serviceURL, logger)
			gomega.Expect(err).To(gomega.HaveOccurred())
		})
		ginkgo.It("returns an error if no events are given", func() {
			serviceURL := testutils.URLMust("ifttt://dummyID")
			err := service.Initialize(serviceURL, logger)
			gomega.Expect(err).To(gomega.HaveOccurred())
		})
		ginkgo.It("returns an error when an invalid query key is given", func() { // Line 54
			serviceURL := testutils.URLMust("ifttt://dummyID/?events=event1&badquery=foo")
			err := service.Initialize(serviceURL, logger)
			gomega.Expect(err).To(gomega.HaveOccurred())
		})
		ginkgo.It("returns an error if message value is above 3", func() {
			serviceURL := testutils.URLMust("ifttt://dummyID/?events=event1&messagevalue=8")
			err := service.Initialize(serviceURL, logger)
			gomega.Expect(err).To(gomega.HaveOccurred())
		})
		ginkgo.It("returns an error if message value is below 1", func() { // Line 60
			serviceURL := testutils.URLMust("ifttt://dummyID/?events=event1&messagevalue=0")
			err := service.Initialize(serviceURL, logger)
			gomega.Expect(err).To(gomega.HaveOccurred())
		})
		ginkgo.It(
			"does not return an error if webhook ID and at least one event are given",
			func() {
				serviceURL := testutils.URLMust("ifttt://dummyID/?events=event1")
				err := service.Initialize(serviceURL, logger)
				gomega.Expect(err).NotTo(gomega.HaveOccurred())
			},
		)
		ginkgo.It("returns an error if titlevalue is invalid", func() { // Line 78
			serviceURL := testutils.URLMust("ifttt://dummyID/?events=event1&titlevalue=4")
			err := service.Initialize(serviceURL, logger)
			gomega.Expect(err).
				To(gomega.MatchError("invalid value for titlevalue: only values 1-3 or 0 (for disabling) are supported"))
		})
		ginkgo.It("returns an error if titlevalue equals messagevalue", func() { // Line 82
			serviceURL := testutils.URLMust(
				"ifttt://dummyID/?events=event1&messagevalue=2&titlevalue=2",
			)
			err := service.Initialize(serviceURL, logger)
			gomega.Expect(err).
				To(gomega.MatchError("titlevalue cannot use the same number as messagevalue"))
		})
	})

	ginkgo.When("serializing a config to URL", func() {
		ginkgo.BeforeEach(func() {
			service = &ifttt.Service{}
			service.SetLogger(logger)
		})
		ginkgo.When("given multiple events", func() {
			ginkgo.It("returns an URL with all events comma-separated", func() {
				configURL := testutils.URLMust("ifttt://dummyID/?events=foo%2Cbar%2Cbaz")
				err := service.Initialize(configURL, logger)
				gomega.Expect(err).NotTo(gomega.HaveOccurred())
				resultURL := service.Config.GetURL().String()
				gomega.Expect(resultURL).To(gomega.Equal(configURL.String()))
			})
		})
		ginkgo.When("given values", func() {
			ginkgo.It("returns an URL with all values", func() {
				configURL := testutils.URLMust(
					"ifttt://dummyID/?events=event1&value1=v1&value2=v2&value3=v3",
				)
				err := service.Initialize(configURL, logger)
				gomega.Expect(err).NotTo(gomega.HaveOccurred())
				resultURL := service.Config.GetURL().String()
				gomega.Expect(resultURL).To(gomega.Equal(configURL.String()))
			})
		})
	})

	ginkgo.Describe("sending a message", func() {
		ginkgo.BeforeEach(func() {
			httpmock.Activate()
			service = &ifttt.Service{}
			service.SetLogger(logger)
		})

		ginkgo.AfterEach(func() {
			httpmock.DeactivateAndReset()
		})
		ginkgo.It("errors if the response code is not 200-299", func() {
			configURL := testutils.URLMust("ifttt://dummy/?events=foo")
			err := service.Initialize(configURL, logger)
			gomega.Expect(err).NotTo(gomega.HaveOccurred())
			httpmock.RegisterResponder(
				"POST",
				"https://maker.ifttt.com/trigger/foo/with/key/dummy",
				httpmock.NewStringResponder(404, ""),
			)
			err = service.Send("hello", nil)
			gomega.Expect(err).To(gomega.HaveOccurred())
		})
		ginkgo.It("does not error if the response code is 200", func() {
			configURL := testutils.URLMust("ifttt://dummy/?events=foo")
			err := service.Initialize(configURL, logger)
			gomega.Expect(err).NotTo(gomega.HaveOccurred())
			httpmock.RegisterResponder(
				"POST",
				"https://maker.ifttt.com/trigger/foo/with/key/dummy",
				httpmock.NewStringResponder(200, ""),
			)
			err = service.Send("hello", nil)
			gomega.Expect(err).NotTo(gomega.HaveOccurred())
		})
		ginkgo.It("returns an error if params update fails", func() { // Line 55
			configURL := testutils.URLMust("ifttt://dummy/?events=event1")
			err := service.Initialize(configURL, logger)
			gomega.Expect(err).NotTo(gomega.HaveOccurred())
			params := types.Params{"messagevalue": "invalid"}
			err = service.Send("hello", &params)
			gomega.Expect(err).To(gomega.HaveOccurred())
		})
		ginkgo.DescribeTable("sets message to correct value field based on messagevalue",
			func(messageValue int, expectedField string) { // Lines 30, 32, 34
				configURL := testutils.URLMust(
					fmt.Sprintf("ifttt://dummy/?events=event1&messagevalue=%d", messageValue),
				)
				err := service.Initialize(configURL, logger)
				gomega.Expect(err).NotTo(gomega.HaveOccurred())
				httpmock.RegisterResponder(
					"POST",
					"https://maker.ifttt.com/trigger/event1/with/key/dummy",
					func(req *http.Request) (*http.Response, error) {
						body, err := io.ReadAll(req.Body)
						gomega.Expect(err).NotTo(gomega.HaveOccurred())
						var payload jsonPayload
						err = json.Unmarshal(body, &payload)
						gomega.Expect(err).NotTo(gomega.HaveOccurred())
						switch expectedField {
						case "Value1":
							gomega.Expect(payload.Value1).To(gomega.Equal("hello"))
							gomega.Expect(payload.Value2).To(gomega.Equal(""))
							gomega.Expect(payload.Value3).To(gomega.Equal(""))
						case "Value2":
							gomega.Expect(payload.Value1).To(gomega.Equal(""))
							gomega.Expect(payload.Value2).To(gomega.Equal("hello"))
							gomega.Expect(payload.Value3).To(gomega.Equal(""))
						case "Value3":
							gomega.Expect(payload.Value1).To(gomega.Equal(""))
							gomega.Expect(payload.Value2).To(gomega.Equal(""))
							gomega.Expect(payload.Value3).To(gomega.Equal("hello"))
						}

						return httpmock.NewStringResponse(200, ""), nil
					},
				)
				err = service.Send("hello", nil)
				gomega.Expect(err).NotTo(gomega.HaveOccurred())
			},
			ginkgo.Entry("messagevalue=1 sets Value1", 1, "Value1"),
			ginkgo.Entry("messagevalue=2 sets Value2", 2, "Value2"),
			ginkgo.Entry("messagevalue=3 sets Value3", 3, "Value3"),
		)
		ginkgo.It("overrides Value2 with params when messagevalue is 1", func() { // Line 36
			configURL := testutils.URLMust("ifttt://dummy/?events=event1&messagevalue=1")
			err := service.Initialize(configURL, logger)
			gomega.Expect(err).NotTo(gomega.HaveOccurred())
			httpmock.RegisterResponder(
				"POST",
				"https://maker.ifttt.com/trigger/event1/with/key/dummy",
				func(req *http.Request) (*http.Response, error) {
					body, err := io.ReadAll(req.Body)
					gomega.Expect(err).NotTo(gomega.HaveOccurred())
					var payload jsonPayload
					err = json.Unmarshal(body, &payload)
					gomega.Expect(err).NotTo(gomega.HaveOccurred())
					gomega.Expect(payload.Value1).To(gomega.Equal("hello"))
					gomega.Expect(payload.Value2).To(gomega.Equal("y"))
					gomega.Expect(payload.Value3).To(gomega.Equal(""))

					return httpmock.NewStringResponse(200, ""), nil
				},
			)
			params := types.Params{
				"value2": "y",
			}
			err = service.Send("hello", &params)
			gomega.Expect(err).NotTo(gomega.HaveOccurred())
		})
		ginkgo.It("overrides payload values with params", func() { // Lines 17, 21, 25
			configURL := testutils.URLMust(
				"ifttt://dummy/?events=event1&value1=a&value2=b&value3=c&messagevalue=2",
			)
			err := service.Initialize(configURL, logger)
			gomega.Expect(err).NotTo(gomega.HaveOccurred())
			httpmock.RegisterResponder(
				"POST",
				"https://maker.ifttt.com/trigger/event1/with/key/dummy",
				func(req *http.Request) (*http.Response, error) {
					body, err := io.ReadAll(req.Body)
					gomega.Expect(err).NotTo(gomega.HaveOccurred())
					var payload jsonPayload
					err = json.Unmarshal(body, &payload)
					gomega.Expect(err).NotTo(gomega.HaveOccurred())
					gomega.Expect(payload.Value1).To(gomega.Equal("x"))
					gomega.Expect(payload.Value2).To(gomega.Equal("hello"))
					gomega.Expect(payload.Value3).To(gomega.Equal("z"))

					return httpmock.NewStringResponse(200, ""), nil
				},
			)
			params := types.Params{
				"value1": "x",
				// "value2": "y", // Omitted to let message override
				"value3": "z",
			}
			err = service.Send("hello", &params)
			gomega.Expect(err).NotTo(gomega.HaveOccurred())
		})
		ginkgo.It("should fail with multiple events when one errors", func() {
			configURL := testutils.URLMust("ifttt://dummy/?events=event1,event2")
			err := service.Initialize(configURL, logger)
			gomega.Expect(err).NotTo(gomega.HaveOccurred())

			httpmock.RegisterResponder(
				"POST",
				"https://maker.ifttt.com/trigger/event1/with/key/dummy",
				httpmock.NewStringResponder(200, ""),
			)
			httpmock.RegisterResponder(
				"POST",
				"https://maker.ifttt.com/trigger/event2/with/key/dummy",
				httpmock.NewStringResponder(404, "Not Found"),
			)

			err = service.Send("Test message", nil)
			gomega.Expect(err).To(gomega.MatchError(
				`failed to send IFTTT event: event "event2": got unexpected response status code: 404 Not Found`,
			))
		})

		ginkgo.It("should fail with network error", func() {
			configURL := testutils.URLMust("ifttt://dummy/?events=event1")
			err := service.Initialize(configURL, logger)
			gomega.Expect(err).NotTo(gomega.HaveOccurred())

			httpmock.RegisterResponder(
				"POST",
				"https://maker.ifttt.com/trigger/event1/with/key/dummy",
				httpmock.NewErrorResponder(errors.New("network failure")),
			)

			err = service.Send("Test message", nil)
			gomega.Expect(err).To(gomega.MatchError(
				`failed to send IFTTT event: event "event1": sending HTTP request to IFTTT webhook: Post "https://maker.ifttt.com/trigger/event1/with/key/dummy": network failure`,
			))
		})
	})
})

type jsonPayload struct {
	Value1 string `json:"value1"`
	Value2 string `json:"value2"`
	Value3 string `json:"value3"`
}