New data source gitlab_project_variables

Refs: #386

Author: timofurrer

docs/data-sources/project_variables.md

@@ -0,0 +1,47 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "gitlab_project_variables Data Source - terraform-provider-gitlab"
+subcategory: ""
+description: |-
+  The gitlab_project_variables data source allows to retrieve all project-level CI/CD variables.
+  Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/project_level_variables.html
+---
+
+# gitlab_project_variables (Data Source)
+
+The `gitlab_project_variables` data source allows to retrieve all project-level CI/CD variables.
+
+**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/project_level_variables.html)
+
+
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Required
+
+- `project` (String) The name or id of the project.
+
+### Optional
+
+- `environment_scope` (String) The environment scope of the variable. Defaults to all environment (`*`).
+- `id` (String) The ID of this resource.
+
+### Read-Only
+
+- `variables` (List of Object) The list of variables returned by the search (see [below for nested schema](#nestedatt--variables))
+
+<a id="nestedatt--variables"></a>
+### Nested Schema for `variables`
+
+Read-Only:
+
+- `environment_scope` (String)
+- `key` (String)
+- `masked` (Boolean)
+- `project` (String)
+- `protected` (Boolean)
+- `value` (String)
+- `variable_type` (String)
+
+

internal/provider/data_source_gitlab_project_variables.go

@@ -0,0 +1,77 @@
+package provider
+
+import (
+	"context"
+	"fmt"
+
+	"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
+	"github.com/xanzy/go-gitlab"
+)
+
+var _ = registerDataSource("gitlab_project_variables", func() *schema.Resource {
+	return &schema.Resource{
+		Description: `The ` + "`gitlab_project_variables`" + ` data source allows to retrieve all project-level CI/CD variables.
+
+**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/project_level_variables.html)`,
+
+		ReadContext: dataSourceGitlabProjectVariablesRead,
+		Schema: map[string]*schema.Schema{
+			"project": {
+				Description: "The name or id of the project.",
+				Type:        schema.TypeString,
+				ForceNew:    true,
+				Required:    true,
+			},
+			"environment_scope": {
+				Description: "The environment scope of the variable. Defaults to all environment (`*`).",
+				Type:        schema.TypeString,
+				Optional:    true,
+				Default:     "*",
+			},
+			"variables": {
+				Description: "The list of variables returned by the search",
+				Type:        schema.TypeList,
+				Computed:    true,
+				Elem: &schema.Resource{
+					Schema: datasourceSchemaFromResourceSchema(gitlabProjectVariableGetSchema(), nil, nil),
+				},
+			},
+		},
+	}
+})
+
+func dataSourceGitlabProjectVariablesRead(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
+	client := meta.(*gitlab.Client)
+	project := d.Get("project").(string)
+	environmentScope := d.Get("environment_scope").(string)
+
+	options := &gitlab.ListProjectVariablesOptions{
+		Page:    1,
+		PerPage: 20,
+	}
+
+	var variables []*gitlab.ProjectVariable
+	for options.Page != 0 {
+		paginatedVariables, resp, err := client.ProjectVariables.ListVariables(project, options, gitlab.WithContext(ctx), withEnvironmentScopeFilter(ctx, environmentScope))
+		if err != nil {
+			return diag.FromErr(err)
+		}
+
+		variables = append(variables, paginatedVariables...)
+		options.Page = resp.NextPage
+	}
+
+	d.SetId(fmt.Sprintf("%s:%s", project, environmentScope))
+	if err := d.Set("variables", flattenGitlabProjectVariables(project, variables)); err != nil {
+		return diag.Errorf("failed to set variables to state: %v", err)
+	}
+	return nil
+}
+
+func flattenGitlabProjectVariables(project string, variables []*gitlab.ProjectVariable) (values []map[string]interface{}) {
+	for _, variable := range variables {
+		values = append(values, gitlabProjectVariableToStateMap(project, variable))
+	}
+	return values
+}

internal/provider/data_source_gitlab_project_variables_test.go

@@ -0,0 +1,40 @@
+package provider
+
+import (
+	"fmt"
+	"testing"
+
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource"
+	"github.com/xanzy/go-gitlab"
+)
+
+func TestAccDataSourceGitlabProjectVariables_basic(t *testing.T) {
+	testAccCheck(t)
+
+	testProject := testAccCreateProject(t)
+	testVariables := make([]*gitlab.ProjectVariable, 0)
+	for i := 0; i < 25; i++ {
+		testVariables = append(testVariables, testAccCreateProjectVariable(t, testProject.ID))
+	}
+
+	resource.Test(t, resource.TestCase{
+		PreCheck:          func() { testAccPreCheck(t) },
+		ProviderFactories: providerFactories,
+		Steps: []resource.TestStep{
+			{
+				Config: fmt.Sprintf(`
+					data "gitlab_project_variables" "this" {
+						project = %d
+					}
+				`, testProject.ID),
+				Check: resource.ComposeTestCheckFunc(
+					resource.TestCheckResourceAttr("data.gitlab_project_variables.this", "variables.#", fmt.Sprintf("%d", len(testVariables))),
+					resource.TestCheckResourceAttr("data.gitlab_project_variables.this", "variables.0.key", testVariables[0].Key),
+					resource.TestCheckResourceAttr("data.gitlab_project_variables.this", "variables.0.value", testVariables[0].Value),
+					resource.TestCheckResourceAttr("data.gitlab_project_variables.this", "variables.24.key", testVariables[24].Key),
+					resource.TestCheckResourceAttr("data.gitlab_project_variables.this", "variables.24.value", testVariables[24].Value),
+				),
+			},
+		},
+	})
+}

internal/provider/helper_test.go

@@ -351,6 +351,24 @@ func testAccCreateProjectEnvironment(t *testing.T, projectID int, options *gitla
 	return projectEnvironment
 }
 
+func testAccCreateProjectVariable(t *testing.T, projectID int) *gitlab.ProjectVariable {
+	variable, _, err := testGitlabClient.ProjectVariables.CreateVariable(projectID, &gitlab.CreateProjectVariableOptions{
+		Key:   gitlab.String(fmt.Sprintf("test_key_%d", acctest.RandInt())),
+		Value: gitlab.String("test_value"),
+	})
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	t.Cleanup(func() {
+		if _, err := testGitlabClient.ProjectVariables.RemoveVariable(projectID, variable.Key, nil); err != nil {
+			t.Fatal(err)
+		}
+	})
+
+	return variable
+}
+
 // testAccGitlabProjectContext encapsulates a GitLab client and test project to be used during an
 // acceptance test.
 type testAccGitlabProjectContext struct {