Updated order of required attributes in schemas, added example for repository tree datasource, added create repo file helper function

Author: Shocktrooper

docs/data-sources/repository_tree.md

@@ -13,7 +13,16 @@ The `gitlab_repository_tree` data source allows details of directories and files
 
 **Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/repositories.html#list-repository-tree)
 
-
+## Example Usage
+
+```terraform
+data "gitlab_repository_tree" "this" {
+  project   = "example"
+  ref       = "main"
+  path      = "ExampleSubFolder"
+  recursive = true
+}
+```
 
 <!-- schema generated by tfplugindocs -->
 ## Schema

examples/data-sources/gitlab_repository_tree/data-source.tf

@@ -0,0 +1,6 @@
+data "gitlab_repository_tree" "this" {
+  project   = "example"
+  ref       = "main"
+  path      = "ExampleSubFolder"
+  recursive = true
+}

internal/provider/data_source_gitlab_repository_tree.go

@@ -23,16 +23,16 @@ var _ = registerDataSource("gitlab_repository_tree", func() *schema.Resource {
 				Type:        schema.TypeString,
 				Required:    true,
 			},
-			"path": {
-				Description: "The path inside repository. Used to get content of subdirectories.",
-				Type:        schema.TypeString,
-				Optional:    true,
-			},
 			"ref": {
 				Description: "The name of a repository branch or tag.",
 				Type:        schema.TypeString,
 				Required:    true,
 			},
+			"path": {
+				Description: "The path inside repository. Used to get content of subdirectories.",
+				Type:        schema.TypeString,
+				Optional:    true,
+			},
 			"recursive": {
 				Description: "Boolean value used to get a recursive tree (false by default).",
 				Type:        schema.TypeBool,

internal/provider/data_source_gitlab_repository_tree_test.go

@@ -12,35 +12,28 @@ import (
 
 func TestAccDataSourceGitlabRepositoryTree_basic(t *testing.T) {
 	testProject := testAccCreateProject(t)
+	testFile := testAccCreateProjectFile(t, testProject.ID, "content", "SomeFile", testProject.DefaultBranch)
 
 	resource.ParallelTest(t, resource.TestCase{
 		ProviderFactories: providerFactories,
 		Steps: []resource.TestStep{
 			{
 				Config: fmt.Sprintf(`
-					resource "gitlab_repository_file" "foo" {
-						project        = "%[1]d"
-						file_path      = "testfile-meow"
-						branch         = "%[2]s"
-						content        = base64encode("Meow goes the cat")
-						commit_message = "feat: Meow"
-					}
-
 					data "gitlab_repository_tree" "this" {
 						project = %[1]d
-						ref     = gitlab_repository_file.foo.branch
+						ref     = "%[2]s"
 					}
-				`, testProject.ID, testProject.DefaultBranch),
+				`, testProject.ID, testFile.Branch),
 				Check: resource.ComposeTestCheckFunc(
 					resource.TestCheckResourceAttr("data.gitlab_repository_tree.this", "tree.#", "2"),
 					resource.TestCheckResourceAttr("data.gitlab_repository_tree.this", "tree.0.name", "README.md"),
 					resource.TestCheckResourceAttr("data.gitlab_repository_tree.this", "tree.0.type", "blob"),
 					resource.TestCheckResourceAttr("data.gitlab_repository_tree.this", "tree.0.path", "README.md"),
 					resource.TestCheckResourceAttr("data.gitlab_repository_tree.this", "tree.0.mode", "100644"),
 
-					resource.TestCheckResourceAttr("data.gitlab_repository_tree.this", "tree.1.name", "testfile-meow"),
+					resource.TestCheckResourceAttr("data.gitlab_repository_tree.this", "tree.1.name", testFile.FilePath),
 					resource.TestCheckResourceAttr("data.gitlab_repository_tree.this", "tree.1.type", "blob"),
-					resource.TestCheckResourceAttr("data.gitlab_repository_tree.this", "tree.1.path", "testfile-meow"),
+					resource.TestCheckResourceAttr("data.gitlab_repository_tree.this", "tree.1.path", testFile.FilePath),
 					resource.TestCheckResourceAttr("data.gitlab_repository_tree.this", "tree.1.mode", "100644"),
 				),
 			},

internal/provider/helper_test.go

@@ -519,6 +519,30 @@ func testAccCreateInstanceVariable(t *testing.T) *gitlab.InstanceVariable {
 	return variable
 }
 
+func testAccCreateProjectFile(t *testing.T, projectID int, fileContent string, filePath string, branch string) *gitlab.FileInfo {
+
+	file, _, err := testGitlabClient.RepositoryFiles.CreateFile(projectID, filePath, &gitlab.CreateFileOptions{
+		Branch:        &branch,
+		Encoding:      gitlab.String("base64"),
+		Content:       &fileContent,
+		CommitMessage: gitlab.String(fmt.Sprintf("Random_Commit_Message_%d", acctest.RandInt())),
+	})
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	t.Cleanup(func() {
+		if _, err := testGitlabClient.RepositoryFiles.DeleteFile(projectID, filePath, &gitlab.DeleteFileOptions{
+			Branch:        &branch,
+			CommitMessage: gitlab.String(fmt.Sprintf("Delete_Random_Commit_Message_%d", acctest.RandInt())),
+		}); err != nil {
+			t.Fatal(err)
+		}
+	})
+
+	return file
+}
+
 // testAccGitlabProjectContext encapsulates a GitLab client and test project to be used during an
 // acceptance test.
 type testAccGitlabProjectContext struct {

internal/provider/resource_gitlab_repository_file.go

@@ -69,6 +69,11 @@ var _ = registerResource("gitlab_repository_file", func() *schema.Resource {
 					Required:    true,
 					ForceNew:    true,
 				},
+				"commit_message": {
+					Description: "Commit message.",
+					Type:        schema.TypeString,
+					Required:    true,
+				},
 				"start_branch": {
 					Description: "Name of the branch to start the new commit from.",
 					Type:        schema.TypeString,
@@ -84,11 +89,6 @@ var _ = registerResource("gitlab_repository_file", func() *schema.Resource {
 					Type:        schema.TypeString,
 					Optional:    true,
 				},
-				"commit_message": {
-					Description: "Commit message.",
-					Type:        schema.TypeString,
-					Required:    true,
-				},
 			},
 			gitlabRepositoryFileGetSchema(),
 		),

internal/provider/schema_gitlab_repository_file.go

@@ -19,6 +19,11 @@ func gitlabRepositoryFileGetSchema() map[string]*schema.Schema {
 			Required:    true,
 			ForceNew:    true,
 		},
+		"content": {
+			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,
+		},
 		"ref": {
 			Description: "The name of branch, tag or commit.",
 			Type:        schema.TypeString,
@@ -39,11 +44,6 @@ func gitlabRepositoryFileGetSchema() map[string]*schema.Schema {
 			Type:        schema.TypeString,
 			Computed:    true,
 		},
-		"content": {
-			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,
-		},
 		"content_sha256": {
 			Description: "File content sha256 digest.",
 			Type:        schema.TypeString,