mirror of
https://github.com/open-policy-agent/opa.git
synced 2026-08-23 00:34:48 -06:00
Patrick East
5418908e1c
Previously we would internally reference modules by only their `path` which was, for data files, the system path but bundles it is relative to the root of the bundle. In theory data paths and bundle paths could collide, but the real trouble is caused by multiple bundles. It was very easy to have two bundles with identical file paths but different packages and policies defined in them. Internally we now reference bundle module id's as a combination of the bundle name (or the file path for the bundle if loaded from CLI) and the path within the bundle. This does change the `id` a particular policy will show up at via the storage ListPolicies and in turn REST API for OPA. This only affects users that have switched to the `bundles` configuration option, or that are using the `-b`/`--bundle` CLI options to load bundles. The older style `bundle` config keyword and loading tarballs from as data paths are still going to use the older ID. Fixes: #1725 Signed-off-by: Patrick East <east.patrick@gmail.com>
122 lines
2.7 KiB
Go
122 lines
2.7 KiB
Go
// Copyright 2017 The OPA Authors. All rights reserved.
|
|
// Use of this source code is governed by an Apache2
|
|
// license that can be found in the LICENSE file.
|
|
|
|
package cmd
|
|
|
|
import (
|
|
"encoding/json"
|
|
"fmt"
|
|
"os"
|
|
|
|
"github.com/open-policy-agent/opa/ast"
|
|
"github.com/open-policy-agent/opa/loader"
|
|
"github.com/open-policy-agent/opa/util"
|
|
"github.com/spf13/cobra"
|
|
)
|
|
|
|
var checkParams = struct {
|
|
format *util.EnumFlag
|
|
errLimit int
|
|
ignore []string
|
|
bundleMode bool
|
|
}{
|
|
format: util.NewEnumFlag(checkFormatPretty, []string{
|
|
checkFormatPretty, checkFormatJSON,
|
|
}),
|
|
}
|
|
|
|
const (
|
|
checkFormatPretty = "pretty"
|
|
checkFormatJSON = "json"
|
|
)
|
|
|
|
var checkCommand = &cobra.Command{
|
|
Use: "check <path> [path [...]]",
|
|
Short: "Check Rego source files",
|
|
Long: `Check Rego source files for parse and compilation errors.
|
|
|
|
If the 'check' command succeeds in parsing and compiling the source file(s), no output
|
|
is produced. If the parsing or compiling fails, 'check' will output the errors
|
|
and exit with a non-zero exit code.`,
|
|
|
|
PreRunE: func(Cmd *cobra.Command, args []string) error {
|
|
if len(args) == 0 {
|
|
return fmt.Errorf("specify at least one file")
|
|
}
|
|
return nil
|
|
},
|
|
|
|
Run: func(cmd *cobra.Command, args []string) {
|
|
os.Exit(checkModules(args))
|
|
},
|
|
}
|
|
|
|
func checkModules(args []string) int {
|
|
modules := map[string]*ast.Module{}
|
|
|
|
if checkParams.bundleMode {
|
|
for _, path := range args {
|
|
b, err := loader.AsBundle(path)
|
|
if err != nil {
|
|
outputErrors(err)
|
|
return 1
|
|
}
|
|
for name, mod := range b.ParsedModules(path) {
|
|
modules[name] = mod
|
|
}
|
|
}
|
|
} else {
|
|
f := loaderFilter{
|
|
Ignore: checkParams.ignore,
|
|
}
|
|
|
|
result, err := loader.Filtered(args, f.Apply)
|
|
if err != nil {
|
|
outputErrors(err)
|
|
return 1
|
|
}
|
|
|
|
for _, m := range result.Modules {
|
|
modules[m.Name] = m.Parsed
|
|
}
|
|
}
|
|
|
|
compiler := ast.NewCompiler().SetErrorLimit(checkParams.errLimit)
|
|
|
|
compiler.Compile(modules)
|
|
|
|
if !compiler.Failed() {
|
|
return 0
|
|
}
|
|
|
|
outputErrors(compiler.Errors)
|
|
|
|
return 1
|
|
}
|
|
|
|
func outputErrors(err error) {
|
|
switch checkParams.format.String() {
|
|
case checkFormatJSON:
|
|
result := map[string]error{
|
|
"errors": err,
|
|
}
|
|
bs, err := json.MarshalIndent(result, "", " ")
|
|
if err != nil {
|
|
fmt.Fprintln(os.Stderr, err)
|
|
} else {
|
|
fmt.Fprintln(os.Stdout, string(bs))
|
|
}
|
|
default:
|
|
fmt.Fprintln(os.Stdout, err)
|
|
}
|
|
}
|
|
|
|
func init() {
|
|
setMaxErrors(checkCommand.Flags(), &checkParams.errLimit)
|
|
setIgnore(checkCommand.Flags(), &checkParams.ignore)
|
|
checkCommand.Flags().VarP(checkParams.format, "format", "f", "set output format")
|
|
checkCommand.Flags().BoolVarP(&checkParams.bundleMode, "bundle", "b", false, "load paths as bundle files or root directories")
|
|
RootCommand.AddCommand(checkCommand)
|
|
}
|