server_test.go 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730
  1. package server
  2. import (
  3. "bufio"
  4. "context"
  5. "encoding/json"
  6. "firebase.google.com/go/messaging"
  7. "fmt"
  8. "github.com/stretchr/testify/require"
  9. "net/http"
  10. "net/http/httptest"
  11. "os"
  12. "path/filepath"
  13. "strings"
  14. "sync"
  15. "testing"
  16. "time"
  17. )
  18. func TestServer_PublishAndPoll(t *testing.T) {
  19. s := newTestServer(t, newTestConfig(t))
  20. response1 := request(t, s, "PUT", "/mytopic", "my first message", nil)
  21. msg1 := toMessage(t, response1.Body.String())
  22. require.NotEmpty(t, msg1.ID)
  23. require.Equal(t, "my first message", msg1.Message)
  24. response2 := request(t, s, "PUT", "/mytopic", "my second\n\nmessage", nil)
  25. msg2 := toMessage(t, response2.Body.String())
  26. require.NotEqual(t, msg1.ID, msg2.ID)
  27. require.NotEmpty(t, msg2.ID)
  28. require.Equal(t, "my second\n\nmessage", msg2.Message)
  29. response := request(t, s, "GET", "/mytopic/json?poll=1", "", nil)
  30. messages := toMessages(t, response.Body.String())
  31. require.Equal(t, 2, len(messages))
  32. require.Equal(t, "my first message", messages[0].Message)
  33. require.Equal(t, "my second\n\nmessage", messages[1].Message)
  34. response = request(t, s, "GET", "/mytopic/sse?poll=1&since=all", "", nil)
  35. lines := strings.Split(strings.TrimSpace(response.Body.String()), "\n")
  36. require.Equal(t, 3, len(lines))
  37. require.Equal(t, "my first message", toMessage(t, strings.TrimPrefix(lines[0], "data: ")).Message)
  38. require.Equal(t, "", lines[1])
  39. require.Equal(t, "my second\n\nmessage", toMessage(t, strings.TrimPrefix(lines[2], "data: ")).Message)
  40. response = request(t, s, "GET", "/mytopic/raw?poll=1", "", nil)
  41. lines = strings.Split(strings.TrimSpace(response.Body.String()), "\n")
  42. require.Equal(t, 2, len(lines))
  43. require.Equal(t, "my first message", lines[0])
  44. require.Equal(t, "my second message", lines[1]) // \n -> " "
  45. }
  46. func TestServer_SubscribeOpenAndKeepalive(t *testing.T) {
  47. c := newTestConfig(t)
  48. c.KeepaliveInterval = time.Second
  49. s := newTestServer(t, c)
  50. rr := httptest.NewRecorder()
  51. ctx, cancel := context.WithCancel(context.Background())
  52. req, err := http.NewRequestWithContext(ctx, "GET", "/mytopic/json", nil)
  53. if err != nil {
  54. t.Fatal(err)
  55. }
  56. doneChan := make(chan bool)
  57. go func() {
  58. s.handle(rr, req)
  59. doneChan <- true
  60. }()
  61. time.Sleep(1300 * time.Millisecond)
  62. cancel()
  63. <-doneChan
  64. messages := toMessages(t, rr.Body.String())
  65. require.Equal(t, 2, len(messages))
  66. require.Equal(t, openEvent, messages[0].Event)
  67. require.Equal(t, "mytopic", messages[0].Topic)
  68. require.Equal(t, "", messages[0].Message)
  69. require.Equal(t, "", messages[0].Title)
  70. require.Equal(t, 0, messages[0].Priority)
  71. require.Nil(t, messages[0].Tags)
  72. require.Equal(t, keepaliveEvent, messages[1].Event)
  73. require.Equal(t, "mytopic", messages[1].Topic)
  74. require.Equal(t, "", messages[1].Message)
  75. require.Equal(t, "", messages[1].Title)
  76. require.Equal(t, 0, messages[1].Priority)
  77. require.Nil(t, messages[1].Tags)
  78. }
  79. func TestServer_PublishAndSubscribe(t *testing.T) {
  80. s := newTestServer(t, newTestConfig(t))
  81. subscribeRR := httptest.NewRecorder()
  82. subscribeCancel := subscribe(t, s, "/mytopic/json", subscribeRR)
  83. publishFirstRR := request(t, s, "PUT", "/mytopic", "my first message", nil)
  84. require.Equal(t, 200, publishFirstRR.Code)
  85. publishSecondRR := request(t, s, "PUT", "/mytopic", "my other message", map[string]string{
  86. "Title": " This is a title ",
  87. "X-Tags": "tag1,tag 2, tag3",
  88. "p": "1",
  89. })
  90. require.Equal(t, 200, publishSecondRR.Code)
  91. subscribeCancel()
  92. messages := toMessages(t, subscribeRR.Body.String())
  93. require.Equal(t, 3, len(messages))
  94. require.Equal(t, openEvent, messages[0].Event)
  95. require.Equal(t, messageEvent, messages[1].Event)
  96. require.Equal(t, "mytopic", messages[1].Topic)
  97. require.Equal(t, "my first message", messages[1].Message)
  98. require.Equal(t, "", messages[1].Title)
  99. require.Equal(t, 0, messages[1].Priority)
  100. require.Nil(t, messages[1].Tags)
  101. require.Equal(t, messageEvent, messages[2].Event)
  102. require.Equal(t, "mytopic", messages[2].Topic)
  103. require.Equal(t, "my other message", messages[2].Message)
  104. require.Equal(t, "This is a title", messages[2].Title)
  105. require.Equal(t, 1, messages[2].Priority)
  106. require.Equal(t, []string{"tag1", "tag 2", "tag3"}, messages[2].Tags)
  107. }
  108. func TestServer_StaticSites(t *testing.T) {
  109. s := newTestServer(t, newTestConfig(t))
  110. rr := request(t, s, "GET", "/", "", nil)
  111. require.Equal(t, 200, rr.Code)
  112. require.Contains(t, rr.Body.String(), "</html>")
  113. rr = request(t, s, "HEAD", "/", "", nil)
  114. require.Equal(t, 200, rr.Code)
  115. rr = request(t, s, "OPTIONS", "/", "", nil)
  116. require.Equal(t, 200, rr.Code)
  117. rr = request(t, s, "GET", "/does-not-exist.txt", "", nil)
  118. require.Equal(t, 404, rr.Code)
  119. rr = request(t, s, "GET", "/mytopic", "", nil)
  120. require.Equal(t, 200, rr.Code)
  121. require.Contains(t, rr.Body.String(), `<meta name="robots" content="noindex, nofollow" />`)
  122. rr = request(t, s, "GET", "/static/css/app.css", "", nil)
  123. require.Equal(t, 200, rr.Code)
  124. require.Contains(t, rr.Body.String(), `html, body {`)
  125. rr = request(t, s, "GET", "/docs", "", nil)
  126. require.Equal(t, 301, rr.Code)
  127. rr = request(t, s, "GET", "/docs/", "", nil)
  128. require.Equal(t, 200, rr.Code)
  129. require.Contains(t, rr.Body.String(), `Made with ❤️ by Philipp C. Heckel`)
  130. require.Contains(t, rr.Body.String(), `<script src=static/js/extra.js></script>`)
  131. rr = request(t, s, "GET", "/example.html", "", nil)
  132. require.Equal(t, 200, rr.Code)
  133. require.Contains(t, rr.Body.String(), "</html>")
  134. }
  135. func TestServer_PublishLargeMessage(t *testing.T) {
  136. s := newTestServer(t, newTestConfig(t))
  137. body := strings.Repeat("this is a large message", 5000)
  138. truncated := body[0:4096]
  139. response := request(t, s, "PUT", "/mytopic", body, nil)
  140. msg := toMessage(t, response.Body.String())
  141. require.NotEmpty(t, msg.ID)
  142. require.Equal(t, truncated, msg.Message)
  143. require.Equal(t, 4096, len(msg.Message))
  144. response = request(t, s, "GET", "/mytopic/json?poll=1", "", nil)
  145. messages := toMessages(t, response.Body.String())
  146. require.Equal(t, 1, len(messages))
  147. require.Equal(t, truncated, messages[0].Message)
  148. }
  149. func TestServer_PublishPriority(t *testing.T) {
  150. s := newTestServer(t, newTestConfig(t))
  151. for prio := 1; prio <= 5; prio++ {
  152. response := request(t, s, "GET", fmt.Sprintf("/mytopic/publish?priority=%d", prio), fmt.Sprintf("priority %d", prio), nil)
  153. msg := toMessage(t, response.Body.String())
  154. require.Equal(t, prio, msg.Priority)
  155. }
  156. response := request(t, s, "GET", "/mytopic/publish?priority=min", "test", nil)
  157. require.Equal(t, 1, toMessage(t, response.Body.String()).Priority)
  158. response = request(t, s, "GET", "/mytopic/send?priority=low", "test", nil)
  159. require.Equal(t, 2, toMessage(t, response.Body.String()).Priority)
  160. response = request(t, s, "GET", "/mytopic/send?priority=default", "test", nil)
  161. require.Equal(t, 3, toMessage(t, response.Body.String()).Priority)
  162. response = request(t, s, "GET", "/mytopic/send?priority=high", "test", nil)
  163. require.Equal(t, 4, toMessage(t, response.Body.String()).Priority)
  164. response = request(t, s, "GET", "/mytopic/send?priority=max", "test", nil)
  165. require.Equal(t, 5, toMessage(t, response.Body.String()).Priority)
  166. response = request(t, s, "GET", "/mytopic/trigger?priority=urgent", "test", nil)
  167. require.Equal(t, 5, toMessage(t, response.Body.String()).Priority)
  168. }
  169. func TestServer_PublishNoCache(t *testing.T) {
  170. s := newTestServer(t, newTestConfig(t))
  171. response := request(t, s, "PUT", "/mytopic", "this message is not cached", map[string]string{
  172. "Cache": "no",
  173. })
  174. msg := toMessage(t, response.Body.String())
  175. require.NotEmpty(t, msg.ID)
  176. require.Equal(t, "this message is not cached", msg.Message)
  177. response = request(t, s, "GET", "/mytopic/json?poll=1", "", nil)
  178. messages := toMessages(t, response.Body.String())
  179. require.Empty(t, messages)
  180. }
  181. func TestServer_PublishAt(t *testing.T) {
  182. c := newTestConfig(t)
  183. c.MinDelay = time.Second
  184. c.AtSenderInterval = 100 * time.Millisecond
  185. s := newTestServer(t, c)
  186. response := request(t, s, "PUT", "/mytopic", "a message", map[string]string{
  187. "In": "1s",
  188. })
  189. require.Equal(t, 200, response.Code)
  190. response = request(t, s, "GET", "/mytopic/json?poll=1", "", nil)
  191. messages := toMessages(t, response.Body.String())
  192. require.Equal(t, 0, len(messages))
  193. time.Sleep(time.Second)
  194. require.Nil(t, s.sendDelayedMessages())
  195. response = request(t, s, "GET", "/mytopic/json?poll=1", "", nil)
  196. messages = toMessages(t, response.Body.String())
  197. require.Equal(t, 1, len(messages))
  198. require.Equal(t, "a message", messages[0].Message)
  199. }
  200. func TestServer_PublishAtWithCacheError(t *testing.T) {
  201. s := newTestServer(t, newTestConfig(t))
  202. response := request(t, s, "PUT", "/mytopic", "a message", map[string]string{
  203. "Cache": "no",
  204. "In": "30 min",
  205. })
  206. require.Equal(t, 400, response.Code)
  207. require.Equal(t, errHTTPBadRequestDelayNoCache, toHTTPError(t, response.Body.String()))
  208. }
  209. func TestServer_PublishAtTooShortDelay(t *testing.T) {
  210. s := newTestServer(t, newTestConfig(t))
  211. response := request(t, s, "PUT", "/mytopic", "a message", map[string]string{
  212. "In": "1s",
  213. })
  214. require.Equal(t, 400, response.Code)
  215. }
  216. func TestServer_PublishAtTooLongDelay(t *testing.T) {
  217. s := newTestServer(t, newTestConfig(t))
  218. response := request(t, s, "PUT", "/mytopic", "a message", map[string]string{
  219. "In": "99999999h",
  220. })
  221. require.Equal(t, 400, response.Code)
  222. }
  223. func TestServer_PublishAtAndPrune(t *testing.T) {
  224. s := newTestServer(t, newTestConfig(t))
  225. response := request(t, s, "PUT", "/mytopic", "a message", map[string]string{
  226. "In": "1h",
  227. })
  228. require.Equal(t, 200, response.Code)
  229. s.updateStatsAndPrune() // Fire pruning
  230. response = request(t, s, "GET", "/mytopic/json?poll=1&scheduled=1", "", nil)
  231. messages := toMessages(t, response.Body.String())
  232. require.Equal(t, 1, len(messages)) // Not affected by pruning
  233. require.Equal(t, "a message", messages[0].Message)
  234. }
  235. func TestServer_PublishAndMultiPoll(t *testing.T) {
  236. s := newTestServer(t, newTestConfig(t))
  237. response := request(t, s, "PUT", "/mytopic1", "message 1", nil)
  238. msg := toMessage(t, response.Body.String())
  239. require.NotEmpty(t, msg.ID)
  240. require.Equal(t, "mytopic1", msg.Topic)
  241. require.Equal(t, "message 1", msg.Message)
  242. response = request(t, s, "PUT", "/mytopic2", "message 2", nil)
  243. msg = toMessage(t, response.Body.String())
  244. require.NotEmpty(t, msg.ID)
  245. require.Equal(t, "mytopic2", msg.Topic)
  246. require.Equal(t, "message 2", msg.Message)
  247. response = request(t, s, "GET", "/mytopic1/json?poll=1", "", nil)
  248. messages := toMessages(t, response.Body.String())
  249. require.Equal(t, 1, len(messages))
  250. require.Equal(t, "mytopic1", messages[0].Topic)
  251. require.Equal(t, "message 1", messages[0].Message)
  252. response = request(t, s, "GET", "/mytopic1,mytopic2/json?poll=1", "", nil)
  253. messages = toMessages(t, response.Body.String())
  254. require.Equal(t, 2, len(messages))
  255. require.Equal(t, "mytopic1", messages[0].Topic)
  256. require.Equal(t, "message 1", messages[0].Message)
  257. require.Equal(t, "mytopic2", messages[1].Topic)
  258. require.Equal(t, "message 2", messages[1].Message)
  259. }
  260. func TestServer_PublishWithNopCache(t *testing.T) {
  261. c := newTestConfig(t)
  262. c.CacheDuration = 0
  263. s := newTestServer(t, c)
  264. subscribeRR := httptest.NewRecorder()
  265. subscribeCancel := subscribe(t, s, "/mytopic/json", subscribeRR)
  266. publishRR := request(t, s, "PUT", "/mytopic", "my first message", nil)
  267. require.Equal(t, 200, publishRR.Code)
  268. subscribeCancel()
  269. messages := toMessages(t, subscribeRR.Body.String())
  270. require.Equal(t, 2, len(messages))
  271. require.Equal(t, openEvent, messages[0].Event)
  272. require.Equal(t, messageEvent, messages[1].Event)
  273. require.Equal(t, "my first message", messages[1].Message)
  274. response := request(t, s, "GET", "/mytopic/json?poll=1", "", nil)
  275. messages = toMessages(t, response.Body.String())
  276. require.Empty(t, messages)
  277. }
  278. func TestServer_PublishAndPollSince(t *testing.T) {
  279. s := newTestServer(t, newTestConfig(t))
  280. request(t, s, "PUT", "/mytopic", "test 1", nil)
  281. time.Sleep(1100 * time.Millisecond)
  282. since := time.Now().Unix()
  283. request(t, s, "PUT", "/mytopic", "test 2", nil)
  284. response := request(t, s, "GET", fmt.Sprintf("/mytopic/json?poll=1&since=%d", since), "", nil)
  285. messages := toMessages(t, response.Body.String())
  286. require.Equal(t, 1, len(messages))
  287. require.Equal(t, "test 2", messages[0].Message)
  288. }
  289. func TestServer_PublishViaGET(t *testing.T) {
  290. s := newTestServer(t, newTestConfig(t))
  291. response := request(t, s, "GET", "/mytopic/trigger", "", nil)
  292. msg := toMessage(t, response.Body.String())
  293. require.NotEmpty(t, msg.ID)
  294. require.Equal(t, "triggered", msg.Message)
  295. response = request(t, s, "GET", "/mytopic/send?message=This+is+a+test&t=This+is+a+title&tags=skull&x-priority=5&delay=24h", "", nil)
  296. msg = toMessage(t, response.Body.String())
  297. require.NotEmpty(t, msg.ID)
  298. require.Equal(t, "This is a test", msg.Message)
  299. require.Equal(t, "This is a title", msg.Title)
  300. require.Equal(t, []string{"skull"}, msg.Tags)
  301. require.Equal(t, 5, msg.Priority)
  302. require.Greater(t, msg.Time, time.Now().Add(23*time.Hour).Unix())
  303. }
  304. func TestServer_PublishFirebase(t *testing.T) {
  305. // This is unfortunately not much of a test, since it merely fires the messages towards Firebase,
  306. // but cannot re-read them. There is no way from Go to read the messages back, or even get an error back.
  307. // I tried everything. I already had written the test, and it increases the code coverage, so I'll leave it ... :shrug: ...
  308. c := newTestConfig(t)
  309. c.FirebaseKeyFile = firebaseServiceAccountFile(t) // May skip the test!
  310. s := newTestServer(t, c)
  311. // Normal message
  312. response := request(t, s, "PUT", "/mytopic", "This is a message for firebase", nil)
  313. msg := toMessage(t, response.Body.String())
  314. require.NotEmpty(t, msg.ID)
  315. // Keepalive message
  316. require.Nil(t, s.firebase(newKeepaliveMessage(firebaseControlTopic)))
  317. time.Sleep(500 * time.Millisecond) // Time for sends
  318. }
  319. func TestServer_PollWithQueryFilters(t *testing.T) {
  320. s := newTestServer(t, newTestConfig(t))
  321. response := request(t, s, "PUT", "/mytopic?priority=1&tags=tag1,tag2", "my first message", nil)
  322. msg := toMessage(t, response.Body.String())
  323. require.NotEmpty(t, msg.ID)
  324. response = request(t, s, "PUT", "/mytopic?title=a+title", "my second message", map[string]string{
  325. "Tags": "tag2,tag3",
  326. })
  327. msg = toMessage(t, response.Body.String())
  328. require.NotEmpty(t, msg.ID)
  329. queriesThatShouldReturnMessageOne := []string{
  330. "/mytopic/json?poll=1&priority=1",
  331. "/mytopic/json?poll=1&priority=min",
  332. "/mytopic/json?poll=1&priority=min,low",
  333. "/mytopic/json?poll=1&priority=1,2",
  334. "/mytopic/json?poll=1&p=2,min",
  335. "/mytopic/json?poll=1&tags=tag1",
  336. "/mytopic/json?poll=1&tags=tag1,tag2",
  337. "/mytopic/json?poll=1&message=my+first+message",
  338. }
  339. for _, query := range queriesThatShouldReturnMessageOne {
  340. response = request(t, s, "GET", query, "", nil)
  341. messages := toMessages(t, response.Body.String())
  342. require.Equal(t, 1, len(messages), "Query failed: "+query)
  343. require.Equal(t, "my first message", messages[0].Message, "Query failed: "+query)
  344. }
  345. queriesThatShouldReturnMessageTwo := []string{
  346. "/mytopic/json?poll=1&x-priority=3", // !
  347. "/mytopic/json?poll=1&priority=3",
  348. "/mytopic/json?poll=1&priority=default",
  349. "/mytopic/json?poll=1&p=3",
  350. "/mytopic/json?poll=1&x-tags=tag2,tag3",
  351. "/mytopic/json?poll=1&tags=tag2,tag3",
  352. "/mytopic/json?poll=1&tag=tag2,tag3",
  353. "/mytopic/json?poll=1&ta=tag2,tag3",
  354. "/mytopic/json?poll=1&x-title=a+title",
  355. "/mytopic/json?poll=1&title=a+title",
  356. "/mytopic/json?poll=1&t=a+title",
  357. "/mytopic/json?poll=1&x-message=my+second+message",
  358. "/mytopic/json?poll=1&message=my+second+message",
  359. "/mytopic/json?poll=1&m=my+second+message",
  360. "/mytopic/json?x-poll=1&m=my+second+message",
  361. "/mytopic/json?po=1&m=my+second+message",
  362. }
  363. for _, query := range queriesThatShouldReturnMessageTwo {
  364. response = request(t, s, "GET", query, "", nil)
  365. messages := toMessages(t, response.Body.String())
  366. require.Equal(t, 1, len(messages), "Query failed: "+query)
  367. require.Equal(t, "my second message", messages[0].Message, "Query failed: "+query)
  368. }
  369. queriesThatShouldReturnNoMessages := []string{
  370. "/mytopic/json?poll=1&priority=4",
  371. "/mytopic/json?poll=1&tags=tag1,tag2,tag3",
  372. "/mytopic/json?poll=1&title=another+title",
  373. "/mytopic/json?poll=1&message=my+third+message",
  374. "/mytopic/json?poll=1&message=my+third+message",
  375. }
  376. for _, query := range queriesThatShouldReturnNoMessages {
  377. response = request(t, s, "GET", query, "", nil)
  378. messages := toMessages(t, response.Body.String())
  379. require.Equal(t, 0, len(messages), "Query failed: "+query)
  380. }
  381. }
  382. func TestServer_SubscribeWithQueryFilters(t *testing.T) {
  383. c := newTestConfig(t)
  384. c.KeepaliveInterval = 800 * time.Millisecond
  385. s := newTestServer(t, c)
  386. subscribeResponse := httptest.NewRecorder()
  387. subscribeCancel := subscribe(t, s, "/mytopic/json?tags=zfs-issue", subscribeResponse)
  388. response := request(t, s, "PUT", "/mytopic", "my first message", nil)
  389. require.Equal(t, 200, response.Code)
  390. response = request(t, s, "PUT", "/mytopic", "ZFS scrub failed", map[string]string{
  391. "Tags": "zfs-issue,zfs-scrub",
  392. })
  393. require.Equal(t, 200, response.Code)
  394. time.Sleep(850 * time.Millisecond)
  395. subscribeCancel()
  396. messages := toMessages(t, subscribeResponse.Body.String())
  397. require.Equal(t, 3, len(messages))
  398. require.Equal(t, openEvent, messages[0].Event)
  399. require.Equal(t, messageEvent, messages[1].Event)
  400. require.Equal(t, "ZFS scrub failed", messages[1].Message)
  401. require.Equal(t, keepaliveEvent, messages[2].Event)
  402. }
  403. /*
  404. func TestServer_Curl_Publish_Poll(t *testing.T) {
  405. s, port := test.StartServer(t)
  406. defer test.StopServer(t, s, port)
  407. cmd := exec.Command("sh", "-c", fmt.Sprintf(`curl -sd "This is a test" localhost:%d/mytopic`, port))
  408. require.Nil(t, cmd.Run())
  409. b, err := cmd.CombinedOutput()
  410. require.Nil(t, err)
  411. msg := toMessage(t, string(b))
  412. require.Equal(t, "This is a test", msg.Message)
  413. cmd = exec.Command("sh", "-c", fmt.Sprintf(`curl "localhost:%d/mytopic?poll=1"`, port))
  414. require.Nil(t, cmd.Run())
  415. b, err = cmd.CombinedOutput()
  416. require.Nil(t, err)
  417. msg = toMessage(t, string(b))
  418. require.Equal(t, "This is a test", msg.Message)
  419. }
  420. */
  421. type testMailer struct {
  422. count int
  423. mu sync.Mutex
  424. }
  425. func (t *testMailer) Send(from, to string, m *message) error {
  426. t.mu.Lock()
  427. defer t.mu.Unlock()
  428. t.count++
  429. return nil
  430. }
  431. func TestServer_PublishTooManyEmails_Defaults(t *testing.T) {
  432. s := newTestServer(t, newTestConfig(t))
  433. s.mailer = &testMailer{}
  434. for i := 0; i < 16; i++ {
  435. response := request(t, s, "PUT", "/mytopic", fmt.Sprintf("message %d", i), map[string]string{
  436. "E-Mail": "test@example.com",
  437. })
  438. require.Equal(t, 200, response.Code)
  439. }
  440. response := request(t, s, "PUT", "/mytopic", "one too many", map[string]string{
  441. "E-Mail": "test@example.com",
  442. })
  443. require.Equal(t, 429, response.Code)
  444. }
  445. func TestServer_PublishTooManyEmails_Replenish(t *testing.T) {
  446. c := newTestConfig(t)
  447. c.VisitorEmailLimitReplenish = 500 * time.Millisecond
  448. s := newTestServer(t, c)
  449. s.mailer = &testMailer{}
  450. for i := 0; i < 16; i++ {
  451. response := request(t, s, "PUT", "/mytopic", fmt.Sprintf("message %d", i), map[string]string{
  452. "E-Mail": "test@example.com",
  453. })
  454. require.Equal(t, 200, response.Code)
  455. }
  456. response := request(t, s, "PUT", "/mytopic", "one too many", map[string]string{
  457. "E-Mail": "test@example.com",
  458. })
  459. require.Equal(t, 429, response.Code)
  460. time.Sleep(510 * time.Millisecond)
  461. response = request(t, s, "PUT", "/mytopic", "this should be okay again too many", map[string]string{
  462. "E-Mail": "test@example.com",
  463. })
  464. require.Equal(t, 200, response.Code)
  465. response = request(t, s, "PUT", "/mytopic", "and bad again", map[string]string{
  466. "E-Mail": "test@example.com",
  467. })
  468. require.Equal(t, 429, response.Code)
  469. }
  470. func TestServer_PublishDelayedEmail_Fail(t *testing.T) {
  471. s := newTestServer(t, newTestConfig(t))
  472. s.mailer = &testMailer{}
  473. response := request(t, s, "PUT", "/mytopic", "fail", map[string]string{
  474. "E-Mail": "test@example.com",
  475. "Delay": "20 min",
  476. })
  477. require.Equal(t, 400, response.Code)
  478. }
  479. func TestServer_PublishEmailNoMailer_Fail(t *testing.T) {
  480. s := newTestServer(t, newTestConfig(t))
  481. response := request(t, s, "PUT", "/mytopic", "fail", map[string]string{
  482. "E-Mail": "test@example.com",
  483. })
  484. require.Equal(t, 400, response.Code)
  485. }
  486. func TestServer_UnifiedPushDiscovery(t *testing.T) {
  487. s := newTestServer(t, newTestConfig(t))
  488. response := request(t, s, "GET", "/mytopic?up=1", "", nil)
  489. require.Equal(t, 200, response.Code)
  490. require.Equal(t, `{"unifiedpush":{"version":1}}`+"\n", response.Body.String())
  491. }
  492. func TestServer_MaybeTruncateFCMMessage(t *testing.T) {
  493. origMessage := strings.Repeat("this is a long string", 300)
  494. origFCMMessage := &messaging.Message{
  495. Topic: "mytopic",
  496. Data: map[string]string{
  497. "id": "abcdefg",
  498. "time": "1641324761",
  499. "event": "message",
  500. "topic": "mytopic",
  501. "priority": "0",
  502. "tags": "",
  503. "title": "",
  504. "message": origMessage,
  505. },
  506. Android: &messaging.AndroidConfig{
  507. Priority: "high",
  508. },
  509. }
  510. origMessageLength := len(origFCMMessage.Data["message"])
  511. serializedOrigFCMMessage, _ := json.Marshal(origFCMMessage)
  512. require.Greater(t, len(serializedOrigFCMMessage), fcmMessageLimit) // Pre-condition
  513. truncatedFCMMessage := maybeTruncateFCMMessage(origFCMMessage)
  514. truncatedMessageLength := len(truncatedFCMMessage.Data["message"])
  515. serializedTruncatedFCMMessage, _ := json.Marshal(truncatedFCMMessage)
  516. require.Equal(t, fcmMessageLimit, len(serializedTruncatedFCMMessage))
  517. require.Equal(t, "1", truncatedFCMMessage.Data["truncated"])
  518. require.NotEqual(t, origMessageLength, truncatedMessageLength)
  519. }
  520. func TestServer_MaybeTruncateFCMMessage_NotTooLong(t *testing.T) {
  521. origMessage := "not really a long string"
  522. origFCMMessage := &messaging.Message{
  523. Topic: "mytopic",
  524. Data: map[string]string{
  525. "id": "abcdefg",
  526. "time": "1641324761",
  527. "event": "message",
  528. "topic": "mytopic",
  529. "priority": "0",
  530. "tags": "",
  531. "title": "",
  532. "message": origMessage,
  533. },
  534. }
  535. origMessageLength := len(origFCMMessage.Data["message"])
  536. serializedOrigFCMMessage, _ := json.Marshal(origFCMMessage)
  537. require.LessOrEqual(t, len(serializedOrigFCMMessage), fcmMessageLimit) // Pre-condition
  538. notTruncatedFCMMessage := maybeTruncateFCMMessage(origFCMMessage)
  539. notTruncatedMessageLength := len(notTruncatedFCMMessage.Data["message"])
  540. serializedNotTruncatedFCMMessage, _ := json.Marshal(notTruncatedFCMMessage)
  541. require.Equal(t, origMessageLength, notTruncatedMessageLength)
  542. require.Equal(t, len(serializedOrigFCMMessage), len(serializedNotTruncatedFCMMessage))
  543. require.Equal(t, "", notTruncatedFCMMessage.Data["truncated"])
  544. }
  545. func newTestConfig(t *testing.T) *Config {
  546. conf := NewConfig()
  547. conf.CacheFile = filepath.Join(t.TempDir(), "cache.db")
  548. return conf
  549. }
  550. func newTestServer(t *testing.T, config *Config) *Server {
  551. server, err := New(config)
  552. if err != nil {
  553. t.Fatal(err)
  554. }
  555. return server
  556. }
  557. func request(t *testing.T, s *Server, method, url, body string, headers map[string]string) *httptest.ResponseRecorder {
  558. rr := httptest.NewRecorder()
  559. req, err := http.NewRequest(method, url, strings.NewReader(body))
  560. if err != nil {
  561. t.Fatal(err)
  562. }
  563. for k, v := range headers {
  564. req.Header.Set(k, v)
  565. }
  566. s.handle(rr, req)
  567. return rr
  568. }
  569. func subscribe(t *testing.T, s *Server, url string, rr *httptest.ResponseRecorder) context.CancelFunc {
  570. ctx, cancel := context.WithCancel(context.Background())
  571. req, err := http.NewRequestWithContext(ctx, "GET", url, nil)
  572. if err != nil {
  573. t.Fatal(err)
  574. }
  575. done := make(chan bool)
  576. go func() {
  577. s.handle(rr, req)
  578. done <- true
  579. }()
  580. cancelAndWaitForDone := func() {
  581. time.Sleep(100 * time.Millisecond)
  582. cancel()
  583. <-done
  584. }
  585. time.Sleep(100 * time.Millisecond)
  586. return cancelAndWaitForDone
  587. }
  588. func toMessages(t *testing.T, s string) []*message {
  589. messages := make([]*message, 0)
  590. scanner := bufio.NewScanner(strings.NewReader(s))
  591. for scanner.Scan() {
  592. messages = append(messages, toMessage(t, scanner.Text()))
  593. }
  594. return messages
  595. }
  596. func toMessage(t *testing.T, s string) *message {
  597. var m message
  598. require.Nil(t, json.NewDecoder(strings.NewReader(s)).Decode(&m))
  599. return &m
  600. }
  601. func toHTTPError(t *testing.T, s string) *errHTTP {
  602. var e errHTTP
  603. require.Nil(t, json.NewDecoder(strings.NewReader(s)).Decode(&e))
  604. return &e
  605. }
  606. func firebaseServiceAccountFile(t *testing.T) string {
  607. if os.Getenv("NTFY_TEST_FIREBASE_SERVICE_ACCOUNT_FILE") != "" {
  608. return os.Getenv("NTFY_TEST_FIREBASE_SERVICE_ACCOUNT_FILE")
  609. } else if os.Getenv("NTFY_TEST_FIREBASE_SERVICE_ACCOUNT") != "" {
  610. filename := filepath.Join(t.TempDir(), "firebase.json")
  611. require.NotNil(t, os.WriteFile(filename, []byte(os.Getenv("NTFY_TEST_FIREBASE_SERVICE_ACCOUNT")), 0600))
  612. return filename
  613. }
  614. t.SkipNow()
  615. return ""
  616. }