github/kubernetes
1
0
Fork 0
mirror of https://github.com/k3s-io/kubernetes.git synced 2025-09-09 05:01:46 +00:00
Code Issues Projects Releases Wiki Activity

Merge pull request #123023 from ah8ad3/fix-kubectl-explain-show-enum

Browse Source 
Fix kubectl explain to shows enum for field types if they were defined
This commit is contained in:
Kubernetes Prow Robot
2024-02-08 19:52:59 -08:00
committed by GitHub
parent 002b0f0003 c82c80099d
commit 012f04b178
2 changed files with 156 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

56
staging/src/k8s.io/kubectl/pkg/explain/v2/templates/plaintext.tmpl
View File

@@ -110,8 +110,10 @@ Takes dictionary as argument with keys:
{{- if eq 1 (len $.FieldPath) -}}
{{- /* TODO: The original explain would say RESOURCE instead of FIELD here under some circumstances */ -}}
FIELD: {{first $.FieldPath}} <{{ template "typeGuess" (dict "schema" $subschema "Document" $.Document) }}>{{"\n"}}
{{- template "extractEnum" (dict "schema" $subschema "Document" $.Document "isLongView" true "limit" -1) -}}{{"\n"}}
{{- "\n" -}}
{{- end -}}
{{- template "output" (set $nextContext "history" (dict) "FieldPath" (slice $.FieldPath 1) "schema" $subschema ) -}}
{{- else if $resolved.items -}}
{{- /* If the schema is an array then traverse the array item fields */ -}}
@@ -203,6 +205,7 @@ Takes dictionary as argument with keys:
{{- $fieldSchema := index $.schema.properties $.name -}}
{{- $.name | indent $indentAmount -}}{{"\t"}}<{{ template "typeGuess" (dict "schema" $fieldSchema "Document" $.Document) }}>
{{- if contains $.schema.required $.name}} -required-{{- end -}}
{{- template "extractEnum" (dict "schema" $fieldSchema "Document" $.Document "isLongView" false "limit" 4 "indentAmount" $indentAmount) -}}
{{- "\n" -}}
{{- if not $.short -}}
{{- or $fieldSchema.description "<no description>" | wrap (sub 78 $indentAmount) | indent (add $indentAmount 2) -}}{{- "\n" -}}
@@ -280,4 +283,57 @@ Takes dictionary as argument with keys:
{{- else -}}
{{- fail "expected schema argument to subtemplate 'typeguess'" -}}
{{- end -}}
{{- end -}}
{{- /* Check if there is any enum returns it in this format e.g.:
ENUM: "", BlockDevice, CharDevice, Directory
enum: "", BlockDevice, CharDevice, Directory
Can change the style of enum in future by modifying this function
Takes dictionary as argument with keys:
schema: openapiv3 JSON schema
Document: openapi document
isLongView: (boolean) Simple view: long list of all fields. Long view: all details of one field
limit: (int) truncate the amount of enums that can be printed in simple view, -1 means all items
indentAmount: intent of the beginning enum line in longform view
*/ -}}
{{- define "extractEnum" -}}
{{- with $.schema -}}
{{- if .enum -}}
{{- $enumLen := len .enum -}}
{{- $limit := or $.limit -1 -}}
{{- if eq $.isLongView false -}}
{{- "\n" -}}
{{- "" | indent $.indentAmount -}}
{{- "enum: " -}}
{{- else -}}
{{- "ENUM:" -}}
{{- end -}}
{{- range $index, $element := .enum -}}
{{- /* Prints , .... and return the range when it goes over the limit */ -}}
{{- if and (gt $limit -1) (ge $index $limit) -}}
{{- ", ...." -}}
{{- break -}}
{{- end -}}
{{- /* Use to reflect "" when we see empty string */ -}}
{{- $elementType := printf "%T" $element -}}
{{- /* Print out either `, ` or `\n ` based of the view */ -}}
{{- /* Simple view */ -}}
{{- if and (gt $index 0) (eq $.isLongView false) -}}
{{- ", " -}}
{{- /* Long view */ -}}
{{- else if eq $.isLongView true -}}
{{- "\n" -}}{{- "" | indent 4 -}}
{{- end -}}
{{- /* Convert empty string to `""` for more clarification */ -}}
{{- if and (eq "string" $elementType) (eq $element "") -}}
{{- `""` -}}
{{- else -}}
{{- $element -}}
{{- end -}}
{{- end -}}
{{- end -}}
{{- end -}}
{{- end -}}

100
staging/src/k8s.io/kubectl/pkg/explain/v2/templates/plaintext_test.go
View File

@@ -648,6 +648,106 @@ func TestPlaintext(t *testing.T) {
checkEquals(" thefield\t<string> -required-\n"),
},
},
{
// show that extractEnum can skip empty enum slice
Name: "extractEmptyEnum",
Subtemplate: "extractEnum",
Context: map[string]any{
"schema": map[string]any{
"type": "string",
"description": "a description that should not be printed",
"enum": []any{},
},
},
Checks: []check{
checkEquals(""),
},
},
{
// show that extractEnum can extract any enum slice and style it uppercase
Name: "extractEnumSimpleForm",
Subtemplate: "extractEnum",
Context: map[string]any{
"schema": map[string]any{
"type": "string",
"description": "a description that should not be printed",
"enum": []any{0, 1, 2, 3},
},
"isLongView": true,
},
Checks: []check{
checkEquals("ENUM:\n 0\n 1\n 2\n 3"),
},
},
{
// show that extractEnum can extract any enum slice and style it lowercase
Name: "extractEnumLongFormWithIndent",
Subtemplate: "extractEnum",
Context: map[string]any{
"schema": map[string]any{
"type": "string",
"description": "a description that should not be printed",
"enum": []any{0, 1, 2, 3},
},
"isLongView": false,
"indentAmount": 2,
},
Checks: []check{
checkEquals("\n enum: 0, 1, 2, 3"),
},
},
{
// show that extractEnum can extract any enum slice and style it with truncated enums
Name: "extractEnumLongFormWithLimitAndIndent",
Subtemplate: "extractEnum",
Context: map[string]any{
"schema": map[string]any{
"type": "string",
"description": "a description that should not be printed",
"enum": []any{0, 1, 2, 3},
},
"isLongView": false,
"limit": 2,
"indentAmount": 2,
},
Checks: []check{
checkEquals("\n enum: 0, 1, ...."),
},
},
{
// show that extractEnum can extract any enum slice and style it with truncated enums
Name: "extractEnumSimpleFormWithLimitAndIndent",
Subtemplate: "extractEnum",
Context: map[string]any{
"schema": map[string]any{
"type": "string",
"description": "a description that should not be printed",
"enum": []any{0, 1, 2, 3},
},
"isLongView": true,
"limit": 2,
"indentAmount": 2,
},
Checks: []check{
checkEquals("ENUM:\n 0\n 1, ...."),
},
},
{
// show that extractEnum can extract any enum slice and style it with empty string
Name: "extractEnumSimpleFormEmptyString",
Subtemplate: "extractEnum",
Context: map[string]any{
"schema": map[string]any{
"type": "string",
"description": "a description that should not be printed",
"enum": []any{"Block", "File", ""},
},
"isLongView": true,
},
Checks: []check{
checkEquals("ENUM:\n Block\n File\n \"\""),
},
},
}
tmpl, err := v2.WithBuiltinTemplateFuncs(template.New("")).Parse(plaintextSource)