server_test.go 40 KB

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