Added command to check your local installs. #121
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,192 @@ | ||
| package cmd | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "os" | ||
| "os/exec" | ||
| "regexp" | ||
| "strings" | ||
| "text/tabwriter" | ||
|
|
||
| "github.com/coreos/go-semver/semver" | ||
| "github.com/spf13/cobra" | ||
| ) | ||
|
|
||
| func init() { | ||
| rootCmd.AddCommand(checkCmd) | ||
| } | ||
|
|
||
| type requirement struct { | ||
| name string | ||
| command string | ||
| args []string | ||
| minVersion string | ||
| regexStr string | ||
| docsURL string | ||
| } | ||
|
|
||
| type versionError struct { | ||
| errorText string | ||
| } | ||
|
|
||
| type commandError struct { | ||
| Command string | ||
| ErrorText string | ||
| Suggestion string | ||
| } | ||
|
|
||
| func (e *versionError) Error() string { | ||
| return fmt.Sprintf("%s", e.errorText) | ||
| } | ||
|
|
||
| func (e *commandError) Error() string { | ||
| return fmt.Sprintf("%s", e.ErrorText) | ||
| } | ||
|
|
||
| func printErrors(errors []commandError) { | ||
| // initialize tabwriter | ||
| w := new(tabwriter.Writer) | ||
|
|
||
| // minwidth, tabwidth, padding, padchar, flags | ||
| w.Init(os.Stdout, 10, 12, 2, ' ', 0) | ||
|
|
||
| defer w.Flush() | ||
|
|
||
| fmt.Fprintf(w, "\n %s\t%s\t%s\t", "Command", "Error", "Info") | ||
| fmt.Fprintf(w, "\n %s\t%s\t%s\t", "---------", "---------", "---------") | ||
|
|
||
| for _, e := range errors { | ||
| fmt.Fprintf(w, "\n%s\t%s\t%s\t", e.Command, e.ErrorText, e.Suggestion) | ||
| } | ||
| } | ||
|
|
||
| // getSemver uses the regular expression from the requirement to parse the | ||
| // output of a command and extract the version from it. Returns the version | ||
| // or an error if the version string could not be parsed. | ||
| func getSemver(req requirement, out []byte) (*semver.Version, error) { | ||
| re := regexp.MustCompile(req.regexStr) | ||
| v := re.FindStringSubmatch(string(out)) | ||
| if len(v) < 4 { | ||
| return nil, &commandError{ | ||
| req.command, | ||
| "Could not find version number in output", | ||
| fmt.Sprintf("Try running %s %s locally and checking it works.", req.command, strings.Join(req.args, " ")), | ||
| } | ||
| } | ||
| versionString := fmt.Sprintf("%s.%s.%s", v[1], v[2], v[3]) | ||
| version, err := semver.NewVersion(versionString) | ||
| if err != nil { | ||
| return version, err | ||
| } | ||
| return version, nil | ||
| } | ||
|
|
||
| // checkSemver validates that the version of a tool meets the minimum required | ||
| // version listed in your requirement. Returns a boolean. | ||
| // For more information on parsing semver, see semver.org | ||
| // If your tool doesn't do full semver then you may need to add custom logic | ||
| // to support it. | ||
| func checkSemver(req requirement, actualVersion *semver.Version) bool { | ||
| requiredVersion := semver.New(req.minVersion) | ||
| return actualVersion.LessThan(*requiredVersion) | ||
| } | ||
|
|
||
| var checkCmd = &cobra.Command{ | ||
| Use: "check", | ||
| Short: "Print the check number of commit0", | ||
| Run: func(cmd *cobra.Command, args []string) { | ||
| // Add any new requirements to this slice. | ||
| required := []requirement{ | ||
| { | ||
| name: "AWS CLI\t\t", | ||
| command: "aws", | ||
| args: []string{"--version"}, | ||
| regexStr: `aws-cli\/(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)`, | ||
| minVersion: "1.16.0", | ||
| docsURL: "https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-install.html", | ||
| }, | ||
| { | ||
| name: "Kubectl\t\t", | ||
| command: "kubectl", | ||
| args: []string{"version", "--client=true", "--short"}, | ||
| regexStr: `Client Version: v(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)`, | ||
| minVersion: "1.15.2", | ||
| docsURL: "https://kubernetes.io/docs/tasks/tools/install-kubectl/", | ||
| }, | ||
| { | ||
| name: "Terraform\t", | ||
| command: "terraform", | ||
| args: []string{"version"}, | ||
| regexStr: `Terraform v(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)`, | ||
| minVersion: "0.12.0", | ||
| docsURL: "https://www.terraform.io/downloads.html", | ||
| }, | ||
| { | ||
| name: "jq\t\t", | ||
| command: "jq", | ||
| args: []string{"--version"}, | ||
| regexStr: `jq-(0|[1-9]\d*)\.(0|[1-9]\d*)-(0|[1-9]\d*)`, | ||
| minVersion: "1.5.0", | ||
| docsURL: "https://stedolan.github.io/jq/download/", | ||
| }, | ||
| { | ||
| name: "Git\t\t", | ||
| command: "git", | ||
| args: []string{"version"}, | ||
| regexStr: `^git version (0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)`, | ||
| minVersion: "2.17.1", | ||
| docsURL: "https://git-scm.com/book/en/v2/Getting-Started-Installing-Git", | ||
| }, | ||
| } | ||
|
|
||
| // Store and errors from the commands we run. | ||
| errors := []commandError{} | ||
|
|
||
| fmt.Println("Checking Zero Requirements...") | ||
| for _, r := range required { | ||
| fmt.Printf("%s", r.name) | ||
| // In future we could parse the stderr and stdout separately, but for now it's nice to see | ||
| // the full output on a failure. | ||
| out, err := exec.Command(r.command, r.args...).CombinedOutput() | ||
| if err != nil { | ||
| cerr := commandError{ | ||
| fmt.Sprintf("%s %s", r.command, strings.Join(r.args, " ")), | ||
| err.Error(), | ||
| r.docsURL, | ||
| } | ||
| errors = append(errors, cerr) | ||
| fmt.Printf("\033[0;31mFAIL\033[0m\t\t%s\n", "-") | ||
| continue | ||
| } | ||
| version, err := getSemver(r, out) | ||
| if err != nil { | ||
| cerr := commandError{ | ||
| r.command, | ||
| err.Error(), | ||
| r.docsURL, | ||
| } | ||
| errors = append(errors, cerr) | ||
| fmt.Printf("\033[0;31mFAIL\033[0m\t\t%s\n", version) | ||
| continue | ||
| } | ||
| if checkSemver(r, version) { | ||
| cerr := commandError{ | ||
| r.command, | ||
| fmt.Sprintf("Version does not meet required. Want: %s; Got: %s", r.minVersion, version), | ||
| r.docsURL, | ||
| } | ||
| errors = append(errors, cerr) | ||
| fmt.Printf("\033[0;31mFAIL\033[0m\t\t%s\n", version) | ||
| } else { | ||
| fmt.Printf("\033[0;32mPASS\033[0m\t\t%s\n", version) | ||
| } | ||
| } | ||
|
|
||
| if len(errors) > 0 { | ||
| printErrors(errors) | ||
| os.Exit(1) | ||
| } | ||
|
|
||
| fmt.Println() | ||
| }, | ||
|
Contributor
There was a problem hiding this comment. Should return zero exit code if the check succeeded, non-zero if it failed. |
||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we make a differentiation here between "the command doesn't exist" and "executing this command returned a non-zero exit code"?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, I'll investigate this some more. I was able to infer based on the output of the command if it's missing or not as the error is consistent. We would need to check cross-platform to make sure it returns a similar error. There may also be another way to run commands that is more verbose.
E.g.