github/kubernetes
1
0
Fork 0
mirror of https://github.com/k3s-io/kubernetes.git synced 2025-08-12 05:21:58 +00:00
Code Issues Projects Releases Wiki Activity

Fix for man pages do not build reproducibly

Browse Source 
In different distros or environments, we may end up with a different
order of the strings printed during help and man page generation,
So we should sort so the strings in the man pages is the same everytime.

Change-Id: Id8fcbd89336aad8d709ba3adac4b29c808d97ebe
This commit is contained in:
Davanum Srinivas 2018-09-22 21:29:01 -04:00
parent 7ef6f0b625
commit f777715262
No known key found for this signature in database
GPG Key ID: 80D83A796103BF59
4 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
staging/src/k8s.io/cli-runtime/pkg/genericclioptions/jsonpath_flags.go
View File

@ -19,6 +19,7 @@ package genericclioptions
import ( import (
"fmt" "fmt"
"io/ioutil" "io/ioutil"
"sort"
"strings" "strings"
"github.com/spf13/cobra" "github.com/spf13/cobra"
@ -49,6 +50,7 @@ func (f *JSONPathPrintFlags) AllowedFormats() []string {
for format := range jsonFormats { for format := range jsonFormats {
formats = append(formats, format) formats = append(formats, format)
} }
sort.Strings(formats)
return formats return formats
} }

7
staging/src/k8s.io/cli-runtime/pkg/genericclioptions/jsonpath_flags_test.go
View File

@ -21,6 +21,7 @@ import (
"fmt" "fmt"
"io/ioutil" "io/ioutil"
"os" "os"
"sort"
"strings" "strings"
"testing" "testing"
@ -101,6 +102,9 @@ func TestPrinterSupportsExpectedJSONPathFormats(t *testing.T) {
printFlags := JSONPathPrintFlags{ printFlags := JSONPathPrintFlags{
TemplateArgument: templateArg, TemplateArgument: templateArg,
} }
if !sort.StringsAreSorted(printFlags.AllowedFormats()) {
t.Fatalf("allowed formats are not sorted")
}
p, err := printFlags.ToPrinter(tc.outputFormat) p, err := printFlags.ToPrinter(tc.outputFormat)
if tc.expectNoMatch { if tc.expectNoMatch {
@ -180,6 +184,9 @@ func TestJSONPathPrinterDefaultsAllowMissingKeysToTrue(t *testing.T) {
TemplateArgument: &tc.templateArg, TemplateArgument: &tc.templateArg,
AllowMissingKeys: tc.allowMissingKeys, AllowMissingKeys: tc.allowMissingKeys,
} }
if !sort.StringsAreSorted(printFlags.AllowedFormats()) {
t.Fatalf("allowed formats are not sorted")
}
outputFormat := "jsonpath" outputFormat := "jsonpath"
p, err := printFlags.ToPrinter(outputFormat) p, err := printFlags.ToPrinter(outputFormat)

2
staging/src/k8s.io/cli-runtime/pkg/genericclioptions/template_flags.go
View File

@ -19,6 +19,7 @@ package genericclioptions
import ( import (
"fmt" "fmt"
"io/ioutil" "io/ioutil"
"sort"
"strings" "strings"
"github.com/spf13/cobra" "github.com/spf13/cobra"
@ -51,6 +52,7 @@ func (f *GoTemplatePrintFlags) AllowedFormats() []string {
for format := range templateFormats { for format := range templateFormats {
formats = append(formats, format) formats = append(formats, format)
} }
sort.Strings(formats)
return formats return formats
} }

7
staging/src/k8s.io/cli-runtime/pkg/genericclioptions/template_flags_test.go
View File

@ -21,6 +21,7 @@ import (
"fmt" "fmt"
"io/ioutil" "io/ioutil"
"os" "os"
"sort"
"strings" "strings"
"testing" "testing"
@ -101,6 +102,9 @@ func TestPrinterSupportsExpectedTemplateFormats(t *testing.T) {
printFlags := GoTemplatePrintFlags{ printFlags := GoTemplatePrintFlags{
TemplateArgument: templateArg, TemplateArgument: templateArg,
} }
if !sort.StringsAreSorted(printFlags.AllowedFormats()) {
t.Fatalf("allowed formats are not sorted")
}
p, err := printFlags.ToPrinter(tc.outputFormat) p, err := printFlags.ToPrinter(tc.outputFormat)
if tc.expectNoMatch { if tc.expectNoMatch {
@ -174,6 +178,9 @@ func TestTemplatePrinterDefaultsAllowMissingKeysToTrue(t *testing.T) {
TemplateArgument: &tc.templateArg, TemplateArgument: &tc.templateArg,
AllowMissingKeys: tc.allowMissingKeys, AllowMissingKeys: tc.allowMissingKeys,
} }
if !sort.StringsAreSorted(printFlags.AllowedFormats()) {
t.Fatalf("allowed formats are not sorted")
}
outputFormat := "template" outputFormat := "template"
p, err := printFlags.ToPrinter(outputFormat) p, err := printFlags.ToPrinter(outputFormat)