Merge pull request #939 from petrmvala/feat/repository-file-datasource

timofurrer · web-flow · commit feefdf622ff4 · 2022-03-20T09:24:09.000+01:00
feat: Add gitlab_repository_file data source
diff --git a/docs/data-sources/repository_file.md b/docs/data-sources/repository_file.md
@@ -0,0 +1,50 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "gitlab_repository_file Data Source - terraform-provider-gitlab"
+subcategory: ""
+description: |-
+  The gitlab_repository_file data source allows details of a file in a repository to be retrieved.
+  Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/repository_files.html
+---
+
+# gitlab_repository_file (Data Source)
+
+The `gitlab_repository_file` data source allows details of a file in a repository to be retrieved.
+
+**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/repository_files.html)
+
+## Example Usage
+
+```terraform
+data "gitlab_repository_file" "example" {
+  project   = "example"
+  ref       = "main"
+  file_path = "README.md"
+}
+```
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Required
+
+- **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.
+- **ref** (String) The name of branch, tag or commit.
+
+### Optional
+
+- **id** (String) The ID of this resource.
+
+### Read-Only
+
+- **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_sha256** (String) File content sha256 digest.
+- **encoding** (String) The file content encoding.
+- **file_name** (String) The filename.
+- **last_commit_id** (String) The last known commit id.
+- **size** (Number) The file size.
+
+
diff --git a/docs/resources/repository_file.md b/docs/resources/repository_file.md
@@ -49,7 +49,7 @@ resource "gitlab_repository_file" "this" {
 - **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).
 - **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 ID of the project.
+- **project** (String) The name or ID of the project.
 
 ### Optional
 
@@ -60,7 +60,14 @@ resource "gitlab_repository_file" "this" {
 
 ### Read-Only
 
-- **encoding** (String) Content encoding.
+- **blob_id** (String) The blob id.
+- **commit_id** (String) The commit id.
+- **content_sha256** (String) File content sha256 digest.
+- **encoding** (String) The file content encoding.
+- **file_name** (String) The filename.
+- **last_commit_id** (String) The last known commit id.
+- **ref** (String) The name of branch, tag or commit.
+- **size** (Number) The file size.
 
 ## Import
 
diff --git a/examples/data-sources/gitlab_repository_file/data-source.tf b/examples/data-sources/gitlab_repository_file/data-source.tf
@@ -0,0 +1,5 @@
+data "gitlab_repository_file" "example" {
+  project   = "example"
+  ref       = "main"
+  file_path = "README.md"
+}
diff --git a/internal/provider/data_source_gitlab_repository_file.go b/internal/provider/data_source_gitlab_repository_file.go
@@ -0,0 +1,46 @@
+package provider
+
+import (
+	"context"
+	"fmt"
+	"log"
+
+	"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
+	gitlab "github.com/xanzy/go-gitlab"
+)
+
+var _ = registerDataSource("gitlab_repository_file", func() *schema.Resource {
+	return &schema.Resource{
+		Description: `The ` + "`gitlab_repository_file`" + ` data source allows details of a file in a repository to be retrieved.
+
+**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/repository_files.html)`,
+
+		ReadContext: dataSourceGitlabRepositoryFileRead,
+		Schema:      datasourceSchemaFromResourceSchema(gitlabRepositoryFileGetSchema(), "project", "file_path", "ref"),
+	}
+})
+
+func dataSourceGitlabRepositoryFileRead(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
+	client := meta.(*gitlab.Client)
+	project := d.Get("project").(string)
+	filePath := d.Get("file_path").(string)
+
+	options := &gitlab.GetFileOptions{
+		Ref: gitlab.String(d.Get("ref").(string)),
+	}
+
+	repositoryFile, resp, err := client.RepositoryFiles.GetFile(project, filePath, options, gitlab.WithContext(ctx))
+	if err != nil {
+		log.Printf("[DEBUG] file %s not found, response %v", filePath, resp)
+		return diag.FromErr(err)
+	}
+
+	d.SetId(fmt.Sprintf("%s:%s:%s", project, repositoryFile.Ref, repositoryFile.FilePath))
+
+	stateMap := gitlabRepositoryFileToStateMap(project, repositoryFile)
+	if err := setStateMapInResourceData(stateMap, d); err != nil {
+		return diag.FromErr(err)
+	}
+	return nil
+}
diff --git a/internal/provider/data_source_gitlab_repository_file_test.go b/internal/provider/data_source_gitlab_repository_file_test.go
@@ -0,0 +1,75 @@
+package provider
+
+import (
+	"fmt"
+	"testing"
+
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/terraform"
+)
+
+func TestAccDataGitlabRepositoryFile_basic(t *testing.T) {
+	testAccCheck(t)
+	project := testAccCreateProject(t)
+	resource.Test(t, resource.TestCase{
+		PreCheck:          func() { testAccPreCheck(t) },
+		ProviderFactories: providerFactories,
+		Steps: []resource.TestStep{
+			{
+				Config: testAccDataGitlabRepositoryFile(project.PathWithNamespace),
+				Check: resource.ComposeTestCheckFunc(
+					testAccDataSourceGitlabRepositoryFile("gitlab_repository_file.foo", "data.gitlab_repository_file.foo"),
+				),
+			},
+		},
+	})
+}
+
+func testAccDataSourceGitlabRepositoryFile(src, n string) resource.TestCheckFunc {
+	return func(s *terraform.State) error {
+
+		file := s.RootModule().Resources[src]
+		fileAttr := file.Primary.Attributes
+
+		search := s.RootModule().Resources[n]
+		searchAttr := search.Primary.Attributes
+
+		testAttributes := []string{
+			"project",
+			"file_path",
+			"size",
+			"encoding",
+			"content",
+			"ref",
+			"blob_id",
+			"commit_id",
+			"content_sha256",
+			"last_commit_id",
+		}
+
+		for _, attribute := range testAttributes {
+			if searchAttr[attribute] != fileAttr[attribute] {
+				return fmt.Errorf("expected file's parameter `%s` to be: %s, but got: `%s`", attribute, fileAttr[attribute], searchAttr[attribute])
+			}
+		}
+		return nil
+	}
+}
+
+func testAccDataGitlabRepositoryFile(project string) string {
+	return fmt.Sprintf(`
+resource "gitlab_repository_file" "foo" {
+	project = "%s"
+	file_path = "testfile-meow"
+	branch = "main"
+	content = base64encode("Meow goes the cat")
+	commit_message = "feat: Meow"
+}
+
+data "gitlab_repository_file" "foo" {
+  project = gitlab_repository_file.foo.project
+  file_path = gitlab_repository_file.foo.file_path
+  ref = "main"
+}
+`, project)
+}
diff --git a/internal/provider/resource_gitlab_repository_file.go b/internal/provider/resource_gitlab_repository_file.go
@@ -34,57 +34,37 @@ var _ = registerResource("gitlab_repository_file", func() *schema.Resource {
 		// However, we don't support the `encoding` parameter as it seems to be broken.
 		// Only a value of `base64` is supported, all others, including the documented default `text`, lead to
 		// a `400 {error: encoding does not have a valid value}` error.
-		Schema: map[string]*schema.Schema{
-			"project": {
-				Description: "The ID of the project.",
-				Type:        schema.TypeString,
-				Required:    true,
-				ForceNew:    true,
+		Schema: constructSchema(
+			map[string]*schema.Schema{
+				"branch": {
+					Description: "Name of the branch to which to commit to.",
+					Type:        schema.TypeString,
+					Required:    true,
+					ForceNew:    true,
+				},
+				"start_branch": {
+					Description: "Name of the branch to start the new commit from.",
+					Type:        schema.TypeString,
+					Optional:    true,
+				},
+				"author_email": {
+					Description: "Email of the commit author.",
+					Type:        schema.TypeString,
+					Optional:    true,
+				},
+				"author_name": {
+					Description: "Name of the commit author.",
+					Type:        schema.TypeString,
+					Optional:    true,
+				},
+				"commit_message": {
+					Description: "Commit message.",
+					Type:        schema.TypeString,
+					Required:    true,
+				},
 			},
-			"file_path": {
-				Description: "The full path of the file. It must be relative to the root of the project without a leading slash `/`.",
-				Type:        schema.TypeString,
-				Required:    true,
-				ForceNew:    true,
-			},
-			"branch": {
-				Description: "Name of the branch to which to commit to.",
-				Type:        schema.TypeString,
-				Required:    true,
-				ForceNew:    true,
-			},
-			"start_branch": {
-				Description: "Name of the branch to start the new commit from.",
-				Type:        schema.TypeString,
-				Optional:    true,
-			},
-			"author_email": {
-				Description: "Email of the commit author.",
-				Type:        schema.TypeString,
-				Optional:    true,
-			},
-			"author_name": {
-				Description: "Name of the commit author.",
-				Type:        schema.TypeString,
-				Optional:    true,
-			},
-			"content": {
-				Description:  "base64 encoded file content. 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,
-				ValidateFunc: validateBase64Content,
-			},
-			"commit_message": {
-				Description: "Commit message.",
-				Type:        schema.TypeString,
-				Required:    true,
-			},
-			"encoding": {
-				Description: "Content encoding.",
-				Type:        schema.TypeString,
-				Computed:    true,
-			},
-		},
+			gitlabRepositoryFileGetSchema(),
+		),
 	}
 })
 
@@ -136,11 +116,11 @@ func resourceGitlabRepositoryFileRead(ctx context.Context, d *schema.ResourceDat
 	}
 
 	d.SetId(resourceGitLabRepositoryFileBuildId(project, branch, repositoryFile.FilePath))
-	d.Set("project", project)
-	d.Set("file_path", repositoryFile.FilePath)
 	d.Set("branch", repositoryFile.Ref)
-	d.Set("encoding", repositoryFile.Encoding)
-	d.Set("content", repositoryFile.Content)
+	stateMap := gitlabRepositoryFileToStateMap(project, repositoryFile)
+	if err = setStateMapInResourceData(stateMap, d); err != nil {
+		return diag.FromErr(err)
+	}
 
 	return nil
 }
diff --git a/internal/provider/schema_gitlab_repository_file.go b/internal/provider/schema_gitlab_repository_file.go
@@ -0,0 +1,85 @@
+package provider
+
+import (
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
+	"github.com/xanzy/go-gitlab"
+)
+
+func gitlabRepositoryFileGetSchema() map[string]*schema.Schema {
+	return map[string]*schema.Schema{
+		"project": {
+			Description: "The name or ID of the project.",
+			Type:        schema.TypeString,
+			Required:    true,
+			ForceNew:    true,
+		},
+		"file_path": {
+			Description: "The full path of the file. It must be relative to the root of the project without a leading slash `/`.",
+			Type:        schema.TypeString,
+			Required:    true,
+			ForceNew:    true,
+		},
+		"ref": {
+			Description: "The name of branch, tag or commit.",
+			Type:        schema.TypeString,
+			Computed:    true,
+		},
+		"file_name": {
+			Description: "The filename.",
+			Type:        schema.TypeString,
+			Computed:    true,
+		},
+		"size": {
+			Description: "The file size.",
+			Type:        schema.TypeInt,
+			Computed:    true,
+		},
+		"encoding": {
+			Description: "The file content encoding.",
+			Type:        schema.TypeString,
+			Computed:    true,
+		},
+		"content": {
+			Description:  "base64 encoded file content. 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,
+			ValidateFunc: validateBase64Content,
+		},
+		"content_sha256": {
+			Description: "File content sha256 digest.",
+			Type:        schema.TypeString,
+			Computed:    true,
+		},
+		"blob_id": {
+			Description: "The blob id.",
+			Type:        schema.TypeString,
+			Computed:    true,
+		},
+		"commit_id": {
+			Description: "The commit id.",
+			Type:        schema.TypeString,
+			Computed:    true,
+		},
+		"last_commit_id": {
+			Description: "The last known commit id.",
+			Type:        schema.TypeString,
+			Computed:    true,
+		},
+	}
+}
+
+func gitlabRepositoryFileToStateMap(project string, repositoryFile *gitlab.File) map[string]interface{} {
+	stateMap := make(map[string]interface{})
+	stateMap["project"] = project
+	stateMap["file_name"] = repositoryFile.FileName
+	stateMap["file_path"] = repositoryFile.FilePath
+	stateMap["size"] = repositoryFile.Size
+	stateMap["encoding"] = repositoryFile.Encoding
+	stateMap["content"] = repositoryFile.Content
+	stateMap["content_sha256"] = repositoryFile.SHA256
+	stateMap["ref"] = repositoryFile.Ref
+	stateMap["blob_id"] = repositoryFile.BlobID
+	stateMap["commit_id"] = repositoryFile.CommitID
+	stateMap["last_commit_id"] = repositoryFile.LastCommitID
+	return stateMap
+}
