| 1 |
package rocketchat |
| 2 |
|
| 3 |
import ( |
| 4 |
"crypto/tls" |
| 5 |
"crypto/x509" |
| 6 |
"net/http" |
| 7 |
"net/http/httptest" |
| 8 |
"net/url" |
| 9 |
"os" |
| 10 |
"testing" |
| 11 |
|
| 12 |
"github.com/onsi/ginkgo/v2" |
| 13 |
"github.com/onsi/gomega" |
| 14 |
|
| 15 |
"github.com/nicholas-fedor/shoutrrr/internal/testutils" |
| 16 |
"github.com/nicholas-fedor/shoutrrr/pkg/types" |
| 17 |
) |
| 18 |
|
| 19 |
// Constants for repeated test values. |
| 20 |
const ( |
| 21 |
testTokenA = "tokenA" |
| 22 |
testTokenB = "tokenB" |
| 23 |
) |
| 24 |
|
| 25 |
var ( |
| 26 |
service *Service |
| 27 |
envRocketchatURL *url.URL |
| 28 |
_ = ginkgo.BeforeSuite(func() { |
| 29 |
service = &Service{} |
| 30 |
envRocketchatURL, _ = url.Parse(os.Getenv("SHOUTRRR_ROCKETCHAT_URL")) |
| 31 |
}) |
| 32 |
) |
| 33 |
|
| 34 |
var _ = ginkgo.Describe("the rocketchat service", func() { |
| 35 |
// Add tests for Initialize() |
| 36 |
ginkgo.Describe("Initialize method", func() { |
| 37 |
ginkgo.When("initializing with a valid URL", func() { |
| 38 |
ginkgo.It("should set logger and config without error", func() { |
| 39 |
service := &Service{} |
| 40 |
testURL, _ := url.Parse( |
| 41 |
"rocketchat://[email protected]:5055/" + testTokenA + "/" + testTokenB + "/#testChannel", |
| 42 |
) |
| 43 |
err := service.Initialize(testURL, testutils.TestLogger()) |
| 44 |
gomega.Expect(err).NotTo(gomega.HaveOccurred()) |
| 45 |
gomega.Expect(service.Config).NotTo(gomega.BeNil()) |
| 46 |
gomega.Expect(service.Config.Host).To(gomega.Equal("rocketchat.my-domain.com")) |
| 47 |
gomega.Expect(service.Config.Port).To(gomega.Equal("5055")) |
| 48 |
gomega.Expect(service.Config.UserName).To(gomega.Equal("testUser")) |
| 49 |
gomega.Expect(service.Config.TokenA).To(gomega.Equal(testTokenA)) |
| 50 |
gomega.Expect(service.Config.TokenB).To(gomega.Equal(testTokenB)) |
| 51 |
gomega.Expect(service.Config.Channel).To(gomega.Equal("#testChannel")) |
| 52 |
}) |
| 53 |
}) |
| 54 |
ginkgo.When("initializing with an invalid URL", func() { |
| 55 |
ginkgo.It("should return an error", func() { |
| 56 |
service := &Service{} |
| 57 |
testURL, _ := url.Parse("rocketchat://rocketchat.my-domain.com") // Missing tokens |
| 58 |
err := service.Initialize(testURL, testutils.TestLogger()) |
| 59 |
gomega.Expect(err).To(gomega.HaveOccurred()) |
| 60 |
gomega.Expect(err). |
| 61 |
To(gomega.Equal(ErrNotEnoughArguments)) |
| 62 |
// Updated to use the error variable |
| 63 |
}) |
| 64 |
}) |
| 65 |
}) |
| 66 |
|
| 67 |
// Add tests for Send() |
| 68 |
ginkgo.Describe("Send method", func() { |
| 69 |
var ( |
| 70 |
mockServer *httptest.Server |
| 71 |
service *Service |
| 72 |
client *http.Client |
| 73 |
) |
| 74 |
|
| 75 |
ginkgo.BeforeEach(func() { |
| 76 |
// Create TLS server |
| 77 |
mockServer = httptest.NewTLSServer(nil) // Handler set in each test |
| 78 |
|
| 79 |
// Configure client to trust the mock server's certificate |
| 80 |
certPool := x509.NewCertPool() |
| 81 |
for _, cert := range mockServer.TLS.Certificates { |
| 82 |
certPool.AddCert(cert.Leaf) |
| 83 |
} |
| 84 |
|
| 85 |
client = &http.Client{ |
| 86 |
Transport: &http.Transport{ |
| 87 |
TLSClientConfig: &tls.Config{ |
| 88 |
RootCAs: certPool, |
| 89 |
MinVersion: tls.VersionTLS12, // Explicitly set minimum TLS version to 1.2 |
| 90 |
}, |
| 91 |
}, |
| 92 |
} |
| 93 |
|
| 94 |
service = &Service{ |
| 95 |
Config: &Config{}, |
| 96 |
Client: client, // Assign the custom client here |
| 97 |
} |
| 98 |
service.SetLogger(testutils.TestLogger()) |
| 99 |
}) |
| 100 |
|
| 101 |
ginkgo.AfterEach(func() { |
| 102 |
if mockServer != nil { |
| 103 |
mockServer.Close() |
| 104 |
} |
| 105 |
}) |
| 106 |
|
| 107 |
ginkgo.When("sending a message to a mock server with success", func() { |
| 108 |
ginkgo.It("should return no error", func() { |
| 109 |
mockServer.Config.Handler = http.HandlerFunc( |
| 110 |
func(w http.ResponseWriter, _ *http.Request) { |
| 111 |
w.WriteHeader(http.StatusOK) |
| 112 |
}, |
| 113 |
) |
| 114 |
mockURL, _ := url.Parse(mockServer.URL) |
| 115 |
service.Config.Host = mockURL.Hostname() |
| 116 |
service.Config.Port = mockURL.Port() |
| 117 |
service.Config.TokenA = testTokenA |
| 118 |
service.Config.TokenB = testTokenB |
| 119 |
|
| 120 |
err := service.Send("test message", nil) |
| 121 |
gomega.Expect(err).NotTo(gomega.HaveOccurred()) |
| 122 |
}) |
| 123 |
}) |
| 124 |
|
| 125 |
ginkgo.When("sending a message to a mock server with failure", func() { |
| 126 |
ginkgo.It("should return an error with status code and body", func() { |
| 127 |
mockServer.Config.Handler = http.HandlerFunc( |
| 128 |
func(w http.ResponseWriter, _ *http.Request) { |
| 129 |
w.WriteHeader(http.StatusBadRequest) |
| 130 |
_, _ = w.Write([]byte("bad request")) |
| 131 |
}, |
| 132 |
) |
| 133 |
mockURL, _ := url.Parse(mockServer.URL) |
| 134 |
service.Config.Host = mockURL.Hostname() |
| 135 |
service.Config.Port = mockURL.Port() |
| 136 |
service.Config.TokenA = testTokenA |
| 137 |
service.Config.TokenB = testTokenB |
| 138 |
|
| 139 |
err := service.Send("test message", nil) |
| 140 |
gomega.Expect(err).To(gomega.HaveOccurred()) |
| 141 |
gomega.Expect(err.Error()). |
| 142 |
To(gomega.ContainSubstring("notification failed: 400 bad request")) |
| 143 |
}) |
| 144 |
}) |
| 145 |
|
| 146 |
ginkgo.When("sending a message to an unreachable server", func() { |
| 147 |
ginkgo.It("should return a connection error", func() { |
| 148 |
service.Client = http.DefaultClient // Reset to default client for this test |
| 149 |
service.Config.Host = "nonexistent.domain" |
| 150 |
service.Config.TokenA = testTokenA |
| 151 |
service.Config.TokenB = testTokenB |
| 152 |
|
| 153 |
err := service.Send("test message", nil) |
| 154 |
gomega.Expect(err).To(gomega.HaveOccurred()) |
| 155 |
gomega.Expect(err.Error()).To(gomega.ContainSubstring("posting to URL")) |
| 156 |
}) |
| 157 |
}) |
| 158 |
|
| 159 |
ginkgo.When("sending a message with params overriding username and channel", func() { |
| 160 |
ginkgo.It("should use params values in the payload", func() { |
| 161 |
mockServer.Config.Handler = http.HandlerFunc( |
| 162 |
func(w http.ResponseWriter, _ *http.Request) { |
| 163 |
w.WriteHeader(http.StatusOK) |
| 164 |
}, |
| 165 |
) |
| 166 |
mockURL, _ := url.Parse(mockServer.URL) |
| 167 |
service.Config.Host = mockURL.Hostname() |
| 168 |
service.Config.Port = mockURL.Port() |
| 169 |
service.Config.TokenA = testTokenA |
| 170 |
service.Config.TokenB = testTokenB |
| 171 |
service.Config.UserName = "defaultUser" |
| 172 |
service.Config.Channel = "#defaultChannel" |
| 173 |
|
| 174 |
params := types.Params{ |
| 175 |
"username": "overrideUser", |
| 176 |
"channel": "#overrideChannel", |
| 177 |
} |
| 178 |
err := service.Send("test message", ¶ms) |
| 179 |
gomega.Expect(err).NotTo(gomega.HaveOccurred()) |
| 180 |
// Note: We can't directly inspect the payload here without mocking CreateJSONPayload, |
| 181 |
// but this ensures the params path is exercised. |
| 182 |
}) |
| 183 |
}) |
| 184 |
}) |
| 185 |
|
| 186 |
// Add tests for GetURL() and SetURL() |
| 187 |
ginkgo.Describe("the rocketchat config", func() { |
| 188 |
ginkgo.When("generating a URL from a config with all fields", func() { |
| 189 |
ginkgo.It("should construct a correct URL", func() { |
| 190 |
config := &Config{ |
| 191 |
Host: "rocketchat.my-domain.com", |
| 192 |
Port: "5055", |
| 193 |
TokenA: testTokenA, |
| 194 |
TokenB: testTokenB, |
| 195 |
} |
| 196 |
url := config.GetURL() |
| 197 |
gomega.Expect(url.String()). |
| 198 |
To(gomega.Equal("rocketchat://rocketchat.my-domain.com:5055/" + testTokenA + "/" + testTokenB)) |
| 199 |
}) |
| 200 |
}) |
| 201 |
|
| 202 |
ginkgo.When("generating a URL from a config without port", func() { |
| 203 |
ginkgo.It("should construct a correct URL without port", func() { |
| 204 |
config := &Config{ |
| 205 |
Host: "rocketchat.my-domain.com", |
| 206 |
TokenA: testTokenA, |
| 207 |
TokenB: testTokenB, |
| 208 |
} |
| 209 |
url := config.GetURL() |
| 210 |
gomega.Expect(url.String()). |
| 211 |
To(gomega.Equal("rocketchat://rocketchat.my-domain.com/" + testTokenA + "/" + testTokenB)) |
| 212 |
}) |
| 213 |
}) |
| 214 |
|
| 215 |
ginkgo.When("setting URL with a channel starting with @", func() { |
| 216 |
ginkgo.It("should set channel without adding #", func() { |
| 217 |
config := &Config{} |
| 218 |
testURL, _ := url.Parse( |
| 219 |
"rocketchat://rocketchat.my-domain.com/" + testTokenA + "/" + testTokenB + "/@user", |
| 220 |
) |
| 221 |
err := config.SetURL(testURL) |
| 222 |
gomega.Expect(err).NotTo(gomega.HaveOccurred()) |
| 223 |
gomega.Expect(config.Channel).To(gomega.Equal("@user")) |
| 224 |
}) |
| 225 |
}) |
| 226 |
|
| 227 |
ginkgo.When("setting URL with a regular channel without fragment", func() { |
| 228 |
ginkgo.It("should prepend # to the channel", func() { |
| 229 |
config := &Config{} |
| 230 |
testURL, _ := url.Parse( |
| 231 |
"rocketchat://rocketchat.my-domain.com/" + testTokenA + "/" + testTokenB + "/general", |
| 232 |
) |
| 233 |
err := config.SetURL(testURL) |
| 234 |
gomega.Expect(err).NotTo(gomega.HaveOccurred()) |
| 235 |
gomega.Expect(config.Channel).To(gomega.Equal("#general")) |
| 236 |
}) |
| 237 |
}) |
| 238 |
}) |
| 239 |
|
| 240 |
// Add test for GetID() |
| 241 |
ginkgo.Describe("GetID method", func() { |
| 242 |
ginkgo.It("should return the correct scheme", func() { |
| 243 |
service := &Service{} |
| 244 |
id := service.GetID() |
| 245 |
gomega.Expect(id).To(gomega.Equal(Scheme)) |
| 246 |
}) |
| 247 |
}) |
| 248 |
}) |
| 249 |
|
| 250 |
func TestRocketchat(t *testing.T) { |
| 251 |
t.Parallel() |
| 252 |
gomega.RegisterFailHandler(ginkgo.Fail) |
| 253 |
ginkgo.RunSpecs(t, "Shoutrrr Rocketchat Suite") |
| 254 |
} |