Feat: ignore archived environments when searching by name (#561)

env0/data_environment.go

@@ -25,6 +25,13 @@ func dataEnvironment() *schema.Resource {
 				Optional:     true,
 				ExactlyOneOf: []string{"name", "id"},
 			},
+			"exclude_archived": {
+				Type:          schema.TypeBool,
+				Description:   "set to 'true' to exclude archived environments when getting an environment by name",
+				Optional:      true,
+				Default:       false,
+				ConflictsWith: []string{"id"},
+			},
 			"project_id": {
 				Type:        schema.TypeString,
 				Description: "project id of the environment",
@@ -91,7 +98,8 @@ func dataEnvironmentRead(ctx context.Context, d *schema.ResourceData, meta inter
 		}
 	} else {
 		name := d.Get("name")
-		environment, err = getEnvironmentByName(name.(string), meta)
+		excludeArchived := d.Get("exclude_archived")
+		environment, err = getEnvironmentByName(name.(string), meta, excludeArchived.(bool))
 		if err != nil {
 			return err
 		}

env0/data_environment_test.go

@@ -33,7 +33,14 @@ func TestEnvironmentDataSource(t *testing.T) {
 		Name: "other-name",
 	}
 
+	archivedEnvironment := client.Environment{
+		Id:         "id-archived",
+		Name:       environment.Name,
+		IsArchived: true,
+	}
+
 	environmentFieldsByName := map[string]interface{}{"name": environment.Name}
+	environmentFieldsByNameWithExclude := map[string]interface{}{"name": environment.Name, "exclude_archived": "true"}
 	environmentFieldsById := map[string]interface{}{"id": environment.Id}
 
 	resourceType := "env0_environment"
@@ -101,6 +108,13 @@ func TestEnvironmentDataSource(t *testing.T) {
 		)
 	})
 
+	t.Run("By Name with Archived", func(t *testing.T) {
+		runUnitTest(t,
+			getValidTestCase(environmentFieldsByNameWithExclude),
+			mockListEnvironmentsCall([]client.Environment{environment, archivedEnvironment, otherEnvironment}),
+		)
+	})
+
 	t.Run("Throw error when no name or id is supplied", func(t *testing.T) {
 		runUnitTest(t,
 			getErrorTestCase(map[string]interface{}{}, "one of `id,name` must be specified"),
@@ -115,6 +129,13 @@ func TestEnvironmentDataSource(t *testing.T) {
 		)
 	})
 
+	t.Run("Throw error when by name and more than one environment exists (archived use-case)", func(t *testing.T) {
+		runUnitTest(t,
+			getErrorTestCase(environmentFieldsByName, "Found multiple environments for name"),
+			mockListEnvironmentsCall([]client.Environment{environment, archivedEnvironment, otherEnvironment}),
+		)
+	})
+
 	t.Run("Throw error when by name and no environments found at all", func(t *testing.T) {
 		runUnitTest(t,
 			getErrorTestCase(environmentFieldsByName, "Could not find an env0 environment with name"),

env0/resource_environment.go

@@ -840,7 +840,7 @@ func getConfigurationVariableFromSchema(variable map[string]interface{}) client.
 	return configurationVariable
 }
 
-func getEnvironmentByName(name interface{}, meta interface{}) (client.Environment, diag.Diagnostics) {
+func getEnvironmentByName(name interface{}, meta interface{}, excludeArchived bool) (client.Environment, diag.Diagnostics) {
 	apiClient := meta.(client.ApiClientInterface)
 	environments, err := apiClient.Environments()
 	if err != nil {
@@ -849,6 +849,10 @@ func getEnvironmentByName(name interface{}, meta interface{}) (client.Environmen
 
 	var environmentsByName []client.Environment
 	for _, candidate := range environments {
+		if excludeArchived && candidate.IsArchived {
+			continue
+		}
+
 		if candidate.Name == name {
 			environmentsByName = append(environmentsByName, candidate)
 		}
@@ -886,7 +890,7 @@ func resourceEnvironmentImport(ctx context.Context, d *schema.ResourceData, meta
 		log.Println("[DEBUG] ID is not a valid env0 id ", id)
 		log.Println("[INFO] Resolving Environment by name: ", id)
 
-		environment, getErr = getEnvironmentByName(id, meta)
+		environment, getErr = getEnvironmentByName(id, meta, false)
 	}
 	apiClient := meta.(client.ApiClientInterface)
 	d.SetId(environment.Id)