add a log volume test

hugodutka · hugodutka · commit 4b8a30e2018b · 2025-02-18T17:13:38.000Z
diff --git a/cli/server_test.go b/cli/server_test.go
@@ -240,6 +240,57 @@ func TestServer(t *testing.T) {
 			t.Fatalf("expected postgres URL to start with \"postgres://\", got %q", got)
 		}
 	})
+	t.Run("SpammyLogs", func(t *testing.T) {
+		// The purpose of this test is to ensure we don't show excessive logs when the server starts.
+		t.Parallel()
+		inv, cfg := clitest.New(t,
+			"server",
+			"--in-memory",
+			"--http-address", ":0",
+			"--access-url", "http://localhost:3000/",
+			"--cache-dir", t.TempDir(),
+		)
+
+		bufferStdout := bytes.NewBuffer(nil)
+		bufferStderr := bytes.NewBuffer(nil)
+		inv.Stdout = io.MultiWriter(os.Stdout, bufferStdout)
+		inv.Stderr = io.MultiWriter(os.Stderr, bufferStderr)
+		clitest.Start(t, inv)
+
+		// Wait for startup
+		_ = waitAccessURL(t, cfg)
+
+		// Wait a bit for more logs to be printed.
+		time.Sleep(testutil.WaitShort)
+
+		// Lines containing these strings are printed because we're
+		// running the server with a test config. They wouldn't be
+		// normally shown to the user, so we'll ignore them.
+		ignoreLines := []string{
+			"isn't externally reachable",
+			"install.sh will be unavailable",
+			"telemetry disabled, unable to notify of security issues",
+		}
+
+		countLines := func(fullOutput string, terminalWidth int) int {
+			lines := strings.Split(fullOutput, "\n")
+			count := 0
+		lineLoop:
+			for _, line := range lines {
+				for _, ignoreLine := range ignoreLines {
+					if strings.Contains(line, ignoreLine) {
+						continue lineLoop
+					}
+				}
+				count += (len(line) + terminalWidth - 1) / terminalWidth
+			}
+			return count
+		}
+
+		terminalWidth := 80
+		numLines := countLines(bufferStdout.String(), terminalWidth) + countLines(bufferStderr.String(), terminalWidth)
+		require.Less(t, numLines, 20)
+	})
 
 	// Validate that a warning is printed that it may not be externally
 	// reachable.
