| 1 |
package ifttt_test |
| 2 |
|
| 3 |
import ( |
| 4 |
"encoding/json" |
| 5 |
"errors" |
| 6 |
"fmt" |
| 7 |
"io" |
| 8 |
"log" |
| 9 |
"net/http" |
| 10 |
"os" |
| 11 |
"testing" |
| 12 |
|
| 13 |
"github.com/jarcoal/httpmock" |
| 14 |
"github.com/onsi/ginkgo/v2" |
| 15 |
"github.com/onsi/gomega" |
| 16 |
|
| 17 |
"github.com/nicholas-fedor/shoutrrr/internal/testutils" |
| 18 |
"github.com/nicholas-fedor/shoutrrr/pkg/services/push/ifttt" |
| 19 |
"github.com/nicholas-fedor/shoutrrr/pkg/types" |
| 20 |
) |
| 21 |
|
| 22 |
type jsonPayload struct { |
| 23 |
Value1 string `json:"value1"` |
| 24 |
Value2 string `json:"value2"` |
| 25 |
Value3 string `json:"value3"` |
| 26 |
} |
| 27 |
|
| 28 |
var ( |
| 29 |
service *ifttt.Service |
| 30 |
logger *log.Logger |
| 31 |
envTestURL string |
| 32 |
_ = ginkgo.BeforeSuite(func() { |
| 33 |
service = &ifttt.Service{} |
| 34 |
logger = testutils.TestLogger() |
| 35 |
envTestURL = os.Getenv("SHOUTRRR_IFTTT_URL") |
| 36 |
}) |
| 37 |
) |
| 38 |
|
| 39 |
var _ = ginkgo.Describe("the IFTTT service", func() { |
| 40 |
ginkgo.When("running integration tests", func() { |
| 41 |
ginkgo.It("sends a message successfully with a valid ENV URL", func() { |
| 42 |
if envTestURL == "" { |
| 43 |
ginkgo.Skip("No integration test ENV URL was set") |
| 44 |
|
| 45 |
return |
| 46 |
} |
| 47 |
|
| 48 |
serviceURL := testutils.URLMust(envTestURL) |
| 49 |
err := service.Initialize(serviceURL, logger) |
| 50 |
gomega.Expect(err).NotTo(gomega.HaveOccurred()) |
| 51 |
err = service.Send("This is an integration test", nil) |
| 52 |
gomega.Expect(err).NotTo(gomega.HaveOccurred()) |
| 53 |
}) |
| 54 |
}) |
| 55 |
|
| 56 |
ginkgo.Describe("the service", func() { |
| 57 |
ginkgo.BeforeEach(func() { |
| 58 |
service = &ifttt.Service{} |
| 59 |
service.SetLogger(logger) |
| 60 |
}) |
| 61 |
ginkgo.It("returns the correct service identifier", func() { |
| 62 |
gomega.Expect(service.GetID()).To(gomega.Equal("ifttt")) |
| 63 |
}) |
| 64 |
}) |
| 65 |
|
| 66 |
ginkgo.When("parsing the configuration URL", func() { |
| 67 |
ginkgo.BeforeEach(func() { |
| 68 |
service = &ifttt.Service{} |
| 69 |
service.SetLogger(logger) |
| 70 |
}) |
| 71 |
ginkgo.It("returns an error if no arguments are supplied", func() { |
| 72 |
serviceURL := testutils.URLMust("ifttt://") |
| 73 |
err := service.Initialize(serviceURL, logger) |
| 74 |
gomega.Expect(err).To(gomega.HaveOccurred()) |
| 75 |
}) |
| 76 |
ginkgo.It("returns an error if no webhook ID is given", func() { |
| 77 |
serviceURL := testutils.URLMust("ifttt:///?events=event1") |
| 78 |
err := service.Initialize(serviceURL, logger) |
| 79 |
gomega.Expect(err).To(gomega.HaveOccurred()) |
| 80 |
}) |
| 81 |
ginkgo.It("returns an error if no events are given", func() { |
| 82 |
serviceURL := testutils.URLMust("ifttt://dummyID") |
| 83 |
err := service.Initialize(serviceURL, logger) |
| 84 |
gomega.Expect(err).To(gomega.HaveOccurred()) |
| 85 |
}) |
| 86 |
ginkgo.It("returns an error when an invalid query key is given", func() { // Line 54 |
| 87 |
serviceURL := testutils.URLMust("ifttt://dummyID/?events=event1&badquery=foo") |
| 88 |
err := service.Initialize(serviceURL, logger) |
| 89 |
gomega.Expect(err).To(gomega.HaveOccurred()) |
| 90 |
}) |
| 91 |
ginkgo.It("returns an error if message value is above 3", func() { |
| 92 |
serviceURL := testutils.URLMust("ifttt://dummyID/?events=event1&messagevalue=8") |
| 93 |
err := service.Initialize(serviceURL, logger) |
| 94 |
gomega.Expect(err).To(gomega.HaveOccurred()) |
| 95 |
}) |
| 96 |
ginkgo.It("returns an error if message value is below 1", func() { // Line 60 |
| 97 |
serviceURL := testutils.URLMust("ifttt://dummyID/?events=event1&messagevalue=0") |
| 98 |
err := service.Initialize(serviceURL, logger) |
| 99 |
gomega.Expect(err).To(gomega.HaveOccurred()) |
| 100 |
}) |
| 101 |
ginkgo.It( |
| 102 |
"does not return an error if webhook ID and at least one event are given", |
| 103 |
func() { |
| 104 |
serviceURL := testutils.URLMust("ifttt://dummyID/?events=event1") |
| 105 |
err := service.Initialize(serviceURL, logger) |
| 106 |
gomega.Expect(err).NotTo(gomega.HaveOccurred()) |
| 107 |
}, |
| 108 |
) |
| 109 |
ginkgo.It("returns an error if titlevalue is invalid", func() { // Line 78 |
| 110 |
serviceURL := testutils.URLMust("ifttt://dummyID/?events=event1&titlevalue=4") |
| 111 |
err := service.Initialize(serviceURL, logger) |
| 112 |
gomega.Expect(err). |
| 113 |
To(gomega.MatchError("invalid value for titlevalue: only values 1-3 or 0 (for disabling) are supported")) |
| 114 |
}) |
| 115 |
ginkgo.It("returns an error if titlevalue equals messagevalue", func() { // Line 82 |
| 116 |
serviceURL := testutils.URLMust( |
| 117 |
"ifttt://dummyID/?events=event1&messagevalue=2&titlevalue=2", |
| 118 |
) |
| 119 |
err := service.Initialize(serviceURL, logger) |
| 120 |
gomega.Expect(err). |
| 121 |
To(gomega.MatchError("titlevalue cannot use the same number as messagevalue")) |
| 122 |
}) |
| 123 |
}) |
| 124 |
|
| 125 |
ginkgo.When("serializing a config to URL", func() { |
| 126 |
ginkgo.BeforeEach(func() { |
| 127 |
service = &ifttt.Service{} |
| 128 |
service.SetLogger(logger) |
| 129 |
}) |
| 130 |
ginkgo.When("given multiple events", func() { |
| 131 |
ginkgo.It("returns an URL with all events comma-separated", func() { |
| 132 |
serviceURL := testutils.URLMust("ifttt://dummyID/?events=foo%2Cbar%2Cbaz") |
| 133 |
err := service.Initialize(serviceURL, logger) |
| 134 |
gomega.Expect(err).NotTo(gomega.HaveOccurred()) |
| 135 |
|
| 136 |
resultURL := service.Config.GetURL().String() |
| 137 |
gomega.Expect(resultURL).To(gomega.Equal(serviceURL.String())) |
| 138 |
}) |
| 139 |
}) |
| 140 |
ginkgo.When("given values", func() { |
| 141 |
ginkgo.It("returns an URL with all values", func() { |
| 142 |
serviceURL := testutils.URLMust( |
| 143 |
"ifttt://dummyID/?events=event1&value1=v1&value2=v2&value3=v3", |
| 144 |
) |
| 145 |
err := service.Initialize(serviceURL, logger) |
| 146 |
gomega.Expect(err).NotTo(gomega.HaveOccurred()) |
| 147 |
|
| 148 |
resultURL := service.Config.GetURL().String() |
| 149 |
gomega.Expect(resultURL).To(gomega.Equal(serviceURL.String())) |
| 150 |
}) |
| 151 |
}) |
| 152 |
}) |
| 153 |
|
| 154 |
ginkgo.Describe("sending a message", func() { |
| 155 |
ginkgo.BeforeEach(func() { |
| 156 |
httpmock.Activate() |
| 157 |
|
| 158 |
service = &ifttt.Service{} |
| 159 |
service.SetLogger(logger) |
| 160 |
}) |
| 161 |
|
| 162 |
ginkgo.AfterEach(func() { |
| 163 |
httpmock.DeactivateAndReset() |
| 164 |
}) |
| 165 |
ginkgo.It("errors if the response code is not 200-299", func() { |
| 166 |
serviceURL := testutils.URLMust("ifttt://dummy/?events=foo") |
| 167 |
err := service.Initialize(serviceURL, logger) |
| 168 |
gomega.Expect(err).NotTo(gomega.HaveOccurred()) |
| 169 |
httpmock.RegisterResponder( |
| 170 |
"POST", |
| 171 |
"https://maker.ifttt.com/trigger/foo/with/key/dummy", |
| 172 |
httpmock.NewStringResponder(404, ""), |
| 173 |
) |
| 174 |
|
| 175 |
err = service.Send("hello", nil) |
| 176 |
gomega.Expect(err).To(gomega.HaveOccurred()) |
| 177 |
}) |
| 178 |
ginkgo.It("does not error if the response code is 200", func() { |
| 179 |
serviceURL := testutils.URLMust("ifttt://dummy/?events=foo") |
| 180 |
err := service.Initialize(serviceURL, logger) |
| 181 |
gomega.Expect(err).NotTo(gomega.HaveOccurred()) |
| 182 |
httpmock.RegisterResponder( |
| 183 |
"POST", |
| 184 |
"https://maker.ifttt.com/trigger/foo/with/key/dummy", |
| 185 |
httpmock.NewStringResponder(200, ""), |
| 186 |
) |
| 187 |
|
| 188 |
err = service.Send("hello", nil) |
| 189 |
gomega.Expect(err).NotTo(gomega.HaveOccurred()) |
| 190 |
}) |
| 191 |
ginkgo.It("returns an error if params update fails", func() { // Line 55 |
| 192 |
serviceURL := testutils.URLMust("ifttt://dummy/?events=event1") |
| 193 |
err := service.Initialize(serviceURL, logger) |
| 194 |
gomega.Expect(err).NotTo(gomega.HaveOccurred()) |
| 195 |
|
| 196 |
params := types.Params{"messagevalue": "invalid"} |
| 197 |
err = service.Send("hello", ¶ms) |
| 198 |
gomega.Expect(err).To(gomega.HaveOccurred()) |
| 199 |
}) |
| 200 |
ginkgo.DescribeTable("sets message to correct value field based on messagevalue", |
| 201 |
func(messageValue int, expectedField string) { // Lines 30, 32, 34 |
| 202 |
serviceURL := testutils.URLMust( |
| 203 |
fmt.Sprintf("ifttt://dummy/?events=event1&messagevalue=%d", messageValue), |
| 204 |
) |
| 205 |
err := service.Initialize(serviceURL, logger) |
| 206 |
gomega.Expect(err).NotTo(gomega.HaveOccurred()) |
| 207 |
httpmock.RegisterResponder( |
| 208 |
"POST", |
| 209 |
"https://maker.ifttt.com/trigger/event1/with/key/dummy", |
| 210 |
func(req *http.Request) (*http.Response, error) { |
| 211 |
body, err := io.ReadAll(req.Body) |
| 212 |
gomega.Expect(err).NotTo(gomega.HaveOccurred()) |
| 213 |
|
| 214 |
var payload jsonPayload |
| 215 |
|
| 216 |
err = json.Unmarshal(body, &payload) |
| 217 |
gomega.Expect(err).NotTo(gomega.HaveOccurred()) |
| 218 |
|
| 219 |
switch expectedField { |
| 220 |
case "Value1": |
| 221 |
gomega.Expect(payload.Value1).To(gomega.Equal("hello")) |
| 222 |
gomega.Expect(payload.Value2).To(gomega.Equal("")) |
| 223 |
gomega.Expect(payload.Value3).To(gomega.Equal("")) |
| 224 |
case "Value2": |
| 225 |
gomega.Expect(payload.Value1).To(gomega.Equal("")) |
| 226 |
gomega.Expect(payload.Value2).To(gomega.Equal("hello")) |
| 227 |
gomega.Expect(payload.Value3).To(gomega.Equal("")) |
| 228 |
case "Value3": |
| 229 |
gomega.Expect(payload.Value1).To(gomega.Equal("")) |
| 230 |
gomega.Expect(payload.Value2).To(gomega.Equal("")) |
| 231 |
gomega.Expect(payload.Value3).To(gomega.Equal("hello")) |
| 232 |
} |
| 233 |
|
| 234 |
return httpmock.NewStringResponse(200, ""), nil |
| 235 |
}, |
| 236 |
) |
| 237 |
|
| 238 |
err = service.Send("hello", nil) |
| 239 |
gomega.Expect(err).NotTo(gomega.HaveOccurred()) |
| 240 |
}, |
| 241 |
ginkgo.Entry("messagevalue=1 sets Value1", 1, "Value1"), |
| 242 |
ginkgo.Entry("messagevalue=2 sets Value2", 2, "Value2"), |
| 243 |
ginkgo.Entry("messagevalue=3 sets Value3", 3, "Value3"), |
| 244 |
) |
| 245 |
ginkgo.It("overrides Value2 with params when messagevalue is 1", func() { // Line 36 |
| 246 |
serviceURL := testutils.URLMust("ifttt://dummy/?events=event1&messagevalue=1") |
| 247 |
err := service.Initialize(serviceURL, logger) |
| 248 |
gomega.Expect(err).NotTo(gomega.HaveOccurred()) |
| 249 |
httpmock.RegisterResponder( |
| 250 |
"POST", |
| 251 |
"https://maker.ifttt.com/trigger/event1/with/key/dummy", |
| 252 |
func(req *http.Request) (*http.Response, error) { |
| 253 |
body, err := io.ReadAll(req.Body) |
| 254 |
gomega.Expect(err).NotTo(gomega.HaveOccurred()) |
| 255 |
|
| 256 |
var payload jsonPayload |
| 257 |
|
| 258 |
err = json.Unmarshal(body, &payload) |
| 259 |
gomega.Expect(err).NotTo(gomega.HaveOccurred()) |
| 260 |
gomega.Expect(payload.Value1).To(gomega.Equal("hello")) |
| 261 |
gomega.Expect(payload.Value2).To(gomega.Equal("y")) |
| 262 |
gomega.Expect(payload.Value3).To(gomega.Equal("")) |
| 263 |
|
| 264 |
return httpmock.NewStringResponse(200, ""), nil |
| 265 |
}, |
| 266 |
) |
| 267 |
|
| 268 |
params := types.Params{ |
| 269 |
"value2": "y", |
| 270 |
} |
| 271 |
err = service.Send("hello", ¶ms) |
| 272 |
gomega.Expect(err).NotTo(gomega.HaveOccurred()) |
| 273 |
}) |
| 274 |
ginkgo.It("overrides payload values with params", func() { // Lines 17, 21, 25 |
| 275 |
serviceURL := testutils.URLMust( |
| 276 |
"ifttt://dummy/?events=event1&value1=a&value2=b&value3=c&messagevalue=2", |
| 277 |
) |
| 278 |
err := service.Initialize(serviceURL, logger) |
| 279 |
gomega.Expect(err).NotTo(gomega.HaveOccurred()) |
| 280 |
httpmock.RegisterResponder( |
| 281 |
"POST", |
| 282 |
"https://maker.ifttt.com/trigger/event1/with/key/dummy", |
| 283 |
func(req *http.Request) (*http.Response, error) { |
| 284 |
body, err := io.ReadAll(req.Body) |
| 285 |
gomega.Expect(err).NotTo(gomega.HaveOccurred()) |
| 286 |
|
| 287 |
var payload jsonPayload |
| 288 |
|
| 289 |
err = json.Unmarshal(body, &payload) |
| 290 |
gomega.Expect(err).NotTo(gomega.HaveOccurred()) |
| 291 |
gomega.Expect(payload.Value1).To(gomega.Equal("x")) |
| 292 |
gomega.Expect(payload.Value2).To(gomega.Equal("hello")) |
| 293 |
gomega.Expect(payload.Value3).To(gomega.Equal("z")) |
| 294 |
|
| 295 |
return httpmock.NewStringResponse(200, ""), nil |
| 296 |
}, |
| 297 |
) |
| 298 |
|
| 299 |
params := types.Params{ |
| 300 |
"value1": "x", |
| 301 |
// "value2": "y", // Omitted to let message override |
| 302 |
"value3": "z", |
| 303 |
} |
| 304 |
err = service.Send("hello", ¶ms) |
| 305 |
gomega.Expect(err).NotTo(gomega.HaveOccurred()) |
| 306 |
}) |
| 307 |
ginkgo.It("should fail with multiple events when one errors", func() { |
| 308 |
serviceURL := testutils.URLMust("ifttt://dummy/?events=event1,event2") |
| 309 |
err := service.Initialize(serviceURL, logger) |
| 310 |
gomega.Expect(err).NotTo(gomega.HaveOccurred()) |
| 311 |
|
| 312 |
httpmock.RegisterResponder( |
| 313 |
"POST", |
| 314 |
"https://maker.ifttt.com/trigger/event1/with/key/dummy", |
| 315 |
httpmock.NewStringResponder(200, ""), |
| 316 |
) |
| 317 |
httpmock.RegisterResponder( |
| 318 |
"POST", |
| 319 |
"https://maker.ifttt.com/trigger/event2/with/key/dummy", |
| 320 |
httpmock.NewStringResponder(404, "Not Found"), |
| 321 |
) |
| 322 |
|
| 323 |
err = service.Send("Test message", nil) |
| 324 |
gomega.Expect(err).To(gomega.MatchError( |
| 325 |
`failed to send IFTTT event: event "event2": got unexpected response status code: 404 Not Found`, |
| 326 |
)) |
| 327 |
}) |
| 328 |
|
| 329 |
ginkgo.It("should fail with network error", func() { |
| 330 |
serviceURL := testutils.URLMust("ifttt://dummy/?events=event1") |
| 331 |
err := service.Initialize(serviceURL, logger) |
| 332 |
gomega.Expect(err).NotTo(gomega.HaveOccurred()) |
| 333 |
|
| 334 |
httpmock.RegisterResponder( |
| 335 |
"POST", |
| 336 |
"https://maker.ifttt.com/trigger/event1/with/key/dummy", |
| 337 |
httpmock.NewErrorResponder(errors.New("network failure")), |
| 338 |
) |
| 339 |
|
| 340 |
err = service.Send("Test message", nil) |
| 341 |
gomega.Expect(err).To(gomega.MatchError( |
| 342 |
`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`, |
| 343 |
)) |
| 344 |
}) |
| 345 |
}) |
| 346 |
}) |
| 347 |
|
| 348 |
// TestIFTTT runs the Ginkgo test suite for the IFTTT package. |
| 349 |
func TestIFTTT(t *testing.T) { |
| 350 |
t.Parallel() |
| 351 |
gomega.RegisterFailHandler(ginkgo.Fail) |
| 352 |
ginkgo.RunSpecs(t, "Shoutrrr IFTTT Suite") |
| 353 |
} |