Skip to content

Commit

Permalink
cover: Disable local var plugging on trace
Browse files Browse the repository at this point in the history
Similar treatment as what we do with the `Profiler`, the coverage
tracer will now signal via configuration that it doesn't need local
variable metadata.

This improves the speed of evaluations with only coverage enabled by
a pretty substantial amount, in particular with many/larger variables.

Signed-off-by: Patrick East <east.patrick@gmail.com>
  • Loading branch information
patrick-east committed May 21, 2020
1 parent 837011c commit dff78c4
Show file tree
Hide file tree
Showing 3 changed files with 100 additions and 0 deletions.
7 changes: 7 additions & 0 deletions cover/cover.go
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,13 @@ func (c *Cover) Enabled() bool {
return true
}

// Config returns the standard Tracer configuration for the Cover tracer
func (c *Cover) Config() topdown.TraceConfig {
return topdown.TraceConfig{
PlugLocalVars: false, // Event variable metadata is not required for the Coverage report
}
}

// Report returns a coverage Report for the given modules.
func (c *Cover) Report(modules map[string]*ast.Module) (report Report) {
report.Files = map[string]*FileReport{}
Expand Down
78 changes: 78 additions & 0 deletions cover/cover_bench_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
// Copyright 2020 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 cover

import (
"context"
"fmt"
"strings"
"testing"

"github.com/open-policy-agent/opa/ast"
"github.com/open-policy-agent/opa/rego"
)

func BenchmarkCoverBigLocalVar(b *testing.B) {
iterations := []int{1, 100, 1000}
vars := []int{1, 10}

for _, iterationCount := range iterations {
for _, varCount := range vars {
name := fmt.Sprintf("%dVars%dIterations", varCount, iterationCount)
b.Run(name, func(b *testing.B) {
cover := New()
module := generateModule(varCount, iterationCount)

_, err := ast.ParseModule("test.rego", module)
if err != nil {
b.Fatal(err)
}

ctx := context.Background()

pq, err := rego.New(
rego.Module("test.rego", module),
rego.Query("data.test.p"),
).PrepareForEval(ctx)

if err != nil {
b.Fatal(err)
}

b.ResetTimer()

for i := 0; i < b.N; i++ {
b.StartTimer()
_, err = pq.Eval(ctx, rego.EvalTracer(cover))
b.StopTimer()

if err != nil {
b.Fatal(err)
}
}
})
}
}
}

func generateModule(numVars int, dataSize int) string {
sb := strings.Builder{}
sb.WriteString(`package test
p {
x := a
v := x[i]
`)
for i := 0; i < numVars; i++ {
sb.WriteString(fmt.Sprintf("\tv%d := x[i+%d]\n", i, i))
}
sb.WriteString("\tfalse\n}\n")
sb.WriteString("\na := [\n")
for i := 0; i < dataSize; i++ {
sb.WriteString(fmt.Sprintf("\t%d,\n", i))
}
sb.WriteString("]\n")
return sb.String()
}
15 changes: 15 additions & 0 deletions cover/cover_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,12 @@ import (
"context"
"encoding/json"
"fmt"
"reflect"
"testing"

"github.com/open-policy-agent/opa/ast"
"github.com/open-policy-agent/opa/rego"
"github.com/open-policy-agent/opa/topdown"
)

func TestCover(t *testing.T) {
Expand Down Expand Up @@ -136,3 +138,16 @@ p {
fmt.Println(string(bs))
}
}

func TestCoverTraceConfig(t *testing.T) {
ct := topdown.CustomTracer(New())
conf := ct.Config()

expected := topdown.TraceConfig{
PlugLocalVars: false,
}

if !reflect.DeepEqual(expected, conf) {
t.Fatalf("Expected config: %+v, got %+v", expected, conf)
}
}

0 comments on commit dff78c4

Please sign in to comment.