package server import ( "bufio" "context" "encoding/json" "fmt" "github.com/stretchr/testify/require" "net/http" "net/http/httptest" "os" "path/filepath" "strings" "sync" "testing" "time" ) func TestServer_PublishAndPoll(t *testing.T) { s := newTestServer(t, newTestConfig(t)) response1 := request(t, s, "PUT", "/mytopic", "my first message", nil) msg1 := toMessage(t, response1.Body.String()) require.NotEmpty(t, msg1.ID) require.Equal(t, "my first message", msg1.Message) response2 := request(t, s, "PUT", "/mytopic", "my second\n\nmessage", nil) msg2 := toMessage(t, response2.Body.String()) require.NotEqual(t, msg1.ID, msg2.ID) require.NotEmpty(t, msg2.ID) require.Equal(t, "my second\n\nmessage", msg2.Message) response := request(t, s, "GET", "/mytopic/json?poll=1", "", nil) messages := toMessages(t, response.Body.String()) require.Equal(t, 2, len(messages)) require.Equal(t, "my first message", messages[0].Message) require.Equal(t, "my second\n\nmessage", messages[1].Message) response = request(t, s, "GET", "/mytopic/sse?poll=1&since=all", "", nil) lines := strings.Split(strings.TrimSpace(response.Body.String()), "\n") require.Equal(t, 3, len(lines)) require.Equal(t, "my first message", toMessage(t, strings.TrimPrefix(lines[0], "data: ")).Message) require.Equal(t, "", lines[1]) require.Equal(t, "my second\n\nmessage", toMessage(t, strings.TrimPrefix(lines[2], "data: ")).Message) response = request(t, s, "GET", "/mytopic/raw?poll=1", "", nil) lines = strings.Split(strings.TrimSpace(response.Body.String()), "\n") require.Equal(t, 2, len(lines)) require.Equal(t, "my first message", lines[0]) require.Equal(t, "my second message", lines[1]) // \n -> " " } func TestServer_SubscribeOpenAndKeepalive(t *testing.T) { c := newTestConfig(t) c.KeepaliveInterval = time.Second s := newTestServer(t, c) rr := httptest.NewRecorder() ctx, cancel := context.WithCancel(context.Background()) req, err := http.NewRequestWithContext(ctx, "GET", "/mytopic/json", nil) if err != nil { t.Fatal(err) } doneChan := make(chan bool) go func() { s.handle(rr, req) doneChan <- true }() time.Sleep(1300 * time.Millisecond) cancel() <-doneChan messages := toMessages(t, rr.Body.String()) require.Equal(t, 2, len(messages)) require.Equal(t, openEvent, messages[0].Event) require.Equal(t, "mytopic", messages[0].Topic) require.Equal(t, "", messages[0].Message) require.Equal(t, "", messages[0].Title) require.Equal(t, 0, messages[0].Priority) require.Nil(t, messages[0].Tags) require.Equal(t, keepaliveEvent, messages[1].Event) require.Equal(t, "mytopic", messages[1].Topic) require.Equal(t, "", messages[1].Message) require.Equal(t, "", messages[1].Title) require.Equal(t, 0, messages[1].Priority) require.Nil(t, messages[1].Tags) } func TestServer_PublishAndSubscribe(t *testing.T) { s := newTestServer(t, newTestConfig(t)) subscribeRR := httptest.NewRecorder() subscribeCancel := subscribe(t, s, "/mytopic/json", subscribeRR) publishFirstRR := request(t, s, "PUT", "/mytopic", "my first message", nil) require.Equal(t, 200, publishFirstRR.Code) publishSecondRR := request(t, s, "PUT", "/mytopic", "my other message", map[string]string{ "Title": " This is a title ", "X-Tags": "tag1,tag 2, tag3", "p": "1", }) require.Equal(t, 200, publishSecondRR.Code) subscribeCancel() messages := toMessages(t, subscribeRR.Body.String()) require.Equal(t, 3, len(messages)) require.Equal(t, openEvent, messages[0].Event) require.Equal(t, messageEvent, messages[1].Event) require.Equal(t, "mytopic", messages[1].Topic) require.Equal(t, "my first message", messages[1].Message) require.Equal(t, "", messages[1].Title) require.Equal(t, 0, messages[1].Priority) require.Nil(t, messages[1].Tags) require.Equal(t, messageEvent, messages[2].Event) require.Equal(t, "mytopic", messages[2].Topic) require.Equal(t, "my other message", messages[2].Message) require.Equal(t, "This is a title", messages[2].Title) require.Equal(t, 1, messages[2].Priority) require.Equal(t, []string{"tag1", "tag 2", "tag3"}, messages[2].Tags) } func TestServer_StaticSites(t *testing.T) { s := newTestServer(t, newTestConfig(t)) rr := request(t, s, "GET", "/", "", nil) require.Equal(t, 200, rr.Code) require.Contains(t, rr.Body.String(), "") rr = request(t, s, "HEAD", "/", "", nil) require.Equal(t, 200, rr.Code) rr = request(t, s, "OPTIONS", "/", "", nil) require.Equal(t, 200, rr.Code) rr = request(t, s, "GET", "/does-not-exist.txt", "", nil) require.Equal(t, 404, rr.Code) rr = request(t, s, "GET", "/mytopic", "", nil) require.Equal(t, 200, rr.Code) require.Contains(t, rr.Body.String(), ``) rr = request(t, s, "GET", "/static/css/app.css", "", nil) require.Equal(t, 200, rr.Code) require.Contains(t, rr.Body.String(), `html, body {`) rr = request(t, s, "GET", "/docs", "", nil) require.Equal(t, 301, rr.Code) rr = request(t, s, "GET", "/docs/", "", nil) require.Equal(t, 200, rr.Code) require.Contains(t, rr.Body.String(), `Made with ❤️ by Philipp C. Heckel`) require.Contains(t, rr.Body.String(), ``) rr = request(t, s, "GET", "/example.html", "", nil) require.Equal(t, 200, rr.Code) require.Contains(t, rr.Body.String(), "") } func TestServer_PublishLargeMessage(t *testing.T) { s := newTestServer(t, newTestConfig(t)) body := strings.Repeat("this is a large message", 1000) truncated := body[0:512] response := request(t, s, "PUT", "/mytopic", body, nil) msg := toMessage(t, response.Body.String()) require.NotEmpty(t, msg.ID) require.Equal(t, truncated, msg.Message) response = request(t, s, "GET", "/mytopic/json?poll=1", "", nil) messages := toMessages(t, response.Body.String()) require.Equal(t, 1, len(messages)) require.Equal(t, truncated, messages[0].Message) } func TestServer_PublishPriority(t *testing.T) { s := newTestServer(t, newTestConfig(t)) for prio := 1; prio <= 5; prio++ { response := request(t, s, "GET", fmt.Sprintf("/mytopic/publish?priority=%d", prio), fmt.Sprintf("priority %d", prio), nil) msg := toMessage(t, response.Body.String()) require.Equal(t, prio, msg.Priority) } response := request(t, s, "GET", "/mytopic/publish?priority=min", "test", nil) require.Equal(t, 1, toMessage(t, response.Body.String()).Priority) response = request(t, s, "GET", "/mytopic/send?priority=low", "test", nil) require.Equal(t, 2, toMessage(t, response.Body.String()).Priority) response = request(t, s, "GET", "/mytopic/send?priority=default", "test", nil) require.Equal(t, 3, toMessage(t, response.Body.String()).Priority) response = request(t, s, "GET", "/mytopic/send?priority=high", "test", nil) require.Equal(t, 4, toMessage(t, response.Body.String()).Priority) response = request(t, s, "GET", "/mytopic/send?priority=max", "test", nil) require.Equal(t, 5, toMessage(t, response.Body.String()).Priority) response = request(t, s, "GET", "/mytopic/trigger?priority=urgent", "test", nil) require.Equal(t, 5, toMessage(t, response.Body.String()).Priority) } func TestServer_PublishNoCache(t *testing.T) { s := newTestServer(t, newTestConfig(t)) response := request(t, s, "PUT", "/mytopic", "this message is not cached", map[string]string{ "Cache": "no", }) msg := toMessage(t, response.Body.String()) require.NotEmpty(t, msg.ID) require.Equal(t, "this message is not cached", msg.Message) response = request(t, s, "GET", "/mytopic/json?poll=1", "", nil) messages := toMessages(t, response.Body.String()) require.Empty(t, messages) } func TestServer_PublishAt(t *testing.T) { c := newTestConfig(t) c.MinDelay = time.Second c.AtSenderInterval = 100 * time.Millisecond s := newTestServer(t, c) response := request(t, s, "PUT", "/mytopic", "a message", map[string]string{ "In": "1s", }) require.Equal(t, 200, response.Code) response = request(t, s, "GET", "/mytopic/json?poll=1", "", nil) messages := toMessages(t, response.Body.String()) require.Equal(t, 0, len(messages)) time.Sleep(time.Second) require.Nil(t, s.sendDelayedMessages()) response = request(t, s, "GET", "/mytopic/json?poll=1", "", nil) messages = toMessages(t, response.Body.String()) require.Equal(t, 1, len(messages)) require.Equal(t, "a message", messages[0].Message) } func TestServer_PublishAtWithCacheError(t *testing.T) { s := newTestServer(t, newTestConfig(t)) response := request(t, s, "PUT", "/mytopic", "a message", map[string]string{ "Cache": "no", "In": "30 min", }) require.Equal(t, 400, response.Code) require.Equal(t, errHTTPBadRequestDelayNoCache, toHTTPError(t, response.Body.String())) } func TestServer_PublishAtTooShortDelay(t *testing.T) { s := newTestServer(t, newTestConfig(t)) response := request(t, s, "PUT", "/mytopic", "a message", map[string]string{ "In": "1s", }) require.Equal(t, 400, response.Code) } func TestServer_PublishAtTooLongDelay(t *testing.T) { s := newTestServer(t, newTestConfig(t)) response := request(t, s, "PUT", "/mytopic", "a message", map[string]string{ "In": "99999999h", }) require.Equal(t, 400, response.Code) } func TestServer_PublishAtAndPrune(t *testing.T) { s := newTestServer(t, newTestConfig(t)) response := request(t, s, "PUT", "/mytopic", "a message", map[string]string{ "In": "1h", }) require.Equal(t, 200, response.Code) s.updateStatsAndPrune() // Fire pruning response = request(t, s, "GET", "/mytopic/json?poll=1&scheduled=1", "", nil) messages := toMessages(t, response.Body.String()) require.Equal(t, 1, len(messages)) // Not affected by pruning require.Equal(t, "a message", messages[0].Message) } func TestServer_PublishAndMultiPoll(t *testing.T) { s := newTestServer(t, newTestConfig(t)) response := request(t, s, "PUT", "/mytopic1", "message 1", nil) msg := toMessage(t, response.Body.String()) require.NotEmpty(t, msg.ID) require.Equal(t, "mytopic1", msg.Topic) require.Equal(t, "message 1", msg.Message) response = request(t, s, "PUT", "/mytopic2", "message 2", nil) msg = toMessage(t, response.Body.String()) require.NotEmpty(t, msg.ID) require.Equal(t, "mytopic2", msg.Topic) require.Equal(t, "message 2", msg.Message) response = request(t, s, "GET", "/mytopic1/json?poll=1", "", nil) messages := toMessages(t, response.Body.String()) require.Equal(t, 1, len(messages)) require.Equal(t, "mytopic1", messages[0].Topic) require.Equal(t, "message 1", messages[0].Message) response = request(t, s, "GET", "/mytopic1,mytopic2/json?poll=1", "", nil) messages = toMessages(t, response.Body.String()) require.Equal(t, 2, len(messages)) require.Equal(t, "mytopic1", messages[0].Topic) require.Equal(t, "message 1", messages[0].Message) require.Equal(t, "mytopic2", messages[1].Topic) require.Equal(t, "message 2", messages[1].Message) } func TestServer_PublishWithNopCache(t *testing.T) { c := newTestConfig(t) c.CacheDuration = 0 s := newTestServer(t, c) subscribeRR := httptest.NewRecorder() subscribeCancel := subscribe(t, s, "/mytopic/json", subscribeRR) publishRR := request(t, s, "PUT", "/mytopic", "my first message", nil) require.Equal(t, 200, publishRR.Code) subscribeCancel() messages := toMessages(t, subscribeRR.Body.String()) require.Equal(t, 2, len(messages)) require.Equal(t, openEvent, messages[0].Event) require.Equal(t, messageEvent, messages[1].Event) require.Equal(t, "my first message", messages[1].Message) response := request(t, s, "GET", "/mytopic/json?poll=1", "", nil) messages = toMessages(t, response.Body.String()) require.Empty(t, messages) } func TestServer_PublishAndPollSince(t *testing.T) { s := newTestServer(t, newTestConfig(t)) request(t, s, "PUT", "/mytopic", "test 1", nil) time.Sleep(1100 * time.Millisecond) since := time.Now().Unix() request(t, s, "PUT", "/mytopic", "test 2", nil) response := request(t, s, "GET", fmt.Sprintf("/mytopic/json?poll=1&since=%d", since), "", nil) messages := toMessages(t, response.Body.String()) require.Equal(t, 1, len(messages)) require.Equal(t, "test 2", messages[0].Message) } func TestServer_PublishViaGET(t *testing.T) { s := newTestServer(t, newTestConfig(t)) response := request(t, s, "GET", "/mytopic/trigger", "", nil) msg := toMessage(t, response.Body.String()) require.NotEmpty(t, msg.ID) require.Equal(t, "triggered", msg.Message) 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) msg = toMessage(t, response.Body.String()) require.NotEmpty(t, msg.ID) require.Equal(t, "This is a test", msg.Message) require.Equal(t, "This is a title", msg.Title) require.Equal(t, []string{"skull"}, msg.Tags) require.Equal(t, 5, msg.Priority) require.Greater(t, msg.Time, time.Now().Add(23*time.Hour).Unix()) } func TestServer_PublishFirebase(t *testing.T) { // This is unfortunately not much of a test, since it merely fires the messages towards Firebase, // but cannot re-read them. There is no way from Go to read the messages back, or even get an error back. // I tried everything. I already had written the test, and it increases the code coverage, so I'll leave it ... :shrug: ... c := newTestConfig(t) c.FirebaseKeyFile = firebaseServiceAccountFile(t) // May skip the test! s := newTestServer(t, c) // Normal message response := request(t, s, "PUT", "/mytopic", "This is a message for firebase", nil) msg := toMessage(t, response.Body.String()) require.NotEmpty(t, msg.ID) // Keepalive message require.Nil(t, s.firebase(newKeepaliveMessage(firebaseControlTopic))) time.Sleep(500 * time.Millisecond) // Time for sends } func TestServer_PollWithQueryFilters(t *testing.T) { s := newTestServer(t, newTestConfig(t)) response := request(t, s, "PUT", "/mytopic?priority=1&tags=tag1,tag2", "my first message", nil) msg := toMessage(t, response.Body.String()) require.NotEmpty(t, msg.ID) response = request(t, s, "PUT", "/mytopic?title=a+title", "my second message", map[string]string{ "Tags": "tag2,tag3", }) msg = toMessage(t, response.Body.String()) require.NotEmpty(t, msg.ID) queriesThatShouldReturnMessageOne := []string{ "/mytopic/json?poll=1&priority=1", "/mytopic/json?poll=1&priority=min", "/mytopic/json?poll=1&priority=min,low", "/mytopic/json?poll=1&priority=1,2", "/mytopic/json?poll=1&p=2,min", "/mytopic/json?poll=1&tags=tag1", "/mytopic/json?poll=1&tags=tag1,tag2", "/mytopic/json?poll=1&message=my+first+message", } for _, query := range queriesThatShouldReturnMessageOne { response = request(t, s, "GET", query, "", nil) messages := toMessages(t, response.Body.String()) require.Equal(t, 1, len(messages), "Query failed: "+query) require.Equal(t, "my first message", messages[0].Message, "Query failed: "+query) } queriesThatShouldReturnMessageTwo := []string{ "/mytopic/json?poll=1&x-priority=3", // ! "/mytopic/json?poll=1&priority=3", "/mytopic/json?poll=1&priority=default", "/mytopic/json?poll=1&p=3", "/mytopic/json?poll=1&x-tags=tag2,tag3", "/mytopic/json?poll=1&tags=tag2,tag3", "/mytopic/json?poll=1&tag=tag2,tag3", "/mytopic/json?poll=1&ta=tag2,tag3", "/mytopic/json?poll=1&x-title=a+title", "/mytopic/json?poll=1&title=a+title", "/mytopic/json?poll=1&t=a+title", "/mytopic/json?poll=1&x-message=my+second+message", "/mytopic/json?poll=1&message=my+second+message", "/mytopic/json?poll=1&m=my+second+message", "/mytopic/json?x-poll=1&m=my+second+message", "/mytopic/json?po=1&m=my+second+message", } for _, query := range queriesThatShouldReturnMessageTwo { response = request(t, s, "GET", query, "", nil) messages := toMessages(t, response.Body.String()) require.Equal(t, 1, len(messages), "Query failed: "+query) require.Equal(t, "my second message", messages[0].Message, "Query failed: "+query) } queriesThatShouldReturnNoMessages := []string{ "/mytopic/json?poll=1&priority=4", "/mytopic/json?poll=1&tags=tag1,tag2,tag3", "/mytopic/json?poll=1&title=another+title", "/mytopic/json?poll=1&message=my+third+message", "/mytopic/json?poll=1&message=my+third+message", } for _, query := range queriesThatShouldReturnNoMessages { response = request(t, s, "GET", query, "", nil) messages := toMessages(t, response.Body.String()) require.Equal(t, 0, len(messages), "Query failed: "+query) } } func TestServer_SubscribeWithQueryFilters(t *testing.T) { c := newTestConfig(t) c.KeepaliveInterval = 800 * time.Millisecond s := newTestServer(t, c) subscribeResponse := httptest.NewRecorder() subscribeCancel := subscribe(t, s, "/mytopic/json?tags=zfs-issue", subscribeResponse) response := request(t, s, "PUT", "/mytopic", "my first message", nil) require.Equal(t, 200, response.Code) response = request(t, s, "PUT", "/mytopic", "ZFS scrub failed", map[string]string{ "Tags": "zfs-issue,zfs-scrub", }) require.Equal(t, 200, response.Code) time.Sleep(850 * time.Millisecond) subscribeCancel() messages := toMessages(t, subscribeResponse.Body.String()) require.Equal(t, 3, len(messages)) require.Equal(t, openEvent, messages[0].Event) require.Equal(t, messageEvent, messages[1].Event) require.Equal(t, "ZFS scrub failed", messages[1].Message) require.Equal(t, keepaliveEvent, messages[2].Event) } /* func TestServer_Curl_Publish_Poll(t *testing.T) { s, port := test.StartServer(t) defer test.StopServer(t, s, port) cmd := exec.Command("sh", "-c", fmt.Sprintf(`curl -sd "This is a test" localhost:%d/mytopic`, port)) require.Nil(t, cmd.Run()) b, err := cmd.CombinedOutput() require.Nil(t, err) msg := toMessage(t, string(b)) require.Equal(t, "This is a test", msg.Message) cmd = exec.Command("sh", "-c", fmt.Sprintf(`curl "localhost:%d/mytopic?poll=1"`, port)) require.Nil(t, cmd.Run()) b, err = cmd.CombinedOutput() require.Nil(t, err) msg = toMessage(t, string(b)) require.Equal(t, "This is a test", msg.Message) } */ type testMailer struct { count int mu sync.Mutex } func (t *testMailer) Send(from, to string, m *message) error { t.mu.Lock() defer t.mu.Unlock() t.count++ return nil } func TestServer_PublishTooManyEmails_Defaults(t *testing.T) { s := newTestServer(t, newTestConfig(t)) s.mailer = &testMailer{} for i := 0; i < 16; i++ { response := request(t, s, "PUT", "/mytopic", fmt.Sprintf("message %d", i), map[string]string{ "E-Mail": "test@example.com", }) require.Equal(t, 200, response.Code) } response := request(t, s, "PUT", "/mytopic", "one too many", map[string]string{ "E-Mail": "test@example.com", }) require.Equal(t, 429, response.Code) } func TestServer_PublishTooManyEmails_Replenish(t *testing.T) { c := newTestConfig(t) c.VisitorEmailLimitReplenish = 500 * time.Millisecond s := newTestServer(t, c) s.mailer = &testMailer{} for i := 0; i < 16; i++ { response := request(t, s, "PUT", "/mytopic", fmt.Sprintf("message %d", i), map[string]string{ "E-Mail": "test@example.com", }) require.Equal(t, 200, response.Code) } response := request(t, s, "PUT", "/mytopic", "one too many", map[string]string{ "E-Mail": "test@example.com", }) require.Equal(t, 429, response.Code) time.Sleep(510 * time.Millisecond) response = request(t, s, "PUT", "/mytopic", "this should be okay again too many", map[string]string{ "E-Mail": "test@example.com", }) require.Equal(t, 200, response.Code) response = request(t, s, "PUT", "/mytopic", "and bad again", map[string]string{ "E-Mail": "test@example.com", }) require.Equal(t, 429, response.Code) } func TestServer_PublishDelayedEmail_Fail(t *testing.T) { s := newTestServer(t, newTestConfig(t)) s.mailer = &testMailer{} response := request(t, s, "PUT", "/mytopic", "fail", map[string]string{ "E-Mail": "test@example.com", "Delay": "20 min", }) require.Equal(t, 400, response.Code) } func TestServer_PublishEmailNoMailer_Fail(t *testing.T) { s := newTestServer(t, newTestConfig(t)) response := request(t, s, "PUT", "/mytopic", "fail", map[string]string{ "E-Mail": "test@example.com", }) require.Equal(t, 400, response.Code) } func newTestConfig(t *testing.T) *Config { conf := NewConfig() conf.CacheFile = filepath.Join(t.TempDir(), "cache.db") return conf } func newTestServer(t *testing.T, config *Config) *Server { server, err := New(config) if err != nil { t.Fatal(err) } return server } func request(t *testing.T, s *Server, method, url, body string, headers map[string]string) *httptest.ResponseRecorder { rr := httptest.NewRecorder() req, err := http.NewRequest(method, url, strings.NewReader(body)) if err != nil { t.Fatal(err) } for k, v := range headers { req.Header.Set(k, v) } s.handle(rr, req) return rr } func subscribe(t *testing.T, s *Server, url string, rr *httptest.ResponseRecorder) context.CancelFunc { ctx, cancel := context.WithCancel(context.Background()) req, err := http.NewRequestWithContext(ctx, "GET", url, nil) if err != nil { t.Fatal(err) } done := make(chan bool) go func() { s.handle(rr, req) done <- true }() cancelAndWaitForDone := func() { time.Sleep(100 * time.Millisecond) cancel() <-done } time.Sleep(100 * time.Millisecond) return cancelAndWaitForDone } func toMessages(t *testing.T, s string) []*message { messages := make([]*message, 0) scanner := bufio.NewScanner(strings.NewReader(s)) for scanner.Scan() { messages = append(messages, toMessage(t, scanner.Text())) } return messages } func toMessage(t *testing.T, s string) *message { var m message require.Nil(t, json.NewDecoder(strings.NewReader(s)).Decode(&m)) return &m } func toHTTPError(t *testing.T, s string) *errHTTP { var e errHTTP require.Nil(t, json.NewDecoder(strings.NewReader(s)).Decode(&e)) return &e } func firebaseServiceAccountFile(t *testing.T) string { if os.Getenv("NTFY_TEST_FIREBASE_SERVICE_ACCOUNT_FILE") != "" { return os.Getenv("NTFY_TEST_FIREBASE_SERVICE_ACCOUNT_FILE") } else if os.Getenv("NTFY_TEST_FIREBASE_SERVICE_ACCOUNT") != "" { filename := filepath.Join(t.TempDir(), "firebase.json") require.NotNil(t, os.WriteFile(filename, []byte(os.Getenv("NTFY_TEST_FIREBASE_SERVICE_ACCOUNT")), 0600)) return filename } t.SkipNow() return "" }