resource/gitlab_repository_file: Store content in text format if config is text format too

Author: timofurrer

docs/resources/repository_file.md

@@ -47,6 +47,17 @@ resource "gitlab_repository_file" "this" {
   author_name    = "Terraform"
   commit_message = "feature: add meow file"
 }
+
+resource "gitlab_repository_file" "readme" {
+  project   = gitlab_project.this.id
+  file_path = "readme.txt"
+  branch    = "main"
+  // content will be auto base64 encoded
+  content        = "Meow goes the cat"
+  author_email   = "[email protected]"
+  author_name    = "Terraform"
+  commit_message = "feature: add readme file"
+}
 ```
 
 <!-- schema generated by tfplugindocs -->

examples/resources/gitlab_repository_file/resource.tf

@@ -17,3 +17,14 @@ resource "gitlab_repository_file" "this" {
   author_name    = "Terraform"
   commit_message = "feature: add meow file"
 }
+
+resource "gitlab_repository_file" "readme" {
+  project   = gitlab_project.this.id
+  file_path = "readme.txt"
+  branch    = "main"
+  // content will be auto base64 encoded
+  content        = "Meow goes the cat"
+  author_email   = "[email protected]"
+  author_name    = "Terraform"
+  commit_message = "feature: add readme file"
+}

internal/provider/resource_gitlab_repository_file.go

@@ -167,6 +167,18 @@ func resourceGitlabRepositoryFileRead(ctx context.Context, d *schema.ResourceDat
 		return diag.FromErr(err)
 	}
 
+	configContent := d.Get("content").(string)
+	log.Printf("[DEBUG] gitlab_repository_file: comparing content of %s with %s", repositoryFile.Content, configContent)
+	// NOTE: for backwards-compatibility reasons, we also support an already given base64 encoding,
+	//       otherwise we encode the `content` to base64.
+	if _, err := base64.StdEncoding.DecodeString(configContent); err != nil {
+		// if `content` is config is not a base64 encoded string, we decode the one from the API, too
+		// in case it's base64 encoded, else we don't decode it.
+		if decodedContent, err := base64.StdEncoding.DecodeString(repositoryFile.Content); err == nil {
+			repositoryFile.Content = string(decodedContent)
+		}
+	}
+
 	d.SetId(resourceGitLabRepositoryFileBuildId(project, branch, repositoryFile.FilePath))
 	d.Set("branch", repositoryFile.Ref)
 	stateMap := gitlabRepositoryFileToStateMap(project, repositoryFile)

internal/provider/resource_gitlab_repository_file_test.go

@@ -28,6 +28,7 @@ func TestAccGitlabRepositoryFile_basic(t *testing.T) {
 						FilePath: "meow.txt",
 						Content:  "bWVvdyBtZW93IG1lb3c=",
 					}),
+					resource.TestCheckResourceAttr("gitlab_repository_file.this", "content", "bWVvdyBtZW93IG1lb3c="),
 				),
 			},
 			{
@@ -44,6 +45,7 @@ func TestAccGitlabRepositoryFile_basic(t *testing.T) {
 						FilePath: "meow.txt",
 						Content:  "bWVvdyBtZW93IG1lb3cgbWVvdyBtZW93Cg==",
 					}),
+					resource.TestCheckResourceAttr("gitlab_repository_file.this", "content", "bWVvdyBtZW93IG1lb3cgbWVvdyBtZW93Cg=="),
 				),
 			},
 			{
@@ -168,6 +170,7 @@ func TestAccGitlabRepositoryFile_base64EncodingWithTextContent(t *testing.T) {
 						FilePath: "meow.txt",
 						Content:  "SGVsbG8gV29ybGQsIG1lb3c=",
 					}),
+					resource.TestCheckResourceAttr("gitlab_repository_file.this", "content", "Hello World, meow"),
 				),
 			},
 			// Update content
@@ -189,9 +192,10 @@ func TestAccGitlabRepositoryFile_base64EncodingWithTextContent(t *testing.T) {
 						FilePath: "meow.txt",
 						Content:  "SGVsbG8gV29ybGQsIG1lb3cgVVBEQVRFRA==",
 					}),
+					resource.TestCheckResourceAttr("gitlab_repository_file.this", "content", "Hello World, meow UPDATED"),
 				),
 			},
-			// Update to already base64 encoded content, but same content, yields in an empty plan
+			// Update to already base64 encoded content, but same content
 			{
 				Config: fmt.Sprintf(`
 					resource "gitlab_repository_file" "this" {
@@ -204,7 +208,7 @@ func TestAccGitlabRepositoryFile_base64EncodingWithTextContent(t *testing.T) {
 						commit_message = "feature: add launch codes"
 					}
 				`, testProject.ID),
-				PlanOnly: true,
+				Check: resource.TestCheckResourceAttr("gitlab_repository_file.this", "content", "SGVsbG8gV29ybGQsIG1lb3cgVVBEQVRFRA=="),
 			},
 			// Update content and already base64 encode it
 			{
@@ -225,9 +229,10 @@ func TestAccGitlabRepositoryFile_base64EncodingWithTextContent(t *testing.T) {
 						FilePath: "meow.txt",
 						Content:  "bWVvdyBtZW93IG1lb3c=",
 					}),
+					resource.TestCheckResourceAttr("gitlab_repository_file.this", "content", "bWVvdyBtZW93IG1lb3c="),
 				),
 			},
-			// Update to not-yet base64 encoded content, but same content, yields in an empty plan
+			// Update to not-yet base64 encoded content, but same content
 			{
 				Config: fmt.Sprintf(`
 					resource "gitlab_repository_file" "this" {
@@ -240,7 +245,7 @@ func TestAccGitlabRepositoryFile_base64EncodingWithTextContent(t *testing.T) {
 						commit_message = "feature: add launch codes"
 					}
 				`, testProject.ID),
-				PlanOnly: true,
+				Check: resource.TestCheckResourceAttr("gitlab_repository_file.this", "content", "meow meow meow"),
 			},
 		},
 	})

internal/provider/schema_gitlab_repository_file.go

@@ -1,8 +1,6 @@
 package provider
 
 import (
-	"encoding/base64"
-
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
 	"github.com/xanzy/go-gitlab"
 )
@@ -45,12 +43,6 @@ func gitlabRepositoryFileGetSchema() map[string]*schema.Schema {
 			Description: "File content. If the content is not yet base64 encoded, it will be encoded automatically. No other encoding is currently supported, because of a [GitLab API bug](https://gitlab.com/gitlab-org/gitlab/-/issues/342430).",
 			Type:        schema.TypeString,
 			Required:    true,
-			DiffSuppressFunc: func(k, old, new string, d *schema.ResourceData) bool {
-				if _, err := base64.StdEncoding.DecodeString(new); err != nil {
-					new = base64.StdEncoding.EncodeToString([]byte(new))
-				}
-				return old == new
-			},
 		},
 		"content_sha256": {
 			Description: "File content sha256 digest.",