Add description to spacelift_mounted_file

Signed-off-by: peterdeme <[email protected]>
spacelift-io · Feb 10, 2025 · 4b61106 · 4b61106
1 parent 5926d9a
commit 4b61106
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 4 deletions.
diff --git a/docs/resources/mounted_file.md b/docs/resources/mounted_file.md
@@ -46,6 +46,7 @@ resource "spacelift_mounted_file" "core-kubeconfig" {
 ### Optional
 
 - `context_id` (String) ID of the context on which the mounted file is defined
+- `description` (String) Free-form description of the mounted file
 - `module_id` (String) ID of the module on which the mounted file is defined
 - `stack_id` (String) ID of the stack on which the mounted file is defined
 - `write_only` (Boolean) Indicates whether the content can be read back outside a Run. Defaults to `true`.

diff --git a/spacelift/resource_mounted_file.go b/spacelift/resource_mounted_file.go
@@ -73,6 +73,12 @@ func resourceMountedFile() *schema.Resource {
 				Optional:    true,
 				ForceNew:    true,
 			},
+			"description": {
+				Type:        schema.TypeString,
+				Description: "Free-form description of the mounted file",
+				Optional:    true,
+				ForceNew:    true,
+			},
 			"write_only": {
 				Type:        schema.TypeBool,
 				Description: "Indicates whether the content can be read back outside a Run. Defaults to `true`.",
@@ -87,10 +93,11 @@ func resourceMountedFile() *schema.Resource {
 func resourceMountedFileCreate(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
 	variables := map[string]interface{}{
 		"config": structs.ConfigInput{
-			ID:        toID(d.Get("relative_path")),
-			Type:      structs.ConfigType("FILE_MOUNT"),
-			Value:     toString(d.Get("content")),
-			WriteOnly: graphql.Boolean(d.Get("write_only").(bool)),
+			ID:          toID(d.Get("relative_path")),
+			Type:        structs.ConfigType("FILE_MOUNT"),
+			Value:       toString(d.Get("content")),
+			WriteOnly:   graphql.Boolean(d.Get("write_only").(bool)),
+			Description: toOptionalString(d.Get("description")),
 		},
 	}
 
@@ -195,6 +202,10 @@ func resourceMountedFileRead(ctx context.Context, d *schema.ResourceData, meta i
 	d.Set("relative_path", relativePath)
 	d.Set("write_only", element.WriteOnly)
 
+	if element.Description != nil {
+		d.Set("description", *element.Description)
+	}
+
 	if value := element.Value; value != nil {
 		d.Set("content", *value)
 	} else {

diff --git a/spacelift/resource_mounted_file_test.go b/spacelift/resource_mounted_file_test.go
@@ -26,6 +26,7 @@ func TestMountedFileResource(t *testing.T) {
 					context_id    = spacelift_context.test.id
 					content       = base64encode("bacon is tasty")
 					relative_path = "bacon.txt"
+					description   = "description text"
 					write_only    = %t
 				}
 			`, randomID, writeOnly)
@@ -40,6 +41,7 @@ func TestMountedFileResource(t *testing.T) {
 					Attribute("checksum", Equals("fb13e7977b7548a324b598e155b5b5ba3dcca2dad5789abe1411a88fa544be9b")),
 					Attribute("context_id", Contains(randomID)),
 					Attribute("relative_path", Equals("bacon.txt")),
+					Attribute("description", Equals("description text")),
 					Attribute("write_only", Equals("true")),
 				),
 			},