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

Jump to bottom

Refactor out backend code #198

Merged
merged 3 commits into from
Feb 10, 2022
Merged

Refactor out backend code #198

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d8fb2d9
Refactor out backend code
Feb 8, 2022
24e707e
Fix lint errors
Feb 8, 2022
b22e758
:Merge branch 'master' into no-backend
Feb 10, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
88 changes: 0 additions & 88 deletions constraint/pkg/client/backend.go
View file
Open in desktop

This file was deleted.

98 changes: 0 additions & 98 deletions constraint/pkg/client/backend_test.go
View file
Open in desktop

This file was deleted.

34 changes: 17 additions & 17 deletions constraint/pkg/client/client.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ type templateEntry struct {
}

type Client struct {
backend *Backend
driver drivers.Driver
targets map[string]handler.TargetHandler

// mtx guards access to both templates and constraints.
Expand Down Expand Up @@ -69,7 +69,7 @@ func (c *Client) AddData(ctx context.Context, data interface{}) (*types.Response
if !handled {
continue
}
if err := c.backend.driver.PutData(ctx, createDataPath(target, relPath), processedData); err != nil {
if err := c.driver.PutData(ctx, createDataPath(target, relPath), processedData); err != nil {
errMap[target] = err
continue
}
Expand All @@ -96,7 +96,7 @@ func (c *Client) RemoveData(ctx context.Context, data interface{}) (*types.Respo
if !handled {
continue
}
if _, err := c.backend.driver.DeleteData(ctx, createDataPath(target, relPath)); err != nil {
if _, err := c.driver.DeleteData(ctx, createDataPath(target, relPath)); err != nil {
errMap[target] = err
continue
}
Expand Down Expand Up @@ -268,11 +268,11 @@ func (c *Client) ValidateConstraintTemplate(templ *templates.ConstraintTemplate)
if _, _, err := c.ValidateConstraintTemplateBasic(templ); err != nil {
return err
}
if dr, ok := c.backend.driver.(*local.Driver); ok {
if dr, ok := c.driver.(*local.Driver); ok {
_, _, err := dr.ValidateConstraintTemplate(templ)
return err
}
return fmt.Errorf("driver %T is not supported", c.backend.driver)
return fmt.Errorf("driver %T is not supported", c.driver)
}

// AddTemplate adds the template source code to OPA and registers the CRD with the client for
Expand All @@ -295,7 +295,7 @@ func (c *Client) AddTemplate(templ *templates.ConstraintTemplate) (*types.Respon
c.mtx.Lock()
defer c.mtx.Unlock()

if err = c.backend.driver.AddTemplate(templ); err != nil {
if err = c.driver.AddTemplate(templ); err != nil {
return resp, err
}
cpy := templ.DeepCopy()
Expand Down Expand Up @@ -341,7 +341,7 @@ func (c *Client) RemoveTemplate(ctx context.Context, templ *templates.Constraint
return resp, err
}

if err := c.backend.driver.RemoveTemplate(templ); err != nil {
if err := c.driver.RemoveTemplate(templ); err != nil {
return resp, err
}

Expand All @@ -353,7 +353,7 @@ func (c *Client) RemoveTemplate(ctx context.Context, templ *templates.Constraint
delete(c.constraints, artifacts.gk)
// Also clean up root path to avoid memory leaks
constraintRoot := createConstraintGKPath(artifacts.targetHandler.GetName(), artifacts.gk)
if _, err := c.backend.driver.DeleteData(ctx, constraintRoot); err != nil {
if _, err := c.driver.DeleteData(ctx, constraintRoot); err != nil {
return resp, err
}
delete(c.templates, artifacts.Key())
Expand Down Expand Up @@ -484,7 +484,7 @@ func (c *Client) AddConstraint(ctx context.Context, constraint *unstructured.Uns
if err := c.validateConstraint(constraint, false); err != nil {
return resp, err
}
if err := c.backend.driver.AddConstraint(ctx, constraint); err != nil {
if err := c.driver.AddConstraint(ctx, constraint); err != nil {
return resp, err
}
for _, target := range entry.Targets {
Expand Down Expand Up @@ -513,7 +513,7 @@ func (c *Client) removeConstraintNoLock(ctx context.Context, constraint *unstruc
if err != nil {
return resp, err
}
if err := c.backend.driver.RemoveConstraint(ctx, constraint); err != nil {
if err := c.driver.RemoveConstraint(ctx, constraint); err != nil {
return resp, err
}
for _, target := range entry.Targets {
Expand Down Expand Up @@ -584,7 +584,7 @@ func (c *Client) init() error {
}

builtinPath := fmt.Sprintf("%s.hooks_builtin", hooks)
err := c.backend.driver.PutModule(builtinPath, libBuiltin.String())
err := c.driver.PutModule(builtinPath, libBuiltin.String())
if err != nil {
return err
}
Expand Down Expand Up @@ -633,20 +633,20 @@ func (c *Client) init() error {
ErrCreatingClient, err)
}

err = c.backend.driver.PutModule(modulePath, string(src))
err = c.driver.PutModule(modulePath, string(src))
if err != nil {
return fmt.Errorf("%w: error %s from compiled source:\n%s",
ErrCreatingClient, err, src)
}
}
if d, ok := c.backend.driver.(*local.Driver); ok {
if d, ok := c.driver.(*local.Driver); ok {
var externs []string
for _, field := range c.AllowedDataFields {
externs = append(externs, fmt.Sprintf("data.%s", field))
}
d.SetExterns(externs)
} else {
return fmt.Errorf("%w: driver %T is not supported", ErrCreatingClient, c.backend.driver)
return fmt.Errorf("%w: driver %T is not supported", ErrCreatingClient, c.driver)
}
return nil
}
Expand All @@ -673,7 +673,7 @@ TargetLoop:
continue
}
input := map[string]interface{}{"review": review}
resp, err := c.backend.driver.Query(ctx, fmt.Sprintf(`hooks["%s"].violation`, name), input, drivers.Tracing(cfg.enableTracing))
resp, err := c.driver.Query(ctx, fmt.Sprintf(`hooks["%s"].violation`, name), input, drivers.Tracing(cfg.enableTracing))
if err != nil {
errMap[name] = err
continue
Expand Down Expand Up @@ -706,7 +706,7 @@ func (c *Client) Audit(ctx context.Context, opts ...QueryOpt) (*types.Responses,
TargetLoop:
for name, target := range c.targets {
// Short-circuiting question applies here as well
resp, err := c.backend.driver.Query(ctx, fmt.Sprintf(`hooks["%s"].audit`, name), nil, drivers.Tracing(cfg.enableTracing))
resp, err := c.driver.Query(ctx, fmt.Sprintf(`hooks["%s"].audit`, name), nil, drivers.Tracing(cfg.enableTracing))
if err != nil {
errMap[name] = err
continue
Expand All @@ -728,7 +728,7 @@ TargetLoop:

// Dump dumps the state of OPA to aid in debugging.
func (c *Client) Dump(ctx context.Context) (string, error) {
return c.backend.driver.Dump(ctx)
return c.driver.Dump(ctx)
}

// knownTargets returns a sorted list of currently-known target names.
Expand Down
19 changes: 3 additions & 16 deletions constraint/pkg/client/client_addtemplate_bench_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,8 @@ import (
"fmt"
"testing"

"github.com/open-policy-agent/frameworks/constraint/pkg/client"
"github.com/open-policy-agent/frameworks/constraint/pkg/client/drivers/local"
"github.com/open-policy-agent/frameworks/constraint/pkg/client/clienttest"
"github.com/open-policy-agent/frameworks/constraint/pkg/core/templates"
"github.com/open-policy-agent/frameworks/constraint/pkg/handler/handlertest"
)

var modules = []struct {
Expand Down Expand Up @@ -80,24 +78,13 @@ func BenchmarkClient_AddTemplate(b *testing.B) {

for i := 0; i < b.N; i++ {
b.StopTimer()
targets := client.Targets(&handlertest.Handler{})

d := local.New()

backend, err := client.NewBackend(client.Driver(d))
if err != nil {
b.Fatal(err)
}

c, err := backend.NewClient(targets)
if err != nil {
b.Fatal(err)
}
c := clienttest.New(b)

b.StartTimer()

for _, ct := range cts {
_, err = c.AddTemplate(ct)
_, err := c.AddTemplate(ct)
if err != nil {
b.Fatal(err)
}
Expand Down