Skip to content
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.

Sign up for GitHub

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

Added examples for policy commands #769

Merged
merged 2 commits into from
Aug 22, 2022
Merged

Added examples for policy commands #769

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
304ccb1
added examples for policy commands
sagar-connect Aug 19, 2022
38764d3
updated example
sagar-connect Aug 20, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 16 additions & 13 deletions cmd/policy/policy.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ func NewCommand(config *settings.Config, preRunE validator.Validator) *cobra.Com

cmd := &cobra.Command{
Short: "push policy bundle",
Use: "push",
Use: "push <policy_dir_path>",
RunE: func(cmd *cobra.Command, args []string) error {
bundle, err := loadBundleFromFS(args[0])
if err != nil {
Expand Down Expand Up @@ -83,7 +83,7 @@ func NewCommand(config *settings.Config, preRunE validator.Validator) *cobra.Com
return nil
},
Args: cobra.ExactArgs(1),
Example: `policy push ./policy_bundle_dir_path --owner-id 462d67f8-b232-4da4-a7de-0c86dd667d3f --context config`,
Example: `policy push ./policies --owner-id 462d67f8-b232-4da4-a7de-0c86dd667d3f`,
}

cmd.Flags().StringVar(&context, "context", "config", "policy context")
Expand All @@ -100,7 +100,7 @@ func NewCommand(config *settings.Config, preRunE validator.Validator) *cobra.Com
var ownerID, context string
cmd := &cobra.Command{
Short: "Get diff between local and remote policy bundles",
Use: "diff",
Use: "diff <policy_dir_path>",
RunE: func(cmd *cobra.Command, args []string) error {
bundle, err := loadBundleFromFS(args[0])
if err != nil {
Expand All @@ -117,7 +117,8 @@ func NewCommand(config *settings.Config, preRunE validator.Validator) *cobra.Com

return prettyJSONEncoder(cmd.OutOrStdout()).Encode(diff)
},
Args: cobra.ExactArgs(1),
Args: cobra.ExactArgs(1),
Example: `policy diff ./policies --owner-id 462d67f8-b232-4da4-a7de-0c86dd667d3f`,
}
cmd.Flags().StringVar(&context, "context", "config", "policy context")
cmd.Flags().StringVar(&ownerID, "owner-id", "", "the id of the policy's owner")
Expand All @@ -132,7 +133,7 @@ func NewCommand(config *settings.Config, preRunE validator.Validator) *cobra.Com
var ownerID, context, policyName string
cmd := &cobra.Command{
Short: "Fetch policy bundle (or a single policy)",
Use: "fetch <policy_name>",
Use: "fetch [policy_name]",
RunE: func(cmd *cobra.Command, args []string) error {
if len(args) == 1 {
policyName = args[0]
Expand All @@ -149,7 +150,7 @@ func NewCommand(config *settings.Config, preRunE validator.Validator) *cobra.Com
return nil
},
Args: cobra.MaximumNArgs(1),
Example: `policy fetch policy_name --owner-id 516425b2-e369-421b-838d-920e1f51b0f5 --context config`,
Example: `policy fetch --owner-id 516425b2-e369-421b-838d-920e1f51b0f5`,
}

cmd.Flags().StringVar(&context, "context", "config", "policy context")
Expand All @@ -166,7 +167,7 @@ func NewCommand(config *settings.Config, preRunE validator.Validator) *cobra.Com
var request policy.DecisionQueryRequest

cmd := &cobra.Command{
Short: "Get policy (decision) logs",
Short: "Get policy decision logs",
Use: "logs",
RunE: func(cmd *cobra.Command, _ []string) (err error) {
if cmd.Flag("after").Changed {
Expand Down Expand Up @@ -234,7 +235,7 @@ func NewCommand(config *settings.Config, preRunE validator.Validator) *cobra.Com
return nil
},
Args: cobra.ExactArgs(0),
Example: `policy logs --owner-id 462d67f8-b232-4da4-a7de-0c86dd667d3f --after 2022/03/14 --out output.json`,
Example: `policy logs --owner-id 462d67f8-b232-4da4-a7de-0c86dd667d3f --after 2022/03/14 --out output.json`,
}

cmd.Flags().StringVar(&request.Status, "status", "", "filter decision logs based on their status")
Expand Down Expand Up @@ -264,13 +265,13 @@ func NewCommand(config *settings.Config, preRunE validator.Validator) *cobra.Com

cmd := &cobra.Command{
Short: "make a decision",
Use: "decide",
Use: "decide [policy_file_or_dir_path]",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

😄

RunE: func(cmd *cobra.Command, args []string) error {
if len(args) == 1 {
policyPath = args[0]
}
if (policyPath == "" && ownerID == "") || (policyPath != "" && ownerID != "") {
return fmt.Errorf("either policy-path or --owner-id is required")
return fmt.Errorf("either [policy_file_or_dir_path] or --owner-id is required")
}

input, err := os.ReadFile(inputPath)
Expand Down Expand Up @@ -307,7 +308,8 @@ func NewCommand(config *settings.Config, preRunE validator.Validator) *cobra.Com

return nil
},
Args: cobra.MaximumNArgs(1),
Args: cobra.MaximumNArgs(1),
Example: `policy decide ./policies --input ./.circleci/config.yml`,
}

cmd.Flags().StringVar(&ownerID, "owner-id", "", "the id of the policy's owner")
Expand All @@ -326,7 +328,7 @@ func NewCommand(config *settings.Config, preRunE validator.Validator) *cobra.Com
var inputPath, metaFile, query string
cmd := &cobra.Command{
Short: "perform raw opa evaluation locally",
Use: "eval",
Use: "eval <policy_file_or_dir_path>",
RunE: func(cmd *cobra.Command, args []string) error {
policyPath := args[0]
input, err := os.ReadFile(inputPath)
Expand Down Expand Up @@ -356,7 +358,8 @@ func NewCommand(config *settings.Config, preRunE validator.Validator) *cobra.Com

return nil
},
Args: cobra.ExactArgs(1),
Args: cobra.ExactArgs(1),
Example: `policy eval ./policies --input ./.circleci/config.yml`,
}

cmd.Flags().StringVar(&inputPath, "input", "", "path to input file")
Expand Down
4 changes: 2 additions & 2 deletions cmd/policy/policy_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -623,12 +623,12 @@ func TestMakeDecisionCommand(t *testing.T) {
{
Name: "fails if neither local-policy nor owner-id is provided",
Args: []string{"decide", "--input", "./testdata/test1/test.yml"},
ExpectedErr: "either policy-path or --owner-id is required",
ExpectedErr: "either [policy_file_or_dir_path] or --owner-id is required",
},
{
Name: "fails if both local-policy and owner-id are provided",
Args: []string{"decide", "./testdata/test0/policy.rego", "--input", "./testdata/test1/test.yml", "--owner-id", "test-owner"},
ExpectedErr: "either policy-path or --owner-id is required",
ExpectedErr: "either [policy_file_or_dir_path] or --owner-id is required",
},
{
Name: "fails for input file not found",
Expand Down
2 changes: 1 addition & 1 deletion cmd/policy/testdata/policy-expected-usage.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Available Commands:
diff Get diff between local and remote policy bundles
eval perform raw opa evaluation locally
fetch Fetch policy bundle (or a single policy)
logs Get policy (decision) logs
logs Get policy decision logs
push push policy bundle

Flags:
Expand Down
5 changes: 4 additions & 1 deletion cmd/policy/testdata/policy/decide-expected-usage.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
Usage:
policy decide [flags]
policy decide [policy_file_or_dir_path] [flags]

Examples:
policy decide ./policies --input ./.circleci/config.yml

Flags:
--context string policy context for decision (default "config")
Expand Down
5 changes: 4 additions & 1 deletion cmd/policy/testdata/policy/diff-expected-usage.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
Usage:
policy diff [flags]
policy diff <policy_dir_path> [flags]

Examples:
policy diff ./policies --owner-id 462d67f8-b232-4da4-a7de-0c86dd667d3f

Flags:
--context string policy context (default "config")
Expand Down
5 changes: 4 additions & 1 deletion cmd/policy/testdata/policy/eval-expected-usage.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
Usage:
policy eval [flags]
policy eval <policy_file_or_dir_path> [flags]

Examples:
policy eval ./policies --input ./.circleci/config.yml

Flags:
--input string path to input file
Expand Down
4 changes: 2 additions & 2 deletions cmd/policy/testdata/policy/fetch-expected-usage.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
Usage:
policy fetch <policy_name> [flags]
policy fetch [policy_name] [flags]

Examples:
policy fetch policy_name --owner-id 516425b2-e369-421b-838d-920e1f51b0f5 --context config
policy fetch --owner-id 516425b2-e369-421b-838d-920e1f51b0f5

Flags:
--context string policy context (default "config")
Expand Down
2 changes: 1 addition & 1 deletion cmd/policy/testdata/policy/logs-expected-usage.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Usage:
policy logs [flags]

Examples:
policy logs --owner-id 462d67f8-b232-4da4-a7de-0c86dd667d3f --after 2022/03/14 --out output.json
policy logs --owner-id 462d67f8-b232-4da4-a7de-0c86dd667d3f --after 2022/03/14 --out output.json

Flags:
--after string filter decision logs triggered AFTER this datetime
Expand Down
4 changes: 2 additions & 2 deletions cmd/policy/testdata/policy/push-expected-usage.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
Usage:
policy push [flags]
policy push <policy_dir_path> [flags]

Examples:
policy push ./policy_bundle_dir_path --owner-id 462d67f8-b232-4da4-a7de-0c86dd667d3f --context config
policy push ./policies --owner-id 462d67f8-b232-4da4-a7de-0c86dd667d3f

Flags:
--context string policy context (default "config")
Expand Down