feat(tuple write): add support for csv files (#222)

openfga · Jan 10, 2024 · dd1ece2 · dd1ece2
2 parents 742405f + e48222d
commit dd1ece2
Show file tree

Hide file tree

Showing 13 changed files with 460 additions and 53 deletions.
diff --git a/.golangci.yaml b/.golangci.yaml
@@ -72,3 +72,10 @@ linters-settings:
 
   goimports:
     local-prefixes: "github.com/openfga/cli"
+
+issues:
+  exclude-use-default: true
+  exclude-rules:
+    - path: "cmd/tuple/write(.*).go"
+      linters:
+        - lll
diff --git a/README.md b/README.md
@@ -34,7 +34,7 @@ A cross-platform CLI to interact with an OpenFGA server
     - [Relationship Tuples](#relationship-tuples)
       - [Read Relationship Tuple Changes (Watch)](#read-relationship-tuple-changes-watch)
       - [Read Relationship Tuples](#read-relationship-tuples)
-      - [Create Relationship Tuples](#create-relationship-tuples)
+      - [Write Relationship Tuples](#write-relationship-tuples)
       - [Delete Relationship Tuples](#delete-relationship-tuples)
     - [Relationship Queries](#relationship-queries)
       - [Check](#check)
@@ -590,7 +590,7 @@ fga tuple **write** <user> <relation> <object> --store-id=<store-id>
 * `--condition-context`: Condition context (optional)
 * `--store-id`: Specifies the store id
 * `--model-id`: Specifies the model id to target (optional)
-* `--file`: Specifies the file name, `yaml` and `json` files are supported
+* `--file`: Specifies the file name, `json`, `yaml` and `csv` files are supported
 * `--max-tuples-per-write`: Max tuples to send in a single write (optional, default=1)
 * `--max-parallel-requests`: Max requests to send in parallel (optional, default=4)
 
@@ -600,12 +600,61 @@ fga tuple **write** <user> <relation> <object> --store-id=<store-id>
 
 ###### Response
 ```json5
-{}
+{
+  "successful": [
+    {
+      "object":"document:roadmap",
+      "relation":"writer",
+      "user":"user:annie"
+    }
+  ],
+}
 ```
 
 ###### Example (with file)
 `fga tuple write --store-id=01H0H015178Y2V4CX10C2KGHF4 --file tuples.json`
 
+If using a `csv` file, the format should be:
+
+```csv
+user_type,user_id,user_relation,relation,object_type,object_id,condition_name,condition_context
+folder,product,,parent,folder,product-2021,inOfficeIP,"{""ip_addr"":""10.0.0.1""}"
+```
+
+
+If using a `yaml` file, the format should be:
+
+```yaml
+- user: folder:5
+  relation: parent
+  object: folder:product-2021
+- user: folder:product-2021
+  relation: parent
+  object: folder:product-2021Q1
+```
+
+If using a `json` file, the format should be:
+
+```json
+[
+  {
+    "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"
+  }
+]
+```
+
 ###### Response
 ```json5
 {

diff --git a/cmd/tuple/testdata/tuples.csv b/cmd/tuple/testdata/tuples.csv
@@ -0,0 +1,4 @@
+user_type,user_id,user_relation,relation,object_type,object_id,condition_name,condition_context
+user,anne,,owner,folder,product,inOfficeIP,
+folder,product,,parent,folder,product-2021,inOfficeIP,"{""ip_addr"":""10.0.0.1""}"
+team,fga,member,viewer,folder,product-2021,,
diff --git a/cmd/tuple/testdata/tuples.json b/cmd/tuple/testdata/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"
+    }
+]
diff --git a/cmd/tuple/testdata/tuples.toml b/cmd/tuple/testdata/tuples.toml
diff --git a/cmd/tuple/testdata/tuples.yaml b/cmd/tuple/testdata/tuples.yaml
@@ -0,0 +1,9 @@
+- 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
diff --git a/cmd/tuple/testdata/tuples_empty.csv b/cmd/tuple/testdata/tuples_empty.csv
diff --git a/cmd/tuple/testdata/tuples_missing_required_headers.csv b/cmd/tuple/testdata/tuples_missing_required_headers.csv
@@ -0,0 +1 @@
+user_type,user_id,user_relation,relation,object_type,object_identifier,condition_name,condition_context
diff --git a/cmd/tuple/testdata/tuples_with_invalid_rows.csv b/cmd/tuple/testdata/tuples_with_invalid_rows.csv
@@ -0,0 +1,2 @@
+user_type,user_id,user_relation,relation,object_type,object_id,condition_name,condition_context
+user,beth,,viewer,folder,product-2021,a,b,d,,
diff --git a/cmd/tuple/testdata/tuples_wrong_headers.csv b/cmd/tuple/testdata/tuples_wrong_headers.csv
@@ -0,0 +1 @@
+a,b,c,d