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
|
package pushover_test
import (
"errors"
"log"
"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/format"
"github.com/nicholas-fedor/shoutrrr/pkg/services/push/pushover"
)
const hookURL = "https://api.pushover.net/1/messages.json"
func TestPushover(t *testing.T) {
gomega.RegisterFailHandler(ginkgo.Fail)
ginkgo.RunSpecs(t, "Pushover Suite")
}
var (
service *pushover.Service
config *pushover.Config
keyResolver format.PropKeyResolver
envPushoverURL *url.URL
logger *log.Logger
_ = ginkgo.BeforeSuite(func() {
service = &pushover.Service{}
logger = log.New(ginkgo.GinkgoWriter, "Test", log.LstdFlags)
envPushoverURL, _ = url.Parse(os.Getenv("SHOUTRRR_PUSHOVER_URL"))
})
)
var _ = ginkgo.Describe("the pushover service", func() {
ginkgo.When("running integration tests", func() {
ginkgo.It("should work", func() {
if envPushoverURL.String() == "" {
return
}
serviceURL, _ := url.Parse(envPushoverURL.String())
err := service.Initialize(serviceURL, testutils.TestLogger())
gomega.Expect(err).NotTo(gomega.HaveOccurred())
err = service.Send("this is an integration test", nil)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
})
ginkgo.It("returns the correct service identifier", func() {
gomega.Expect(service.GetID()).To(gomega.Equal("pushover"))
})
})
})
var _ = ginkgo.Describe("the pushover config", func() {
ginkgo.BeforeEach(func() {
config = &pushover.Config{}
keyResolver = format.NewPropKeyResolver(config)
})
ginkgo.When("updating it using an url", func() {
ginkgo.It("should update the username using the host part of the url", func() {
url := createURL("simme", "dummy")
err := config.SetURL(url)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
gomega.Expect(config.User).To(gomega.Equal("simme"))
})
ginkgo.It("should update the token using the password part of the url", func() {
url := createURL("dummy", "TestToken")
err := config.SetURL(url)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
gomega.Expect(config.Token).To(gomega.Equal("TestToken"))
})
ginkgo.It("should error if supplied with an empty username", func() {
url := createURL("", "token")
expectErrorMessageGivenURL(pushover.UserMissing, url)
})
ginkgo.It("should error if supplied with an empty token", func() {
url := createURL("user", "")
expectErrorMessageGivenURL(pushover.TokenMissing, url)
})
})
ginkgo.When("getting the current config", func() {
ginkgo.It("should return the config that is currently set as an url", func() {
config.User = "simme"
config.Token = "test-token"
url := config.GetURL()
password, _ := url.User.Password()
gomega.Expect(url.Host).To(gomega.Equal(config.User))
gomega.Expect(password).To(gomega.Equal(config.Token))
gomega.Expect(url.Scheme).To(gomega.Equal("pushover"))
})
})
ginkgo.When("setting a config key", func() {
ginkgo.It("should split it by commas if the key is devices", func() {
err := keyResolver.Set("devices", "a,b,c,d")
gomega.Expect(err).NotTo(gomega.HaveOccurred())
gomega.Expect(config.Devices).To(gomega.Equal([]string{"a", "b", "c", "d"}))
})
ginkgo.It("should update priority when a valid number is supplied", func() {
err := keyResolver.Set("priority", "1")
gomega.Expect(err).NotTo(gomega.HaveOccurred())
gomega.Expect(config.Priority).To(gomega.Equal(int8(1)))
})
ginkgo.It("should update priority when a negative number is supplied", func() {
gomega.Expect(keyResolver.Set("priority", "-1")).To(gomega.Succeed())
gomega.Expect(config.Priority).To(gomega.BeEquivalentTo(-1))
gomega.Expect(keyResolver.Set("priority", "-2")).To(gomega.Succeed())
gomega.Expect(config.Priority).To(gomega.BeEquivalentTo(-2))
})
ginkgo.It("should update the title when it is supplied", func() {
err := keyResolver.Set("title", "new title")
gomega.Expect(err).NotTo(gomega.HaveOccurred())
gomega.Expect(config.Title).To(gomega.Equal("new title"))
})
ginkgo.It("should return an error if priority is not a number", func() {
err := keyResolver.Set("priority", "super-duper")
gomega.Expect(err).To(gomega.HaveOccurred())
})
ginkgo.It("should return an error if the key is not recognized", func() {
err := keyResolver.Set("devicey", "a,b,c,d")
gomega.Expect(err).To(gomega.HaveOccurred())
})
})
ginkgo.When("getting a config key", func() {
ginkgo.It("should join it with commas if the key is devices", func() {
config.Devices = []string{"a", "b", "c"}
value, err := keyResolver.Get("devices")
gomega.Expect(err).NotTo(gomega.HaveOccurred())
gomega.Expect(value).To(gomega.Equal("a,b,c"))
})
ginkgo.It("should return an error if the key is not recognized", func() {
_, err := keyResolver.Get("devicey")
gomega.Expect(err).To(gomega.HaveOccurred())
})
})
ginkgo.When("listing the query fields", func() {
ginkgo.It("should return the keys \"devices\",\"priority\",\"title\"", func() {
fields := keyResolver.QueryFields()
gomega.Expect(fields).To(gomega.Equal([]string{"devices", "priority", "title"}))
})
})
ginkgo.Describe("sending the payload", func() {
ginkgo.BeforeEach(func() {
httpmock.Activate()
})
ginkgo.AfterEach(func() {
httpmock.DeactivateAndReset()
})
ginkgo.It("should not report an error if the server accepts the payload", func() {
serviceURL, err := url.Parse("pushover://:apptoken@usertoken")
gomega.Expect(err).NotTo(gomega.HaveOccurred())
err = service.Initialize(serviceURL, logger)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
httpmock.RegisterResponder("POST", hookURL, httpmock.NewStringResponder(200, ""))
err = service.Send("Message", nil)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
})
ginkgo.It("should not panic if an error occurs when sending the payload", func() {
serviceURL, err := url.Parse("pushover://:apptoken@usertoken")
gomega.Expect(err).NotTo(gomega.HaveOccurred())
err = service.Initialize(serviceURL, logger)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
httpmock.RegisterResponder(
"POST",
hookURL,
httpmock.NewErrorResponder(errors.New("dummy error")),
)
err = service.Send("Message", nil)
gomega.Expect(err).To(gomega.HaveOccurred())
})
})
})
func createURL(username string, token string) *url.URL {
return &url.URL{
User: url.UserPassword("Token", token),
Host: username,
}
}
func expectErrorMessageGivenURL(msg pushover.ErrorMessage, url *url.URL) {
err := config.SetURL(url)
gomega.Expect(err).To(gomega.HaveOccurred())
gomega.Expect(err.Error()).To(gomega.Equal(string(msg)))
}
|
