| 1 |
package teams |
| 2 |
|
| 3 |
import ( |
| 4 |
"errors" |
| 5 |
"log" |
| 6 |
"net/http" |
| 7 |
"net/url" |
| 8 |
"testing" |
| 9 |
|
| 10 |
"github.com/jarcoal/httpmock" |
| 11 |
"github.com/onsi/ginkgo/v2" |
| 12 |
"github.com/onsi/gomega" |
| 13 |
) |
| 14 |
|
| 15 |
const ( |
| 16 |
workflowURL = "https://prod-00.westus.logic.azure.com:443/workflows/abc123/triggers/manual/paths/invoke?api-version=2016-06-00&sp=/triggers/manual/run&sv=1.0&sig=XXXXXXXX" |
| 17 |
) |
| 18 |
|
| 19 |
var serviceURLBase = "teams://?host=" + url.QueryEscape(workflowURL) |
| 20 |
|
| 21 |
var logger = log.New(ginkgo.GinkgoWriter, "Test", log.LstdFlags) |
| 22 |
|
| 23 |
var _ = ginkgo.Describe("the teams service", func() { |
| 24 |
ginkgo.Describe("sending the payload", func() { |
| 25 |
var ( |
| 26 |
err error |
| 27 |
service Service |
| 28 |
) |
| 29 |
|
| 30 |
ginkgo.BeforeEach(func() { |
| 31 |
httpmock.Activate() |
| 32 |
}) |
| 33 |
ginkgo.AfterEach(func() { |
| 34 |
httpmock.DeactivateAndReset() |
| 35 |
}) |
| 36 |
ginkgo.It("should not report an error if the server accepts the payload", func() { |
| 37 |
serviceURL, _ := url.Parse(serviceURLBase) |
| 38 |
err = service.Initialize(serviceURL, logger) |
| 39 |
gomega.Expect(err).NotTo(gomega.HaveOccurred()) |
| 40 |
|
| 41 |
httpmock.RegisterResponder( |
| 42 |
"POST", |
| 43 |
workflowURL, |
| 44 |
httpmock.NewStringResponder(http.StatusOK, ""), |
| 45 |
) |
| 46 |
|
| 47 |
err = service.Send("Message", nil) |
| 48 |
gomega.Expect(err).NotTo(gomega.HaveOccurred()) |
| 49 |
}) |
| 50 |
ginkgo.It("should not report an error if the server responds with 202 Accepted", func() { |
| 51 |
serviceURL, _ := url.Parse(serviceURLBase) |
| 52 |
err = service.Initialize(serviceURL, logger) |
| 53 |
gomega.Expect(err).NotTo(gomega.HaveOccurred()) |
| 54 |
|
| 55 |
httpmock.RegisterResponder( |
| 56 |
"POST", |
| 57 |
workflowURL, |
| 58 |
httpmock.NewStringResponder(http.StatusAccepted, ""), |
| 59 |
) |
| 60 |
|
| 61 |
err = service.Send("Message", nil) |
| 62 |
gomega.Expect(err).NotTo(gomega.HaveOccurred()) |
| 63 |
}) |
| 64 |
ginkgo.It("should report an error if the server returns non-200", func() { |
| 65 |
serviceURL, _ := url.Parse(serviceURLBase) |
| 66 |
err = service.Initialize(serviceURL, logger) |
| 67 |
gomega.Expect(err).NotTo(gomega.HaveOccurred()) |
| 68 |
|
| 69 |
httpmock.RegisterResponder( |
| 70 |
"POST", |
| 71 |
workflowURL, |
| 72 |
httpmock.NewStringResponder(http.StatusInternalServerError, ""), |
| 73 |
) |
| 74 |
|
| 75 |
err = service.Send("Message", nil) |
| 76 |
gomega.Expect(err).To(gomega.HaveOccurred()) |
| 77 |
}) |
| 78 |
ginkgo.It("should not panic if an HTTP error occurs when sending the payload", func() { |
| 79 |
serviceURL, _ := url.Parse(serviceURLBase) |
| 80 |
err = service.Initialize(serviceURL, logger) |
| 81 |
gomega.Expect(err).NotTo(gomega.HaveOccurred()) |
| 82 |
|
| 83 |
httpmock.RegisterResponder( |
| 84 |
"POST", |
| 85 |
workflowURL, |
| 86 |
httpmock.NewErrorResponder(errors.New("dummy error")), |
| 87 |
) |
| 88 |
|
| 89 |
err = service.Send("Message", nil) |
| 90 |
gomega.Expect(err).To(gomega.HaveOccurred()) |
| 91 |
}) |
| 92 |
}) |
| 93 |
|
| 94 |
ginkgo.It("should return the correct service ID", func() { |
| 95 |
service := &Service{} |
| 96 |
gomega.Expect(service.GetID()).To(gomega.Equal("teams")) |
| 97 |
}) |
| 98 |
|
| 99 |
ginkgo.Describe("the teams config", func() { |
| 100 |
ginkgo.Describe("setURL", func() { |
| 101 |
ginkgo.It("should set all fields correctly from URL", func() { |
| 102 |
config := &Config{} |
| 103 |
urlStr := serviceURLBase + "&title=Test&color=red" |
| 104 |
parsedURL, err := url.Parse(urlStr) |
| 105 |
gomega.Expect(err).NotTo(gomega.HaveOccurred()) |
| 106 |
|
| 107 |
err = config.SetURL(parsedURL) |
| 108 |
gomega.Expect(err).NotTo(gomega.HaveOccurred()) |
| 109 |
|
| 110 |
gomega.Expect(config.Host).To(gomega.Equal(workflowURL)) |
| 111 |
gomega.Expect(config.Title).To(gomega.Equal("Test")) |
| 112 |
gomega.Expect(config.Color).To(gomega.Equal("red")) |
| 113 |
}) |
| 114 |
|
| 115 |
ginkgo.It("should silently skip unknown query params from workflow URL", func() { |
| 116 |
config := &Config{} |
| 117 |
// Simulates the query params appended by Power Automate workflow URLs |
| 118 |
urlStr := serviceURLBase + "&api-version=2016-06-00&sp=/triggers/manual/run&sv=1.0&sig=XXXXXXXX" |
| 119 |
parsedURL, err := url.Parse(urlStr) |
| 120 |
gomega.Expect(err).NotTo(gomega.HaveOccurred()) |
| 121 |
|
| 122 |
err = config.SetURL(parsedURL) |
| 123 |
gomega.Expect(err).NotTo(gomega.HaveOccurred()) |
| 124 |
gomega.Expect(config.Host).To(gomega.Equal(workflowURL)) |
| 125 |
}) |
| 126 |
|
| 127 |
ginkgo.It("should accept valid string values for known keys", func() { |
| 128 |
config := &Config{} |
| 129 |
urlStr := serviceURLBase + "&title=Test" |
| 130 |
parsedURL, err := url.Parse(urlStr) |
| 131 |
gomega.Expect(err).NotTo(gomega.HaveOccurred()) |
| 132 |
|
| 133 |
err = config.SetURL(parsedURL) |
| 134 |
gomega.Expect(err).NotTo(gomega.HaveOccurred()) |
| 135 |
gomega.Expect(config.Title).To(gomega.Equal("Test")) |
| 136 |
}) |
| 137 |
}) |
| 138 |
|
| 139 |
ginkgo.Describe("getURL", func() { |
| 140 |
ginkgo.It("should generate URL containing host, title, and color params", func() { |
| 141 |
config := &Config{ |
| 142 |
Host: workflowURL, |
| 143 |
Title: "Test", |
| 144 |
Color: "red", |
| 145 |
} |
| 146 |
|
| 147 |
urlObj := config.GetURL() |
| 148 |
urlStr := urlObj.String() |
| 149 |
gomega.Expect(urlStr).To(gomega.ContainSubstring("host=")) |
| 150 |
gomega.Expect(urlStr).To(gomega.ContainSubstring("color=red")) |
| 151 |
gomega.Expect(urlStr).To(gomega.ContainSubstring("title=Test")) |
| 152 |
}) |
| 153 |
}) |
| 154 |
}) |
| 155 |
|
| 156 |
ginkgo.Describe("Initialize", func() { |
| 157 |
ginkgo.It("should initialize with a valid workflow URL", func() { |
| 158 |
service := &Service{} |
| 159 |
serviceURL, _ := url.Parse(serviceURLBase) |
| 160 |
err := service.Initialize(serviceURL, logger) |
| 161 |
gomega.Expect(err).NotTo(gomega.HaveOccurred()) |
| 162 |
gomega.Expect(service.Config).NotTo(gomega.BeNil()) |
| 163 |
gomega.Expect(service.Config.Host).To(gomega.Equal(workflowURL)) |
| 164 |
}) |
| 165 |
}) |
| 166 |
|
| 167 |
ginkgo.Describe("ValidateWebhookURL", func() { |
| 168 |
ginkgo.It("should accept valid Power Automate workflow URLs", func() { |
| 169 |
validURLs := []string{ |
| 170 |
"https://prod-00.westus.logic.azure.com:443/workflows/abc123/triggers/manual/paths/invoke", |
| 171 |
"https://prod-00.westus.logic.azure.com/workflows/abc123/triggers/manual/paths/invoke", |
| 172 |
"https://mytenant.logic.azure.com/workflows/abc123/triggers/manual/paths/invoke?api-version=2016-06-00", |
| 173 |
"https://prod-00.westus.logic.azure.us/workflows/abc123/triggers/manual/paths/invoke", |
| 174 |
"https://prod-00.westus.logic.azure.cn/workflows/abc123/triggers/manual/paths/invoke", |
| 175 |
"https://prod-00.westus.logic.azure.de/workflows/abc123/triggers/manual/paths/invoke", |
| 176 |
"https://default.environment.api.powerplatform.com/powerautomate/automations/direct/workflows/abc123/triggers/manual/paths/invoke?api-version=1&sp=%2Ftriggers%2Fmanual%2Frun&sv=1.0&sig=XXXXXXXX", |
| 177 |
"https://prefix.environment.environment.api.powerplatform.com:443/powerautomate/automations/direct/workflows/abc123/triggers/manual/paths/invoke", |
| 178 |
} |
| 179 |
for _, u := range validURLs { |
| 180 |
err := ValidateWebhookURL(u) |
| 181 |
gomega.Expect(err).NotTo(gomega.HaveOccurred(), "URL: %s", u) |
| 182 |
} |
| 183 |
}) |
| 184 |
|
| 185 |
ginkgo.It("should reject invalid URLs", func() { |
| 186 |
invalidURLs := []string{ |
| 187 |
"https://example.com/webhook", |
| 188 |
"", |
| 189 |
} |
| 190 |
for _, u := range invalidURLs { |
| 191 |
err := ValidateWebhookURL(u) |
| 192 |
gomega.Expect(err).To(gomega.HaveOccurred(), "URL: %s", u) |
| 193 |
} |
| 194 |
}) |
| 195 |
}) |
| 196 |
|
| 197 |
ginkgo.Describe("doSend", func() { |
| 198 |
ginkgo.It("should return ErrMissingHost when host is empty", func() { |
| 199 |
service := &Service{} |
| 200 |
service.Config = &Config{} |
| 201 |
service.SetLogger(logger) |
| 202 |
|
| 203 |
err := service.doSend(&Config{}, "test message") |
| 204 |
gomega.Expect(err).To(gomega.Equal(ErrMissingHost)) |
| 205 |
}) |
| 206 |
|
| 207 |
ginkgo.It("should return ErrInvalidWebhookURL for invalid host before any HTTP call", func() { |
| 208 |
service := &Service{} |
| 209 |
service.Config = &Config{} |
| 210 |
service.SetLogger(logger) |
| 211 |
|
| 212 |
// No httpmock activated — this must fail at validation, not at the network layer. |
| 213 |
err := service.doSend(&Config{Host: "https://example.com"}, "test message") |
| 214 |
gomega.Expect(err).To(gomega.MatchError(ErrInvalidWebhookURL)) |
| 215 |
}) |
| 216 |
}) |
| 217 |
}) |
| 218 |
|
| 219 |
// TestTeams runs the test suite for the Teams package. |
| 220 |
func TestTeams(t *testing.T) { |
| 221 |
t.Parallel() |
| 222 |
gomega.RegisterFailHandler(ginkgo.Fail) |
| 223 |
ginkgo.RunSpecs(t, "Shoutrrr Teams Suite") |
| 224 |
} |