Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
117 changes: 117 additions & 0 deletions admin/api/audit.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,117 @@
// Copyright 2026 CloudBlue LLC
// SPDX-License-Identifier: Apache-2.0

package api

import (
"fmt"
"net/http"
"net/url"
"strconv"
"strings"
"time"

"github.com/cloudblue/chaperone/admin/store"
)

// AuditHandler serves the audit log REST endpoint.
type AuditHandler struct {
store *store.Store
}

// NewAuditHandler creates a handler for the audit log endpoint.
func NewAuditHandler(st *store.Store) *AuditHandler {
return &AuditHandler{store: st}
}

// Register mounts audit routes on the given mux.
func (h *AuditHandler) Register(mux *http.ServeMux) {
mux.HandleFunc("GET /api/audit", h.list)
}

func (h *AuditHandler) list(w http.ResponseWriter, r *http.Request) {
filter, err := parseAuditFilter(r.URL.Query())
if err != nil {
respondError(w, http.StatusBadRequest, "VALIDATION_ERROR", err.Error())
return
}

page, err := h.store.ListAuditEntries(r.Context(), filter)
if err != nil {
respondError(w, http.StatusInternalServerError, "INTERNAL_ERROR", "Failed to list audit entries")
return
}

respondJSON(w, http.StatusOK, page)
}

func parseAuditFilter(q url.Values) (store.AuditFilter, error) {
filter := store.AuditFilter{
Action: strings.TrimSpace(q.Get("action")),
Comment thread
victor-cuevas marked this conversation as resolved.
Query: strings.TrimSpace(q.Get("q")),
Page: 1,
PerPage: 20,
}

if err := parseIDParam(q, "user", &filter.UserID); err != nil {
return filter, err
}
if err := parseIDParam(q, "instance_id", &filter.InstanceID); err != nil {
return filter, err
}
if err := parseTimeParam(q, "from", &filter.From); err != nil {
return filter, err
}
if err := parseTimeParam(q, "to", &filter.To); err != nil {
return filter, err
}
if err := parsePageParams(q, &filter.Page, &filter.PerPage); err != nil {
return filter, err
}

return filter, nil
}

func parseIDParam(q url.Values, key string, dst **int64) error {
v := q.Get(key)
if v == "" {
return nil
}
id, err := strconv.ParseInt(v, 10, 64)
if err != nil {
return fmt.Errorf("invalid %s: %q", key, v)
}
*dst = &id
return nil
}

func parseTimeParam(q url.Values, key string, dst **time.Time) error {
v := q.Get(key)
if v == "" {
return nil
}
t, err := time.Parse(time.RFC3339, v)
if err != nil {
return fmt.Errorf("invalid %s: %q (expected RFC 3339)", key, v)
}
*dst = &t
return nil
}

func parsePageParams(q url.Values, page, perPage *int) error {
if v := q.Get("page"); v != "" {
p, err := strconv.Atoi(v)
if err != nil || p < 1 {
return fmt.Errorf("invalid page: %q", v)
}
*page = p
}
if v := q.Get("per_page"); v != "" {
pp, err := strconv.Atoi(v)
if err != nil || pp < 1 || pp > 100 {
return fmt.Errorf("invalid per_page: %q (must be 1-100)", v)
}
*perPage = pp
}
return nil
}
15 changes: 15 additions & 0 deletions admin/api/audit_actions.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
// Copyright 2026 CloudBlue LLC
// SPDX-License-Identifier: Apache-2.0

package api

// Audit action constants logged for each portal operation.
// Keep in sync with the frontend labels in admin/ui/src/utils/audit.js.
const (
AuditActionInstanceCreate = "instance.create"
AuditActionInstanceUpdate = "instance.update"
AuditActionInstanceDelete = "instance.delete"
AuditActionUserLogin = "user.login"
AuditActionUserLogout = "user.logout"
AuditActionPasswordChange = "user.password_change"
)
241 changes: 241 additions & 0 deletions admin/api/audit_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,241 @@
// Copyright 2026 CloudBlue LLC
// SPDX-License-Identifier: Apache-2.0

package api

import (
"context"
"encoding/json"
"net/http"
"net/http/httptest"
"strconv"
"testing"

"github.com/cloudblue/chaperone/admin/store"
)

func newAuditTestMux(t *testing.T) (*http.ServeMux, *store.Store) {
t.Helper()
st := openTestStore(t)
h := NewAuditHandler(st)
mux := http.NewServeMux()
h.Register(mux)
return mux, st
}

func seedAuditData(t *testing.T, st *store.Store) int64 {
t.Helper()
ctx := context.Background()
user, err := st.CreateUser(ctx, "admin", "$2a$10$abcdefghijklmnopqrstuuABCDEFGHIJKLMNOPQRSTUVWXYZ01234")
if err != nil {
t.Fatalf("CreateUser() error = %v", err)
}
inst, err := st.CreateInstance(ctx, "proxy-1", "10.0.0.1:9090")
if err != nil {
t.Fatalf("CreateInstance() error = %v", err)
}

entries := []struct {
action string
instanceID *int64
detail string
}{
{"instance.create", &inst.ID, "Created instance proxy-1 at 10.0.0.1:9090"},
{"instance.update", &inst.ID, "Updated instance proxy-1"},
{"user.login", nil, "User admin logged in"},
}
for _, e := range entries {
if err := st.InsertAuditEntry(ctx, user.ID, e.action, e.instanceID, e.detail); err != nil {
t.Fatalf("InsertAuditEntry() error = %v", err)
}
}
return user.ID
}

func TestAuditList_Empty_ReturnsEmptyPage(t *testing.T) {
t.Parallel()
mux, _ := newAuditTestMux(t)

req := httptest.NewRequest(http.MethodGet, "/api/audit", nil)
rec := httptest.NewRecorder()
mux.ServeHTTP(rec, req)

if rec.Code != http.StatusOK {
t.Fatalf("status = %d, want %d; body = %s", rec.Code, http.StatusOK, rec.Body.String())
}

var page store.AuditPage
if err := json.NewDecoder(rec.Body).Decode(&page); err != nil {
t.Fatalf("decoding response: %v", err)
}
if page.Total != 0 {
t.Errorf("Total = %d, want 0", page.Total)
}
if len(page.Items) != 0 {
t.Errorf("len(Items) = %d, want 0", len(page.Items))
}
}

func TestAuditList_ReturnsEntries(t *testing.T) {
t.Parallel()
mux, st := newAuditTestMux(t)
seedAuditData(t, st)

req := httptest.NewRequest(http.MethodGet, "/api/audit", nil)
rec := httptest.NewRecorder()
mux.ServeHTTP(rec, req)

if rec.Code != http.StatusOK {
t.Fatalf("status = %d, want %d", rec.Code, http.StatusOK)
}

var page store.AuditPage
if err := json.NewDecoder(rec.Body).Decode(&page); err != nil {
t.Fatalf("decoding: %v", err)
}
if page.Total != 3 {
t.Errorf("Total = %d, want 3", page.Total)
}
if len(page.Items) != 3 {
t.Errorf("len(Items) = %d, want 3", len(page.Items))
}
}

func TestAuditList_FilterByAction(t *testing.T) {
t.Parallel()
mux, st := newAuditTestMux(t)
seedAuditData(t, st)

req := httptest.NewRequest(http.MethodGet, "/api/audit?action=user.login", nil)
rec := httptest.NewRecorder()
mux.ServeHTTP(rec, req)

if rec.Code != http.StatusOK {
t.Fatalf("status = %d", rec.Code)
}

var page store.AuditPage
if err := json.NewDecoder(rec.Body).Decode(&page); err != nil {
t.Fatalf("decoding: %v", err)
}
if page.Total != 1 {
t.Errorf("Total = %d, want 1", page.Total)
}
}

func TestAuditList_FilterByUser(t *testing.T) {
t.Parallel()
mux, st := newAuditTestMux(t)
userID := seedAuditData(t, st)

req := httptest.NewRequest(http.MethodGet, "/api/audit?user="+itoa(userID), nil)
rec := httptest.NewRecorder()
mux.ServeHTTP(rec, req)

var page store.AuditPage
if err := json.NewDecoder(rec.Body).Decode(&page); err != nil {
t.Fatalf("decoding: %v", err)
}
if page.Total != 3 {
t.Errorf("Total = %d, want 3", page.Total)
}
}

func TestAuditList_FullTextSearch(t *testing.T) {
t.Parallel()
mux, st := newAuditTestMux(t)
seedAuditData(t, st)

req := httptest.NewRequest(http.MethodGet, "/api/audit?q=proxy-1", nil)
rec := httptest.NewRecorder()
mux.ServeHTTP(rec, req)

var page store.AuditPage
if err := json.NewDecoder(rec.Body).Decode(&page); err != nil {
t.Fatalf("decoding: %v", err)
}
// "proxy-1" appears in instance.create and instance.update details.
if page.Total != 2 {
t.Errorf("Total = %d, want 2", page.Total)
}
}

func TestAuditList_Pagination(t *testing.T) {
t.Parallel()
mux, st := newAuditTestMux(t)
seedAuditData(t, st)

req := httptest.NewRequest(http.MethodGet, "/api/audit?page=1&per_page=2", nil)
rec := httptest.NewRecorder()
mux.ServeHTTP(rec, req)

var page store.AuditPage
if err := json.NewDecoder(rec.Body).Decode(&page); err != nil {
t.Fatalf("decoding: %v", err)
}
if page.Total != 3 {
t.Errorf("Total = %d, want 3", page.Total)
}
if len(page.Items) != 2 {
t.Errorf("len(Items) = %d, want 2", len(page.Items))
}
if page.Page != 1 {
t.Errorf("Page = %d, want 1", page.Page)
}
}

func TestAuditList_InvalidPage_Returns400(t *testing.T) {
t.Parallel()
mux, _ := newAuditTestMux(t)

req := httptest.NewRequest(http.MethodGet, "/api/audit?page=abc", nil)
rec := httptest.NewRecorder()
mux.ServeHTTP(rec, req)

if rec.Code != http.StatusBadRequest {
t.Errorf("status = %d, want %d", rec.Code, http.StatusBadRequest)
}
}

func TestAuditList_InvalidPerPage_Returns400(t *testing.T) {
t.Parallel()
mux, _ := newAuditTestMux(t)

req := httptest.NewRequest(http.MethodGet, "/api/audit?per_page=999", nil)
rec := httptest.NewRecorder()
mux.ServeHTTP(rec, req)

if rec.Code != http.StatusBadRequest {
t.Errorf("status = %d, want %d", rec.Code, http.StatusBadRequest)
}
}

func TestAuditList_InvalidUserID_Returns400(t *testing.T) {
t.Parallel()
mux, _ := newAuditTestMux(t)

req := httptest.NewRequest(http.MethodGet, "/api/audit?user=notanumber", nil)
rec := httptest.NewRecorder()
mux.ServeHTTP(rec, req)

if rec.Code != http.StatusBadRequest {
t.Errorf("status = %d, want %d", rec.Code, http.StatusBadRequest)
}
}

func TestAuditList_InvalidFromDate_Returns400(t *testing.T) {
t.Parallel()
mux, _ := newAuditTestMux(t)

req := httptest.NewRequest(http.MethodGet, "/api/audit?from=not-a-date", nil)
rec := httptest.NewRecorder()
mux.ServeHTTP(rec, req)

if rec.Code != http.StatusBadRequest {
t.Errorf("status = %d, want %d", rec.Code, http.StatusBadRequest)
}
}

func itoa(n int64) string {
return strconv.FormatInt(n, 10)
}
Loading
Loading