-
Notifications
You must be signed in to change notification settings - Fork 787
/
step_report_version.go
121 lines (104 loc) · 3.18 KB
/
step_report_version.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
package report
import (
"regexp"
"sort"
"github.com/jenkins-x/jx/v2/pkg/cmd/helper"
"github.com/jenkins-x/jx/v2/pkg/cmd/opts"
"github.com/jenkins-x/jx/v2/pkg/cmd/opts/step"
"github.com/jenkins-x/jx/v2/pkg/cmd/templates"
"github.com/spf13/cobra"
)
var (
stepReportVersionLong = templates.LongDesc(`Creates a report of a set of package versions. This command is typically used inside images to determine what tools are inside.`)
stepReportVersionExample = templates.Examples(`
`)
)
var (
defaultPackageVersions = []string{"jx", "kubectl", "helm", "helm3", "git", "skaffold"}
numberRegex = regexp.MustCompile("[0-9]")
)
// VersionReport the report
type VersionReport struct {
Versions []Pair `json:"versions,omitempty"`
Failures []Pair `json:"failures,omitempty"`
}
// Pair represents a name and value
type Pair struct {
Name string `json:"name,omitempty"`
Value string `json:"value,omitempty"`
}
// StepReportVersionOptions contains the command line flags and other helper objects
type StepReportVersionOptions struct {
StepReportOptions
FileName string
Packages []string
Report VersionReport
}
// NewCmdStepReportVersion Creates a new Command object
func NewCmdStepReportVersion(commonOpts *opts.CommonOptions) *cobra.Command {
options := &StepReportVersionOptions{
StepReportOptions: StepReportOptions{
StepOptions: step.StepOptions{
CommonOptions: commonOpts,
},
},
}
cmd := &cobra.Command{
Use: "version",
Short: "Creates a report of a set of package versions",
Aliases: []string{"versions"},
Long: stepReportVersionLong,
Example: stepReportVersionExample,
Run: func(cmd *cobra.Command, args []string) {
options.Cmd = cmd
options.Args = args
err := options.Run()
helper.CheckErr(err)
},
}
options.StepReportOptions.AddReportFlags(cmd)
cmd.Flags().StringVarP(&options.FileName, "name", "n", "", "The name of the file to generate")
cmd.Flags().StringArrayVarP(&options.Packages, "package", "p", defaultPackageVersions, "The name of the packages to version")
return cmd
}
// Run generates the report
func (o *StepReportVersionOptions) Run() error {
report := &o.Report
err := o.generateReport()
if err != nil {
return err
}
return o.OutputReport(report, o.FileName, o.OutputDir)
}
func (o *StepReportVersionOptions) generateReport() error {
sort.Strings(o.Packages)
for _, p := range o.Packages {
version, err := o.getPackageVersion(p)
if err != nil {
o.Report.Failures = append(o.Report.Failures, Pair{p, err.Error()})
} else {
o.Report.Versions = append(o.Report.Versions, Pair{p, version})
}
}
return nil
}
func (o *StepReportVersionOptions) getPackageVersion(name string) (string, error) {
args := []string{"version"}
switch name {
case "jx":
args = []string{"--version"}
case "kubectl":
args = append(args, "--client", "--short")
case "helm":
args = append(args, "--client", "--short")
case "helm3":
args = append(args, "--short")
}
version, err := o.GetCommandOutput("", name, args...)
// lets trim non-numeric prefixes such as for `git version` returning `git version 1.2.3`
idxs := numberRegex.FindStringIndex(version)
if len(idxs) > 0 {
return version[idxs[0]:], err
}
return version, err
}