server_test.go 42 KB

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