Adding name filtering (#559)

Issue #540

Author: safaci2000

cli/backup/alerting_alertrules.go

@@ -6,10 +6,10 @@ import (
 	"log/slog"
 
 	"github.com/bep/simplecobra"
-	domain3 "github.com/esnet/gdg/cli/domain"
+	"github.com/esnet/gdg/cli/domain"
 	"github.com/esnet/gdg/internal/adapter/grafana/api"
 	"github.com/esnet/gdg/internal/config/config_domain"
-	domain2 "github.com/esnet/gdg/internal/domain"
+	appDomain "github.com/esnet/gdg/internal/domain"
 	"github.com/esnet/gdg/internal/ports"
 	"github.com/esnet/gdg/pkg/ptr"
 	"github.com/go-openapi/strfmt"
@@ -19,10 +19,11 @@ import (
 
 // getAlertRulesFilter constructs alert rule filters from command-line flags and returns both the parsed
 // AlertRuleFilterParams and a corresponding Filter for use in alert rule operations.
-func getAlertRulesFilter(cfg *config_domain.GDGAppConfiguration, grafanaService ports.GrafanaService, command *cobra.Command) (domain2.AlertRuleFilterParams, ports.Filter) {
-	f := domain2.AlertRuleFilterParams{}
+func getAlertRulesFilter(cfg *config_domain.GDGAppConfiguration, grafanaService ports.GrafanaService, command *cobra.Command) (appDomain.AlertRuleFilterParams, ports.Filter) {
+	f := appDomain.AlertRuleFilterParams{}
 	f.Folder, _ = command.Flags().GetString("folder")
 	f.Label, _ = command.Flags().GetStringArray("label")
+	f.Name, _ = command.Flags().GetString("name")
 	f.IgnoreWatchedFolders, _ = command.Flags().GetBool("ignore-watched-folders")
 
 	return f, api.NewAlertRuleFilter(cfg, grafanaService, f)
@@ -33,14 +34,15 @@ func getAlertRulesFilter(cfg *config_domain.GDGAppConfiguration, grafanaService
 // watched folders and labels.
 func newAlertingRulesCommand() simplecobra.Commander {
 	description := "Manage Alerting Rules"
-	return &domain3.SimpleCommand{
+	return &domain.SimpleCommand{
 		NameP: "rules",
 		Short: description,
 		Long:  description,
-		WithCFunc: func(cmd *cobra.Command, r *domain3.RootCommand) {
+		WithCFunc: func(cmd *cobra.Command, r *domain.RootCommand) {
 			cmd.Aliases = []string{"rule", "alert-rules", "alert-rule"}
 			cmd.PersistentFlags().Bool("ignore-watched-folders", false, "Default to false, but if passed then will only operate on the list of folders listed in the configuration file")
-			cmd.PersistentFlags().String("folder", "", "Add a folder filter")
+			cmd.PersistentFlags().String("folder", "", "filter by folder")
+			cmd.PersistentFlags().String("name", "", "filter by name")
 			cmd.PersistentFlags().StringArray("label", []string{}, "Filter by label name value pair. (Additive behavior dashboard includes: label1 AND label2).  ex --label env=staging")
 		},
 		CommandsList: []simplecobra.Commander{
@@ -49,7 +51,7 @@ func newAlertingRulesCommand() simplecobra.Commander {
 			newClearAlertRulesCmd(),
 			newUploadAlertRulesCmd(),
 		},
-		RunFunc: func(ctx context.Context, cd *simplecobra.Commandeer, rootCmd *domain3.RootCommand, args []string) error {
+		RunFunc: func(ctx context.Context, cd *simplecobra.Commandeer, rootCmd *domain.RootCommand, args []string) error {
 			return cd.CobraCommand.Help()
 		},
 	}
@@ -59,14 +61,14 @@ func newAlertingRulesCommand() simplecobra.Commander {
 // It supports folder and label filtering and is aliased as "u".
 func newUploadAlertRulesCmd() simplecobra.Commander {
 	description := "Upload all alert rules for the given Organization"
-	return &domain3.SimpleCommand{
+	return &domain.SimpleCommand{
 		NameP: "upload",
 		Short: description,
 		Long:  description,
-		WithCFunc: func(cmd *cobra.Command, r *domain3.RootCommand) {
+		WithCFunc: func(cmd *cobra.Command, r *domain.RootCommand) {
 			cmd.Aliases = []string{"u"}
 		},
-		RunFunc: func(ctx context.Context, cd *simplecobra.Commandeer, rootCmd *domain3.RootCommand, args []string) error {
+		RunFunc: func(ctx context.Context, cd *simplecobra.Commandeer, rootCmd *domain.RootCommand, args []string) error {
 			filtersList, rulesFilter := getAlertRulesFilter(rootCmd.ConfigSvc(), rootCmd.GrafanaSvc(), cd.CobraCommand)
 			rootCmd.TableObj.AppendHeader(table.Row{"uid"})
 			slog.Info("Uploading all alert rules for context",
@@ -91,14 +93,14 @@ func newUploadAlertRulesCmd() simplecobra.Commander {
 // The command is aliased as "c".
 func newClearAlertRulesCmd() simplecobra.Commander {
 	description := "Clear all alert rules for the given Organization"
-	return &domain3.SimpleCommand{
+	return &domain.SimpleCommand{
 		NameP: "clear",
 		Short: description,
 		Long:  description,
-		WithCFunc: func(cmd *cobra.Command, r *domain3.RootCommand) {
+		WithCFunc: func(cmd *cobra.Command, r *domain.RootCommand) {
 			cmd.Aliases = []string{"c"}
 		},
-		RunFunc: func(ctx context.Context, cd *simplecobra.Commandeer, rootCmd *domain3.RootCommand, args []string) error {
+		RunFunc: func(ctx context.Context, cd *simplecobra.Commandeer, rootCmd *domain.RootCommand, args []string) error {
 			filtersList, rulesFilter := getAlertRulesFilter(rootCmd.ConfigSvc(), rootCmd.GrafanaSvc(), cd.CobraCommand)
 			slog.Info("Deleting all alert rules for context",
 				slog.String("Organization", GetOrganizationName(rootCmd.ConfigSvc())),
@@ -131,14 +133,14 @@ func newClearAlertRulesCmd() simplecobra.Commander {
 // The command is aliased as "l".
 func newListAlertRulesCmd() simplecobra.Commander {
 	description := "List all alert rules for the given Organization"
-	return &domain3.SimpleCommand{
+	return &domain.SimpleCommand{
 		NameP: "list",
 		Short: description,
 		Long:  description,
-		WithCFunc: func(cmd *cobra.Command, r *domain3.RootCommand) {
+		WithCFunc: func(cmd *cobra.Command, r *domain.RootCommand) {
 			cmd.Aliases = []string{"l"}
 		},
-		RunFunc: func(ctx context.Context, cd *simplecobra.Commandeer, rootCmd *domain3.RootCommand, args []string) error {
+		RunFunc: func(ctx context.Context, cd *simplecobra.Commandeer, rootCmd *domain.RootCommand, args []string) error {
 			filtersList, rulesFilter := getAlertRulesFilter(rootCmd.ConfigSvc(), rootCmd.GrafanaSvc(), cd.CobraCommand)
 			rootCmd.TableObj.AppendHeader(table.Row{"name", "uid", "folder", "ruleGroup", "Labels", "For"})
 			slog.Info("Listing alert rules for context",
@@ -185,14 +187,14 @@ func newListAlertRulesCmd() simplecobra.Commander {
 // It applies any configured filters (folder, label) and renders the resulting list of downloaded rule files.
 func newDownloadAlertRulesCmd() simplecobra.Commander {
 	description := "Download all alert rules for the given Organization"
-	return &domain3.SimpleCommand{
+	return &domain.SimpleCommand{
 		NameP: "download",
 		Short: description,
 		Long:  description,
-		WithCFunc: func(cmd *cobra.Command, r *domain3.RootCommand) {
+		WithCFunc: func(cmd *cobra.Command, r *domain.RootCommand) {
 			cmd.Aliases = []string{"d"}
 		},
-		RunFunc: func(ctx context.Context, cd *simplecobra.Commandeer, rootCmd *domain3.RootCommand, args []string) error {
+		RunFunc: func(ctx context.Context, cd *simplecobra.Commandeer, rootCmd *domain.RootCommand, args []string) error {
 			filtersList, rulesFilter := getAlertRulesFilter(rootCmd.ConfigSvc(), rootCmd.GrafanaSvc(), cd.CobraCommand)
 			rootCmd.TableObj.AppendHeader(table.Row{"alert-rule"})
 			slog.Info("Downloading alert rules for context",

config/assets_test.go

@@ -0,0 +1,22 @@
+package config
+
+import (
+	"strings"
+	"testing"
+
+	"github.com/esnet/gdg/pkg/test_tooling/path"
+	"github.com/matryer/is"
+)
+
+func TestAssets(t *testing.T) {
+	path.FixTestDir("config", "..")
+	is := is.New(t)
+	file, err := GetFile("gdg-example.yml")
+	is.NoErr(err)
+	is.True(strings.Contains(file, "storage_engine"))
+	//failing test
+	file, err = GetFile("dummy")
+	is.True(err != nil)
+	is.Equal(err.Error(), "open dummy: file does not exist")
+	is.Equal(file, "")
+}

internal/adapter/grafana/api/alerting_alertrules.go

@@ -2,6 +2,7 @@ package api
 
 import (
 	"encoding/json"
+	"errors"
 	"fmt"
 	"log"
 	"log/slog"
@@ -29,6 +30,8 @@ func setupAlertRulesReaders(filterObj ports.Filter, grafanaSvc ports.GrafanaServ
 			return nil, fmt.Errorf("unsupported data type")
 		}
 		switch filterType {
+		case domain.Name:
+			return ptr.ValueOrDefault(val.Title, ""), nil
 		case domain.FolderFilter:
 			return val.NestedPath, nil
 		case domain.TagsFilter:
@@ -48,6 +51,14 @@ func setupAlertRulesReaders(filterObj ports.Filter, grafanaSvc ports.GrafanaServ
 			return nil, fmt.Errorf("unsupported data type")
 		}
 		switch filterType {
+		case domain.Name:
+			{
+				r := gjson.GetBytes(val, "title")
+				if !r.Exists() || r.IsArray() {
+					return nil, errors.New("no valid rule name was found")
+				}
+				return r.String(), nil
+			}
 		case domain.FolderFilter:
 			{
 				r := gjson.GetBytes(val, "folderUID")
@@ -155,6 +166,22 @@ func NewAlertRuleFilter(cfg *configDomain.GDGAppConfiguration, grafanaSvc ports.
 		return fmt.Errorf("invalid folder filter. Expected: %v", expressions)
 	}, folderArr)
 
+	filterObj.AddValidation(domain.Name, func(value any, expected any) error {
+		val, expressions, convErr := v2.GetParams[string](value, expected, domain.Name)
+		if convErr != nil {
+			return convErr
+		}
+		//no filter active
+		if expressions == "" {
+			return nil
+		}
+		if expected == val {
+			return nil
+		}
+
+		return fmt.Errorf("invalid folder filter. Expected: %v", expressions)
+	}, filterEntities.Name)
+
 	// Tags
 	filterObj.AddValidation(domain.TagsFilter, func(value any, expected any) error {
 		val, exp, convErr := v2.GetMismatchParams[map[string]string, []string](value, expected, domain.TagsFilter)

internal/domain/cli_filter_models.go

@@ -4,6 +4,7 @@ package domain
 // It allows filtering by folder name, a set of labels, and provides an option to ignore folder-based rules.
 type AlertRuleFilterParams struct {
 	Folder               string
+	Name                 string
 	Label                []string
 	IgnoreWatchedFolders bool
 }

test/alerting_rules_test.go

@@ -192,6 +192,34 @@ func TestAlertingRulesFilterTest(t *testing.T) {
 	rulesList, err = apiClient.ListAlertRules(alertFilters)
 	is.NoErr(err)
 	is.Equal(len(rulesList), 2)
+	// Adding a name based filter
+	f = domain.AlertRuleFilterParams{
+		IgnoreWatchedFolders: true,
+		Name:                 "boom",
+	}
+	alertFilters = api.NewAlertRuleFilter(cfg, apiClient, f)
+	rulesList, err = apiClient.ListAlertRules(alertFilters)
+	is.Equal(len(rulesList), 1)
+	f = domain.AlertRuleFilterParams{
+		IgnoreWatchedFolders: false,
+		Name:                 "boom",
+	}
+	alertFilters = api.NewAlertRuleFilter(cfg, apiClient, f)
+	rulesList, err = apiClient.ListAlertRules(alertFilters)
+	is.Equal(len(rulesList), 0)
+	// Now run test for a rule under the monitored folders
+	f = domain.AlertRuleFilterParams{
+		IgnoreWatchedFolders: false,
+		Name:                 "woof",
+	}
+	alertFilters = api.NewAlertRuleFilter(cfg, apiClient, f)
+	rulesList, err = apiClient.ListAlertRules(alertFilters)
+	is.Equal(len(rulesList), 1)
+	f = domain.AlertRuleFilterParams{
+		IgnoreWatchedFolders: true,
+		Name:                 "woof",
+	}
+	is.Equal(len(rulesList), 1)
 }
 
 func TestAlertingRulesNoFilterCrud(t *testing.T) {

website/content/docs/releases/gdg_0.9.md

@@ -1,7 +1,7 @@
 ---
 title: "Version 0.9"
 description: "Release Notes for v0.9"
-date: 2026-01-07T00:00:00
+date: 2026-03-07T00:00:00
 draft: false
 images: [ ]
 weight: 2
@@ -11,6 +11,8 @@ toc: true
 ## Release Notes for v0.9.3
 
 ### Changes
+ - [#557](https://github.com/esnet/gdg/pull/557) Adds label and folder based filtering to alert rules.
+ - [#559](https://github.com/esnet/gdg/pull/559) Adds name based filtering to alert rules.
 
 ### BugFixes
   - [#543](https://github.com/esnet/gdg/issues/543) Env vars not working due to a conflict with the secure_location pattern that was previously introduced. Env will work if secure location not used. Next major release (0.10.x) will fix this to allow for Env to take precedence over any config values.
@@ -21,6 +23,7 @@ toc: true
  - [#488](https://github.com/esnet/gdg/issues/488) Added an Env to disable enterprise tests. Allow contributors to not be blocked without a license.
  - [#531](https://github.com/esnet/gdg/issues/531) Fixing documentation issues with the Getting Started guide and css/icons rendering behavior.
  - General dependency and tooling update, upgrade to go 1.26.0, npm updates
+ - [#558](https://github.com/esnet/gdg/pull/558) Refactors code base to follow port/adapters/domains
 
 ## Release Notes for v0.9.2
 

website/content/docs/usage_guide/backup_guide.md

@@ -34,6 +34,7 @@ gdg backup alerting contactpoints download  -- Download all known contact points
 gdg backup alerting contactpoints upload -- Upload all contact points
 gdg backup alerting contactpoints clear -- Clear all contact points
 ```
+
 {{< details "Example Output:" >}}
 ```
 ┌────────────────┬─────────┬─────────┬───────────────────────────────────────────────────┐
@@ -78,6 +79,12 @@ gdg backup alerting rules upload -- Upload all rules
 gdg backup alerting rules clear -- Clear all rules
 ```
 
+**Available Options:**
+  - `--folder string`            filter by folder
+  - `--ignore-watched-folders`   Default to false, but if passed then will only operate on the list of folders listed in the configuration file
+  - `--label stringArray`        Filter by label name value pair. (Additive behavior dashboard includes: label1 AND label2).  ex --label env=staging
+  - `--name string`              filter by name
+
 
 {{< details "Example Output:" >}}
 ```