Allow preserving files on destroy

This change introduces the `preserve_on_destroy` option for the
local_file resource. This defaults to `false`, but when set to `true`
will ensure that the file is preserved when the resource is destroyed in
Terraform.

Resolves: #7

Author: abn

local/resource_local_file.go

@@ -36,6 +36,13 @@ func resourceLocalFile() *schema.Resource {
 				Required:    true,
 				ForceNew:    true,
 			},
+			"preserve_on_destroy": {
+				Type:        schema.TypeBool,
+				Description: "If true, the file will be preserved on destroy.",
+				Optional:    true,
+				Default:     false,
+				ForceNew:    true,
+			},
 		},
 	}
 }
@@ -98,6 +105,8 @@ func resourceLocalFileCreate(d *schema.ResourceData, _ interface{}) error {
 }
 
 func resourceLocalFileDelete(d *schema.ResourceData, _ interface{}) error {
-	os.Remove(d.Get("filename").(string))
+	if !d.Get("preserve_on_destroy").(bool) {
+		os.Remove(d.Get("filename").(string))
+	}
 	return nil
 }

local/resource_local_file_test.go

@@ -13,12 +13,14 @@ import (
 
 func TestLocalFile_Basic(t *testing.T) {
 	var cases = []struct {
-		path    string
-		content string
-		config  string
+		path     string
+		preserve bool
+		content  string
+		config   string
 	}{
 		{
 			"local_file",
+			false,
 			"This is some content",
 			`resource "local_file" "file" {
          content     = "This is some content"
@@ -27,10 +29,22 @@ func TestLocalFile_Basic(t *testing.T) {
 		},
 		{
 			"local_file",
+			false,
 			"This is some sensitive content",
 			`resource "local_file" "file" {
          sensitive_content     = "This is some sensitive content"
          filename    = "local_file"
+         preserve_on_destroy = false
+      }`,
+		},
+		{
+			"local_file",
+			true,
+			"This is some content",
+			`resource "local_file" "file" {
+         content     = "This is some content"
+         filename    = "local_file"
+         preserve_on_destroy = true
       }`,
 		},
 	}
@@ -55,6 +69,12 @@ func TestLocalFile_Basic(t *testing.T) {
 			},
 			CheckDestroy: func(*terraform.State) error {
 				if _, err := os.Stat(tt.path); os.IsNotExist(err) {
+					if !tt.preserve {
+						return nil
+					}
+					return errors.New("local_file was destroyed when 'preserve_on_destroy' was set to true")
+				} else if tt.preserve {
+					os.Remove(tt.path)
 					return nil
 				}
 				return errors.New("local_file did not get destroyed")

website/docs/r/file.html.md

@@ -35,5 +35,7 @@ The following arguments are supported:
 
 * `filename` - (Required) The path of the file to create.
 
+* `preserve_on_destroy` - (Optional) Determines if the file created will be removed when this resource is destroyed in Terraform. Defaults to `false`.
+
 Any required parent directories will be created automatically, and any existing
 file with the given name will be overwritten.