-
Notifications
You must be signed in to change notification settings - Fork 42
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Introduce
mindev ruletype lint command (#1796)
This is a helper command to lint minder rule type definitions. The main value it currently brings is being able to also lint rego rules.
- Loading branch information
Showing
4 changed files
with
110 additions
and
4 deletions.
There are no files selected for viewing
This file contains 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,102 @@ | ||
| // Copyright 2023 Stacklok, Inc. | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package rule_type | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
| "io" | ||
| "os" | ||
|
|
||
| "github.com/spf13/cobra" | ||
| "github.com/styrainc/regal/pkg/linter" | ||
| "github.com/styrainc/regal/pkg/rules" | ||
| "gopkg.in/yaml.v3" | ||
|
|
||
| "github.com/stacklok/minder/internal/engine/eval/rego" | ||
| minderv1 "github.com/stacklok/minder/pkg/api/protobuf/go/minder/v1" | ||
| ) | ||
|
|
||
| // CmdLint is the command for linting a rule type definition | ||
| func CmdLint() *cobra.Command { | ||
| var lintCmd = &cobra.Command{ | ||
| Use: "lint", | ||
| Short: "lint a rule type definition", | ||
| Long: `The 'rule type lint' subcommand allows you lint a rule type definition`, | ||
| RunE: lintCmdRun, | ||
| SilenceUsage: true, | ||
| } | ||
| lintCmd.Flags().StringP("rule-type", "r", "", "file to read rule type definition from") | ||
|
|
||
| if err := lintCmd.MarkFlagRequired("rule-type"); err != nil { | ||
| fmt.Fprintf(os.Stderr, "Error marking flag as required: %s\n", err) | ||
| os.Exit(1) | ||
| } | ||
|
|
||
| return lintCmd | ||
| } | ||
|
|
||
| func lintCmdRun(cmd *cobra.Command, _ []string) error { | ||
| rtpath := cmd.Flag("rule-type") | ||
|
|
||
| ctx := cmd.Context() | ||
|
|
||
| rtpathStr := rtpath.Value.String() | ||
|
|
||
| rt, err := readRuleTypeFromFile(rtpathStr) | ||
| if err != nil { | ||
| return fmt.Errorf("error reading rule type from file: %w", err) | ||
| } | ||
|
|
||
| if err := rt.Validate(); err != nil { | ||
| return fmt.Errorf("error validating rule type: %w", err) | ||
| } | ||
|
|
||
| if rt.Def.Eval.Type == rego.RegoEvalType { | ||
| if err := validateRegoRule(ctx, rt.Def.Eval.Rego, rtpathStr, cmd.OutOrStdout()); err != nil { | ||
| return fmt.Errorf("failed validating rego rule: %w", err) | ||
| } | ||
| } | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
| func validateRegoRule(ctx context.Context, r *minderv1.RuleType_Definition_Eval_Rego, path string, out io.Writer) error { | ||
| if r == nil { | ||
| return fmt.Errorf("rego rule is nil") | ||
| } | ||
|
|
||
| if r.Def == "" { | ||
| return fmt.Errorf("rego rule definition is empty") | ||
| } | ||
|
|
||
| inputs, err := rules.InputFromText(path, r.Def) | ||
| if err != nil { | ||
| return fmt.Errorf("failed parsing rego rule: %w", err) | ||
| } | ||
|
|
||
| lint := linter.NewLinter().WithInputModules(&inputs) | ||
|
|
||
| res, err := lint.Lint(ctx) | ||
| if err != nil { | ||
| return fmt.Errorf("failed linting rego rule: %w", err) | ||
| } | ||
|
|
||
| if err := yaml.NewEncoder(out).Encode(res); err != nil { | ||
| return fmt.Errorf("failed writing lint results: %w", err) | ||
| } | ||
|
|
||
| return nil | ||
| } |
This file contains 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 |
|---|---|---|
|
|
@@ -24,6 +24,7 @@ func CmdRuleType() *cobra.Command { | |
| } | ||
|
|
||
| rtCmd.AddCommand(CmdTest()) | ||
| rtCmd.AddCommand(CmdLint()) | ||
|
|
||
| return rtCmd | ||
| } | ||
This file contains 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 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