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
|
package telegram
import (
"fmt"
"log"
"net/url"
"os"
"strings"
"testing"
"github.com/jarcoal/httpmock"
"github.com/onsi/ginkgo/v2"
"github.com/onsi/gomega"
"github.com/nicholas-fedor/shoutrrr/internal/testutils"
)
func TestTelegram(t *testing.T) {
gomega.RegisterFailHandler(ginkgo.Fail)
ginkgo.RunSpecs(t, "Shoutrrr Telegram Suite")
}
var (
envTelegramURL string
logger *log.Logger
_ = ginkgo.BeforeSuite(func() {
envTelegramURL = os.Getenv("SHOUTRRR_TELEGRAM_URL")
logger = log.New(ginkgo.GinkgoWriter, "Test", log.LstdFlags)
})
)
var _ = ginkgo.Describe("the telegram service", func() {
var telegram *Service // No telegram. prefix needed
ginkgo.BeforeEach(func() {
telegram = &Service{}
})
ginkgo.When("running integration tests", func() {
ginkgo.It("should not error out", func() {
if envTelegramURL == "" {
return
}
serviceURL, _ := url.Parse(envTelegramURL)
err := telegram.Initialize(serviceURL, logger)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
err = telegram.Send("This is an integration test Message", nil)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
})
ginkgo.When("given a Message that exceeds the max length", func() {
ginkgo.It("should generate an error", func() {
if envTelegramURL == "" {
return
}
hundredChars := "this string is exactly (to the letter) a hundred characters long which will make the send func error"
serviceURL, _ := url.Parse("telegram://12345:mock-token@telegram/?chats=channel-1")
builder := strings.Builder{}
for range 42 {
builder.WriteString(hundredChars)
}
err := telegram.Initialize(serviceURL, logger)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
err = telegram.Send(builder.String(), nil)
gomega.Expect(err).To(gomega.HaveOccurred())
})
})
ginkgo.When("given a valid request with a faked token", func() {
if envTelegramURL == "" {
return
}
ginkgo.It("should generate a 401", func() {
serviceURL, _ := url.Parse(
"telegram://000000000:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA@telegram/?chats=channel-id",
)
message := "this is a perfectly valid Message"
err := telegram.Initialize(serviceURL, logger)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
err = telegram.Send(message, nil)
gomega.Expect(err).To(gomega.HaveOccurred())
gomega.Expect(strings.Contains(err.Error(), "401 Unauthorized")).To(gomega.BeTrue())
})
})
})
ginkgo.Describe("creating configurations", func() {
ginkgo.When("given an url", func() {
ginkgo.It("should return an error if no arguments where supplied", func() {
expectErrorAndEmptyObject(telegram, "telegram://", logger)
})
ginkgo.It("should return an error if the token has an invalid format", func() {
expectErrorAndEmptyObject(telegram, "telegram://invalid-token", logger)
})
ginkgo.It("should return an error if only the api token where supplied", func() {
expectErrorAndEmptyObject(telegram, "telegram://12345:mock-token@telegram", logger)
})
ginkgo.When("the url is valid", func() {
var config *Config // No telegram. prefix
var err error
ginkgo.BeforeEach(func() {
serviceURL, _ := url.Parse(
"telegram://12345:mock-token@telegram/?chats=channel-1,channel-2,channel-3",
)
err = telegram.Initialize(serviceURL, logger)
config = telegram.GetConfig()
})
ginkgo.It("should create a config object", func() {
gomega.Expect(err).NotTo(gomega.HaveOccurred())
gomega.Expect(config).ToNot(gomega.BeNil())
})
ginkgo.It("should create a config object containing the API Token", func() {
gomega.Expect(err).NotTo(gomega.HaveOccurred())
gomega.Expect(config.Token).To(gomega.Equal("12345:mock-token"))
})
ginkgo.It("should add every chats query field as a chat ID", func() {
gomega.Expect(err).NotTo(gomega.HaveOccurred())
gomega.Expect(config.Chats).To(gomega.Equal([]string{
"channel-1",
"channel-2",
"channel-3",
}))
})
})
})
})
ginkgo.Describe("sending the payload", func() {
var err error
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, _ := url.Parse(
"telegram://12345:mock-token@telegram/?chats=channel-1,channel-2,channel-3",
)
err = telegram.Initialize(serviceURL, logger)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
setupResponder("sendMessage", telegram.GetConfig().Token, 200, "")
err = telegram.Send("Message", nil)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
})
})
ginkgo.It("should implement basic service API methods correctly", func() {
serviceURL, _ := url.Parse("telegram://12345:mock-token@telegram/?chats=channel-1")
err := telegram.Initialize(serviceURL, logger)
gomega.Expect(err).NotTo(gomega.HaveOccurred())
config := telegram.GetConfig()
testutils.TestConfigGetInvalidQueryValue(config)
testutils.TestConfigSetInvalidQueryValue(
config,
"telegram://12345:mock-token@telegram/?chats=channel-1&foo=bar",
)
testutils.TestConfigGetEnumsCount(config, 1)
testutils.TestConfigGetFieldsCount(config, 6)
})
ginkgo.It("should return the correct service ID", func() {
service := &Service{}
gomega.Expect(service.GetID()).To(gomega.Equal("telegram"))
})
})
func expectErrorAndEmptyObject(telegram *Service, rawURL string, logger *log.Logger) {
serviceURL, _ := url.Parse(rawURL)
err := telegram.Initialize(serviceURL, logger)
gomega.Expect(err).To(gomega.HaveOccurred())
config := telegram.GetConfig()
gomega.Expect(config.Token).To(gomega.BeEmpty())
gomega.Expect(config.Chats).To(gomega.BeEmpty())
}
func setupResponder(endpoint string, token string, code int, body string) {
targetURL := fmt.Sprintf("https://api.telegram.org/bot%s/%s", token, endpoint)
httpmock.RegisterResponder("POST", targetURL, httpmock.NewStringResponder(code, body))
}
|
