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
|
package slack_test
import (
"errors"
"fmt"
"log"
"net/url"
"os"
"strings"
"testing"
"github.com/jarcoal/httpmock"
"github.com/onsi/ginkgo/v2"
"github.com/onsi/gomega"
"github.com/onsi/gomega/format"
"github.com/nicholas-fedor/shoutrrr/internal/testutils"
"github.com/nicholas-fedor/shoutrrr/pkg/services/chat/slack"
)
const (
TestWebhookURL = "https://hooks.slack.com/services/AAAAAAAAA/BBBBBBBBB/123456789123456789123456"
)
func TestSlack(t *testing.T) {
format.CharactersAroundMismatchToInclude = 20
gomega.RegisterFailHandler(ginkgo.Fail)
ginkgo.RunSpecs(t, "Shoutrrr Slack Suite")
}
var (
service *slack.Service
envSlackURL *url.URL
logger *log.Logger
_ = ginkgo.BeforeSuite(func() {
service = &slack.Service{}
logger = log.New(ginkgo.GinkgoWriter, "Test", log.LstdFlags)
envSlackURL, _ = url.Parse(os.Getenv("SHOUTRRR_SLACK_URL"))
})
)
var _ = ginkgo.Describe("the slack service", func() {
ginkgo.When("running integration tests", func() {
ginkgo.It("should not error out", func() {
if envSlackURL.String() == "" {
return
}
serviceURL, _ := url.Parse(envSlackURL.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.It("returns the correct service identifier", func() {
gomega.Expect(service.GetID()).To(gomega.Equal("slack"))
})
})
// xoxb:123456789012-1234567890123-4mt0t4l1YL3g1T5L4cK70k3N
ginkgo.When("given a token with a malformed part", func() {
ginkgo.It("should return an error if part A is not 9 letters", func() {
expectErrorMessageGivenURL(
slack.ErrInvalidToken,
"slack://lol@12345678/123456789/123456789123456789123456",
)
})
ginkgo.It("should return an error if part B is not 9 letters", func() {
expectErrorMessageGivenURL(
slack.ErrInvalidToken,
"slack://lol@123456789/12345678/123456789123456789123456",
)
})
ginkgo.It("should return an error if part C is not 24 letters", func() {
expectErrorMessageGivenURL(
slack.ErrInvalidToken,
"slack://123456789/123456789/12345678912345678912345",
)
})
})
ginkgo.When("given a token missing a part", func() {
ginkgo.It("should return an error if the missing part is A", func() {
expectErrorMessageGivenURL(
slack.ErrInvalidToken,
"slack://lol@/123456789/123456789123456789123456",
)
})
ginkgo.It("should return an error if the missing part is B", func() {
expectErrorMessageGivenURL(slack.ErrInvalidToken, "slack://lol@123456789//123456789")
})
ginkgo.It("should return an error if the missing part is C", func() {
expectErrorMessageGivenURL(slack.ErrInvalidToken, "slack://lol@123456789/123456789/")
})
})
ginkgo.Describe("the slack config", func() {
ginkgo.When("parsing the configuration URL", func() {
ginkgo.When("given a config using the legacy format", func() {
ginkgo.It("should be converted to the new format after de-/serialization", func() {
oldURL := "slack://testbot@AAAAAAAAA/BBBBBBBBB/123456789123456789123456?color=3f00fe&title=Test+title"
newURL := "slack://hook:AAAAAAAAA-BBBBBBBBB-123456789123456789123456@webhook?botname=testbot&color=3f00fe&title=Test+title"
config := &slack.Config{}
err := config.SetURL(testutils.URLMust(oldURL))
gomega.Expect(err).NotTo(gomega.HaveOccurred(), "verifying")
gomega.Expect(config.GetURL().String()).To(gomega.Equal(newURL))
})
})
})
ginkgo.When("the URL contains an invalid property", func() {
testURL := testutils.URLMust(
"slack://hook:AAAAAAAAA-BBBBBBBBB-123456789123456789123456@webhook?bass=dirty",
)
err := (&slack.Config{}).SetURL(testURL)
gomega.Expect(err).To(gomega.HaveOccurred())
})
ginkgo.It("should be identical after de-/serialization", func() {
testURL := "slack://hook:AAAAAAAAA-BBBBBBBBB-123456789123456789123456@webhook?botname=testbot&color=3f00fe&title=Test+title"
config := &slack.Config{}
err := config.SetURL(testutils.URLMust(testURL))
gomega.Expect(err).NotTo(gomega.HaveOccurred(), "verifying")
outputURL := config.GetURL()
gomega.Expect(outputURL.String()).To(gomega.Equal(testURL))
})
ginkgo.When("generating a config object", func() {
ginkgo.It(
"should use the default botname if the argument list contains three strings",
func() {
slackURL, _ := url.Parse("slack://AAAAAAAAA/BBBBBBBBB/123456789123456789123456")
config, configError := slack.CreateConfigFromURL(slackURL)
gomega.Expect(configError).NotTo(gomega.HaveOccurred())
gomega.Expect(config.BotName).To(gomega.BeEmpty())
},
)
ginkgo.It("should set the botname if the argument list is three", func() {
slackURL, _ := url.Parse(
"slack://testbot@AAAAAAAAA/BBBBBBBBB/123456789123456789123456",
)
config, configError := slack.CreateConfigFromURL(slackURL)
gomega.Expect(configError).NotTo(gomega.HaveOccurred())
gomega.Expect(config.BotName).To(gomega.Equal("testbot"))
})
ginkgo.It("should return an error if the argument list is shorter than three", func() {
slackURL, _ := url.Parse("slack://AAAAAAAA")
_, configError := slack.CreateConfigFromURL(slackURL)
gomega.Expect(configError).To(gomega.HaveOccurred())
})
})
ginkgo.When("getting credentials from token", func() {
ginkgo.It("should return a valid webhook URL for the given token", func() {
token := tokenMust("AAAAAAAAA/BBBBBBBBB/123456789123456789123456")
gomega.Expect(token.WebhookURL()).To(gomega.Equal(TestWebhookURL))
})
ginkgo.It(
"should return a valid authorization header value for the given token",
func() {
token := tokenMust("xoxb:AAAAAAAAA-BBBBBBBBB-123456789123456789123456")
expected := "Bearer xoxb-AAAAAAAAA-BBBBBBBBB-123456789123456789123456"
gomega.Expect(token.Authorization()).To(gomega.Equal(expected))
},
)
})
})
ginkgo.Describe("creating the payload", func() {
ginkgo.Describe("the icon fields", func() {
payload := slack.MessagePayload{}
ginkgo.It("should set IconURL when the configured icon looks like an URL", func() {
payload.SetIcon("https://example.com/logo.png")
gomega.Expect(payload.IconURL).To(gomega.Equal("https://example.com/logo.png"))
gomega.Expect(payload.IconEmoji).To(gomega.BeEmpty())
})
ginkgo.It(
"should set IconEmoji when the configured icon does not look like an URL",
func() {
payload.SetIcon("tanabata_tree")
gomega.Expect(payload.IconEmoji).To(gomega.Equal("tanabata_tree"))
gomega.Expect(payload.IconURL).To(gomega.BeEmpty())
},
)
ginkgo.It("should clear both fields when icon is empty", func() {
payload.SetIcon("")
gomega.Expect(payload.IconEmoji).To(gomega.BeEmpty())
gomega.Expect(payload.IconURL).To(gomega.BeEmpty())
})
})
ginkgo.When("when more than 99 lines are being sent", func() {
ginkgo.It("should append the exceeding lines to the last attachment", func() {
config := slack.Config{}
sb := strings.Builder{}
for i := 1; i <= 110; i++ {
sb.WriteString(fmt.Sprintf("Line %d\n", i))
}
payload := slack.CreateJSONPayload(&config, sb.String()).(slack.MessagePayload)
atts := payload.Attachments
fmt.Fprint(
ginkgo.GinkgoWriter,
"\nLines: ",
len(atts),
" Last: ",
atts[len(atts)-1],
"\n",
)
gomega.Expect(atts).To(gomega.HaveLen(100))
gomega.Expect(atts[len(atts)-1].Text).To(gomega.ContainSubstring("Line 110"))
})
})
ginkgo.When("when the last message line ends with a newline", func() {
ginkgo.It("should not send an empty attachment", func() {
payload := slack.CreateJSONPayload(&slack.Config{}, "One\nTwo\nThree\n").(slack.MessagePayload)
atts := payload.Attachments
gomega.Expect(atts[len(atts)-1].Text).NotTo(gomega.BeEmpty())
})
})
})
ginkgo.Describe("sending the payload", func() {
ginkgo.When("sending via webhook URL", func() {
var err error
ginkgo.BeforeEach(func() {
httpmock.Activate()
})
ginkgo.AfterEach(func() {
httpmock.DeactivateAndReset()
})
ginkgo.It("should not report an error if the server accepts the payload", func() {
serviceURL, _ := url.Parse(
"slack://testbot@AAAAAAAAA/BBBBBBBBB/123456789123456789123456",
)
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("should not panic if an error occurs when sending the payload", func() {
serviceURL, _ := url.Parse(
"slack://testbot@AAAAAAAAA/BBBBBBBBB/123456789123456789123456",
)
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.When("sending via bot API", func() {
var err error
ginkgo.BeforeEach(func() {
httpmock.Activate()
})
ginkgo.AfterEach(func() {
httpmock.DeactivateAndReset()
})
ginkgo.It("should not report an error if the server accepts the payload", func() {
serviceURL := testutils.URLMust(
"slack://xoxb:123456789012-1234567890123-4mt0t4l1YL3g1T5L4cK70k3N@C0123456789",
)
err = service.Initialize(serviceURL, logger)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
targetURL := "https://slack.com/api/chat.postMessage"
httpmock.RegisterResponder(
"POST",
targetURL,
testutils.JSONRespondMust(200, slack.APIResponse{
Ok: true,
}),
)
err = service.Send("Message", nil)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
})
ginkgo.It("should not panic if an error occurs when sending the payload", func() {
serviceURL := testutils.URLMust(
"slack://xoxb:123456789012-1234567890123-4mt0t4l1YL3g1T5L4cK70k3N@C0123456789",
)
err = service.Initialize(serviceURL, logger)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
targetURL := "https://slack.com/api/chat.postMessage"
httpmock.RegisterResponder(
"POST",
targetURL,
testutils.JSONRespondMust(200, slack.APIResponse{
Error: "someone turned off the internet",
}),
)
err = service.Send("Message", nil)
gomega.Expect(err).To(gomega.HaveOccurred())
})
})
})
})
func tokenMust(rawToken string) *slack.Token {
token, err := slack.ParseToken(rawToken)
gomega.ExpectWithOffset(1, err).NotTo(gomega.HaveOccurred())
return token
}
func expectErrorMessageGivenURL(expected error, rawURL string) {
err := service.Initialize(testutils.URLMust(rawURL), testutils.TestLogger())
gomega.ExpectWithOffset(1, err).To(gomega.HaveOccurred())
gomega.ExpectWithOffset(1, err).To(gomega.Equal(expected))
}
|