feat: support project-level Mattermost integration (client-go v1) by Vadims-U · Pull Request #268 · crossplane-contrib/provider-gitlab

Vadims-U · 2026-01-08T20:30:19Z

This PR completes and modernizes support for project‑level Mattermost integration, originally started in draft PR #261. The draft required updates to work with the new gitlab-org/api/client-go v1 SDK and recent provider changes.

This PR:

updates the original implementation to the new API client,
fixes type mismatches introduced by the SDK migration (migrated all necessary numeric fields to int64),
completes missing functionality,
cleans up API types,
brings the resource to a fully working, test‑verified state.

I recommend a squash merge to keep history clean.

Refs #250. Supersedes #261. Builds on top of #264.

What was done

Based on draft PR #261

The initial implementation was outdated and non‑functional. Main issues:

old client-go usage,
deprecated numeric types (int → int64),
incompatible with client-go v1.

This PR completes and modernizes that draft.

Changes in this PR

Updated to client-go v1 (using #264)

migrated numeric fields to *int64,
updated client calls to new signatures,
resolved compile errors after SDK update.

Completed implementation

finished controller logic,
fixed Create / Update logic
implemented reference resolution

Regenerated and aligned code

regenerated CRDs, deepcopy, referencers and managed types via make generate,
fixed schema inconsistencies after migrating to int64.

Tests & validation

repaired tests from the draft,
validated against a self‑hosted GitLab CE.

Reconciliation behavior

Observe – reads integration state
LateInit – fills defaults without overriding user input
Create/Update – applies configuration idempotently via API v1
UpToDate – compares only fields supported by the API
Delete – no‑op (GitLab API supposedly cannot disable this integration?)

Test environment & workflow

Environment:

Windows 11 / WSL2 Ubuntu
Podman inside WSL2

kind cluster (Podman provider):

KIND_EXPERIMENTAL_PROVIDER=podman kind create cluster --name gitlab

Crossplane via Helm:

helm repo add crossplane-stable https://charts.crossplane.io/stable
helm install crossplane --namespace crossplane-system --create-namespace crossplane-stable/crossplane

Provider built locally:

make go.build && ./_output/bin/linux_amd64/provider --debug

Test steps:

Create secret with PAT:

kubectl create secret generic gitlab-credentials -n crossplane-system --from-literal=token=EXAMPLE_VALUE

Apply ProviderConfig:

apiVersion: gitlab.m.crossplane.io/v1beta1
kind: ProviderConfig
metadata:
  name: gitlab-provider
  namespace: default
spec:
  baseURL: https://REDACTED_URL/
  credentials:
    source: Secret
    method: PersonalAccessToken
    secretRef:
      namespace: crossplane-system
      name: gitlab-credentials
      key: token

Apply examples/projects/integration_mattermost.yaml.
Verify parameters applied correctly.
Update CRD fields and confirm correct reconciliation.
Modify integration manually in GitLab and re‑verify.
Delete resource and confirm no‑op behavior.

Example manifest used during testing

apiVersion: projects.gitlab.m.crossplane.io/v1alpha1
kind: IntegrationMattermost
metadata:
  name: mm-integration-test
spec:
  forProvider:
    projectId: <PROJECT_ID>
    webhook: "https://example.com/hooks/test"
    username: "gitlab-bot"
    notifyOnlyBrokenPipelines: false
    pushEvents: false
    issuesEvents: true
    mergeRequestsEvents: true
    tagPushEvents: false
    noteEvents: true
    pipelineEvents: true
    wikiPageEvents: true

  providerConfigRef:
    kind: ProviderConfig
    name: gitlab-provider

MisterMX · 2026-01-12T16:10:02Z

.gitignore

+# Local testing
+gitlab/
+docker-compose.yml
+test-resources/


I wouldn't consider these files "common" in the sense that everyone uses them for his local dev setup. I case of custom files you want to ignore you can add them to .git/info/exclude which acts as a kind of local gitignore that is not committed.

MisterMX · 2026-01-13T09:00:44Z

apis/cluster/projects/v1alpha1/zz_integration_mattermost_types.go

+
+	// Send notifications for broken pipelines.
+	// +optional
+	NotifyOnlyBrokenPipelines *bool `json:"notify_only_broken_pipelines,omitempty"`


General rule for API property naming: JSON names should not use underscores and use camel case for the first letter: i.e. projectId instead of projectID or project_id. Does not apply to Go field names: There it is ProjectID instead of ProjectId.

Suggested change

NotifyOnlyBrokenPipelines *bool `json:"notify_only_broken_pipelines,omitempty"`

NotifyOnlyBrokenPipelines *bool `json:"notifyOnlyBrokenPipelines,omitempty"`

pkg/namespaced/controller/projects/integrationmattermost/controller.go

MisterMX · 2026-01-14T09:48:09Z

pkg/namespaced/controller/projects/integration_mattermost/controller.go

+func (e *external) Update(ctx context.Context, mg resource.Managed) (managed.ExternalUpdate, error) {
+	cr, ok := mg.(*v1alpha1.IntegrationMattermost)
+	if !ok {
+		return managed.ExternalUpdate{}, errors.New(errNotIntegrationMattermost)
+	}
+
+	cr.Status.SetConditions(xpv1.Creating())
+
+	// Call GitLab Mattermost service API
+	_, _, err := e.client.SetMattermostService(
+		*cr.Spec.ForProvider.ProjectID,
+		projects.GenerateSetMattermostServiceOptions(&cr.Spec.ForProvider),
+		gitlab.WithContext(ctx))
+	if err != nil {
+		return managed.ExternalUpdate{}, errors.Wrap(err, errUpdateFailed)
+	}
+
+	return managed.ExternalUpdate{}, nil
+}


Create and Update functions are basically identical so we can move the call to SetMatterMost() into an extra function and just call it in both.

MisterMX · 2026-01-14T09:51:18Z

pkg/namespaced/controller/projects/integration_mattermost/controller.go

+	if err != nil {
+		if clients.IsResponseNotFound(res) {
+			return managed.ExternalObservation{ResourceExists: false}, nil
+		}
+		return managed.ExternalObservation{}, errors.Wrap(err, errGetFailed)
+	}


Can be simplified. errors.Wrap() returns nil for nil errors.

Also, false is default value for boolean fields, so ResourceExists: false is implied.

Suggested change

if err != nil {

if clients.IsResponseNotFound(res) {

return managed.ExternalObservation{ResourceExists: false}, nil

}

return managed.ExternalObservation{}, errors.Wrap(err, errGetFailed)

}

if resource.Ignore(clients.IsResponseNotFound, err) != nil {

return managed.ExternalObservation{}, errors.Wrap(err, errGetFailed)

}

pkg/namespaced/controller/projects/integrationmattermost/controller.go

MisterMX · 2026-01-23T10:53:09Z

apis/common/v1alpha1/integration.go

+	ID                             int64        `json:"id"`
+	Title                          string       `json:"title"`
+	Slug                           string       `json:"slug"`
+	CreatedAt                      *metav1.Time `json:"createdAt,omitempty"`
+	UpdatedAt                      *metav1.Time `json:"updatedAt,omitempty"`
+	Active                         bool         `json:"active"`
+	AlertEvents                    bool         `json:"alertEvents"`
+	CommitEvents                   bool         `json:"commitEvents"`
+	ConfidentialIssuesEvents       bool         `json:"confidentialIssuesEvents"`
+	ConfidentialNoteEvents         bool         `json:"confidentialNoteEvents"`
+	DeploymentEvents               bool         `json:"deploymentEvents"`
+	GroupConfidentialMentionEvents bool         `json:"groupConfidentialMentionEvents"`
+	GroupMentionEvents             bool         `json:"groupMentionEvents"`
+	IncidentEvents                 bool         `json:"incidentEvents"`
+	IssuesEvents                   bool         `json:"issuesEvents"`
+	JobEvents                      bool         `json:"jobEvents"`
+	MergeRequestsEvents            bool         `json:"mergeRequestsEvents"`
+	NoteEvents                     bool         `json:"noteEvents"`
+	PipelineEvents                 bool         `json:"pipelineEvents"`
+	PushEvents                     bool         `json:"pushEvents"`
+	TagPushEvents                  bool         `json:"tagPushEvents"`
+	VulnerabilityEvents            bool         `json:"vulnerabilityEvents"`
+	WikiPageEvents                 bool         `json:"wikiPageEvents"`
+	CommentOnEventEnabled          bool         `json:"commentOnEventEnabled"`
+	Inherited                      bool         `json:"inherited"`


Not sure, but I think they should be optional. Otherwise we might run into an error at the end of the reconcilation when the status update fails due to a missing field.

henrysachs · 2026-01-23T19:00:50Z

@Vadims-U you probably need to merge the latest changes i did to the branch into yours. But I would recommend waiting for my MR to hit master. Also I could imagine that you receive a lot of Merge conflicts because i had to merge all commits into one. Just as a heads up! sorry!

Vadims-U · 2026-01-26T11:52:25Z

@Vadims-U you probably need to merge the latest changes i did to the branch into yours. But I would recommend waiting for my MR to hit master. Also I could imagine that you receive a lot of Merge conflicts because i had to merge all commits into one. Just as a heads up! sorry!

Hi! Nothing to worry about. Thanks for the heads up - I’ll wait for the MR to land in master 👍

henrysachs · 2026-01-30T08:52:43Z

@Vadims-U now that my PR has landed would you be so kind and update your PR?

henrysachs · 2026-02-02T08:11:44Z

@Vadims-U I think you forgot to sign your Commit would you be so kind and do this? :)

MisterMX · 2026-02-10T16:08:21Z

apis/namespaced/projects/v1alpha1/hook_types.go

 	// PushEventsBranchFilter triggers hook on push events for matching branches only.
 	// +optional
-	PushEventsBranchFilter *string `json:"pushEventsBranch_filter,omitempty"`
+	PushEventsBranchFilter *string `json:"pushEventsBranchFilter,omitempty"`


Is this change related to this PR? If not it is a breaking change, which we should avoid.

MisterMX · 2026-02-10T16:08:38Z

apis/common/v1alpha1/integration.go

+type CommonIntegrationParameters struct {
+	// Send notifications for broken pipelines.
+	// +optional
+	NotifyOnlyBrokenPipelines *bool `json:"notify_only_broken_pipelines,omitempty"`


Please replace underscores with camel case.

MisterMX · 2026-02-10T16:09:18Z

apis/namespaced/projects/v1alpha1/runner_types.go

@@ -93,7 +93,7 @@ type RunnerProject struct {
 	// PathWithNamespace is the full path of the project including its namespace.
 	// This follows the format "namespace/project-path" and is used in URLs.
 	// +optional
-	PathWithNamespace string `json:"path_with_namespace"`
+	PathWithNamespace string `json:"pathWithNamespace"`


I think this is a breaking change as well.

MisterMX · 2026-02-10T16:12:08Z

pkg/common/project_integration.go

+func ptrBool(v bool) *bool       { return &v }
+func ptrInt64(v int64) *int64    { return &v }
+func ptrString(v string) *string { return &v }


Please use the ptr package instead: https://pkg.go.dev/k8s.io/utils/ptr

MisterMX · 2026-02-10T16:13:11Z

pkg/common/helper.go

+// Int64PtrToInt64Ptr is a no-op now that CRDs use int64
+// Kept for API compatibility
+func Int64PtrToInt64Ptr(v *int64) *int64 {
+	return v
+}
+
+// IntToInt64 converts int to int64
+func IntToInt64(v int) int64 {
+	return int64(v)
+}
+
+// Int64ToInt converts int64 to int
+func Int64ToInt(v int64) int {
+	return int(v)
+}


Do we really need this functions?

This should be removed as soon as Main is rebased into this branch

henrysachs · 2026-02-17T13:08:02Z

@Vadims-U would you be so kind and merge master into your branch so everythings up to date?

Migrate all CRD field types from *int to *int64 to align with GitLab client-go v1.0 API which uses int64 for all ID fields. This is NOT a breaking change for users as YAML/JSON does not distinguish between int and int64 - both serialize as numbers. Changes: - Update all API type definitions in apis/namespaced/ - Update all API type definitions in apis/cluster/ - Update helper functions: IsIntEqualToIntPtr -> IsInt64EqualToInt64Ptr - Update client code to remove unnecessary int() casts - Update controller code to work with int64 types directly - Regenerate deepcopy code for all API packages - Regenerate cluster-scoped files from namespaced templates Benefits: - Eliminates hundreds of manual type conversions - Direct compatibility with GitLab API types - More maintainable codebase - Prevents potential overflow issues with large IDs Files affected: - All *_types.go files in apis/namespaced/ and apis/cluster/ - Client implementations in pkg/namespaced/clients/ - Controller implementations in pkg/namespaced/controller/ - Generated cluster-scoped equivalents Related to GitLab client-go v1.0 migration. Signed-off-by: Henry Sachs <henry.sachs@deutschebahn.com>

Signed-off-by: BoxBoxJason <contact@boxboxjason.dev> Signed-off-by: Vadims-U <vadims.ubikins@accenture.com> # Conflicts: # apis/cluster/projects/v1alpha1/zz_register.go # apis/namespaced/projects/v1alpha1/register.go # pkg/cluster/controller/projects/zz_setup.go # pkg/namespaced/controller/projects/setup.go

Signed-off-by: Vadims-U <vadims.ubikins@accenture.com>

…lints Signed-off-by: Vadims-U <vadims.ubikins@accenture.com>

MisterMX · 2026-03-02T12:10:50Z

package/crds/projects.gitlab.crossplane.io_projects.yaml

                      keepN:
                        format: int64
                        type: integer
-                      name_regex:


Don't rename this

MisterMX · 2026-03-02T12:11:10Z

package/crds/projects.gitlab.m.crossplane.io_projects.yaml

                      keepN:
                        format: int64
                        type: integer
-                      name_regex:


Don't rename this

…lints Signed-off-by: Vadims-U <vadims.ubikins@accenture.com>

henrysachs · 2026-03-03T08:38:44Z

@Vadims-U the DCO is still failing so you need to sign off your commits please

… behavior, full test suite, controller fixes Signed-off-by: Vadims-U <vadims.ubikins@accenture.com>

MisterMX

LGTM. Thank you very much @Vadims-U!

Vadims-U force-pushed the feature/mm-on-clientgo-v1 branch from 1d25ab6 to cd200fd Compare January 9, 2026 08:36

MisterMX reviewed Jan 12, 2026

View reviewed changes

MisterMX requested changes Jan 13, 2026

View reviewed changes

MisterMX requested changes Jan 14, 2026

View reviewed changes

Vadims-U force-pushed the feature/mm-on-clientgo-v1 branch from cd200fd to a221715 Compare January 19, 2026 16:22

MisterMX requested changes Jan 23, 2026

View reviewed changes

Vadims-U force-pushed the feature/mm-on-clientgo-v1 branch from a221715 to f1931d4 Compare January 23, 2026 16:36

Vadims-U force-pushed the feature/mm-on-clientgo-v1 branch from f1931d4 to a55949e Compare January 30, 2026 17:49

Vadims-U force-pushed the feature/mm-on-clientgo-v1 branch 4 times, most recently from 60c4235 to 3a83f8f Compare February 2, 2026 13:06

BoxBoxJason mentioned this pull request Feb 2, 2026

feat: support mattermost notifications integration #261

Closed

3 tasks

MisterMX mentioned this pull request Feb 10, 2026

Support external application project integrations #250

Open

13 tasks

MisterMX requested changes Feb 10, 2026

View reviewed changes

henrysachs and others added 4 commits February 23, 2026 12:41

Mattermost integration + int64 migration

c8498ec

Signed-off-by: Vadims-U <vadims.ubikins@accenture.com>

chore: regen & align after rebase onto upstream/master (SDK v1); fix …

307d896

…lints Signed-off-by: Vadims-U <vadims.ubikins@accenture.com>

Vadims-U force-pushed the feature/mm-on-clientgo-v1 branch from 3a83f8f to 307d896 Compare February 25, 2026 15:03

MisterMX reviewed Mar 2, 2026

View reviewed changes

package/crds/projects.gitlab.crossplane.io_projects.yaml

keepN:

format: int64

type: integer

name_regex:

Copy link

Collaborator

MisterMX Mar 2, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't rename this

MisterMX reviewed Mar 2, 2026

View reviewed changes

package/crds/projects.gitlab.m.crossplane.io_projects.yaml

keepN:

format: int64

type: integer

name_regex:

Copy link

Collaborator

MisterMX Mar 2, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't rename this

chore: regen & align after rebase onto upstream/master (SDK v1); fix …

95750a3

…lints Signed-off-by: Vadims-U <vadims.ubikins@accenture.com>

MisterMX mentioned this pull request Mar 3, 2026

Support Github integration #289

Open

Mattermost Integration: add LateInit, robust IsUpToDate, safe webhook…

2da3977

… behavior, full test suite, controller fixes Signed-off-by: Vadims-U <vadims.ubikins@accenture.com>

Vadims-U force-pushed the feature/mm-on-clientgo-v1 branch from 2c5241e to 2da3977 Compare March 3, 2026 10:28

MisterMX approved these changes Mar 5, 2026

View reviewed changes

MisterMX merged commit df8bd77 into crossplane-contrib:master Mar 5, 2026
8 checks passed

	NotifyOnlyBrokenPipelines *bool `json:"notify_only_broken_pipelines,omitempty"`
	NotifyOnlyBrokenPipelines *bool `json:"notifyOnlyBrokenPipelines,omitempty"`

Conversation

Vadims-U commented Jan 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What was done

Based on draft PR #261

Changes in this PR

Updated to client-go v1 (using #264)

Completed implementation

Regenerated and aligned code

Tests & validation

Reconciliation behavior

Test environment & workflow

Example manifest used during testing

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

henrysachs commented Jan 23, 2026

Uh oh!

Vadims-U commented Jan 26, 2026

Uh oh!

henrysachs commented Jan 30, 2026

Uh oh!

henrysachs commented Feb 2, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

henrysachs commented Feb 17, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

henrysachs commented Mar 3, 2026

Uh oh!

MisterMX left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Vadims-U commented Jan 8, 2026 •

edited

Loading