|
| 1 | +package cli |
| 2 | + |
| 3 | +import ( |
| 4 | + "fmt" |
| 5 | + "os" |
| 6 | + |
| 7 | + "github.com/pkg/errors" |
| 8 | + "github.com/replicatedhq/troubleshoot/pkg/constants" |
| 9 | + "github.com/replicatedhq/troubleshoot/pkg/lint" |
| 10 | + "github.com/spf13/cobra" |
| 11 | + "github.com/spf13/viper" |
| 12 | +) |
| 13 | + |
| 14 | +func LintCmd() *cobra.Command { |
| 15 | + cmd := &cobra.Command{ |
| 16 | + Use: "lint [spec-files...]", |
| 17 | + Args: cobra.MinimumNArgs(1), |
| 18 | + Short: "Lint v1beta3 preflight specs for syntax and structural errors", |
| 19 | + Long: `Lint v1beta3 preflight specs for syntax and structural errors. |
| 20 | +
|
| 21 | +This command validates v1beta3 preflight specs and checks for: |
| 22 | +- YAML syntax errors |
| 23 | +- Missing required fields (apiVersion, kind, metadata, spec) |
| 24 | +- Invalid template syntax ({{ .Values.* }}) |
| 25 | +- Missing analyzers or collectors |
| 26 | +- Common structural issues |
| 27 | +- Missing docStrings (warning) |
| 28 | +
|
| 29 | +The linter only validates v1beta3 specs. For v1beta2 specs, use the 'convert' command first. |
| 30 | +
|
| 31 | +Examples: |
| 32 | + # Lint a single spec file |
| 33 | + preflight lint my-preflight.yaml |
| 34 | +
|
| 35 | + # Lint multiple spec files |
| 36 | + preflight lint spec1.yaml spec2.yaml spec3.yaml |
| 37 | +
|
| 38 | + # Lint with automatic fixes |
| 39 | + preflight lint --fix my-preflight.yaml |
| 40 | +
|
| 41 | + # Lint and output as JSON for CI/CD integration |
| 42 | + preflight lint --format json my-preflight.yaml |
| 43 | +
|
| 44 | +Exit codes: |
| 45 | + 0 - No errors found |
| 46 | + 2 - Validation errors found`, |
| 47 | + PreRun: func(cmd *cobra.Command, args []string) { |
| 48 | + viper.BindPFlags(cmd.Flags()) |
| 49 | + }, |
| 50 | + RunE: func(cmd *cobra.Command, args []string) error { |
| 51 | + v := viper.GetViper() |
| 52 | + |
| 53 | + opts := lint.LintOptions{ |
| 54 | + FilePaths: args, |
| 55 | + Fix: v.GetBool("fix"), |
| 56 | + Format: v.GetString("format"), |
| 57 | + } |
| 58 | + |
| 59 | + return runLint(opts) |
| 60 | + }, |
| 61 | + } |
| 62 | + |
| 63 | + cmd.Flags().Bool("fix", false, "Automatically fix issues where possible") |
| 64 | + cmd.Flags().String("format", "text", "Output format: text or json") |
| 65 | + |
| 66 | + return cmd |
| 67 | +} |
| 68 | + |
| 69 | +func runLint(opts lint.LintOptions) error { |
| 70 | + // Validate file paths exist |
| 71 | + for _, filePath := range opts.FilePaths { |
| 72 | + if _, err := os.Stat(filePath); err != nil { |
| 73 | + return errors.Wrapf(err, "file not found: %s", filePath) |
| 74 | + } |
| 75 | + } |
| 76 | + |
| 77 | + // Run linting |
| 78 | + results, err := lint.LintFiles(opts) |
| 79 | + if err != nil { |
| 80 | + return errors.Wrap(err, "failed to lint files") |
| 81 | + } |
| 82 | + |
| 83 | + // Format and print results |
| 84 | + output := lint.FormatResults(results, opts.Format) |
| 85 | + fmt.Print(output) |
| 86 | + |
| 87 | + // Return appropriate exit code |
| 88 | + if lint.HasErrors(results) { |
| 89 | + os.Exit(constants.EXIT_CODE_SPEC_ISSUES) |
| 90 | + } |
| 91 | + |
| 92 | + return nil |
| 93 | +} |
0 commit comments