Merge branch 'main' into chore-refactor-credentials-#394

env0 · Jun 12, 2022 · 1c82b4d · 1c82b4d
2 parents f852426 + 84193fb
commit 1c82b4d
Show file tree

Hide file tree

Showing 5 changed files with 69 additions and 10 deletions.
diff --git a/client/api_key.go b/client/api_key.go
@@ -13,8 +13,13 @@ type ApiKey struct {
 	CreatedByUser    User   `json:"createdByUser"`
 }
 
+type ApiKeyPermissions struct {
+	OrganizationRole string `json:"organizationRole"`
+}
+
 type ApiKeyCreatePayload struct {
-	Name string `json:"name"`
+	Name        string            `json:"name"`
+	Permissions ApiKeyPermissions `json:"permissions"`
 }
 
 type ApiKeyCreatePayloadWith struct {

diff --git a/docs/resources/api_key.md b/docs/resources/api_key.md
@@ -28,7 +28,7 @@ resource "env0_api_key" "api_key_sample" {
 ### Optional
 
 - **id** (String) The ID of this resource.
-- **organization_role** (String) the api key type. 'Admin' or 'User'. If not set defaults to 'Admin'. For more details check https://docs.env0.com/docs/api-keys
+- **organization_role** (String) the api key type. 'Admin' or 'User'. Defaults to 'Admin'. For more details check https://docs.env0.com/docs/api-keys
 
 ## Import
 

diff --git a/env0/resource_api_key.go b/env0/resource_api_key.go
@@ -28,7 +28,7 @@ func resourceApiKey() *schema.Resource {
 			},
 			"organization_role": {
 				Type:             schema.TypeString,
-				Description:      "the api key type. 'Admin' or 'User'. If not set defaults to 'Admin'. For more details check https://docs.env0.com/docs/api-keys",
+				Description:      "the api key type. 'Admin' or 'User'. Defaults to 'Admin'. For more details check https://docs.env0.com/docs/api-keys",
 				Default:          "Admin",
 				Optional:         true,
 				ForceNew:         true,
@@ -46,6 +46,9 @@ func resourceApiKeyCreate(ctx context.Context, d *schema.ResourceData, meta inte
 		return diag.Errorf("schema resource data deserialization failed: %v", err)
 	}
 
+	organizationRole := d.Get("organization_role").(string)
+	payload.Permissions.OrganizationRole = organizationRole
+
 	apiKey, err := apiClient.ApiKeyCreate(payload)
 	if err != nil {
 		return diag.Errorf("could not create api key: %v", err)

diff --git a/env0/resource_api_key_test.go b/env0/resource_api_key_test.go
@@ -27,6 +27,15 @@ func TestUnitApiKeyResource(t *testing.T) {
 		OrganizationRole: "Admin",
 	}
 
+	apiKeyUser := client.ApiKey{
+		Id:               uuid.NewString(),
+		Name:             "name-user",
+		ApiKeyId:         "keyid",
+		ApiKeySecret:     "keysecret",
+		OrganizationId:   "org",
+		OrganizationRole: "User",
+	}
+
 	updatedApiKey := client.ApiKey{
 		Id:               "id2",
 		Name:             "name2",
@@ -36,7 +45,7 @@ func TestUnitApiKeyResource(t *testing.T) {
 		OrganizationRole: "Admin",
 	}
 
-	t.Run("Success", func(t *testing.T) {
+	t.Run("Success - Admin", func(t *testing.T) {
 		testCase := resource.TestCase{
 			Steps: []resource.TestStep{
 				{
@@ -65,19 +74,52 @@ func TestUnitApiKeyResource(t *testing.T) {
 		runUnitTest(t, testCase, func(mock *client.MockApiClientInterface) {
 			gomock.InOrder(
 				mock.EXPECT().ApiKeyCreate(client.ApiKeyCreatePayload{
-					Name: apiKey.Name,
+					Name:        apiKey.Name,
+					Permissions: client.ApiKeyPermissions{OrganizationRole: "Admin"},
 				}).Times(1).Return(&apiKey, nil),
 				mock.EXPECT().ApiKeys().Times(2).Return([]client.ApiKey{apiKey}, nil),
 				mock.EXPECT().ApiKeyDelete(apiKey.Id).Times(1),
 				mock.EXPECT().ApiKeyCreate(client.ApiKeyCreatePayload{
-					Name: updatedApiKey.Name,
+					Name:        updatedApiKey.Name,
+					Permissions: client.ApiKeyPermissions{OrganizationRole: "Admin"},
 				}).Times(1).Return(&updatedApiKey, nil),
 				mock.EXPECT().ApiKeys().Times(1).Return([]client.ApiKey{updatedApiKey}, nil),
 				mock.EXPECT().ApiKeyDelete(updatedApiKey.Id).Times(1),
 			)
 		})
 	})
 
+	t.Run("Success - User", func(t *testing.T) {
+		testCase := resource.TestCase{
+			Steps: []resource.TestStep{
+				{
+					Config: resourceConfigCreate(resourceType, resourceName, map[string]interface{}{
+						"name":              apiKeyUser.Name,
+						"organization_role": apiKeyUser.OrganizationRole,
+					}),
+					Check: resource.ComposeAggregateTestCheckFunc(
+						resource.TestCheckResourceAttr(accessor, "id", apiKeyUser.Id),
+						resource.TestCheckResourceAttr(accessor, "name", apiKeyUser.Name),
+						resource.TestCheckResourceAttr(accessor, "organization_role", apiKeyUser.OrganizationRole),
+					),
+				},
+			},
+		}
+
+		runUnitTest(t, testCase, func(mock *client.MockApiClientInterface) {
+			gomock.InOrder(
+				mock.EXPECT().ApiKeyCreate(client.ApiKeyCreatePayload{
+					Name: apiKeyUser.Name,
+					Permissions: client.ApiKeyPermissions{
+						OrganizationRole: apiKeyUser.OrganizationRole,
+					},
+				}).Times(1).Return(&apiKeyUser, nil),
+				mock.EXPECT().ApiKeys().Times(1).Return([]client.ApiKey{apiKeyUser}, nil),
+				mock.EXPECT().ApiKeyDelete(apiKeyUser.Id).Times(1),
+			)
+		})
+	})
+
 	t.Run("Create Failure", func(t *testing.T) {
 		testCase := resource.TestCase{
 			Steps: []resource.TestStep{
@@ -92,7 +134,8 @@ func TestUnitApiKeyResource(t *testing.T) {
 
 		runUnitTest(t, testCase, func(mock *client.MockApiClientInterface) {
 			mock.EXPECT().ApiKeyCreate(client.ApiKeyCreatePayload{
-				Name: apiKey.Name,
+				Name:        apiKey.Name,
+				Permissions: client.ApiKeyPermissions{OrganizationRole: "Admin"},
 			}).Times(1).Return(nil, errors.New("error"))
 		})
 	})
@@ -116,7 +159,8 @@ func TestUnitApiKeyResource(t *testing.T) {
 
 		runUnitTest(t, testCase, func(mock *client.MockApiClientInterface) {
 			mock.EXPECT().ApiKeyCreate(client.ApiKeyCreatePayload{
-				Name: apiKey.Name,
+				Name:        apiKey.Name,
+				Permissions: client.ApiKeyPermissions{OrganizationRole: "Admin"},
 			}).Times(1).Return(&apiKey, nil)
 			mock.EXPECT().ApiKeys().Times(3).Return([]client.ApiKey{apiKey}, nil)
 			mock.EXPECT().ApiKeyDelete(apiKey.Id).Times(1)
@@ -142,7 +186,8 @@ func TestUnitApiKeyResource(t *testing.T) {
 
 		runUnitTest(t, testCase, func(mock *client.MockApiClientInterface) {
 			mock.EXPECT().ApiKeyCreate(client.ApiKeyCreatePayload{
-				Name: apiKey.Name,
+				Name:        apiKey.Name,
+				Permissions: client.ApiKeyPermissions{OrganizationRole: "Admin"},
 			}).Times(1).Return(&apiKey, nil)
 			mock.EXPECT().ApiKeys().Times(3).Return([]client.ApiKey{apiKey}, nil)
 			mock.EXPECT().ApiKeyDelete(apiKey.Id).Times(1)
@@ -169,7 +214,8 @@ func TestUnitApiKeyResource(t *testing.T) {
 
 		runUnitTest(t, testCase, func(mock *client.MockApiClientInterface) {
 			mock.EXPECT().ApiKeyCreate(client.ApiKeyCreatePayload{
-				Name: updatedApiKey.Name,
+				Name:        updatedApiKey.Name,
+				Permissions: client.ApiKeyPermissions{OrganizationRole: "Admin"},
 			}).Times(1).Return(&updatedApiKey, nil)
 			mock.EXPECT().ApiKeys().Times(2).Return([]client.ApiKey{updatedApiKey}, nil)
 			mock.EXPECT().ApiKeyDelete(updatedApiKey.Id).Times(1)

diff --git a/tests/integration/020_api_key/main.tf b/tests/integration/020_api_key/main.tf
@@ -10,6 +10,11 @@ resource "env0_api_key" "test_api_key" {
   name = "my-little-api-key-${random_string.random.result}"
 }
 
+resource "env0_api_key" "test_user_api_key" {
+  name = "my-little-user-api-key-${random_string.random.result}"
+  organization_role = "User"
+}
+
 data "env0_api_key" "test_api_key1" {
   name       = env0_api_key.test_api_key.name
   depends_on = [env0_api_key.test_api_key]