alihan/faas-cli
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

fix: add section header for usage data in describe output

Browse Source 
Add the header `Usage:` for the usage data to help it fit with the other
fields better

Signed-off-by: Lucas Roesler <roesler.lucas@gmail.com>
This commit is contained in:
Lucas Roesler
2022-03-17 10:43:02 +01:00
committed by Alex Ellis
parent f3f2eadcf6
commit 17baca4d8f
2 changed files with 61 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
commands/describe.go
View File

@@ -201,17 +201,17 @@ func printUsage(w io.Writer, usage *types.FunctionUsage, verbose bool) {
}
if usage == nil {
fmt.Fprintln(w, "No usage information available")
fmt.Fprintln(w, "Usage:\t <none>")
return
}
fmt.Fprintln(w)
fmt.Fprintf(w, "RAM:\t %.2f MB\n", (usage.TotalMemoryBytes / 1024 / 1024))
fmt.Fprintln(w, "Usage:")
fmt.Fprintf(w, " RAM:\t %.2f MB\n", (usage.TotalMemoryBytes / 1024 / 1024))
cpu := usage.CPU
if cpu < 0 {
cpu = 1
}
fmt.Fprintf(w, "CPU:\t %.0f Mi\n", (cpu))
fmt.Fprintf(w, " CPU:\t %.0f Mi\n", (cpu))
}
func printMap(w io.Writer, name string, m map[string]string, verbose bool) {
@@ -219,13 +219,12 @@ func printMap(w io.Writer, name string, m map[string]string, verbose bool) {
return
}
fmt.Fprintf(w, name+":")
if len(m) == 0 {
fmt.Fprintln(w, "\t <none>")
fmt.Fprintf(w, "%s:\t <none>\n", name)
return
}
fmt.Fprintf(w, "%s:\n", name)
for key, value := range m {
fmt.Fprintln(w, "\t "+key+": "+value)
}
@@ -238,13 +237,12 @@ func printList(w io.Writer, name string, data []string, verbose bool) {
return
}
fmt.Fprintf(w, name+":")
if len(data) == 0 {
fmt.Fprintln(w, "\t <none>")
fmt.Fprintf(w, "%s:\t <none>\n", name)
return
}
fmt.Fprintf(w, "%s:\n", name)
for _, value := range data {
fmt.Fprintln(w, "\t - "+value)
}

56
commands/describe_test.go
View File

@@ -43,7 +43,7 @@ func TestDescribeOuput(t *testing.T) {
expectedOutput string
}{
{
name: "minimal output, non-verbose",
name: "non-verbose minimal output",
function: schema.FunctionDescription{
FunctionStatus: types.FunctionStatus{
Name: "figlet",
@@ -57,7 +57,7 @@ func TestDescribeOuput(t *testing.T) {
expectedOutput: "Name:\tfiglet\nStatus:\tReady\nReplicas:\t0\nAvailable Replicas: 0\nInvocations:\t0\nImage:\topenfaas/figlet:latest\nFunction Process:\t<default>\n",
},
{
name: "minimal output, verbose",
name: "verbose minimal output",
function: schema.FunctionDescription{
FunctionStatus: types.FunctionStatus{
Name: "figlet",
@@ -68,7 +68,57 @@ func TestDescribeOuput(t *testing.T) {
Status: "Ready",
},
verbose: true,
expectedOutput: "Name:\tfiglet\nStatus:\tReady\nReplicas:\t0\nAvailable Replicas: 0\nInvocations:\t0\nImage:\topenfaas/figlet:latest\nFunction Process:\t<default>\nURL:\t<none>\nAsync URL:\t<none>\nLabels:\t<none>\nAnnotations:\t<none>\nConstraints:\t<none>\nEnvironment:\t<none>\nSecrets:\t<none>\nRequests:\t<none>\nLimits:\t<none>\nNo usage information available\n",
expectedOutput: "Name:\tfiglet\nStatus:\tReady\nReplicas:\t0\nAvailable Replicas: 0\nInvocations:\t0\nImage:\topenfaas/figlet:latest\nFunction Process:\t<default>\nURL:\t<none>\nAsync URL:\t<none>\nLabels:\t<none>\nAnnotations:\t<none>\nConstraints:\t<none>\nEnvironment:\t<none>\nSecrets:\t<none>\nRequests:\t<none>\nLimits:\t<none>\nUsage:\t<none>\n",
},
{
name: "non-verbose formats output with non-empty labels, env variables, and secrets",
function: schema.FunctionDescription{
FunctionStatus: types.FunctionStatus{
Name: "figlet",
Image: "openfaas/figlet:latest",
Labels: &map[string]string{"quadrant": "alpha"},
Annotations: &map[string]string{},
EnvVars: map[string]string{"FOO": "bar"},
Secrets: []string{"db-password"},
},
Status: "Ready",
},
verbose: false,
expectedOutput: "Name:\tfiglet\nStatus:\tReady\nReplicas:\t0\nAvailable Replicas: 0\nInvocations:\t0\nImage:\topenfaas/figlet:latest\nFunction Process:\t<default>\nLabels:\n quadrant: alpha\nEnvironment:\n FOO: bar\nSecrets:\n - db-password\n",
},
{
name: "verbose formats output with non-empty labels, env variables, and secrets",
function: schema.FunctionDescription{
FunctionStatus: types.FunctionStatus{
Name: "figlet",
Image: "openfaas/figlet:latest",
Labels: &map[string]string{"quadrant": "alpha"},
Annotations: &map[string]string{},
EnvVars: map[string]string{"FOO": "bar"},
Secrets: []string{"db-password"},
},
Status: "Ready",
},
verbose: true,
expectedOutput: "Name:\tfiglet\nStatus:\tReady\nReplicas:\t0\nAvailable Replicas: 0\nInvocations:\t0\nImage:\topenfaas/figlet:latest\nFunction Process:\t<default>\nURL:\t<none>\nAsync URL:\t<none>\nLabels:\n quadrant: alpha\nAnnotations:\t<none>\nConstraints:\t<none>\nEnvironment:\n FOO: bar\nSecrets:\n - db-password\nRequests:\t<none>\nLimits:\t<none>\nUsage:\t<none>\n",
},
{
name: "formats non-empty usage",
function: schema.FunctionDescription{
FunctionStatus: types.FunctionStatus{
Name: "figlet",
Image: "openfaas/figlet:latest",
Labels: &map[string]string{},
Annotations: &map[string]string{},
Usage: &types.FunctionUsage{
TotalMemoryBytes: 1024 * 1024 * 1024,
CPU: 1.5,
},
},
Status: "Ready",
},
verbose: false,
expectedOutput: "Name:\tfiglet\nStatus:\tReady\nReplicas:\t0\nAvailable Replicas: 0\nInvocations:\t0\nImage:\topenfaas/figlet:latest\nFunction Process:\t<default>\nUsage:\n\tRAM:\t1024.00 MB\n\tCPU:\t2 Mi\n",
},
}
for _, tc := range cases {