Debian Codegraph @

testing/e2e/matrix/service_e2e_test.go

raw
1 package e2e_test
2
3 import (
4 "net/url"
5 "os"
6
7 "github.com/onsi/ginkgo/v2"
8 "github.com/onsi/gomega"
9
10 "github.com/nicholas-fedor/shoutrrr/internal/testutils"
11 "github.com/nicholas-fedor/shoutrrr/pkg/services/chat/matrix"
12 "github.com/nicholas-fedor/shoutrrr/pkg/types"
13 )
14
15 var _ = ginkgo.Describe("Matrix Service E2E Tests", func() {
16 ginkgo.Describe("Service Initialization", func() {
17 ginkgo.It("should initialize with valid credentials from environment", func() {
18 // Use shared service if available, otherwise create new one
19 if sharedService != nil {
20 gomega.Expect(sharedService.Config).NotTo(gomega.BeNil())
21 gomega.Expect(sharedService.Config.Host).NotTo(gomega.BeEmpty())
22
23 return
24 }
25
26 serviceURL := buildServiceURL()
27 if serviceURL == "" {
28 ginkgo.Skip("Matrix server not configured, skipping test. " +
29 "Set SHOUTRRR_MATRIX_USER and SHOUTRRR_MATRIX_PASSWORD environment variables")
30 }
31
32 parsedURL, err := url.Parse(serviceURL)
33 gomega.Expect(err).NotTo(gomega.HaveOccurred())
34
35 service := &matrix.Service{}
36 err = service.Initialize(parsedURL, testutils.TestLogger())
37 gomega.Expect(err).NotTo(gomega.HaveOccurred())
38
39 gomega.Expect(service.Config).NotTo(gomega.BeNil())
40 gomega.Expect(service.Config.Host).NotTo(gomega.BeEmpty())
41 })
42
43 ginkgo.It("should return error with invalid credentials", func() {
44 // Use a clearly invalid URL that will fail authentication
45 invalidURL := "matrix://invaliduser:invalidpassword@localhost:8008?disableTLS=true"
46 parsedURL, err := url.Parse(invalidURL)
47 gomega.Expect(err).NotTo(gomega.HaveOccurred())
48
49 service := &matrix.Service{}
50 err = service.Initialize(parsedURL, testutils.TestLogger())
51
52 // Should fail because the user doesn't exist or password is wrong
53 gomega.Expect(err).To(gomega.HaveOccurred())
54 })
55
56 ginkgo.It("should return error with missing host", func() {
57 invalidURL := "matrix://user:password@"
58 parsedURL, err := url.Parse(invalidURL)
59 gomega.Expect(err).NotTo(gomega.HaveOccurred())
60
61 service := &matrix.Service{}
62 err = service.Initialize(parsedURL, testutils.TestLogger())
63 gomega.Expect(err).To(gomega.HaveOccurred())
64 })
65
66 ginkgo.It("should return error with missing credentials", func() {
67 invalidURL := "matrix://localhost:8008"
68 parsedURL, err := url.Parse(invalidURL)
69 gomega.Expect(err).NotTo(gomega.HaveOccurred())
70
71 service := &matrix.Service{}
72 err = service.Initialize(parsedURL, testutils.TestLogger())
73 gomega.Expect(err).To(gomega.HaveOccurred())
74 })
75 })
76
77 ginkgo.Describe("Send Messages", func() {
78 ginkgo.It("should send basic text message to Matrix room", func() {
79 // Use shared service if available
80 if sharedService != nil {
81 err := sharedService.Send("E2E Test: Basic text message", nil)
82 gomega.Expect(err).NotTo(gomega.HaveOccurred())
83
84 return
85 }
86
87 serviceURL := buildServiceURL()
88 if serviceURL == "" {
89 ginkgo.Skip("Matrix server not configured, skipping test. " +
90 "Set SHOUTRRR_MATRIX_USER, SHOUTRRR_MATRIX_PASSWORD, and SHOUTRRR_MATRIX_ROOM environment variables")
91 }
92
93 parsedURL, err := url.Parse(serviceURL)
94 gomega.Expect(err).NotTo(gomega.HaveOccurred())
95
96 service := &matrix.Service{}
97 err = service.Initialize(parsedURL, testutils.TestLogger())
98 gomega.Expect(err).NotTo(gomega.HaveOccurred())
99
100 err = service.Send("E2E Test: Basic text message", nil)
101 gomega.Expect(err).NotTo(gomega.HaveOccurred())
102 })
103
104 ginkgo.It("should send message with custom title", func() {
105 // Use shared service if available to avoid rate limit from new login
106 if sharedService != nil {
107 err := sharedService.Send(
108 "E2E Test: Message with custom title",
109 &types.Params{"title": "TestNotification"},
110 )
111 gomega.Expect(err).NotTo(gomega.HaveOccurred())
112
113 return
114 }
115
116 serviceURL := buildServiceURL()
117 if serviceURL == "" {
118 ginkgo.Skip("Matrix server not configured, skipping test")
119 }
120
121 // Fallback: create new service (hits rate limit - not recommended)
122 parsedURL, err := url.Parse(serviceURL + "&title=TestNotification")
123 gomega.Expect(err).NotTo(gomega.HaveOccurred())
124
125 service := &matrix.Service{}
126 err = service.Initialize(parsedURL, testutils.TestLogger())
127 gomega.Expect(err).NotTo(gomega.HaveOccurred())
128
129 err = service.Send("E2E Test: Message with custom title", nil)
130 gomega.Expect(err).NotTo(gomega.HaveOccurred())
131 })
132
133 ginkgo.It("should fail to send when client is not initialized", func() {
134 // Use dummy URL which skips client initialization
135 // Format: matrix://:password@host - password is empty, which triggers ErrMissingCredentials
136 // but this is handled differently - we need a URL that parses successfully but skips client init
137 dummyURL := "matrix://:[email protected]"
138 parsedURL, err := url.Parse(dummyURL)
139 gomega.Expect(err).NotTo(gomega.HaveOccurred())
140
141 service := &matrix.Service{}
142 err = service.Initialize(parsedURL, testutils.TestLogger())
143 // This should succeed because the dummy URL is detected and client is not initialized
144 gomega.Expect(err).NotTo(gomega.HaveOccurred())
145
146 err = service.Send("This should fail", nil)
147 gomega.Expect(err).To(gomega.HaveOccurred())
148 })
149 })
150
151 ginkgo.Describe("Service ID", func() {
152 ginkgo.It("should return correct service ID", func() {
153 // Even with dummy URL, service ID should work
154 // Use format with empty username but password present: matrix://:password@host
155 dummyURL := "matrix://:[email protected]"
156 parsedURL, err := url.Parse(dummyURL)
157 gomega.Expect(err).NotTo(gomega.HaveOccurred())
158
159 service := &matrix.Service{}
160 err = service.Initialize(parsedURL, testutils.TestLogger())
161 gomega.Expect(err).NotTo(gomega.HaveOccurred())
162
163 serviceID := service.GetID()
164 gomega.Expect(serviceID).To(gomega.Equal("matrix"))
165 })
166 })
167
168 ginkgo.Describe("Configuration", func() {
169 ginkgo.It("should parse room aliases correctly", func() {
170 // Test that room aliases are handled with # prefix
171 serviceURL := buildServiceURL()
172 if serviceURL == "" {
173 ginkgo.Skip("Matrix server not configured, skipping test")
174 }
175
176 // Add room without # prefix
177 room := os.Getenv("SHOUTRRR_MATRIX_ROOM")
178 if room == "" {
179 room = "testroom"
180 }
181
182 // Build URL with room that needs prefix
183 parsedURL, err := url.Parse("matrix://user:pass@localhost:8008?room=" + room + "&disableTLS=true")
184 gomega.Expect(err).NotTo(gomega.HaveOccurred())
185
186 service := &matrix.Service{}
187 err = service.Initialize(parsedURL, testutils.TestLogger())
188 // This may fail due to auth, but we can check config parsing
189 if err == nil {
190 gomega.Expect(service.Config.Rooms).To(gomega.Not(gomega.BeEmpty()))
191 }
192 })
193 })
194 })