Initial commit

checker/rule.go

@@ -0,0 +1,118 @@
+// This file is part of the happyDomain (R) project.
+// Copyright (c) 2020-2026 happyDomain
+// Authors: Pierre-Olivier Mercier, et al.
+//
+// This program is offered under a commercial and under the AGPL license.
+// For commercial licensing, contact us at <contact@happydomain.org>.
+//
+// For AGPL licensing:
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Affero General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU Affero General Public License for more details.
+//
+// You should have received a copy of the GNU Affero General Public License
+// along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+package checker
+
+import (
+	"context"
+	"fmt"
+
+	"git.happydns.org/happyDomain/model"
+	sdk "git.happydns.org/happyDomain/sdk/checker"
+)
+
+// Rule returns a new dummy check rule.
+//
+// A rule evaluates collected observation data and returns a status (OK,
+// Warning, Critical, Error). Each checker can define multiple rules that
+// inspect the same data from different angles.
+func Rule() happydns.CheckRule {
+	return &dummyRule{}
+}
+
+// dummyRule implements the happydns.CheckRule interface.
+type dummyRule struct{}
+
+// Name returns a unique, stable identifier for this rule. It is used as the
+// "code" field in check results and stored in the database.
+func (r *dummyRule) Name() string { return "dummy_score_check" }
+
+// Description returns a human-readable summary of what this rule checks.
+func (r *dummyRule) Description() string {
+	return "Checks whether the dummy score is above the configured thresholds"
+}
+
+// ValidateOptions is called before evaluation to verify that the options are
+// well-formed. Return an error to reject invalid configuration early, before
+// any data collection happens.
+func (r *dummyRule) ValidateOptions(opts happydns.CheckerOptions) error {
+	warning := sdk.GetFloatOption(opts, "warningThreshold", 50)
+	critical := sdk.GetFloatOption(opts, "criticalThreshold", 20)
+
+	if warning < 0 || warning > 100 {
+		return fmt.Errorf("warningThreshold must be between 0 and 100")
+	}
+	if critical < 0 || critical > 100 {
+		return fmt.Errorf("criticalThreshold must be between 0 and 100")
+	}
+	if critical >= warning {
+		return fmt.Errorf("criticalThreshold (%v) must be less than warningThreshold (%v)", critical, warning)
+	}
+
+	return nil
+}
+
+// Evaluate inspects the collected observation data and returns a CheckState.
+//
+// Parameters:
+//   - ctx: context for cancellation.
+//   - obs: an ObservationGetter to retrieve collected data by key.
+//   - opts: the merged checker options.
+//
+// The ObservationGetter.Get method deserialises the stored JSON into your data
+// struct. Always check the error — the observation may not be available if
+// collection failed.
+func (r *dummyRule) Evaluate(ctx context.Context, obs happydns.ObservationGetter, opts happydns.CheckerOptions) happydns.CheckState {
+	// Retrieve the observation data by key.
+	var data DummyData
+	if err := obs.Get(ctx, ObservationKeyDummy, &data); err != nil {
+		return happydns.CheckState{
+			Status:  happydns.StatusError,
+			Message: fmt.Sprintf("Failed to get dummy data: %v", err),
+			Code:    "dummy_error",
+		}
+	}
+
+	// Read thresholds from options.
+	warningThreshold := sdk.GetFloatOption(opts, "warningThreshold", 50)
+	criticalThreshold := sdk.GetFloatOption(opts, "criticalThreshold", 20)
+
+	// Determine the status based on the score and thresholds.
+	var status happydns.Status
+	switch {
+	case data.Score < criticalThreshold:
+		status = happydns.StatusCrit
+	case data.Score < warningThreshold:
+		status = happydns.StatusWarn
+	default:
+		status = happydns.StatusOK
+	}
+
+	return happydns.CheckState{
+		Status:  status,
+		Message: fmt.Sprintf("Score: %.1f — %s", data.Score, data.Message),
+		Code:    "dummy_score_check",
+		Meta: map[string]any{
+			"score":   data.Score,
+			"message": data.Message,
+		},
+	}
+}