network-status: Add human friendly network status

cmd/network/status.go

@@ -3,40 +3,100 @@ package network
 import (
 	"context"
 	"fmt"
+	"strings"
+	"time"
 
 	"github.com/spf13/cobra"
+	flag "github.com/spf13/pflag"
 
 	"github.com/oasisprotocol/oasis-sdk/client-sdk/go/connection"
 
 	"github.com/oasisprotocol/cli/cmd/common"
 	cliConfig "github.com/oasisprotocol/cli/config"
 )
 
-var statusCmd = &cobra.Command{
-	Use:   "status",
-	Short: "Show the current status of the node and the network",
-	Args:  cobra.NoArgs,
-	Run: func(cmd *cobra.Command, args []string) {
-		cfg := cliConfig.Global()
-		npa := common.GetNPASelection(cfg)
+var (
+	showJson bool
 
-		// Establish connection with the target network.
-		ctx := context.Background()
-		conn, err := connection.Connect(ctx, npa.Network)
-		cobra.CheckErr(err)
+	statusCmd = &cobra.Command{
+		Use:   "status",
+		Short: "Show the current status of the node and the network",
+		Args:  cobra.NoArgs,
+		Run: func(cmd *cobra.Command, args []string) {
+			cfg := cliConfig.Global()
+			npa := common.GetNPASelection(cfg)
 
-		ctrlConn := conn.Control()
+			// Establish connection with the target network.
+			ctx := context.Background()
+			conn, err := connection.Connect(ctx, npa.Network)
+			cobra.CheckErr(err)
 
-		nodeStatus, err := ctrlConn.GetStatus(ctx)
-		cobra.CheckErr(err)
+			ctrlConn := conn.Control()
 
-		nodeStr, err := common.PrettyJSONMarshal(nodeStatus)
-		cobra.CheckErr(err)
+			nodeStatus, err := ctrlConn.GetStatus(ctx)
+			cobra.CheckErr(err)
 
-		fmt.Println(string(nodeStr))
-	},
-}
+			if showJson {
+				nodeStr, err := common.PrettyJSONMarshal(nodeStatus)
+				cobra.CheckErr(err)
+
+				fmt.Println(string(nodeStr))
+			} else {
+				fmt.Println("=== NETWORK STATUS ===")
+				fmt.Printf("Network:             %s", npa.PrettyPrintNetwork())
+				fmt.Println()
+
+				fmt.Printf("Core Version:        %s", nodeStatus.SoftwareVersion)
+				fmt.Println()
+
+				fmt.Printf("Consensus:")
+				fmt.Println()
+
+				fmt.Printf("  Status:            %s", nodeStatus.Consensus.Status.String())
+				fmt.Println()
+
+				fmt.Printf("  Consensus Version: %s", nodeStatus.Consensus.Version.String())
+				fmt.Println()
+
+				fmt.Printf("  Latest Height:     %d", nodeStatus.Consensus.LatestHeight)
+				fmt.Println()
+
+				fmt.Printf("  Latest Epoch:      %d", nodeStatus.Consensus.LatestEpoch)
+				fmt.Println()
+
+				for _, runtime := range nodeStatus.Runtimes {
+					fmt.Printf("%s: %s", strings.Title(runtime.Descriptor.Kind.String()), runtime.Descriptor.ID)
+					fmt.Println()
+
+					fmt.Printf("  Status:            %s", runtime.Committee.Status)
+					fmt.Println()
+
+					fmt.Printf("  Active version:    %s", runtime.Committee.ActiveVersion)
+					fmt.Println()
+
+					for i, deployment := range runtime.Descriptor.Deployments {
+						fmt.Printf("  Deployment-%d:      %s", i, deployment.Version)
+						fmt.Println()
+					}
+
+					fmt.Printf("  Latest round:      %d", runtime.LatestRound)
+					fmt.Println()
+
+					date := time.Unix(int64(runtime.LatestTime), 0)
+					fmt.Printf("  Latest time:       %s", date)
+					fmt.Println()
+
+					fmt.Printf("  Number of peers:   %d", len(runtime.Committee.Peers))
+					fmt.Println()
+				}
+			}
+		},
+	}
+)
 
 func init() {
+	showJsonFlag := flag.NewFlagSet("", flag.ContinueOnError)
+	showJsonFlag.BoolVar(&showJson, "json", false, "show network status in json")
+	statusCmd.Flags().AddFlagSet(showJsonFlag)
 	statusCmd.Flags().AddFlagSet(common.SelectorNFlags)
 }

docs/network.md

@@ -380,6 +380,12 @@ Mainnet was reported:
 
 ![code json](../examples/network/status.out.static)
 
+You can also view output in json format by passing the `--json` parameter:
+
+![code shell](../examples/network/status-json.in.static)
+
+![code](../examples/network/status-json.out.static)
+
 :::info
 
 [Network](./account.md#npa) selector is available for the

examples/network/status-json.in.static

@@ -0,0 +1 @@
+oasis network status --json