Debian Codegraph @

pkg/services/specialized/logger/logger_suite_test.go

raw
1 package logger_test
2
3 import (
4 "log"
5 "testing"
6
7 "github.com/onsi/ginkgo/v2"
8 "github.com/onsi/gomega"
9 "github.com/onsi/gomega/gbytes"
10
11 "github.com/nicholas-fedor/shoutrrr/internal/testutils"
12 "github.com/nicholas-fedor/shoutrrr/pkg/services/specialized/logger"
13 "github.com/nicholas-fedor/shoutrrr/pkg/types"
14 )
15
16 var _ = ginkgo.Describe("the logger service", func() {
17 ginkgo.When("sending a notification", func() {
18 ginkgo.It("should output the message to the log", func() {
19 logbuf := gbytes.NewBuffer()
20 service := &logger.Service{}
21 _ = service.Initialize(testutils.URLMust(`logger://`), log.New(logbuf, "", 0))
22
23 err := service.Send(`Failed - Requires Toaster Repair Level 10`, nil)
24 gomega.Expect(err).NotTo(gomega.HaveOccurred())
25
26 gomega.Eventually(logbuf).
27 Should(gbytes.Say("Failed - Requires Toaster Repair Level 10"))
28 })
29
30 ginkgo.It("should not mutate the passed params", func() {
31 service := &logger.Service{}
32 _ = service.Initialize(testutils.URLMust(`logger://`), nil)
33 params := types.Params{}
34 err := service.Send(`Failed - Requires Toaster Repair Level 10`, &params)
35 gomega.Expect(err).NotTo(gomega.HaveOccurred())
36
37 gomega.Expect(params).To(gomega.BeEmpty())
38 })
39
40 ginkgo.When("a template has been added", func() {
41 ginkgo.It("should render template with params", func() {
42 logbuf := gbytes.NewBuffer()
43 service := &logger.Service{}
44 _ = service.Initialize(testutils.URLMust(`logger://`), log.New(logbuf, "", 0))
45 err := service.SetTemplateString(`message`, `{{.level}}: {{.message}}`)
46 gomega.Expect(err).NotTo(gomega.HaveOccurred())
47
48 params := types.Params{
49 "level": "warning",
50 }
51 err = service.Send(`Requires Toaster Repair Level 10`, &params)
52 gomega.Expect(err).NotTo(gomega.HaveOccurred())
53
54 gomega.Eventually(logbuf).
55 Should(gbytes.Say("warning: Requires Toaster Repair Level 10"))
56 })
57
58 ginkgo.It("should return an error if template execution fails", func() {
59 logbuf := gbytes.NewBuffer()
60 service := &logger.Service{}
61 _ = service.Initialize(testutils.URLMust(`logger://`), log.New(logbuf, "", 0))
62 err := service.SetTemplateString(
63 `message`,
64 `{{range .message}}x{{end}} {{.message}}`,
65 )
66 gomega.Expect(err).NotTo(gomega.HaveOccurred())
67
68 params := types.Params{
69 "level": "error",
70 }
71 err = service.Send(`Critical Failure`, &params)
72 gomega.Expect(err).To(gomega.HaveOccurred())
73 gomega.Expect(err.Error()).
74 To(gomega.ContainSubstring("failed to write template to log"))
75 })
76 })
77 })
78
79 ginkgo.Describe("the config object", func() {
80 ginkgo.It("should return a URL with the correct scheme from GetURL", func() {
81 config := &logger.Config{}
82 url := config.GetURL()
83 gomega.Expect(url.Scheme).To(gomega.Equal("logger"))
84 gomega.Expect(url.String()).To(gomega.Equal("logger://"))
85 })
86
87 ginkgo.It("should not error when SetURL is called with a valid URL", func() {
88 config := &logger.Config{}
89 url := testutils.URLMust(`logger://`)
90 err := config.SetURL(url)
91 gomega.Expect(err).NotTo(gomega.HaveOccurred())
92 })
93 })
94
95 ginkgo.Describe("the service identifier", func() {
96 ginkgo.It("should return the correct ID", func() {
97 service := &logger.Service{}
98 id := service.GetID()
99 gomega.Expect(id).To(gomega.Equal("logger"))
100 })
101 })
102 })
103
104 func TestLogger(t *testing.T) {
105 t.Parallel()
106 gomega.RegisterFailHandler(ginkgo.Fail)
107 ginkgo.RunSpecs(t, "Logger Suite")
108 }