DAOS-10028 control: Move core types into daos package

src/control/cmd/daos/pool.go

@@ -21,6 +21,7 @@ import (
 	"github.com/daos-stack/daos/src/control/common/proto/convert"
 	mgmtpb "github.com/daos-stack/daos/src/control/common/proto/mgmt"
 	"github.com/daos-stack/daos/src/control/lib/control"
+	"github.com/daos-stack/daos/src/control/lib/daos"
 	"github.com/daos-stack/daos/src/control/lib/ranklist"
 	"github.com/daos-stack/daos/src/control/lib/ui"
 )
@@ -370,7 +371,7 @@ func convertPoolTargetInfo(ptinfo *C.daos_target_info_t) (*control.PoolQueryTarg
 	pqti := new(control.PoolQueryTargetInfo)
 	pqti.Type = control.PoolQueryTargetType(ptinfo.ta_type)
 	pqti.State = control.PoolQueryTargetState(ptinfo.ta_state)
-	pqti.Space = []*control.StorageTargetUsage{
+	pqti.Space = []*daos.StorageTargetUsage{
 		{
 			Total:     uint64(ptinfo.ta_space.s_total[C.DAOS_MEDIA_SCM]),
 			Free:      uint64(ptinfo.ta_space.s_free[C.DAOS_MEDIA_SCM]),

src/control/cmd/daos/pretty/pool.go

@@ -0,0 +1,76 @@
+//
+// (C) Copyright 2020-2023 Intel Corporation.
+//
+// SPDX-License-Identifier: BSD-2-Clause-Patent
+//
+
+package pretty
+
+import (
+	"fmt"
+	"io"
+
+	"github.com/dustin/go-humanize"
+	"github.com/pkg/errors"
+
+	"github.com/daos-stack/daos/src/control/lib/daos"
+	"github.com/daos-stack/daos/src/control/lib/txtfmt"
+)
+
+const msgNoPools = "No pools in system"
+
+func getTierNameText(tierIdx int) string {
+	switch tierIdx {
+	case int(daos.StorageMediaTypeScm):
+		return fmt.Sprintf("- Storage tier %d (SCM):", tierIdx)
+	case int(daos.StorageMediaTypeNvme):
+		return fmt.Sprintf("- Storage tier %d (NVMe):", tierIdx)
+	default:
+		return fmt.Sprintf("- Storage tier %d (unknown):", tierIdx)
+	}
+}
+
+// PrintPoolInfo generates a human-readable representation of the supplied
+// PoolQueryResp struct and writes it to the supplied io.Writer.
+func PrintPoolInfo(pi *daos.PoolInfo, out io.Writer) error {
+	if pi == nil {
+		return errors.Errorf("nil %T", pi)
+	}
+	w := txtfmt.NewErrWriter(out)
+
+	// Maintain output compatibility with the `daos pool query` output.
+	fmt.Fprintf(w, "Pool %s, ntarget=%d, disabled=%d, leader=%d, version=%d, state=%s\n",
+		pi.UUID, pi.TotalTargets, pi.DisabledTargets, pi.Leader, pi.Version, pi.State)
+
+	if pi.PoolLayoutVer != pi.UpgradeLayoutVer {
+		fmt.Fprintf(w, "Pool layout out of date (%d < %d) -- see `dmg pool upgrade` for details.\n",
+			pi.PoolLayoutVer, pi.UpgradeLayoutVer)
+	}
+	fmt.Fprintln(w, "Pool space info:")
+	if pi.EnabledRanks != nil {
+		fmt.Fprintf(w, "- Enabled ranks: %s\n", pi.EnabledRanks)
+	}
+	if pi.DisabledRanks != nil {
+		fmt.Fprintf(w, "- Disabled ranks: %s\n", pi.DisabledRanks)
+	}
+	fmt.Fprintf(w, "- Target(VOS) count:%d\n", pi.ActiveTargets)
+	if pi.TierStats != nil {
+		for tierIdx, tierStats := range pi.TierStats {
+			fmt.Fprintln(w, getTierNameText(tierIdx))
+			fmt.Fprintf(w, "  Total size: %s\n", humanize.Bytes(tierStats.Total))
+			fmt.Fprintf(w, "  Free: %s, min:%s, max:%s, mean:%s\n",
+				humanize.Bytes(tierStats.Free), humanize.Bytes(tierStats.Min),
+				humanize.Bytes(tierStats.Max), humanize.Bytes(tierStats.Mean))
+		}
+	}
+	if pi.Rebuild != nil {
+		if pi.Rebuild.Status == 0 {
+			fmt.Fprintf(w, "Rebuild %s, %d objs, %d recs\n",
+				pi.Rebuild.State, pi.Rebuild.Objects, pi.Rebuild.Records)
+		} else {
+			fmt.Fprintf(w, "Rebuild failed, status=%d\n", pi.Rebuild.Status)
+		}
+	}
+
+	return w.Err
+}

src/control/cmd/daos/pretty/pool_test.go

@@ -0,0 +1,261 @@
+//
+// (C) Copyright 2020-2024 Intel Corporation.
+//
+// SPDX-License-Identifier: BSD-2-Clause-Patent
+//
+
+package pretty
+
+import (
+	"fmt"
+	"strings"
+	"testing"
+
+	"github.com/google/go-cmp/cmp"
+	"github.com/google/uuid"
+
+	"github.com/daos-stack/daos/src/control/common/test"
+	"github.com/daos-stack/daos/src/control/lib/daos"
+	"github.com/daos-stack/daos/src/control/lib/ranklist"
+)
+
+func TestPretty_PrintPoolInfo(t *testing.T) {
+	poolUUID := test.MockPoolUUID()
+	backtickStr := "`" + "dmg pool upgrade" + "`"
+	for name, tc := range map[string]struct {
+		pi          *daos.PoolInfo
+		expPrintStr string
+	}{
+		"empty response": {
+			pi: &daos.PoolInfo{},
+			expPrintStr: fmt.Sprintf(`
+Pool %s, ntarget=0, disabled=0, leader=0, version=0, state=Creating
+Pool space info:
+- Target(VOS) count:0
+`, uuid.Nil.String()),
+		},
+		"normal response": {
+			pi: &daos.PoolInfo{
+				State:            daos.PoolServiceStateDegraded,
+				UUID:             poolUUID,
+				TotalTargets:     2,
+				DisabledTargets:  1,
+				ActiveTargets:    1,
+				Leader:           42,
+				Version:          100,
+				PoolLayoutVer:    1,
+				UpgradeLayoutVer: 2,
+				Rebuild: &daos.PoolRebuildStatus{
+					State:   daos.PoolRebuildStateBusy,
+					Objects: 42,
+					Records: 21,
+				},
+				TierStats: []*daos.StorageUsageStats{
+					{
+						Total: 2,
+						Free:  1,
+					},
+					{
+						Total: 2,
+						Free:  1,
+					},
+				},
+			},
+			expPrintStr: fmt.Sprintf(`
+Pool %s, ntarget=2, disabled=1, leader=42, version=100, state=Degraded
+Pool layout out of date (1 < 2) -- see `+backtickStr+` for details.
+Pool space info:
+- Target(VOS) count:1
+- Storage tier 0 (SCM):
+  Total size: 2 B
+  Free: 1 B, min:0 B, max:0 B, mean:0 B
+- Storage tier 1 (NVMe):
+  Total size: 2 B
+  Free: 1 B, min:0 B, max:0 B, mean:0 B
+Rebuild busy, 42 objs, 21 recs
+`, poolUUID.String()),
+		},
+		"normal response; enabled ranks": {
+			pi: &daos.PoolInfo{
+				State:            daos.PoolServiceStateDegraded,
+				UUID:             poolUUID,
+				TotalTargets:     2,
+				DisabledTargets:  1,
+				ActiveTargets:    1,
+				Leader:           42,
+				Version:          100,
+				PoolLayoutVer:    1,
+				UpgradeLayoutVer: 2,
+				EnabledRanks:     ranklist.MustCreateRankSet("[0,1,2]"),
+				Rebuild: &daos.PoolRebuildStatus{
+					State:   daos.PoolRebuildStateBusy,
+					Objects: 42,
+					Records: 21,
+				},
+				TierStats: []*daos.StorageUsageStats{
+					{
+						Total: 2,
+						Free:  1,
+					},
+					{
+						Total: 2,
+						Free:  1,
+					},
+				},
+			},
+			expPrintStr: fmt.Sprintf(`
+Pool %s, ntarget=2, disabled=1, leader=42, version=100, state=Degraded
+Pool layout out of date (1 < 2) -- see `+backtickStr+` for details.
+Pool space info:
+- Enabled ranks: 0-2
+- Target(VOS) count:1
+- Storage tier 0 (SCM):
+  Total size: 2 B
+  Free: 1 B, min:0 B, max:0 B, mean:0 B
+- Storage tier 1 (NVMe):
+  Total size: 2 B
+  Free: 1 B, min:0 B, max:0 B, mean:0 B
+Rebuild busy, 42 objs, 21 recs
+`, poolUUID.String()),
+		},
+		"normal response; disabled ranks": {
+			pi: &daos.PoolInfo{
+				State:            daos.PoolServiceStateDegraded,
+				UUID:             poolUUID,
+				TotalTargets:     2,
+				DisabledTargets:  1,
+				ActiveTargets:    1,
+				Leader:           42,
+				Version:          100,
+				PoolLayoutVer:    1,
+				UpgradeLayoutVer: 2,
+				DisabledRanks:    ranklist.MustCreateRankSet("[0,1,3]"),
+				Rebuild: &daos.PoolRebuildStatus{
+					State:   daos.PoolRebuildStateBusy,
+					Objects: 42,
+					Records: 21,
+				},
+				TierStats: []*daos.StorageUsageStats{
+					{
+						Total: 2,
+						Free:  1,
+					},
+					{
+						Total: 2,
+						Free:  1,
+					},
+				},
+			},
+			expPrintStr: fmt.Sprintf(`
+Pool %s, ntarget=2, disabled=1, leader=42, version=100, state=Degraded
+Pool layout out of date (1 < 2) -- see `+backtickStr+` for details.
+Pool space info:
+- Disabled ranks: 0-1,3
+- Target(VOS) count:1
+- Storage tier 0 (SCM):
+  Total size: 2 B
+  Free: 1 B, min:0 B, max:0 B, mean:0 B
+- Storage tier 1 (NVMe):
+  Total size: 2 B
+  Free: 1 B, min:0 B, max:0 B, mean:0 B
+Rebuild busy, 42 objs, 21 recs
+`, poolUUID.String()),
+		},
+		"unknown/invalid rebuild state response": {
+			pi: &daos.PoolInfo{
+				State:            daos.PoolServiceStateDegraded,
+				UUID:             poolUUID,
+				TotalTargets:     2,
+				DisabledTargets:  1,
+				ActiveTargets:    1,
+				Leader:           42,
+				Version:          100,
+				PoolLayoutVer:    1,
+				UpgradeLayoutVer: 2,
+				DisabledRanks:    ranklist.MustCreateRankSet("[0,1,3]"),
+				Rebuild: &daos.PoolRebuildStatus{
+					State:   42,
+					Objects: 42,
+					Records: 21,
+				},
+				TierStats: []*daos.StorageUsageStats{
+					{
+						Total: 2,
+						Free:  1,
+					},
+					{
+						Total: 2,
+						Free:  1,
+					},
+				},
+			},
+			expPrintStr: fmt.Sprintf(`
+Pool %s, ntarget=2, disabled=1, leader=42, version=100, state=Degraded
+Pool layout out of date (1 < 2) -- see `+backtickStr+` for details.
+Pool space info:
+- Disabled ranks: 0-1,3
+- Target(VOS) count:1
+- Storage tier 0 (SCM):
+  Total size: 2 B
+  Free: 1 B, min:0 B, max:0 B, mean:0 B
+- Storage tier 1 (NVMe):
+  Total size: 2 B
+  Free: 1 B, min:0 B, max:0 B, mean:0 B
+Rebuild unknown, 42 objs, 21 recs
+`, poolUUID.String()),
+		},
+		"rebuild failed": {
+			pi: &daos.PoolInfo{
+				State:            daos.PoolServiceStateDegraded,
+				UUID:             poolUUID,
+				TotalTargets:     2,
+				DisabledTargets:  1,
+				ActiveTargets:    1,
+				Leader:           42,
+				Version:          100,
+				PoolLayoutVer:    1,
+				UpgradeLayoutVer: 2,
+				Rebuild: &daos.PoolRebuildStatus{
+					Status:  2,
+					State:   daos.PoolRebuildStateBusy,
+					Objects: 42,
+					Records: 21,
+				},
+				TierStats: []*daos.StorageUsageStats{
+					{
+						Total: 2,
+						Free:  1,
+					},
+					{
+						Total: 2,
+						Free:  1,
+					},
+				},
+			},
+			expPrintStr: fmt.Sprintf(`
+Pool %s, ntarget=2, disabled=1, leader=42, version=100, state=Degraded
+Pool layout out of date (1 < 2) -- see `+backtickStr+` for details.
+Pool space info:
+- Target(VOS) count:1
+- Storage tier 0 (SCM):
+  Total size: 2 B
+  Free: 1 B, min:0 B, max:0 B, mean:0 B
+- Storage tier 1 (NVMe):
+  Total size: 2 B
+  Free: 1 B, min:0 B, max:0 B, mean:0 B
+Rebuild failed, status=2
+`, poolUUID.String()),
+		},
+	} {
+		t.Run(name, func(t *testing.T) {
+			var bld strings.Builder
+			if err := PrintPoolInfo(tc.pi, &bld); err != nil {
+				t.Fatal(err)
+			}
+
+			if diff := cmp.Diff(strings.TrimLeft(tc.expPrintStr, "\n"), bld.String()); diff != "" {
+				t.Fatalf("unexpected format string (-want, +got):\n%s\n", diff)
+			}
+		})
+	}
+}