server_test.go 41 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205
  1. package server
  2. import (
  3. "bufio"
  4. "context"
  5. "encoding/base64"
  6. "encoding/json"
  7. "fmt"
  8. "github.com/stretchr/testify/require"
  9. "heckel.io/ntfy/auth"
  10. "heckel.io/ntfy/util"
  11. "math/rand"
  12. "net/http"
  13. "net/http/httptest"
  14. "os"
  15. "path/filepath"
  16. "strings"
  17. "sync"
  18. "testing"
  19. "time"
  20. )
  21. func TestServer_PublishAndPoll(t *testing.T) {
  22. s := newTestServer(t, newTestConfig(t))
  23. response1 := request(t, s, "PUT", "/mytopic", "my first message", nil)
  24. msg1 := toMessage(t, response1.Body.String())
  25. require.NotEmpty(t, msg1.ID)
  26. require.Equal(t, "my first message", msg1.Message)
  27. response2 := request(t, s, "PUT", "/mytopic", "my second\n\nmessage", nil)
  28. msg2 := toMessage(t, response2.Body.String())
  29. require.NotEqual(t, msg1.ID, msg2.ID)
  30. require.NotEmpty(t, msg2.ID)
  31. require.Equal(t, "my second\n\nmessage", msg2.Message)
  32. response := request(t, s, "GET", "/mytopic/json?poll=1", "", nil)
  33. messages := toMessages(t, response.Body.String())
  34. require.Equal(t, 2, len(messages))
  35. require.Equal(t, "my first message", messages[0].Message)
  36. require.Equal(t, "my second\n\nmessage", messages[1].Message)
  37. response = request(t, s, "GET", "/mytopic/sse?poll=1&since=all", "", nil)
  38. lines := strings.Split(strings.TrimSpace(response.Body.String()), "\n")
  39. require.Equal(t, 3, len(lines))
  40. require.Equal(t, "my first message", toMessage(t, strings.TrimPrefix(lines[0], "data: ")).Message)
  41. require.Equal(t, "", lines[1])
  42. require.Equal(t, "my second\n\nmessage", toMessage(t, strings.TrimPrefix(lines[2], "data: ")).Message)
  43. response = request(t, s, "GET", "/mytopic/raw?poll=1", "", nil)
  44. lines = strings.Split(strings.TrimSpace(response.Body.String()), "\n")
  45. require.Equal(t, 2, len(lines))
  46. require.Equal(t, "my first message", lines[0])
  47. require.Equal(t, "my second message", lines[1]) // \n -> " "
  48. }
  49. func TestServer_SubscribeOpenAndKeepalive(t *testing.T) {
  50. c := newTestConfig(t)
  51. c.KeepaliveInterval = time.Second
  52. s := newTestServer(t, c)
  53. rr := httptest.NewRecorder()
  54. ctx, cancel := context.WithCancel(context.Background())
  55. req, err := http.NewRequestWithContext(ctx, "GET", "/mytopic/json", nil)
  56. if err != nil {
  57. t.Fatal(err)
  58. }
  59. doneChan := make(chan bool)
  60. go func() {
  61. s.handle(rr, req)
  62. doneChan <- true
  63. }()
  64. time.Sleep(1300 * time.Millisecond)
  65. cancel()
  66. <-doneChan
  67. messages := toMessages(t, rr.Body.String())
  68. require.Equal(t, 2, len(messages))
  69. require.Equal(t, openEvent, messages[0].Event)
  70. require.Equal(t, "mytopic", messages[0].Topic)
  71. require.Equal(t, "", messages[0].Message)
  72. require.Equal(t, "", messages[0].Title)
  73. require.Equal(t, 0, messages[0].Priority)
  74. require.Nil(t, messages[0].Tags)
  75. require.Equal(t, keepaliveEvent, messages[1].Event)
  76. require.Equal(t, "mytopic", messages[1].Topic)
  77. require.Equal(t, "", messages[1].Message)
  78. require.Equal(t, "", messages[1].Title)
  79. require.Equal(t, 0, messages[1].Priority)
  80. require.Nil(t, messages[1].Tags)
  81. }
  82. func TestServer_PublishAndSubscribe(t *testing.T) {
  83. s := newTestServer(t, newTestConfig(t))
  84. subscribeRR := httptest.NewRecorder()
  85. subscribeCancel := subscribe(t, s, "/mytopic/json", subscribeRR)
  86. publishFirstRR := request(t, s, "PUT", "/mytopic", "my first message", nil)
  87. require.Equal(t, 200, publishFirstRR.Code)
  88. publishSecondRR := request(t, s, "PUT", "/mytopic", "my other message", map[string]string{
  89. "Title": " This is a title ",
  90. "X-Tags": "tag1,tag 2, tag3",
  91. "p": "1",
  92. })
  93. require.Equal(t, 200, publishSecondRR.Code)
  94. subscribeCancel()
  95. messages := toMessages(t, subscribeRR.Body.String())
  96. require.Equal(t, 3, len(messages))
  97. require.Equal(t, openEvent, messages[0].Event)
  98. require.Equal(t, messageEvent, messages[1].Event)
  99. require.Equal(t, "mytopic", messages[1].Topic)
  100. require.Equal(t, "my first message", messages[1].Message)
  101. require.Equal(t, "", messages[1].Title)
  102. require.Equal(t, 0, messages[1].Priority)
  103. require.Nil(t, messages[1].Tags)
  104. require.Equal(t, messageEvent, messages[2].Event)
  105. require.Equal(t, "mytopic", messages[2].Topic)
  106. require.Equal(t, "my other message", messages[2].Message)
  107. require.Equal(t, "This is a title", messages[2].Title)
  108. require.Equal(t, 1, messages[2].Priority)
  109. require.Equal(t, []string{"tag1", "tag 2", "tag3"}, messages[2].Tags)
  110. }
  111. func TestServer_StaticSites(t *testing.T) {
  112. s := newTestServer(t, newTestConfig(t))
  113. rr := request(t, s, "GET", "/", "", nil)
  114. require.Equal(t, 200, rr.Code)
  115. require.Contains(t, rr.Body.String(), "</html>")
  116. rr = request(t, s, "HEAD", "/", "", nil)
  117. require.Equal(t, 200, rr.Code)
  118. rr = request(t, s, "OPTIONS", "/", "", nil)
  119. require.Equal(t, 200, rr.Code)
  120. rr = request(t, s, "GET", "/does-not-exist.txt", "", nil)
  121. require.Equal(t, 404, rr.Code)
  122. rr = request(t, s, "GET", "/mytopic", "", nil)
  123. require.Equal(t, 200, rr.Code)
  124. require.Contains(t, rr.Body.String(), `<meta name="robots" content="noindex, nofollow"/>`)
  125. rr = request(t, s, "GET", "/static/css/home.css", "", nil)
  126. require.Equal(t, 200, rr.Code)
  127. require.Contains(t, rr.Body.String(), `html, body {`)
  128. rr = request(t, s, "GET", "/docs", "", nil)
  129. require.Equal(t, 301, rr.Code)
  130. // Docs test removed, it was failing annoyingly.
  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. c := newTestConfig(t)
  137. c.AttachmentCacheDir = "" // Disable attachments
  138. s := newTestServer(t, c)
  139. body := strings.Repeat("this is a large message", 5000)
  140. response := request(t, s, "PUT", "/mytopic", body, nil)
  141. require.Equal(t, 400, response.Code)
  142. }
  143. func TestServer_PublishPriority(t *testing.T) {
  144. s := newTestServer(t, newTestConfig(t))
  145. for prio := 1; prio <= 5; prio++ {
  146. response := request(t, s, "GET", fmt.Sprintf("/mytopic/publish?priority=%d", prio), fmt.Sprintf("priority %d", prio), nil)
  147. msg := toMessage(t, response.Body.String())
  148. require.Equal(t, prio, msg.Priority)
  149. }
  150. response := request(t, s, "GET", "/mytopic/publish?priority=min", "test", nil)
  151. require.Equal(t, 1, toMessage(t, response.Body.String()).Priority)
  152. response = request(t, s, "GET", "/mytopic/send?priority=low", "test", nil)
  153. require.Equal(t, 2, toMessage(t, response.Body.String()).Priority)
  154. response = request(t, s, "GET", "/mytopic/send?priority=default", "test", nil)
  155. require.Equal(t, 3, toMessage(t, response.Body.String()).Priority)
  156. response = request(t, s, "GET", "/mytopic/send?priority=high", "test", nil)
  157. require.Equal(t, 4, toMessage(t, response.Body.String()).Priority)
  158. response = request(t, s, "GET", "/mytopic/send?priority=max", "test", nil)
  159. require.Equal(t, 5, toMessage(t, response.Body.String()).Priority)
  160. response = request(t, s, "GET", "/mytopic/trigger?priority=urgent", "test", nil)
  161. require.Equal(t, 5, toMessage(t, response.Body.String()).Priority)
  162. response = request(t, s, "GET", "/mytopic/trigger?priority=INVALID", "test", nil)
  163. require.Equal(t, 40007, toHTTPError(t, response.Body.String()).Code)
  164. }
  165. func TestServer_PublishNoCache(t *testing.T) {
  166. s := newTestServer(t, newTestConfig(t))
  167. response := request(t, s, "PUT", "/mytopic", "this message is not cached", map[string]string{
  168. "Cache": "no",
  169. })
  170. msg := toMessage(t, response.Body.String())
  171. require.NotEmpty(t, msg.ID)
  172. require.Equal(t, "this message is not cached", msg.Message)
  173. response = request(t, s, "GET", "/mytopic/json?poll=1", "", nil)
  174. messages := toMessages(t, response.Body.String())
  175. require.Empty(t, messages)
  176. }
  177. func TestServer_PublishAt(t *testing.T) {
  178. c := newTestConfig(t)
  179. c.MinDelay = time.Second
  180. c.AtSenderInterval = 100 * time.Millisecond
  181. s := newTestServer(t, c)
  182. response := request(t, s, "PUT", "/mytopic", "a message", map[string]string{
  183. "In": "1s",
  184. })
  185. require.Equal(t, 200, response.Code)
  186. response = request(t, s, "GET", "/mytopic/json?poll=1", "", nil)
  187. messages := toMessages(t, response.Body.String())
  188. require.Equal(t, 0, len(messages))
  189. time.Sleep(time.Second)
  190. require.Nil(t, s.sendDelayedMessages())
  191. response = request(t, s, "GET", "/mytopic/json?poll=1", "", nil)
  192. messages = toMessages(t, response.Body.String())
  193. require.Equal(t, 1, len(messages))
  194. require.Equal(t, "a message", messages[0].Message)
  195. }
  196. func TestServer_PublishAtWithCacheError(t *testing.T) {
  197. s := newTestServer(t, newTestConfig(t))
  198. response := request(t, s, "PUT", "/mytopic", "a message", map[string]string{
  199. "Cache": "no",
  200. "In": "30 min",
  201. })
  202. require.Equal(t, 400, response.Code)
  203. require.Equal(t, errHTTPBadRequestDelayNoCache, toHTTPError(t, response.Body.String()))
  204. }
  205. func TestServer_PublishAtTooShortDelay(t *testing.T) {
  206. s := newTestServer(t, newTestConfig(t))
  207. response := request(t, s, "PUT", "/mytopic", "a message", map[string]string{
  208. "In": "1s",
  209. })
  210. require.Equal(t, 400, response.Code)
  211. }
  212. func TestServer_PublishAtTooLongDelay(t *testing.T) {
  213. s := newTestServer(t, newTestConfig(t))
  214. response := request(t, s, "PUT", "/mytopic", "a message", map[string]string{
  215. "In": "99999999h",
  216. })
  217. require.Equal(t, 400, response.Code)
  218. }
  219. func TestServer_PublishAtInvalidDelay(t *testing.T) {
  220. s := newTestServer(t, newTestConfig(t))
  221. response := request(t, s, "PUT", "/mytopic?delay=INVALID", "a message", nil)
  222. err := toHTTPError(t, response.Body.String())
  223. require.Equal(t, 400, response.Code)
  224. require.Equal(t, 40004, err.Code)
  225. }
  226. func TestServer_PublishAtTooLarge(t *testing.T) {
  227. s := newTestServer(t, newTestConfig(t))
  228. response := request(t, s, "PUT", "/mytopic?x-in=99999h", "a message", nil)
  229. err := toHTTPError(t, response.Body.String())
  230. require.Equal(t, 400, response.Code)
  231. require.Equal(t, 40006, err.Code)
  232. }
  233. func TestServer_PublishAtAndPrune(t *testing.T) {
  234. s := newTestServer(t, newTestConfig(t))
  235. response := request(t, s, "PUT", "/mytopic", "a message", map[string]string{
  236. "In": "1h",
  237. })
  238. require.Equal(t, 200, response.Code)
  239. s.updateStatsAndPrune() // Fire pruning
  240. response = request(t, s, "GET", "/mytopic/json?poll=1&scheduled=1", "", nil)
  241. messages := toMessages(t, response.Body.String())
  242. require.Equal(t, 1, len(messages)) // Not affected by pruning
  243. require.Equal(t, "a message", messages[0].Message)
  244. }
  245. func TestServer_PublishAndMultiPoll(t *testing.T) {
  246. s := newTestServer(t, newTestConfig(t))
  247. response := request(t, s, "PUT", "/mytopic1", "message 1", nil)
  248. msg := toMessage(t, response.Body.String())
  249. require.NotEmpty(t, msg.ID)
  250. require.Equal(t, "mytopic1", msg.Topic)
  251. require.Equal(t, "message 1", msg.Message)
  252. response = request(t, s, "PUT", "/mytopic2", "message 2", nil)
  253. msg = toMessage(t, response.Body.String())
  254. require.NotEmpty(t, msg.ID)
  255. require.Equal(t, "mytopic2", msg.Topic)
  256. require.Equal(t, "message 2", msg.Message)
  257. response = request(t, s, "GET", "/mytopic1/json?poll=1", "", nil)
  258. messages := toMessages(t, response.Body.String())
  259. require.Equal(t, 1, len(messages))
  260. require.Equal(t, "mytopic1", messages[0].Topic)
  261. require.Equal(t, "message 1", messages[0].Message)
  262. response = request(t, s, "GET", "/mytopic1,mytopic2/json?poll=1", "", nil)
  263. messages = toMessages(t, response.Body.String())
  264. require.Equal(t, 2, len(messages))
  265. require.Equal(t, "mytopic1", messages[0].Topic)
  266. require.Equal(t, "message 1", messages[0].Message)
  267. require.Equal(t, "mytopic2", messages[1].Topic)
  268. require.Equal(t, "message 2", messages[1].Message)
  269. }
  270. func TestServer_PublishWithNopCache(t *testing.T) {
  271. c := newTestConfig(t)
  272. c.CacheDuration = 0
  273. s := newTestServer(t, c)
  274. subscribeRR := httptest.NewRecorder()
  275. subscribeCancel := subscribe(t, s, "/mytopic/json", subscribeRR)
  276. publishRR := request(t, s, "PUT", "/mytopic", "my first message", nil)
  277. require.Equal(t, 200, publishRR.Code)
  278. subscribeCancel()
  279. messages := toMessages(t, subscribeRR.Body.String())
  280. require.Equal(t, 2, len(messages))
  281. require.Equal(t, openEvent, messages[0].Event)
  282. require.Equal(t, messageEvent, messages[1].Event)
  283. require.Equal(t, "my first message", messages[1].Message)
  284. response := request(t, s, "GET", "/mytopic/json?poll=1", "", nil)
  285. messages = toMessages(t, response.Body.String())
  286. require.Empty(t, messages)
  287. }
  288. func TestServer_PublishAndPollSince(t *testing.T) {
  289. s := newTestServer(t, newTestConfig(t))
  290. request(t, s, "PUT", "/mytopic", "test 1", nil)
  291. time.Sleep(1100 * time.Millisecond)
  292. since := time.Now().Unix()
  293. request(t, s, "PUT", "/mytopic", "test 2", nil)
  294. response := request(t, s, "GET", fmt.Sprintf("/mytopic/json?poll=1&since=%d", since), "", nil)
  295. messages := toMessages(t, response.Body.String())
  296. require.Equal(t, 1, len(messages))
  297. require.Equal(t, "test 2", messages[0].Message)
  298. response = request(t, s, "GET", "/mytopic/json?poll=1&since=10s", "", nil)
  299. messages = toMessages(t, response.Body.String())
  300. require.Equal(t, 2, len(messages))
  301. require.Equal(t, "test 1", messages[0].Message)
  302. response = request(t, s, "GET", "/mytopic/json?poll=1&since=100ms", "", nil)
  303. messages = toMessages(t, response.Body.String())
  304. require.Equal(t, 1, len(messages))
  305. require.Equal(t, "test 2", messages[0].Message)
  306. response = request(t, s, "GET", "/mytopic/json?poll=1&since=INVALID", "", nil)
  307. require.Equal(t, 40008, toHTTPError(t, response.Body.String()).Code)
  308. }
  309. func TestServer_PublishViaGET(t *testing.T) {
  310. s := newTestServer(t, newTestConfig(t))
  311. response := request(t, s, "GET", "/mytopic/trigger", "", nil)
  312. msg := toMessage(t, response.Body.String())
  313. require.NotEmpty(t, msg.ID)
  314. require.Equal(t, "triggered", msg.Message)
  315. 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)
  316. msg = toMessage(t, response.Body.String())
  317. require.NotEmpty(t, msg.ID)
  318. require.Equal(t, "This is a test", msg.Message)
  319. require.Equal(t, "This is a title", msg.Title)
  320. require.Equal(t, []string{"skull"}, msg.Tags)
  321. require.Equal(t, 5, msg.Priority)
  322. require.Greater(t, msg.Time, time.Now().Add(23*time.Hour).Unix())
  323. }
  324. func TestServer_PublishMessageInHeaderWithNewlines(t *testing.T) {
  325. s := newTestServer(t, newTestConfig(t))
  326. response := request(t, s, "PUT", "/mytopic", "", map[string]string{
  327. "Message": "Line 1\\nLine 2",
  328. })
  329. msg := toMessage(t, response.Body.String())
  330. require.NotEmpty(t, msg.ID)
  331. require.Equal(t, "Line 1\nLine 2", msg.Message) // \\n -> \n !
  332. }
  333. func TestServer_PublishFirebase(t *testing.T) {
  334. // This is unfortunately not much of a test, since it merely fires the messages towards Firebase,
  335. // but cannot re-read them. There is no way from Go to read the messages back, or even get an error back.
  336. // I tried everything. I already had written the test, and it increases the code coverage, so I'll leave it ... :shrug: ...
  337. c := newTestConfig(t)
  338. c.FirebaseKeyFile = firebaseServiceAccountFile(t) // May skip the test!
  339. s := newTestServer(t, c)
  340. // Normal message
  341. response := request(t, s, "PUT", "/mytopic", "This is a message for firebase", nil)
  342. msg := toMessage(t, response.Body.String())
  343. require.NotEmpty(t, msg.ID)
  344. // Keepalive message
  345. require.Nil(t, s.firebase(newKeepaliveMessage(firebaseControlTopic)))
  346. time.Sleep(500 * time.Millisecond) // Time for sends
  347. }
  348. func TestServer_PublishInvalidTopic(t *testing.T) {
  349. s := newTestServer(t, newTestConfig(t))
  350. s.mailer = &testMailer{}
  351. response := request(t, s, "PUT", "/docs", "fail", nil)
  352. require.Equal(t, 40010, toHTTPError(t, response.Body.String()).Code)
  353. }
  354. func TestServer_PollWithQueryFilters(t *testing.T) {
  355. s := newTestServer(t, newTestConfig(t))
  356. response := request(t, s, "PUT", "/mytopic?priority=1&tags=tag1,tag2", "my first message", nil)
  357. msg := toMessage(t, response.Body.String())
  358. require.NotEmpty(t, msg.ID)
  359. response = request(t, s, "PUT", "/mytopic?title=a+title", "my second message", map[string]string{
  360. "Tags": "tag2,tag3",
  361. })
  362. msg = toMessage(t, response.Body.String())
  363. require.NotEmpty(t, msg.ID)
  364. queriesThatShouldReturnMessageOne := []string{
  365. "/mytopic/json?poll=1&priority=1",
  366. "/mytopic/json?poll=1&priority=min",
  367. "/mytopic/json?poll=1&priority=min,low",
  368. "/mytopic/json?poll=1&priority=1,2",
  369. "/mytopic/json?poll=1&p=2,min",
  370. "/mytopic/json?poll=1&tags=tag1",
  371. "/mytopic/json?poll=1&tags=tag1,tag2",
  372. "/mytopic/json?poll=1&message=my+first+message",
  373. }
  374. for _, query := range queriesThatShouldReturnMessageOne {
  375. response = request(t, s, "GET", query, "", nil)
  376. messages := toMessages(t, response.Body.String())
  377. require.Equal(t, 1, len(messages), "Query failed: "+query)
  378. require.Equal(t, "my first message", messages[0].Message, "Query failed: "+query)
  379. }
  380. queriesThatShouldReturnMessageTwo := []string{
  381. "/mytopic/json?poll=1&x-priority=3", // !
  382. "/mytopic/json?poll=1&priority=3",
  383. "/mytopic/json?poll=1&priority=default",
  384. "/mytopic/json?poll=1&p=3",
  385. "/mytopic/json?poll=1&x-tags=tag2,tag3",
  386. "/mytopic/json?poll=1&tags=tag2,tag3",
  387. "/mytopic/json?poll=1&tag=tag2,tag3",
  388. "/mytopic/json?poll=1&ta=tag2,tag3",
  389. "/mytopic/json?poll=1&x-title=a+title",
  390. "/mytopic/json?poll=1&title=a+title",
  391. "/mytopic/json?poll=1&t=a+title",
  392. "/mytopic/json?poll=1&x-message=my+second+message",
  393. "/mytopic/json?poll=1&message=my+second+message",
  394. "/mytopic/json?poll=1&m=my+second+message",
  395. "/mytopic/json?x-poll=1&m=my+second+message",
  396. "/mytopic/json?po=1&m=my+second+message",
  397. }
  398. for _, query := range queriesThatShouldReturnMessageTwo {
  399. response = request(t, s, "GET", query, "", nil)
  400. messages := toMessages(t, response.Body.String())
  401. require.Equal(t, 1, len(messages), "Query failed: "+query)
  402. require.Equal(t, "my second message", messages[0].Message, "Query failed: "+query)
  403. }
  404. queriesThatShouldReturnNoMessages := []string{
  405. "/mytopic/json?poll=1&priority=4",
  406. "/mytopic/json?poll=1&tags=tag1,tag2,tag3",
  407. "/mytopic/json?poll=1&title=another+title",
  408. "/mytopic/json?poll=1&message=my+third+message",
  409. "/mytopic/json?poll=1&message=my+third+message",
  410. }
  411. for _, query := range queriesThatShouldReturnNoMessages {
  412. response = request(t, s, "GET", query, "", nil)
  413. messages := toMessages(t, response.Body.String())
  414. require.Equal(t, 0, len(messages), "Query failed: "+query)
  415. }
  416. }
  417. func TestServer_SubscribeWithQueryFilters(t *testing.T) {
  418. c := newTestConfig(t)
  419. c.KeepaliveInterval = 800 * time.Millisecond
  420. s := newTestServer(t, c)
  421. subscribeResponse := httptest.NewRecorder()
  422. subscribeCancel := subscribe(t, s, "/mytopic/json?tags=zfs-issue", subscribeResponse)
  423. response := request(t, s, "PUT", "/mytopic", "my first message", nil)
  424. require.Equal(t, 200, response.Code)
  425. response = request(t, s, "PUT", "/mytopic", "ZFS scrub failed", map[string]string{
  426. "Tags": "zfs-issue,zfs-scrub",
  427. })
  428. require.Equal(t, 200, response.Code)
  429. time.Sleep(850 * time.Millisecond)
  430. subscribeCancel()
  431. messages := toMessages(t, subscribeResponse.Body.String())
  432. require.Equal(t, 3, len(messages))
  433. require.Equal(t, openEvent, messages[0].Event)
  434. require.Equal(t, messageEvent, messages[1].Event)
  435. require.Equal(t, "ZFS scrub failed", messages[1].Message)
  436. require.Equal(t, keepaliveEvent, messages[2].Event)
  437. }
  438. func TestServer_Auth_Success_Admin(t *testing.T) {
  439. c := newTestConfig(t)
  440. c.AuthFile = filepath.Join(t.TempDir(), "user.db")
  441. s := newTestServer(t, c)
  442. manager := s.auth.(auth.Manager)
  443. require.Nil(t, manager.AddUser("phil", "phil", auth.RoleAdmin))
  444. response := request(t, s, "GET", "/mytopic/auth", "", map[string]string{
  445. "Authorization": basicAuth("phil:phil"),
  446. })
  447. require.Equal(t, 200, response.Code)
  448. require.Equal(t, `{"success":true}`+"\n", response.Body.String())
  449. }
  450. func TestServer_Auth_Success_User(t *testing.T) {
  451. c := newTestConfig(t)
  452. c.AuthFile = filepath.Join(t.TempDir(), "user.db")
  453. c.AuthDefaultRead = false
  454. c.AuthDefaultWrite = false
  455. s := newTestServer(t, c)
  456. manager := s.auth.(auth.Manager)
  457. require.Nil(t, manager.AddUser("ben", "ben", auth.RoleUser))
  458. require.Nil(t, manager.AllowAccess("ben", "mytopic", true, true))
  459. response := request(t, s, "GET", "/mytopic/auth", "", map[string]string{
  460. "Authorization": basicAuth("ben:ben"),
  461. })
  462. require.Equal(t, 200, response.Code)
  463. }
  464. func TestServer_Auth_Success_User_MultipleTopics(t *testing.T) {
  465. c := newTestConfig(t)
  466. c.AuthFile = filepath.Join(t.TempDir(), "user.db")
  467. c.AuthDefaultRead = false
  468. c.AuthDefaultWrite = false
  469. s := newTestServer(t, c)
  470. manager := s.auth.(auth.Manager)
  471. require.Nil(t, manager.AddUser("ben", "ben", auth.RoleUser))
  472. require.Nil(t, manager.AllowAccess("ben", "mytopic", true, true))
  473. require.Nil(t, manager.AllowAccess("ben", "anothertopic", true, true))
  474. response := request(t, s, "GET", "/mytopic,anothertopic/auth", "", map[string]string{
  475. "Authorization": basicAuth("ben:ben"),
  476. })
  477. require.Equal(t, 200, response.Code)
  478. response = request(t, s, "GET", "/mytopic,anothertopic,NOT-THIS-ONE/auth", "", map[string]string{
  479. "Authorization": basicAuth("ben:ben"),
  480. })
  481. require.Equal(t, 403, response.Code)
  482. }
  483. func TestServer_Auth_Fail_InvalidPass(t *testing.T) {
  484. c := newTestConfig(t)
  485. c.AuthFile = filepath.Join(t.TempDir(), "user.db")
  486. c.AuthDefaultRead = false
  487. c.AuthDefaultWrite = false
  488. s := newTestServer(t, c)
  489. manager := s.auth.(auth.Manager)
  490. require.Nil(t, manager.AddUser("phil", "phil", auth.RoleAdmin))
  491. response := request(t, s, "GET", "/mytopic/auth", "", map[string]string{
  492. "Authorization": basicAuth("phil:INVALID"),
  493. })
  494. require.Equal(t, 401, response.Code)
  495. }
  496. func TestServer_Auth_Fail_Unauthorized(t *testing.T) {
  497. c := newTestConfig(t)
  498. c.AuthFile = filepath.Join(t.TempDir(), "user.db")
  499. c.AuthDefaultRead = false
  500. c.AuthDefaultWrite = false
  501. s := newTestServer(t, c)
  502. manager := s.auth.(auth.Manager)
  503. require.Nil(t, manager.AddUser("ben", "ben", auth.RoleUser))
  504. require.Nil(t, manager.AllowAccess("ben", "sometopic", true, true)) // Not mytopic!
  505. response := request(t, s, "GET", "/mytopic/auth", "", map[string]string{
  506. "Authorization": basicAuth("ben:ben"),
  507. })
  508. require.Equal(t, 403, response.Code)
  509. }
  510. func TestServer_Auth_Fail_CannotPublish(t *testing.T) {
  511. c := newTestConfig(t)
  512. c.AuthFile = filepath.Join(t.TempDir(), "user.db")
  513. c.AuthDefaultRead = true // Open by default
  514. c.AuthDefaultWrite = true // Open by default
  515. s := newTestServer(t, c)
  516. manager := s.auth.(auth.Manager)
  517. require.Nil(t, manager.AddUser("phil", "phil", auth.RoleAdmin))
  518. require.Nil(t, manager.AllowAccess(auth.Everyone, "private", false, false))
  519. require.Nil(t, manager.AllowAccess(auth.Everyone, "announcements", true, false))
  520. response := request(t, s, "PUT", "/mytopic", "test", nil)
  521. require.Equal(t, 200, response.Code)
  522. response = request(t, s, "GET", "/mytopic/json?poll=1", "", nil)
  523. require.Equal(t, 200, response.Code)
  524. response = request(t, s, "PUT", "/announcements", "test", nil)
  525. require.Equal(t, 403, response.Code) // Cannot write as anonymous
  526. response = request(t, s, "PUT", "/announcements", "test", map[string]string{
  527. "Authorization": basicAuth("phil:phil"),
  528. })
  529. require.Equal(t, 200, response.Code)
  530. response = request(t, s, "GET", "/announcements/json?poll=1", "", nil)
  531. require.Equal(t, 200, response.Code) // Anonymous read allowed
  532. response = request(t, s, "GET", "/private/json?poll=1", "", nil)
  533. require.Equal(t, 403, response.Code) // Anonymous read not allowed
  534. }
  535. func TestServer_Auth_ViaQuery(t *testing.T) {
  536. c := newTestConfig(t)
  537. c.AuthFile = filepath.Join(t.TempDir(), "user.db")
  538. c.AuthDefaultRead = false
  539. c.AuthDefaultWrite = false
  540. s := newTestServer(t, c)
  541. manager := s.auth.(auth.Manager)
  542. require.Nil(t, manager.AddUser("ben", "some pass", auth.RoleAdmin))
  543. u := fmt.Sprintf("/mytopic/json?poll=1&auth=%s", base64.RawURLEncoding.EncodeToString([]byte(basicAuth("ben:some pass"))))
  544. response := request(t, s, "GET", u, "", nil)
  545. require.Equal(t, 200, response.Code)
  546. u = fmt.Sprintf("/mytopic/json?poll=1&auth=%s", base64.RawURLEncoding.EncodeToString([]byte(basicAuth("ben:WRONNNGGGG"))))
  547. response = request(t, s, "GET", u, "", nil)
  548. require.Equal(t, 401, response.Code)
  549. }
  550. /*
  551. func TestServer_Curl_Publish_Poll(t *testing.T) {
  552. s, port := test.StartServer(t)
  553. defer test.StopServer(t, s, port)
  554. cmd := exec.Command("sh", "-c", fmt.Sprintf(`curl -sd "This is a test" localhost:%d/mytopic`, port))
  555. require.Nil(t, cmd.Run())
  556. b, err := cmd.CombinedOutput()
  557. require.Nil(t, err)
  558. msg := toMessage(t, string(b))
  559. require.Equal(t, "This is a test", msg.Message)
  560. cmd = exec.Command("sh", "-c", fmt.Sprintf(`curl "localhost:%d/mytopic?poll=1"`, port))
  561. require.Nil(t, cmd.Run())
  562. b, err = cmd.CombinedOutput()
  563. require.Nil(t, err)
  564. msg = toMessage(t, string(b))
  565. require.Equal(t, "This is a test", msg.Message)
  566. }
  567. */
  568. type testMailer struct {
  569. count int
  570. mu sync.Mutex
  571. }
  572. func (t *testMailer) Send(from, to string, m *message) error {
  573. t.mu.Lock()
  574. defer t.mu.Unlock()
  575. t.count++
  576. return nil
  577. }
  578. func TestServer_PublishTooRequests_Defaults(t *testing.T) {
  579. s := newTestServer(t, newTestConfig(t))
  580. for i := 0; i < 60; i++ {
  581. response := request(t, s, "PUT", "/mytopic", fmt.Sprintf("message %d", i), nil)
  582. require.Equal(t, 200, response.Code)
  583. }
  584. response := request(t, s, "PUT", "/mytopic", "message", nil)
  585. require.Equal(t, 429, response.Code)
  586. }
  587. func TestServer_PublishTooRequests_Defaults_ExemptHosts(t *testing.T) {
  588. c := newTestConfig(t)
  589. c.VisitorRequestExemptIPAddrs = []string{"9.9.9.9"} // see request()
  590. s := newTestServer(t, c)
  591. for i := 0; i < 65; i++ { // > 60
  592. response := request(t, s, "PUT", "/mytopic", fmt.Sprintf("message %d", i), nil)
  593. require.Equal(t, 200, response.Code)
  594. }
  595. }
  596. func TestServer_PublishTooRequests_ShortReplenish(t *testing.T) {
  597. c := newTestConfig(t)
  598. c.VisitorRequestLimitBurst = 60
  599. c.VisitorRequestLimitReplenish = 500 * time.Millisecond
  600. s := newTestServer(t, c)
  601. for i := 0; i < 60; i++ {
  602. response := request(t, s, "PUT", "/mytopic", fmt.Sprintf("message %d", i), nil)
  603. require.Equal(t, 200, response.Code)
  604. }
  605. response := request(t, s, "PUT", "/mytopic", "message", nil)
  606. require.Equal(t, 429, response.Code)
  607. time.Sleep(510 * time.Millisecond)
  608. response = request(t, s, "PUT", "/mytopic", "message", nil)
  609. require.Equal(t, 200, response.Code)
  610. }
  611. func TestServer_PublishTooManyEmails_Defaults(t *testing.T) {
  612. s := newTestServer(t, newTestConfig(t))
  613. s.mailer = &testMailer{}
  614. for i := 0; i < 16; i++ {
  615. response := request(t, s, "PUT", "/mytopic", fmt.Sprintf("message %d", i), map[string]string{
  616. "E-Mail": "test@example.com",
  617. })
  618. require.Equal(t, 200, response.Code)
  619. }
  620. response := request(t, s, "PUT", "/mytopic", "one too many", map[string]string{
  621. "E-Mail": "test@example.com",
  622. })
  623. require.Equal(t, 429, response.Code)
  624. }
  625. func TestServer_PublishTooManyEmails_Replenish(t *testing.T) {
  626. c := newTestConfig(t)
  627. c.VisitorEmailLimitReplenish = 500 * time.Millisecond
  628. s := newTestServer(t, c)
  629. s.mailer = &testMailer{}
  630. for i := 0; i < 16; i++ {
  631. response := request(t, s, "PUT", "/mytopic", fmt.Sprintf("message %d", i), map[string]string{
  632. "E-Mail": "test@example.com",
  633. })
  634. require.Equal(t, 200, response.Code)
  635. }
  636. response := request(t, s, "PUT", "/mytopic", "one too many", map[string]string{
  637. "E-Mail": "test@example.com",
  638. })
  639. require.Equal(t, 429, response.Code)
  640. time.Sleep(510 * time.Millisecond)
  641. response = request(t, s, "PUT", "/mytopic", "this should be okay again too many", map[string]string{
  642. "E-Mail": "test@example.com",
  643. })
  644. require.Equal(t, 200, response.Code)
  645. response = request(t, s, "PUT", "/mytopic", "and bad again", map[string]string{
  646. "E-Mail": "test@example.com",
  647. })
  648. require.Equal(t, 429, response.Code)
  649. }
  650. func TestServer_PublishDelayedEmail_Fail(t *testing.T) {
  651. s := newTestServer(t, newTestConfig(t))
  652. s.mailer = &testMailer{}
  653. response := request(t, s, "PUT", "/mytopic", "fail", map[string]string{
  654. "E-Mail": "test@example.com",
  655. "Delay": "20 min",
  656. })
  657. require.Equal(t, 400, response.Code)
  658. }
  659. func TestServer_PublishEmailNoMailer_Fail(t *testing.T) {
  660. s := newTestServer(t, newTestConfig(t))
  661. response := request(t, s, "PUT", "/mytopic", "fail", map[string]string{
  662. "E-Mail": "test@example.com",
  663. })
  664. require.Equal(t, 400, response.Code)
  665. }
  666. func TestServer_UnifiedPushDiscovery(t *testing.T) {
  667. s := newTestServer(t, newTestConfig(t))
  668. response := request(t, s, "GET", "/mytopic?up=1", "", nil)
  669. require.Equal(t, 200, response.Code)
  670. require.Equal(t, `{"unifiedpush":{"version":1}}`+"\n", response.Body.String())
  671. }
  672. func TestServer_PublishUnifiedPushBinary_AndPoll(t *testing.T) {
  673. b := make([]byte, 12) // Max length
  674. _, err := rand.Read(b)
  675. require.Nil(t, err)
  676. s := newTestServer(t, newTestConfig(t))
  677. response := request(t, s, "PUT", "/mytopic?up=1", string(b), nil)
  678. require.Equal(t, 200, response.Code)
  679. m := toMessage(t, response.Body.String())
  680. require.Equal(t, "base64", m.Encoding)
  681. b2, err := base64.StdEncoding.DecodeString(m.Message)
  682. require.Nil(t, err)
  683. require.Equal(t, b, b2)
  684. response = request(t, s, "GET", "/mytopic/json?poll=1", string(b), nil)
  685. require.Equal(t, 200, response.Code)
  686. m = toMessage(t, response.Body.String())
  687. require.Equal(t, "base64", m.Encoding)
  688. b2, err = base64.StdEncoding.DecodeString(m.Message)
  689. require.Nil(t, err)
  690. require.Equal(t, b, b2)
  691. }
  692. func TestServer_PublishUnifiedPushBinary_Truncated(t *testing.T) {
  693. b := make([]byte, 5000) // Longer than max length
  694. _, err := rand.Read(b)
  695. require.Nil(t, err)
  696. s := newTestServer(t, newTestConfig(t))
  697. response := request(t, s, "PUT", "/mytopic?up=1", string(b), nil)
  698. require.Equal(t, 200, response.Code)
  699. m := toMessage(t, response.Body.String())
  700. require.Equal(t, "base64", m.Encoding)
  701. b2, err := base64.StdEncoding.DecodeString(m.Message)
  702. require.Nil(t, err)
  703. require.Equal(t, 4096, len(b2))
  704. require.Equal(t, b[:4096], b2)
  705. }
  706. func TestServer_PublishUnifiedPushText(t *testing.T) {
  707. s := newTestServer(t, newTestConfig(t))
  708. response := request(t, s, "PUT", "/mytopic?up=1", "this is a unifiedpush text message", nil)
  709. require.Equal(t, 200, response.Code)
  710. m := toMessage(t, response.Body.String())
  711. require.Equal(t, "", m.Encoding)
  712. require.Equal(t, "this is a unifiedpush text message", m.Message)
  713. }
  714. func TestServer_PublishAsJSON(t *testing.T) {
  715. s := newTestServer(t, newTestConfig(t))
  716. body := `{"topic":"mytopic","message":"A message","title":"a title\nwith lines","tags":["tag1","tag 2"],` +
  717. `"not-a-thing":"ok", "attach":"http://google.com","filename":"google.pdf", "click":"http://ntfy.sh","priority":4}`
  718. response := request(t, s, "PUT", "/", body, nil)
  719. require.Equal(t, 200, response.Code)
  720. m := toMessage(t, response.Body.String())
  721. require.Equal(t, "mytopic", m.Topic)
  722. require.Equal(t, "A message", m.Message)
  723. require.Equal(t, "a title\nwith lines", m.Title)
  724. require.Equal(t, []string{"tag1", "tag 2"}, m.Tags)
  725. require.Equal(t, "http://google.com", m.Attachment.URL)
  726. require.Equal(t, "google.pdf", m.Attachment.Name)
  727. require.Equal(t, "http://ntfy.sh", m.Click)
  728. require.Equal(t, 4, m.Priority)
  729. }
  730. func TestServer_PublishAsJSON_Invalid(t *testing.T) {
  731. s := newTestServer(t, newTestConfig(t))
  732. body := `{"topic":"mytopic",INVALID`
  733. response := request(t, s, "PUT", "/", body, nil)
  734. require.Equal(t, 400, response.Code)
  735. }
  736. func TestServer_PublishAttachment(t *testing.T) {
  737. content := util.RandomString(5000) // > 4096
  738. s := newTestServer(t, newTestConfig(t))
  739. response := request(t, s, "PUT", "/mytopic", content, nil)
  740. msg := toMessage(t, response.Body.String())
  741. require.Equal(t, "attachment.txt", msg.Attachment.Name)
  742. require.Equal(t, "text/plain; charset=utf-8", msg.Attachment.Type)
  743. require.Equal(t, int64(5000), msg.Attachment.Size)
  744. require.GreaterOrEqual(t, msg.Attachment.Expires, time.Now().Add(179*time.Minute).Unix()) // Almost 3 hours
  745. require.Contains(t, msg.Attachment.URL, "http://127.0.0.1:12345/file/")
  746. require.Equal(t, "", msg.Attachment.Owner) // Should never be returned
  747. require.FileExists(t, filepath.Join(s.config.AttachmentCacheDir, msg.ID))
  748. path := strings.TrimPrefix(msg.Attachment.URL, "http://127.0.0.1:12345")
  749. response = request(t, s, "GET", path, "", nil)
  750. require.Equal(t, 200, response.Code)
  751. require.Equal(t, "5000", response.Header().Get("Content-Length"))
  752. require.Equal(t, content, response.Body.String())
  753. // Slightly unrelated cross-test: make sure we add an owner for internal attachments
  754. size, err := s.messageCache.AttachmentsSize("9.9.9.9") // See request()
  755. require.Nil(t, err)
  756. require.Equal(t, int64(5000), size)
  757. }
  758. func TestServer_PublishAttachmentShortWithFilename(t *testing.T) {
  759. c := newTestConfig(t)
  760. c.BehindProxy = true
  761. s := newTestServer(t, c)
  762. content := "this is an ATTACHMENT"
  763. response := request(t, s, "PUT", "/mytopic?f=myfile.txt", content, map[string]string{
  764. "X-Forwarded-For": "1.2.3.4",
  765. })
  766. msg := toMessage(t, response.Body.String())
  767. require.Equal(t, "myfile.txt", msg.Attachment.Name)
  768. require.Equal(t, "text/plain; charset=utf-8", msg.Attachment.Type)
  769. require.Equal(t, int64(21), msg.Attachment.Size)
  770. require.GreaterOrEqual(t, msg.Attachment.Expires, time.Now().Add(3*time.Hour).Unix())
  771. require.Contains(t, msg.Attachment.URL, "http://127.0.0.1:12345/file/")
  772. require.Equal(t, "", msg.Attachment.Owner) // Should never be returned
  773. require.FileExists(t, filepath.Join(s.config.AttachmentCacheDir, msg.ID))
  774. path := strings.TrimPrefix(msg.Attachment.URL, "http://127.0.0.1:12345")
  775. response = request(t, s, "GET", path, "", nil)
  776. require.Equal(t, 200, response.Code)
  777. require.Equal(t, "21", response.Header().Get("Content-Length"))
  778. require.Equal(t, content, response.Body.String())
  779. // Slightly unrelated cross-test: make sure we add an owner for internal attachments
  780. size, err := s.messageCache.AttachmentsSize("1.2.3.4")
  781. require.Nil(t, err)
  782. require.Equal(t, int64(21), size)
  783. }
  784. func TestServer_PublishAttachmentExternalWithoutFilename(t *testing.T) {
  785. s := newTestServer(t, newTestConfig(t))
  786. response := request(t, s, "PUT", "/mytopic", "", map[string]string{
  787. "Attach": "https://upload.wikimedia.org/wikipedia/commons/f/fd/Pink_flower.jpg",
  788. })
  789. msg := toMessage(t, response.Body.String())
  790. require.Equal(t, "You received a file: Pink_flower.jpg", msg.Message)
  791. require.Equal(t, "Pink_flower.jpg", msg.Attachment.Name)
  792. require.Equal(t, "https://upload.wikimedia.org/wikipedia/commons/f/fd/Pink_flower.jpg", msg.Attachment.URL)
  793. require.Equal(t, "", msg.Attachment.Type)
  794. require.Equal(t, int64(0), msg.Attachment.Size)
  795. require.Equal(t, int64(0), msg.Attachment.Expires)
  796. require.Equal(t, "", msg.Attachment.Owner)
  797. // Slightly unrelated cross-test: make sure we don't add an owner for external attachments
  798. size, err := s.messageCache.AttachmentsSize("127.0.0.1")
  799. require.Nil(t, err)
  800. require.Equal(t, int64(0), size)
  801. }
  802. func TestServer_PublishAttachmentExternalWithFilename(t *testing.T) {
  803. s := newTestServer(t, newTestConfig(t))
  804. response := request(t, s, "PUT", "/mytopic", "This is a custom message", map[string]string{
  805. "X-Attach": "https://upload.wikimedia.org/wikipedia/commons/f/fd/Pink_flower.jpg",
  806. "File": "some file.jpg",
  807. })
  808. msg := toMessage(t, response.Body.String())
  809. require.Equal(t, "This is a custom message", msg.Message)
  810. require.Equal(t, "some file.jpg", msg.Attachment.Name)
  811. require.Equal(t, "https://upload.wikimedia.org/wikipedia/commons/f/fd/Pink_flower.jpg", msg.Attachment.URL)
  812. require.Equal(t, "", msg.Attachment.Type)
  813. require.Equal(t, int64(0), msg.Attachment.Size)
  814. require.Equal(t, int64(0), msg.Attachment.Expires)
  815. require.Equal(t, "", msg.Attachment.Owner)
  816. }
  817. func TestServer_PublishAttachmentBadURL(t *testing.T) {
  818. s := newTestServer(t, newTestConfig(t))
  819. response := request(t, s, "PUT", "/mytopic?a=not+a+URL", "", nil)
  820. err := toHTTPError(t, response.Body.String())
  821. require.Equal(t, 400, response.Code)
  822. require.Equal(t, 400, err.HTTPCode)
  823. require.Equal(t, 40013, err.Code)
  824. }
  825. func TestServer_PublishAttachmentTooLargeContentLength(t *testing.T) {
  826. content := util.RandomString(5000) // > 4096
  827. s := newTestServer(t, newTestConfig(t))
  828. response := request(t, s, "PUT", "/mytopic", content, map[string]string{
  829. "Content-Length": "20000000",
  830. })
  831. err := toHTTPError(t, response.Body.String())
  832. require.Equal(t, 400, response.Code)
  833. require.Equal(t, 400, err.HTTPCode)
  834. require.Equal(t, 40012, err.Code)
  835. }
  836. func TestServer_PublishAttachmentTooLargeBodyAttachmentFileSizeLimit(t *testing.T) {
  837. content := util.RandomString(5001) // > 5000, see below
  838. c := newTestConfig(t)
  839. c.AttachmentFileSizeLimit = 5000
  840. s := newTestServer(t, c)
  841. response := request(t, s, "PUT", "/mytopic", content, nil)
  842. err := toHTTPError(t, response.Body.String())
  843. require.Equal(t, 400, response.Code)
  844. require.Equal(t, 400, err.HTTPCode)
  845. require.Equal(t, 40012, err.Code)
  846. }
  847. func TestServer_PublishAttachmentExpiryBeforeDelivery(t *testing.T) {
  848. c := newTestConfig(t)
  849. c.AttachmentExpiryDuration = 10 * time.Minute
  850. s := newTestServer(t, c)
  851. response := request(t, s, "PUT", "/mytopic", util.RandomString(5000), map[string]string{
  852. "Delay": "11 min", // > AttachmentExpiryDuration
  853. })
  854. err := toHTTPError(t, response.Body.String())
  855. require.Equal(t, 400, response.Code)
  856. require.Equal(t, 400, err.HTTPCode)
  857. require.Equal(t, 40015, err.Code)
  858. }
  859. func TestServer_PublishAttachmentTooLargeBodyVisitorAttachmentTotalSizeLimit(t *testing.T) {
  860. c := newTestConfig(t)
  861. c.VisitorAttachmentTotalSizeLimit = 10000
  862. s := newTestServer(t, c)
  863. response := request(t, s, "PUT", "/mytopic", util.RandomString(5000), nil)
  864. msg := toMessage(t, response.Body.String())
  865. require.Equal(t, 200, response.Code)
  866. require.Equal(t, "You received a file: attachment.txt", msg.Message)
  867. require.Equal(t, int64(5000), msg.Attachment.Size)
  868. content := util.RandomString(5001) // 5000+5001 > , see below
  869. response = request(t, s, "PUT", "/mytopic", content, nil)
  870. err := toHTTPError(t, response.Body.String())
  871. require.Equal(t, 400, response.Code)
  872. require.Equal(t, 400, err.HTTPCode)
  873. require.Equal(t, 40012, err.Code)
  874. }
  875. func TestServer_PublishAttachmentAndPrune(t *testing.T) {
  876. content := util.RandomString(5000) // > 4096
  877. c := newTestConfig(t)
  878. c.AttachmentExpiryDuration = time.Millisecond // Hack
  879. s := newTestServer(t, c)
  880. // Publish and make sure we can retrieve it
  881. response := request(t, s, "PUT", "/mytopic", content, nil)
  882. msg := toMessage(t, response.Body.String())
  883. require.Contains(t, msg.Attachment.URL, "http://127.0.0.1:12345/file/")
  884. file := filepath.Join(s.config.AttachmentCacheDir, msg.ID)
  885. require.FileExists(t, file)
  886. path := strings.TrimPrefix(msg.Attachment.URL, "http://127.0.0.1:12345")
  887. response = request(t, s, "GET", path, "", nil)
  888. require.Equal(t, 200, response.Code)
  889. require.Equal(t, content, response.Body.String())
  890. // Prune and makes sure it's gone
  891. time.Sleep(time.Second) // Sigh ...
  892. s.updateStatsAndPrune()
  893. require.NoFileExists(t, file)
  894. response = request(t, s, "GET", path, "", nil)
  895. require.Equal(t, 404, response.Code)
  896. }
  897. func TestServer_PublishAttachmentBandwidthLimit(t *testing.T) {
  898. content := util.RandomString(5000) // > 4096
  899. c := newTestConfig(t)
  900. c.VisitorAttachmentDailyBandwidthLimit = 5*5000 + 123 // A little more than 1 upload and 3 downloads
  901. s := newTestServer(t, c)
  902. // Publish attachment
  903. response := request(t, s, "PUT", "/mytopic", content, nil)
  904. msg := toMessage(t, response.Body.String())
  905. require.Contains(t, msg.Attachment.URL, "http://127.0.0.1:12345/file/")
  906. // Get it 4 times successfully
  907. path := strings.TrimPrefix(msg.Attachment.URL, "http://127.0.0.1:12345")
  908. for i := 1; i <= 4; i++ { // 4 successful downloads
  909. response = request(t, s, "GET", path, "", nil)
  910. require.Equal(t, 200, response.Code)
  911. require.Equal(t, content, response.Body.String())
  912. }
  913. // And then fail with a 429
  914. response = request(t, s, "GET", path, "", nil)
  915. err := toHTTPError(t, response.Body.String())
  916. require.Equal(t, 429, response.Code)
  917. require.Equal(t, 42905, err.Code)
  918. }
  919. func TestServer_PublishAttachmentBandwidthLimitUploadOnly(t *testing.T) {
  920. content := util.RandomString(5000) // > 4096
  921. c := newTestConfig(t)
  922. c.VisitorAttachmentDailyBandwidthLimit = 5*5000 + 500 // 5 successful uploads
  923. s := newTestServer(t, c)
  924. // 5 successful uploads
  925. for i := 1; i <= 5; i++ {
  926. response := request(t, s, "PUT", "/mytopic", content, nil)
  927. msg := toMessage(t, response.Body.String())
  928. require.Contains(t, msg.Attachment.URL, "http://127.0.0.1:12345/file/")
  929. }
  930. // And a failed one
  931. response := request(t, s, "PUT", "/mytopic", content, nil)
  932. err := toHTTPError(t, response.Body.String())
  933. require.Equal(t, 400, response.Code)
  934. require.Equal(t, 40012, err.Code)
  935. }
  936. func newTestConfig(t *testing.T) *Config {
  937. conf := NewConfig()
  938. conf.BaseURL = "http://127.0.0.1:12345"
  939. conf.CacheFile = filepath.Join(t.TempDir(), "cache.db")
  940. conf.AttachmentCacheDir = t.TempDir()
  941. return conf
  942. }
  943. func newTestServer(t *testing.T, config *Config) *Server {
  944. server, err := New(config)
  945. if err != nil {
  946. t.Fatal(err)
  947. }
  948. return server
  949. }
  950. func request(t *testing.T, s *Server, method, url, body string, headers map[string]string) *httptest.ResponseRecorder {
  951. rr := httptest.NewRecorder()
  952. req, err := http.NewRequest(method, url, strings.NewReader(body))
  953. if err != nil {
  954. t.Fatal(err)
  955. }
  956. req.RemoteAddr = "9.9.9.9" // Used for tests
  957. for k, v := range headers {
  958. req.Header.Set(k, v)
  959. }
  960. s.handle(rr, req)
  961. return rr
  962. }
  963. func subscribe(t *testing.T, s *Server, url string, rr *httptest.ResponseRecorder) context.CancelFunc {
  964. ctx, cancel := context.WithCancel(context.Background())
  965. req, err := http.NewRequestWithContext(ctx, "GET", url, nil)
  966. if err != nil {
  967. t.Fatal(err)
  968. }
  969. done := make(chan bool)
  970. go func() {
  971. s.handle(rr, req)
  972. done <- true
  973. }()
  974. cancelAndWaitForDone := func() {
  975. time.Sleep(100 * time.Millisecond)
  976. cancel()
  977. <-done
  978. }
  979. time.Sleep(100 * time.Millisecond)
  980. return cancelAndWaitForDone
  981. }
  982. func toMessages(t *testing.T, s string) []*message {
  983. messages := make([]*message, 0)
  984. scanner := bufio.NewScanner(strings.NewReader(s))
  985. for scanner.Scan() {
  986. messages = append(messages, toMessage(t, scanner.Text()))
  987. }
  988. return messages
  989. }
  990. func toMessage(t *testing.T, s string) *message {
  991. var m message
  992. require.Nil(t, json.NewDecoder(strings.NewReader(s)).Decode(&m))
  993. return &m
  994. }
  995. func toHTTPError(t *testing.T, s string) *errHTTP {
  996. var e errHTTP
  997. require.Nil(t, json.NewDecoder(strings.NewReader(s)).Decode(&e))
  998. return &e
  999. }
  1000. func firebaseServiceAccountFile(t *testing.T) string {
  1001. if os.Getenv("NTFY_TEST_FIREBASE_SERVICE_ACCOUNT_FILE") != "" {
  1002. return os.Getenv("NTFY_TEST_FIREBASE_SERVICE_ACCOUNT_FILE")
  1003. } else if os.Getenv("NTFY_TEST_FIREBASE_SERVICE_ACCOUNT") != "" {
  1004. filename := filepath.Join(t.TempDir(), "firebase.json")
  1005. require.NotNil(t, os.WriteFile(filename, []byte(os.Getenv("NTFY_TEST_FIREBASE_SERVICE_ACCOUNT")), 0600))
  1006. return filename
  1007. }
  1008. t.SkipNow()
  1009. return ""
  1010. }
  1011. func basicAuth(s string) string {
  1012. return fmt.Sprintf("Basic %s", base64.StdEncoding.EncodeToString([]byte(s)))
  1013. }