Debian Codegraph @

pkg/services/push/pushover/pushover_test.go

raw
1 package pushover_test
2
3 import (
4 "errors"
5 "log"
6 "net/url"
7 "os"
8 "testing"
9
10 "github.com/jarcoal/httpmock"
11 "github.com/onsi/ginkgo/v2"
12 "github.com/onsi/gomega"
13
14 "github.com/nicholas-fedor/shoutrrr/internal/testutils"
15 "github.com/nicholas-fedor/shoutrrr/pkg/format"
16 "github.com/nicholas-fedor/shoutrrr/pkg/services/push/pushover"
17 )
18
19 const hookURL = "https://api.pushover.net/1/messages.json"
20
21 var (
22 service *pushover.Service
23 config *pushover.Config
24 keyResolver format.PropKeyResolver
25 envPushoverURL *url.URL
26 logger *log.Logger
27 _ = ginkgo.BeforeSuite(func() {
28 service = &pushover.Service{}
29 logger = log.New(ginkgo.GinkgoWriter, "Test", log.LstdFlags)
30 envPushoverURL, _ = url.Parse(os.Getenv("SHOUTRRR_PUSHOVER_URL"))
31 })
32 )
33
34 var _ = ginkgo.Describe("the pushover service", func() {
35 ginkgo.When("running integration tests", func() {
36 ginkgo.It("should work", func() {
37 if envPushoverURL.String() == "" {
38 return
39 }
40
41 serviceURL, _ := url.Parse(envPushoverURL.String())
42 err := service.Initialize(serviceURL, testutils.TestLogger())
43 gomega.Expect(err).NotTo(gomega.HaveOccurred())
44 err = service.Send("this is an integration test", nil)
45 gomega.Expect(err).NotTo(gomega.HaveOccurred())
46 })
47 ginkgo.It("returns the correct service identifier", func() {
48 gomega.Expect(service.GetID()).To(gomega.Equal("pushover"))
49 })
50 })
51 })
52
53 var _ = ginkgo.Describe("the pushover config", func() {
54 ginkgo.BeforeEach(func() {
55 config = &pushover.Config{}
56 keyResolver = format.NewPropKeyResolver(config)
57 })
58 ginkgo.When("updating it using an url", func() {
59 ginkgo.It("should update the username using the host part of the url", func() {
60 url := createURL("simme", "dummy")
61 err := config.SetURL(url)
62 gomega.Expect(err).NotTo(gomega.HaveOccurred())
63 gomega.Expect(config.User).To(gomega.Equal("simme"))
64 })
65 ginkgo.It("should update the token using the password part of the url", func() {
66 url := createURL("dummy", "TestToken")
67 err := config.SetURL(url)
68 gomega.Expect(err).NotTo(gomega.HaveOccurred())
69 gomega.Expect(config.Token).To(gomega.Equal("TestToken"))
70 })
71 ginkgo.It("should error if supplied with an empty username", func() {
72 url := createURL("", "token")
73 expectErrorGivenURL(pushover.ErrUserMissing, url)
74 })
75 ginkgo.It("should error if supplied with an empty token", func() {
76 url := createURL("user", "")
77 expectErrorGivenURL(pushover.ErrTokenMissing, url)
78 })
79 })
80 ginkgo.When("getting the current config", func() {
81 ginkgo.It("should return the config that is currently set as an url", func() {
82 config.User = "simme"
83 config.Token = "test-token"
84
85 url := config.GetURL()
86 password, _ := url.User.Password()
87 gomega.Expect(url.Host).To(gomega.Equal(config.User))
88 gomega.Expect(password).To(gomega.Equal(config.Token))
89 gomega.Expect(url.Scheme).To(gomega.Equal("pushover"))
90 })
91 })
92 ginkgo.When("setting a config key", func() {
93 ginkgo.It("should split it by commas if the key is devices", func() {
94 err := keyResolver.Set("devices", "a,b,c,d")
95 gomega.Expect(err).NotTo(gomega.HaveOccurred())
96 gomega.Expect(config.Devices).To(gomega.Equal([]string{"a", "b", "c", "d"}))
97 })
98 ginkgo.It("should update priority when a valid number is supplied", func() {
99 err := keyResolver.Set("priority", "1")
100 gomega.Expect(err).NotTo(gomega.HaveOccurred())
101 gomega.Expect(config.Priority).To(gomega.Equal(int8(1)))
102 })
103 ginkgo.It("should update priority when a negative number is supplied", func() {
104 gomega.Expect(keyResolver.Set("priority", "-1")).To(gomega.Succeed())
105 gomega.Expect(config.Priority).To(gomega.BeEquivalentTo(-1))
106
107 gomega.Expect(keyResolver.Set("priority", "-2")).To(gomega.Succeed())
108 gomega.Expect(config.Priority).To(gomega.BeEquivalentTo(-2))
109 })
110 ginkgo.It("should update the title when it is supplied", func() {
111 err := keyResolver.Set("title", "new title")
112 gomega.Expect(err).NotTo(gomega.HaveOccurred())
113 gomega.Expect(config.Title).To(gomega.Equal("new title"))
114 })
115 ginkgo.It("should return an error if priority is not a number", func() {
116 err := keyResolver.Set("priority", "super-duper")
117 gomega.Expect(err).To(gomega.HaveOccurred())
118 })
119 ginkgo.It("should return an error if the key is not recognized", func() {
120 err := keyResolver.Set("devicey", "a,b,c,d")
121 gomega.Expect(err).To(gomega.HaveOccurred())
122 })
123 })
124 ginkgo.When("getting a config key", func() {
125 ginkgo.It("should join it with commas if the key is devices", func() {
126 config.Devices = []string{"a", "b", "c"}
127 value, err := keyResolver.Get("devices")
128 gomega.Expect(err).NotTo(gomega.HaveOccurred())
129 gomega.Expect(value).To(gomega.Equal("a,b,c"))
130 })
131 ginkgo.It("should return an error if the key is not recognized", func() {
132 _, err := keyResolver.Get("devicey")
133 gomega.Expect(err).To(gomega.HaveOccurred())
134 })
135 })
136
137 ginkgo.When("listing the query fields", func() {
138 ginkgo.It("should return the keys \"devices\",\"priority\",\"title\"", func() {
139 fields := keyResolver.QueryFields()
140 gomega.Expect(fields).To(gomega.Equal([]string{"devices", "priority", "title"}))
141 })
142 })
143
144 ginkgo.Describe("sending the payload", func() {
145 ginkgo.BeforeEach(func() {
146 httpmock.Activate()
147 })
148 ginkgo.AfterEach(func() {
149 httpmock.DeactivateAndReset()
150 })
151 ginkgo.It("should not report an error if the server accepts the payload", func() {
152 serviceURL, err := url.Parse("pushover://:apptoken@usertoken")
153 gomega.Expect(err).NotTo(gomega.HaveOccurred())
154
155 err = service.Initialize(serviceURL, logger)
156 gomega.Expect(err).NotTo(gomega.HaveOccurred())
157
158 httpmock.RegisterResponder("POST", hookURL, httpmock.NewStringResponder(200, ""))
159
160 err = service.Send("Message", nil)
161 gomega.Expect(err).NotTo(gomega.HaveOccurred())
162 })
163 ginkgo.It("should not panic if an error occurs when sending the payload", func() {
164 serviceURL, err := url.Parse("pushover://:apptoken@usertoken")
165 gomega.Expect(err).NotTo(gomega.HaveOccurred())
166
167 err = service.Initialize(serviceURL, logger)
168 gomega.Expect(err).NotTo(gomega.HaveOccurred())
169
170 httpmock.RegisterResponder(
171 "POST",
172 hookURL,
173 httpmock.NewErrorResponder(errors.New("dummy error")),
174 )
175
176 err = service.Send("Message", nil)
177 gomega.Expect(err).To(gomega.HaveOccurred())
178 })
179 })
180 })
181
182 func TestPushover(t *testing.T) {
183 t.Parallel()
184 gomega.RegisterFailHandler(ginkgo.Fail)
185 ginkgo.RunSpecs(t, "Pushover Suite")
186 }
187
188 func createURL(username, token string) *url.URL {
189 return &url.URL{
190 User: url.UserPassword("Token", token),
191 Host: username,
192 }
193 }
194
195 func expectErrorGivenURL(expectedErr error, serviceURL *url.URL) {
196 err := config.SetURL(serviceURL)
197 gomega.Expect(err).To(gomega.HaveOccurred())
198 gomega.Expect(err.Error()).To(gomega.Equal(expectedErr.Error()))
199 }