Merge pull request #1204 from timofurrer/feature/datasource/gitlab_project_hook

RicePatrick · web-flow · commit 9f18610276c3 · 2022-08-08T13:42:30.000-05:00
Implement `gitlab_project_hook` and `gitlab_project_hooks` data sources
diff --git a/docs/data-sources/project_hook.md b/docs/data-sources/project_hook.md
@@ -0,0 +1,58 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "gitlab_project_hook Data Source - terraform-provider-gitlab"
+subcategory: ""
+description: |-
+  The gitlab_project_hook data source allows to retrieve details about a hook in a project.
+  Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/projects.html#get-project-hook
+---
+
+# gitlab_project_hook (Data Source)
+
+The `gitlab_project_hook` data source allows to retrieve details about a hook in a project.
+
+**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/projects.html#get-project-hook)
+
+## Example Usage
+
+```terraform
+data "gitlab_project" "example" {
+  id = "foo/bar/baz"
+}
+
+data "gitlab_project_hook" "example" {
+  project = data.gitlab_project.example.id
+  hook_id = 1
+}
+```
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Required
+
+- `hook_id` (Number) The id of the project hook.
+- `project` (String) The name or id of the project to add the hook to.
+
+### Read-Only
+
+- `confidential_issues_events` (Boolean) Invoke the hook for confidential issues events.
+- `confidential_note_events` (Boolean) Invoke the hook for confidential notes events.
+- `deployment_events` (Boolean) Invoke the hook for deployment events.
+- `enable_ssl_verification` (Boolean) Enable ssl verification when invoking the hook.
+- `id` (String) The ID of this resource.
+- `issues_events` (Boolean) Invoke the hook for issues events.
+- `job_events` (Boolean) Invoke the hook for job events.
+- `merge_requests_events` (Boolean) Invoke the hook for merge requests.
+- `note_events` (Boolean) Invoke the hook for notes events.
+- `pipeline_events` (Boolean) Invoke the hook for pipeline events.
+- `project_id` (Number) The id of the project for the hook.
+- `push_events` (Boolean) Invoke the hook for push events.
+- `push_events_branch_filter` (String) Invoke the hook for push events on matching branches only.
+- `releases_events` (Boolean) Invoke the hook for releases events.
+- `tag_push_events` (Boolean) Invoke the hook for tag push events.
+- `token` (String) A token to present when invoking the hook. The token is not available for imported resources.
+- `url` (String) The url of the hook to invoke.
+- `wiki_page_events` (Boolean) Invoke the hook for wiki page events.
+
+
diff --git a/docs/data-sources/project_hooks.md b/docs/data-sources/project_hooks.md
@@ -0,0 +1,65 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "gitlab_project_hooks Data Source - terraform-provider-gitlab"
+subcategory: ""
+description: |-
+  The gitlab_project_hooks data source allows to retrieve details about hooks in a project.
+  Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/projects.html#list-project-hooks
+---
+
+# gitlab_project_hooks (Data Source)
+
+The `gitlab_project_hooks` data source allows to retrieve details about hooks in a project.
+
+**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/projects.html#list-project-hooks)
+
+## Example Usage
+
+```terraform
+data "gitlab_project" "example" {
+  id = "foo/bar/baz"
+}
+
+data "gitlab_project_hooks" "examples" {
+  project = data.gitlab_project.example.id
+}
+```
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Required
+
+- `project` (String) The name or id of the project.
+
+### Read-Only
+
+- `hooks` (List of Object) The list of hooks. (see [below for nested schema](#nestedatt--hooks))
+- `id` (String) The ID of this resource.
+
+<a id="nestedatt--hooks"></a>
+### Nested Schema for `hooks`
+
+Read-Only:
+
+- `confidential_issues_events` (Boolean)
+- `confidential_note_events` (Boolean)
+- `deployment_events` (Boolean)
+- `enable_ssl_verification` (Boolean)
+- `hook_id` (Number)
+- `issues_events` (Boolean)
+- `job_events` (Boolean)
+- `merge_requests_events` (Boolean)
+- `note_events` (Boolean)
+- `pipeline_events` (Boolean)
+- `project` (String)
+- `project_id` (Number)
+- `push_events` (Boolean)
+- `push_events_branch_filter` (String)
+- `releases_events` (Boolean)
+- `tag_push_events` (Boolean)
+- `token` (String)
+- `url` (String)
+- `wiki_page_events` (Boolean)
+
+
diff --git a/docs/resources/project_hook.md b/docs/resources/project_hook.md
@@ -51,7 +51,9 @@ resource "gitlab_project_hook" "example" {
 
 ### Read-Only
 
+- `hook_id` (Number) The id of the project hook.
 - `id` (String) The ID of this resource.
+- `project_id` (Number) The id of the project for the hook.
 
 ## Import
 
diff --git a/examples/data-sources/gitlab_project_hook/data-source.tf b/examples/data-sources/gitlab_project_hook/data-source.tf
@@ -0,0 +1,8 @@
+data "gitlab_project" "example" {
+  id = "foo/bar/baz"
+}
+
+data "gitlab_project_hook" "example" {
+  project = data.gitlab_project.example.id
+  hook_id = 1
+}
diff --git a/examples/data-sources/gitlab_project_hooks/data-source.tf b/examples/data-sources/gitlab_project_hooks/data-source.tf
@@ -0,0 +1,7 @@
+data "gitlab_project" "example" {
+  id = "foo/bar/baz"
+}
+
+data "gitlab_project_hooks" "examples" {
+  project = data.gitlab_project.example.id
+}
diff --git a/internal/provider/data_source_gitlab_project_hook.go b/internal/provider/data_source_gitlab_project_hook.go
@@ -0,0 +1,39 @@
+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_hook", func() *schema.Resource {
+	return &schema.Resource{
+		Description: `The ` + "`gitlab_project_hook`" + ` data source allows to retrieve details about a hook in a project.
+
+**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/projects.html#get-project-hook)`,
+
+		ReadContext: dataSourceGitlabProjectHookRead,
+		Schema:      datasourceSchemaFromResourceSchema(gitlabProjectHookSchema(), []string{"project", "hook_id"}, nil),
+	}
+})
+
+func dataSourceGitlabProjectHookRead(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
+	client := meta.(*gitlab.Client)
+	project := d.Get("project").(string)
+	hookID := d.Get("hook_id").(int)
+
+	hook, _, err := client.Projects.GetProjectHook(project, hookID, gitlab.WithContext(ctx))
+	if err != nil {
+		return diag.FromErr(err)
+	}
+
+	d.SetId(fmt.Sprintf("%s:%d", project, hookID))
+	stateMap := gitlabProjectHookToStateMap(project, hook)
+	if err := setStateMapInResourceData(stateMap, d); err != nil {
+		return diag.FromErr(err)
+	}
+	return nil
+}
diff --git a/internal/provider/data_source_gitlab_project_hook_test.go b/internal/provider/data_source_gitlab_project_hook_test.go
@@ -0,0 +1,35 @@
+//go:build acceptance
+// +build acceptance
+
+package provider
+
+import (
+	"fmt"
+	"testing"
+
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource"
+)
+
+func TestAccDataSourceGitlabProjectHook_basic(t *testing.T) {
+	testProject := testAccCreateProject(t)
+	testHook := testAccCreateProjectHooks(t, testProject.ID, 1)[0]
+
+	resource.ParallelTest(t, resource.TestCase{
+		ProviderFactories: providerFactories,
+		Steps: []resource.TestStep{
+			{
+				Config: fmt.Sprintf(`
+					data "gitlab_project_hook" "this" {
+						project = "%s"
+						hook_id = %d
+					}
+				`, testProject.PathWithNamespace, testHook.ID),
+				Check: resource.ComposeTestCheckFunc(
+					resource.TestCheckResourceAttr("data.gitlab_project_hook.this", "hook_id", fmt.Sprintf("%d", testHook.ID)),
+					resource.TestCheckResourceAttr("data.gitlab_project_hook.this", "project_id", fmt.Sprintf("%d", testProject.ID)),
+					resource.TestCheckResourceAttr("data.gitlab_project_hook.this", "url", testHook.URL),
+				),
+			},
+		},
+	})
+}
diff --git a/internal/provider/data_source_gitlab_project_hooks.go b/internal/provider/data_source_gitlab_project_hooks.go
@@ -0,0 +1,69 @@
+package provider
+
+import (
+	"context"
+
+	"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_hooks", func() *schema.Resource {
+	return &schema.Resource{
+		Description: `The ` + "`gitlab_project_hooks`" + ` data source allows to retrieve details about hooks in a project.
+
+**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/projects.html#list-project-hooks)`,
+
+		ReadContext: dataSourceGitlabProjectHooksRead,
+		Schema: map[string]*schema.Schema{
+			"project": {
+				Description: "The name or id of the project.",
+				Type:        schema.TypeString,
+				Required:    true,
+			},
+			"hooks": {
+				Description: "The list of hooks.",
+				Type:        schema.TypeList,
+				Computed:    true,
+				Elem: &schema.Resource{
+					Schema: datasourceSchemaFromResourceSchema(gitlabProjectHookSchema(), nil, nil),
+				},
+			},
+		},
+	}
+})
+
+func dataSourceGitlabProjectHooksRead(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
+	client := meta.(*gitlab.Client)
+
+	project := d.Get("project").(string)
+	options := gitlab.ListProjectHooksOptions{
+		PerPage: 20,
+		Page:    1,
+	}
+
+	var hooks []*gitlab.ProjectHook
+	for options.Page != 0 {
+		paginatedHooks, resp, err := client.Projects.ListProjectHooks(project, &options, gitlab.WithContext(ctx))
+		if err != nil {
+			return diag.FromErr(err)
+		}
+
+		hooks = append(hooks, paginatedHooks...)
+		options.Page = resp.NextPage
+	}
+
+	d.SetId(project)
+	if err := d.Set("hooks", flattenGitlabProjectHooks(project, hooks)); err != nil {
+		return diag.Errorf("failed to set hooks to state: %v", err)
+	}
+
+	return nil
+}
+
+func flattenGitlabProjectHooks(project string, hooks []*gitlab.ProjectHook) (values []map[string]interface{}) {
+	for _, hook := range hooks {
+		values = append(values, gitlabProjectHookToStateMap(project, hook))
+	}
+	return values
+}
diff --git a/internal/provider/data_source_gitlab_project_hooks_test.go b/internal/provider/data_source_gitlab_project_hooks_test.go
@@ -0,0 +1,34 @@
+//go:build acceptance
+// +build acceptance
+
+package provider
+
+import (
+	"fmt"
+	"testing"
+
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource"
+)
+
+func TestAccDataSourceGitlabProjectHooks_basic(t *testing.T) {
+	testProject := testAccCreateProject(t)
+	testHooks := testAccCreateProjectHooks(t, testProject.ID, 25)
+
+	resource.ParallelTest(t, resource.TestCase{
+		ProviderFactories: providerFactories,
+		Steps: []resource.TestStep{
+			{
+				Config: fmt.Sprintf(`
+					data "gitlab_project_hooks" "this" {
+						project = "%s"
+					}
+				`, testProject.PathWithNamespace),
+				Check: resource.ComposeTestCheckFunc(
+					resource.TestCheckResourceAttr("data.gitlab_project_hooks.this", "hooks.#", fmt.Sprintf("%d", len(testHooks))),
+					resource.TestCheckResourceAttr("data.gitlab_project_hooks.this", "hooks.0.url", testHooks[0].URL),
+					resource.TestCheckResourceAttr("data.gitlab_project_hooks.this", "hooks.1.url", testHooks[1].URL),
+				),
+			},
+		},
+	})
+}
diff --git a/internal/provider/helper_test.go b/internal/provider/helper_test.go
@@ -322,6 +322,22 @@ func testAccAddProjectMembers(t *testing.T, pid interface{}, users []*gitlab.Use
 	}
 }
 
+func testAccCreateProjectHooks(t *testing.T, pid interface{}, n int) []*gitlab.ProjectHook {
+	t.Helper()
+
+	var hooks []*gitlab.ProjectHook
+	for i := 0; i < n; i++ {
+		hook, _, err := testGitlabClient.Projects.AddProjectHook(pid, &gitlab.AddProjectHookOptions{
+			URL: gitlab.String(fmt.Sprintf("https://%s.com", acctest.RandomWithPrefix("acctest"))),
+		})
+		if err != nil {
+			t.Fatalf("could not create project hook: %v", err)
+		}
+		hooks = append(hooks, hook)
+	}
+	return hooks
+}
+
 func testAccCreateClusterAgents(t *testing.T, pid interface{}, n int) []*gitlab.Agent {
 	t.Helper()
 
diff --git a/internal/provider/resource_gitlab_project_hook.go b/internal/provider/resource_gitlab_project_hook.go
diff --git a/internal/provider/schema_gitlab_project_hook.go b/internal/provider/schema_gitlab_project_hook.go
