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
|
package signal
import (
"log"
"net/url"
"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/types"
)
func TestSignal(t *testing.T) {
gomega.RegisterFailHandler(ginkgo.Fail)
ginkgo.RunSpecs(t, "Shoutrrr Signal Suite")
}
var (
logger *log.Logger
_ = ginkgo.BeforeSuite(func() {
logger = log.New(ginkgo.GinkgoWriter, "Test", log.LstdFlags)
})
)
var _ = ginkgo.Describe("the signal service", func() {
var signal *Service
ginkgo.BeforeEach(func() {
signal = &Service{}
})
ginkgo.Describe("creating configurations", func() {
ginkgo.When("given a url", func() {
ginkgo.It("should return an error if no source phone number is supplied", func() {
serviceURL, _ := url.Parse("signal://localhost:8080")
err := signal.Initialize(serviceURL, logger)
gomega.Expect(err).To(gomega.HaveOccurred())
gomega.Expect(err).To(gomega.MatchError(ErrNoRecipients))
})
ginkgo.It("should return an error if no recipients are supplied", func() {
serviceURL, _ := url.Parse("signal://localhost:8080/+1234567890")
err := signal.Initialize(serviceURL, logger)
gomega.Expect(err).To(gomega.HaveOccurred())
gomega.Expect(err).To(gomega.MatchError(ErrNoRecipients))
})
ginkgo.It("should return an error for invalid phone number format", func() {
serviceURL, _ := url.Parse("signal://localhost:8080/invalid-phone/+1234567890")
err := signal.Initialize(serviceURL, logger)
gomega.Expect(err).To(gomega.HaveOccurred())
gomega.Expect(err.Error()).
To(gomega.ContainSubstring("invalid phone number format"))
})
ginkgo.It("should return an error for invalid group ID format", func() {
serviceURL, _ := url.Parse("signal://localhost:8080/+1234567890/invalid.group!")
err := signal.Initialize(serviceURL, logger)
gomega.Expect(err).To(gomega.HaveOccurred())
gomega.Expect(err.Error()).To(gomega.ContainSubstring("invalid recipient"))
})
ginkgo.When("parsing authentication", func() {
ginkgo.It("should parse user without password", func() {
serviceURL, _ := url.Parse(
"signal://user@localhost:8080/+1234567890/+0987654321",
)
err := signal.Initialize(serviceURL, logger)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
gomega.Expect(signal.Config.User).To(gomega.Equal("user"))
gomega.Expect(signal.Config.Password).To(gomega.BeEmpty())
})
ginkgo.It("should parse user with password", func() {
serviceURL, _ := url.Parse(
"signal://user:pass@localhost:8080/+1234567890/+0987654321",
)
err := signal.Initialize(serviceURL, logger)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
gomega.Expect(signal.Config.User).To(gomega.Equal("user"))
gomega.Expect(signal.Config.Password).To(gomega.Equal("pass"))
})
})
ginkgo.When("parsing host and port", func() {
ginkgo.It("should parse custom host and port", func() {
serviceURL, _ := url.Parse("signal://myserver:9999/+1234567890/+0987654321")
err := signal.Initialize(serviceURL, logger)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
gomega.Expect(signal.Config.Host).To(gomega.Equal("myserver"))
gomega.Expect(signal.Config.Port).To(gomega.Equal(9999))
})
ginkgo.It("should use default port when not specified", func() {
serviceURL, _ := url.Parse("signal://myserver/+1234567890/+0987654321")
err := signal.Initialize(serviceURL, logger)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
gomega.Expect(signal.Config.Host).To(gomega.Equal("myserver"))
gomega.Expect(signal.Config.Port).To(gomega.Equal(8080))
})
})
ginkgo.When("parsing TLS settings", func() {
ginkgo.It("should enable TLS by default", func() {
serviceURL, _ := url.Parse("signal://localhost:8080/+1234567890/+0987654321")
err := signal.Initialize(serviceURL, logger)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
gomega.Expect(signal.Config.DisableTLS).To(gomega.BeFalse())
})
ginkgo.It("should disable TLS when disabletls=yes", func() {
serviceURL, _ := url.Parse(
"signal://localhost:8080/+1234567890/+0987654321?disabletls=yes",
)
err := signal.Initialize(serviceURL, logger)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
gomega.Expect(signal.Config.DisableTLS).To(gomega.BeTrue())
})
})
ginkgo.When("the url is valid", func() {
var config *Config
var err error
ginkgo.BeforeEach(func() {
serviceURL, _ := url.Parse(
"signal://localhost:8080/+1234567890/+0987654321/group.testgroup",
)
err = signal.Initialize(serviceURL, logger)
config = signal.Config
})
ginkgo.It("should create a config object", func() {
gomega.Expect(err).NotTo(gomega.HaveOccurred())
gomega.Expect(config).ToNot(gomega.BeNil())
})
ginkgo.It("should parse the source phone number", func() {
gomega.Expect(config.Source).To(gomega.Equal("+1234567890"))
})
ginkgo.It("should parse the recipients", func() {
gomega.Expect(config.Recipients).
To(gomega.Equal([]string{"+0987654321", "group.testgroup"}))
})
ginkgo.It("should set default host and port", func() {
gomega.Expect(config.Host).To(gomega.Equal("localhost"))
gomega.Expect(config.Port).To(gomega.Equal(8080))
})
})
})
})
ginkgo.Describe("sending the payload", 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("signal://localhost:8080/+1234567890/+0987654321")
err = signal.Initialize(serviceURL, logger)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
setupResponder(200, `{"timestamp": 1234567890}`)
err = signal.Send("Test message", nil)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
})
ginkgo.It("should report an error if the server returns an error", func() {
serviceURL, _ := url.Parse("signal://localhost:8080/+1234567890/+0987654321")
err = signal.Initialize(serviceURL, logger)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
setupResponder(400, `{"error": "Bad Request"}`)
err = signal.Send("Test message", nil)
gomega.Expect(err).To(gomega.HaveOccurred())
gomega.Expect(err.Error()).To(gomega.ContainSubstring("server returned status 400"))
})
ginkgo.It("should handle attachments in parameters", func() {
serviceURL, _ := url.Parse("signal://localhost:8080/+1234567890/+0987654321")
err = signal.Initialize(serviceURL, logger)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
setupResponder(200, `{"timestamp": 1234567890}`)
params := types.Params{
"attachments": "base64data1,base64data2",
}
err = signal.Send("Test message", ¶ms)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
})
ginkgo.It("should handle different response formats", func() {
serviceURL, _ := url.Parse("signal://localhost:8080/+1234567890/+0987654321")
err = signal.Initialize(serviceURL, logger)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
setupResponder(201, `{"timestamp": "1234567890"}`) // String timestamp
err = signal.Send("Test message", nil)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
})
ginkgo.It("should handle server errors gracefully", func() {
serviceURL, _ := url.Parse("signal://localhost:8080/+1234567890/+0987654321")
err = signal.Initialize(serviceURL, logger)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
setupResponder(500, `{"error": "Internal Server Error"}`)
err = signal.Send("Test message", nil)
gomega.Expect(err).To(gomega.HaveOccurred())
gomega.Expect(err.Error()).To(gomega.ContainSubstring("server returned status 500"))
})
ginkgo.It("should return error when no recipients configured", func() {
// Create a config with no recipients
signal.Config = &Config{
Host: "localhost",
Port: 8080,
Source: "+1234567890",
Recipients: []string{}, // Empty recipients
}
err = signal.Send("Test message", nil)
gomega.Expect(err).To(gomega.MatchError(ErrNoRecipients))
})
})
ginkgo.It("should implement basic service API methods correctly", func() {
serviceURL, _ := url.Parse("signal://localhost:8080/+1234567890/+0987654321")
err := signal.Initialize(serviceURL, logger)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
config := signal.Config
testutils.TestConfigGetInvalidQueryValue(config)
testutils.TestConfigSetInvalidQueryValue(
config,
"signal://localhost:8080/+1234567890/+0987654321?foo=bar",
)
testutils.TestConfigGetEnumsCount(config, 0)
testutils.TestConfigGetFieldsCount(config, 10)
})
ginkgo.It("should return the correct service ID", func() {
service := &Service{}
gomega.Expect(service.GetID()).To(gomega.Equal("signal"))
})
})
func setupResponder(code int, body string) {
targetURL := "https://localhost:8080/v2/send"
httpmock.RegisterResponder("POST", targetURL, httpmock.NewStringResponder(code, body))
}
|