server_test.go 40 KB

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