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.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: skip comments when loading test relationships #335

Merged
merged 1 commit into from Dec 13, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion pkg/validationfile/loader.go
Expand Up @@ -94,7 +94,7 @@ func PopulateFromFiles(ds datastore.Datastore, filePaths []string) (*FullyParsed
lines := strings.Split(relationships, "\n")
for index, line := range lines {
trimmed := strings.TrimSpace(line)
if len(trimmed) == 0 {
if len(trimmed) == 0 || strings.HasPrefix(trimmed, "//") {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mind adding a test into fileformat_test.go?

continue
}

Expand Down
50 changes: 50 additions & 0 deletions pkg/validationfile/loader_test.go
@@ -0,0 +1,50 @@
package validationfile

import (
"testing"

v0 "github.com/authzed/authzed-go/proto/authzed/api/v0"
"github.com/stretchr/testify/require"

"github.com/authzed/spicedb/internal/datastore/memdb"
"github.com/authzed/spicedb/pkg/tuple"
)

func TestPopulateFromFiles(t *testing.T) {
tests := []struct {
name string
filePaths []string
want []*v0.RelationTuple
}{
{
name: "no comment",
filePaths: []string{"testdata/loader_no_comment.yaml"},
want: []*v0.RelationTuple{
tuple.Parse("example/project:pied_piper#owner@example/user:milburga"),
tuple.Parse("example/project:pied_piper#reader@example/user:tarben"),
tuple.Parse("example/project:pied_piper#writer@example/user:freyja"),
},
},
{
name: "with comment",
filePaths: []string{"testdata/loader_with_comment.yaml"},
want: []*v0.RelationTuple{
tuple.Parse("example/project:pied_piper#owner@example/user:milburga"),
tuple.Parse("example/project:pied_piper#reader@example/user:tarben"),
tuple.Parse("example/project:pied_piper#writer@example/user:freyja"),
},
},
}

for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
require := require.New(t)
ds, err := memdb.NewMemdbDatastore(0, 0, 0, 0)
require.NoError(err)

parsed, _, err := PopulateFromFiles(ds, tt.filePaths)
require.NoError(err)
require.Equal(tt.want, parsed.Tuples)
})
}
}
23 changes: 23 additions & 0 deletions pkg/validationfile/testdata/loader_no_comment.yaml
@@ -0,0 +1,23 @@
schema: >-
definition example/user {}


definition example/project {
relation reader: example/user
relation writer: example/user
relation owner: example/user

permission read = reader + write
permission write = writer + admin
permission admin = owner
}
relationships: >-
example/project:pied_piper#owner@example/user:milburga

example/project:pied_piper#reader@example/user:tarben

example/project:pied_piper#writer@example/user:freyja
assertions:
assertTrue: []
assertFalse: []
validation: null
27 changes: 27 additions & 0 deletions pkg/validationfile/testdata/loader_with_comment.yaml
@@ -0,0 +1,27 @@
schema: >-
definition example/user {}


definition example/project {
relation reader: example/user
relation writer: example/user
relation owner: example/user

permission read = reader + write
permission write = writer + admin
permission admin = owner
}
relationships: >-
// Some comment

example/project:pied_piper#owner@example/user:milburga

example/project:pied_piper#reader@example/user:tarben

bryanhuhta marked this conversation as resolved.
Show resolved Hide resolved
// Some other comment

example/project:pied_piper#writer@example/user:freyja
assertions:
assertTrue: []
assertFalse: []
validation: null