|
| 1 | +package validator |
| 2 | + |
| 3 | +import ( |
| 4 | + "bytes" |
| 5 | + "fmt" |
| 6 | + "log/slog" |
| 7 | + "testing" |
| 8 | + |
| 9 | + "github.com/mxab/nacp/pkg/admissionctrl/types" |
| 10 | + "github.com/mxab/nacp/testutil" |
| 11 | + "github.com/open-policy-agent/opa/v1/logging" |
| 12 | + "github.com/open-policy-agent/opa/v1/sdk" |
| 13 | + sdktest "github.com/open-policy-agent/opa/v1/sdk/test" |
| 14 | + "github.com/stretchr/testify/assert" |
| 15 | + "github.com/stretchr/testify/require" |
| 16 | +) |
| 17 | + |
| 18 | +func TestOpaBundleValidator(t *testing.T) { |
| 19 | + |
| 20 | + // https://www.openpolicyagent.org/docs/integration#integrating-with-the-go-sdk |
| 21 | + |
| 22 | + tt := []struct { |
| 23 | + name string |
| 24 | + policy string |
| 25 | + path string |
| 26 | + expectErrParts []string |
| 27 | + expectWarns []string |
| 28 | + }{ |
| 29 | + { |
| 30 | + name: "no issues", |
| 31 | + policy: `package mypolicy`, |
| 32 | + path: "/mypolicy", |
| 33 | + }, |
| 34 | + { |
| 35 | + name: "error", |
| 36 | + policy: `package mypolicy |
| 37 | + errors = ["an error message"]`, |
| 38 | + path: "/mypolicy", |
| 39 | + expectErrParts: []string{"an error message"}, |
| 40 | + }, |
| 41 | + { |
| 42 | + name: "multiple errors", |
| 43 | + policy: `package mypolicy |
| 44 | + errors = ["an error message", "another error message"]`, |
| 45 | + path: "/mypolicy", |
| 46 | + expectErrParts: []string{"an error message", "another error message"}, |
| 47 | + }, |
| 48 | + { |
| 49 | + name: "warning", |
| 50 | + policy: `package mypolicy |
| 51 | + warnings = ["a warning message"]`, |
| 52 | + path: "/mypolicy", |
| 53 | + expectWarns: []string{"a warning message"}, |
| 54 | + }, |
| 55 | + { |
| 56 | + name: "handle invalid errors value", |
| 57 | + policy: `package mypolicy |
| 58 | + errors = 5`, |
| 59 | + path: "/mypolicy", |
| 60 | + expectErrParts: []string{"policy yielded an invalid errors value"}, |
| 61 | + }, |
| 62 | + { |
| 63 | + name: "handle invalid error value", |
| 64 | + policy: `package mypolicy |
| 65 | + errors = [5]`, |
| 66 | + path: "/mypolicy", |
| 67 | + expectErrParts: []string{"policy yielded an invalid error value"}, |
| 68 | + }, |
| 69 | + { |
| 70 | + name: "handle invalid warnings value", |
| 71 | + policy: `package mypolicy |
| 72 | + warnings = 5`, |
| 73 | + path: "/mypolicy", |
| 74 | + expectWarns: []string{"policy yielded an invalid warnings value"}, |
| 75 | + }, |
| 76 | + { |
| 77 | + name: "handle invalid warnings value", |
| 78 | + policy: `package mypolicy |
| 79 | + warnings = [5]`, |
| 80 | + path: "/mypolicy", |
| 81 | + expectWarns: []string{"policy yielded an invalid warning value"}, |
| 82 | + }, |
| 83 | + { |
| 84 | + name: "test invalid policy path", |
| 85 | + policy: `package mypolicy |
| 86 | + errors = ["an error message"]`, |
| 87 | + path: "/invalidpath", |
| 88 | + expectErrParts: []string{"failed to perform policy decision"}, |
| 89 | + }, |
| 90 | + } |
| 91 | + |
| 92 | + for _, tc := range tt { |
| 93 | + t.Run(tc.name, func(t *testing.T) { |
| 94 | + job := testutil.BaseJob() |
| 95 | + |
| 96 | + opa := setupOpa(t, tc.policy) |
| 97 | + validator, err := NewOpaBundleValidator("testopabundlevalidator", tc.path, slog.New(slog.DiscardHandler), opa) |
| 98 | + |
| 99 | + require.NoError(t, err, "No error creating validator") |
| 100 | + |
| 101 | + warnings, err := validator.Validate(t.Context(), &types.Payload{Job: job}) |
| 102 | + |
| 103 | + if len(tc.expectErrParts) > 0 { |
| 104 | + for _, expectErrPart := range tc.expectErrParts { |
| 105 | + assert.ErrorContains(t, err, expectErrPart, "Error from validator") |
| 106 | + } |
| 107 | + } else { |
| 108 | + assert.NoError(t, err, "No error from validator") |
| 109 | + } |
| 110 | + |
| 111 | + // check warnings |
| 112 | + require.Len(t, warnings, len(tc.expectWarns), "Number of warnings from validator") |
| 113 | + for i, expectWarn := range tc.expectWarns { |
| 114 | + assert.ErrorContains(t, warnings[i], expectWarn, "Warning from validator") |
| 115 | + } |
| 116 | + |
| 117 | + }) |
| 118 | + } |
| 119 | +} |
| 120 | + |
| 121 | +func setupOpa(t *testing.T, policy string) *sdk.OPA { |
| 122 | + t.Helper() |
| 123 | + ctx := t.Context() |
| 124 | + |
| 125 | + // create a mock HTTP bundle server |
| 126 | + server, err := sdktest.NewServer(sdktest.MockBundle("/bundles/bundle.tar.gz", map[string]string{ |
| 127 | + "example.rego": policy, |
| 128 | + })) |
| 129 | + require.NoError(t, err, "No error creating mock server") |
| 130 | + t.Cleanup(server.Stop) |
| 131 | + |
| 132 | + // provide the OPA configuration which specifies |
| 133 | + // fetching policy bundles from the mock server |
| 134 | + // and logging decisions locally to the console |
| 135 | + config := []byte(fmt.Sprintf(`{ |
| 136 | + "services": { |
| 137 | + "test": { |
| 138 | + "url": %q |
| 139 | + } |
| 140 | + }, |
| 141 | + "bundles": { |
| 142 | + "test": { |
| 143 | + "resource": "/bundles/bundle.tar.gz" |
| 144 | + } |
| 145 | + }, |
| 146 | + "decision_logs": { |
| 147 | + "console": true |
| 148 | + } |
| 149 | + }`, server.URL())) |
| 150 | + |
| 151 | + // create an instance of the OPA object |
| 152 | + |
| 153 | + opa, err := sdk.New(ctx, sdk.Options{ |
| 154 | + ID: "opa-test-1", |
| 155 | + Config: bytes.NewReader(config), |
| 156 | + Logger: logging.New(), |
| 157 | + }) |
| 158 | + require.NoError(t, err, "No error creating OPA instance") |
| 159 | + t.Cleanup(func() { |
| 160 | + opa.Stop(ctx) |
| 161 | + }) |
| 162 | + |
| 163 | + return opa |
| 164 | +} |
| 165 | +func TestBundleValidatorName(t *testing.T) { |
| 166 | + opa := setupOpa(t, "package mypolicy") |
| 167 | + validator, err := NewOpaBundleValidator("testopabundlevalidator", "/mypolicy", slog.New(slog.DiscardHandler), opa) |
| 168 | + |
| 169 | + require.NoError(t, err, "No error creating validator") |
| 170 | + |
| 171 | + assert.Equal(t, "testopabundlevalidator", validator.Name(), "Validator name") |
| 172 | +} |
0 commit comments