Files
releases/cmd/capabilities.go
T
Anders Eknert 39d0e4ec03 chore: capbilities fixes (#5700)
* Use two spaces to indent JSON, not one
* Fix wrong closing tag in built-in reference

Signed-off-by: Anders Eknert <anders@styra.com>
2023-02-25 01:39:59 +01:00

125 lines
2.7 KiB
Go

// Copyright 2022 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"
"strings"
"github.com/open-policy-agent/opa/ast"
"github.com/spf13/cobra"
)
type capabilitiesParams struct {
showCurrent bool
version string
file string
}
func init() {
capabilitiesParams := capabilitiesParams{}
var capabilitiesCommand = &cobra.Command{
Use: "capabilities",
Short: "Print the capabilities of OPA",
Long: `Show capabilities for OPA.
The 'capabilities' command prints the OPA capabilities, prior to and including the version of OPA used.
Print a list of all existing capabilities version names
$ opa capabilities
v0.17.0
v0.17.1
...
v0.37.1
v0.37.2
v0.38.0
...
Print the capabilities of the current version
$ opa capabilities --current
{
"builtins": [...],
"future_keywords": [...],
"wasm_abi_versions": [...]
}
Print the capabilities of a specific version
$ opa capabilities --version v0.32.1
{
"builtins": [...],
"future_keywords": null,
"wasm_abi_versions": [...]
}
Print the capabilities of a capabilities file
$ opa capabilities --file ./capabilities/v0.32.1.json
{
"builtins": [...],
"future_keywords": null,
"wasm_abi_versions": [...]
}
`,
RunE: func(*cobra.Command, []string) error {
cs, err := doCapabilities(capabilitiesParams)
if err != nil {
return err
}
fmt.Println(cs)
return nil
},
}
capabilitiesCommand.Flags().BoolVar(&capabilitiesParams.showCurrent, "current", false, "print current capabilities")
capabilitiesCommand.Flags().StringVar(&capabilitiesParams.version, "version", "", "print capabilities of a specific version")
capabilitiesCommand.Flags().StringVar(&capabilitiesParams.file, "file", "", "print current capabilities")
RootCommand.AddCommand(capabilitiesCommand)
}
func doCapabilities(params capabilitiesParams) (string, error) {
var (
c *ast.Capabilities
err error
)
if len(params.version) > 0 {
c, err = ast.LoadCapabilitiesVersion(params.version)
} else if len(params.file) > 0 {
c, err = ast.LoadCapabilitiesFile(params.file)
} else if params.showCurrent {
c = ast.CapabilitiesForThisVersion()
} else {
return showVersions()
}
if err != nil {
return "", err
}
bs, err := json.MarshalIndent(c, "", " ")
if err != nil {
return "", err
}
return string(bs), nil
}
func showVersions() (string, error) {
cvs, err := ast.LoadCapabilitiesVersions()
if err != nil {
return "", err
}
t := strings.Join(cvs, "\n")
return t, nil
}