-
Notifications
You must be signed in to change notification settings - Fork 35
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
lsp: Add package/rule ref completions (#739)
Signed-off-by: Charlie Egan <charlie@styra.com>
- Loading branch information
1 parent
f0875e3
commit 10aa4b7
Showing
23 changed files
with
1,239 additions
and
282 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
package ast | ||
|
||
import ( | ||
"strings" | ||
|
||
"github.com/open-policy-agent/opa/ast" | ||
) | ||
|
||
// RefToString converts an ast.Ref to a readable string, e.g. data.foo[bar]. | ||
func RefToString(ref ast.Ref) string { | ||
sb := strings.Builder{} | ||
|
||
for i, part := range ref { | ||
if part.IsGround() { | ||
if i > 0 { | ||
sb.WriteString(".") | ||
} | ||
|
||
sb.WriteString(strings.Trim(part.Value.String(), `"`)) | ||
} else { | ||
if i == 0 { | ||
sb.WriteString(strings.Trim(part.Value.String(), `"`)) | ||
} else { | ||
sb.WriteString("[") | ||
sb.WriteString(strings.Trim(part.Value.String(), `"`)) | ||
sb.WriteString("]") | ||
} | ||
} | ||
} | ||
|
||
return sb.String() | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,75 @@ | ||
package ast | ||
|
||
import ( | ||
"testing" | ||
|
||
"github.com/open-policy-agent/opa/ast" | ||
) | ||
|
||
func TestRefToString(t *testing.T) { | ||
t.Parallel() | ||
|
||
cases := []struct { | ||
title string | ||
ref ast.Ref | ||
expected string | ||
}{ | ||
{ | ||
"single var", | ||
ast.Ref{ | ||
ast.VarTerm("foo"), | ||
}, | ||
"foo", | ||
}, | ||
{ | ||
"var in middle", | ||
ast.Ref{ | ||
ast.StringTerm("foo"), | ||
ast.VarTerm("bar"), | ||
ast.StringTerm("baz"), | ||
}, | ||
"foo[bar].baz", | ||
}, | ||
{ | ||
"strings", | ||
ast.Ref{ | ||
ast.DefaultRootDocument, | ||
ast.StringTerm("foo"), | ||
ast.StringTerm("bar"), | ||
ast.StringTerm("baz"), | ||
}, | ||
"data.foo.bar.baz", | ||
}, | ||
{ | ||
"consecutive vars", | ||
ast.Ref{ | ||
ast.VarTerm("foo"), | ||
ast.VarTerm("bar"), | ||
ast.VarTerm("baz"), | ||
}, | ||
"foo[bar][baz]", | ||
}, | ||
{ | ||
"mixed", | ||
ast.Ref{ | ||
ast.VarTerm("foo"), | ||
ast.VarTerm("bar"), | ||
ast.StringTerm("baz"), | ||
ast.VarTerm("qux"), | ||
ast.StringTerm("quux"), | ||
}, | ||
"foo[bar].baz[qux].quux", | ||
}, | ||
} | ||
|
||
for _, tc := range cases { | ||
t.Run(tc.title, func(t *testing.T) { | ||
t.Parallel() | ||
|
||
result := RefToString(tc.ref) | ||
if result != tc.expected { | ||
t.Errorf("Expected %s, got %s", tc.expected, result) | ||
} | ||
}) | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,105 @@ | ||
package ast | ||
|
||
import ( | ||
"fmt" | ||
"strings" | ||
|
||
"github.com/open-policy-agent/opa/ast" | ||
|
||
"github.com/styrainc/regal/internal/lsp/rego" | ||
) | ||
|
||
// GetRuleDetail returns a short descriptive string value for a given rule stating | ||
// if the rule is contstant, multi-value, single-value etc and the type of the rule's | ||
// value if known. | ||
func GetRuleDetail(rule *ast.Rule) string { | ||
if rule.Head.Args != nil { | ||
return "function" + rule.Head.Args.String() | ||
} | ||
|
||
if rule.Head.Key != nil && rule.Head.Value == nil { | ||
return "multi-value rule" | ||
} | ||
|
||
if rule.Head.Value == nil { | ||
return "" | ||
} | ||
|
||
detail := "single-value " | ||
|
||
if rule.Head.Key != nil { | ||
detail += "map " | ||
} | ||
|
||
detail += "rule" | ||
|
||
switch v := rule.Head.Value.Value.(type) { | ||
case ast.Boolean: | ||
if strings.HasPrefix(rule.Head.Ref()[0].String(), "test_") { | ||
detail += " (test)" | ||
} else { | ||
detail += " (boolean)" | ||
} | ||
case ast.Number: | ||
detail += " (number)" | ||
case ast.String: | ||
detail += " (string)" | ||
case *ast.Array, *ast.ArrayComprehension: | ||
detail += " (array)" | ||
case ast.Object, *ast.ObjectComprehension: | ||
detail += " (object)" | ||
case ast.Set, *ast.SetComprehension: | ||
detail += " (set)" | ||
case ast.Call: | ||
name := v[0].String() | ||
|
||
if builtin, ok := rego.BuiltIns[name]; ok { | ||
retType := builtin.Decl.NamedResult().String() | ||
|
||
detail += fmt.Sprintf(" (%s)", simplifyType(retType)) | ||
} | ||
} | ||
|
||
return detail | ||
} | ||
|
||
// IsConstant returns true if the rule is a "constant" rule, i.e. | ||
// one without conditions and scalar value in the head. | ||
func IsConstant(rule *ast.Rule) bool { | ||
isScalar := false | ||
|
||
if rule.Head.Value == nil { | ||
return false | ||
} | ||
|
||
switch rule.Head.Value.Value.(type) { | ||
case ast.Boolean, ast.Number, ast.String, ast.Null: | ||
isScalar = true | ||
} | ||
|
||
return isScalar && | ||
rule.Head.Args == nil && | ||
rule.Body.Equal(ast.NewBody(ast.NewExpr(ast.BooleanTerm(true)))) && | ||
rule.Else == nil | ||
} | ||
|
||
// simplifyType removes anything but the base type from the type name. | ||
func simplifyType(name string) string { | ||
result := name | ||
|
||
if strings.Contains(result, ":") { | ||
result = result[strings.Index(result, ":")+1:] | ||
} | ||
|
||
// silence gocritic linter here as strings.Index can in | ||
// fact *not* return -1 in these cases | ||
if strings.Contains(result, "[") { | ||
result = result[:strings.Index(result, "[")] //nolint:gocritic | ||
} | ||
|
||
if strings.Contains(result, "<") { | ||
result = result[:strings.Index(result, "<")] //nolint:gocritic | ||
} | ||
|
||
return strings.TrimSpace(result) | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,93 @@ | ||
package ast | ||
|
||
import ( | ||
"testing" | ||
|
||
"github.com/styrainc/regal/internal/parse" | ||
) | ||
|
||
func TestGetRuleDetail(t *testing.T) { | ||
t.Parallel() | ||
|
||
cases := []struct { | ||
input string | ||
expected string | ||
}{ | ||
{ | ||
`allow := true`, | ||
`single-value rule (boolean)`, | ||
}, | ||
{ | ||
`allow := [1,2,3]`, | ||
`single-value rule (array)`, | ||
}, | ||
{ | ||
`allow := "foo"`, | ||
`single-value rule (string)`, | ||
}, | ||
{ | ||
`foo contains 1 if true`, | ||
`multi-value rule`, | ||
}, | ||
{ | ||
`func(x) := true`, | ||
`function(x)`, | ||
}, | ||
} | ||
|
||
for _, tc := range cases { | ||
t.Run(tc.input, func(t *testing.T) { | ||
t.Parallel() | ||
|
||
mod := parse.MustParseModule("package example\nimport rego.v1\n" + tc.input) | ||
|
||
if len(mod.Rules) != 1 { | ||
t.Fatalf("Expected 1 rule, got %d", len(mod.Rules)) | ||
} | ||
|
||
rule := mod.Rules[0] | ||
|
||
result := GetRuleDetail(rule) | ||
if result != tc.expected { | ||
t.Errorf("Expected %s, got %s", tc.expected, result) | ||
} | ||
}) | ||
} | ||
} | ||
|
||
func TestSimplifyType(t *testing.T) { | ||
t.Parallel() | ||
|
||
cases := []struct { | ||
input string | ||
expected string | ||
}{ | ||
{ | ||
"set", | ||
"set", | ||
}, | ||
{ | ||
"set[any]", | ||
"set", | ||
}, | ||
{ | ||
"any<set, object>", | ||
"any", | ||
}, | ||
{ | ||
"output: any<set[any], object>", | ||
"any", | ||
}, | ||
} | ||
|
||
for _, tc := range cases { | ||
t.Run(tc.input, func(t *testing.T) { | ||
t.Parallel() | ||
|
||
result := simplifyType(tc.input) | ||
if result != tc.expected { | ||
t.Errorf("Expected %s, got %s", tc.expected, result) | ||
} | ||
}) | ||
} | ||
} |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.