Merge pull request #821 from timofurrer/feature/slack-service-alignment-790

resource/service_slack: use pass through importer and start alignment with upstream API. Refs #790

Author: armsnyder

docs/resources/service_slack.md

@@ -50,7 +50,7 @@ resource "gitlab_service_slack" "slack" {
 - **note_channel** (String) The name of the channel to receive note events notifications.
 - **note_events** (Boolean) Enable notifications for note events.
 - **notify_only_broken_pipelines** (Boolean) Send notifications for broken pipelines.
-- **notify_only_default_branch** (Boolean, Deprecated) DEPRECATED: This parameter has been replaced with `branches_to_be_notified`.
+- **notify_only_default_branch** (Boolean, Deprecated) This parameter has been replaced with `branches_to_be_notified`.
 - **pipeline_channel** (String) The name of the channel to receive pipeline events notifications.
 - **pipeline_events** (Boolean) Enable notifications for pipeline events.
 - **push_channel** (String) The name of the channel to receive push events notifications.
@@ -63,7 +63,7 @@ resource "gitlab_service_slack" "slack" {
 
 ### Read-Only
 
-- **job_events** (Boolean) Enable notifications for job events.
+- **job_events** (Boolean) Enable notifications for job events. **ATTENTION**: This attribute is currently not being submitted to the GitLab API, due to https://github.com/xanzy/go-gitlab/issues/1354.
 
 ## Import
 

gitlab/resource_gitlab_service_slack.go

@@ -2,7 +2,6 @@ package gitlab
 
 import (
 	"context"
-	"fmt"
 	"log"
 
 	"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
@@ -19,7 +18,7 @@ func resourceGitlabServiceSlack() *schema.Resource {
 		UpdateContext: resourceGitlabServiceSlackUpdate,
 		DeleteContext: resourceGitlabServiceSlackDelete,
 		Importer: &schema.ResourceImporter{
-			StateContext: resourceGitlabServiceSlackImportState,
+			StateContext: schema.ImportStatePassthroughContext,
 		},
 
 		Schema: map[string]*schema.Schema{
@@ -46,7 +45,7 @@ func resourceGitlabServiceSlack() *schema.Resource {
 				Computed:    true,
 			},
 			"notify_only_default_branch": {
-				Description: "DEPRECATED: This parameter has been replaced with `branches_to_be_notified`.",
+				Description: "This parameter has been replaced with `branches_to_be_notified`.",
 				Type:        schema.TypeBool,
 				Optional:    true,
 				Computed:    true,
@@ -58,58 +57,84 @@ func resourceGitlabServiceSlack() *schema.Resource {
 				Optional:    true,
 				Computed:    true,
 			},
-			"push_events": {
-				Description: "Enable notifications for push events.",
-				Type:        schema.TypeBool,
+			// TODO: Currently, go-gitlab doesn't implement this option yet.
+			//       see https://github.com/xanzy/go-gitlab/issues/1354
+			// "commit_events": {
+			// 	Description: "Enable notifications for commit events.",
+			// 	Type:        schema.TypeBool,
+			// 	Optional:    true,
+			// 	Computed:    true,
+			// },
+			"confidential_issue_channel": {
+				Description: "The name of the channel to receive confidential issue events notifications.",
+				Type:        schema.TypeString,
 				Optional:    true,
-				Computed:    true,
 			},
-			"push_channel": {
-				Description: "The name of the channel to receive push events notifications.",
-				Type:        schema.TypeString,
+			"confidential_issues_events": {
+				Description: "Enable notifications for confidential issues events.",
+				Type:        schema.TypeBool,
 				Optional:    true,
+				Computed:    true,
 			},
-			"issues_events": {
-				Description: "Enable notifications for issues events.",
+			// TODO: Currently, GitLab ignores this option (not implemented yet?), so
+			// there is no way to set it. Uncomment when this is fixed.
+			// See: https://gitlab.com/gitlab-org/gitlab-ce/issues/49730
+			// "confidential_note_channel": {
+			// 	Description: "The name of the channel to receive confidential note events notifications.",
+			// 	Type:        schema.TypeString,
+			// 	Optional:    true,
+			// },
+			"confidential_note_events": {
+				Description: "Enable notifications for confidential note events.",
 				Type:        schema.TypeBool,
 				Optional:    true,
 				Computed:    true,
 			},
+			// TODO: Currently, GitLab doesn't correctly implement the API, so this is
+			//       impossible to implement here at the moment.
+			//       see https://gitlab.com/gitlab-org/gitlab/-/issues/28903
+			// "deployment_channel": {
+			// 	Description: "The name of the channel to receive deployment events notifications.",
+			// 	Type:        schema.TypeString,
+			// 	Optional:    true,
+			// },
+			// "deployment_events": {
+			// 	Description: "Enable notifications for deployment events.",
+			// 	Type:        schema.TypeBool,
+			// 	Optional:    true,
+			// 	Computed:    true,
+			// },
 			"issue_channel": {
 				Description: "The name of the channel to receive issue events notifications.",
 				Type:        schema.TypeString,
 				Optional:    true,
 			},
-			"confidential_issues_events": {
-				Description: "Enable notifications for confidential issues events.",
+			"issues_events": {
+				Description: "Enable notifications for issues events.",
 				Type:        schema.TypeBool,
 				Optional:    true,
 				Computed:    true,
 			},
-			"confidential_issue_channel": {
-				Description: "The name of the channel to receive confidential issue events notifications.",
-				Type:        schema.TypeString,
-				Optional:    true,
-			},
-			"merge_requests_events": {
-				Description: "Enable notifications for merge requests events.",
+			// TODO: Currently, go-gitlab doesn't implement this option yet.
+			//       see https://github.com/xanzy/go-gitlab/issues/1354
+			"job_events": {
+				Description: "Enable notifications for job events. **ATTENTION**: This attribute is currently not being submitted to the GitLab API, due to https://github.com/xanzy/go-gitlab/issues/1354.",
 				Type:        schema.TypeBool,
-				Optional:    true,
 				Computed:    true,
 			},
 			"merge_request_channel": {
 				Description: "The name of the channel to receive merge request events notifications.",
 				Type:        schema.TypeString,
 				Optional:    true,
 			},
-			"tag_push_events": {
-				Description: "Enable notifications for tag push events.",
+			"merge_requests_events": {
+				Description: "Enable notifications for merge requests events.",
 				Type:        schema.TypeBool,
 				Optional:    true,
 				Computed:    true,
 			},
-			"tag_push_channel": {
-				Description: "The name of the channel to receive tag push events notifications.",
+			"note_channel": {
+				Description: "The name of the channel to receive note events notifications.",
 				Type:        schema.TypeString,
 				Optional:    true,
 			},
@@ -119,38 +144,35 @@ func resourceGitlabServiceSlack() *schema.Resource {
 				Optional:    true,
 				Computed:    true,
 			},
-			"note_channel": {
-				Description: "The name of the channel to receive note events notifications.",
+			"pipeline_channel": {
+				Description: "The name of the channel to receive pipeline events notifications.",
 				Type:        schema.TypeString,
 				Optional:    true,
 			},
-			"confidential_note_events": {
-				Description: "Enable notifications for confidential note events.",
+			"pipeline_events": {
+				Description: "Enable notifications for pipeline events.",
 				Type:        schema.TypeBool,
 				Optional:    true,
 				Computed:    true,
 			},
-			// TODO: Currently, GitLab ignores this option (not implemented yet?), so
-			// there is no way to set it. Uncomment when this is fixed.
-			// See: https://gitlab.com/gitlab-org/gitlab-ce/issues/49730
-			//"confidential_note_channel": {
-			//	Type:     schema.TypeString,
-			//	Optional: true,
-			//  Computed: true,
-			//},
-			"pipeline_events": {
-				Description: "Enable notifications for pipeline events.",
+			"push_channel": {
+				Description: "The name of the channel to receive push events notifications.",
+				Type:        schema.TypeString,
+				Optional:    true,
+			},
+			"push_events": {
+				Description: "Enable notifications for push events.",
 				Type:        schema.TypeBool,
 				Optional:    true,
 				Computed:    true,
 			},
-			"pipeline_channel": {
-				Description: "The name of the channel to receive pipeline events notifications.",
+			"tag_push_channel": {
+				Description: "The name of the channel to receive tag push events notifications.",
 				Type:        schema.TypeString,
 				Optional:    true,
 			},
-			"wiki_page_events": {
-				Description: "Enable notifications for wiki page events.",
+			"tag_push_events": {
+				Description: "Enable notifications for tag push events.",
 				Type:        schema.TypeBool,
 				Optional:    true,
 				Computed:    true,
@@ -160,49 +182,20 @@ func resourceGitlabServiceSlack() *schema.Resource {
 				Type:        schema.TypeString,
 				Optional:    true,
 			},
-			"job_events": {
-				Description: "Enable notifications for job events.",
+			"wiki_page_events": {
+				Description: "Enable notifications for wiki page events.",
 				Type:        schema.TypeBool,
+				Optional:    true,
 				Computed:    true,
 			},
 		},
 	}
 }
 
-func resourceGitlabServiceSlackSetToState(d *schema.ResourceData, service *gitlab.SlackService) error {
-	d.SetId(fmt.Sprintf("%d", service.ID))
-	d.Set("webhook", service.Properties.WebHook)
-	d.Set("username", service.Properties.Username)
-	d.Set("notify_only_broken_pipelines", bool(service.Properties.NotifyOnlyBrokenPipelines))
-	d.Set("notify_only_default_branch", bool(service.Properties.NotifyOnlyDefaultBranch))
-	d.Set("branches_to_be_notified", service.Properties.BranchesToBeNotified)
-	d.Set("push_events", service.PushEvents)
-	d.Set("push_channel", service.Properties.PushChannel)
-	d.Set("issues_events", service.IssuesEvents)
-	d.Set("issue_channel", service.Properties.IssueChannel)
-	d.Set("confidential_issues_events", service.ConfidentialIssuesEvents)
-	d.Set("confidential_issue_channel", service.Properties.ConfidentialIssueChannel)
-	d.Set("merge_requests_events", service.MergeRequestsEvents)
-	d.Set("merge_request_channel", service.Properties.MergeRequestChannel)
-	d.Set("tag_push_events", service.TagPushEvents)
-	d.Set("tag_push_channel", service.Properties.TagPushChannel)
-	d.Set("note_events", service.NoteEvents)
-	d.Set("note_channel", service.Properties.NoteChannel)
-	d.Set("confidential_note_events", service.ConfidentialNoteEvents)
-	// See comment to "confidential_note_channel" in resourceGitlabServiceSlack()
-	//d.Set("confidential_note_channel", service.Properties.ConfidentialNoteChannel)
-	d.Set("pipeline_events", service.PipelineEvents)
-	d.Set("pipeline_channel", service.Properties.PipelineChannel)
-	d.Set("wiki_page_events", service.WikiPageEvents)
-	d.Set("wiki_page_channel", service.Properties.WikiPageChannel)
-	d.Set("job_events", service.JobEvents)
-
-	return nil
-}
-
 func resourceGitlabServiceSlackCreate(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
 	client := meta.(*gitlab.Client)
 	project := d.Get("project").(string)
+	d.SetId(project)
 
 	log.Printf("[DEBUG] create gitlab slack service for project %s", project)
 
@@ -214,23 +207,38 @@ func resourceGitlabServiceSlackCreate(ctx context.Context, d *schema.ResourceDat
 	opts.NotifyOnlyBrokenPipelines = gitlab.Bool(d.Get("notify_only_broken_pipelines").(bool))
 	opts.NotifyOnlyDefaultBranch = gitlab.Bool(d.Get("notify_only_default_branch").(bool))
 	opts.BranchesToBeNotified = gitlab.String(d.Get("branches_to_be_notified").(string))
-	opts.PushEvents = gitlab.Bool(d.Get("push_events").(bool))
-	opts.PushChannel = gitlab.String(d.Get("push_channel").(string))
-	opts.IssuesEvents = gitlab.Bool(d.Get("issues_events").(bool))
-	opts.IssueChannel = gitlab.String(d.Get("issue_channel").(string))
-	opts.ConfidentialIssuesEvents = gitlab.Bool(d.Get("confidential_issues_events").(bool))
+	// TODO: Currently, go-gitlab doesn't implement this option yet.
+	//       see https://github.com/xanzy/go-gitlab/issues/1354
+	// opts.CommitEvents = gitlab.Bool(d.Get("commit_events").(bool))
 	opts.ConfidentialIssueChannel = gitlab.String(d.Get("confidential_issue_channel").(string))
-	opts.MergeRequestsEvents = gitlab.Bool(d.Get("merge_requests_events").(bool))
+	opts.ConfidentialIssuesEvents = gitlab.Bool(d.Get("confidential_issues_events").(bool))
+	// TODO: Currently, GitLab ignores this option (not implemented yet?), so
+	// there is no way to set it. Uncomment when this is fixed.
+	// See: https://gitlab.com/gitlab-org/gitlab-ce/issues/49730
+	// opts.ConfidentialNoteChannel = gitlab.String(d.Get("confidential_note_channel").(string))
+	opts.ConfidentialNoteEvents = gitlab.Bool(d.Get("confidential_note_events").(bool))
+	// TODO: Currently, GitLab doesn't correctly implement the API, so this is
+	//       impossible to implement here at the moment.
+	//       see https://gitlab.com/gitlab-org/gitlab/-/issues/28903
+	// opts.DeploymentChannel = gitlab.String(d.Get("deployment_channel").(string))
+	// opts.DeploymentEvents = gitlab.Bool(d.Get("deployment_events").(bool))
+	opts.IssueChannel = gitlab.String(d.Get("issue_channel").(string))
+	opts.IssuesEvents = gitlab.Bool(d.Get("issues_events").(bool))
+	// TODO: Currently, go-gitlab doesn't implement this option yet.
+	//       see https://github.com/xanzy/go-gitlab/issues/1354
+	// opts.JobEvents = gitlab.Bool(d.Get("job_events").(bool))
 	opts.MergeRequestChannel = gitlab.String(d.Get("merge_request_channel").(string))
-	opts.TagPushEvents = gitlab.Bool(d.Get("tag_push_events").(bool))
-	opts.TagPushChannel = gitlab.String(d.Get("tag_push_channel").(string))
-	opts.NoteEvents = gitlab.Bool(d.Get("note_events").(bool))
+	opts.MergeRequestsEvents = gitlab.Bool(d.Get("merge_requests_events").(bool))
 	opts.NoteChannel = gitlab.String(d.Get("note_channel").(string))
-	opts.ConfidentialNoteEvents = gitlab.Bool(d.Get("confidential_note_events").(bool))
-	opts.PipelineEvents = gitlab.Bool(d.Get("pipeline_events").(bool))
+	opts.NoteEvents = gitlab.Bool(d.Get("note_events").(bool))
 	opts.PipelineChannel = gitlab.String(d.Get("pipeline_channel").(string))
-	opts.WikiPageEvents = gitlab.Bool(d.Get("wiki_page_events").(bool))
+	opts.PipelineEvents = gitlab.Bool(d.Get("pipeline_events").(bool))
+	opts.PushChannel = gitlab.String(d.Get("push_channel").(string))
+	opts.PushEvents = gitlab.Bool(d.Get("push_events").(bool))
+	opts.TagPushChannel = gitlab.String(d.Get("tag_push_channel").(string))
+	opts.TagPushEvents = gitlab.Bool(d.Get("tag_push_events").(bool))
 	opts.WikiPageChannel = gitlab.String(d.Get("wiki_page_channel").(string))
+	opts.WikiPageEvents = gitlab.Bool(d.Get("wiki_page_events").(bool))
 
 	_, err := client.Services.SetSlackService(project, opts, gitlab.WithContext(ctx))
 	if err != nil {
@@ -242,7 +250,7 @@ func resourceGitlabServiceSlackCreate(ctx context.Context, d *schema.ResourceDat
 
 func resourceGitlabServiceSlackRead(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
 	client := meta.(*gitlab.Client)
-	project := d.Get("project").(string)
+	project := d.Id()
 
 	log.Printf("[DEBUG] read gitlab slack service for project %s", project)
 
@@ -256,9 +264,41 @@ func resourceGitlabServiceSlackRead(ctx context.Context, d *schema.ResourceData,
 		return diag.FromErr(err)
 	}
 
-	if err = resourceGitlabServiceSlackSetToState(d, service); err != nil {
-		return diag.FromErr(err)
-	}
+	d.Set("project", project)
+	d.Set("webhook", service.Properties.WebHook)
+	d.Set("username", service.Properties.Username)
+	d.Set("notify_only_broken_pipelines", bool(service.Properties.NotifyOnlyBrokenPipelines))
+	d.Set("notify_only_default_branch", bool(service.Properties.NotifyOnlyDefaultBranch))
+	d.Set("branches_to_be_notified", service.Properties.BranchesToBeNotified)
+	d.Set("confidential_issue_channel", service.Properties.ConfidentialIssueChannel)
+	d.Set("confidential_issues_events", service.ConfidentialIssuesEvents)
+	// TODO: Currently, GitLab ignores this option (not implemented yet?), so
+	// there is no way to set it. Uncomment when this is fixed.
+	// See: https://gitlab.com/gitlab-org/gitlab-ce/issues/49730
+	// d.Set("confidential_note_channel", service.Properties.ConfidentialNoteChannel)
+	d.Set("confidential_note_events", service.ConfidentialNoteEvents)
+	// TODO: Currently, GitLab doesn't correctly implement the API, so this is
+	//       impossible to implement here at the moment.
+	//       see https://gitlab.com/gitlab-org/gitlab/-/issues/28903
+	// d.Set("deployment_channel", service.Properties.DeploymentChannel)
+	// d.Set("deployment_events", service.DeploymentEvents)
+	d.Set("issue_channel", service.Properties.IssueChannel)
+	d.Set("issues_events", service.IssuesEvents)
+	// TODO: Currently, go-gitlab doesn't implement this option yet.
+	//       see https://github.com/xanzy/go-gitlab/issues/1354
+	d.Set("job_events", service.JobEvents)
+	d.Set("merge_request_channel", service.Properties.MergeRequestChannel)
+	d.Set("merge_requests_events", service.MergeRequestsEvents)
+	d.Set("note_channel", service.Properties.NoteChannel)
+	d.Set("note_events", service.NoteEvents)
+	d.Set("pipeline_channel", service.Properties.PipelineChannel)
+	d.Set("pipeline_events", service.PipelineEvents)
+	d.Set("push_channel", service.Properties.PushChannel)
+	d.Set("push_events", service.PushEvents)
+	d.Set("tag_push_channel", service.Properties.TagPushChannel)
+	d.Set("tag_push_events", service.TagPushEvents)
+	d.Set("wiki_page_channel", service.Properties.WikiPageChannel)
+	d.Set("wiki_page_events", service.WikiPageEvents)
 
 	return nil
 }
@@ -269,7 +309,7 @@ func resourceGitlabServiceSlackUpdate(ctx context.Context, d *schema.ResourceDat
 
 func resourceGitlabServiceSlackDelete(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
 	client := meta.(*gitlab.Client)
-	project := d.Get("project").(string)
+	project := d.Id()
 
 	log.Printf("[DEBUG] delete gitlab slack service for project %s", project)
 
@@ -280,9 +320,3 @@ func resourceGitlabServiceSlackDelete(ctx context.Context, d *schema.ResourceDat
 
 	return nil
 }
-
-func resourceGitlabServiceSlackImportState(ctx context.Context, d *schema.ResourceData, meta interface{}) ([]*schema.ResourceData, error) {
-	d.Set("project", d.Id())
-
-	return []*schema.ResourceData{d}, nil
-}