feat(test): support tuple_file alongside of tuples (#212)

README.md

@@ -440,7 +440,7 @@ The tests file should be in yaml and have the following format:
 ---
 name: Store Name # store name, optional
 # model_file: ./model.fga # a global model that would apply to all tests, optional
-# model can be used instead of model-file, optional
+# model can be used instead of model_file, optional
 model: |
   model
     schema 1.1
@@ -453,13 +453,15 @@ model: |
       define can_write: owner or can_write from parent
       define can_share: owner
 
+# tuple_file: ./tuples.yaml # global tuples that would apply to all tests, optional
 tuples: # global tuples that would apply to all tests, optional
   - user: folder:1
     relation: parent
     object: folder:2
 tests: # required
   - name: test-1
     description: testing that the model works # optional
+    # tuple_file: ./tuples.json # tuples that would apply per test
     tuples:
       - user: user:anne
         relation: owner

example/folder-document-access_tuples.json

@@ -0,0 +1,17 @@
+[
+    {
+        "user": "user:anne",
+        "relation": "owner",
+        "object": "folder:product"
+    },
+    {
+        "user": "folder:product",
+        "relation": "parent",
+        "object": "folder:product-2021"
+    },
+    {
+        "user": "user:beth",
+        "relation": "viewer",
+        "object": "folder:product-2021"
+    }
+]

example/model.fga.yaml

@@ -6,26 +6,28 @@ model_file: ./model.fga # a global model that would apply to all tests
 #    schema 1.1
 #  type user
 #  ...
-tuples: # global tuples that would apply to all tests
-  - user: folder:5
-    relation: parent
-    object: folder:product-2021
-  - user: folder:product-2021
-    relation: parent
-    object: folder:product-2021Q1
+tuple_file: ./model_tuples.yaml  # global tuples that would apply to all tests
+# tuples can also be used instead of tuple_file
+#tuples:
+#   - user: folder:5
+#     relation: parent
+#     object: folder:product-2021
+#   - user: folder:product-2021
+#     relation: parent
+#     object: folder:product-2021Q1
 tests:
   - name: "folder-document-access"
     description: ""
-    tuples: # tuples in tests are appended to the global tuples and do not replace them
-      - user: user:anne
-        relation: owner
-        object: folder:product
-      - user: folder:product
-        relation: parent
-        object: folder:product-2021
-      - user: user:beth
-        relation: viewer
-        object: folder:product-2021
+     # tuples in tests are appended to the global tuples and do not replace them
+    tuple_file: ./folder-document-access_tuples.json
+    # tuples can also be used instead of tuple_file
+    #tuples:
+    #   - user: folder:5
+    #     relation: parent
+    #     object: folder:product-2021
+    #   - user: folder:product-2021
+    #     relation: parent
+    #     object: folder:product-2021Q1
     check: # Each check test is made of: a user, an object and the expected result for one or more relations
       - user: user:anne
         object: folder:product-2021

example/model_tuples.yaml

@@ -0,0 +1,6 @@
+- user: folder:5
+  relation: parent
+  object: folder:product-2021
+- user: folder:product-2021
+  relation: parent
+  object: folder:product-2021Q1

internal/storetest/localstore.go

@@ -70,8 +70,8 @@ func initLocalStore(
 	return &storeID, modelID, nil
 }
 
-func getLocalServerAndModel(
-	storeData StoreData,
+func getLocalServerModelAndTuples(
+	storeData *StoreData,
 	basePath string,
 ) (*server.Server, *authorizationmodel.AuthzModel, error) {
 	var fgaServer *server.Server
@@ -83,6 +83,11 @@ func getLocalServerAndModel(
 		return nil, nil, err
 	}
 
+	err = storeData.LoadTuples(basePath)
+	if err != nil {
+		return nil, nil, err
+	}
+
 	if storeData.Model == "" {
 		return fgaServer, authModel, nil
 	}

internal/storetest/storedata.go

@@ -18,10 +18,17 @@ limitations under the License.
 package storetest
 
 import (
+	"encoding/json"
+	"errors"
+	"fmt"
+	"io"
+	"os"
 	"path"
 
 	"github.com/openfga/go-sdk/client"
 
+	"gopkg.in/yaml.v3"
+
 	"github.com/openfga/cli/internal/authorizationmodel"
 )
 
@@ -43,6 +50,7 @@ type ModelTest struct {
 	Name        string                            `json:"name"         yaml:"name"`
 	Description string                            `json:"description"  yaml:"description"`
 	Tuples      []client.ClientContextualTupleKey `json:"tuples"       yaml:"tuples"`
+	TupleFile   string                            `json:"tuple_file"   yaml:"tuple_file"` //nolint:tagliatelle
 	Check       []ModelTestCheck                  `json:"check"        yaml:"check"`
 	ListObjects []ModelTestListObjects            `json:"list_objects" yaml:"list_objects"` //nolint:tagliatelle
 }
@@ -52,6 +60,7 @@ type StoreData struct {
 	Model     string                            `json:"model"      yaml:"model"`
 	ModelFile string                            `json:"model_file" yaml:"model_file"` //nolint:tagliatelle
 	Tuples    []client.ClientContextualTupleKey `json:"tuples"     yaml:"tuples"`
+	TupleFile string                            `json:"tuple_file" yaml:"tuple_file"` //nolint:tagliatelle
 	Tests     []ModelTest                       `json:"tests"      yaml:"tests"`
 }
 
@@ -82,3 +91,74 @@ func (storeData *StoreData) LoadModel(basePath string) (authorizationmodel.Model
 
 	return format, nil
 }
+
+func (storeData *StoreData) LoadTuples(basePath string) error {
+	var errs error
+
+	if storeData.TupleFile != "" {
+		tuples, err := readTupleFile(path.Join(basePath, storeData.TupleFile))
+		if err != nil {
+			errs = fmt.Errorf("failed to process global tuple %s file due to %w", storeData.TupleFile, err)
+		} else {
+			storeData.Tuples = tuples
+		}
+	}
+
+	for index := 0; index < len(storeData.Tests); index++ {
+		test := storeData.Tests[index]
+		if test.TupleFile == "" {
+			continue
+		}
+
+		tuples, err := readTupleFile(path.Join(basePath, test.TupleFile))
+		if err != nil {
+			errs = errors.Join(
+				errs,
+				fmt.Errorf("failed to process tuple file %s for test %s due to %w", test.TupleFile, test.Name, err),
+			)
+		} else {
+			storeData.Tests[index].Tuples = tuples
+		}
+	}
+
+	if errs != nil {
+		return errors.Join(errors.New("failed to process one or more tuple files"), errs) //nolint:goerr113
+	}
+
+	return nil
+}
+
+func readTupleFile(tuplePath string) ([]client.ClientContextualTupleKey, error) {
+	var tuples []client.ClientContextualTupleKey
+
+	tupleFile, err := os.Open(tuplePath)
+	if err != nil {
+		return nil, err //nolint:wrapcheck
+	}
+	defer tupleFile.Close()
+
+	switch path.Ext(tuplePath) {
+	case ".json":
+		contents, err := io.ReadAll(tupleFile)
+		if err != nil {
+			return nil, err //nolint:wrapcheck
+		}
+
+		err = json.Unmarshal(contents, &tuples)
+		if err != nil {
+			return nil, err //nolint:wrapcheck
+		}
+	case ".yaml", ".yml":
+		decoder := yaml.NewDecoder(tupleFile)
+		decoder.KnownFields(true)
+
+		err = decoder.Decode(&tuples)
+		if err != nil {
+			return nil, err //nolint:wrapcheck
+		}
+	default:
+		return nil, fmt.Errorf("unsupported file format %s", path.Ext(tuplePath)) //nolint:goerr113
+	}
+
+	return tuples, nil
+}

internal/storetest/tests.go

@@ -36,7 +36,7 @@ func RunTests(
 ) (TestResults, error) {
 	test := TestResults{}
 
-	fgaServer, authModel, err := getLocalServerAndModel(storeData, basePath)
+	fgaServer, authModel, err := getLocalServerModelAndTuples(&storeData, basePath)
 	if err != nil {
 		return test, err
 	}