| 1 |
package twilio |
| 2 |
|
| 3 |
import ( |
| 4 |
"net/url" |
| 5 |
|
| 6 |
"github.com/onsi/ginkgo/v2" |
| 7 |
"github.com/onsi/gomega" |
| 8 |
|
| 9 |
"github.com/nicholas-fedor/shoutrrr/pkg/format" |
| 10 |
) |
| 11 |
|
| 12 |
var _ = ginkgo.Describe("Config Unit Tests", func() { |
| 13 |
var ( |
| 14 |
config *Config |
| 15 |
keyResolver format.PropKeyResolver |
| 16 |
) |
| 17 |
|
| 18 |
ginkgo.BeforeEach(func() { |
| 19 |
config = &Config{} |
| 20 |
keyResolver = format.NewPropKeyResolver(config) |
| 21 |
}) |
| 22 |
|
| 23 |
ginkgo.Describe("SetURL", func() { |
| 24 |
ginkgo.It("should update the account SID from the user part of the url", func() { |
| 25 |
testURL := createTestURL( |
| 26 |
"ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", |
| 27 |
"authToken", |
| 28 |
"+15551234567", |
| 29 |
"+15559876543", |
| 30 |
) |
| 31 |
err := config.SetURL(testURL) |
| 32 |
gomega.Expect(err).NotTo(gomega.HaveOccurred()) |
| 33 |
gomega.Expect(config.AccountSID).To(gomega.Equal("ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")) |
| 34 |
}) |
| 35 |
|
| 36 |
ginkgo.It("should update the auth token from the password part of the url", func() { |
| 37 |
testURL := createTestURL( |
| 38 |
"ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", |
| 39 |
"testAuthToken", |
| 40 |
"+15551234567", |
| 41 |
"+15559876543", |
| 42 |
) |
| 43 |
err := config.SetURL(testURL) |
| 44 |
gomega.Expect(err).NotTo(gomega.HaveOccurred()) |
| 45 |
gomega.Expect(config.AuthToken).To(gomega.Equal("testAuthToken")) |
| 46 |
}) |
| 47 |
|
| 48 |
ginkgo.It("should update the from number from the host part of the url", func() { |
| 49 |
testURL := createTestURL( |
| 50 |
"ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", |
| 51 |
"authToken", |
| 52 |
"+15551234567", |
| 53 |
"+15559876543", |
| 54 |
) |
| 55 |
err := config.SetURL(testURL) |
| 56 |
gomega.Expect(err).NotTo(gomega.HaveOccurred()) |
| 57 |
gomega.Expect(config.FromNumber).To(gomega.Equal("+15551234567")) |
| 58 |
}) |
| 59 |
|
| 60 |
ginkgo.It("should update the to numbers from the path part of the url", func() { |
| 61 |
testURL := createTestURL( |
| 62 |
"ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", |
| 63 |
"authToken", |
| 64 |
"+15551234567", |
| 65 |
"+15559876543", |
| 66 |
) |
| 67 |
err := config.SetURL(testURL) |
| 68 |
gomega.Expect(err).NotTo(gomega.HaveOccurred()) |
| 69 |
gomega.Expect(config.ToNumbers).To(gomega.Equal([]string{"+15559876543"})) |
| 70 |
}) |
| 71 |
|
| 72 |
ginkgo.It("should parse multiple recipients from the path", func() { |
| 73 |
testURL, err := url.Parse( |
| 74 |
"twilio://ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX:authToken@+15551234567/+15559876543/+15551111111", |
| 75 |
) |
| 76 |
gomega.Expect(err).NotTo(gomega.HaveOccurred()) |
| 77 |
err = config.SetURL(testURL) |
| 78 |
gomega.Expect(err).NotTo(gomega.HaveOccurred()) |
| 79 |
gomega.Expect(config.ToNumbers). |
| 80 |
To(gomega.Equal([]string{"+15559876543", "+15551111111"})) |
| 81 |
}) |
| 82 |
|
| 83 |
ginkgo.It("should error if the account SID is missing", func() { |
| 84 |
testURL := createTestURL("", "authToken", "+15551234567", "+15559876543") |
| 85 |
err := config.SetURL(testURL) |
| 86 |
gomega.Expect(err).To(gomega.MatchError(ErrAccountSIDMissing)) |
| 87 |
}) |
| 88 |
|
| 89 |
ginkgo.It("should error if the auth token is missing", func() { |
| 90 |
testURL := createTestURL( |
| 91 |
"ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", |
| 92 |
"", |
| 93 |
"+15551234567", |
| 94 |
"+15559876543", |
| 95 |
) |
| 96 |
err := config.SetURL(testURL) |
| 97 |
gomega.Expect(err).To(gomega.MatchError(ErrAuthTokenMissing)) |
| 98 |
}) |
| 99 |
|
| 100 |
ginkgo.It("should error if the from number is missing", func() { |
| 101 |
testURL := createTestURL( |
| 102 |
"ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", |
| 103 |
"authToken", |
| 104 |
"", |
| 105 |
"+15559876543", |
| 106 |
) |
| 107 |
err := config.SetURL(testURL) |
| 108 |
gomega.Expect(err).To(gomega.MatchError(ErrFromNumberMissing)) |
| 109 |
}) |
| 110 |
|
| 111 |
ginkgo.It("should error if the to numbers are missing", func() { |
| 112 |
testURL := createTestURL( |
| 113 |
"ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", |
| 114 |
"authToken", |
| 115 |
"+15551234567", |
| 116 |
"", |
| 117 |
) |
| 118 |
err := config.SetURL(testURL) |
| 119 |
gomega.Expect(err).To(gomega.MatchError(ErrToNumbersMissing)) |
| 120 |
}) |
| 121 |
|
| 122 |
ginkgo.It("should error if to and from numbers are the same", func() { |
| 123 |
testURL := createTestURL( |
| 124 |
"ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", |
| 125 |
"authToken", |
| 126 |
"+15551234567", |
| 127 |
"+15551234567", |
| 128 |
) |
| 129 |
err := config.SetURL(testURL) |
| 130 |
gomega.Expect(err).To(gomega.MatchError(ErrToFromNumberSame)) |
| 131 |
}) |
| 132 |
}) |
| 133 |
|
| 134 |
ginkgo.Describe("GetURL", func() { |
| 135 |
ginkgo.It("should return the config as a URL", func() { |
| 136 |
config.AccountSID = "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" |
| 137 |
config.AuthToken = "testAuthToken" |
| 138 |
config.FromNumber = "+15551234567" |
| 139 |
config.ToNumbers = []string{"+15559876543"} |
| 140 |
|
| 141 |
serviceURL := config.GetURL() |
| 142 |
password, _ := serviceURL.User.Password() |
| 143 |
gomega.Expect(serviceURL.Scheme).To(gomega.Equal("twilio")) |
| 144 |
gomega.Expect(serviceURL.User.Username()).To(gomega.Equal(config.AccountSID)) |
| 145 |
gomega.Expect(password).To(gomega.Equal(config.AuthToken)) |
| 146 |
gomega.Expect(serviceURL.Host).To(gomega.Equal(config.FromNumber)) |
| 147 |
}) |
| 148 |
|
| 149 |
ginkgo.It("should encode multiple recipients in the path", func() { |
| 150 |
config.AccountSID = "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" |
| 151 |
config.AuthToken = "testAuthToken" |
| 152 |
config.FromNumber = "+15551234567" |
| 153 |
config.ToNumbers = []string{"+15559876543", "+15551111111"} |
| 154 |
|
| 155 |
serviceURL := config.GetURL() |
| 156 |
gomega.Expect(serviceURL.Path).To(gomega.Equal("/+15559876543/+15551111111")) |
| 157 |
}) |
| 158 |
}) |
| 159 |
|
| 160 |
ginkgo.Describe("Messaging Service SID", func() { |
| 161 |
ginkgo.It("should accept an MG-prefixed sender", func() { |
| 162 |
testURL, err := url.Parse( |
| 163 |
"twilio://ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX:authToken@MGXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/+15559876543", |
| 164 |
) |
| 165 |
gomega.Expect(err).NotTo(gomega.HaveOccurred()) |
| 166 |
err = config.SetURL(testURL) |
| 167 |
gomega.Expect(err).NotTo(gomega.HaveOccurred()) |
| 168 |
gomega.Expect(config.FromNumber).To(gomega.Equal("MGXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")) |
| 169 |
}) |
| 170 |
|
| 171 |
ginkgo.It("should not validate to==from when using Messaging Service SID", func() { |
| 172 |
// MG-prefixed senders skip the to==from validation |
| 173 |
testURL, err := url.Parse( |
| 174 |
"twilio://ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX:authToken@MGXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/MGXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", |
| 175 |
) |
| 176 |
gomega.Expect(err).NotTo(gomega.HaveOccurred()) |
| 177 |
err = config.SetURL(testURL) |
| 178 |
gomega.Expect(err).NotTo(gomega.HaveOccurred()) |
| 179 |
}) |
| 180 |
}) |
| 181 |
|
| 182 |
ginkgo.Describe("normalizePhoneNumber", func() { |
| 183 |
ginkgo.It("should strip dashes and parentheses", func() { |
| 184 |
testURL, err := url.Parse( |
| 185 |
"twilio://ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX:authToken@+1(555)123-4567/+1(555)987-6543", |
| 186 |
) |
| 187 |
gomega.Expect(err).NotTo(gomega.HaveOccurred()) |
| 188 |
err = config.SetURL(testURL) |
| 189 |
gomega.Expect(err).NotTo(gomega.HaveOccurred()) |
| 190 |
gomega.Expect(config.FromNumber).To(gomega.Equal("+15551234567")) |
| 191 |
gomega.Expect(config.ToNumbers).To(gomega.Equal([]string{"+15559876543"})) |
| 192 |
}) |
| 193 |
|
| 194 |
ginkgo.It("should strip spaces and dots", func() { |
| 195 |
testURL, err := url.Parse( |
| 196 |
"twilio://ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX:authToken@+1.555.123.4567/+1 555 987 6543", |
| 197 |
) |
| 198 |
gomega.Expect(err).NotTo(gomega.HaveOccurred()) |
| 199 |
err = config.SetURL(testURL) |
| 200 |
gomega.Expect(err).NotTo(gomega.HaveOccurred()) |
| 201 |
gomega.Expect(config.FromNumber).To(gomega.Equal("+15551234567")) |
| 202 |
gomega.Expect(config.ToNumbers).To(gomega.Equal([]string{"+15559876543"})) |
| 203 |
}) |
| 204 |
|
| 205 |
ginkgo.It("should not modify Messaging Service SIDs", func() { |
| 206 |
result := normalizePhoneNumber("MGXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX") |
| 207 |
gomega.Expect(result).To(gomega.Equal("MGXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")) |
| 208 |
}) |
| 209 |
}) |
| 210 |
|
| 211 |
ginkgo.Describe("parseToNumbers", func() { |
| 212 |
ginkgo.It("should return nil for an empty path", func() { |
| 213 |
result := parseToNumbers("") |
| 214 |
gomega.Expect(result).To(gomega.BeNil()) |
| 215 |
}) |
| 216 |
|
| 217 |
ginkgo.It("should parse a single number", func() { |
| 218 |
result := parseToNumbers("/+15559876543") |
| 219 |
gomega.Expect(result).To(gomega.Equal([]string{"+15559876543"})) |
| 220 |
}) |
| 221 |
|
| 222 |
ginkgo.It("should parse multiple numbers", func() { |
| 223 |
result := parseToNumbers("/+15559876543/+15551111111") |
| 224 |
gomega.Expect(result).To(gomega.Equal([]string{"+15559876543", "+15551111111"})) |
| 225 |
}) |
| 226 |
|
| 227 |
ginkgo.It("should skip empty path segments", func() { |
| 228 |
result := parseToNumbers("/+15559876543//+15551111111") |
| 229 |
gomega.Expect(result).To(gomega.Equal([]string{"+15559876543", "+15551111111"})) |
| 230 |
}) |
| 231 |
}) |
| 232 |
|
| 233 |
ginkgo.Describe("Enums", func() { |
| 234 |
ginkgo.It("should return an empty map", func() { |
| 235 |
enums := config.Enums() |
| 236 |
gomega.Expect(enums).To(gomega.BeEmpty()) |
| 237 |
}) |
| 238 |
}) |
| 239 |
|
| 240 |
ginkgo.Describe("PropKeyResolver", func() { |
| 241 |
ginkgo.When("setting a config key", func() { |
| 242 |
ginkgo.It("should update the title when supplied", func() { |
| 243 |
err := keyResolver.Set("title", "new title") |
| 244 |
gomega.Expect(err).NotTo(gomega.HaveOccurred()) |
| 245 |
gomega.Expect(config.Title).To(gomega.Equal("new title")) |
| 246 |
}) |
| 247 |
|
| 248 |
ginkgo.It("should return an error for an unrecognized key", func() { |
| 249 |
err := keyResolver.Set("invalidkey", "value") |
| 250 |
gomega.Expect(err).To(gomega.HaveOccurred()) |
| 251 |
}) |
| 252 |
}) |
| 253 |
|
| 254 |
ginkgo.When("getting a config key", func() { |
| 255 |
ginkgo.It("should return the title value", func() { |
| 256 |
config.Title = "my title" |
| 257 |
value, err := keyResolver.Get("title") |
| 258 |
gomega.Expect(err).NotTo(gomega.HaveOccurred()) |
| 259 |
gomega.Expect(value).To(gomega.Equal("my title")) |
| 260 |
}) |
| 261 |
|
| 262 |
ginkgo.It("should return an error for an unrecognized key", func() { |
| 263 |
_, err := keyResolver.Get("invalidkey") |
| 264 |
gomega.Expect(err).To(gomega.HaveOccurred()) |
| 265 |
}) |
| 266 |
}) |
| 267 |
|
| 268 |
ginkgo.When("listing query fields", func() { |
| 269 |
ginkgo.It("should return the key title", func() { |
| 270 |
fields := keyResolver.QueryFields() |
| 271 |
gomega.Expect(fields).To(gomega.Equal([]string{"title"})) |
| 272 |
}) |
| 273 |
}) |
| 274 |
}) |
| 275 |
|
| 276 |
ginkgo.Describe("Service API compliance", func() { |
| 277 |
ginkgo.It("should pass standard config tests", func() { |
| 278 |
cfg := &Config{} |
| 279 |
enums := cfg.Enums() |
| 280 |
gomega.Expect(enums).To(gomega.BeEmpty()) |
| 281 |
|
| 282 |
resolver := format.NewPropKeyResolver(cfg) |
| 283 |
fields := resolver.QueryFields() |
| 284 |
gomega.Expect(fields).To(gomega.HaveLen(1)) |
| 285 |
}) |
| 286 |
}) |
| 287 |
}) |
| 288 |
|
| 289 |
// createTestURL is a helper to construct a URL for config testing. |
| 290 |
func createTestURL(accountSID, authToken, fromNumber, toNumber string) *url.URL { |
| 291 |
return &url.URL{ |
| 292 |
Scheme: "twilio", |
| 293 |
User: url.UserPassword(accountSID, authToken), |
| 294 |
Host: fromNumber, |
| 295 |
Path: "/" + toNumber, |
| 296 |
} |
| 297 |
} |