feat: initial support for models with conditions (#169)

Author: rhamzeh

.golangci.yaml

@@ -46,6 +46,7 @@ linters-settings:
           - github.com/spf13/pflag
           - github.com/spf13/viper
           - google.golang.org/protobuf/encoding/protojson
+          - google.golang.org/protobuf/types/known/structpb
           - gopkg.in/yaml.v3
       test:
         files:
@@ -69,4 +70,4 @@ linters-settings:
     statements: 80
 
   skip-dirs:
-    - mocks
+    - mocks

CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## v0.2.0
+
+### [0.2.0](https://github.com/openfga/cli/compare/v0.1.2...v0.2.0) (2023-11-03)
+
+Changed:
+- add support for models with conditions
+
 ## v0.1.2
 
 ### [0.1.2](https://github.com/openfga/cli/compare/v0.1.1...v0.1.2) (2023-10-12)

cmd/model/list.go

@@ -50,7 +50,7 @@ func listModels(fgaClient client.SdkClient, maxPages int) (*openfga.ReadAuthoriz
 			return nil, fmt.Errorf("failed to list models due to %w", err)
 		}
 
-		models = append(models, *response.AuthorizationModels...)
+		models = append(models, response.AuthorizationModels...)
 
 		pageIndex++
 
@@ -61,7 +61,7 @@ func listModels(fgaClient client.SdkClient, maxPages int) (*openfga.ReadAuthoriz
 		continuationToken = *response.ContinuationToken
 	}
 
-	return &openfga.ReadAuthorizationModelsResponse{AuthorizationModels: &models}, nil
+	return &openfga.ReadAuthorizationModelsResponse{AuthorizationModels: models}, nil
 }
 
 // listCmd represents the list command.
@@ -93,7 +93,7 @@ var listCmd = &cobra.Command{
 		}
 
 		models := authorizationmodel.AuthzModelList{}
-		authzModels := *response.AuthorizationModels
+		authzModels := response.AuthorizationModels
 		for index := 0; index < len(authzModels); index++ {
 			authModel := authorizationmodel.AuthzModel{}
 			authModel.Set(authzModels[index])

cmd/model/list_test.go

@@ -28,7 +28,7 @@ func TestListModelsEmpty(t *testing.T) {
 	var models []openfga.AuthorizationModel
 
 	response := openfga.ReadAuthorizationModelsResponse{
-		AuthorizationModels: &models,
+		AuthorizationModels: models,
 		ContinuationToken:   openfga.PtrString(""),
 	}
 	mockExecute.EXPECT().Execute().Return(&response, nil)
@@ -101,7 +101,7 @@ func TestListModelsSinglePage(t *testing.T) {
 	}
 
 	response := openfga.ReadAuthorizationModelsResponse{
-		AuthorizationModels: &models,
+		AuthorizationModels: models,
 		ContinuationToken:   openfga.PtrString(""),
 	}
 	mockExecute.EXPECT().Execute().Return(&response, nil)
@@ -149,7 +149,7 @@ func TestListModelsMultiPage(t *testing.T) {
 	}
 	continuationToken1 := openfga.PtrString("abcdef")
 	response1 := openfga.ReadAuthorizationModelsResponse{
-		AuthorizationModels: &models1,
+		AuthorizationModels: models1,
 		ContinuationToken:   continuationToken1,
 	}
 
@@ -172,7 +172,7 @@ func TestListModelsMultiPage(t *testing.T) {
 	}
 	emptyToken := ""
 	response2 := openfga.ReadAuthorizationModelsResponse{
-		AuthorizationModels: &models2,
+		AuthorizationModels: models2,
 		ContinuationToken:   &emptyToken,
 	}
 
@@ -231,7 +231,7 @@ func TestListModelsMultiPageMaxPage(t *testing.T) {
 	}
 	continuationToken1 := openfga.PtrString("abcdef")
 	response1 := openfga.ReadAuthorizationModelsResponse{
-		AuthorizationModels: &models1,
+		AuthorizationModels: models1,
 		ContinuationToken:   continuationToken1,
 	}
 

cmd/model/test.go

@@ -33,7 +33,7 @@ var testCmd = &cobra.Command{
 	Use:     "test",
 	Short:   "Test an Authorization Model",
 	Long:    "Run a set of tests against a particular Authorization Model.",
-	Example: `fga model test --tests tests.fga.yaml`,
+	Example: `fga model test --tests model.fga.yaml`,
 	RunE: func(cmd *cobra.Command, args []string) error {
 		clientConfig := cmdutils.GetClientConfig(cmd)
 

cmd/model/write_test.go

@@ -9,7 +9,6 @@ import (
 	"github.com/golang/mock/gomock"
 	"github.com/openfga/cli/internal/authorizationmodel"
 	mockclient "github.com/openfga/cli/internal/mocks"
-	openfga "github.com/openfga/go-sdk"
 	"github.com/openfga/go-sdk/client"
 )
 
@@ -71,7 +70,7 @@ func TestWriteModel(t *testing.T) {
 
 	modelID := "01GXSB8YR785C4FYS3C0RTG7C2"
 	response := client.ClientWriteAuthorizationModelResponse{
-		AuthorizationModelId: openfga.PtrString(modelID),
+		AuthorizationModelId: modelID,
 	}
 	mockExecute.EXPECT().Execute().Return(&response, nil)
 

cmd/query/check.go

@@ -31,13 +31,13 @@ func check(
 	user string,
 	relation string,
 	object string,
-	contextualTuples []client.ClientTupleKey,
+	contextualTuples []client.ClientContextualTupleKey,
 ) (*client.ClientCheckResponse, error) {
 	body := &client.ClientCheckRequest{
 		User:             user,
 		Relation:         relation,
 		Object:           object,
-		ContextualTuples: &contextualTuples,
+		ContextualTuples: contextualTuples,
 	}
 	options := &client.ClientCheckOptions{}
 

cmd/query/check_test.go

@@ -31,15 +31,15 @@ func TestCheckWithError(t *testing.T) {
 	mockRequest.EXPECT().Options(options).Return(mockExecute)
 
 	mockBody := mock_client.NewMockSdkClientCheckRequestInterface(mockCtrl)
-	contextualTuples := []client.ClientTupleKey{
+	contextualTuples := []client.ClientContextualTupleKey{
 		{User: "user:foo", Relation: "admin", Object: "doc:doc1"},
 	}
 
 	body := client.ClientCheckRequest{
 		User:             "user:foo",
 		Relation:         "writer",
 		Object:           "doc:doc1",
-		ContextualTuples: &contextualTuples,
+		ContextualTuples: contextualTuples,
 	}
 	mockBody.EXPECT().Body(body).Return(mockRequest)
 
@@ -75,14 +75,14 @@ func TestCheckWithNoError(t *testing.T) {
 
 	mockBody := mock_client.NewMockSdkClientCheckRequestInterface(mockCtrl)
 
-	contextualTuples := []client.ClientTupleKey{
+	contextualTuples := []client.ClientContextualTupleKey{
 		{User: "user:foo", Relation: "admin", Object: "doc:doc1"},
 	}
 	body := client.ClientCheckRequest{
 		User:             "user:foo",
 		Relation:         "writer",
 		Object:           "doc:doc1",
-		ContextualTuples: &contextualTuples,
+		ContextualTuples: contextualTuples,
 	}
 	mockBody.EXPECT().Body(body).Return(mockRequest)
 

cmd/query/list-objects.go

@@ -32,13 +32,13 @@ func listObjects(
 	user string,
 	relation string,
 	objectType string,
-	contextualTuples []client.ClientTupleKey,
+	contextualTuples []client.ClientContextualTupleKey,
 ) (*client.ClientListObjectsResponse, error) {
 	body := &client.ClientListObjectsRequest{
 		User:             user,
 		Relation:         relation,
 		Type:             objectType,
-		ContextualTuples: &contextualTuples,
+		ContextualTuples: contextualTuples,
 	}
 	options := &client.ClientListObjectsOptions{}
 

cmd/query/list-objects_test.go

@@ -31,14 +31,14 @@ func TestListObjectsWithError(t *testing.T) {
 
 	mockBody := mock_client.NewMockSdkClientListObjectsRequestInterface(mockCtrl)
 
-	contextualTuples := []client.ClientTupleKey{
+	contextualTuples := []client.ClientContextualTupleKey{
 		{User: "user:foo", Relation: "admin", Object: "doc:doc1"},
 	}
 	body := client.ClientListObjectsRequest{
 		User:             "user:foo",
 		Relation:         "writer",
 		Type:             "doc",
-		ContextualTuples: &contextualTuples,
+		ContextualTuples: contextualTuples,
 	}
 	mockBody.EXPECT().Body(body).Return(mockRequest)
 
@@ -60,7 +60,7 @@ func TestListObjectsWithNoError(t *testing.T) {
 	mockExecute := mock_client.NewMockSdkClientListObjectsRequestInterface(mockCtrl)
 
 	expectedResponse := client.ClientListObjectsResponse{
-		Objects: &[]string{"doc:doc1", "doc:doc2"},
+		Objects: []string{"doc:doc1", "doc:doc2"},
 	}
 
 	mockExecute.EXPECT().Execute().Return(&expectedResponse, nil)
@@ -71,14 +71,14 @@ func TestListObjectsWithNoError(t *testing.T) {
 
 	mockBody := mock_client.NewMockSdkClientListObjectsRequestInterface(mockCtrl)
 
-	contextualTuples := []client.ClientTupleKey{
+	contextualTuples := []client.ClientContextualTupleKey{
 		{User: "user:foo", Relation: "admin", Object: "doc:doc1"},
 	}
 	body := client.ClientListObjectsRequest{
 		User:             "user:foo",
 		Relation:         "writer",
 		Type:             "doc",
-		ContextualTuples: &contextualTuples,
+		ContextualTuples: contextualTuples,
 	}
 	mockBody.EXPECT().Body(body).Return(mockRequest)
 
@@ -89,7 +89,7 @@ func TestListObjectsWithNoError(t *testing.T) {
 		t.Error(err)
 	}
 
-	if *output != expectedResponse {
+	if output != &expectedResponse {
 		t.Errorf("Expect %v but actual %v", expectedResponse, *output)
 	}
 }