server_test.go 49 KB

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