feat(core): pagination of LIST commands (#447)

1. Fixes a few bad BATS tests that used `--regexp` with the wrong values but passed because of more generous `assert_output` instead of `assert_line` 2. Adds pagination info to LIST command flags and tables in a footer 3. Adds basic BATS tests to all LIST commands 4. Adds a comprehensive BATS test for pagination scenarios to `attributes` alone to avoid test redundancy
opentdf · Dec 5, 2024 · 673a064 · 673a064
1 parent 1c8c739
commit 673a064
Show file tree

Hide file tree

Showing 37 changed files with 358 additions and 121 deletions.
diff --git a/cmd/dev.go b/cmd/dev.go
@@ -18,7 +18,11 @@ import (
 // devCmd is the command for playground-style development
 var devCmd = man.Docs.GetCommand("dev")
 
-var metadataLabels []string
+var (
+	metadataLabels        []string
+	defaultListFlagLimit  int32 = 300
+	defaultListFlagOffset int32 = 0
+)
 
 func dev_designSystem(cmd *cobra.Command, args []string) {
 	fmt.Print("Design system\n=============\n\n")
@@ -116,6 +120,22 @@ func injectLabelFlags(cmd *cobra.Command, isUpdate bool) {
 	}
 }
 
+// Adds reusable limit/offset flags to a Policy LIST command
+func injectListPaginationFlags(listDoc *man.Doc) {
+	listDoc.Flags().Int32P(
+		listDoc.GetDocFlag("limit").Name,
+		listDoc.GetDocFlag("limit").Shorthand,
+		defaultListFlagLimit,
+		listDoc.GetDocFlag("limit").Description,
+	)
+	listDoc.Flags().Int32P(
+		listDoc.GetDocFlag("offset").Name,
+		listDoc.GetDocFlag("offset").Shorthand,
+		defaultListFlagOffset,
+		listDoc.GetDocFlag("offset").Description,
+	)
+}
+
 // Read bytes from stdin without blocking by checking size first
 func readPipedStdin() []byte {
 	stat, err := os.Stdin.Stat()

diff --git a/cmd/kas-grants.go b/cmd/kas-grants.go
@@ -162,6 +162,8 @@ func policy_listKasGrants(cmd *cobra.Command, args []string) {
 	h := NewHandler(c)
 	defer h.Close()
 	kasF := c.Flags.GetOptionalString("kas")
+	limit := c.Flags.GetRequiredInt32("limit")
+	offset := c.Flags.GetRequiredInt32("offset")
 	var (
 		kasID  string
 		kasURI string
@@ -177,7 +179,7 @@ func policy_listKasGrants(cmd *cobra.Command, args []string) {
 		}
 	}
 
-	grants, err := h.ListKasGrants(cmd.Context(), kasID, kasURI)
+	grants, page, err := h.ListKasGrants(cmd.Context(), kasID, kasURI, limit, offset)
 	if err != nil {
 		cli.ExitWithError("Failed to list assigned KAS Grants", err)
 	}
@@ -224,6 +226,7 @@ func policy_listKasGrants(cmd *cobra.Command, args []string) {
 		}
 	}
 	t = t.WithRows(rows)
+	t = cli.WithListPaginationFooter(t, page)
 
 	// Do not supporting printing the 'get --id=...' helper message as grants are atypical
 	// with no individual ID.
@@ -304,6 +307,8 @@ func init() {
 		listCmd.GetDocFlag("kas").Default,
 		listCmd.GetDocFlag("kas").Description,
 	)
+	injectListPaginationFlags(listCmd)
+
 	cmd := man.Docs.GetCommand("policy/kas-grants",
 		man.WithSubcommands(assignCmd, unassignCmd, listCmd),
 	)

diff --git a/cmd/kas-registry.go b/cmd/kas-registry.go
@@ -57,7 +57,10 @@ func policy_listKeyAccessRegistries(cmd *cobra.Command, args []string) {
 	h := NewHandler(c)
 	defer h.Close()
 
-	list, err := h.ListKasRegistryEntries()
+	limit := c.Flags.GetRequiredInt32("limit")
+	offset := c.Flags.GetRequiredInt32("offset")
+
+	list, page, err := h.ListKasRegistryEntries(limit, offset)
 	if err != nil {
 		cli.ExitWithError("Failed to list Registered KAS entries", err)
 	}
@@ -84,6 +87,7 @@ func policy_listKeyAccessRegistries(cmd *cobra.Command, args []string) {
 		}))
 	}
 	t = t.WithRows(rows)
+	t = cli.WithListPaginationFooter(t, page)
 	HandleSuccess(cmd, "", t, list)
 }
 
@@ -268,6 +272,7 @@ func init() {
 	listDoc := man.Docs.GetCommand("policy/kas-registry/list",
 		man.WithRun(policy_listKeyAccessRegistries),
 	)
+	injectListPaginationFlags(listDoc)
 
 	createDoc := man.Docs.GetCommand("policy/kas-registry/create",
 		man.WithRun(policy_createKeyAccessRegistry),

diff --git a/cmd/policy-attributeNamespaces.go b/cmd/policy-attributeNamespaces.go
@@ -45,7 +45,10 @@ func policy_listAttributeNamespaces(cmd *cobra.Command, args []string) {
 	defer h.Close()
 
 	state := cli.GetState(cmd)
-	list, err := h.ListNamespaces(state)
+	limit := c.Flags.GetRequiredInt32("limit")
+	offset := c.Flags.GetRequiredInt32("offset")
+
+	list, page, err := h.ListNamespaces(state, limit, offset)
 	if err != nil {
 		cli.ExitWithError("Failed to list namespaces", err)
 	}
@@ -72,6 +75,7 @@ func policy_listAttributeNamespaces(cmd *cobra.Command, args []string) {
 		)
 	}
 	t = t.WithRows(rows)
+	t = cli.WithListPaginationFooter(t, page)
 	HandleSuccess(cmd, "", t, list)
 }
 
@@ -281,6 +285,7 @@ func init() {
 		listCmd.GetDocFlag("state").Default,
 		listCmd.GetDocFlag("state").Description,
 	)
+	injectListPaginationFlags(listCmd)
 
 	createDoc := man.Docs.GetCommand("policy/attributes/namespaces/create",
 		man.WithRun(policy_createAttributeNamespace),

diff --git a/cmd/policy-attributeValues.go b/cmd/policy-attributeValues.go
@@ -53,9 +53,13 @@ func policy_listAttributeValue(cmd *cobra.Command, args []string) {
 	c := cli.New(cmd, args)
 	h := NewHandler(c)
 	defer h.Close()
+
 	attrId := c.FlagHelper.GetRequiredID("attribute-id")
 	state := cli.GetState(cmd)
-	vals, err := h.ListAttributeValues(attrId, state)
+	limit := c.Flags.GetRequiredInt32("limit")
+	offset := c.Flags.GetRequiredInt32("offset")
+
+	vals, page, err := h.ListAttributeValues(attrId, state, limit, offset)
 	if err != nil {
 		cli.ExitWithError("Failed to list attribute values", err)
 	}
@@ -80,6 +84,7 @@ func policy_listAttributeValue(cmd *cobra.Command, args []string) {
 		}))
 	}
 	t = t.WithRows(rows)
+	t = cli.WithListPaginationFooter(t, page)
 	HandleSuccess(cmd, "", t, vals)
 }
 
@@ -264,6 +269,7 @@ func init() {
 		listCmd.GetDocFlag("state").Default,
 		listCmd.GetDocFlag("state").Description,
 	)
+	injectListPaginationFlags(listCmd)
 
 	updateCmd := man.Docs.GetCommand("policy/attributes/values/update",
 		man.WithRun(policy_updateAttributeValue),

diff --git a/cmd/policy-attributes.go b/cmd/policy-attributes.go
@@ -91,7 +91,10 @@ func policy_listAttributes(cmd *cobra.Command, args []string) {
 	defer h.Close()
 
 	state := cli.GetState(cmd)
-	attrs, err := h.ListAttributes(state)
+	limit := c.Flags.GetRequiredInt32("limit")
+	offset := c.Flags.GetRequiredInt32("offset")
+
+	attrs, page, err := h.ListAttributes(state, limit, offset)
 	if err != nil {
 		cli.ExitWithError("Failed to list attributes", err)
 	}
@@ -123,6 +126,7 @@ func policy_listAttributes(cmd *cobra.Command, args []string) {
 		}))
 	}
 	t = t.WithRows(rows)
+	t = cli.WithListPaginationFooter(t, page)
 	HandleSuccess(cmd, "", t, attrs)
 }
 
@@ -349,6 +353,7 @@ func init() {
 		listDoc.GetDocFlag("state").Default,
 		listDoc.GetDocFlag("state").Description,
 	)
+	injectListPaginationFlags(listDoc)
 
 	// Update an attribute
 	updateDoc := man.Docs.GetCommand("policy/attributes/update",

diff --git a/cmd/policy-resourceMappings.go b/cmd/policy-resourceMappings.go
@@ -73,7 +73,10 @@ func policy_listResourceMappings(cmd *cobra.Command, args []string) {
 	h := NewHandler(c)
 	defer h.Close()
 
-	rmList, err := h.ListResourceMappings()
+	limit := c.Flags.GetRequiredInt32("limit")
+	offset := c.Flags.GetRequiredInt32("offset")
+
+	rmList, page, err := h.ListResourceMappings(cmd.Context(), limit, offset)
 	if err != nil {
 		cli.ExitWithError("Failed to list resource mappings", err)
 	}
@@ -101,6 +104,7 @@ func policy_listResourceMappings(cmd *cobra.Command, args []string) {
 		}))
 	}
 	t = t.WithRows(rows)
+	t = cli.WithListPaginationFooter(t, page)
 	HandleSuccess(cmd, "", t, rmList)
 }
 
@@ -189,6 +193,7 @@ func init() {
 	listDoc := man.Docs.GetCommand("policy/resource-mappings/list",
 		man.WithRun(policy_listResourceMappings),
 	)
+	injectListPaginationFlags(listDoc)
 
 	updateDoc := man.Docs.GetCommand("policy/resource-mappings/update",
 		man.WithRun(policy_updateResourceMapping),

diff --git a/cmd/policy-subjectConditionSets.go b/cmd/policy-subjectConditionSets.go
@@ -143,7 +143,10 @@ func policy_listSubjectConditionSets(cmd *cobra.Command, args []string) {
 	h := NewHandler(c)
 	defer h.Close()
 
-	scsList, err := h.ListSubjectConditionSets()
+	limit := c.Flags.GetRequiredInt32("limit")
+	offset := c.Flags.GetRequiredInt32("offset")
+
+	scsList, page, err := h.ListSubjectConditionSets(limit, offset)
 	if err != nil {
 		cli.ExitWithError("Error listing subject condition sets", err)
 	}
@@ -171,6 +174,7 @@ func policy_listSubjectConditionSets(cmd *cobra.Command, args []string) {
 		}))
 	}
 	t = t.WithRows(rows)
+	t = cli.WithListPaginationFooter(t, page)
 	HandleSuccess(cmd, "", t, scsList)
 }
 
@@ -340,6 +344,7 @@ func init() {
 	listDoc := man.Docs.GetCommand("policy/subject-condition-sets/list",
 		man.WithRun(policy_listSubjectConditionSets),
 	)
+	injectListPaginationFlags(listDoc)
 
 	updateDoc := man.Docs.GetCommand("policy/subject-condition-sets/update",
 		man.WithRun(policy_updateSubjectConditionSet),

diff --git a/cmd/policy-subjectMappings.go b/cmd/policy-subjectMappings.go
@@ -64,7 +64,10 @@ func policy_listSubjectMappings(cmd *cobra.Command, args []string) {
 	h := NewHandler(c)
 	defer h.Close()
 
-	list, err := h.ListSubjectMappings()
+	limit := c.Flags.GetRequiredInt32("limit")
+	offset := c.Flags.GetRequiredInt32("offset")
+
+	list, page, err := h.ListSubjectMappings(limit, offset)
 	if err != nil {
 		cli.ExitWithError("Failed to get subject mappings", err)
 	}
@@ -98,6 +101,7 @@ func policy_listSubjectMappings(cmd *cobra.Command, args []string) {
 		}))
 	}
 	t = t.WithRows(rows)
+	t = cli.WithListPaginationFooter(t, page)
 	HandleSuccess(cmd, "", t, list)
 }
 
@@ -353,6 +357,7 @@ func init() {
 	listDoc := man.Docs.GetCommand("policy/subject-mappings/list",
 		man.WithRun(policy_listSubjectMappings),
 	)
+	injectListPaginationFlags(listDoc)
 
 	createDoc := man.Docs.GetCommand("policy/subject-mappings/create",
 		man.WithRun(policy_createSubjectMapping),

diff --git a/docs/man/policy/attributes/list.md b/docs/man/policy/attributes/list.md
@@ -13,6 +13,12 @@ command:
         - inactive
         - any
       default: active
+    - name: limit
+      shorthand: l
+      description: Limit retrieved count
+    - name: offset
+      shorthand: o
+      description: Offset (page) quantity from start of the list
 ---
 
 By default, the list will only provide `active` attributes if unspecified, but the filter can be controlled with the `--state` flag.

diff --git a/docs/man/policy/attributes/namespaces/list.md b/docs/man/policy/attributes/namespaces/list.md
@@ -9,6 +9,12 @@ command:
     - name: state
       shorthand: s
       description: Filter by state [active, inactive, any]
+    - name: limit
+      shorthand: l
+      description: Limit retrieved count
+    - name: offset
+      shorthand: o
+      description: Offset (page) quantity from start of the list
 ---
 
 For more general information, see the `namespaces` subcommand.
diff --git a/docs/man/policy/attributes/values/list.md b/docs/man/policy/attributes/values/list.md
@@ -17,6 +17,12 @@ command:
         - inactive
         - any
       default: active
+    - name: limit
+      shorthand: l
+      description: Limit retrieved count
+    - name: offset
+      shorthand: o
+      description: Offset (page) quantity from start of the list
 ---
 
 By default, the list will only provide `active` values if unspecified, but the filter can be controlled with the `--state` flag.

diff --git a/docs/man/policy/kas-grants/list.md b/docs/man/policy/kas-grants/list.md
@@ -10,6 +10,12 @@ command:
     - name: kas
       shorthand: k
       description: The optional ID or URI of a KAS to filter the list
+    - name: limit
+      shorthand: l
+      description: Limit retrieved count
+    - name: offset
+      shorthand: o
+      description: Offset (page) quantity from start of the list
 ---
 
 List the Grants of Registered Key Access Servers (KASes) to attribute namespaces, definitions,

diff --git a/docs/man/policy/kas-registry/list.md b/docs/man/policy/kas-registry/list.md
@@ -4,6 +4,13 @@ command:
   name: list
   aliases:
     - l
+  flags:
+    - name: limit
+      shorthand: l
+      description: Limit retrieved count
+    - name: offset
+      shorthand: o
+      description: Offset (page) quantity from start of the list
 ---
 
 For more information about registration of Key Access Servers, see the manual for `kas-registry`.
diff --git a/docs/man/policy/resource-mappings/list.md b/docs/man/policy/resource-mappings/list.md
@@ -4,6 +4,13 @@ command:
   name: list
   aliases:
     - l
+  flags:
+    - name: limit
+      shorthand: l
+      description: Limit retrieved count
+    - name: offset
+      shorthand: o
+      description: Offset (page) quantity from start of the list
 ---
 
 For more information about resource mappings, see the `resource-mappings` subcommand.
diff --git a/docs/man/policy/subject-condition-sets/list.md b/docs/man/policy/subject-condition-sets/list.md
@@ -5,6 +5,13 @@ command:
   name: list
   aliases:
     - l
+  flags:
+    - name: limit
+      shorthand: l
+      description: Limit retrieved count
+    - name: offset
+      shorthand: o
+      description: Offset (page) quantity from start of the list
 ---
 
 For more information about subject condition sets, see the `subject-condition-sets` subcommand.
diff --git a/docs/man/policy/subject-mappings/list.md b/docs/man/policy/subject-mappings/list.md
@@ -4,6 +4,13 @@ command:
   name: list
   aliases:
     - l
+  flags:
+    - name: limit
+      shorthand: l
+      description: Limit retrieved count
+    - name: offset
+      shorthand: o
+      description: Offset (page) quantity from start of the list
 ---
 
 For more information about subject mappings, see the `subject-mappings` subcommand.