Enable query by configuration variable id in order to resolve #215 (#216

)
env0 · Jan 25, 2022 · 5160c76 · 5160c76
1 parent 282700a
commit 5160c76
Show file tree

Hide file tree

Showing 9 changed files with 204 additions and 63 deletions.
diff --git a/client/api_client.go b/client/api_client.go
@@ -12,7 +12,8 @@ type ApiClient struct {
 }
 
 type ApiClientInterface interface {
-	ConfigurationVariables(scope Scope, scopeId string) ([]ConfigurationVariable, error)
+	ConfigurationVariablesByScope(scope Scope, scopeId string) ([]ConfigurationVariable, error)
+	ConfigurationVariablesById(id string) (ConfigurationVariable, error)
 	ConfigurationVariableCreate(params ConfigurationVariableCreateParams) (ConfigurationVariable, error)
 	ConfigurationVariableUpdate(params ConfigurationVariableUpdateParams) (ConfigurationVariable, error)
 	ConfigurationVariableDelete(id string) error

diff --git a/client/api_client_mock.go b/client/api_client_mock.go
diff --git a/client/configuration_variable.go b/client/configuration_variable.go
@@ -4,7 +4,18 @@ import (
 	"errors"
 )
 
-func (self *ApiClient) ConfigurationVariables(scope Scope, scopeId string) ([]ConfigurationVariable, error) {
+func (self *ApiClient) ConfigurationVariablesById(id string) (ConfigurationVariable, error) {
+	var result ConfigurationVariable
+
+	err := self.http.Get("/configuration/"+id, nil, &result)
+
+	if err != nil {
+		return ConfigurationVariable{}, err
+	}
+	return result, nil
+}
+
+func (self *ApiClient) ConfigurationVariablesByScope(scope Scope, scopeId string) ([]ConfigurationVariable, error) {
 	organizationId, err := self.organizationId()
 	if err != nil {
 		return nil, err

diff --git a/client/configuration_variable_test.go b/client/configuration_variable_test.go
@@ -35,6 +35,24 @@ var _ = Describe("Configuration Variable", func() {
 		IsRequired:     &isRequired,
 	}
 
+	Describe("ConfigurationVariablesById", func() {
+		id := "configurationId"
+		var found ConfigurationVariable
+		BeforeEach(func() {
+			httpCall = mockHttpClient.EXPECT().
+				Get("/configuration/"+id, nil, gomock.Any()).
+				Do(func(path string, request interface{}, response *ConfigurationVariable) {
+					*response = mockConfigurationVariable
+				})
+
+			found, _ = apiClient.ConfigurationVariablesById(id)
+		})
+
+		It("Should return variable", func() {
+			Expect(found).To(Equal(mockConfigurationVariable))
+		})
+	})
+
 	Describe("ConfigurationVariableCreate", func() {
 		var createdConfigurationVariable ConfigurationVariable
 
@@ -198,7 +216,7 @@ var _ = Describe("Configuration Variable", func() {
 		})
 	})
 
-	Describe("ConfigurationVariables", func() {
+	Describe("ConfigurationVariablesByScope", func() {
 		var returnedVariables []ConfigurationVariable
 		mockVariables := []ConfigurationVariable{mockConfigurationVariable}
 		expectedParams := map[string]string{"organizationId": organizationId}
@@ -211,7 +229,7 @@ var _ = Describe("Configuration Variable", func() {
 				Do(func(path string, request interface{}, response *[]ConfigurationVariable) {
 					*response = mockVariables
 				})
-			returnedVariables, _ = apiClient.ConfigurationVariables(ScopeGlobal, "")
+			returnedVariables, _ = apiClient.ConfigurationVariablesByScope(ScopeGlobal, "")
 		})
 
 		It("Should send GET request with expected params", func() {
@@ -239,7 +257,7 @@ var _ = Describe("Configuration Variable", func() {
 					Do(func(path string, request interface{}, response *[]ConfigurationVariable) {
 						*response = mockVariables
 					})
-				returnedVariables, _ = apiClient.ConfigurationVariables(Scope(scope), scopeId)
+				returnedVariables, _ = apiClient.ConfigurationVariablesByScope(Scope(scope), scopeId)
 				httpCall.Times(1)
 			},
 			Entry("Template Scope", string(ScopeTemplate), "blueprintId"),

diff --git a/env0/data_configuration_variable.go b/env0/data_configuration_variable.go
@@ -185,13 +185,22 @@ func getScopeAndId(d *schema.ResourceData) (client.Scope, string) {
 
 func getConfigurationVariable(params ConfigurationVariableParams, meta interface{}) (client.ConfigurationVariable, diag.Diagnostics) {
 	apiClient := meta.(client.ApiClientInterface)
+	id, idOk := params.Id, params.Id != ""
+
+	if idOk {
+		variable, err := apiClient.ConfigurationVariablesById(id)
+		if err != nil {
+			return client.ConfigurationVariable{}, diag.Errorf("Could not query variable: %v", err)
+		}
+		return variable, nil
+	}
+
+	variables, err := apiClient.ConfigurationVariablesByScope(params.Scope, params.ScopeId)
 
-	variables, err := apiClient.ConfigurationVariables(params.Scope, params.ScopeId)
 	if err != nil {
 		return client.ConfigurationVariable{}, diag.Errorf("Could not query variables: %v", err)
 	}
 
-	id, idOk := params.Id, params.Id != ""
 	name, nameOk := params.Name, params.Name != ""
 	typeString, ok := params.configurationType, params.configurationType != ""
 	type_ := -1

diff --git a/env0/data_configuration_variable_test.go b/env0/data_configuration_variable_test.go
@@ -62,6 +62,8 @@ func TestUnitConfigurationVariableData(t *testing.T) {
 				},
 			},
 			func(mock *client.MockApiClientInterface) {
+				mock.EXPECT().ConfigurationVariablesById(configurationVariable.Id).AnyTimes().
+					Return(configurationVariable, nil)
 				mock.EXPECT().ConfigurationVariables(client.ScopeGlobal, "").AnyTimes().
 					Return([]client.ConfigurationVariable{configurationVariable}, nil)
 			})
@@ -107,6 +109,8 @@ func TestUnitConfigurationVariableData(t *testing.T) {
 				},
 			},
 			func(mock *client.MockApiClientInterface) {
+				mock.EXPECT().ConfigurationVariablesById(configurationVariable.Id).AnyTimes().
+					Return(configurationVariable, nil)
 				mock.EXPECT().ConfigurationVariables(client.ScopeGlobal, "").AnyTimes().
 					Return([]client.ConfigurationVariable{configurationVariable}, nil)
 			})
@@ -117,7 +121,7 @@ func TestUnitConfigurationVariableData(t *testing.T) {
 			resource.TestCase{
 				Steps: []resource.TestStep{
 					{
-						Config: dataSourceConfigCreate(resourceType, resourceName, map[string]interface{}{"id": configurationVariable.Id, "template_id": "template_id"}),
+						Config: dataSourceConfigCreate(resourceType, resourceName, map[string]interface{}{"template_id": "template_id", "name": configurationVariable.Name}),
 						Check:  checkResources,
 					},
 				},

diff --git a/env0/resource_configuration_variable.go b/env0/resource_configuration_variable.go
@@ -198,36 +198,34 @@ func resourceConfigurationVariableRead(ctx context.Context, d *schema.ResourceDa
 	apiClient := meta.(client.ApiClientInterface)
 
 	id := d.Id()
-	scope, scopeId := whichScope(d)
-	variables, err := apiClient.ConfigurationVariables(scope, scopeId)
+	variable, err := apiClient.ConfigurationVariablesById(id)
+
 	if err != nil {
 		return diag.Errorf("could not get configurationVariable: %v", err)
 	}
-	for _, variable := range variables {
-		if variable.Id == id {
-			d.Set("name", variable.Name)
-			d.Set("description", variable.Description)
-			d.Set("value", variable.Value)
-			d.Set("is_sensitive", variable.IsSensitive)
-			if variable.Type != nil && *variable.Type == client.ConfigurationVariableTypeTerraform {
-				d.Set("type", "terraform")
-			} else {
-				d.Set("type", "environment")
-			}
-			if variable.Schema != nil {
-				if len(variable.Schema.Enum) > 0 {
-					d.Set("enum", variable.Schema.Enum)
-				}
 
-				if variable.Schema.Format != "" {
-					d.Set("format", variable.Schema.Format)
-				}
-			}
+	d.Set("name", variable.Name)
+	d.Set("description", variable.Description)
+	d.Set("value", variable.Value)
+	d.Set("is_sensitive", variable.IsSensitive)
+	d.Set("is_read_only", variable.IsReadonly)
+	d.Set("is_required", variable.IsRequired)
+	if variable.Type != nil && *variable.Type == client.ConfigurationVariableTypeTerraform {
+		d.Set("type", "terraform")
+	} else {
+		d.Set("type", "environment")
+	}
+	if variable.Schema != nil {
+		if len(variable.Schema.Enum) > 0 {
+			d.Set("enum", variable.Schema.Enum)
+		}
 
-			return nil
+		if variable.Schema.Format != "" {
+			d.Set("format", variable.Schema.Format)
 		}
 	}
-	return diag.Errorf("variable %s not found (under this scope): %v", id, err)
+
+	return nil
 }
 
 func resourceConfigurationVariableUpdate(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {