fix: import with schema=false (#510)

Author: tstirrat15

internal/cmd/import-test/relations-only-schema.zed

@@ -0,0 +1,6 @@
+definition user {}
+
+definition resource {
+  relation user: user
+  permission view = user
+}

internal/cmd/import-test/relations-only-validation-file-different-schema.yaml

@@ -0,0 +1,12 @@
+---
+# different than relations-only-schema.zed
+schema: |-
+  definition new {}
+
+  definition resource {
+    relation viewer: new
+    permission view = viewer
+  }
+
+relationships: >-
+  resource:1#user@user:1

internal/cmd/import-test/relations-only-validation-file.yaml

@@ -0,0 +1,3 @@
+---
+relationships: >-
+  resource:1#user@user:1

internal/cmd/import.go

@@ -76,7 +76,7 @@ func registerImportCmd(rootCmd *cobra.Command) {
 
 func importCmdFunc(cmd *cobra.Command, schemaClient v1.SchemaServiceClient, relationshipsClient v1.PermissionsServiceClient, prefix, filename string) error {
 	prefix = strings.TrimRight(prefix, "/")
-	p, err := decode.ValidationFileFromFilename(filename, decode.FileTypeYaml)
+	p, err := decode.ValidationFileFromFilename(filename, decode.FileTypeYaml, false)
 	if err != nil {
 		return err
 	}

internal/cmd/import_test.go

@@ -1,6 +1,7 @@
 package cmd
 
 import (
+	"os"
 	"path/filepath"
 	"testing"
 
@@ -69,6 +70,9 @@ func TestImportCmd(t *testing.T) {
 			}()
 			conn, err := srv.GRPCDialContext(ctx)
 			require.NoError(err)
+			t.Cleanup(func() {
+				conn.Close()
+			})
 
 			c, err := zedtesting.ClientFromConn(conn)(cmd)
 			require.NoError(err)
@@ -98,3 +102,80 @@ func TestImportCmd(t *testing.T) {
 		})
 	}
 }
+
+func TestImportCmdRelationsOnly(t *testing.T) {
+	cmd := zedtesting.CreateTestCobraCommandWithFlagValue(t,
+		zedtesting.StringFlag{FlagName: "schema-definition-prefix"},
+		zedtesting.BoolFlag{FlagName: "schema", FlagValue: false},
+		zedtesting.BoolFlag{FlagName: "relationships", FlagValue: true},
+		zedtesting.IntFlag{FlagName: "batch-size", FlagValue: 100},
+		zedtesting.IntFlag{FlagName: "workers", FlagValue: 1},
+	)
+
+	// Set up client
+	ctx := t.Context()
+	srv := zedtesting.NewTestServer(ctx, t)
+	go func() {
+		assert.NoError(t, srv.Run(ctx))
+	}()
+	conn, err := srv.GRPCDialContext(ctx)
+	require.NoError(t, err)
+	t.Cleanup(func() {
+		conn.Close()
+	})
+
+	c, err := zedtesting.ClientFromConn(conn)(cmd)
+	require.NoError(t, err)
+
+	// Write the schema out-of-band so that the import is hitting a realized schema
+	schemaBytes, err := os.ReadFile(filepath.Join("import-test", "relations-only-schema.zed"))
+	require.NoError(t, err)
+	_, err = c.WriteSchema(ctx, &v1.WriteSchemaRequest{
+		Schema: string(schemaBytes),
+	})
+	require.NoError(t, err)
+
+	t.Run("with no schema or schemaFile key in yaml", func(t *testing.T) {
+		f := filepath.Join("import-test", "relations-only-validation-file.yaml")
+		err = importCmdFunc(cmd, c, c, "", f)
+		require.NoError(t, err)
+
+		// Run a check with full consistency to see whether the relationships were written
+		resp, err := c.CheckPermission(ctx, &v1.CheckPermissionRequest{
+			Consistency: fullyConsistent,
+			Subject:     &v1.SubjectReference{Object: &v1.ObjectReference{ObjectType: "user", ObjectId: "1"}},
+			Permission:  "view",
+			Resource:    &v1.ObjectReference{ObjectType: "resource", ObjectId: "1"},
+		})
+		require.NoError(t, err)
+		require.Equal(t, v1.CheckPermissionResponse_PERMISSIONSHIP_HAS_PERMISSION, resp.Permissionship)
+
+		// Run a ReadSchema to assert the schema was NOT written
+		schemaResp, err := c.ReadSchema(ctx, &v1.ReadSchemaRequest{})
+		require.NoError(t, err)
+		require.Contains(t, schemaResp.SchemaText, `relation user: user`)
+		require.Contains(t, schemaResp.SchemaText, `permission view = user`)
+	})
+	t.Run("with schema present should be ignored", func(t *testing.T) {
+		f := filepath.Join("import-test", "relations-only-validation-file-different-schema.yaml")
+		err = importCmdFunc(cmd, c, c, "", f)
+		require.NoError(t, err)
+
+		// Run a check with full consistency to see whether the relationships
+		// and schema are written
+		resp, err := c.CheckPermission(ctx, &v1.CheckPermissionRequest{
+			Consistency: fullyConsistent,
+			Subject:     &v1.SubjectReference{Object: &v1.ObjectReference{ObjectType: "user", ObjectId: "1"}},
+			Permission:  "view",
+			Resource:    &v1.ObjectReference{ObjectType: "resource", ObjectId: "1"},
+		})
+		require.NoError(t, err)
+		require.Equal(t, v1.CheckPermissionResponse_PERMISSIONSHIP_HAS_PERMISSION, resp.Permissionship)
+
+		// Run a ReadSchema to assert the schema was NOT written
+		schemaResp, err := c.ReadSchema(ctx, &v1.ReadSchemaRequest{})
+		require.NoError(t, err)
+		require.Contains(t, schemaResp.SchemaText, `relation user: user`)
+		require.Contains(t, schemaResp.SchemaText, `permission view = user`)
+	})
+}

internal/cmd/validate.go

@@ -142,7 +142,7 @@ func validateCmdFunc(cmd *cobra.Command, filenames []string) (string, bool, erro
 			toPrint.WriteString(filename + "\n")
 		}
 
-		parsed, err := decode.ValidationFileFromFilename(filename, fileType)
+		parsed, err := decode.ValidationFileFromFilename(filename, fileType, true)
 		if err != nil {
 			return "", true, err
 		}

internal/decode/decoder.go

@@ -197,7 +197,7 @@ func UnmarshalYAMLValidationFile(contents []byte) (*validationfile.ValidationFil
 
 // ValidationFileFromFilename takes a filename and a desired/expected FileType and
 // returns the decoded file.
-func ValidationFileFromFilename(filename string, fileType FileType) (decoderResult *DecoderResult, err error) {
+func ValidationFileFromFilename(filename string, fileType FileType, mustDefineSchema bool) (decoderResult *DecoderResult, err error) {
 	u, err := url.Parse(filename)
 	if err != nil {
 		return nil, err
@@ -231,7 +231,7 @@ func ValidationFileFromFilename(filename string, fileType FileType) (decoderResu
 	schemaFilePresent := parsed.SchemaFile != ""
 
 	// Ensure that either schema or schemaFile is present
-	if !schemaPresent && !schemaFilePresent {
+	if mustDefineSchema && !schemaPresent && !schemaFilePresent {
 		return nil, errors.New("either schema or schemaFile must be present")
 	}
 

internal/decode/decoder_test.go

@@ -457,7 +457,7 @@ relationships: |-
 			f := filepath.Join(dir, tt.name+".yaml")
 			require.NoError(t, os.WriteFile(f, []byte(tt.yamlContent), 0o600))
 
-			vFile, err := ValidationFileFromFilename(f, FileTypeYaml)
+			vFile, err := ValidationFileFromFilename(f, FileTypeYaml, true)
 
 			if tt.expectedErrText != "" {
 				require.ErrorContains(t, err, tt.expectedErrText)
@@ -482,7 +482,7 @@ func TestValidationFileFromURLWithHTTP(t *testing.T) {
 	serverURL := SetupTestServer(t)
 
 	t.Run("schema file does not get populated", func(t *testing.T) {
-		_, err := ValidationFileFromFilename(serverURL+"/valid-with-schemaFile.zed", FileTypeYaml)
+		_, err := ValidationFileFromFilename(serverURL+"/valid-with-schemaFile.zed", FileTypeYaml, true)
 		require.ErrorContains(t, err, "cannot use schemaFile key")
 	})
 }