Adding comments

Signed-off-by: katara-Jayprakash <katarajayprakash@icloud.com>

Author: katara-Jayprakash

.gitignore

@@ -1,4 +1,4 @@
-# SPDX-FileCopyrightText: 2023 SUSE LLC
+# SPDX-FileCopyrightText: 2026 SUSE LLC
 #
 # SPDX-License-Identifier: Apache-2.0
 

mgrctl/cmd/get/get.go

@@ -1,4 +1,4 @@
-// SPDX-FileCopyrightText: 2026 SUSE LLC
+// SPDX-FileCopyrightText: 2026 Jayprakash
 //
 // SPDX-License-Identifier: Apache-2.0
 
@@ -29,15 +29,32 @@ func NewCommand(globalFlags *types.GlobalFlags) *cobra.Command {
 	cmd := &cobra.Command{
 		Use:   "get <resource-type> [flags]",
 		Short: L("Display one or many resources"),
+		Example: `  mgrctl get system
+  mgrctl get systemgroup
+  mgrctl get system --page 0 --page-size 10
+  mgrctl get system --filter "extra_pkg_count>0"`,
+		Long: L(`Fetch and display Uyuni API resources in table, JSON, or YAML format.
+
+The resource type is passed as the first argument. Filtering and pagination
+are handled server-side when the API endpoint supports it.
+
+Available resource types:
+` + GetResourceHelp() + `
+
+Filter Operators:
+  >=, <=, !=, =, >, < (e.g. extra_pkg_count>0)
+
+Custom Columns:
+  Use -o custom-columns=HEADER:path,HEADER:path to extract specific JSON fields.
+  Example: -o custom-columns=ID:.id,NAME:.name`),
 		Args:      cobra.MatchAll(cobra.ExactArgs(1), cobra.OnlyValidArgs),
 		ValidArgs: registeredTypes(),
 		RunE: func(cmd *cobra.Command, args []string) error {
 			return utils.CommandHelper(globalFlags, cmd, args, &flags, nil, runGet)
 		},
 	}
 
-	cmd.Flags().StringVarP(&flags.OutputFormat, "output", "o", "table",
-		L("Output format: table|json|yaml|custom-columns=SPEC|custom-columns-file=PATH"))
+	utils.AddOutputFlag(cmd, &flags.OutputFormat)
 	cmd.Flags().StringVar(&flags.Filter, "filter", "",
 		L("Filter expression (e.g. extra_pkg_count=0)"))
 	cmd.Flags().IntVar(&flags.Page, "page", 0,
@@ -66,10 +83,14 @@ func runGet(_ *types.GlobalFlags, flags *getFlags, _ *cobra.Command, args []stri
 		return utils.Errorf(err, L("unable to login to the server"))
 	}
 
-	items, err := fetcher.List(client, flags.Filter, flags.Page, flags.PageSize)
+	items, total, err := fetcher.List(client, flags.Filter, flags.Page, flags.PageSize)
 	if err != nil {
 		return err
 	}
 
-	return printOutput(flags.OutputFormat, items, fetcher.Columns(), os.Stdout)
+	if total > 0 && flags.PageSize > 0 {
+		log.Info().Msgf("Fetched %d items out of %d total", len(items), total)
+	}
+
+	return utils.PrintOutput(flags.OutputFormat, items, fetcher.Columns(), os.Stdout)
 }

mgrctl/cmd/get/resource.go

@@ -1,39 +1,49 @@
-// SPDX-FileCopyrightText: 2026 SUSE LLC
+// SPDX-FileCopyrightText: 2026 Jayprakash
 //
 // SPDX-License-Identifier: Apache-2.0
 
 package get
 
 import (
 	"fmt"
-	"net/url"
 	"sort"
 	"strings"
 
 	"github.com/uyuni-project/uyuni-tools/shared/api"
 	apitypes "github.com/uyuni-project/uyuni-tools/shared/api/types"
 	. "github.com/uyuni-project/uyuni-tools/shared/l10n"
+	"github.com/uyuni-project/uyuni-tools/shared/utils"
 )
 
-type ColumnDef struct {
-	Header string
-	Field  string
+type ResourceFetcher interface {
+	List(client *api.APIClient, filter string, page, pageSize int) ([]map[string]any, int, error)
+	Columns() []utils.ColumnDef
 }
 
-type ResourceFetcher interface {
-	List(client *api.APIClient, filter string, page, pageSize int) ([]map[string]any, error)
-	Columns() []ColumnDef
+type Resource struct {
+	Fetcher     ResourceFetcher
+	Aliases     []string
+	Description string
 }
 
-var resourceTypes = map[string]ResourceFetcher{
-	"system":      systemFetcher{},
-	"systemgroup": systemGroupFetcher{},
+var resourceTypes = map[string]Resource{
+	"system": {
+		Fetcher:     systemFetcher{},
+		Aliases:     []string{"sys"},
+		Description: "List systems",
+	},
+	"systemgroup": {
+		Fetcher:     systemGroupFetcher{},
+		Aliases:     []string{"grp"},
+		Description: "List system groups",
+	},
 }
 
 func registeredTypes() []string {
-	names := make([]string, 0, len(resourceTypes))
-	for name := range resourceTypes {
+	names := make([]string, 0)
+	for name, res := range resourceTypes {
 		names = append(names, name)
+		names = append(names, res.Aliases...)
 	}
 	sort.Strings(names)
 	return names
@@ -43,40 +53,37 @@ func registeredTypesText() string {
 	return strings.Join(registeredTypes(), ", ")
 }
 
-func lookupFetcher(name string) (ResourceFetcher, error) {
-	fetcher, ok := resourceTypes[name]
-	if !ok {
-		return nil, fmt.Errorf(L("unknown resource type %q; available: %s"), name, registeredTypesText())
+func GetResourceHelp() string {
+	var lines []string
+	for name, res := range resourceTypes {
+		aliases := ""
+		if len(res.Aliases) > 0 {
+			aliases = fmt.Sprintf(" (%s)", strings.Join(res.Aliases, ", "))
+		}
+		lines = append(lines, fmt.Sprintf("  %-20s - %s", name+aliases, L(res.Description)))
 	}
-	return fetcher, nil
+	sort.Strings(lines)
+	return strings.Join(lines, "\n")
 }
 
-func listFiltered(client *api.APIClient, endpoint, filter string, page, pageSize int) ([]map[string]any, error) {
-	filterKey, filterValue := "", ""
-	if filter != "" {
-		filterKey, filterValue = parseFilter(filter)
+func lookupFetcher(name string) (ResourceFetcher, error) {
+	if res, ok := resourceTypes[name]; ok {
+		return res.Fetcher, nil
 	}
+	for _, res := range resourceTypes {
+		if utils.Contains(res.Aliases, name) {
+			return res.Fetcher, nil
+		}
+	}
+	return nil, fmt.Errorf(L("unknown resource type %q; available: %s"), name, registeredTypesText())
+}
 
-	query := url.Values{}
-	query.Set("filterKey", filterKey)
-	query.Set("filterValue", filterValue)
-	query.Set("page", fmt.Sprintf("%d", page))
-	query.Set("pageSize", fmt.Sprintf("%d", pageSize))
-
+func listFiltered(client *api.APIClient, endpoint, query string) ([]map[string]any, int, error) {
 	res, err := api.Get[apitypes.FilteredResponse[map[string]any]](
-		client, fmt.Sprintf("%s?%s", endpoint, query.Encode()),
+		client, fmt.Sprintf("%s?%s", endpoint, query),
 	)
 	if err != nil {
-		return nil, err
-	}
-	return res.Result.Data, nil
-}
-
-func parseFilter(expr string) (string, string) {
-	for _, op := range []string{">=", "<=", "!=", "=", ">", "<"} {
-		if i := strings.Index(expr, op); i >= 0 {
-			return strings.TrimSpace(expr[:i]), strings.TrimSpace(expr[i:])
-		}
+		return nil, 0, err
 	}
-	return strings.TrimSpace(expr), ""
+	return res.Result.Data, res.Result.Total, nil
 }

mgrctl/cmd/get/resource_test.go

@@ -0,0 +1,27 @@
+// SPDX-FileCopyrightText: 2026 Jayprakash
+//
+// SPDX-License-Identifier: Apache-2.0
+
+package get
+
+import (
+	"testing"
+)
+
+func TestResourceTypesNoDuplicates(t *testing.T) {
+	seen := make(map[string]bool)
+
+	for name, res := range resourceTypes {
+		if seen[name] {
+			t.Errorf("Duplicate resource key found: %s", name)
+		}
+		seen[name] = true
+
+		for _, alias := range res.Aliases {
+			if seen[alias] {
+				t.Errorf("Duplicate resource alias found: %s (in resource %s)", alias, name)
+			}
+			seen[alias] = true
+		}
+	}
+}

mgrctl/cmd/get/system.go

@@ -1,19 +1,46 @@
-// SPDX-FileCopyrightText: 2026 SUSE LLC
+// SPDX-FileCopyrightText: 2026 Jayprakash
 //
 // SPDX-License-Identifier: Apache-2.0
 
 package get
 
-import "github.com/uyuni-project/uyuni-tools/shared/api"
+import (
+	"fmt"
+	"net/url"
+	"strings"
+
+	"github.com/uyuni-project/uyuni-tools/shared/api"
+	"github.com/uyuni-project/uyuni-tools/shared/utils"
+)
 
 type systemFetcher struct{}
 
-func (systemFetcher) List(client *api.APIClient, filter string, page, pageSize int) ([]map[string]any, error) {
-	return listFiltered(client, "system/listSystemsFiltered", filter, page, pageSize)
+func (systemFetcher) List(client *api.APIClient, filter string, page, pageSize int) ([]map[string]any, int, error) {
+	filterKey, filterValue := "", ""
+	if filter != "" {
+		filterKey, filterValue = parseFilter(filter)
+	}
+
+	query := url.Values{}
+	query.Set("filterKey", filterKey)
+	query.Set("filterValue", filterValue)
+	query.Set("page", fmt.Sprintf("%d", page))
+	query.Set("pageSize", fmt.Sprintf("%d", pageSize))
+
+	return listFiltered(client, "system/listSystemsFiltered", query.Encode())
+}
+
+func parseFilter(expr string) (string, string) {
+	for _, op := range []string{">=", "<=", "!=", "=", ">", "<"} {
+		if i := strings.Index(expr, op); i >= 0 {
+			return strings.TrimSpace(expr[:i]), strings.TrimSpace(expr[i:])
+		}
+	}
+	return strings.TrimSpace(expr), ""
 }
 
-func (systemFetcher) Columns() []ColumnDef {
-	return []ColumnDef{
+func (systemFetcher) Columns() []utils.ColumnDef {
+	return []utils.ColumnDef{
 		{Header: "ID", Field: "id"},
 		{Header: "NAME", Field: "name"},
 		{Header: "LAST_CHECKIN", Field: "last_checkin"},

mgrctl/cmd/get/systemgroup.go

@@ -1,23 +1,26 @@
-// SPDX-FileCopyrightText: 2026 SUSE LLC
+// SPDX-FileCopyrightText: 2026 Jayprakash
 //
 // SPDX-License-Identifier: Apache-2.0
 
 package get
 
-import "github.com/uyuni-project/uyuni-tools/shared/api"
+import (
+	"github.com/uyuni-project/uyuni-tools/shared/api"
+	"github.com/uyuni-project/uyuni-tools/shared/utils"
+)
 
 type systemGroupFetcher struct{}
 
-func (systemGroupFetcher) List(client *api.APIClient, _ string, _, _ int) ([]map[string]any, error) {
+func (systemGroupFetcher) List(client *api.APIClient, _ string, _, _ int) ([]map[string]any, int, error) {
 	res, err := api.Get[[]map[string]any](client, "systemgroup/listAllGroups")
 	if err != nil {
-		return nil, err
+		return nil, 0, err
 	}
-	return res.Result, nil
+	return res.Result, len(res.Result), nil
 }
 
-func (systemGroupFetcher) Columns() []ColumnDef {
-	return []ColumnDef{
+func (systemGroupFetcher) Columns() []utils.ColumnDef {
+	return []utils.ColumnDef{
 		{Header: "ID", Field: "id"},
 		{Header: "NAME", Field: "name"},
 		{Header: "DESCRIPTION", Field: "description"},

shared/api/types/filtered.go

@@ -1,4 +1,4 @@
-// SPDX-FileCopyrightText: 2026 SUSE LLC
+// SPDX-FileCopyrightText: 2026 Jayprakash
 //
 // SPDX-License-Identifier: Apache-2.0
 

mgrctl/cmd/get/printer.go shared/utils/printer.gomgrctl/cmd/get/printer.go renamed to shared/utils/printer.go

@@ -1,8 +1,8 @@
-// SPDX-FileCopyrightText: 2026 SUSE LLC
+// SPDX-FileCopyrightText: 2026 Jayprakash
 //
 // SPDX-License-Identifier: Apache-2.0
 
-package get
+package utils
 
 import (
 	"encoding/json"
@@ -12,10 +12,22 @@ import (
 	"strings"
 	"text/tabwriter"
 
+	"github.com/spf13/cobra"
+	. "github.com/uyuni-project/uyuni-tools/shared/l10n"
 	"gopkg.in/yaml.v2"
 )
 
-func printOutput(format string, items []map[string]any, cols []ColumnDef, out io.Writer) error {
+type ColumnDef struct {
+	Header string
+	Field  string
+}
+
+func AddOutputFlag(cmd *cobra.Command, outputFormat *string) {
+	cmd.Flags().StringVarP(outputFormat, "output", "o", "table",
+		L("Output format: table|json|yaml|custom-columns=SPEC|custom-columns-file=PATH"))
+}
+
+func PrintOutput(format string, items []map[string]any, cols []ColumnDef, out io.Writer) error {
 	if strings.HasPrefix(format, "custom-columns=") {
 		spec := strings.TrimPrefix(format, "custom-columns=")
 		parsed := parseCustomColumns(spec)
@@ -97,6 +109,7 @@ func formatValue(v any) string {
 
 func parseCustomColumns(spec string) []ColumnDef {
 	var cols []ColumnDef
+
 	for _, part := range strings.Split(spec, ",") {
 		kv := strings.SplitN(part, ":", 2)
 		if len(kv) == 2 {
@@ -157,10 +170,12 @@ func fieldValue(item map[string]any, path string) (any, bool) {
 		if part == "" {
 			return nil, false
 		}
+
 		m, ok := current.(map[string]any)
 		if !ok {
 			return nil, false
 		}
+
 		current, ok = m[part]
 		if !ok {
 			return nil, false