Implement archive_on_destroy attribute for projects. Closes #761

This change implements an `archive_on_destroy` attribute on the
`gitlab_project` resource. It defaults to `false`, if set to `true`, on
a destroy it will *archive* the project instead of deleting it.

This is especially useful in organizations where repositories need to
be kept for regulatory purposes and can't be deleted.

Author: timofurrer

docs/resources/project.md

@@ -44,6 +44,7 @@ resource "gitlab_project" "example-two" {
 
 - **allow_merge_on_skipped_pipeline** (Boolean) Set to true if you want to treat skipped pipelines as if they finished with success.
 - **approvals_before_merge** (Number) Number of merge request approvals required for merging. Default is 0.
+- **archive_on_destroy** (Boolean) Set to `true` to archive the project instead of deleting on destroy. If set to `true` it will entire omit the `DELETE` operation.
 - **archived** (Boolean) Whether the project is in read-only mode (archived). Repositories can be archived/unarchived by toggling this parameter.
 - **build_coverage_regex** (String) Test coverage parsing for the project.
 - **ci_config_path** (String) Custom Path to CI config file.

gitlab/resource_gitlab_project.go

@@ -358,6 +358,11 @@ var resourceGitLabProjectSchema = map[string]*schema.Schema{
 		Type:        schema.TypeString,
 		Optional:    true,
 	},
+	"archive_on_destroy": {
+		Description: "Set to `true` to archive the project instead of deleting on destroy. If set to `true` it will entire omit the `DELETE` operation.",
+		Type:        schema.TypeBool,
+		Optional:    true,
+	},
 }
 
 func resourceGitlabProject() *schema.Resource {
@@ -857,43 +862,53 @@ func resourceGitlabProjectUpdate(ctx context.Context, d *schema.ResourceData, me
 
 func resourceGitlabProjectDelete(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
 	client := meta.(*gitlab.Client)
-	log.Printf("[DEBUG] Delete gitlab project %s", d.Id())
 
-	_, err := client.Projects.DeleteProject(d.Id(), gitlab.WithContext(ctx))
-	if err != nil {
-		return diag.FromErr(err)
-	}
+	if !d.Get("archive_on_destroy").(bool) {
+		log.Printf("[DEBUG] Delete gitlab project %s", d.Id())
+		_, err := client.Projects.DeleteProject(d.Id(), gitlab.WithContext(ctx))
+		if err != nil {
+			return diag.FromErr(err)
+		}
 
-	// Wait for the project to be deleted.
-	// Deleting a project in gitlab is async.
-	stateConf := &resource.StateChangeConf{
-		Pending: []string{"Deleting"},
-		Target:  []string{"Deleted"},
-		Refresh: func() (interface{}, string, error) {
-			out, response, err := client.Projects.GetProject(d.Id(), nil, gitlab.WithContext(ctx))
-			if err != nil {
-				if response.StatusCode == 404 {
+		// Wait for the project to be deleted.
+		// Deleting a project in gitlab is async.
+		stateConf := &resource.StateChangeConf{
+			Pending: []string{"Deleting"},
+			Target:  []string{"Deleted"},
+			Refresh: func() (interface{}, string, error) {
+				out, response, err := client.Projects.GetProject(d.Id(), nil, gitlab.WithContext(ctx))
+				if err != nil {
+					if response.StatusCode == 404 {
+						return out, "Deleted", nil
+					}
+					log.Printf("[ERROR] Received error: %#v", err)
+					return out, "Error", err
+				}
+				if out.MarkedForDeletionAt != nil {
+					// Represents a Gitlab EE soft-delete
 					return out, "Deleted", nil
 				}
-				log.Printf("[ERROR] Received error: %#v", err)
-				return out, "Error", err
-			}
-			if out.MarkedForDeletionAt != nil {
-				// Represents a Gitlab EE soft-delete
-				return out, "Deleted", nil
-			}
-			return out, "Deleting", nil
-		},
+				return out, "Deleting", nil
+			},
 
-		Timeout:    10 * time.Minute,
-		MinTimeout: 3 * time.Second,
-		Delay:      5 * time.Second,
-	}
+			Timeout:    10 * time.Minute,
+			MinTimeout: 3 * time.Second,
+			Delay:      5 * time.Second,
+		}
 
-	_, err = stateConf.WaitForStateContext(ctx)
-	if err != nil {
-		return diag.Errorf("error waiting for project (%s) to become deleted: %s", d.Id(), err)
+		_, err = stateConf.WaitForStateContext(ctx)
+		if err != nil {
+			return diag.Errorf("error waiting for project (%s) to become deleted: %s", d.Id(), err)
+		}
+
+	} else {
+		log.Printf("[DEBUG] Archive gitlab project %s", d.Id())
+		_, _, err := client.Projects.ArchiveProject(d.Id(), gitlab.WithContext(ctx))
+		if err != nil {
+			return diag.FromErr(err)
+		}
 	}
+
 	return nil
 }
 

gitlab/resource_gitlab_project_test.go

@@ -383,6 +383,21 @@ func TestAccGitlabProject_initializeWithoutReadme(t *testing.T) {
 	})
 }
 
+func TestAccGitlabProject_archiveOnDestroy(t *testing.T) {
+	rInt := acctest.RandInt()
+
+	resource.Test(t, resource.TestCase{
+		PreCheck:     func() { testAccPreCheck(t) },
+		Providers:    testAccProviders,
+		CheckDestroy: testAccCheckGitlabProjectArchivedOnDestroy,
+		Steps: []resource.TestStep{
+			{
+				Config: testAccGitlabProjectConfigArchiveOnDestroy(rInt),
+			},
+		},
+	})
+}
+
 func TestAccGitlabProject_IssueMergeRequestTemplates(t *testing.T) {
 	var project gitlab.Project
 	rInt := acctest.RandInt()
@@ -881,6 +896,27 @@ func testAccCheckGitlabProjectDestroy(s *terraform.State) error {
 	return nil
 }
 
+func testAccCheckGitlabProjectArchivedOnDestroy(s *terraform.State) error {
+	conn := testAccProvider.Meta().(*gitlab.Client)
+	for _, rs := range s.RootModule().Resources {
+		if rs.Type != "gitlab_project" {
+			continue
+		}
+
+		gotRepo, _, err := conn.Projects.GetProject(rs.Primary.ID, nil)
+		if err != nil {
+			return fmt.Errorf("unable to get project %s, to check if it has been archived on the destroy", rs.Primary.ID)
+		}
+
+		if !gotRepo.Archived {
+			return fmt.Errorf("expected project to be archived, but it isn't")
+		}
+		return nil
+	}
+
+	return fmt.Errorf("no project resources found in state, but expected a `gitlab_project` resource marked as archvied")
+}
+
 func testAccCheckAggregateGitlabProject(expected, received *gitlab.Project) resource.TestCheckFunc {
 	var checks []resource.TestCheckFunc
 
@@ -1343,3 +1379,15 @@ resource "gitlab_project" "foo" {
 }
 	`, rInt, rInt)
 }
+
+func testAccGitlabProjectConfigArchiveOnDestroy(rInt int) string {
+	return fmt.Sprintf(`
+resource "gitlab_project" "foo" {
+  name = "foo-%d"
+  path = "foo.%d"
+  description = "Terraform acceptance tests"
+  archive_on_destroy = true
+  archived = false
+}
+	`, rInt, rInt)
+}