-
Notifications
You must be signed in to change notification settings - Fork 53
feat: add policy develop lint #2250
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Piskoo
merged 7 commits into
chainloop-dev:main
from
Piskoo:feat-add-policy-develop-lint
Jul 18, 2025
Merged
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
1c5e1ae
feat: add policy develop lint
Piskoo 33151f4
fix linting error
Piskoo d5cbbea
use proto unmarshal and validation for yaml schema validation; remove…
Piskoo 04c3c6d
fix tests
Piskoo 5a6fc8d
rename policy; add comments, change return type for linting functions
Piskoo b905bce
refactor handling storage during linting process
Piskoo 2fc1359
resolve merge conflicts
Piskoo File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
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,67 @@ | ||
| // | ||
| // Copyright 2025 The Chainloop Authors. | ||
| // | ||
| // 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 cmd | ||
|
|
||
| import ( | ||
| "fmt" | ||
|
|
||
| "github.com/chainloop-dev/chainloop/app/cli/internal/action" | ||
| "github.com/spf13/cobra" | ||
| ) | ||
|
|
||
| func newPolicyDevelopLintCmd() *cobra.Command { | ||
| var ( | ||
| policyPath string | ||
| format bool | ||
| ) | ||
|
|
||
| cmd := &cobra.Command{ | ||
| Use: "lint", | ||
| Short: "Lint chainloop policy structure and content", | ||
| Long: `Performs comprehensive validation of: | ||
| - *.yaml files (schema validation) | ||
| - *.rego (formatting, linting, structure)`, | ||
| RunE: func(cmd *cobra.Command, _ []string) error { | ||
| a, err := action.NewPolicyLint(actionOpts) | ||
| if err != nil { | ||
| return fmt.Errorf("failed to initialize linter: %w", err) | ||
| } | ||
|
|
||
| result, err := a.Run(cmd.Context(), &action.PolicyLintOpts{ | ||
| PolicyPath: policyPath, | ||
| Format: format, | ||
| }) | ||
| if err != nil { | ||
| return fmt.Errorf("linting failed: %w", err) | ||
| } | ||
|
|
||
| if result.Valid { | ||
| logger.Info().Msg("policy is valid!") | ||
| return nil | ||
| } | ||
|
|
||
| // Print all validation errors | ||
| for _, err := range result.Errors { | ||
| logger.Error().Msg(err) | ||
| } | ||
| return fmt.Errorf("policy validation failed with %d issues", len(result.Errors)) | ||
| }, | ||
| } | ||
|
|
||
| cmd.Flags().StringVarP(&policyPath, "policy", "p", ".", "Path to policy directory") | ||
| cmd.Flags().BoolVar(&format, "format", false, "Auto-format file with opa fmt") | ||
| return cmd | ||
| } |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,74 @@ | ||
| // | ||
| // Copyright 2025 The Chainloop Authors. | ||
| // | ||
| // 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 action | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
| "path/filepath" | ||
|
|
||
| "github.com/chainloop-dev/chainloop/app/cli/internal/policydevel" | ||
| ) | ||
|
|
||
| type PolicyLintOpts struct { | ||
| PolicyPath string | ||
| Format bool | ||
| } | ||
|
|
||
| type PolicyLintResult struct { | ||
| Valid bool | ||
| Errors []string | ||
| } | ||
|
|
||
| type PolicyLint struct { | ||
| *ActionsOpts | ||
| } | ||
|
|
||
| func NewPolicyLint(actionOpts *ActionsOpts) (*PolicyLint, error) { | ||
| return &PolicyLint{ | ||
| ActionsOpts: actionOpts, | ||
| }, nil | ||
| } | ||
|
|
||
| func (action *PolicyLint) Run(_ context.Context, opts *PolicyLintOpts) (*PolicyLintResult, error) { | ||
| // Resolve absolute path to policy directory | ||
| absPath, err := filepath.Abs(opts.PolicyPath) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("resolving absolute path: %w", err) | ||
| } | ||
|
|
||
| // Read policies | ||
| policy, err := policydevel.Lookup(absPath, opts.Format) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("loading policy: %w", err) | ||
| } | ||
|
|
||
| // Run all validations | ||
| policy.Validate() | ||
|
|
||
| // Prepare result | ||
| result := &PolicyLintResult{ | ||
| Valid: !policy.HasErrors(), | ||
| Errors: make([]string, 0, len(policy.Errors)), | ||
| } | ||
|
|
||
| // Convert validation errors to strings | ||
| for _, err := range policy.Errors { | ||
| result.Errors = append(result.Errors, err.Error()) | ||
| } | ||
|
|
||
| return result, nil | ||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.