Merge branch 'feat/group-mattermost-integration' into 'main' (a1f5e474) · Commits · GitLab.org / API / client-go

group_integrations.go

0 → 100644

+184 −0

Original line number	Diff line number	Diff line
		package gitlab

		import (
		"net/http"
		"time"
		)

		// GroupMattermostIntegration represents a Mattermost integration for a group.
		//
		// GitLab API docs:
		// https://docs.gitlab.com/api/group_integrations/#mattermost-notifications
		type GroupMattermostIntegration struct {
		Integration
		NotifyOnlyBrokenPipelines bool `json:"notify_only_broken_pipelines"`
		BranchesToBeNotified string `json:"branches_to_be_notified"`
		LabelsToBeNotified string `json:"labels_to_be_notified"`
		LabelsToBeNotifiedBehavior string `json:"labels_to_be_notified_behavior"`
		NotifyOnlyDefaultBranch bool `json:"notify_only_default_branch"`
		Properties *GroupMattermostIntegrationProperties `json:"properties"`
		}

		type GroupMattermostIntegrationProperties struct {
		WebHook string `json:"webhook"`
		Username string `json:"username"`
		Channel string `json:"channel"`
		PushChannel string `json:"push_channel"`
		IssueChannel string `json:"issue_channel"`
		ConfidentialIssueChannel string `json:"confidential_issue_channel"`
		MergeRequestChannel string `json:"merge_request_channel"`
		NoteChannel string `json:"note_channel"`
		ConfidentialNoteChannel string `json:"confidential_note_channel"`
		TagPushChannel string `json:"tag_push_channel"`
		PipelineChannel string `json:"pipeline_channel"`
		WikiPageChannel string `json:"wiki_page_channel"`
		DeploymentChannel string `json:"deployment_channel"`
		AlertChannel string `json:"alert_channel"`
		VulnerabilityChannel string `json:"vulnerability_channel"`
		}

		// GroupMattermostIntegrationOptions represents the available options for
		// creating or updating a Mattermost integration for a group.
		//
		// GitLab API docs:
		// https://docs.gitlab.com/api/group_integrations/#mattermost-notifications
		type GroupMattermostIntegrationOptions struct {
		WebHook *string `url:"webhook,omitempty" json:"webhook,omitempty"`
		Username *string `url:"username,omitempty" json:"username,omitempty"`
		Channel *string `url:"channel,omitempty" json:"channel,omitempty"`
		NotifyOnlyBrokenPipelines *bool `url:"notify_only_broken_pipelines,omitempty" json:"notify_only_broken_pipelines,omitempty"`
		BranchesToBeNotified *string `url:"branches_to_be_notified,omitempty" json:"branches_to_be_notified,omitempty"`
		PushEvents *bool `url:"push_events,omitempty" json:"push_events,omitempty"`
		IssuesEvents *bool `url:"issues_events,omitempty" json:"issues_events,omitempty"`
		ConfidentialIssuesEvents *bool `url:"confidential_issues_events,omitempty" json:"confidential_issues_events,omitempty"`
		MergeRequestsEvents *bool `url:"merge_requests_events,omitempty" json:"merge_requests_events,omitempty"`
		TagPushEvents *bool `url:"tag_push_events,omitempty" json:"tag_push_events,omitempty"`
		NoteEvents *bool `url:"note_events,omitempty" json:"note_events,omitempty"`
		ConfidentialNoteEvents *bool `url:"confidential_note_events,omitempty" json:"confidential_note_events,omitempty"`
		PipelineEvents *bool `url:"pipeline_events,omitempty" json:"pipeline_events,omitempty"`
		WikiPageEvents *bool `url:"wiki_page_events,omitempty" json:"wiki_page_events,omitempty"`
		DeploymentEvents *bool `url:"deployment_events,omitempty" json:"deployment_events,omitempty"`
		AlertEvents *bool `url:"alert_events,omitempty" json:"alert_events,omitempty"`
		VulnerabilityEvents *bool `url:"vulnerability_events,omitempty" json:"vulnerability_events,omitempty"`
		PushChannel *string `url:"push_channel,omitempty" json:"push_channel,omitempty"`
		IssueChannel *string `url:"issue_channel,omitempty" json:"issue_channel,omitempty"`
		ConfidentialIssueChannel *string `url:"confidential_issue_channel,omitempty" json:"confidential_issue_channel,omitempty"`
		MergeRequestChannel *string `url:"merge_request_channel,omitempty" json:"merge_request_channel,omitempty"`
		NoteChannel *string `url:"note_channel,omitempty" json:"note_channel,omitempty"`
		ConfidentialNoteChannel *string `url:"confidential_note_channel,omitempty" json:"confidential_note_channel,omitempty"`
		TagPushChannel *string `url:"tag_push_channel,omitempty" json:"tag_push_channel,omitempty"`
		PipelineChannel *string `url:"pipeline_channel,omitempty" json:"pipeline_channel,omitempty"`
		WikiPageChannel *string `url:"wiki_page_channel,omitempty" json:"wiki_page_channel,omitempty"`
		DeploymentChannel *string `url:"deployment_channel,omitempty" json:"deployment_channel,omitempty"`
		AlertChannel *string `url:"alert_channel,omitempty" json:"alert_channel,omitempty"`
		VulnerabilityChannel *string `url:"vulnerability_channel,omitempty" json:"vulnerability_channel,omitempty"`
		LabelsToBeNotified *string `url:"labels_to_be_notified,omitempty" json:"labels_to_be_notified,omitempty"`
		LabelsToBeNotifiedBehavior *string `url:"labels_to_be_notified_behavior,omitempty" json:"labels_to_be_notified_behavior,omitempty"`
		NotifyOnlyDefaultBranch *bool `url:"notify_only_default_branch,omitempty" json:"notify_only_default_branch,omitempty"`
		UseInheritedSettings *bool `url:"use_inherited_settings,omitempty" json:"use_inherited_settings,omitempty"`
		}

		// GetGroupMattermostIntegration retrieves the Mattermost integration for a group.
		//
		// GitLab API docs:
		// https://docs.gitlab.com/api/group_integrations/#mattermost-notifications
		func (s IntegrationsService) GetGroupMattermostIntegration(gid any, options ...RequestOptionFunc) (GroupMattermostIntegration, *Response, error) {
		return do[*GroupMattermostIntegration](
		s.client,
		withPath("groups/%s/integrations/mattermost", GroupID{gid}),
		withMethod(http.MethodGet),
		withRequestOpts(options...),
		)
		}

		// SetGroupMattermostIntegration creates or updates the Mattermost integration for a group.
		//
		// GitLab API docs:
		// https://docs.gitlab.com/api/group_integrations/#mattermost-notifications
		func (s IntegrationsService) SetGroupMattermostIntegration(gid any, opt GroupMattermostIntegrationOptions, options ...RequestOptionFunc) (GroupMattermostIntegration, Response, error) {
		return do[*GroupMattermostIntegration](
		s.client,
		withPath("groups/%s/integrations/mattermost", GroupID{gid}),
		withMethod(http.MethodPut),
		withAPIOpts(opt),
		withRequestOpts(options...),
		)
		}

		// DeleteGroupMattermostIntegration removes the Mattermost integration from a group.
		//
		// GitLab API docs:
		// https://docs.gitlab.com/api/group_integrations/#mattermost-notifications
		func (s IntegrationsService) DeleteGroupMattermostIntegration(gid any, options ...RequestOptionFunc) (Response, error) {
		_, resp, err := do[none](
		s.client,
		withPath("groups/%s/integrations/mattermost", GroupID{gid}),
		withMethod(http.MethodDelete),
		withRequestOpts(options...),
		)
		return resp, err
		}

		// GroupMattermostSlashCommandsIntegration represents a Mattermost slash commands integration for a group.
		//
		// GitLab API docs:
		// https://docs.gitlab.com/api/group_integrations/#mattermost-slash-commands
		type GroupMattermostSlashCommandsIntegration struct {
		ID int `json:"id"`
		Title string `json:"title"`
		Slug string `json:"slug"`
		CreatedAt *time.Time `json:"created_at"`
		UpdatedAt *time.Time `json:"updated_at"`
		Token string `json:"token"`
		}

		// GroupMattermostSlashCommandsIntegrationOptions represents the available options for
		// creating or updating a Mattermost slash commands integration for a group.
		//
		// GitLab API docs:
		// https://docs.gitlab.com/api/group_integrations/#mattermost-slash-commands
		type GroupMattermostSlashCommandsIntegrationOptions struct {
		Token *string `url:"token,omitempty" json:"token,omitempty"`
		UseInheritedSettings *bool `url:"use_inherited_settings,omitempty" json:"use_inherited_settings,omitempty"`
		}

		// GetGroupMattermostSlashCommandsIntegration retrieves the Mattermost slash commands integration for a group.
		//
		// GitLab API docs:
		// https://docs.gitlab.com/api/group_integrations/#mattermost-slash-commands
		func (s IntegrationsService) GetGroupMattermostSlashCommandsIntegration(gid any, options ...RequestOptionFunc) (GroupMattermostSlashCommandsIntegration, *Response, error) {
		return do[*GroupMattermostSlashCommandsIntegration](
		s.client,
		withPath("groups/%s/integrations/mattermost-slash-commands", GroupID{gid}),
		withMethod(http.MethodGet),
		withRequestOpts(options...),
		)
		}

		// SetGroupMattermostSlashCommandsIntegration creates or updates the Mattermost slash commands integration for a group.
		//
		// GitLab API docs:
		// https://docs.gitlab.com/api/group_integrations/#mattermost-slash-commands
		func (s IntegrationsService) SetGroupMattermostSlashCommandsIntegration(gid any, opt GroupMattermostSlashCommandsIntegrationOptions, options ...RequestOptionFunc) (GroupMattermostSlashCommandsIntegration, Response, error) {
		return do[*GroupMattermostSlashCommandsIntegration](
		s.client,
		withPath("groups/%s/integrations/mattermost-slash-commands", GroupID{gid}),
		withMethod(http.MethodPut),
		withAPIOpts(opt),
		withRequestOpts(options...),
		)
		}

		// DeleteGroupMattermostSlashCommandsIntegration removes the Mattermost slash commands integration from a group.
		//
		// GitLab API docs:
		// https://docs.gitlab.com/api/group_integrations/#mattermost-slash-commands
		func (s IntegrationsService) DeleteGroupMattermostSlashCommandsIntegration(gid any, options ...RequestOptionFunc) (Response, error) {
		_, resp, err := do[none](
		s.client,
		withPath("groups/%s/integrations/mattermost-slash-commands", GroupID{gid}),
		withMethod(http.MethodDelete),
		withRequestOpts(options...),
		)
		return resp, err
		}

group_integrations_test.go

0 → 100644

+270 −0

Original line number	Diff line number	Diff line
		package gitlab

		import (
		"fmt"
		"net/http"
		"testing"
		"time"

		"github.com/stretchr/testify/assert"
		)

		func TestGetGroupMattermostIntegration(t *testing.T) {
		t.Parallel()
		mux, client := setup(t)

		mux.HandleFunc("/api/v4/groups/1/integrations/mattermost", func(w http.ResponseWriter, r *http.Request) {
		testMethod(t, r, http.MethodGet)
		fmt.Fprint(w, `{
		"id": 1,
		"title": "Mattermost",
		"slug": "mattermost",
		"created_at": "2023-01-01T00:00:00.000Z",
		"updated_at": "2023-01-02T00:00:00.000Z",
		"active": true,
		"notify_only_broken_pipelines": true,
		"branches_to_be_notified": "default",
		"push_events": true,
		"issues_events": true,
		"confidential_issues_events": true,
		"merge_requests_events": true,
		"tag_push_events": true,
		"note_events": true,
		"confidential_note_events": true,
		"pipeline_events": true,
		"wiki_page_events": true,
		"deployment_events": true,
		"alert_events": true,
		"vulnerability_events": true,
		"labels_to_be_notified": "label1,label2",
		"labels_to_be_notified_behavior": "match_all",
		"notify_only_default_branch": true,
		"properties": {
		"webhook": "http://mattermost.example.com/hooks/xxx",
		"channel": "#alerts",
		"username": "GitLab",
		"push_channel": "push",
		"issue_channel": "issue",
		"confidential_issue_channel": "confidential_issue",
		"merge_request_channel": "merge_request",
		"note_channel": "note",
		"confidential_note_channel": "confidential_note",
		"tag_push_channel": "tag_push",
		"pipeline_channel": "pipeline_channel",
		"wiki_page_channel": "wiki_page",
		"deployment_channel": "deployment",
		"alert_channel": "alert",
		"vulnerability_channel": "vulnerability"
		}
		}`)
		})

		gmi, resp, err := client.Integrations.GetGroupMattermostIntegration(1)
		assert.NoError(t, err)
		assert.NotNil(t, resp)

		createdAt, _ := time.Parse(time.RFC3339, "2023-01-01T00:00:00.000Z")
		updatedAt, _ := time.Parse(time.RFC3339, "2023-01-02T00:00:00.000Z")

		want := &GroupMattermostIntegration{
		Integration: Integration{
		ID: 1,
		Title: "Mattermost",
		Slug: "mattermost",
		CreatedAt: &createdAt,
		UpdatedAt: &updatedAt,
		Active: true,
		PushEvents: true,
		IssuesEvents: true,
		ConfidentialIssuesEvents: true,
		MergeRequestsEvents: true,
		TagPushEvents: true,
		NoteEvents: true,
		ConfidentialNoteEvents: true,
		PipelineEvents: true,
		WikiPageEvents: true,
		DeploymentEvents: true,
		AlertEvents: true,
		VulnerabilityEvents: true,
		},
		NotifyOnlyBrokenPipelines: true,
		BranchesToBeNotified: "default",
		LabelsToBeNotified: "label1,label2",
		LabelsToBeNotifiedBehavior: "match_all",
		NotifyOnlyDefaultBranch: true,
		Properties: &GroupMattermostIntegrationProperties{
		WebHook: "http://mattermost.example.com/hooks/xxx",
		Username: "GitLab",
		Channel: "#alerts",
		PushChannel: "push",
		IssueChannel: "issue",
		ConfidentialIssueChannel: "confidential_issue",
		MergeRequestChannel: "merge_request",
		NoteChannel: "note",
		ConfidentialNoteChannel: "confidential_note",
		TagPushChannel: "tag_push",
		PipelineChannel: "pipeline_channel",
		WikiPageChannel: "wiki_page",
		DeploymentChannel: "deployment",
		AlertChannel: "alert",
		VulnerabilityChannel: "vulnerability",
		},
		}

		assert.Equal(t, want, gmi)
		}

		func TestSetGroupMattermostIntegration(t *testing.T) {
		t.Parallel()
		mux, client := setup(t)

		mux.HandleFunc("/api/v4/groups/1/integrations/mattermost", func(w http.ResponseWriter, r *http.Request) {
		testMethod(t, r, http.MethodPut)
		fmt.Fprint(w, `{
		"id": 1,
		"title": "Mattermost",
		"slug": "mattermost",
		"created_at": "2023-01-01T00:00:00.000Z",
		"updated_at": "2023-01-02T00:00:00.000Z",
		"active": true,
		"push_events": true,
		"properties": {
		"webhook": "http://mattermost.example.com/hooks/xxx",
		"channel": "#alerts",
		"username": "GitLab"
		}
		}`)
		})

		opt := &GroupMattermostIntegrationOptions{
		WebHook: Ptr("http://mattermost.example.com/hooks/xxx"),
		Channel: Ptr("#alerts"),
		}

		gmi, resp, err := client.Integrations.SetGroupMattermostIntegration(1, opt)
		assert.NoError(t, err)
		assert.NotNil(t, resp)

		createdAt, _ := time.Parse(time.RFC3339, "2023-01-01T00:00:00.000Z")
		updatedAt, _ := time.Parse(time.RFC3339, "2023-01-02T00:00:00.000Z")

		want := &GroupMattermostIntegration{
		Integration: Integration{
		ID: 1,
		Title: "Mattermost",
		Slug: "mattermost",
		CreatedAt: &createdAt,
		UpdatedAt: &updatedAt,
		Active: true,
		PushEvents: true,
		},
		Properties: &GroupMattermostIntegrationProperties{
		WebHook: "http://mattermost.example.com/hooks/xxx",
		Channel: "#alerts",
		Username: "GitLab",
		},
		}

		assert.Equal(t, want, gmi)
		}

		func TestDeleteGroupMattermostIntegration(t *testing.T) {
		t.Parallel()
		mux, client := setup(t)

		mux.HandleFunc("/api/v4/groups/1/integrations/mattermost", func(w http.ResponseWriter, r *http.Request) {
		testMethod(t, r, http.MethodDelete)
		})

		resp, err := client.Integrations.DeleteGroupMattermostIntegration(1)
		assert.NoError(t, err)
		assert.NotNil(t, resp)
		}

		func TestGetGroupMattermostSlashCommandsIntegration(t *testing.T) {
		t.Parallel()
		mux, client := setup(t)

		mux.HandleFunc("/api/v4/groups/1/integrations/mattermost-slash-commands", func(w http.ResponseWriter, r *http.Request) {
		testMethod(t, r, http.MethodGet)
		fmt.Fprint(w, `{
		"id": 1,
		"title": "Mattermost Slash Commands",
		"slug": "mattermost-slash-commands",
		"created_at": "2023-01-01T00:00:00.000Z",
		"updated_at": "2023-01-02T00:00:00.000Z",
		"token": "secret"
		}`)
		})

		integration, resp, err := client.Integrations.GetGroupMattermostSlashCommandsIntegration(1)
		assert.NoError(t, err)
		assert.NotNil(t, resp)

		createdAt, _ := time.Parse(time.RFC3339, "2023-01-01T00:00:00.000Z")
		updatedAt, _ := time.Parse(time.RFC3339, "2023-01-02T00:00:00.000Z")

		want := &GroupMattermostSlashCommandsIntegration{
		ID: 1,
		Title: "Mattermost Slash Commands",
		Slug: "mattermost-slash-commands",
		CreatedAt: &createdAt,
		UpdatedAt: &updatedAt,
		Token: "secret",
		}

		assert.Equal(t, want, integration)
		}

		func TestSetGroupMattermostSlashCommandsIntegration(t *testing.T) {
		t.Parallel()
		mux, client := setup(t)

		mux.HandleFunc("/api/v4/groups/1/integrations/mattermost-slash-commands", func(w http.ResponseWriter, r *http.Request) {
		testMethod(t, r, http.MethodPut)
		testBodyJSON(t, r, map[string]string{"token": "new-token"})
		fmt.Fprint(w, `{
		"id": 1,
		"title": "Mattermost Slash Commands",
		"slug": "mattermost-slash-commands",
		"created_at": "2023-01-01T00:00:00.000Z",
		"updated_at": "2023-01-02T00:00:00.000Z",
		"token": "new-token"
		}`)
		})

		opt := &GroupMattermostSlashCommandsIntegrationOptions{
		Token: Ptr("new-token"),
		}

		integration, resp, err := client.Integrations.SetGroupMattermostSlashCommandsIntegration(1, opt)
		assert.NoError(t, err)
		assert.NotNil(t, resp)

		createdAt, _ := time.Parse(time.RFC3339, "2023-01-01T00:00:00.000Z")
		updatedAt, _ := time.Parse(time.RFC3339, "2023-01-02T00:00:00.000Z")

		want := &GroupMattermostSlashCommandsIntegration{
		ID: 1,
		Title: "Mattermost Slash Commands",
		Slug: "mattermost-slash-commands",
		CreatedAt: &createdAt,
		UpdatedAt: &updatedAt,
		Token: "new-token",
		}

		assert.Equal(t, want, integration)
		}

		func TestDeleteGroupMattermostSlashCommandsIntegration(t *testing.T) {
		t.Parallel()
		mux, client := setup(t)

		mux.HandleFunc("/api/v4/groups/1/integrations/mattermost-slash-commands", func(w http.ResponseWriter, r *http.Request) {
		testMethod(t, r, http.MethodDelete)
		})

		resp, err := client.Integrations.DeleteGroupMattermostSlashCommandsIntegration(1)
		assert.NoError(t, err)
		assert.NotNil(t, resp)
		}

integrations.go

+36 −0

Original line number	Diff line number	Diff line
		@@ -83,6 +83,42 @@ type (
		// GitLab API docs:
		// https://docs.gitlab.com/api/group_integrations/#get-jira-settings
		GetGroupJiraSettings(gid any, options ...RequestOptionFunc) (Integration, Response, error)

		// GetGroupMattermostIntegration retrieves the Mattermost integration for a group.
		//
		// GitLab API docs:
		// https://docs.gitlab.com/api/group_integrations/#mattermost-notifications
		GetGroupMattermostIntegration(gid any, options ...RequestOptionFunc) (GroupMattermostIntegration, Response, error)

		// SetGroupMattermostIntegration creates or updates the Mattermost integration for a group.
		//
		// GitLab API docs:
		// https://docs.gitlab.com/api/group_integrations/#mattermost-notifications
		SetGroupMattermostIntegration(gid any, opt GroupMattermostIntegrationOptions, options ...RequestOptionFunc) (GroupMattermostIntegration, *Response, error)

		// DeleteGroupMattermostIntegration removes the Mattermost integration from a group.
		//
		// GitLab API docs:
		// https://docs.gitlab.com/api/group_integrations/#mattermost-notifications
		DeleteGroupMattermostIntegration(gid any, options ...RequestOptionFunc) (*Response, error)

		// GetGroupMattermostSlashCommandsIntegration retrieves the Mattermost slash commands integration for a group.
		//
		// GitLab API docs:
		// https://docs.gitlab.com/api/group_integrations/#mattermost-slash-commands
		GetGroupMattermostSlashCommandsIntegration(gid any, options ...RequestOptionFunc) (GroupMattermostSlashCommandsIntegration, Response, error)

		// SetGroupMattermostSlashCommandsIntegration creates or updates the Mattermost slash commands integration for a group.
		//
		// GitLab API docs:
		// https://docs.gitlab.com/api/group_integrations/#mattermost-slash-commands
		SetGroupMattermostSlashCommandsIntegration(gid any, opt GroupMattermostSlashCommandsIntegrationOptions, options ...RequestOptionFunc) (GroupMattermostSlashCommandsIntegration, *Response, error)

		// DeleteGroupMattermostSlashCommandsIntegration removes the Mattermost slash commands integration from a group.
		//
		// GitLab API docs:
		// https://docs.gitlab.com/api/group_integrations/#mattermost-slash-commands
		DeleteGroupMattermostSlashCommandsIntegration(gid any, options ...RequestOptionFunc) (*Response, error)
		}

		// IntegrationsService handles communication with the group

testing/integrations_mock.go

+268 −0

File changed.

Preview size limit exceeded, changes collapsed.

gitlab_test/groups_integration_test.go

+20 −20

File changed.

Contains only whitespace changes.