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
|
package googlechat_test
import (
"errors"
"io"
"log"
"net/http"
"net/url"
"os"
"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/services/chat/googlechat"
"github.com/nicholas-fedor/shoutrrr/pkg/types"
)
// TestGooglechat runs the Ginkgo test suite for the Google Chat package.
func TestGooglechat(t *testing.T) {
gomega.RegisterFailHandler(ginkgo.Fail)
ginkgo.RunSpecs(t, "Shoutrrr Google Chat Suite")
}
var (
service *googlechat.Service
logger *log.Logger
envGooglechatURL *url.URL
_ = ginkgo.BeforeSuite(func() {
service = &googlechat.Service{}
logger = log.New(ginkgo.GinkgoWriter, "Test", log.LstdFlags)
var err error
envGooglechatURL, err = url.Parse(os.Getenv("SHOUTRRR_GOOGLECHAT_URL"))
if err != nil {
envGooglechatURL = &url.URL{} // Default to empty URL if parsing fails
}
})
)
var _ = ginkgo.Describe("Google Chat Service", func() {
ginkgo.When("running integration tests", func() {
ginkgo.It("sends a message successfully with a valid ENV URL", func() {
if envGooglechatURL.String() == "" {
ginkgo.Skip("No integration test ENV URL was set")
return
}
serviceURL := testutils.URLMust(envGooglechatURL.String())
err := service.Initialize(serviceURL, testutils.TestLogger())
gomega.Expect(err).NotTo(gomega.HaveOccurred())
err = service.Send("This is an integration test message", nil)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
})
})
ginkgo.Describe("the service", func() {
ginkgo.BeforeEach(func() {
service = &googlechat.Service{}
service.SetLogger(logger)
})
ginkgo.It("implements Service interface", func() {
var impl types.Service = service
gomega.Expect(impl).ToNot(gomega.BeNil())
})
ginkgo.It("returns the correct service identifier", func() {
gomega.Expect(service.GetID()).To(gomega.Equal("googlechat"))
})
})
ginkgo.When("parsing the configuration URL", func() {
ginkgo.BeforeEach(func() {
service = &googlechat.Service{}
service.SetLogger(logger)
})
ginkgo.It("builds a valid Google Chat Incoming Webhook URL", func() {
configURL := testutils.URLMust(
"googlechat://chat.googleapis.com/v1/spaces/FOO/messages?key=bar&token=baz",
)
err := service.Initialize(configURL, logger)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
gomega.Expect(service.Config.GetURL().String()).To(gomega.Equal(configURL.String()))
})
ginkgo.It("is identical after de-/serialization", func() {
testURL := "googlechat://chat.googleapis.com/v1/spaces/FOO/messages?key=bar&token=baz"
serviceURL := testutils.URLMust(testURL)
err := service.Initialize(serviceURL, logger)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
gomega.Expect(service.Config.GetURL().String()).To(gomega.Equal(testURL))
})
ginkgo.It("returns an error if key is present but empty", func() {
configURL := testutils.URLMust(
"googlechat://chat.googleapis.com/v1/spaces/FOO/messages?key=&token=baz",
)
err := service.Initialize(configURL, logger)
gomega.Expect(err).To(gomega.MatchError("missing field 'key'"))
})
ginkgo.It("returns an error if token is present but empty", func() {
configURL := testutils.URLMust(
"googlechat://chat.googleapis.com/v1/spaces/FOO/messages?key=bar&token=",
)
err := service.Initialize(configURL, logger)
gomega.Expect(err).To(gomega.MatchError("missing field 'token'"))
})
})
ginkgo.Describe("sending the payload", func() {
ginkgo.BeforeEach(func() {
httpmock.Activate()
service = &googlechat.Service{}
service.SetLogger(logger)
})
ginkgo.AfterEach(func() {
httpmock.DeactivateAndReset()
})
ginkgo.When("sending via webhook URL", func() {
ginkgo.It("does not report an error if the server accepts the payload", func() {
configURL := testutils.URLMust(
"googlechat://chat.googleapis.com/v1/spaces/FOO/messages?key=bar&token=baz",
)
err := service.Initialize(configURL, logger)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
httpmock.RegisterResponder(
"POST",
"https://chat.googleapis.com/v1/spaces/FOO/messages?key=bar&token=baz",
httpmock.NewStringResponder(200, ""),
)
err = service.Send("Message", nil)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
})
ginkgo.It("reports an error if the server rejects the payload", func() {
configURL := testutils.URLMust(
"googlechat://chat.googleapis.com/v1/spaces/FOO/messages?key=bar&token=baz",
)
err := service.Initialize(configURL, logger)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
httpmock.RegisterResponder(
"POST",
"https://chat.googleapis.com/v1/spaces/FOO/messages?key=bar&token=baz",
httpmock.NewStringResponder(400, "Bad Request"),
)
err = service.Send("Message", nil)
gomega.Expect(err).To(gomega.HaveOccurred())
})
ginkgo.It("marshals the payload correctly with the message", func() {
configURL := testutils.URLMust(
"googlechat://chat.googleapis.com/v1/spaces/FOO/messages?key=bar&token=baz",
)
err := service.Initialize(configURL, logger)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
httpmock.RegisterResponder(
"POST",
"https://chat.googleapis.com/v1/spaces/FOO/messages?key=bar&token=baz",
func(req *http.Request) (*http.Response, error) {
body, err := io.ReadAll(req.Body)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
gomega.Expect(string(body)).To(gomega.MatchJSON(`{"text":"Test Message"}`))
return httpmock.NewStringResponse(200, ""), nil
},
)
err = service.Send("Test Message", nil)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
})
ginkgo.It("sends the POST request with correct URL and content type", func() {
configURL := testutils.URLMust(
"googlechat://chat.googleapis.com/v1/spaces/FOO/messages?key=bar&token=baz",
)
err := service.Initialize(configURL, logger)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
httpmock.RegisterResponder(
"POST",
"https://chat.googleapis.com/v1/spaces/FOO/messages?key=bar&token=baz",
func(req *http.Request) (*http.Response, error) {
gomega.Expect(req.Method).To(gomega.Equal("POST"))
gomega.Expect(req.Header.Get("Content-Type")).
To(gomega.Equal("application/json"))
return httpmock.NewStringResponse(200, ""), nil
},
)
err = service.Send("Message", nil)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
})
ginkgo.It("returns marshal error if JSON marshaling fails", func() {
// Note: Current JSON struct (string) can't fail marshaling naturally
// This test is a placeholder for future complex payload changes
configURL := testutils.URLMust(
"googlechat://chat.googleapis.com/v1/spaces/FOO/messages?key=bar&token=baz",
)
err := service.Initialize(configURL, logger)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
httpmock.RegisterResponder(
"POST",
"https://chat.googleapis.com/v1/spaces/FOO/messages?key=bar&token=baz",
httpmock.NewStringResponder(200, ""),
)
err = service.Send("Valid Message", nil)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
})
ginkgo.It("returns formatted error if HTTP POST fails", func() {
configURL := testutils.URLMust(
"googlechat://chat.googleapis.com/v1/spaces/FOO/messages?key=bar&token=baz",
)
err := service.Initialize(configURL, logger)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
httpmock.RegisterResponder(
"POST",
"https://chat.googleapis.com/v1/spaces/FOO/messages?key=bar&token=baz",
httpmock.NewErrorResponder(errors.New("network failure")),
)
err = service.Send("Message", nil)
gomega.Expect(err).To(gomega.MatchError(
"sending notification to Google Chat: Post \"https://chat.googleapis.com/v1/spaces/FOO/messages?key=bar&token=baz\": network failure",
))
})
})
})
})
|
