checker: thread rule states into ReportContext
Reporters can now read rule output via ctx.States() instead of re-deriving severity/hints from the raw payload, keeping the rules screen and the HTML report aligned on a single source of truth.
This commit is contained in:
parent
89cc3f112b
commit
3382f62f57
6 changed files with 252 additions and 25 deletions
|
|
@ -96,14 +96,15 @@ func (s *Server) handleCheckForm(w http.ResponseWriter, r *http.Request) {
|
|||
}
|
||||
|
||||
func (s *Server) handleCheckSubmit(w http.ResponseWriter, r *http.Request) {
|
||||
fields := s.interactive.RenderForm()
|
||||
if err := r.ParseForm(); err != nil {
|
||||
s.renderCheckForm(w, s.interactive.RenderForm(), fmt.Sprintf("invalid form: %v", err))
|
||||
s.renderCheckForm(w, fields, fmt.Sprintf("invalid form: %v", err))
|
||||
return
|
||||
}
|
||||
|
||||
opts, err := s.interactive.ParseForm(r)
|
||||
if err != nil {
|
||||
s.renderCheckForm(w, s.interactive.RenderForm(), err.Error())
|
||||
s.renderCheckForm(w, fields, err.Error())
|
||||
return
|
||||
}
|
||||
|
||||
|
|
@ -135,7 +136,7 @@ func (s *Server) handleCheckSubmit(w http.ResponseWriter, r *http.Request) {
|
|||
result.States = s.evaluateRules(r.Context(), obs, opts, nil)
|
||||
}
|
||||
|
||||
ctx := checker.NewReportContext(raw, related)
|
||||
ctx := checker.NewReportContext(raw, related, result.States)
|
||||
|
||||
if reporter, ok := s.provider.(checker.CheckerHTMLReporter); ok {
|
||||
html, rerr := reporter.GetHTMLReport(ctx)
|
||||
|
|
|
|||
|
|
@ -355,6 +355,65 @@ func TestCheck_Submit_RunsSiblingAndExposesRelated(t *testing.T) {
|
|||
}
|
||||
}
|
||||
|
||||
// interactiveStatesPeekingProvider implements Interactive + HTMLReporter
|
||||
// and captures the ReportContext.States() seen at GetHTMLReport time.
|
||||
type interactiveStatesPeekingProvider struct {
|
||||
key checker.ObservationKey
|
||||
def *checker.CheckerDefinition
|
||||
seen *[]checker.CheckState
|
||||
}
|
||||
|
||||
func (p *interactiveStatesPeekingProvider) Key() checker.ObservationKey { return p.key }
|
||||
func (p *interactiveStatesPeekingProvider) Collect(ctx context.Context, opts checker.CheckerOptions) (any, error) {
|
||||
return map[string]string{"ok": "1"}, nil
|
||||
}
|
||||
func (p *interactiveStatesPeekingProvider) Definition() *checker.CheckerDefinition { return p.def }
|
||||
func (p *interactiveStatesPeekingProvider) RenderForm() []checker.CheckerOptionField {
|
||||
return []checker.CheckerOptionField{{Id: "domain", Type: "string"}}
|
||||
}
|
||||
func (p *interactiveStatesPeekingProvider) ParseForm(r *http.Request) (checker.CheckerOptions, error) {
|
||||
return checker.CheckerOptions{"domain": r.FormValue("domain")}, nil
|
||||
}
|
||||
func (p *interactiveStatesPeekingProvider) GetHTMLReport(ctx checker.ReportContext) (string, error) {
|
||||
if p.seen != nil {
|
||||
*p.seen = ctx.States()
|
||||
}
|
||||
return "<p>ok</p>", nil
|
||||
}
|
||||
|
||||
// TestCheck_Submit_ThreadsStatesIntoReport verifies that CheckStates
|
||||
// produced by evaluateRules during POST /check are threaded into the
|
||||
// ReportContext handed to GetHTMLReport. Without this wiring, the /check
|
||||
// UI can show states in its own section but the embedded report would
|
||||
// have to re-derive severity/hints from Data.
|
||||
func TestCheck_Submit_ThreadsStatesIntoReport(t *testing.T) {
|
||||
var seen []checker.CheckState
|
||||
p := &interactiveStatesPeekingProvider{
|
||||
key: "test",
|
||||
def: &checker.CheckerDefinition{
|
||||
ID: "test",
|
||||
Rules: []checker.CheckRule{&dummyRule{name: "rule1", desc: "first"}},
|
||||
},
|
||||
seen: &seen,
|
||||
}
|
||||
srv := New(p)
|
||||
defer srv.Close()
|
||||
|
||||
rec := postForm(srv.Handler(), "/check", url.Values{"domain": {"example.com"}})
|
||||
if rec.Code != http.StatusOK {
|
||||
t.Fatalf("POST /check = %d, want 200", rec.Code)
|
||||
}
|
||||
if len(seen) != 1 {
|
||||
t.Fatalf("reporter saw %d states, want 1", len(seen))
|
||||
}
|
||||
if seen[0].RuleName != "rule1" {
|
||||
t.Errorf("state RuleName = %q, want %q", seen[0].RuleName, "rule1")
|
||||
}
|
||||
if seen[0].Status != checker.StatusOK {
|
||||
t.Errorf("state Status = %v, want %v", seen[0].Status, checker.StatusOK)
|
||||
}
|
||||
}
|
||||
|
||||
func TestCheck_Submit_NoSibling_LeavesRelatedEmpty(t *testing.T) {
|
||||
p := &interactiveProvider{
|
||||
testProvider: &testProvider{
|
||||
|
|
|
|||
|
|
@ -357,7 +357,7 @@ func (s *Server) handleReport(w http.ResponseWriter, r *http.Request) {
|
|||
return
|
||||
}
|
||||
|
||||
html, err := reporter.GetHTMLReport(checker.NewReportContext(req.Data, req.Related))
|
||||
html, err := reporter.GetHTMLReport(checker.NewReportContext(req.Data, req.Related, req.States))
|
||||
if err != nil {
|
||||
http.Error(w, fmt.Sprintf("failed to generate HTML report: %v", err), http.StatusInternalServerError)
|
||||
return
|
||||
|
|
@ -375,7 +375,7 @@ func (s *Server) handleReport(w http.ResponseWriter, r *http.Request) {
|
|||
return
|
||||
}
|
||||
|
||||
metrics, err := reporter.ExtractMetrics(checker.NewReportContext(req.Data, req.Related), time.Now())
|
||||
metrics, err := reporter.ExtractMetrics(checker.NewReportContext(req.Data, req.Related, req.States), time.Now())
|
||||
if err != nil {
|
||||
writeJSON(w, http.StatusInternalServerError, map[string]string{
|
||||
"error": fmt.Sprintf("failed to extract metrics: %v", err),
|
||||
|
|
|
|||
|
|
@ -542,6 +542,107 @@ func (p *relatedPeekingProvider) GetHTMLReport(ctx checker.ReportContext) (strin
|
|||
return "<p>ok</p>", nil
|
||||
}
|
||||
|
||||
// statesPeekingProvider captures the ReportContext's States slice at
|
||||
// GetHTMLReport / ExtractMetrics time.
|
||||
type statesPeekingProvider struct {
|
||||
base *testProvider
|
||||
htmlSeen *[]checker.CheckState
|
||||
metricSeen *[]checker.CheckState
|
||||
}
|
||||
|
||||
func (p *statesPeekingProvider) Key() checker.ObservationKey { return p.base.Key() }
|
||||
func (p *statesPeekingProvider) Collect(ctx context.Context, opts checker.CheckerOptions) (any, error) {
|
||||
return p.base.Collect(ctx, opts)
|
||||
}
|
||||
func (p *statesPeekingProvider) Definition() *checker.CheckerDefinition { return p.base.definition }
|
||||
func (p *statesPeekingProvider) GetHTMLReport(ctx checker.ReportContext) (string, error) {
|
||||
if p.htmlSeen != nil {
|
||||
*p.htmlSeen = ctx.States()
|
||||
}
|
||||
return "<p>ok</p>", nil
|
||||
}
|
||||
func (p *statesPeekingProvider) ExtractMetrics(ctx checker.ReportContext, t time.Time) ([]checker.CheckMetric, error) {
|
||||
if p.metricSeen != nil {
|
||||
*p.metricSeen = ctx.States()
|
||||
}
|
||||
return []checker.CheckMetric{{Name: "m1", Value: 1.0, Timestamp: t}}, nil
|
||||
}
|
||||
|
||||
// TestServer_Report_States_HTML verifies ExternalReportRequest.States is
|
||||
// threaded into the ReportContext seen by the HTML reporter.
|
||||
func TestServer_Report_States_HTML(t *testing.T) {
|
||||
var seen []checker.CheckState
|
||||
base := &testProvider{
|
||||
key: "test",
|
||||
definition: &checker.CheckerDefinition{ID: "test-checker", Rules: []checker.CheckRule{}},
|
||||
}
|
||||
srv := New(&statesPeekingProvider{base: base, htmlSeen: &seen})
|
||||
defer srv.Close()
|
||||
|
||||
states := []checker.CheckState{
|
||||
{Status: checker.StatusCrit, Message: "broken", RuleName: "r1", Code: "bad", Subject: "host.example"},
|
||||
}
|
||||
req := checker.ExternalReportRequest{
|
||||
Key: "test",
|
||||
Data: json.RawMessage(`{}`),
|
||||
States: states,
|
||||
}
|
||||
rec := doRequest(srv.Handler(), "POST", "/report", req, map[string]string{"Accept": "text/html"})
|
||||
if rec.Code != http.StatusOK {
|
||||
t.Fatalf("POST /report = %d, want 200", rec.Code)
|
||||
}
|
||||
if len(seen) != 1 || seen[0].RuleName != "r1" || seen[0].Code != "bad" || seen[0].Subject != "host.example" {
|
||||
t.Errorf("reporter saw states = %+v, want single state {RuleName:r1, Code:bad, Subject:host.example}", seen)
|
||||
}
|
||||
}
|
||||
|
||||
// TestServer_Report_States_Metrics verifies the States passthrough on the
|
||||
// metrics path as well.
|
||||
func TestServer_Report_States_Metrics(t *testing.T) {
|
||||
var seen []checker.CheckState
|
||||
base := &testProvider{
|
||||
key: "test",
|
||||
definition: &checker.CheckerDefinition{ID: "test-checker", Rules: []checker.CheckRule{}},
|
||||
}
|
||||
srv := New(&statesPeekingProvider{base: base, metricSeen: &seen})
|
||||
defer srv.Close()
|
||||
|
||||
req := checker.ExternalReportRequest{
|
||||
Key: "test",
|
||||
Data: json.RawMessage(`{}`),
|
||||
States: []checker.CheckState{{Status: checker.StatusWarn, RuleName: "r1"}},
|
||||
}
|
||||
rec := doRequest(srv.Handler(), "POST", "/report", req, map[string]string{"Accept": "application/json"})
|
||||
if rec.Code != http.StatusOK {
|
||||
t.Fatalf("POST /report = %d, want 200", rec.Code)
|
||||
}
|
||||
if len(seen) != 1 || seen[0].RuleName != "r1" {
|
||||
t.Errorf("reporter saw states = %+v, want single state with RuleName=r1", seen)
|
||||
}
|
||||
}
|
||||
|
||||
// TestServer_Report_States_Absent verifies that omitting States in the
|
||||
// request yields a nil States() slice on the reporter side (graceful
|
||||
// degradation for hosts that don't thread evaluate→report yet).
|
||||
func TestServer_Report_States_Absent(t *testing.T) {
|
||||
seen := []checker.CheckState{{Status: checker.StatusOK}} // non-nil sentinel
|
||||
base := &testProvider{
|
||||
key: "test",
|
||||
definition: &checker.CheckerDefinition{ID: "test-checker", Rules: []checker.CheckRule{}},
|
||||
}
|
||||
srv := New(&statesPeekingProvider{base: base, htmlSeen: &seen})
|
||||
defer srv.Close()
|
||||
|
||||
req := checker.ExternalReportRequest{Key: "test", Data: json.RawMessage(`{}`)}
|
||||
rec := doRequest(srv.Handler(), "POST", "/report", req, map[string]string{"Accept": "text/html"})
|
||||
if rec.Code != http.StatusOK {
|
||||
t.Fatalf("POST /report = %d, want 200", rec.Code)
|
||||
}
|
||||
if seen != nil {
|
||||
t.Errorf("States() = %+v, want nil when ExternalReportRequest.States is absent", seen)
|
||||
}
|
||||
}
|
||||
|
||||
func TestServer_Report_BadBody(t *testing.T) {
|
||||
p := &testProvider{
|
||||
key: "test",
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue