Merge pull request #972 from timofurrer/feature/repository-file-encoding

resource/gitlab_repository_file: Support auto base64 encoding for content

Author: timofurrer

docs/data-sources/repository_file.md

@@ -40,7 +40,7 @@ data "gitlab_repository_file" "example" {
 
 - `blob_id` (String) The blob id.
 - `commit_id` (String) The commit id.
-- `content` (String) base64 encoded file content. No other encoding is currently supported, because of a [GitLab API bug](https://gitlab.com/gitlab-org/gitlab/-/issues/342430).
+- `content` (String) 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).
 - `content_sha256` (String) File content sha256 digest.
 - `encoding` (String) The file content encoding.
 - `file_name` (String) The filename.

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 -->
@@ -56,7 +67,7 @@ resource "gitlab_repository_file" "this" {
 
 - `branch` (String) Name of the branch to which to commit to.
 - `commit_message` (String) Commit message.
-- `content` (String) base64 encoded file content. No other encoding is currently supported, because of a [GitLab API bug](https://gitlab.com/gitlab-org/gitlab/-/issues/342430).
+- `content` (String) 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).
 - `file_path` (String) The full path of the file. It must be relative to the root of the project without a leading slash `/`.
 - `project` (String) The name or ID of the project.
 

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

@@ -107,13 +107,20 @@ func resourceGitlabRepositoryFileCreate(ctx context.Context, d *schema.ResourceD
 	log.Printf("[DEBUG] gitlab_repository_file: got lock to create %s/%s", project, filePath)
 
 	client := meta.(*gitlab.Client)
+	// NOTE: for backwards-compatibility reasons, we also support an already given base64 encoding,
+	//       otherwise we encode the `content` to base64.
+	content := d.Get("content").(string)
+	if _, err := base64.StdEncoding.DecodeString(content); err != nil {
+		log.Printf("[DEBUG] gitlab_repository_file: given content '%s' is not a valid base64 encoded string, encoding it ...", content)
+		content = base64.StdEncoding.EncodeToString([]byte(content))
+	}
 
 	options := &gitlab.CreateFileOptions{
 		Branch:        gitlab.String(d.Get("branch").(string)),
 		Encoding:      gitlab.String(encoding),
 		AuthorEmail:   gitlab.String(d.Get("author_email").(string)),
 		AuthorName:    gitlab.String(d.Get("author_name").(string)),
-		Content:       gitlab.String(d.Get("content").(string)),
+		Content:       gitlab.String(content),
 		CommitMessage: gitlab.String(d.Get("commit_message").(string)),
 	}
 	if startBranch, ok := d.GetOk("start_branch"); ok {
@@ -160,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)
@@ -189,12 +208,20 @@ func resourceGitlabRepositoryFileUpdate(ctx context.Context, d *schema.ResourceD
 		Ref: gitlab.String(branch),
 	}
 
+	// NOTE: for backwards-compatibility reasons, we also support an already given base64 encoding,
+	//       otherwise we encode the `content` to base64.
+	content := d.Get("content").(string)
+	if _, err := base64.StdEncoding.DecodeString(content); err != nil {
+		log.Printf("[DEBUG] gitlab_repository_file: given content '%s' is not a valid base64 encoded string, encoding it ...", content)
+		content = base64.StdEncoding.EncodeToString([]byte(content))
+	}
+
 	updateOptions := &gitlab.UpdateFileOptions{
 		Branch:        gitlab.String(branch),
 		Encoding:      gitlab.String(encoding),
 		AuthorEmail:   gitlab.String(d.Get("author_email").(string)),
 		AuthorName:    gitlab.String(d.Get("author_name").(string)),
-		Content:       gitlab.String(d.Get("content").(string)),
+		Content:       gitlab.String(content),
 		CommitMessage: gitlab.String(d.Get("commit_message").(string)),
 	}
 	if startBranch, ok := d.GetOk("start_branch"); ok {
@@ -276,14 +303,6 @@ func resourceGitlabRepositoryFileDelete(ctx context.Context, d *schema.ResourceD
 	return nil
 }
 
-func validateBase64Content(v interface{}, k string) (we []string, errors []error) {
-	content := v.(string)
-	if _, err := base64.StdEncoding.DecodeString(content); err != nil {
-		errors = append(errors, fmt.Errorf("given repository file content '%s' is not base64 encoded, but must be", content))
-	}
-	return
-}
-
 func resourceGitLabRepositoryFileParseId(id string) (string, string, string, error) {
 	parts := strings.SplitN(id, ":", 3)
 	if len(parts) != 3 {