don't print table if no results and add unit tests

Features: control Required-githooks: true Signed-off-by: Tom Nabarro <[email protected]>
daos-stack · Jan 23, 2024 · 86588da · 86588da
1 parent a69c445
commit 86588da
Show file tree

Hide file tree

Showing 4 changed files with 122 additions and 29 deletions.
diff --git a/src/control/cmd/dmg/pretty/storage.go b/src/control/cmd/dmg/pretty/storage.go
@@ -1,5 +1,5 @@
 //
-// (C) Copyright 2020-2023 Intel Corporation.
+// (C) Copyright 2020-2024 Intel Corporation.
 //
 // SPDX-License-Identifier: BSD-2-Clause-Patent
 //
@@ -26,7 +26,8 @@ func printHostStorageMapVerbose(hsm control.HostStorageMap, out io.Writer, opts
 		hosts := getPrintHosts(hss.HostSet.RangedString(), opts...)
 		lineBreak := strings.Repeat("-", len(hosts))
 		fmt.Fprintf(out, "%s\n%s\n%s\n", lineBreak, hosts, lineBreak)
-		fmt.Fprintf(out, "HugePage Size: %d KB\n", hss.HostStorage.MemInfo.HugepageSizeKiB)
+		fmt.Fprintf(out, "HugePage Size: %d KB\n\n",
+			hss.HostStorage.MemInfo.HugepageSizeKiB)
 		if len(hss.HostStorage.ScmNamespaces) == 0 {
 			if err := PrintScmModules(hss.HostStorage.ScmModules, out, opts...); err != nil {
 				return err

diff --git a/src/control/cmd/dmg/pretty/storage_nvme.go b/src/control/cmd/dmg/pretty/storage_nvme.go
@@ -1,5 +1,5 @@
 //
-// (C) Copyright 2020-2023 Intel Corporation.
+// (C) Copyright 2020-2024 Intel Corporation.
 //
 // SPDX-License-Identifier: BSD-2-Clause-Patent
 //
@@ -168,13 +168,14 @@ func parseNvmeFormatResults(inResults storage.NvmeControllers) storage.NvmeContr
 			parsedResults = append(parsedResults, result)
 		}
 	}
-
 	return parsedResults
 }
 
-func printNvmeFormatResults(ctrlrs storage.NvmeControllers, out io.Writer, opts ...PrintConfigOption) error {
+func printNvmeFormatResults(inCtrlrs storage.NvmeControllers, out io.Writer, opts ...PrintConfigOption) error {
+	ctrlrs := parseNvmeFormatResults(inCtrlrs)
+	iw := txtfmt.NewIndentWriter(out)
 	if len(ctrlrs) == 0 {
-		fmt.Fprintln(out, "\tNo NVMe devices found")
+		fmt.Fprintln(iw, "No NVMe devices were formatted")
 		return nil
 	}
 
@@ -188,13 +189,13 @@ func printNvmeFormatResults(ctrlrs storage.NvmeControllers, out io.Writer, opts
 
 	sort.Slice(ctrlrs, func(i, j int) bool { return ctrlrs[i].PciAddr < ctrlrs[j].PciAddr })
 
-	for _, ctrlr := range parseNvmeFormatResults(ctrlrs) {
-		row := txtfmt.TableRow{pciTitle: ctrlr.PciAddr}
-		row[resultTitle] = ctrlr.Info
+	for _, c := range ctrlrs {
+		row := txtfmt.TableRow{pciTitle: c.PciAddr}
+		row[resultTitle] = c.Info
 		roles := "NA"
 		// Assumes that all SMD devices on a controller have the same roles.
-		if len(ctrlr.SmdDevices) > 0 {
-			roles = fmt.Sprintf("%s", ctrlr.SmdDevices[0].Roles.String())
+		if len(c.SmdDevices) > 0 {
+			roles = fmt.Sprintf("%s", c.SmdDevices[0].Roles.String())
 		}
 		row[rolesTitle] = roles
 
@@ -209,8 +210,9 @@ func printNvmeFormatResults(ctrlrs storage.NvmeControllers, out io.Writer, opts
 func PrintNvmeControllers(controllers storage.NvmeControllers, out io.Writer, opts ...PrintConfigOption) error {
 	w := txtfmt.NewErrWriter(out)
 
+	iw := txtfmt.NewIndentWriter(out)
 	if len(controllers) == 0 {
-		fmt.Fprintln(out, "\tNo NVMe devices found")
+		fmt.Fprintln(iw, "No NVMe devices found")
 		return w.Err
 	}
 

diff --git a/src/control/cmd/dmg/pretty/storage_scm.go b/src/control/cmd/dmg/pretty/storage_scm.go
@@ -1,5 +1,5 @@
 //
-// (C) Copyright 2020-2021 Intel Corporation.
+// (C) Copyright 2020-2024 Intel Corporation.
 //
 // SPDX-License-Identifier: BSD-2-Clause-Patent
 //
@@ -18,8 +18,9 @@ import (
 )
 
 func printScmMountPoints(mountpoints storage.ScmMountPoints, out io.Writer, opts ...PrintConfigOption) error {
+	iw := txtfmt.NewIndentWriter(out)
 	if len(mountpoints) == 0 {
-		fmt.Fprintln(out, "\tNo SCM mount results")
+		fmt.Fprintln(iw, "No SCM mount results")
 		return nil
 	}
 
@@ -48,9 +49,9 @@ func printScmMountPoints(mountpoints storage.ScmMountPoints, out io.Writer, opts
 // TODO: un-export function when not needed in cmd/daos_server/storage.go
 func PrintScmModules(modules storage.ScmModules, out io.Writer, opts ...PrintConfigOption) error {
 	w := txtfmt.NewErrWriter(out)
-
+	iw := txtfmt.NewIndentWriter(out)
 	if len(modules) == 0 {
-		fmt.Fprintln(out, "\tNo SCM modules found")
+		fmt.Fprintln(iw, "No SCM modules found")
 		return w.Err
 	}
 
@@ -89,9 +90,9 @@ func PrintScmModules(modules storage.ScmModules, out io.Writer, opts ...PrintCon
 // TODO: un-export function when not needed in cmd/daos_server/storage.go
 func PrintScmNamespaces(namespaces storage.ScmNamespaces, out io.Writer, opts ...PrintConfigOption) error {
 	w := txtfmt.NewErrWriter(out)
-
+	iw := txtfmt.NewIndentWriter(out)
 	if len(namespaces) == 0 {
-		fmt.Fprintln(out, "\tNo SCM namespaces found")
+		fmt.Fprintln(iw, "No SCM namespaces found")
 		return w.Err
 	}
 

diff --git a/src/control/cmd/dmg/pretty/storage_test.go b/src/control/cmd/dmg/pretty/storage_test.go
@@ -1,5 +1,5 @@
 //
-// (C) Copyright 2020-2023 Intel Corporation.
+// (C) Copyright 2020-2024 Intel Corporation.
 //
 // SPDX-License-Identifier: BSD-2-Clause-Patent
 //
@@ -472,7 +472,8 @@ Errors:
 host1
 -----
 HugePage Size: 2048 KB
-	No SCM modules found
+
+  No SCM modules found
 
 NVMe PCI     Model   FW Revision Socket Capacity Role(s) Rank 
 --------     -----   ----------- ------ -------- ------- ---- 
@@ -501,11 +502,12 @@ Errors:
 host1
 -----
 HugePage Size: 2048 KB
+
 SCM Module Socket Memory Ctrlr Channel Channel Slot Capacity 
 ---------- ------ ------------ ------- ------------ -------- 
 1          1      1            1       1            954 MiB  
 
-	No NVMe devices found
+  No NVMe devices found
 
 `,
 		},
@@ -535,9 +537,10 @@ Errors:
 host[1-2]
 ---------
 HugePage Size: 2048 KB
-	No SCM modules found
 
-	No NVMe devices found
+  No SCM modules found
+
+  No NVMe devices found
 
 `,
 		},
@@ -561,9 +564,10 @@ HugePage Size: 2048 KB
 host[1-2]
 ---------
 HugePage Size: 2048 KB
-	No SCM modules found
 
-	No NVMe devices found
+  No SCM modules found
+
+  No NVMe devices found
 
 `,
 		},
@@ -583,6 +587,7 @@ HugePage Size: 2048 KB
 host1
 -----
 HugePage Size: 2048 KB
+
 SCM Module Socket Memory Ctrlr Channel Channel Slot Capacity 
 ---------- ------ ------------ ------- ------------ -------- 
 1          1      1            1       1            954 MiB  
@@ -609,6 +614,7 @@ NVMe PCI     Model   FW Revision Socket Capacity Role(s) Rank
 host1
 -----
 HugePage Size: 2048 KB
+
 SCM Namespace Socket Capacity 
 ------------- ------ -------- 
 pmem0         0      1.0 TB   
@@ -639,6 +645,7 @@ NVMe PCI     Model   FW Revision Socket Capacity Role(s) Rank
 host[1-2]
 ---------
 HugePage Size: 2048 KB
+
 SCM Module Socket Memory Ctrlr Channel Channel Slot Capacity 
 ---------- ------ ------------ ------- ------------ -------- 
 1          1      1            1       1            954 MiB  
@@ -669,17 +676,19 @@ NVMe PCI     Model   FW Revision Socket Capacity Role(s) Rank
 host1
 -----
 HugePage Size: 2048 KB
+
 SCM Module Socket Memory Ctrlr Channel Channel Slot Capacity 
 ---------- ------ ------------ ------- ------------ -------- 
 1          1      1            1       1            954 MiB  
 
-	No NVMe devices found
+  No NVMe devices found
 
 -----
 host2
 -----
 HugePage Size: 2048 KB
-	No SCM modules found
+
+  No SCM modules found
 
 NVMe PCI     Model   FW Revision Socket Capacity Role(s) Rank 
 --------     -----   ----------- ------ -------- ------- ---- 
@@ -699,6 +708,7 @@ NVMe PCI     Model   FW Revision Socket Capacity Role(s) Rank
 host[0-1023]
 ------------
 HugePage Size: 2048 KB
+
 SCM Module Socket Memory Ctrlr Channel Channel Slot Capacity 
 ---------- ------ ------------ ------- ------------ -------- 
 1          1      1            1       1            954 MiB  
@@ -737,7 +747,8 @@ NVMe PCI     Model   FW Revision Socket Capacity Role(s) Rank
 host-[0001-0004]
 ----------------
 HugePage Size: 2048 KB
-	No SCM modules found
+
+  No SCM modules found
 
 NVMe PCI     Model   FW Revision Socket Capacity Role(s) Rank 
 --------     -----   ----------- ------ -------- ------- ---- 
@@ -773,7 +784,8 @@ NVMe PCI     Model   FW Revision Socket Capacity Role(s) Rank
 host-j-[0001-0004]
 ------------------
 HugePage Size: 2048 KB
-	No SCM modules found
+
+  No SCM modules found
 
 NVMe PCI     Model   FW Revision Socket Capacity Role(s) Rank 
 --------     -----   ----------- ------ -------- ------- ---- 
@@ -809,6 +821,7 @@ NVMe PCI     Model   FW Revision Socket Capacity Role(s) Rank
 host[1,3]
 ---------
 HugePage Size: 2048 KB
+
 SCM Namespace Socket Capacity 
 ------------- ------ -------- 
 pmem0         0      1.0 TB   
@@ -823,6 +836,7 @@ NVMe PCI     Model FW Revision Socket Capacity Role(s)       Rank
 host[2,4]
 ---------
 HugePage Size: 2048 KB
+
 SCM Namespace Socket Capacity 
 ------------- ------ -------- 
 pmem0         0      1.0 TB   
@@ -1058,6 +1072,41 @@ Format Summary:
   Hosts SCM Devices NVMe Devices 
   ----- ----------- ------------ 
   host1 2           2            
+`,
+		},
+		"1 SCM, NVMe skipped": {
+			resp: &control.StorageFormatResp{
+				HostErrorsResp: control.HostErrorsResp{
+					HostErrors: make(control.HostErrorsMap),
+				},
+				HostStorage: func() control.HostStorageMap {
+					hsm := make(control.HostStorageMap)
+					hs := &control.HostStorage{
+						ScmMountPoints: []*storage.ScmMountPoint{
+							{
+								Info: "success",
+								Path: "/mnt/0",
+							},
+						},
+						NvmeDevices: []*storage.NvmeController{
+							{
+								Info:    "skipping",
+								PciAddr: storage.NilBdevAddress,
+							},
+						},
+					}
+					if err := hsm.Add("host1", hs); err != nil {
+						t.Fatal(err)
+					}
+					return hsm
+				}(),
+			},
+			expPrintStr: `
+
+Format Summary:
+  Hosts SCM Devices NVMe Devices 
+  ----- ----------- ------------ 
+  host1 1           0            
 `,
 		},
 		"2 Hosts, 2 SCM, 2 NVMe; first SCM fails": {
@@ -1278,6 +1327,46 @@ NVMe PCI Format Result Role(s)
 1        CTL_SUCCESS   data,meta,wal 
 2        CTL_SUCCESS   data,meta,wal 
 
+`,
+		},
+		"1 SCM, NVMe skipped": {
+			resp: &control.StorageFormatResp{
+				HostErrorsResp: control.HostErrorsResp{
+					HostErrors: make(control.HostErrorsMap),
+				},
+				HostStorage: func() control.HostStorageMap {
+					hsm := make(control.HostStorageMap)
+					hs := &control.HostStorage{
+						ScmMountPoints: []*storage.ScmMountPoint{
+							{
+								Info: "CTL_SUCCESS",
+								Path: "/mnt/0",
+							},
+						},
+						NvmeDevices: []*storage.NvmeController{
+							{
+								Info:    "skipping",
+								PciAddr: storage.NilBdevAddress,
+							},
+						},
+					}
+					if err := hsm.Add("host1", hs); err != nil {
+						t.Fatal(err)
+					}
+					return hsm
+				}(),
+			},
+			expPrintStr: `
+
+-----
+host1
+-----
+SCM Mount Format Result 
+--------- ------------- 
+/mnt/0    CTL_SUCCESS   
+
+  No NVMe devices were formatted
+
 `,
 		},
 	} {