server_test.go 46 KB

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