Debian Codegraph @

pkg/services/chat/googlechat/googlechat_test.go

raw
1 package googlechat_test
2
3 import (
4 "errors"
5 "io"
6 "log"
7 "net/http"
8 "net/url"
9 "os"
10 "testing"
11
12 "github.com/jarcoal/httpmock"
13 "github.com/onsi/ginkgo/v2"
14 "github.com/onsi/gomega"
15
16 "github.com/nicholas-fedor/shoutrrr/internal/testutils"
17 "github.com/nicholas-fedor/shoutrrr/pkg/services/chat/googlechat"
18 "github.com/nicholas-fedor/shoutrrr/pkg/types"
19 )
20
21 var (
22 service *googlechat.Service
23 logger *log.Logger
24 envGooglechatURL *url.URL
25 )
26
27 var _ = ginkgo.BeforeSuite(func() {
28 service = &googlechat.Service{}
29 logger = log.New(ginkgo.GinkgoWriter, "Test", log.LstdFlags)
30
31 var err error
32
33 envGooglechatURL, err = url.Parse(os.Getenv("SHOUTRRR_GOOGLECHAT_URL"))
34 if err != nil {
35 envGooglechatURL = &url.URL{} // Default to empty URL if parsing fails
36 }
37 })
38
39 var _ = ginkgo.Describe("Google Chat Service", func() {
40 ginkgo.When("running integration tests", func() {
41 ginkgo.It("sends a message successfully with a valid ENV URL", func() {
42 if envGooglechatURL.String() == "" {
43 ginkgo.Skip("No integration test ENV URL was set")
44
45 return
46 }
47
48 serviceURL := testutils.URLMust(envGooglechatURL.String())
49 err := service.Initialize(serviceURL, testutils.TestLogger())
50 gomega.Expect(err).NotTo(gomega.HaveOccurred())
51 err = service.Send("This is an integration test message", nil)
52 gomega.Expect(err).NotTo(gomega.HaveOccurred())
53 })
54 })
55
56 ginkgo.Describe("the service", func() {
57 ginkgo.BeforeEach(func() {
58 service = &googlechat.Service{}
59 service.SetLogger(logger)
60 })
61 ginkgo.It("implements Service interface", func() {
62 var impl types.Service = service
63 gomega.Expect(impl).ToNot(gomega.BeNil())
64 })
65 ginkgo.It("returns the correct service identifier", func() {
66 gomega.Expect(service.GetID()).To(gomega.Equal("googlechat"))
67 })
68 })
69
70 ginkgo.When("parsing the configuration URL", func() {
71 ginkgo.BeforeEach(func() {
72 service = &googlechat.Service{}
73 service.SetLogger(logger)
74 })
75 ginkgo.It("builds a valid Google Chat Incoming Webhook URL", func() {
76 serviceURL := testutils.URLMust(
77 "googlechat://chat.googleapis.com/v1/spaces/FOO/messages?key=bar&token=baz",
78 )
79 err := service.Initialize(serviceURL, logger)
80 gomega.Expect(err).NotTo(gomega.HaveOccurred())
81 gomega.Expect(service.Config.GetURL().String()).To(gomega.Equal(serviceURL.String()))
82 })
83 ginkgo.It("is identical after de-/serialization", func() {
84 testURL := "googlechat://chat.googleapis.com/v1/spaces/FOO/messages?key=bar&token=baz"
85 serviceURL := testutils.URLMust(testURL)
86 err := service.Initialize(serviceURL, logger)
87 gomega.Expect(err).NotTo(gomega.HaveOccurred())
88 gomega.Expect(service.Config.GetURL().String()).To(gomega.Equal(testURL))
89 })
90 ginkgo.It("returns an error if key is present but empty", func() {
91 serviceURL := testutils.URLMust(
92 "googlechat://chat.googleapis.com/v1/spaces/FOO/messages?key=&token=baz",
93 )
94 err := service.Initialize(serviceURL, logger)
95 gomega.Expect(err).To(gomega.MatchError("missing field 'key'"))
96 })
97 ginkgo.It("returns an error if token is present but empty", func() {
98 serviceURL := testutils.URLMust(
99 "googlechat://chat.googleapis.com/v1/spaces/FOO/messages?key=bar&token=",
100 )
101 err := service.Initialize(serviceURL, logger)
102 gomega.Expect(err).To(gomega.MatchError("missing field 'token'"))
103 })
104 })
105
106 ginkgo.Describe("sending the payload", func() {
107 ginkgo.BeforeEach(func() {
108 httpmock.Activate()
109
110 service = &googlechat.Service{}
111 service.SetLogger(logger)
112 })
113 ginkgo.AfterEach(func() {
114 httpmock.DeactivateAndReset()
115 })
116 ginkgo.When("sending via webhook URL", func() {
117 ginkgo.It("does not report an error if the server accepts the payload", func() {
118 serviceURL := testutils.URLMust(
119 "googlechat://chat.googleapis.com/v1/spaces/FOO/messages?key=bar&token=baz",
120 )
121 err := service.Initialize(serviceURL, logger)
122 gomega.Expect(err).NotTo(gomega.HaveOccurred())
123 httpmock.RegisterResponder(
124 "POST",
125 "https://chat.googleapis.com/v1/spaces/FOO/messages?key=bar&token=baz",
126 httpmock.NewStringResponder(200, ""),
127 )
128
129 err = service.Send("Message", nil)
130 gomega.Expect(err).NotTo(gomega.HaveOccurred())
131 })
132 ginkgo.It("reports an error if the server rejects the payload", func() {
133 serviceURL := testutils.URLMust(
134 "googlechat://chat.googleapis.com/v1/spaces/FOO/messages?key=bar&token=baz",
135 )
136 err := service.Initialize(serviceURL, logger)
137 gomega.Expect(err).NotTo(gomega.HaveOccurred())
138 httpmock.RegisterResponder(
139 "POST",
140 "https://chat.googleapis.com/v1/spaces/FOO/messages?key=bar&token=baz",
141 httpmock.NewStringResponder(400, "Bad Request"),
142 )
143
144 err = service.Send("Message", nil)
145 gomega.Expect(err).To(gomega.HaveOccurred())
146 })
147 ginkgo.It("marshals the payload correctly with the message", func() {
148 serviceURL := testutils.URLMust(
149 "googlechat://chat.googleapis.com/v1/spaces/FOO/messages?key=bar&token=baz",
150 )
151 err := service.Initialize(serviceURL, logger)
152 gomega.Expect(err).NotTo(gomega.HaveOccurred())
153 httpmock.RegisterResponder(
154 "POST",
155 "https://chat.googleapis.com/v1/spaces/FOO/messages?key=bar&token=baz",
156 func(req *http.Request) (*http.Response, error) {
157 body, err := io.ReadAll(req.Body)
158 gomega.Expect(err).NotTo(gomega.HaveOccurred())
159 gomega.Expect(string(body)).To(gomega.MatchJSON(`{"text":"Test Message"}`))
160
161 return httpmock.NewStringResponse(200, ""), nil
162 },
163 )
164
165 err = service.Send("Test Message", nil)
166 gomega.Expect(err).NotTo(gomega.HaveOccurred())
167 })
168 ginkgo.It("sends the POST request with correct URL and content type", func() {
169 serviceURL := testutils.URLMust(
170 "googlechat://chat.googleapis.com/v1/spaces/FOO/messages?key=bar&token=baz",
171 )
172 err := service.Initialize(serviceURL, logger)
173 gomega.Expect(err).NotTo(gomega.HaveOccurred())
174 httpmock.RegisterResponder(
175 "POST",
176 "https://chat.googleapis.com/v1/spaces/FOO/messages?key=bar&token=baz",
177 func(req *http.Request) (*http.Response, error) {
178 gomega.Expect(req.Method).To(gomega.Equal("POST"))
179 gomega.Expect(req.Header.Get("Content-Type")).
180 To(gomega.Equal("application/json"))
181
182 return httpmock.NewStringResponse(200, ""), nil
183 },
184 )
185
186 err = service.Send("Message", nil)
187 gomega.Expect(err).NotTo(gomega.HaveOccurred())
188 })
189 ginkgo.It("returns marshal error if JSON marshaling fails", func() {
190 // Note: Current JSON struct (string) can't fail marshaling naturally
191 // This test is a placeholder for future complex payload changes
192 serviceURL := testutils.URLMust(
193 "googlechat://chat.googleapis.com/v1/spaces/FOO/messages?key=bar&token=baz",
194 )
195 err := service.Initialize(serviceURL, logger)
196 gomega.Expect(err).NotTo(gomega.HaveOccurred())
197 httpmock.RegisterResponder(
198 "POST",
199 "https://chat.googleapis.com/v1/spaces/FOO/messages?key=bar&token=baz",
200 httpmock.NewStringResponder(200, ""),
201 )
202
203 err = service.Send("Valid Message", nil)
204 gomega.Expect(err).NotTo(gomega.HaveOccurred())
205 })
206 ginkgo.It("returns formatted error if HTTP POST fails", func() {
207 serviceURL := testutils.URLMust(
208 "googlechat://chat.googleapis.com/v1/spaces/FOO/messages?key=bar&token=baz",
209 )
210 err := service.Initialize(serviceURL, logger)
211 gomega.Expect(err).NotTo(gomega.HaveOccurred())
212 httpmock.RegisterResponder(
213 "POST",
214 "https://chat.googleapis.com/v1/spaces/FOO/messages?key=bar&token=baz",
215 httpmock.NewErrorResponder(errors.New("network failure")),
216 )
217
218 err = service.Send("Message", nil)
219 gomega.Expect(err).To(gomega.MatchError(
220 "sending notification to Google Chat: Post \"https://chat.googleapis.com/v1/spaces/FOO/messages?key=bar&token=baz\": network failure",
221 ))
222 })
223 })
224 })
225 })
226
227 // TestGooglechat runs the Ginkgo test suite for the Google Chat package.
228 func TestGooglechat(t *testing.T) {
229 t.Parallel()
230
231 gomega.RegisterFailHandler(ginkgo.Fail)
232 ginkgo.RunSpecs(t, "Shoutrrr Google Chat Suite")
233 }