File: pushbullet_test.go

package info (click to toggle)
golang-github-nicholas-fedor-shoutrrr 0.10.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky
  • size: 4,432 kB
  • sloc: sh: 74; makefile: 5
file content (248 lines) | stat: -rw-r--r-- 8,004 bytes parent folder | download | duplicates (2)
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
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
package pushbullet_test

import (
	"errors"
	"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/push/pushbullet"
)

func TestPushbullet(t *testing.T) {
	gomega.RegisterFailHandler(ginkgo.Fail)
	ginkgo.RunSpecs(t, "Shoutrrr Pushbullet Suite")
}

var (
	service          *pushbullet.Service
	envPushbulletURL *url.URL
	_                = ginkgo.BeforeSuite(func() {
		service = &pushbullet.Service{}
		envPushbulletURL, _ = url.Parse(os.Getenv("SHOUTRRR_PUSHBULLET_URL"))
	})
)

var _ = ginkgo.Describe("the pushbullet service", func() {
	ginkgo.When("running integration tests", func() {
		ginkgo.It("should not error out", func() {
			if envPushbulletURL.String() == "" {
				return
			}

			serviceURL, _ := url.Parse(envPushbulletURL.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.It("returns the correct service identifier", func() {
			gomega.Expect(service.GetID()).To(gomega.Equal("pushbullet"))
		})
	})

	ginkgo.Describe("the pushbullet config", func() {
		ginkgo.When("generating a config object", func() {
			ginkgo.It("should set token", func() {
				pushbulletURL, _ := url.Parse("pushbullet://tokentokentokentokentokentokentoke")
				config := pushbullet.Config{}
				err := config.SetURL(pushbulletURL)

				gomega.Expect(config.Token).To(gomega.Equal("tokentokentokentokentokentokentoke"))
				gomega.Expect(err).NotTo(gomega.HaveOccurred())
			})

			ginkgo.It("should set the device from path", func() {
				pushbulletURL, _ := url.Parse(
					"pushbullet://tokentokentokentokentokentokentoke/test",
				)
				config := pushbullet.Config{}
				err := config.SetURL(pushbulletURL)

				gomega.Expect(err).NotTo(gomega.HaveOccurred())
				gomega.Expect(config.Targets).To(gomega.HaveLen(1))
				gomega.Expect(config.Targets).To(gomega.ContainElements("test"))
			})

			ginkgo.It("should set the channel from path", func() {
				pushbulletURL, _ := url.Parse(
					"pushbullet://tokentokentokentokentokentokentoke/foo#bar",
				)
				config := pushbullet.Config{}
				err := config.SetURL(pushbulletURL)

				gomega.Expect(err).NotTo(gomega.HaveOccurred())
				gomega.Expect(config.Targets).To(gomega.HaveLen(2))
				gomega.Expect(config.Targets).To(gomega.ContainElements("foo", "#bar"))
			})
		})

		ginkgo.When("parsing the configuration URL", func() {
			ginkgo.It("should be identical after de-/serialization", func() {
				testURL := "pushbullet://tokentokentokentokentokentokentoke/device?title=Great+News"

				config := &pushbullet.Config{}
				err := config.SetURL(testutils.URLMust(testURL))
				gomega.Expect(err).NotTo(gomega.HaveOccurred(), "verifying")

				outputURL := config.GetURL()
				gomega.Expect(outputURL.String()).To(gomega.Equal(testURL))
			})
		})
	})

	ginkgo.Describe("building the payload", func() {
		ginkgo.It("Email target should only populate one the correct field", func() {
			push := pushbullet.PushRequest{}
			push.SetTarget("iam@email.com")
			gomega.Expect(push.Email).To(gomega.Equal("iam@email.com"))
			gomega.Expect(push.DeviceIden).To(gomega.BeEmpty())
			gomega.Expect(push.ChannelTag).To(gomega.BeEmpty())
		})

		ginkgo.It("Device target should only populate one the correct field", func() {
			push := pushbullet.PushRequest{}
			push.SetTarget("device")
			gomega.Expect(push.Email).To(gomega.BeEmpty())
			gomega.Expect(push.DeviceIden).To(gomega.Equal("device"))
			gomega.Expect(push.ChannelTag).To(gomega.BeEmpty())
		})

		ginkgo.It("Channel target should only populate one the correct field", func() {
			push := pushbullet.PushRequest{}
			push.SetTarget("#channel")
			gomega.Expect(push.Email).To(gomega.BeEmpty())
			gomega.Expect(push.DeviceIden).To(gomega.BeEmpty())
			gomega.Expect(push.ChannelTag).To(gomega.Equal("channel"))
		})
	})

	ginkgo.Describe("sending the payload", func() {
		var err error
		targetURL := "https://api.pushbullet.com/v2/pushes"
		ginkgo.BeforeEach(func() {
			httpmock.Activate()
		})

		ginkgo.AfterEach(func() {
			httpmock.DeactivateAndReset()
		})

		ginkgo.It("should not report an error if the server accepts the payload", func() {
			err = initService()
			gomega.Expect(err).NotTo(gomega.HaveOccurred())

			response := pushbullet.PushResponse{
				Type:   "note",
				Body:   "Message",
				Title:  "Shoutrrr notification", // Matches default
				Active: true,
			}
			responder, _ := httpmock.NewJsonResponder(200, &response)
			httpmock.RegisterResponder("POST", targetURL, responder)

			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() {
			err = initService()
			gomega.Expect(err).NotTo(gomega.HaveOccurred())

			httpmock.RegisterResponder(
				"POST",
				targetURL,
				httpmock.NewErrorResponder(errors.New("")),
			)

			err = service.Send("Message", nil)
			gomega.Expect(err).To(gomega.HaveOccurred())
		})

		ginkgo.It("should return an error if the response type is incorrect", func() {
			err = initService()
			gomega.Expect(err).NotTo(gomega.HaveOccurred())

			response := pushbullet.PushResponse{
				Type:   "link", // Incorrect type
				Body:   "Message",
				Title:  "Shoutrrr notification",
				Active: true,
			}
			responder, _ := httpmock.NewJsonResponder(200, &response)
			httpmock.RegisterResponder("POST", targetURL, responder)

			err = service.Send("Message", nil)
			gomega.Expect(err).To(gomega.HaveOccurred())
			gomega.Expect(err.Error()).To(gomega.ContainSubstring("unexpected response type"))
		})

		ginkgo.It("should return an error if the response body does not match", func() {
			err = initService()
			gomega.Expect(err).NotTo(gomega.HaveOccurred())

			response := pushbullet.PushResponse{
				Type:   "note",
				Body:   "Wrong message",
				Title:  "Shoutrrr notification",
				Active: true,
			}
			responder, _ := httpmock.NewJsonResponder(200, &response)
			httpmock.RegisterResponder("POST", targetURL, responder)

			err = service.Send("Message", nil)
			gomega.Expect(err).To(gomega.HaveOccurred())
			gomega.Expect(err.Error()).To(gomega.ContainSubstring("response body mismatch"))
		})

		ginkgo.It("should return an error if the response title does not match", func() {
			err = initService()
			gomega.Expect(err).NotTo(gomega.HaveOccurred())

			response := pushbullet.PushResponse{
				Type:   "note",
				Body:   "Message",
				Title:  "Wrong Title",
				Active: true,
			}
			responder, _ := httpmock.NewJsonResponder(200, &response)
			httpmock.RegisterResponder("POST", targetURL, responder)

			err = service.Send("Message", nil)
			gomega.Expect(err).To(gomega.HaveOccurred())
			gomega.Expect(err.Error()).To(gomega.ContainSubstring("response title mismatch"))
		})

		ginkgo.It("should return an error if the push is not active", func() {
			err = initService()
			gomega.Expect(err).NotTo(gomega.HaveOccurred())

			response := pushbullet.PushResponse{
				Type:   "note",
				Body:   "Message",
				Title:  "Shoutrrr notification", // Matches default
				Active: false,
			}
			responder, _ := httpmock.NewJsonResponder(200, &response)
			httpmock.RegisterResponder("POST", targetURL, responder)

			err = service.Send("Message", nil)
			gomega.Expect(err).To(gomega.HaveOccurred())
			gomega.Expect(err.Error()).
				To(gomega.ContainSubstring("push notification is not active"))
		})
	})
})

// initService initializes the service with a fixed test configuration.
func initService() error {
	serviceURL, err := url.Parse("pushbullet://tokentokentokentokentokentokentoke/test")
	gomega.ExpectWithOffset(1, err).NotTo(gomega.HaveOccurred())

	return service.Initialize(serviceURL, testutils.TestLogger())
}