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.
Go aialertsdashboarddockerdocker-monitoringgohomelabinfrastructure-monitoringkubernetesmonitoringmspproxmoxproxmox-backup-serverproxmox-mail-gatewayproxmox-veself-hostedtruenastypescriptvspherewebhooks
package api
import (
"bytes"
"crypto/sha256"
"encoding/hex"
"fmt"
"io"
"net/http"
"net/http/httptest"
"os"
"path/filepath"
"strings"
"testing"
)
func TestDownloadAgentHelperRejectsUnsupportedArchitecture(t *testing.T) {
router := &Router{}
request := httptest.NewRequest(http.MethodGet, "/download/pulse-agent-helper?arch=darwin-arm64", nil)
response := httptest.NewRecorder()
router.handleDownloadAgentHelper(response, request)
if response.Code != http.StatusBadRequest {
t.Fatalf("status = %d, want %d", response.Code, http.StatusBadRequest)
}
}
func TestDownloadAgentHelperServesSignedLocalLinuxBinary(t *testing.T) {
router, root := setupUnifiedAgentRouter(t)
router.serverVersion = "v6.0.0"
content := []byte("linux helper")
path := filepath.Join(root, "bin", "pulse-agent-helper-linux-amd64")
if err := os.WriteFile(path, content, 0o755); err != nil {
t.Fatal(err)
}
if err := os.WriteFile(path+".sig", []byte("helper-signature"), 0o644); err != nil {
t.Fatal(err)
}
if err := os.WriteFile(path+".sshsig", []byte("helper-ssh-signature"), 0o644); err != nil {
t.Fatal(err)
}
request := httptest.NewRequest(http.MethodGet, "/download/pulse-agent-helper?arch=linux-amd64", nil)
response := httptest.NewRecorder()
router.handleDownloadAgentHelper(response, request)
if response.Code != http.StatusOK {
t.Fatalf("status = %d, body = %s", response.Code, response.Body.String())
}
wantChecksum := sha256.Sum256(content)
if got := response.Header().Get(checksumHeaderName); got != hex.EncodeToString(wantChecksum[:]) {
t.Fatalf("checksum = %q", got)
}
if got := response.Header().Get(signatureHeaderName); got != "helper-signature" {
t.Fatalf("signature = %q", got)
}
if got := response.Header().Get(sshSignatureHeaderName); got != encodedTestSSHSignature("helper-ssh-signature") {
t.Fatalf("SSH signature = %q", got)
}
}
func TestDownloadAgentHelperMissingDevBinaryReturnsExactBuildCommand(t *testing.T) {
router, _ := setupUnifiedAgentRouter(t)
router.serverVersion = "dev"
request := httptest.NewRequest(http.MethodGet, "/download/pulse-agent-helper?arch=linux-armv7", nil)
response := httptest.NewRecorder()
router.handleDownloadAgentHelper(response, request)
if response.Code != http.StatusNotFound {
t.Fatalf("status = %d, want %d", response.Code, http.StatusNotFound)
}
want := "CGO_ENABLED=0 GOOS=linux GOARCH=arm GOARM=7 go build -o bin/pulse-agent-helper-linux-armv7 ./cmd/pulse-agent-helper"
if !strings.Contains(response.Body.String(), want) {
t.Fatalf("body missing build command: %s", response.Body.String())
}
}
func TestDownloadAgentHelperProxiesPublishedSignedAsset(t *testing.T) {
router, _ := setupUnifiedAgentRouter(t)
router.serverVersion = "v6.0.0-rc.1"
assetURL := "https://github.com/rcourtman/Pulse/releases/download/v6.0.0-rc.1/pulse-agent-helper-linux-amd64"
router.installScriptClient = newTestInstallScriptClientSequence(t, []expectedHTTPExchange{
{Method: http.MethodGet, URL: assetURL, Status: http.StatusOK, Body: "helper"},
{Method: http.MethodGet, URL: assetURL + ".sig", Status: http.StatusOK, Body: "helper-signature"},
{Method: http.MethodGet, URL: assetURL + ".sshsig", Status: http.StatusOK, Body: "helper-ssh-signature"},
})
request := httptest.NewRequest(http.MethodGet, "/download/pulse-agent-helper?arch=linux-amd64", nil)
response := httptest.NewRecorder()
router.handleDownloadAgentHelper(response, request)
if response.Code != http.StatusOK {
t.Fatalf("status = %d, body = %s", response.Code, response.Body.String())
}
if got := response.Header().Get("X-Served-From"); got != "github-proxy" {
t.Fatalf("served from = %q", got)
}
if got := response.Header().Get(signatureHeaderName); got != "helper-signature" {
t.Fatalf("signature = %q", got)
}
}
func TestDownloadAgentRunnerRejectsUnsupportedArchitecture(t *testing.T) {
router := &Router{}
request := httptest.NewRequest(http.MethodGet, "/download/pulse-agent-runner?arch=darwin-arm64", nil)
response := httptest.NewRecorder()
router.handleDownloadAgentRunner(response, request)
if response.Code != http.StatusBadRequest {
t.Fatalf("status = %d, want %d", response.Code, http.StatusBadRequest)
}
}
func TestDownloadAgentRunnerServesSignedLocalLinuxBinary(t *testing.T) {
root := t.TempDir()
binDir := filepath.Join(root, "bin")
if err := os.MkdirAll(binDir, 0o755); err != nil {
t.Fatal(err)
}
path := filepath.Join(binDir, "pulse-agent-runner-linux-amd64")
content := []byte("runner")
if err := os.WriteFile(path, content, 0o755); err != nil {
t.Fatal(err)
}
if err := os.WriteFile(path+".sig", []byte("detached"), 0o644); err != nil {
t.Fatal(err)
}
if err := os.WriteFile(path+".sshsig", []byte("ssh-signature"), 0o644); err != nil {
t.Fatal(err)
}
router := &Router{projectRoot: root, serverVersion: "6.5.0"}
request := httptest.NewRequest(http.MethodGet, "/download/pulse-agent-runner?arch=linux-amd64", nil)
response := httptest.NewRecorder()
router.handleDownloadAgentRunner(response, request)
if response.Code != http.StatusOK {
t.Fatalf("status = %d, want %d: %s", response.Code, http.StatusOK, response.Body.String())
}
if got := response.Header().Get(checksumHeaderName); got == "" {
t.Fatal("missing checksum header")
}
if got := response.Header().Get(signatureHeaderName); got != "detached" {
t.Fatalf("signature = %q", got)
}
if got := response.Header().Get(sshSignatureHeaderName); got == "" {
t.Fatal("missing SSH signature header")
}
if !bytes.Equal(response.Body.Bytes(), content) {
t.Fatalf("body = %q", response.Body.Bytes())
}
}
func TestDownloadAgentRunnerMissingDevBinaryReturnsExactBuildCommand(t *testing.T) {
router := &Router{projectRoot: t.TempDir(), serverVersion: "dev"}
request := httptest.NewRequest(http.MethodGet, "/download/pulse-agent-runner?arch=linux-armv7", nil)
response := httptest.NewRecorder()
router.handleDownloadAgentRunner(response, request)
if response.Code != http.StatusNotFound {
t.Fatalf("status = %d, want %d", response.Code, http.StatusNotFound)
}
want := "CGO_ENABLED=0 GOOS=linux GOARCH=arm GOARM=7 go build -o bin/pulse-agent-runner-linux-armv7 ./cmd/pulse-agent-runner"
if !strings.Contains(response.Body.String(), want) {
t.Fatalf("response missing build command %q: %s", want, response.Body.String())
}
}
type roundTripFunc func(*http.Request) (*http.Response, error)
func (f roundTripFunc) RoundTrip(req *http.Request) (*http.Response, error) {
return f(req)
}
func newTestInstallScriptClient(t *testing.T, expectedMethod, expectedURL string, status int, body string, err error) *http.Client {
t.Helper()
return &http.Client{
Transport: roundTripFunc(func(req *http.Request) (*http.Response, error) {
if expectedMethod != "" && req.Method != expectedMethod {
t.Fatalf("unexpected method: %s", req.Method)
}
if expectedURL != "" && req.URL.String() != expectedURL {
t.Fatalf("unexpected URL: %s", req.URL.String())
}
if err != nil {
return nil, err
}
return &http.Response{
StatusCode: status,
Status: fmt.Sprintf("%d %s", status, http.StatusText(status)),
Header: make(http.Header),
Body: io.NopCloser(strings.NewReader(body)),
}, nil
}),
}
}
type expectedHTTPExchange struct {
Method string
URL string
Status int
Body string
Err error
}
func newTestInstallScriptClientSequence(t *testing.T, exchanges []expectedHTTPExchange) *http.Client {
t.Helper()
var index int
return &http.Client{
Transport: roundTripFunc(func(req *http.Request) (*http.Response, error) {
if index >= len(exchanges) {
t.Fatalf("unexpected extra request: %s %s", req.Method, req.URL.String())
}
exchange := exchanges[index]
index++
if exchange.Method != "" && req.Method != exchange.Method {
t.Fatalf("unexpected method at request %d: %s", index, req.Method)
}
if exchange.URL != "" && req.URL.String() != exchange.URL {
t.Fatalf("unexpected URL at request %d: %s", index, req.URL.String())
}
if exchange.Err != nil {
return nil, exchange.Err
}
return &http.Response{
StatusCode: exchange.Status,
Status: fmt.Sprintf("%d %s", exchange.Status, http.StatusText(exchange.Status)),
Header: make(http.Header),
Body: io.NopCloser(strings.NewReader(exchange.Body)),
}, nil
}),
}
}
func TestDownloadUnifiedInstallScript_MethodNotAllowed(t *testing.T) {
router := &Router{}
req := httptest.NewRequest(http.MethodPost, "/install.sh", nil)
w := httptest.NewRecorder()
router.handleDownloadUnifiedInstallScript(w, req)
if w.Code != http.StatusMethodNotAllowed {
t.Fatalf("expected 405, got %d", w.Code)
}
}
func TestDownloadUnifiedInstallScriptPS_MethodNotAllowed(t *testing.T) {
router := &Router{}
req := httptest.NewRequest(http.MethodPut, "/install.ps1", nil)
w := httptest.NewRecorder()
router.handleDownloadUnifiedInstallScriptPS(w, req)
if w.Code != http.StatusMethodNotAllowed {
t.Fatalf("expected 405, got %d", w.Code)
}
}
func TestDownloadUnifiedInstallScript_NoLocalScriptFailsClosed(t *testing.T) {
router, _ := setupUnifiedAgentRouter(t)
router.serverVersion = "v6.0.0-rc.6"
// No agent installer is bundled. The endpoint must fail closed and must never
// proxy the GitHub install.sh release asset (the SERVER installer). Any outbound
// HTTP call from this endpoint is a regression of the issue #1470 root fix.
router.installScriptClient = &http.Client{Transport: roundTripFunc(func(req *http.Request) (*http.Response, error) {
t.Errorf("install-script endpoint must not make outbound calls; got %s %s", req.Method, req.URL)
return nil, fmt.Errorf("unexpected outbound call")
})}
req := httptest.NewRequest(http.MethodGet, "/install.sh", nil)
w := httptest.NewRecorder()
router.handleDownloadUnifiedInstallScript(w, req)
if w.Code != http.StatusServiceUnavailable {
t.Fatalf("expected 503, got %d", w.Code)
}
if got := w.Header().Get("X-Served-From"); got != "" {
t.Fatalf("endpoint must not proxy; X-Served-From = %q", got)
}
}
func TestDownloadUnifiedInstallScriptPS_NoLocalScriptFailsClosed(t *testing.T) {
router, _ := setupUnifiedAgentRouter(t)
router.serverVersion = "v6.0.0"
router.installScriptClient = &http.Client{Transport: roundTripFunc(func(req *http.Request) (*http.Response, error) {
t.Errorf("install-script endpoint must not make outbound calls; got %s %s", req.Method, req.URL)
return nil, fmt.Errorf("unexpected outbound call")
})}
req := httptest.NewRequest(http.MethodGet, "/install.ps1", nil)
w := httptest.NewRecorder()
router.handleDownloadUnifiedInstallScriptPS(w, req)
if w.Code != http.StatusServiceUnavailable {
t.Fatalf("expected 503, got %d", w.Code)
}
}
func TestDownloadUnifiedInstallScript_NoLocalScriptFailsClosedForDevBuild(t *testing.T) {
router, _ := setupUnifiedAgentRouter(t)
router.serverVersion = "dev"
req := httptest.NewRequest(http.MethodGet, "/install.sh", nil)
w := httptest.NewRecorder()
router.handleDownloadUnifiedInstallScript(w, req)
if w.Code != http.StatusServiceUnavailable {
t.Fatalf("expected 503, got %d", w.Code)
}
}
func TestDownloadUnifiedInstallScript_NoLocalScriptFailsClosedHEAD(t *testing.T) {
router, _ := setupUnifiedAgentRouter(t)
router.serverVersion = "v6.0.0-rc.6"
req := httptest.NewRequest(http.MethodHead, "/install.sh", nil)
w := httptest.NewRecorder()
router.handleDownloadUnifiedInstallScript(w, req)
if w.Code != http.StatusServiceUnavailable {
t.Fatalf("expected 503, got %d", w.Code)
}
}
func TestDownloadUnifiedAgent_MethodNotAllowed(t *testing.T) {
router := &Router{}
req := httptest.NewRequest(http.MethodPost, "/download/pulse-agent", nil)
w := httptest.NewRecorder()
router.handleDownloadUnifiedAgent(w, req)
if w.Code != http.StatusMethodNotAllowed {
t.Fatalf("expected 405, got %d", w.Code)
}
}
func TestDownloadUnifiedAgent_NoArchNotFound(t *testing.T) {
tempDir := t.TempDir()
t.Setenv("PULSE_BIN_DIR", tempDir)
router := &Router{projectRoot: tempDir}
req := httptest.NewRequest(http.MethodGet, "/download/pulse-agent", nil)
w := httptest.NewRecorder()
router.handleDownloadUnifiedAgent(w, req)
if w.Code != http.StatusNotFound {
t.Fatalf("expected 404, got %d", w.Code)
}
if !strings.Contains(w.Body.String(), "Specify ?arch=linux-amd64") {
t.Fatalf("expected guidance message")
}
}