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 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359
|
package generic_test
import (
"errors"
"io"
"log"
"net/http"
"net/url"
"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/generic"
"github.com/nicholas-fedor/shoutrrr/pkg/types"
)
// Test constants.
const (
TestWebhookURL = "https://host.tld/webhook" // Default test webhook URL
)
// TestGeneric runs the Ginkgo test suite for the generic package.
func TestGeneric(t *testing.T) {
gomega.RegisterFailHandler(ginkgo.Fail)
ginkgo.RunSpecs(t, "Shoutrrr Generic Webhook Suite")
}
var (
service *generic.Service
logger *log.Logger
envGenericURL *url.URL
_ = ginkgo.BeforeSuite(func() {
service = &generic.Service{}
logger = log.New(ginkgo.GinkgoWriter, "Test", log.LstdFlags)
var err error
envGenericURL, err = url.Parse(os.Getenv("SHOUTRRR_GENERIC_URL"))
if err != nil {
envGenericURL = &url.URL{} // Default to empty URL if parsing fails
}
})
)
var _ = ginkgo.Describe("the generic service", func() {
ginkgo.When("running integration tests", func() {
ginkgo.It("sends a message successfully with a valid ENV URL", func() {
if envGenericURL.String() == "" {
ginkgo.Skip("No integration test ENV URL was set")
return
}
serviceURL := testutils.URLMust(envGenericURL.String())
err := service.Initialize(serviceURL, testutils.TestLogger())
gomega.Expect(err).NotTo(gomega.HaveOccurred())
err = service.Send("This is an integration test message", nil)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
})
})
ginkgo.Describe("the service", func() {
ginkgo.BeforeEach(func() {
service = &generic.Service{}
service.SetLogger(logger)
})
ginkgo.It("returns the correct service identifier", func() {
gomega.Expect(service.GetID()).To(gomega.Equal("generic"))
})
})
ginkgo.When("parsing a custom URL", func() {
ginkgo.BeforeEach(func() {
service = &generic.Service{}
service.SetLogger(logger)
})
ginkgo.It("correctly sets webhook URL from custom URL", func() {
customURL := testutils.URLMust("generic+https://test.tld")
serviceURL, err := service.GetConfigURLFromCustom(customURL)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
err = service.Initialize(serviceURL, logger)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
gomega.Expect(service.Config.WebhookURL().String()).To(gomega.Equal("https://test.tld"))
})
ginkgo.When("a HTTP URL is provided via query parameter", func() {
ginkgo.It("disables TLS", func() {
config := &generic.Config{}
err := config.SetURL(testutils.URLMust("generic://example.com?disabletls=yes"))
gomega.Expect(err).NotTo(gomega.HaveOccurred())
gomega.Expect(config.DisableTLS).To(gomega.BeTrue())
})
})
ginkgo.When("a HTTPS URL is provided", func() {
ginkgo.It("enables TLS", func() {
config := &generic.Config{}
err := config.SetURL(testutils.URLMust("generic://example.com"))
gomega.Expect(err).NotTo(gomega.HaveOccurred())
gomega.Expect(config.DisableTLS).To(gomega.BeFalse())
})
})
ginkgo.It("escapes conflicting custom query keys", func() {
serviceURL := testutils.URLMust("generic://example.com/?__template=passed")
err := service.Initialize(serviceURL, logger)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
gomega.Expect(service.Config.Template).NotTo(gomega.Equal("passed"))
whURL := service.Config.WebhookURL().String()
gomega.Expect(whURL).To(gomega.Equal("https://example.com/?template=passed"))
gomega.Expect(service.Config.GetURL().String()).To(gomega.Equal(serviceURL.String()))
})
ginkgo.It("handles both escaped and service prop versions of keys", func() {
serviceURL := testutils.URLMust(
"generic://example.com/?__template=passed&template=captured",
)
err := service.Initialize(serviceURL, logger)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
gomega.Expect(service.Config.Template).To(gomega.Equal("captured"))
whURL := service.Config.WebhookURL().String()
gomega.Expect(whURL).To(gomega.Equal("https://example.com/?template=passed"))
})
})
ginkgo.When("retrieving the webhook URL", func() {
ginkgo.BeforeEach(func() {
service = &generic.Service{}
service.SetLogger(logger)
})
ginkgo.It("builds a valid webhook URL", func() {
serviceURL := testutils.URLMust("generic://example.com/path?foo=bar")
err := service.Initialize(serviceURL, logger)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
gomega.Expect(service.Config.WebhookURL().String()).
To(gomega.Equal("https://example.com/path?foo=bar"))
})
ginkgo.When("TLS is disabled", func() {
ginkgo.It("uses http scheme", func() {
serviceURL := testutils.URLMust("generic://test.tld?disabletls=yes")
err := service.Initialize(serviceURL, logger)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
gomega.Expect(service.Config.WebhookURL().Scheme).To(gomega.Equal("http"))
})
})
ginkgo.When("TLS is not disabled", func() {
ginkgo.It("uses https scheme", func() {
serviceURL := testutils.URLMust("generic://test.tld")
err := service.Initialize(serviceURL, logger)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
gomega.Expect(service.Config.WebhookURL().Scheme).To(gomega.Equal("https"))
})
})
})
ginkgo.Describe("the generic config", func() {
ginkgo.When("parsing the configuration URL", func() {
ginkgo.It("is identical after de-/serialization", func() {
testURL := "generic://user:pass@host.tld/api/v1/webhook?$context=inside-joke&@Authorization=frend&__title=w&contenttype=a%2Fb&template=f&title=t"
expectedURL := "generic://user:pass@host.tld/api/v1/webhook?%24context=inside-joke&%40Authorization=frend&__title=w&contenttype=a%2Fb&template=f&title=t"
serviceURL := testutils.URLMust(testURL)
err := service.Initialize(serviceURL, logger)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
gomega.Expect(service.Config.GetURL().String()).To(gomega.Equal(expectedURL))
})
})
})
ginkgo.Describe("building the payload", func() {
ginkgo.BeforeEach(func() {
service = &generic.Service{}
service.SetLogger(logger)
})
ginkgo.When("no template is specified", func() {
ginkgo.It("uses the message as payload", func() {
serviceURL := testutils.URLMust("generic://host.tld/webhook")
err := service.Initialize(serviceURL, logger)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
payload, err := service.GetPayload(
service.Config,
types.Params{"message": "test message"},
)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
contents, err := io.ReadAll(payload)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
gomega.Expect(string(contents)).To(gomega.Equal("test message"))
})
})
ginkgo.When("template is specified as `JSON`", func() {
ginkgo.It("creates a JSON object as the payload", func() {
serviceURL := testutils.URLMust("generic://host.tld/webhook?template=JSON")
err := service.Initialize(serviceURL, logger)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
params := types.Params{"title": "test title", "message": "test message"}
payload, err := service.GetPayload(service.Config, params)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
contents, err := io.ReadAll(payload)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
gomega.Expect(string(contents)).To(gomega.MatchJSON(`{
"title": "test title",
"message": "test message"
}`))
})
ginkgo.When("alternate keys are specified", func() {
ginkgo.It("creates a JSON object using the specified keys", func() {
serviceURL := testutils.URLMust(
"generic://host.tld/webhook?template=JSON&messagekey=body&titlekey=header",
)
err := service.Initialize(serviceURL, logger)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
params := types.Params{"header": "test title", "body": "test message"}
payload, err := service.GetPayload(service.Config, params)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
contents, err := io.ReadAll(payload)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
gomega.Expect(string(contents)).To(gomega.MatchJSON(`{
"header": "test title",
"body": "test message"
}`))
})
})
})
ginkgo.When("a valid template is specified", func() {
ginkgo.It("applies the template to the message payload", func() {
serviceURL := testutils.URLMust("generic://host.tld/webhook?template=news")
err := service.Initialize(serviceURL, logger)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
err = service.SetTemplateString("news", `{{.title}} ==> {{.message}}`)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
params := types.Params{"title": "BREAKING NEWS", "message": "it's today!"}
payload, err := service.GetPayload(service.Config, params)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
contents, err := io.ReadAll(payload)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
gomega.Expect(string(contents)).To(gomega.Equal("BREAKING NEWS ==> it's today!"))
})
ginkgo.When("given nil params", func() {
ginkgo.It("applies template with message data", func() {
serviceURL := testutils.URLMust("generic://host.tld/webhook?template=arrows")
err := service.Initialize(serviceURL, logger)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
err = service.SetTemplateString("arrows", `==> {{.message}} <==`)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
payload, err := service.GetPayload(
service.Config,
types.Params{"message": "LOOK AT ME"},
)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
contents, err := io.ReadAll(payload)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
gomega.Expect(string(contents)).To(gomega.Equal("==> LOOK AT ME <=="))
})
})
})
ginkgo.When("an unknown template is specified", func() {
ginkgo.It("returns an error", func() {
serviceURL := testutils.URLMust("generic://host.tld/webhook?template=missing")
err := service.Initialize(serviceURL, logger)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
_, err = service.GetPayload(service.Config, nil)
gomega.Expect(err).To(gomega.HaveOccurred())
})
})
})
ginkgo.Describe("sending the payload", func() {
ginkgo.BeforeEach(func() {
httpmock.Activate()
service = &generic.Service{}
service.SetLogger(logger)
})
ginkgo.AfterEach(func() {
httpmock.DeactivateAndReset()
})
ginkgo.When("sending via webhook URL", func() {
ginkgo.It("succeeds if the server accepts the payload", func() {
serviceURL := testutils.URLMust("generic://host.tld/webhook")
err := service.Initialize(serviceURL, logger)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
httpmock.RegisterResponder(
"POST",
TestWebhookURL,
httpmock.NewStringResponder(200, ""),
)
err = service.Send("Message", nil)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
})
ginkgo.It("reports an error if sending fails", func() {
serviceURL := testutils.URLMust("generic://host.tld/webhook")
err := service.Initialize(serviceURL, logger)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
httpmock.RegisterResponder(
"POST",
TestWebhookURL,
httpmock.NewErrorResponder(errors.New("dummy error")),
)
err = service.Send("Message", nil)
gomega.Expect(err).To(gomega.HaveOccurred())
})
ginkgo.It("includes custom headers in the request", func() {
serviceURL := testutils.URLMust("generic://host.tld/webhook?@authorization=frend")
err := service.Initialize(serviceURL, logger)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
httpmock.RegisterResponder("POST", TestWebhookURL,
func(req *http.Request) (*http.Response, error) {
gomega.Expect(req.Header.Get("Authorization")).To(gomega.Equal("frend"))
return httpmock.NewStringResponse(200, ""), nil
})
err = service.Send("Message", nil)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
})
ginkgo.It("includes extra data in JSON payload", func() {
serviceURL := testutils.URLMust(
"generic://host.tld/webhook?template=json&$context=inside+joke",
)
err := service.Initialize(serviceURL, logger)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
httpmock.RegisterResponder("POST", TestWebhookURL,
func(req *http.Request) (*http.Response, error) {
body, err := io.ReadAll(req.Body)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
gomega.Expect(string(body)).
To(gomega.MatchJSON(`{"message":"Message","context":"inside joke"}`))
return httpmock.NewStringResponse(200, ""), nil
})
err = service.Send("Message", nil)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
})
ginkgo.It("uses the configured HTTP method", func() {
serviceURL := testutils.URLMust("generic://host.tld/webhook?method=GET")
err := service.Initialize(serviceURL, logger)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
httpmock.RegisterResponder(
"GET",
TestWebhookURL,
httpmock.NewStringResponder(200, ""),
)
err = service.Send("Message", nil)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
})
ginkgo.It("does not mutate the given params", func() {
serviceURL := testutils.URLMust("generic://host.tld/webhook?method=GET")
err := service.Initialize(serviceURL, logger)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
httpmock.RegisterResponder(
"GET",
TestWebhookURL,
httpmock.NewStringResponder(200, ""),
)
params := types.Params{"title": "TITLE"}
err = service.Send("Message", ¶ms)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
gomega.Expect(params).To(gomega.Equal(types.Params{"title": "TITLE"}))
})
})
})
})
|