Skip to content

armgit / Pulse

Public Imported from GitHub
0

Real-time monitoring dashboard for Proxmox VE, PBS, Docker, Kubernetes, TrueNAS and vSphere. Self-hosted, with alerts for failed backups, full disks, unhealthy containers and offline nodes.

7.1 KB
Raw Blame
package websocket

import (
	"encoding/json"
	"net/http"
	"net/http/httptest"
	"reflect"
	"strings"
	"testing"
	"time"

	"github.com/gorilla/websocket"
	"github.com/rcourtman/pulse-go-rewrite/internal/securityutil"
)

func wsHeadersForHTTP(t *testing.T, serverURL string) http.Header {
	t.Helper()

	origin, err := securityutil.HTTPOriginForWebSocketBaseURL(serverURL)
	if err != nil {
		t.Fatalf("failed to derive websocket origin: %v", err)
	}

	headers := http.Header{}
	headers.Set("Origin", origin)
	return headers
}

func TestBroadcastStateEnqueuesRawData(t *testing.T) {
	hub := NewHub(nil)
	state := struct {
		DockerHosts []string
	}{DockerHosts: []string{"a", "b"}}

	hub.BroadcastState(state)

	select {
	case msg := <-hub.broadcastSeq:
		if msg.Type != "rawData" {
			t.Fatalf("unexpected message type: %s", msg.Type)
		}
		if !reflect.DeepEqual(msg.Data, state) {
			t.Fatalf("unexpected state payload: %+v", msg.Data)
		}
	case <-time.After(200 * time.Millisecond):
		t.Fatal("expected broadcastSeq message")
	}
}

func TestBroadcastAlertResolvedAndCustom(t *testing.T) {
	hub := NewHub(nil)

	hub.BroadcastAlertResolvedToTenant("", "alert-1")
	select {
	case event := <-hub.tenantBroadcast:
		if event.OrgID != "default" {
			t.Fatalf("unexpected org: %s", event.OrgID)
		}
		data, err := json.Marshal(event.Message)
		if err != nil {
			t.Fatal(err)
		}
		var msg Message
		if err := json.Unmarshal(data, &msg); err != nil {
			t.Fatalf("unmarshal message: %v", err)
		}
		if msg.Type != "alertResolved" {
			t.Fatalf("unexpected type: %s", msg.Type)
		}
		payload := msg.Data.(map[string]interface{})
		if payload["alertIdentifier"] != "alert-1" {
			t.Fatalf("unexpected alertIdentifier: %v", payload["alertIdentifier"])
		}
	case <-time.After(200 * time.Millisecond):
		t.Fatal("expected alertResolved broadcast")
	}

	hub.BroadcastToTenant("", map[string]string{"status": "ok"})
	select {
	case event := <-hub.tenantBroadcast:
		if event.OrgID != "default" {
			t.Fatalf("unexpected org: %s", event.OrgID)
		}
		data, err := json.Marshal(event.Message)
		if err != nil {
			t.Fatal(err)
		}
		var msg Message
		if err := json.Unmarshal(data, &msg); err != nil {
			t.Fatalf("unmarshal message: %v", err)
		}
		if msg.Type != "custom" {
			t.Fatalf("unexpected type: %s", msg.Type)
		}
		if msg.Timestamp == "" {
			t.Fatal("expected timestamp on custom broadcast")
		}
	case <-time.After(200 * time.Millisecond):
		t.Fatal("expected custom broadcast")
	}
}

func TestSendPingEnqueuesMessage(t *testing.T) {
	hub := NewHub(nil)
	hub.sendPing()

	select {
	case data := <-hub.broadcast:
		var msg Message
		if err := json.Unmarshal(data, &msg); err != nil {
			t.Fatalf("unmarshal message: %v", err)
		}
		if msg.Type != "ping" {
			t.Fatalf("unexpected type: %s", msg.Type)
		}
		payload := msg.Data.(map[string]interface{})
		if _, ok := payload["timestamp"]; !ok {
			t.Fatal("expected ping timestamp")
		}
	case <-time.After(200 * time.Millisecond):
		t.Fatal("expected ping broadcast")
	}
}

func TestStopClosesChannel(t *testing.T) {
	hub := NewHub(nil)
	hub.Stop()

	select {
	case _, ok := <-hub.stopChan:
		if ok {
			t.Fatal("expected stopChan to be closed")
		}
	case <-time.After(200 * time.Millisecond):
		t.Fatal("expected stopChan closure")
	}
}

func TestStopIsIdempotent(t *testing.T) {
	hub := NewHub(nil)
	hub.Stop()
	hub.Stop()

	select {
	case _, ok := <-hub.stopChan:
		if ok {
			t.Fatal("expected stopChan to be closed")
		}
	default:
		t.Fatal("expected stopChan to be closed after repeated Stop calls")
	}
}

func TestTryRegisterClientReturnsFalseWhenStopped(t *testing.T) {
	hub := NewHub(nil)
	hub.Stop()

	done := make(chan bool, 1)
	go func() {
		done <- hub.tryRegisterClient(&Client{
			hub:  hub,
			id:   "stopped-client",
			send: make(chan []byte, 1),
		})
	}()

	select {
	case ok := <-done:
		if ok {
			t.Fatal("expected tryRegisterClient to reject client during shutdown")
		}
	case <-time.After(200 * time.Millisecond):
		t.Fatal("tryRegisterClient blocked during shutdown")
	}
}

func TestBroadcastStateSkippedWhenStopped(t *testing.T) {
	hub := NewHub(nil)
	hub.Stop()

	hub.BroadcastState(map[string]string{"status": "down"})

	select {
	case <-hub.broadcastSeq:
		t.Fatal("expected no broadcastSeq enqueue while hub is stopping")
	default:
	}
}

func TestHandleWebSocketPingPong(t *testing.T) {
	hub := NewHub(nil)
	go hub.Run()
	t.Cleanup(hub.Stop)

	server := httptest.NewServer(http.HandlerFunc(hub.HandleWebSocket))
	defer server.Close()

	wsURL := "ws" + strings.TrimPrefix(server.URL, "http") + "?org_id=default"
	conn, _, err := websocket.DefaultDialer.Dial(wsURL, wsHeadersForHTTP(t, server.URL))
	if err != nil {
		t.Fatalf("dial websocket: %v", err)
	}
	defer conn.Close()

	if err := conn.WriteJSON(Message{Type: "ping"}); err != nil {
		t.Fatalf("write ping: %v", err)
	}

	deadline := time.Now().Add(1 * time.Second)
	for time.Now().Before(deadline) {
		if err := conn.SetReadDeadline(time.Now().Add(200 * time.Millisecond)); err != nil {
			t.Fatalf("set read deadline: %v", err)
		}
		_, data, err := conn.ReadMessage()
		if err != nil {
			continue
		}
		var msg Message
		if err := json.Unmarshal(data, &msg); err != nil {
			t.Fatalf("unmarshal message: %v", err)
		}
		if msg.Type == "pong" {
			return
		}
	}

	t.Fatal("expected pong response")
}

func TestHandleWebSocket_ReadLimitExceededClosesConnection(t *testing.T) {
	hub := NewHub(nil)
	go hub.Run()
	t.Cleanup(hub.Stop)

	server := httptest.NewServer(http.HandlerFunc(hub.HandleWebSocket))
	defer server.Close()

	wsURL := "ws" + strings.TrimPrefix(server.URL, "http") + "?org_id=default"
	dialer := websocket.Dialer{
		// Disable compression so the oversized payload hits the server's
		// read limit on the wire (repeated bytes compress too well).
		EnableCompression: false,
	}

	conn, _, err := dialer.Dial(wsURL, wsHeadersForHTTP(t, server.URL))
	if err != nil {
		t.Fatalf("dial websocket: %v", err)
	}
	defer conn.Close()

	oversizedPayload, err := json.Marshal(Message{
		Type: "ping",
		Data: strings.Repeat("x", maxWebSocketInboundMessageSize),
	})
	if err != nil {
		t.Fatalf("marshal oversized payload: %v", err)
	}
	if len(oversizedPayload) <= maxWebSocketInboundMessageSize {
		t.Fatalf("test payload must exceed read limit, got %d bytes", len(oversizedPayload))
	}

	if err := conn.WriteMessage(websocket.TextMessage, oversizedPayload); err != nil {
		t.Fatalf("write oversized payload: %v", err)
	}

	// Drain messages until the server closes the connection. The goroutine
	// approach avoids gorilla/websocket's panic on retry after a timeout-induced
	// fatal error — we set a long deadline so the only "fatal" read would be
	// the close frame itself, after which we exit the loop immediately.
	if err := conn.SetReadDeadline(time.Now().Add(5 * time.Second)); err != nil {
		t.Fatalf("set read deadline: %v", err)
	}
	closed := make(chan struct{})
	go func() {
		defer close(closed)
		for {
			if _, _, err := conn.ReadMessage(); err != nil {
				return
			}
		}
	}()
	select {
	case <-closed:
		// Server closed the connection as expected
	case <-time.After(5 * time.Second):
		t.Fatal("expected websocket connection to close after oversized inbound message")
	}
}