2021-02-07 20:26:56 -08:00
package test
2021-02-01 16:22:41 +05:30
import (
"encoding/json"
2021-02-07 20:26:56 -08:00
"fmt"
2021-02-01 16:22:41 +05:30
"io/ioutil"
2021-02-07 20:26:56 -08:00
"net/url"
2021-02-01 16:22:41 +05:30
"os"
2022-04-27 17:19:40 +05:30
"path"
2021-02-01 16:22:41 +05:30
"path/filepath"
2021-10-01 14:16:33 +05:30
"regexp"
2021-02-07 20:26:56 -08:00
"sort"
2021-02-01 16:22:41 +05:30
"strings"
2021-08-21 19:35:17 +02:00
"time"
2021-02-07 20:26:56 -08:00
"github.com/fatih/color"
"github.com/go-git/go-billy/v5"
"github.com/go-git/go-billy/v5/memfs"
"github.com/kataras/tablewriter"
2022-05-17 13:12:43 +02:00
kyvernov1 "github.com/kyverno/kyverno/api/kyverno/v1"
2022-04-25 20:20:40 +08:00
"github.com/kyverno/kyverno/api/kyverno/v1beta1"
2022-05-17 13:12:43 +02:00
policyreportv1alpha2 "github.com/kyverno/kyverno/api/policyreport/v1alpha2"
2022-04-14 17:50:18 +05:30
"github.com/kyverno/kyverno/cmd/cli/kubectl-kyverno/utils/common"
sanitizederror "github.com/kyverno/kyverno/cmd/cli/kubectl-kyverno/utils/sanitizedError"
"github.com/kyverno/kyverno/cmd/cli/kubectl-kyverno/utils/store"
2022-03-28 16:01:27 +02:00
"github.com/kyverno/kyverno/pkg/autogen"
2022-04-13 18:15:04 +05:30
"github.com/kyverno/kyverno/pkg/background/generate"
2022-05-17 16:40:51 +02:00
"github.com/kyverno/kyverno/pkg/dclient"
2021-02-07 20:26:56 -08:00
"github.com/kyverno/kyverno/pkg/engine/response"
2021-02-01 16:22:41 +05:30
"github.com/kyverno/kyverno/pkg/openapi"
2021-02-07 20:26:56 -08:00
policy2 "github.com/kyverno/kyverno/pkg/policy"
2021-02-01 16:22:41 +05:30
"github.com/kyverno/kyverno/pkg/policyreport"
2021-05-07 19:27:15 -04:00
util "github.com/kyverno/kyverno/pkg/utils"
2021-02-01 16:22:41 +05:30
"github.com/lensesio/tableprinter"
2021-02-07 20:26:56 -08:00
"github.com/spf13/cobra"
corev1 "k8s.io/api/core/v1"
2021-08-21 19:35:17 +02:00
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
2021-10-01 14:16:33 +05:30
"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
2021-02-07 20:26:56 -08:00
"k8s.io/apimachinery/pkg/util/yaml"
log "sigs.k8s.io/controller-runtime/pkg/log"
2021-02-01 16:22:41 +05:30
)
2021-10-01 14:16:33 +05:30
var longHelp = `
2022-02-21 10:53:29 +05:30
The test command provides a facility to test resources against policies by comparing expected results , declared ahead of time in a test manifest file , to actual results reported by Kyverno . Users provide the path to the folder containing a kyverno - test . yaml file where the location could be on a local filesystem or a remote git repository .
2021-10-01 14:16:33 +05:30
`
2022-05-17 08:19:03 +02:00
2021-10-01 14:16:33 +05:30
var exampleHelp = `
2022-02-21 10:53:29 +05:30
# Test a git repository containing Kyverno test cases .
2021-12-20 11:39:53 +05:30
kyverno test https : //github.com/kyverno/policies/pod-security --git-branch main
2022-02-21 10:53:29 +05:30
< snip >
Executing require - non - root - groups ...
applying 1 policy to 2 resources ...
│ ─ ─ ─ │ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ │ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ │ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ │ ─ ─ ─ ─ ─ ─ ─ ─ │
│ # │ POLICY │ RULE │ RESOURCE │ RESULT │
│ ─ ─ ─ │ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ │ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ │ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ │ ─ ─ ─ ─ ─ ─ ─ ─ │
│ 1 │ require - non - root - groups │ check - runasgroup │ default / Pod / fs - group0 │ Pass │
│ 2 │ require - non - root - groups │ check - supplementalGroups │ default / Pod / fs - group0 │ Pass │
│ 3 │ require - non - root - groups │ check - fsGroup │ default / Pod / fs - group0 │ Pass │
│ 4 │ require - non - root - groups │ check - supplementalGroups │ default / Pod / supplemental - groups0 │ Pass │
│ 5 │ require - non - root - groups │ check - fsGroup │ default / Pod / supplemental - groups0 │ Pass │
│ 6 │ require - non - root - groups │ check - runasgroup │ default / Pod / supplemental - groups0 │ Pass │
│ ─ ─ ─ │ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ │ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ │ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ │ ─ ─ ─ ─ ─ ─ ─ ─ │
< snip >
# Test a local folder containing test cases .
kyverno test .
Executing limit - containers - per - pod ...
applying 1 policy to 4 resources ...
│ ─ ─ ─ │ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ │ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ │ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ │ ─ ─ ─ ─ ─ ─ ─ ─ │
│ # │ POLICY │ RULE │ RESOURCE │ RESULT │
│ ─ ─ ─ │ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ │ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ │ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ │ ─ ─ ─ ─ ─ ─ ─ ─ │
│ 1 │ limit - containers - per - pod │ limit - containers - per - pod - bare │ default / Pod / myapp - pod - 1 │ Pass │
│ 2 │ limit - containers - per - pod │ limit - containers - per - pod - bare │ default / Pod / myapp - pod - 2 │ Pass │
│ 3 │ limit - containers - per - pod │ limit - containers - per - pod - controllers │ default / Deployment / mydeploy │ Pass │
│ 4 │ limit - containers - per - pod │ limit - containers - per - pod - cronjob │ default / CronJob / mycronjob │ Pass │
│ ─ ─ ─ │ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ │ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ │ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ │ ─ ─ ─ ─ ─ ─ ─ ─ │
Test Summary : 4 tests passed and 0 tests failed
2022-03-09 13:10:53 +05:30
# Test some specific test cases out of many test cases in a local folder .
kyverno test . -- test - case - selector "policy=disallow-latest-tag, rule=require-image-tag, resource=test-require-image-tag-pass"
Executing test - simple ...
applying 1 policy to 1 resource ...
│ ─ ─ ─ │ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ │ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ │ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ │ ─ ─ ─ ─ ─ ─ ─ ─ │
│ # │ POLICY │ RULE │ RESOURCE │ RESULT │
│ ─ ─ ─ │ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ │ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ │ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ │ ─ ─ ─ ─ ─ ─ ─ ─ │
│ 1 │ disallow - latest - tag │ require - image - tag │ default / Pod / test - require - image - tag - pass │ Pass │
│ ─ ─ ─ │ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ │ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ │ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ │ ─ ─ ─ ─ ─ ─ ─ ─ │
Test Summary : 1 tests passed and 0 tests failed
2022-02-21 10:53:29 +05:30
* * TEST FILE STRUCTURE * * :
The kyverno - test . yaml has four parts :
"policies" -- > List of policies which are applied .
"resources" -- > List of resources on which the policies are applied .
"variables" -- > Variable file path containing variables referenced in the policy ( OPTIONAL ) .
"results" -- > List of results expected after applying the policies to the resources .
* * TEST FILE FORMAT * * :
name : < test_name >
policies :
- < path / to / policy1 . yaml >
- < path / to / policy2 . yaml >
resources :
- < path / to / resource1 . yaml >
- < path / to / resource2 . yaml >
variables : < variable_file > ( OPTIONAL )
results :
- policy : < name > ( For Namespaced [ Policy ] files , format is < policy_namespace > / < policy_name > )
rule : < name >
resource : < name >
namespace : < name > ( OPTIONAL )
kind : < name >
patchedResource : < path / to / patched / resource . yaml > ( For mutate policies / rules only )
result : < pass | fail | skip >
* * VARIABLES FILE FORMAT * * :
policies :
- name : < policy_name >
rules :
- name : < rule_name >
# Global variable values
values :
foo : bar
2021-10-01 14:16:33 +05:30
resources :
2022-02-21 10:53:29 +05:30
- name : < resource_name_1 >
# Resource - specific variable values
values :
foo : baz
- name : < resource_name_2 >
values :
foo : bin
* * RESULT DESCRIPTIONS * * :
pass -- > The resource is either validated by the policy or , if a mutation , equals the state of the patched resource .
fail -- > The resource fails validation or the patched resource generated by Kyverno is not equal to the input resource provided by the user .
2021-10-14 02:37:11 +05:30
skip -- > The rule is not applied .
2021-10-01 17:52:23 +05:30
2021-10-14 02:37:11 +05:30
For more information visit https : //kyverno.io/docs/kyverno-cli/#test
2021-10-01 14:16:33 +05:30
`
2021-02-01 16:22:41 +05:30
// Command returns version command
func Command ( ) * cobra . Command {
2021-02-18 01:00:41 +05:30
var cmd * cobra . Command
2022-03-09 13:10:53 +05:30
var testCase string
2022-02-21 10:53:29 +05:30
var testFile [ ] byte
2022-03-09 13:10:53 +05:30
var fileName , gitBranch string
2022-03-16 09:56:47 +05:30
var registryAccess bool
2021-02-18 01:00:41 +05:30
cmd = & cobra . Command {
2022-02-21 10:53:29 +05:30
Use : "test <path_to_folder_Containing_test.yamls> [flags]\n kyverno test <path_to_gitRepository_with_dir> --git-branch <branchName>\n kyverno test --manifest-mutate > kyverno-test.yaml\n kyverno test --manifest-validate > kyverno-test.yaml" ,
// Args: cobra.ExactArgs(1),
2021-10-01 14:16:33 +05:30
Short : "run tests from directory" ,
Long : longHelp ,
Example : exampleHelp ,
2021-02-01 23:34:15 +05:30
RunE : func ( cmd * cobra . Command , dirPath [ ] string ) ( err error ) {
2021-02-01 16:22:41 +05:30
defer func ( ) {
if err != nil {
if ! sanitizederror . IsErrorSanitized ( err ) {
log . Log . Error ( err , "failed to sanitize" )
err = fmt . Errorf ( "internal error" )
}
}
} ( )
2021-10-03 22:36:06 -07:00
2022-02-21 10:53:29 +05:30
mStatus , _ := cmd . Flags ( ) . GetBool ( "manifest-mutate" )
vStatus , _ := cmd . Flags ( ) . GetBool ( "manifest-validate" )
if mStatus {
testFile = [ ] byte ( ` name : < test_name >
policies :
- < path / to / policy1 . yaml >
- < path / to / policy2 . yaml >
resources :
- < path / to / resource1 . yaml >
- < path / to / resource2 . yaml >
variables : < variable_file > ( OPTIONAL )
results :
- policy : < name > ( For Namespaced [ Policy ] files , format is < policy_namespace > / < policy_name > )
rule : < name >
resource : < name >
namespace : < name > ( OPTIONAL )
kind : < name >
patchedResource : < path / to / patched / resource . yaml >
result : < pass | fail | skip > ` )
fmt . Println ( string ( testFile ) )
return nil
}
if vStatus {
testFile = [ ] byte ( ` name : < test_name >
policies :
- < path / to / policy1 . yaml >
- < path / to / policy2 . yaml >
resources :
- < path / to / resource1 . yaml >
- < path / to / resource2 . yaml >
variables : < variable_file > ( OPTIONAL )
results :
- policy : < name > ( For Namespaced [ Policy ] files , format is < policy_namespace > / < policy_name > )
rule : < name >
resource : < name >
namespace : < name > ( OPTIONAL )
kind : < name >
result : < pass | fail | skip > ` )
fmt . Println ( string ( testFile ) )
return nil
}
2022-03-16 09:56:47 +05:30
store . SetRegistryAccess ( registryAccess )
2022-03-09 13:10:53 +05:30
_ , err = testCommandExecute ( dirPath , fileName , gitBranch , testCase )
2021-02-01 16:22:41 +05:30
if err != nil {
2021-02-02 18:43:19 +05:30
log . Log . V ( 3 ) . Info ( "a directory is required" )
2021-02-01 16:22:41 +05:30
return err
}
2021-10-03 22:36:06 -07:00
2021-02-01 16:22:41 +05:30
return nil
} ,
}
2021-12-17 12:01:34 +05:30
cmd . Flags ( ) . StringVarP ( & fileName , "file-name" , "f" , "kyverno-test.yaml" , "test filename" )
2021-12-20 11:39:53 +05:30
cmd . Flags ( ) . StringVarP ( & gitBranch , "git-branch" , "b" , "" , "test github repository branch" )
2022-03-09 13:10:53 +05:30
cmd . Flags ( ) . StringVarP ( & testCase , "test-case-selector" , "t" , "" , ` run some specific test cases by passing a string argument in double quotes to this flag like - "policy=<policy_name>, rule=<rule_name>, resource=<resource_name". The argument could be any combination of policy, rule and resource. ` )
2022-02-21 10:53:29 +05:30
cmd . Flags ( ) . BoolP ( "manifest-mutate" , "" , false , "prints out a template test manifest for a mutate policy" )
cmd . Flags ( ) . BoolP ( "manifest-validate" , "" , false , "prints out a template test manifest for a validate policy" )
2022-03-16 09:56:47 +05:30
cmd . Flags ( ) . BoolVarP ( & registryAccess , "registry" , "" , false , "If set to true, access the image registry using local docker credentials to populate external data" )
2021-02-18 01:00:41 +05:30
return cmd
2021-02-01 16:22:41 +05:30
}
type Test struct {
2021-02-07 20:26:56 -08:00
Name string ` json:"name" `
Policies [ ] string ` json:"policies" `
Resources [ ] string ` json:"resources" `
Variables string ` json:"variables" `
2022-04-12 09:30:49 +05:30
UserInfo string ` json:"userinfo" `
2021-02-07 20:26:56 -08:00
Results [ ] TestResults ` json:"results" `
2021-02-01 16:22:41 +05:30
}
type TestResults struct {
2022-05-25 19:56:22 +05:30
// Policy mentions the name of the policy.
Policy string ` json:"policy" `
// Rule mentions the name of the rule in the policy.
Rule string ` json:"rule" `
// Result mentions the result that the user is expecting.
// Possible values are pass, fail and skip.
Result policyreportv1alpha2 . PolicyResult ` json:"result" `
// Status mentions the status that the user is expecting.
// Possible values are pass, fail and skip.
Status policyreportv1alpha2 . PolicyResult ` json:"status" `
// Resource mentions the name of the resource on which the policy is to be applied.
Resource string ` json:"resource" `
2022-06-20 12:08:13 +05:30
// Resources gives us the list of resources on which the policy is going to be applied.
Resources [ ] string ` json:"resources" `
2022-05-25 19:56:22 +05:30
// Kind mentions the kind of the resource on which the policy is to be applied.
Kind string ` json:"kind" `
// Namespace mentions the namespace of the policy which has namespace scope.
Namespace string ` json:"namespace" `
// PatchedResource takes a resource configuration file in yaml format from
// the user to compare it against the Kyverno mutated resource configuration.
PatchedResource string ` json:"patchedResource" `
// AutoGeneratedRule is internally set by the CLI command. It takes values either
// autogen or autogen-cronjob.
AutoGeneratedRule string ` json:"auto_generated_rule" `
// GeneratedResource takes a resource configuration file in yaml format from
// the user to compare it against the Kyverno generated resource configuration.
GeneratedResource string ` json:"generatedResource" `
// CloneSourceResource takes the resource configuration file in yaml format
// from the user which is meant to be cloned by the generate rule.
CloneSourceResource string ` json:"cloneSourceResource" `
2021-02-01 16:22:41 +05:30
}
type ReportResult struct {
2021-02-07 20:26:56 -08:00
TestResults
2021-02-01 16:22:41 +05:30
Resources [ ] * corev1 . ObjectReference ` json:"resources" `
}
type Resource struct {
2021-02-07 20:26:56 -08:00
Name string ` json:"name" `
2021-02-01 16:22:41 +05:30
Values map [ string ] string ` json:"values" `
}
type Table struct {
2021-02-07 20:26:56 -08:00
ID int ` header:"#" `
2021-09-02 23:11:35 +05:30
Policy string ` header:"policy" `
Rule string ` header:"rule" `
Resource string ` header:"resource" `
2021-02-07 20:26:56 -08:00
Result string ` header:"result" `
2021-02-01 16:22:41 +05:30
}
type Policy struct {
Name string ` json:"name" `
Resources [ ] Resource ` json:"resources" `
}
type Values struct {
Policies [ ] Policy ` json:"policies" `
}
2021-03-05 05:39:18 +05:30
type resultCounts struct {
2021-09-02 23:11:35 +05:30
Skip int
Pass int
Fail int
2021-03-05 05:39:18 +05:30
}
2022-03-09 13:10:53 +05:30
type testFilter struct {
policy string
rule string
resource string
enabled bool
}
2022-06-20 12:08:13 +05:30
var ftable = [ ] Table { }
2022-06-02 23:01:46 +05:30
2022-03-09 13:10:53 +05:30
func testCommandExecute ( dirPath [ ] string , fileName string , gitBranch string , testCase string ) ( rc * resultCounts , err error ) {
2021-02-01 16:22:41 +05:30
var errors [ ] error
fs := memfs . New ( )
2021-09-02 23:11:35 +05:30
rc = & resultCounts { }
2021-03-12 01:16:36 +05:30
var testYamlCount int
2022-05-17 08:19:03 +02:00
tf := & testFilter {
2022-03-09 13:10:53 +05:30
enabled : true ,
}
2021-09-03 16:41:13 +05:30
2021-02-01 23:34:15 +05:30
if len ( dirPath ) == 0 {
2022-05-09 18:55:35 +02:00
return rc , sanitizederror . NewWithError ( "a directory is required" , err )
2021-02-07 20:26:56 -08:00
}
2022-03-09 13:10:53 +05:30
if len ( testCase ) != 0 {
parameters := map [ string ] string { "policy" : "" , "rule" : "" , "resource" : "" }
for _ , t := range strings . Split ( testCase , "," ) {
if ! strings . Contains ( t , "=" ) {
fmt . Printf ( "\n Invalid test-case-selector argument. Selecting all test cases. \n" )
tf . enabled = false
break
}
key := strings . TrimSpace ( strings . Split ( t , "=" ) [ 0 ] )
value := strings . TrimSpace ( strings . Split ( t , "=" ) [ 1 ] )
_ , ok := parameters [ key ]
if ! ok {
fmt . Printf ( "\n Invalid parameter. Parameter can only be policy, rule or resource. Selecting all test cases \n" )
tf . enabled = false
break
}
parameters [ key ] = value
}
tf . policy = parameters [ "policy" ]
tf . rule = parameters [ "rule" ]
tf . resource = parameters [ "resource" ]
} else {
tf . enabled = false
}
2022-02-24 15:34:12 +00:00
openAPIController , err := openapi . NewOpenAPIController ( )
if err != nil {
return rc , fmt . Errorf ( "unable to create open api controller, %w" , err )
}
2022-05-10 21:28:45 +02:00
if strings . Contains ( dirPath [ 0 ] , "https://" ) {
2021-03-05 05:39:18 +05:30
gitURL , err := url . Parse ( dirPath [ 0 ] )
2021-02-01 16:22:41 +05:30
if err != nil {
2021-03-05 05:39:18 +05:30
return rc , sanitizederror . NewWithError ( "failed to parse URL" , err )
2021-02-01 16:22:41 +05:30
}
2021-09-03 16:41:13 +05:30
2021-03-05 05:39:18 +05:30
pathElems := strings . Split ( gitURL . Path [ 1 : ] , "/" )
2021-09-02 23:11:35 +05:30
if len ( pathElems ) <= 1 {
2021-12-20 11:39:53 +05:30
err := fmt . Errorf ( "invalid URL path %s - expected https://github.com/:owner/:repository/:branch (without --git-branch flag) OR https://github.com/:owner/:repository/:directory (with --git-branch flag)" , gitURL . Path )
2021-03-05 05:39:18 +05:30
fmt . Printf ( "Error: failed to parse URL \nCause: %s\n" , err )
os . Exit ( 1 )
2021-02-01 16:22:41 +05:30
}
2021-09-03 16:41:13 +05:30
2021-03-12 01:16:36 +05:30
gitURL . Path = strings . Join ( [ ] string { pathElems [ 0 ] , pathElems [ 1 ] } , "/" )
2021-03-05 05:39:18 +05:30
repoURL := gitURL . String ( )
2021-12-20 11:39:53 +05:30
var gitPathToYamls string
if gitBranch == "" {
gitPathToYamls = "/"
if string ( dirPath [ 0 ] [ len ( dirPath [ 0 ] ) - 1 ] ) == "/" {
gitBranch = strings . ReplaceAll ( dirPath [ 0 ] , repoURL + "/" , "" )
} else {
gitBranch = strings . ReplaceAll ( dirPath [ 0 ] , repoURL , "" )
}
if gitBranch == "" {
gitBranch = "main"
} else if string ( gitBranch [ 0 ] ) == "/" {
gitBranch = gitBranch [ 1 : ]
}
} else {
if string ( dirPath [ 0 ] [ len ( dirPath [ 0 ] ) - 1 ] ) == "/" {
gitPathToYamls = strings . ReplaceAll ( dirPath [ 0 ] , repoURL + "/" , "/" )
} else {
gitPathToYamls = strings . ReplaceAll ( dirPath [ 0 ] , repoURL , "/" )
}
2021-09-02 23:11:35 +05:30
}
2021-09-03 16:41:13 +05:30
2021-12-20 11:39:53 +05:30
_ , cloneErr := clone ( repoURL , fs , gitBranch )
2021-03-12 01:16:36 +05:30
if cloneErr != nil {
fmt . Printf ( "Error: failed to clone repository \nCause: %s\n" , cloneErr )
log . Log . V ( 3 ) . Info ( fmt . Sprintf ( "failed to clone repository %v as it is not valid" , repoURL ) , "error" , cloneErr )
2021-03-05 05:39:18 +05:30
os . Exit ( 1 )
2021-02-01 16:22:41 +05:30
}
2021-09-03 16:41:13 +05:30
2021-12-20 11:39:53 +05:30
policyYamls , err := listYAMLs ( fs , gitPathToYamls )
2021-02-01 16:22:41 +05:30
if err != nil {
2021-03-05 05:39:18 +05:30
return rc , sanitizederror . NewWithError ( "failed to list YAMLs in repository" , err )
2021-02-01 16:22:41 +05:30
}
sort . Strings ( policyYamls )
2021-09-03 16:41:13 +05:30
2021-02-01 16:22:41 +05:30
for _ , yamlFilePath := range policyYamls {
2021-02-07 20:26:56 -08:00
file , err := fs . Open ( yamlFilePath )
2021-05-03 08:20:22 -04:00
if err != nil {
errors = append ( errors , sanitizederror . NewWithError ( "Error: failed to open file" , err ) )
continue
}
2021-09-03 16:41:13 +05:30
2022-04-27 17:19:40 +05:30
if path . Base ( file . Name ( ) ) == fileName {
2021-03-12 01:16:36 +05:30
testYamlCount ++
2021-02-18 01:00:41 +05:30
policyresoucePath := strings . Trim ( yamlFilePath , fileName )
bytes , err := ioutil . ReadAll ( file )
if err != nil {
2021-05-03 08:20:22 -04:00
errors = append ( errors , sanitizederror . NewWithError ( "Error: failed to read file" , err ) )
2021-02-18 01:00:41 +05:30
continue
}
2021-09-03 16:41:13 +05:30
2021-02-18 01:00:41 +05:30
policyBytes , err := yaml . ToJSON ( bytes )
if err != nil {
2021-05-03 08:20:22 -04:00
errors = append ( errors , sanitizederror . NewWithError ( "failed to convert to JSON" , err ) )
2021-02-18 01:00:41 +05:30
continue
}
2022-03-09 13:10:53 +05:30
if err := applyPoliciesFromPath ( fs , policyBytes , true , policyresoucePath , rc , openAPIController , tf ) ; err != nil {
2021-03-05 05:39:18 +05:30
return rc , sanitizederror . NewWithError ( "failed to apply test command" , err )
2021-02-18 01:00:41 +05:30
}
2021-02-01 16:22:41 +05:30
}
2021-05-03 08:20:22 -04:00
}
2021-09-03 16:41:13 +05:30
2021-05-03 08:20:22 -04:00
if testYamlCount == 0 {
fmt . Printf ( "\n No test yamls available \n" )
2021-02-01 16:22:41 +05:30
}
} else {
2022-01-14 14:15:59 +05:30
var testFiles int
2021-02-01 23:34:15 +05:30
path := filepath . Clean ( dirPath [ 0 ] )
2022-03-22 08:39:08 +00:00
errors = getLocalDirTestFiles ( fs , path , fileName , rc , & testFiles , openAPIController , tf )
2022-01-14 14:15:59 +05:30
if testFiles == 0 {
fmt . Printf ( "\n No test files found. Please provide test YAML files named kyverno-test.yaml \n" )
}
2021-05-03 08:20:22 -04:00
}
2021-09-03 16:41:13 +05:30
2021-05-03 08:20:22 -04:00
if len ( errors ) > 0 && log . Log . V ( 1 ) . Enabled ( ) {
2021-10-03 22:36:06 -07:00
fmt . Printf ( "test errors: \n" )
2021-05-03 08:20:22 -04:00
for _ , e := range errors {
fmt . Printf ( " %v \n" , e . Error ( ) )
2021-02-01 16:22:41 +05:30
}
}
2021-10-03 22:36:06 -07:00
2022-05-02 03:52:40 +05:30
fmt . Printf ( "\nTest Summary: %d tests passed and %d tests failed\n" , rc . Pass + rc . Skip , rc . Fail )
2022-06-02 23:01:46 +05:30
fmt . Printf ( "\n" )
2022-05-02 03:52:40 +05:30
2021-09-02 03:21:07 +05:30
if rc . Fail > 0 {
2022-06-02 23:01:46 +05:30
printFailedTestResult ( )
2021-03-05 05:39:18 +05:30
os . Exit ( 1 )
}
os . Exit ( 0 )
return rc , nil
2021-02-01 16:22:41 +05:30
}
2021-02-01 23:34:15 +05:30
2022-03-22 08:39:08 +00:00
func getLocalDirTestFiles ( fs billy . Filesystem , path , fileName string , rc * resultCounts , testFiles * int , openAPIController * openapi . Controller , tf * testFilter ) [ ] error {
2021-05-03 08:20:22 -04:00
var errors [ ] error
2022-01-14 14:15:59 +05:30
2021-02-18 01:00:41 +05:30
files , err := ioutil . ReadDir ( path )
if err != nil {
2021-05-03 08:20:22 -04:00
return [ ] error { fmt . Errorf ( "failed to read %v: %v" , path , err . Error ( ) ) }
2021-02-18 01:00:41 +05:30
}
for _ , file := range files {
if file . IsDir ( ) {
2022-03-22 08:39:08 +00:00
getLocalDirTestFiles ( fs , filepath . Join ( path , file . Name ( ) ) , fileName , rc , testFiles , openAPIController , tf )
2021-02-18 01:00:41 +05:30
continue
}
2022-03-22 08:39:08 +00:00
if file . Name ( ) == fileName {
2022-01-14 14:15:59 +05:30
* testFiles ++
2021-10-14 00:05:13 +02:00
// We accept the risk of including files here as we read the test dir only.
yamlFile , err := ioutil . ReadFile ( filepath . Join ( path , file . Name ( ) ) ) // #nosec G304
2021-02-18 01:00:41 +05:30
if err != nil {
2021-05-03 08:20:22 -04:00
errors = append ( errors , sanitizederror . NewWithError ( "unable to read yaml" , err ) )
2021-02-18 01:00:41 +05:30
continue
}
valuesBytes , err := yaml . ToJSON ( yamlFile )
if err != nil {
2021-05-03 08:20:22 -04:00
errors = append ( errors , sanitizederror . NewWithError ( "failed to convert json" , err ) )
2021-02-18 01:00:41 +05:30
continue
}
2022-03-09 13:10:53 +05:30
if err := applyPoliciesFromPath ( fs , valuesBytes , false , path , rc , openAPIController , tf ) ; err != nil {
2021-05-03 08:20:22 -04:00
errors = append ( errors , sanitizederror . NewWithError ( fmt . Sprintf ( "failed to apply test command from file %s" , file . Name ( ) ) , err ) )
2021-02-18 01:00:41 +05:30
continue
}
}
}
2021-05-03 08:20:22 -04:00
return errors
2021-02-18 01:00:41 +05:30
}
2022-05-17 13:12:43 +02:00
func buildPolicyResults ( engineResponses [ ] * response . EngineResponse , testResults [ ] TestResults , infos [ ] policyreport . Info , policyResourcePath string , fs billy . Filesystem , isGit bool ) ( map [ string ] policyreportv1alpha2 . PolicyReportResult , [ ] TestResults ) {
results := make ( map [ string ] policyreportv1alpha2 . PolicyReportResult )
2021-08-21 19:35:17 +02:00
now := metav1 . Timestamp { Seconds : time . Now ( ) . Unix ( ) }
2021-09-07 20:23:03 +05:30
2022-01-23 05:54:22 -08:00
for _ , resp := range engineResponses {
2021-06-30 00:43:11 +03:00
policyName := resp . PolicyResponse . Policy . Name
2021-05-07 19:27:15 -04:00
resourceName := resp . PolicyResponse . Resource . Name
2021-10-01 14:16:33 +05:30
resourceKind := resp . PolicyResponse . Resource . Kind
resourceNamespace := resp . PolicyResponse . Resource . Namespace
policyNamespace := resp . PolicyResponse . Policy . Namespace
2021-07-06 10:44:43 +05:30
2021-05-07 19:27:15 -04:00
var rules [ ] string
for _ , rule := range resp . PolicyResponse . Rules {
rules = append ( rules , rule . Name )
}
2021-10-01 22:43:21 +05:30
2022-05-17 13:12:43 +02:00
result := policyreportv1alpha2 . PolicyReportResult {
2021-05-07 19:27:15 -04:00
Policy : policyName ,
2022-04-28 11:11:14 +02:00
Resources : [ ] corev1 . ObjectReference {
2021-05-07 19:27:15 -04:00
{
Name : resourceName ,
} ,
} ,
2021-10-03 01:31:05 -07:00
Message : buildMessage ( resp ) ,
2021-05-07 19:27:15 -04:00
}
2021-10-01 22:43:21 +05:30
2022-01-23 05:54:22 -08:00
var patchedResourcePath [ ] string
2021-09-07 20:23:03 +05:30
for i , test := range testResults {
2021-10-01 14:16:33 +05:30
var userDefinedPolicyNamespace string
var userDefinedPolicyName string
2021-10-01 22:43:21 +05:30
found , err := isNamespacedPolicy ( test . Policy )
if err != nil {
log . Log . V ( 3 ) . Info ( "error while checking the policy is namespaced or not" , "policy: " , test . Policy , "error: " , err )
continue
}
2021-10-01 14:16:33 +05:30
if found {
userDefinedPolicyNamespace , userDefinedPolicyName = getUserDefinedPolicyNameAndNamespace ( test . Policy )
test . Policy = userDefinedPolicyName
}
2022-06-20 12:08:13 +05:30
if test . Resources != nil {
if test . Policy == policyName {
// results[].namespace value implict set same as metadata.namespace until and unless
// user provides explict values for results[].namespace in test yaml file.
if test . Namespace == "" {
test . Namespace = resourceNamespace
testResults [ i ] . Namespace = resourceNamespace
}
for _ , resource := range test . Resources {
if resource == resourceName {
var resultsKey string
resultsKey = GetResultKeyAccordingToTestResults ( userDefinedPolicyNamespace , test . Policy , test . Rule , test . Namespace , test . Kind , resource )
if ! util . ContainsString ( rules , test . Rule ) {
if ! util . ContainsString ( rules , "autogen-" + test . Rule ) {
if ! util . ContainsString ( rules , "autogen-cronjob-" + test . Rule ) {
result . Result = policyreportv1alpha2 . StatusSkip
} else {
testResults [ i ] . AutoGeneratedRule = "autogen-cronjob"
test . Rule = "autogen-cronjob-" + test . Rule
resultsKey = GetResultKeyAccordingToTestResults ( userDefinedPolicyNamespace , test . Policy , test . Rule , test . Namespace , test . Kind , resource )
}
} else {
testResults [ i ] . AutoGeneratedRule = "autogen"
test . Rule = "autogen-" + test . Rule
resultsKey = GetResultKeyAccordingToTestResults ( userDefinedPolicyNamespace , test . Policy , test . Rule , test . Namespace , test . Kind , resource )
}
if results [ resultsKey ] . Result == "" {
result . Result = policyreportv1alpha2 . StatusSkip
results [ resultsKey ] = result
}
}
patchedResourcePath = append ( patchedResourcePath , test . PatchedResource )
if _ , ok := results [ resultsKey ] ; ! ok {
results [ resultsKey ] = result
}
}
}
2022-06-15 17:59:13 +05:30
}
2022-06-20 12:08:13 +05:30
}
if test . Resource != "" {
if test . Policy == policyName && test . Resource == resourceName {
var resultsKey string
resultsKey = GetResultKeyAccordingToTestResults ( userDefinedPolicyNamespace , test . Policy , test . Rule , test . Namespace , test . Kind , test . Resource )
if ! util . ContainsString ( rules , test . Rule ) {
if ! util . ContainsString ( rules , "autogen-" + test . Rule ) {
if ! util . ContainsString ( rules , "autogen-cronjob-" + test . Rule ) {
result . Result = policyreportv1alpha2 . StatusSkip
} else {
testResults [ i ] . AutoGeneratedRule = "autogen-cronjob"
test . Rule = "autogen-cronjob-" + test . Rule
resultsKey = GetResultKeyAccordingToTestResults ( userDefinedPolicyNamespace , test . Policy , test . Rule , test . Namespace , test . Kind , test . Resource )
}
2021-09-07 22:27:29 +05:30
} else {
2022-06-20 12:08:13 +05:30
testResults [ i ] . AutoGeneratedRule = "autogen"
test . Rule = "autogen-" + test . Rule
2021-10-01 14:16:33 +05:30
resultsKey = GetResultKeyAccordingToTestResults ( userDefinedPolicyNamespace , test . Policy , test . Rule , test . Namespace , test . Kind , test . Resource )
2021-09-07 22:27:29 +05:30
}
2022-06-20 12:08:13 +05:30
if results [ resultsKey ] . Result == "" {
result . Result = policyreportv1alpha2 . StatusSkip
results [ resultsKey ] = result
}
2021-10-01 14:16:33 +05:30
}
2021-10-01 22:43:21 +05:30
2022-06-20 12:08:13 +05:30
patchedResourcePath = append ( patchedResourcePath , test . PatchedResource )
if _ , ok := results [ resultsKey ] ; ! ok {
2021-10-01 14:16:33 +05:30
results [ resultsKey ] = result
2021-09-07 20:23:03 +05:30
}
2021-05-07 19:27:15 -04:00
}
}
2022-05-25 19:56:22 +05:30
for _ , rule := range resp . PolicyResponse . Rules {
if rule . Type != response . Generation || test . Rule != rule . Name {
continue
}
var resultsKey [ ] string
var resultKey string
var result policyreportv1alpha2 . PolicyReportResult
resultsKey = GetAllPossibleResultsKey ( policyNamespace , policyName , rule . Name , resourceNamespace , resourceKind , resourceName )
for _ , key := range resultsKey {
if val , ok := results [ key ] ; ok {
result = val
resultKey = key
} else {
continue
}
if rule . Status == response . RuleStatusSkip {
result . Result = policyreportv1alpha2 . StatusSkip
} else if rule . Status == response . RuleStatusError {
result . Result = policyreportv1alpha2 . StatusError
} else {
var x string
result . Result = policyreportv1alpha2 . StatusFail
x = getAndCompareResource ( test . GeneratedResource , rule . GeneratedResource , isGit , policyResourcePath , fs , true )
if x == "pass" {
result . Result = policyreportv1alpha2 . StatusPass
}
}
results [ resultKey ] = result
}
}
2021-10-01 14:16:33 +05:30
}
for _ , rule := range resp . PolicyResponse . Rules {
2022-04-06 21:04:08 +02:00
if rule . Type != response . Mutation {
2021-10-01 14:16:33 +05:30
continue
}
2021-10-07 15:25:44 -07:00
2021-10-01 14:16:33 +05:30
var resultsKey [ ] string
var resultKey string
2022-05-17 13:12:43 +02:00
var result policyreportv1alpha2 . PolicyReportResult
2021-10-01 14:16:33 +05:30
resultsKey = GetAllPossibleResultsKey ( policyNamespace , policyName , rule . Name , resourceNamespace , resourceKind , resourceName )
2022-01-23 05:54:22 -08:00
for _ , key := range resultsKey {
if val , ok := results [ key ] ; ok {
2021-10-01 14:16:33 +05:30
result = val
2022-01-23 05:54:22 -08:00
resultKey = key
2021-10-01 14:16:33 +05:30
} else {
continue
}
2021-10-07 15:25:44 -07:00
if rule . Status == response . RuleStatusSkip {
2022-05-17 13:12:43 +02:00
result . Result = policyreportv1alpha2 . StatusSkip
2021-10-07 15:25:44 -07:00
} else if rule . Status == response . RuleStatusError {
2022-05-17 13:12:43 +02:00
result . Result = policyreportv1alpha2 . StatusError
2021-10-07 15:25:44 -07:00
} else {
var x string
2022-01-23 05:54:22 -08:00
for _ , path := range patchedResourcePath {
2022-05-17 13:12:43 +02:00
result . Result = policyreportv1alpha2 . StatusFail
2022-05-25 19:56:22 +05:30
x = getAndCompareResource ( path , resp . PatchedResource , isGit , policyResourcePath , fs , false )
2021-10-07 15:25:44 -07:00
if x == "pass" {
2022-05-17 13:12:43 +02:00
result . Result = policyreportv1alpha2 . StatusPass
2021-10-07 15:25:44 -07:00
break
}
2021-10-01 14:16:33 +05:30
}
}
2021-10-07 15:25:44 -07:00
2021-10-01 14:16:33 +05:30
results [ resultKey ] = result
}
2021-05-07 19:27:15 -04:00
}
}
2021-09-07 20:23:03 +05:30
2021-02-01 16:22:41 +05:30
for _ , info := range infos {
for _ , infoResult := range info . Results {
for _ , rule := range infoResult . Rules {
2022-04-27 08:09:52 -07:00
if rule . Type != string ( response . Validation ) && rule . Type != string ( response . ImageVerify ) {
2021-02-01 16:22:41 +05:30
continue
}
2021-09-07 22:27:29 +05:30
2022-05-17 13:12:43 +02:00
var result policyreportv1alpha2 . PolicyReportResult
2022-02-13 20:35:11 -08:00
var resultsKeys [ ] string
2021-10-01 14:16:33 +05:30
var resultKey string
2022-02-13 20:35:11 -08:00
resultsKeys = GetAllPossibleResultsKey ( "" , info . PolicyName , rule . Name , infoResult . Resource . Namespace , infoResult . Resource . Kind , infoResult . Resource . Name )
for _ , key := range resultsKeys {
if val , ok := results [ key ] ; ok {
2021-10-01 14:16:33 +05:30
result = val
2022-02-13 20:35:11 -08:00
resultKey = key
2021-10-01 14:16:33 +05:30
} else {
continue
}
2021-02-01 16:22:41 +05:30
}
2021-09-07 22:27:29 +05:30
2021-09-02 23:11:35 +05:30
result . Rule = rule . Name
2022-05-17 13:12:43 +02:00
result . Result = policyreportv1alpha2 . PolicyResult ( rule . Status )
2021-08-21 19:35:17 +02:00
result . Source = policyreport . SourceValue
result . Timestamp = now
2021-10-01 14:16:33 +05:30
results [ resultKey ] = result
2021-02-01 16:22:41 +05:30
}
}
}
2021-09-02 23:11:35 +05:30
2021-09-07 20:23:03 +05:30
return results , testResults
2021-02-01 16:22:41 +05:30
}
2022-01-23 05:54:22 -08:00
func GetAllPossibleResultsKey ( policyNamespace , policy , rule , resourceNamespace , kind , resource string ) [ ] string {
2021-10-01 14:16:33 +05:30
var resultsKey [ ] string
resultKey1 := fmt . Sprintf ( "%s-%s-%s-%s" , policy , rule , kind , resource )
2022-01-23 05:54:22 -08:00
resultKey2 := fmt . Sprintf ( "%s-%s-%s-%s-%s" , policy , rule , resourceNamespace , kind , resource )
resultKey3 := fmt . Sprintf ( "%s-%s-%s-%s-%s" , policyNamespace , policy , rule , kind , resource )
resultKey4 := fmt . Sprintf ( "%s-%s-%s-%s-%s-%s" , policyNamespace , policy , rule , resourceNamespace , kind , resource )
2021-10-01 14:16:33 +05:30
resultsKey = append ( resultsKey , resultKey1 , resultKey2 , resultKey3 , resultKey4 )
return resultsKey
}
2021-10-01 22:43:21 +05:30
func GetResultKeyAccordingToTestResults ( policyNs , policy , rule , resourceNs , kind , resource string ) string {
2021-10-01 14:16:33 +05:30
var resultKey string
resultKey = fmt . Sprintf ( "%s-%s-%s-%s" , policy , rule , kind , resource )
2021-10-01 22:43:21 +05:30
if policyNs != "" && resourceNs != "" {
resultKey = fmt . Sprintf ( "%s-%s-%s-%s-%s-%s" , policyNs , policy , rule , resourceNs , kind , resource )
} else if policyNs != "" {
resultKey = fmt . Sprintf ( "%s-%s-%s-%s-%s" , policyNs , policy , rule , kind , resource )
} else if resourceNs != "" {
resultKey = fmt . Sprintf ( "%s-%s-%s-%s-%s" , policy , rule , resourceNs , kind , resource )
2021-10-01 14:16:33 +05:30
}
return resultKey
}
func isNamespacedPolicy ( policyNames string ) ( bool , error ) {
return regexp . MatchString ( "^[a-z]*/[a-z]*" , policyNames )
}
func getUserDefinedPolicyNameAndNamespace ( policyName string ) ( string , string ) {
2021-10-01 22:54:10 +05:30
if strings . Contains ( policyName , "/" ) {
2021-10-29 16:06:03 +01:00
parts := strings . Split ( policyName , "/" )
namespace := parts [ 0 ]
policy := parts [ 1 ]
2021-10-01 22:54:10 +05:30
return namespace , policy
}
return "" , policyName
2021-10-01 14:16:33 +05:30
}
2022-05-25 19:56:22 +05:30
// getAndCompareResource --> Get the patchedResource or generatedResource from the path provided by user
// And compare this resource with engine generated resource.
func getAndCompareResource ( path string , engineResource unstructured . Unstructured , isGit bool , policyResourcePath string , fs billy . Filesystem , isGenerate bool ) string {
2021-10-01 14:16:33 +05:30
var status string
2022-05-25 19:56:22 +05:30
resourceType := "patchedResource"
if isGenerate {
resourceType = "generatedResource"
}
userResource , err := common . GetResourceFromPath ( fs , path , isGit , policyResourcePath , resourceType )
2021-10-01 14:16:33 +05:30
if err != nil {
2022-07-06 13:24:28 +05:30
fmt . Printf ( "Error: failed to load resources\nCause: %s\n" , err )
return ""
2021-10-01 14:16:33 +05:30
}
2022-05-25 19:56:22 +05:30
matched , err := generate . ValidateResourceWithPattern ( log . Log , engineResource . UnstructuredContent ( ) , userResource . UnstructuredContent ( ) )
2021-10-01 14:16:33 +05:30
if err != nil {
2022-05-25 19:56:22 +05:30
log . Log . V ( 3 ) . Info ( resourceType + " mismatch" , "error" , err . Error ( ) )
2021-10-01 14:16:33 +05:30
status = "fail"
}
2022-01-23 05:54:22 -08:00
2021-10-01 14:16:33 +05:30
if matched == "" {
status = "pass"
}
return status
}
2021-10-03 01:31:05 -07:00
func buildMessage ( resp * response . EngineResponse ) string {
var bldr strings . Builder
for _ , ruleResp := range resp . PolicyResponse . Rules {
fmt . Fprintf ( & bldr , " %s: %s \n" , ruleResp . Name , ruleResp . Status . String ( ) )
fmt . Fprintf ( & bldr , " %s \n" , ruleResp . Message )
}
return bldr . String ( )
}
2021-10-01 17:52:23 +05:30
func getFullPath ( paths [ ] string , policyResourcePath string , isGit bool ) [ ] string {
var pols [ ] string
2021-10-01 14:16:33 +05:30
var pol string
if ! isGit {
2021-10-01 17:52:23 +05:30
for _ , path := range paths {
pol = filepath . Join ( policyResourcePath , path )
pols = append ( pols , pol )
}
return pols
2021-10-01 14:16:33 +05:30
}
2021-10-01 17:52:23 +05:30
return paths
2021-10-01 14:16:33 +05:30
}
2022-03-09 13:10:53 +05:30
func applyPoliciesFromPath ( fs billy . Filesystem , policyBytes [ ] byte , isGit bool , policyResourcePath string , rc * resultCounts , openAPIController * openapi . Controller , tf * testFilter ) ( err error ) {
2021-10-01 14:16:33 +05:30
engineResponses := make ( [ ] * response . EngineResponse , 0 )
2022-05-17 16:40:51 +02:00
var dClient dclient . Interface
2021-02-01 16:22:41 +05:30
values := & Test { }
2021-02-02 18:43:19 +05:30
var variablesString string
2021-09-02 18:15:22 +05:30
var pvInfos [ ] policyreport . Info
2021-09-02 23:11:35 +05:30
var resultCounts common . ResultCounts
2021-02-01 16:22:41 +05:30
2022-04-12 09:30:49 +05:30
store . SetMock ( true )
2021-02-01 16:22:41 +05:30
if err := json . Unmarshal ( policyBytes , values ) ; err != nil {
return sanitizederror . NewWithError ( "failed to decode yaml" , err )
2021-02-07 20:26:56 -08:00
}
2021-02-18 01:00:41 +05:30
2022-03-09 13:10:53 +05:30
if tf . enabled {
var filteredResults [ ] TestResults
for _ , res := range values . Results {
if ( len ( tf . policy ) == 0 || tf . policy == res . Policy ) && ( len ( tf . resource ) == 0 || tf . resource == res . Resource ) && ( len ( tf . rule ) == 0 || tf . rule == res . Rule ) {
filteredResults = append ( filteredResults , res )
}
}
values . Results = filteredResults
}
if len ( values . Results ) == 0 {
return nil
}
2021-02-18 01:00:41 +05:30
fmt . Printf ( "\nExecuting %s..." , values . Name )
2022-03-09 13:10:53 +05:30
valuesFile := values . Variables
2022-04-12 09:30:49 +05:30
userInfoFile := values . UserInfo
2021-09-20 22:16:57 +05:30
variables , globalValMap , valuesMap , namespaceSelectorMap , err := common . GetVariable ( variablesString , values . Variables , fs , isGit , policyResourcePath )
2021-02-01 16:22:41 +05:30
if err != nil {
if ! sanitizederror . IsErrorSanitized ( err ) {
2021-02-07 20:26:56 -08:00
return sanitizederror . NewWithError ( "failed to decode yaml" , err )
2021-02-01 16:22:41 +05:30
}
2021-02-07 20:26:56 -08:00
return err
2021-02-01 16:22:41 +05:30
}
2021-02-18 01:00:41 +05:30
2022-04-12 09:30:49 +05:30
// get the user info as request info from a different file
2022-04-25 20:20:40 +08:00
var userInfo v1beta1 . RequestInfo
2022-05-11 20:51:13 +05:30
var subjectInfo store . Subject
2022-04-12 09:30:49 +05:30
if userInfoFile != "" {
2022-05-11 20:51:13 +05:30
userInfo , subjectInfo , err = common . GetUserInfoFromPath ( fs , userInfoFile , isGit , policyResourcePath )
2022-04-12 09:30:49 +05:30
if err != nil {
fmt . Printf ( "Error: failed to load request info\nCause: %s\n" , err )
os . Exit ( 1 )
}
2022-05-11 20:51:13 +05:30
store . SetSubjects ( subjectInfo )
2022-04-12 09:30:49 +05:30
}
2021-10-01 17:52:23 +05:30
policyFullPath := getFullPath ( values . Policies , policyResourcePath , isGit )
resourceFullPath := getFullPath ( values . Resources , policyResourcePath , isGit )
2021-02-18 01:00:41 +05:30
2021-10-01 14:16:33 +05:30
for i , result := range values . Results {
2021-10-01 17:52:23 +05:30
arrPatchedResource := [ ] string { result . PatchedResource }
2022-05-25 19:56:22 +05:30
arrGeneratedResource := [ ] string { result . GeneratedResource }
arrCloneSourceResource := [ ] string { result . CloneSourceResource }
2021-10-01 17:52:23 +05:30
patchedResourceFullPath := getFullPath ( arrPatchedResource , policyResourcePath , isGit )
2022-05-25 19:56:22 +05:30
generatedResourceFullPath := getFullPath ( arrGeneratedResource , policyResourcePath , isGit )
CloneSourceResourceFullPath := getFullPath ( arrCloneSourceResource , policyResourcePath , isGit )
2021-10-01 17:52:23 +05:30
values . Results [ i ] . PatchedResource = patchedResourceFullPath [ 0 ]
2022-05-25 19:56:22 +05:30
values . Results [ i ] . GeneratedResource = generatedResourceFullPath [ 0 ]
values . Results [ i ] . CloneSourceResource = CloneSourceResourceFullPath [ 0 ]
2021-10-01 14:16:33 +05:30
}
2021-10-01 17:52:23 +05:30
policies , err := common . GetPoliciesFromPaths ( fs , policyFullPath , isGit , policyResourcePath )
2021-02-01 16:22:41 +05:30
if err != nil {
fmt . Printf ( "Error: failed to load policies\nCause: %s\n" , err )
os . Exit ( 1 )
}
2021-07-09 18:01:46 -07:00
2022-05-17 13:12:43 +02:00
filteredPolicies := [ ] kyvernov1 . PolicyInterface { }
2022-03-09 13:10:53 +05:30
for _ , p := range policies {
for _ , res := range values . Results {
2022-03-31 08:44:00 +02:00
if p . GetName ( ) == res . Policy {
2022-03-09 13:10:53 +05:30
filteredPolicies = append ( filteredPolicies , p )
break
}
}
}
2022-05-25 19:56:22 +05:30
var ruleToCloneSourceResource = map [ string ] string { }
2022-03-09 13:10:53 +05:30
for _ , p := range filteredPolicies {
2022-05-17 13:12:43 +02:00
filteredRules := [ ] kyvernov1 . Rule { }
2022-03-09 13:10:53 +05:30
2022-03-28 16:01:27 +02:00
for _ , rule := range autogen . ComputeRules ( p ) {
2022-03-09 13:10:53 +05:30
for _ , res := range values . Results {
if rule . Name == res . Rule {
filteredRules = append ( filteredRules , rule )
2022-05-25 19:56:22 +05:30
if rule . HasGenerate ( ) {
ruleUnstr , err := generate . GetUnstrRule ( rule . Generation . DeepCopy ( ) )
if err != nil {
fmt . Printf ( "Error: failed to get unstructured rule\nCause: %s\n" , err )
break
}
genClone , _ , err := unstructured . NestedMap ( ruleUnstr . Object , "clone" )
if err != nil {
fmt . Printf ( "Error: failed to read data\nCause: %s\n" , err )
break
}
if len ( genClone ) != 0 {
ruleToCloneSourceResource [ rule . Name ] = res . CloneSourceResource
}
}
2022-03-09 13:10:53 +05:30
break
}
}
}
2022-03-31 08:44:00 +02:00
p . GetSpec ( ) . SetRules ( filteredRules )
2022-03-09 13:10:53 +05:30
}
policies = filteredPolicies
2022-03-18 17:16:42 +01:00
mutatedPolicies , err := common . MutatePolicies ( policies )
2021-02-07 20:26:56 -08:00
if err != nil {
2021-02-01 16:22:41 +05:30
if ! sanitizederror . IsErrorSanitized ( err ) {
2021-02-07 20:26:56 -08:00
return sanitizederror . NewWithError ( "failed to mutate policy" , err )
2021-02-01 16:22:41 +05:30
}
2021-02-07 20:26:56 -08:00
}
2021-07-09 18:01:46 -07:00
2021-09-03 16:41:13 +05:30
err = common . PrintMutatedPolicy ( mutatedPolicies )
if err != nil {
return sanitizederror . NewWithError ( "failed to print mutated policy" , err )
2021-09-02 23:11:35 +05:30
}
2021-09-03 16:41:13 +05:30
2021-10-01 17:52:23 +05:30
resources , err := common . GetResourceAccordingToResourcePath ( fs , resourceFullPath , false , mutatedPolicies , dClient , "" , false , isGit , policyResourcePath )
2021-02-07 20:26:56 -08:00
if err != nil {
fmt . Printf ( "Error: failed to load resources\nCause: %s\n" , err )
os . Exit ( 1 )
}
2021-07-09 18:01:46 -07:00
2022-05-17 08:19:03 +02:00
filteredResources := [ ] * unstructured . Unstructured { }
2022-03-09 13:10:53 +05:30
for _ , r := range resources {
for _ , res := range values . Results {
2022-06-20 12:08:13 +05:30
for _ , testr := range res . Resources {
if r . GetName ( ) == testr {
filteredResources = append ( filteredResources , r )
}
}
2022-03-09 13:10:53 +05:30
if r . GetName ( ) == res . Resource {
filteredResources = append ( filteredResources , r )
break
}
}
}
resources = filteredResources
2021-02-07 20:26:56 -08:00
msgPolicies := "1 policy"
if len ( mutatedPolicies ) > 1 {
msgPolicies = fmt . Sprintf ( "%d policies" , len ( policies ) )
}
2021-07-09 18:01:46 -07:00
2021-02-07 20:26:56 -08:00
msgResources := "1 resource"
if len ( resources ) > 1 {
msgResources = fmt . Sprintf ( "%d resources" , len ( resources ) )
}
2021-07-09 18:01:46 -07:00
2021-02-07 20:26:56 -08:00
if len ( mutatedPolicies ) > 0 && len ( resources ) > 0 {
fmt . Printf ( "\napplying %s to %s... \n" , msgPolicies , msgResources )
}
2021-07-09 18:01:46 -07:00
2021-02-07 20:26:56 -08:00
for _ , policy := range mutatedPolicies {
2022-03-16 00:50:33 -04:00
_ , err := policy2 . Validate ( policy , nil , true , openAPIController )
2021-02-01 16:22:41 +05:30
if err != nil {
2022-03-31 08:44:00 +02:00
log . Log . Error ( err , "skipping invalid policy" , "name" , policy . GetName ( ) )
2021-02-07 20:26:56 -08:00
continue
2021-02-01 16:22:41 +05:30
}
2021-07-09 18:01:46 -07:00
2021-11-03 11:16:55 -07:00
matches := common . HasVariables ( policy )
2021-07-24 00:02:48 +05:30
variable := common . RemoveDuplicateAndObjectVariables ( matches )
2021-09-03 18:43:11 +05:30
if len ( variable ) > 0 {
if len ( variables ) == 0 {
// check policy in variable file
2022-03-31 08:44:00 +02:00
if valuesFile == "" || valuesMap [ policy . GetName ( ) ] == nil {
fmt . Printf ( "test skipped for policy %v (as required variables are not provided by the users) \n \n" , policy . GetName ( ) )
2021-09-03 18:43:11 +05:30
}
}
}
2021-09-03 16:41:13 +05:30
kindOnwhichPolicyIsApplied := common . GetKindsFromPolicy ( policy )
2021-09-02 23:11:35 +05:30
2021-02-07 20:26:56 -08:00
for _ , resource := range resources {
2021-09-20 22:16:57 +05:30
thisPolicyResourceValues , err := common . CheckVariableForPolicy ( valuesMap , globalValMap , policy . GetName ( ) , resource . GetName ( ) , resource . GetKind ( ) , variables , kindOnwhichPolicyIsApplied , variable )
2021-09-03 16:41:13 +05:30
if err != nil {
2022-03-31 08:44:00 +02:00
return sanitizederror . NewWithError ( fmt . Sprintf ( "policy `%s` have variables. pass the values for the variables for resource `%s` using set/values_file flag" , policy . GetName ( ) , resource . GetName ( ) ) , err )
2021-02-01 16:22:41 +05:30
}
2021-02-07 20:26:56 -08:00
2022-05-25 19:56:22 +05:30
ers , info , err := common . ApplyPolicyOnResource ( policy , resource , "" , false , thisPolicyResourceValues , userInfo , true , namespaceSelectorMap , false , & resultCounts , false , ruleToCloneSourceResource )
2021-02-07 20:26:56 -08:00
if err != nil {
2022-03-31 08:44:00 +02:00
return sanitizederror . NewWithError ( fmt . Errorf ( "failed to apply policy %v on resource %v" , policy . GetName ( ) , resource . GetName ( ) ) . Error ( ) , err )
2021-02-01 16:22:41 +05:30
}
2021-10-01 17:52:23 +05:30
engineResponses = append ( engineResponses , ers ... )
2021-09-02 18:15:22 +05:30
pvInfos = append ( pvInfos , info )
2021-02-01 16:22:41 +05:30
}
2021-02-07 20:26:56 -08:00
}
2021-10-01 14:16:33 +05:30
resultsMap , testResults := buildPolicyResults ( engineResponses , values . Results , pvInfos , policyResourcePath , fs , isGit )
2021-09-07 20:23:03 +05:30
resultErr := printTestResult ( resultsMap , testResults , rc )
2021-02-07 20:26:56 -08:00
if resultErr != nil {
2021-10-03 22:36:06 -07:00
return sanitizederror . NewWithError ( "failed to print test result:" , resultErr )
2021-02-07 20:26:56 -08:00
}
2021-10-03 22:36:06 -07:00
2021-02-01 16:22:41 +05:30
return
}
2022-05-17 13:12:43 +02:00
func printTestResult ( resps map [ string ] policyreportv1alpha2 . PolicyReportResult , testResults [ ] TestResults , rc * resultCounts ) error {
2021-02-01 16:22:41 +05:30
printer := tableprinter . New ( os . Stdout )
2022-06-20 12:08:13 +05:30
table := [ ] Table { }
2021-05-07 19:27:15 -04:00
boldGreen := color . New ( color . FgGreen ) . Add ( color . Bold )
2021-02-01 16:22:41 +05:30
boldRed := color . New ( color . FgRed ) . Add ( color . Bold )
2021-05-03 08:55:04 -04:00
boldYellow := color . New ( color . FgYellow ) . Add ( color . Bold )
2021-02-01 16:22:41 +05:30
boldFgCyan := color . New ( color . FgCyan ) . Add ( color . Bold )
2021-10-01 22:43:21 +05:30
2022-06-20 12:08:13 +05:30
countDeprecatedResource := 0
2021-02-01 16:22:41 +05:30
for i , v := range testResults {
res := new ( Table )
2021-02-07 20:26:56 -08:00
res . ID = i + 1
2021-09-02 23:11:35 +05:30
res . Policy = boldFgCyan . Sprintf ( v . Policy )
res . Rule = boldFgCyan . Sprintf ( v . Rule )
2021-10-01 22:43:21 +05:30
2022-06-20 12:08:13 +05:30
if v . Resources != nil {
for _ , resource := range v . Resources {
res . Resource = boldFgCyan . Sprintf ( v . Namespace ) + "/" + boldFgCyan . Sprintf ( v . Kind ) + "/" + boldFgCyan . Sprintf ( resource )
var ruleNameInResultKey string
if v . AutoGeneratedRule != "" {
ruleNameInResultKey = fmt . Sprintf ( "%s-%s" , v . AutoGeneratedRule , v . Rule )
} else {
ruleNameInResultKey = v . Rule
}
2021-10-01 22:43:21 +05:30
2022-06-20 12:08:13 +05:30
resultKey := fmt . Sprintf ( "%s-%s-%s-%s" , v . Policy , ruleNameInResultKey , v . Kind , resource )
found , _ := isNamespacedPolicy ( v . Policy )
var ns string
ns , v . Policy = getUserDefinedPolicyNameAndNamespace ( v . Policy )
if found && v . Namespace != "" {
resultKey = fmt . Sprintf ( "%s-%s-%s-%s-%s-%s" , ns , v . Policy , ruleNameInResultKey , v . Namespace , v . Kind , resource )
} else if found {
resultKey = fmt . Sprintf ( "%s-%s-%s-%s-%s" , ns , v . Policy , ruleNameInResultKey , v . Kind , resource )
res . Policy = boldFgCyan . Sprintf ( ns ) + "/" + boldFgCyan . Sprintf ( v . Policy )
res . Resource = boldFgCyan . Sprintf ( v . Namespace ) + "/" + boldFgCyan . Sprintf ( v . Kind ) + "/" + boldFgCyan . Sprintf ( resource )
} else if v . Namespace != "" {
res . Resource = boldFgCyan . Sprintf ( v . Namespace ) + "/" + boldFgCyan . Sprintf ( v . Kind ) + "/" + boldFgCyan . Sprintf ( resource )
resultKey = fmt . Sprintf ( "%s-%s-%s-%s-%s" , v . Policy , ruleNameInResultKey , v . Namespace , v . Kind , resource )
}
var testRes policyreportv1alpha2 . PolicyReportResult
if val , ok := resps [ resultKey ] ; ok {
testRes = val
} else {
log . Log . V ( 2 ) . Info ( "result not found" , "key" , resultKey )
res . Result = boldYellow . Sprintf ( "Not found" )
rc . Fail ++
table = append ( table , * res )
ftable = append ( ftable , * res )
continue
}
if v . Result == "" && v . Status != "" {
v . Result = v . Status
}
if testRes . Result == v . Result {
res . Result = boldGreen . Sprintf ( "Pass" )
if testRes . Result == policyreportv1alpha2 . StatusSkip {
res . Result = boldGreen . Sprintf ( "Pass" )
rc . Skip ++
} else {
res . Result = boldGreen . Sprintf ( "Pass" )
rc . Pass ++
}
} else {
log . Log . V ( 2 ) . Info ( "result mismatch" , "expected" , v . Result , "received" , testRes . Result , "key" , resultKey )
res . Result = boldRed . Sprintf ( "Fail" )
rc . Fail ++
ftable = append ( ftable , * res )
}
table = append ( table , * res )
}
} else if v . Resource != "" {
countDeprecatedResource ++
2022-06-15 17:59:13 +05:30
res . Resource = boldFgCyan . Sprintf ( v . Namespace ) + "/" + boldFgCyan . Sprintf ( v . Kind ) + "/" + boldFgCyan . Sprintf ( v . Resource )
2022-06-20 12:08:13 +05:30
var ruleNameInResultKey string
if v . AutoGeneratedRule != "" {
ruleNameInResultKey = fmt . Sprintf ( "%s-%s" , v . AutoGeneratedRule , v . Rule )
} else {
ruleNameInResultKey = v . Rule
}
2021-10-01 22:43:21 +05:30
2022-06-20 12:08:13 +05:30
resultKey := fmt . Sprintf ( "%s-%s-%s-%s" , v . Policy , ruleNameInResultKey , v . Kind , v . Resource )
found , _ := isNamespacedPolicy ( v . Policy )
var ns string
ns , v . Policy = getUserDefinedPolicyNameAndNamespace ( v . Policy )
if found && v . Namespace != "" {
resultKey = fmt . Sprintf ( "%s-%s-%s-%s-%s-%s" , ns , v . Policy , ruleNameInResultKey , v . Namespace , v . Kind , v . Resource )
} else if found {
resultKey = fmt . Sprintf ( "%s-%s-%s-%s-%s" , ns , v . Policy , ruleNameInResultKey , v . Kind , v . Resource )
res . Policy = boldFgCyan . Sprintf ( ns ) + "/" + boldFgCyan . Sprintf ( v . Policy )
res . Resource = boldFgCyan . Sprintf ( v . Namespace ) + "/" + boldFgCyan . Sprintf ( v . Kind ) + "/" + boldFgCyan . Sprintf ( v . Resource )
} else if v . Namespace != "" {
res . Resource = boldFgCyan . Sprintf ( v . Namespace ) + "/" + boldFgCyan . Sprintf ( v . Kind ) + "/" + boldFgCyan . Sprintf ( v . Resource )
resultKey = fmt . Sprintf ( "%s-%s-%s-%s-%s" , v . Policy , ruleNameInResultKey , v . Namespace , v . Kind , v . Resource )
}
2021-10-01 22:43:21 +05:30
2022-06-20 12:08:13 +05:30
var testRes policyreportv1alpha2 . PolicyReportResult
if val , ok := resps [ resultKey ] ; ok {
testRes = val
} else {
log . Log . V ( 2 ) . Info ( "result not found" , "key" , resultKey )
res . Result = boldYellow . Sprintf ( "Not found" )
rc . Fail ++
table = append ( table , * res )
ftable = append ( ftable , * res )
continue
}
if v . Result == "" && v . Status != "" {
v . Result = v . Status
}
2021-10-01 22:43:21 +05:30
2022-06-20 12:08:13 +05:30
if testRes . Result == v . Result {
2021-10-04 10:24:39 +05:30
res . Result = boldGreen . Sprintf ( "Pass" )
2022-06-20 12:08:13 +05:30
if testRes . Result == policyreportv1alpha2 . StatusSkip {
res . Result = boldGreen . Sprintf ( "Pass" )
rc . Skip ++
} else {
res . Result = boldGreen . Sprintf ( "Pass" )
rc . Pass ++
}
2021-05-07 19:27:15 -04:00
} else {
2022-06-20 12:08:13 +05:30
log . Log . V ( 2 ) . Info ( "result mismatch" , "expected" , v . Result , "received" , testRes . Result , "key" , resultKey )
res . Result = boldRed . Sprintf ( "Fail" )
rc . Fail ++
ftable = append ( ftable , * res )
2021-02-01 16:22:41 +05:30
}
2021-10-01 22:43:21 +05:30
2022-06-20 12:08:13 +05:30
table = append ( table , * res )
}
2021-02-07 20:26:56 -08:00
}
2021-10-01 22:43:21 +05:30
2022-06-20 12:08:13 +05:30
if countDeprecatedResource > 0 {
fmt . Printf ( "\n Note : The resource field is being deprecated in 1.8.0 release. Please provide the resources under the resources parameter as an array in the results field \n" )
}
2021-02-01 16:22:41 +05:30
printer . BorderTop , printer . BorderBottom , printer . BorderLeft , printer . BorderRight = true , true , true , true
printer . CenterSeparator = "│"
printer . ColumnSeparator = "│"
printer . RowSeparator = "─"
printer . RowCharLimit = 300
2021-02-07 20:26:56 -08:00
printer . RowLengthTitle = func ( rowsLength int ) bool {
2021-02-01 16:22:41 +05:30
return rowsLength > 10
}
2021-10-01 22:43:21 +05:30
2021-02-01 16:22:41 +05:30
printer . HeaderBgColor = tablewriter . BgBlackColor
printer . HeaderFgColor = tablewriter . FgGreenColor
2021-10-01 14:16:33 +05:30
fmt . Printf ( "\n" )
2021-02-01 16:22:41 +05:30
printer . Print ( table )
return nil
2021-02-07 20:26:56 -08:00
}
2022-06-02 23:01:46 +05:30
func printFailedTestResult ( ) {
printer := tableprinter . New ( os . Stdout )
for i , v := range ftable {
v . ID = i + 1
}
fmt . Printf ( "Aggregated Failed Test Cases : " )
printer . BorderTop , printer . BorderBottom , printer . BorderLeft , printer . BorderRight = true , true , true , true
printer . CenterSeparator = "│"
printer . ColumnSeparator = "│"
printer . RowSeparator = "─"
printer . RowCharLimit = 300
printer . RowLengthTitle = func ( rowsLength int ) bool {
return rowsLength > 10
}
printer . HeaderBgColor = tablewriter . BgBlackColor
printer . HeaderFgColor = tablewriter . FgGreenColor
fmt . Printf ( "\n" )
printer . Print ( ftable )
}