Implement new data source gitlab_cluster_agents

Author: timofurrer

docs/data-sources/cluster_agents.md

@@ -0,0 +1,50 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "gitlab_cluster_agents Data Source - terraform-provider-gitlab"
+subcategory: ""
+description: |-
+  The gitlab_cluster_agents data source allows details of GitLab Agents for Kubernetes in a project.
+  -> Requires at least GitLab 14.10
+  Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/cluster_agents.html
+---
+
+# gitlab_cluster_agents (Data Source)
+
+The `gitlab_cluster_agents` data source allows details of GitLab Agents for Kubernetes in a project.
+
+-> Requires at least GitLab 14.10
+
+**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/cluster_agents.html)
+
+## Example Usage
+
+```terraform
+data "gitlab_cluster_agents" "agents" {
+  project = "12345"
+}
+```
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Required
+
+- `project` (String) The ID or full path of the project owned by the authenticated user.
+
+### Read-Only
+
+- `cluster_agents` (List of Object) List of the registered agents. (see [below for nested schema](#nestedatt--cluster_agents))
+- `id` (String) The ID of this resource.
+
+<a id="nestedatt--cluster_agents"></a>
+### Nested Schema for `cluster_agents`
+
+Read-Only:
+
+- `agent_id` (Number)
+- `created_at` (String)
+- `created_by_user_id` (Number)
+- `name` (String)
+- `project` (String)
+
+

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

@@ -0,0 +1,3 @@
+data "gitlab_cluster_agents" "agents" {
+  project = "12345"
+}

internal/provider/data_source_gitlab_cluster_agents.go

@@ -0,0 +1,78 @@
+package provider
+
+import (
+	"context"
+	"log"
+	"time"
+
+	"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_cluster_agents", func() *schema.Resource {
+	return &schema.Resource{
+		Description: `The ` + "`gitlab_cluster_agents`" + ` data source allows details of GitLab Agents for Kubernetes in a project.
+
+-> Requires at least GitLab 14.10
+
+**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/cluster_agents.html)`,
+
+		ReadContext: dataSourceGitlabClusterAgentsRead,
+		Schema: map[string]*schema.Schema{
+			"project": {
+				Description: "The ID or full path of the project owned by the authenticated user.",
+				Type:        schema.TypeString,
+				Required:    true,
+			},
+			"cluster_agents": {
+				Description: "List of the registered agents.",
+				Type:        schema.TypeList,
+				Computed:    true,
+				Elem: &schema.Resource{
+					Schema: datasourceSchemaFromResourceSchema(gitlabClusterAgentSchema(), nil, nil),
+				},
+			},
+		},
+	}
+})
+
+func dataSourceGitlabClusterAgentsRead(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
+	client := meta.(*gitlab.Client)
+
+	project := d.Get("project").(string)
+	options := gitlab.ListAgentsOptions{
+		PerPage: 20,
+		Page:    1,
+	}
+
+	var clusterAgents []*gitlab.Agent
+	for options.Page != 0 {
+		paginatedClusterAgents, resp, err := client.ClusterAgents.ListAgents(project, &options, gitlab.WithContext(ctx))
+		if err != nil {
+			return diag.FromErr(err)
+		}
+
+		clusterAgents = append(clusterAgents, paginatedClusterAgents...)
+		options.Page = resp.NextPage
+	}
+
+	log.Printf("[DEBUG] list GitLab Agents for Kubernetes in project %s", project)
+	d.SetId(project)
+	d.Set("project", project)
+	if err := d.Set("cluster_agents", flattenClusterAgentsForState(clusterAgents)); err != nil {
+		return diag.Errorf("Failed to set cluster agents to state: %v", err)
+	}
+	return nil
+}
+
+func flattenClusterAgentsForState(clusterAgents []*gitlab.Agent) (values []map[string]interface{}) {
+	for _, clusterAgent := range clusterAgents {
+		values = append(values, map[string]interface{}{
+			"name":               clusterAgent.Name,
+			"created_at":         clusterAgent.CreatedAt.Format(time.RFC3339),
+			"created_by_user_id": clusterAgent.CreatedByUserID,
+		})
+	}
+	return values
+}

internal/provider/data_source_gitlab_cluster_agents_test.go

@@ -0,0 +1,40 @@
+//go:build acceptance
+// +build acceptance
+
+package provider
+
+import (
+	"fmt"
+	"testing"
+
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource"
+)
+
+func TestAccDataSourceGitlabClusterAgents_basic(t *testing.T) {
+	testAccRequiresAtLeast(t, "14.10")
+
+	testProject := testAccCreateProject(t)
+	testClusterAgents := testAccCreateClusterAgents(t, testProject.ID, 25)
+
+	resource.Test(t, resource.TestCase{
+		ProviderFactories: providerFactories,
+		Steps: []resource.TestStep{
+			{
+				Config: fmt.Sprintf(`
+					data "gitlab_cluster_agents" "this" {
+						project = "%d"
+					}
+				`, testProject.ID),
+				Check: resource.ComposeTestCheckFunc(
+					resource.TestCheckResourceAttr("data.gitlab_cluster_agents.this", "cluster_agents.#", fmt.Sprintf("%d", len(testClusterAgents))),
+					resource.TestCheckResourceAttrSet("data.gitlab_cluster_agents.this", "cluster_agents.0.name"),
+					resource.TestCheckResourceAttrSet("data.gitlab_cluster_agents.this", "cluster_agents.0.created_at"),
+					resource.TestCheckResourceAttrSet("data.gitlab_cluster_agents.this", "cluster_agents.0.created_by_user_id"),
+					resource.TestCheckResourceAttrSet("data.gitlab_cluster_agents.this", "cluster_agents.1.name"),
+					resource.TestCheckResourceAttrSet("data.gitlab_cluster_agents.this", "cluster_agents.1.created_at"),
+					resource.TestCheckResourceAttrSet("data.gitlab_cluster_agents.this", "cluster_agents.1.created_by_user_id"),
+				),
+			},
+		},
+	})
+}