Allow sort by multiple keys

Signed-off-by: GuessWhoSamFoo <[email protected]>
vmware-archive · Oct 30, 2020 · 4545b2f · 4545b2f
1 parent 8fe97ca
commit 4545b2f
Show file tree

Hide file tree

Showing 12 changed files with 95 additions and 48 deletions.
diff --git a/internal/modules/configuration/plugin_describer.go b/internal/modules/configuration/plugin_describer.go
@@ -92,7 +92,7 @@ func (d *PluginListDescriber) Describe(ctx context.Context, namespace string, op
 		tbl.Add(row)
 	}
 
-	tbl.Sort("Name", false, false)
+	tbl.Sort(false, false, "Name")
 
 	return component.ContentResponse{
 		Components: []component.Component{list},

diff --git a/internal/printer/configmap.go b/internal/printer/configmap.go
@@ -123,7 +123,7 @@ func describeConfigMapData(cm *corev1.ConfigMap) (*component.Table, error) {
 		table.Add(row)
 	}
 
-	table.Sort("Key", false, false)
+	table.Sort(false, false, "Key")
 
 	return table, nil
 }

diff --git a/internal/printer/customresource.go b/internal/printer/customresource.go
@@ -95,7 +95,7 @@ func CreateCustomResourceList(crdObject *unstructured.Unstructured, resources *u
 		table.Add(row)
 	}
 
-	table.Sort("Name", false, false)
+	table.Sort(false, false, "Name")
 
 	return table, nil
 }

diff --git a/internal/printer/deployment.go b/internal/printer/deployment.go
@@ -146,7 +146,7 @@ func createDeploymentConditionsView(deployment *appsv1.Deployment) (*component.T
 		table.Add(row)
 	}
 
-	table.Sort("Type", false, false)
+	table.Sort(false, false, "Type")
 
 	return table, nil
 }

diff --git a/internal/printer/event.go b/internal/printer/event.go
@@ -68,7 +68,7 @@ func EventListHandler(ctx context.Context, list *corev1.EventList, opts Options)
 		table.Add(row)
 	}
 
-	table.Sort("Last Seen", true, false)
+	table.Sort(true, false, "Last Seen")
 
 	return table, nil
 }

diff --git a/internal/printer/horizontalpodautoscaler.go b/internal/printer/horizontalpodautoscaler.go
@@ -241,7 +241,7 @@ func createHorizontalPodAutoscalerConditionsView(horizontalPodAutoscaler *autosc
 		table.Add(row)
 	}
 
-	table.Sort("Type", false, false)
+	table.Sort(false, false, "Type")
 
 	return table, nil
 }

diff --git a/internal/printer/namespace.go b/internal/printer/namespace.go
@@ -219,7 +219,7 @@ func printNamespaceResourceQuotas(quotas []corev1.ResourceQuota) map[string]comp
 			row["Limit"] = component.NewText(q["hard"][resource])
 			table.Add(row)
 		}
-		table.Sort("Resource", false, false)
+		table.Sort(false, false, "Resource")
 		items[quotas[i].Name] = component.FlexLayoutItem{Width: component.WidthHalf, View: table}
 	}
 	return items

diff --git a/internal/printer/node.go b/internal/printer/node.go
@@ -320,7 +320,7 @@ func createNodeConditionsView(node *corev1.Node) (*component.Table, error) {
 		table.Add(row)
 	}
 
-	table.Sort("Type", false, false)
+	table.Sort(false, false, "Type")
 
 	return table, nil
 }
@@ -345,7 +345,7 @@ func createNodeImagesView(node *corev1.Node) (*component.Table, error) {
 		table.Add(row)
 	}
 
-	table.Sort("Names", false, false)
+	table.Sort(false, false, "Names")
 
 	return table, nil
 }

diff --git a/internal/printer/object_table.go b/internal/printer/object_table.go
@@ -149,7 +149,7 @@ func (ol *ObjectTable) ToComponent() (component.Component, error) {
 	}
 
 	if so := ol.sortOrder; so != nil {
-		table.Sort(so.name, so.reverse, so.hasStatus)
+		table.Sort(so.reverse, so.hasStatus, so.name)
 	}
 
 	return table, nil

diff --git a/internal/printer/secret.go b/internal/printer/secret.go
@@ -111,7 +111,7 @@ func describeSecretData(secret corev1.Secret) (*component.Table, error) {
 		table.Add(row)
 	}
 
-	table.Sort("Key", false, false)
+	table.Sort(false, false, "Key")
 
 	return table, nil
 }

diff --git a/pkg/view/component/table.go b/pkg/view/component/table.go
@@ -162,53 +162,59 @@ func (t *Table) IsEmpty() bool {
 	return len(t.Config.Rows) == 0
 }
 
+// SetPlaceholder adds placeholder text to an empty table.
 func (t *Table) SetPlaceholder(placeholder string) {
 	t.Config.EmptyContent = placeholder
 }
 
-func (t *Table) Sort(name string, reverse bool, status bool) {
+// Sort sorts a table by one or more keys with booleans for reverse and object status.
+func (t *Table) Sort(reverse bool, status bool, keys ...string) {
 	t.mu.Lock()
 	defer t.mu.Unlock()
 
-	statusFunc := func(i, j TableRow) bool {
-		a, ok := i[name].(*Link)
-		if !ok {
-			spew.Dump(fmt.Sprintf("%s:%v/%v", name, i, j), t.Config.Rows)
-			return false
-		}
-
-		b, ok := j[name].(*Link)
-		if !ok {
-			spew.Dump(fmt.Sprintf("%s:%v/%v", name, i, j), t.Config.Rows)
-			return false
-		}
-		return a.Config.Status > b.Config.Status
-	}
-
-	nameFunc := func(i, j TableRow) bool {
-		a, ok := i[name]
-		if !ok {
-			spew.Dump(fmt.Sprintf("%s:%v/%v", name, i, j), t.Config.Rows)
-			return false
-		}
-
-		b, ok := j[name]
-		if !ok {
-			spew.Dump(fmt.Sprintf("%s:%v/%v", name, i, j), t.Config.Rows)
-			return false
+	var sortFuncs []lessFunc
+
+	for _, key := range keys {
+		if status {
+			statusFunc := func(i, j TableRow) bool {
+				a, ok := i[key].(*Link)
+				if !ok {
+					spew.Dump(fmt.Sprintf("%s:%v/%v", key, i, j), t.Config.Rows)
+					return false
+				}
+
+				b, ok := j[key].(*Link)
+				if !ok {
+					spew.Dump(fmt.Sprintf("%s:%v/%v", key, i, j), t.Config.Rows)
+					return false
+				}
+				return a.Config.Status > b.Config.Status
+			}
+			sortFuncs = append(sortFuncs, statusFunc)
 		}
 
-		if reverse {
-			return !a.LessThan(b)
+		nameFunc := func(i, j TableRow) bool {
+			a, ok := i[key]
+			if !ok {
+				spew.Dump(fmt.Sprintf("%s:%v/%v", key, i, j), t.Config.Rows)
+				return false
+			}
+
+			b, ok := j[key]
+			if !ok {
+				spew.Dump(fmt.Sprintf("%s:%v/%v", key, i, j), t.Config.Rows)
+				return false
+			}
+
+			if reverse {
+				return !a.LessThan(b)
+			}
+			return a.LessThan(b)
 		}
-		return a.LessThan(b)
+		sortFuncs = append(sortFuncs, nameFunc)
 	}
 
-	if status {
-		OrderedBy(statusFunc, nameFunc).Sort(t.Rows())
-	} else {
-		OrderedBy(nameFunc).Sort(t.Rows())
-	}
+	OrderedBy(sortFuncs).Sort(t.Rows())
 }
 
 type lessFunc func(p1, p2 TableRow) bool
@@ -223,7 +229,7 @@ func (ms *multiSorter) Sort(tableRow []TableRow) {
 	sort.Sort(ms)
 }
 
-func OrderedBy(less ...lessFunc) *multiSorter {
+func OrderedBy(less []lessFunc) *multiSorter {
 	return &multiSorter{
 		less: less,
 	}

diff --git a/pkg/view/component/table_test.go b/pkg/view/component/table_test.go
@@ -150,6 +150,7 @@ func Test_Table_Sort(t *testing.T) {
 		rows     []TableRow
 		reverse  bool
 		status   bool
+		multiple bool
 		expected []TableRow
 	}{
 		{
@@ -222,12 +223,52 @@ func Test_Table_Sort(t *testing.T) {
 				{"a": NewLink("", "a", "/a", genObjectStatus(TextStatusOK, []string{""}))},
 			},
 		},
+		{
+			name:     "multiple keys",
+			reverse:  false,
+			status:   false,
+			multiple: true,
+			rows: []TableRow{
+				{"a": NewText("1"), "b": NewText("2")},
+				{"a": NewText("1"), "b": NewText("1")},
+				{"a": NewText("1"), "b": NewText("3")},
+			},
+			expected: []TableRow{
+				{"a": NewText("1"), "b": NewText("1")},
+				{"a": NewText("1"), "b": NewText("2")},
+				{"a": NewText("1"), "b": NewText("3")},
+			},
+		},
+		{
+			name:     "multiple keys, desc, and status",
+			reverse:  true,
+			status:   true,
+			multiple: true,
+			rows: []TableRow{
+				{"a": NewText("1"), "b": NewLink("", "2", "/2", genObjectStatus(TextStatusOK, []string{""}))},
+				{"a": NewText("1"), "b": NewLink("", "1", "/1", genObjectStatus(TextStatusOK, []string{""}))},
+				{"a": NewText("1"), "b": NewLink("", "1", "/1", genObjectStatus(TextStatusWarning, []string{""}))},
+				{"a": NewText("1"), "b": NewLink("", "3", "/3", genObjectStatus(TextStatusOK, []string{""}))},
+				{"a": NewText("1"), "b": NewLink("", "1", "/1", genObjectStatus(TextStatusError, []string{""}))},
+			},
+			expected: []TableRow{
+				{"a": NewText("1"), "b": NewLink("", "1", "/1", genObjectStatus(TextStatusError, []string{""}))},
+				{"a": NewText("1"), "b": NewLink("", "1", "/1", genObjectStatus(TextStatusWarning, []string{""}))},
+				{"a": NewText("1"), "b": NewLink("", "3", "/3", genObjectStatus(TextStatusOK, []string{""}))},
+				{"a": NewText("1"), "b": NewLink("", "2", "/2", genObjectStatus(TextStatusOK, []string{""}))},
+				{"a": NewText("1"), "b": NewLink("", "1", "/1", genObjectStatus(TextStatusOK, []string{""}))},
+			},
+		},
 	}
 
 	for _, tc := range cases {
 		t.Run(tc.name, func(t *testing.T) {
 			table := NewTableWithRows("table", "placeholder", NewTableCols("a"), tc.rows)
-			table.Sort("a", tc.reverse, tc.status)
+			if tc.multiple {
+				table.Sort(tc.reverse, tc.status, "a", "b")
+			} else {
+				table.Sort(tc.reverse, tc.status, "a")
+			}
 			expected := NewTableWithRows("table", "placeholder", NewTableCols("a"), tc.expected)
 
 			assert.Equal(t, expected, table)