feat: Add support for Bitbucket webhooks (#134)

epam · Oct 4, 2024 · 6902508 · 6902508
1 parent c5fb02b
commit 6902508
Show file tree

Hide file tree

Showing 29 changed files with 98,210 additions and 101 deletions.
diff --git a/.golangci.yaml b/.golangci.yaml
@@ -4,6 +4,7 @@ run:
   issues-exit-code: 1
   skip-dirs:
     - "mocks"
+    - "generated"
   skip-dirs-use-default: true
   skip-files:
     - "mock_.*\\.go"

diff --git a/Makefile b/Makefile
@@ -185,3 +185,19 @@ MOCKERY = $(LOCALBIN)/mockery
 .PHONY: mockery
 mockery: ## Download mockery locally if necessary.
 	$(call go-get-tool,$(MOCKERY),github.com/vektra/mockery/v2,v2.43.0)
+
+OAPICODEGEN ?= $(LOCALBIN)/oapi-codegen
+
+.PHONY: oapi-codegen
+oapi-codegen: $(OAPICODEGEN) ## Download oapi-codegen locally if necessary.
+$(OAPICODEGEN): $(LOCALBIN)
+	test -s $(LOCALBIN)/oapi-codegen || GOBIN=$(LOCALBIN) go install github.com/oapi-codegen/oapi-codegen/v2/cmd/oapi-codegen@latest
+
+.PHONY: update-bitbucket-swagger
+update-bitbucket-swagger: ## Update bitbucket swagger file
+	echo "Read hack/bitbucket_api_notes.md and make manual changes to hack/bitbucket_api.json after running this command"
+	curl -o hack/bitbucket_api.json https://dac-static.atlassian.com/cloud/bitbucket/swagger.v3.json?_v=2.300.64-0.1310.0
+
+.PHONY: generate-bitbucket-api-client
+generate-bitbucket-api-client: oapi-codegen ## Generate code containing DeepCopy, DeepCopyInto, and DeepCopyObject method implementations.
+	$(OAPICODEGEN) -config oapicfg.yaml hack/bitbucket_api.json
diff --git a/api/v1/codebase_types.go b/api/v1/codebase_types.go
@@ -1,6 +1,7 @@
 package v1
 
 import (
+	"strconv"
 	"strings"
 
 	metaV1 "k8s.io/apimachinery/pkg/apis/meta/v1"
@@ -193,14 +194,27 @@ type CodebaseStatus struct {
 	Git string `json:"git"`
 
 	// Stores ID of webhook which was created for a codebase.
+	// Deprecated: Because the webhook id can be more than just an integer. Use WebHookRef instead.
 	// +optional
 	WebHookID int `json:"webHookID,omitempty"`
 
+	// WebHookRef stores unique reference to webhook which was created for a codebase.
+	// +optional
+	WebHookRef string `json:"webHookRef,omitempty"`
+
 	// Stores GitWebUrl of codebase.
 	// +optional
 	GitWebUrl string `json:"gitWebUrl,omitempty"`
 }
 
+func (in *CodebaseStatus) GetWebHookRef() string {
+	if in.WebHookRef == "" && in.WebHookID != 0 {
+		return strconv.Itoa(in.WebHookID)
+	}
+
+	return in.WebHookRef
+}
+
 // +kubebuilder:object:root=true
 // +kubebuilder:subresource:status
 // +kubebuilder:resource:shortName=cdbs

diff --git a/config/crd/bases/v2.edp.epam.com_codebases.yaml b/config/crd/bases/v2.edp.epam.com_codebases.yaml
@@ -214,8 +214,14 @@ spec:
                 description: Specifies a current state of Codebase.
                 type: string
               webHookID:
-                description: Stores ID of webhook which was created for a codebase.
+                description: |-
+                  Stores ID of webhook which was created for a codebase.
+                  Deprecated: Because the webhook id can be more than just an integer. Use WebHookRef instead.
                 type: integer
+              webHookRef:
+                description: WebHookRef stores unique reference to webhook which was
+                  created for a codebase.
+                type: string
             required:
             - action
             - available

diff --git a/controllers/codebase/codebase_controller.go b/controllers/codebase/codebase_controller.go
@@ -4,6 +4,7 @@ import (
 	"context"
 	"fmt"
 	"reflect"
+	"strconv"
 	"time"
 
 	"github.com/go-logr/logr"
@@ -162,6 +163,12 @@ func (r *ReconcileCodebase) Reconcile(ctx context.Context, request reconcile.Req
 }
 
 func (r *ReconcileCodebase) updateFinishStatus(ctx context.Context, c *codebaseApi.Codebase) error {
+	// Set WebHookRef from WebHookID for backward compatibility.
+	webHookRef := c.Status.WebHookRef
+	if webHookRef == "" && c.Status.WebHookID != 0 {
+		webHookRef = strconv.Itoa(c.Status.WebHookID)
+	}
+
 	c.Status = codebaseApi.CodebaseStatus{
 		Status:          util.StatusFinished,
 		Available:       true,
@@ -173,6 +180,7 @@ func (r *ReconcileCodebase) updateFinishStatus(ctx context.Context, c *codebaseA
 		FailureCount:    0,
 		Git:             c.Status.Git,
 		WebHookID:       c.Status.WebHookID,
+		WebHookRef:      webHookRef,
 		GitWebUrl:       c.Status.GitWebUrl,
 	}
 

diff --git a/controllers/codebase/service/chain/common.go b/controllers/codebase/service/chain/common.go
@@ -3,6 +3,7 @@ package chain
 import (
 	"context"
 	"fmt"
+	"strconv"
 
 	metaV1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"sigs.k8s.io/controller-runtime/pkg/client"
@@ -12,6 +13,12 @@ import (
 )
 
 func setIntermediateSuccessFields(ctx context.Context, c client.Client, cb *codebaseApi.Codebase, action codebaseApi.ActionType) error {
+	// Set WebHookRef from WebHookID for backward compatibility.
+	webHookRef := cb.Status.WebHookRef
+	if webHookRef == "" && cb.Status.WebHookID != 0 {
+		webHookRef = strconv.Itoa(cb.Status.WebHookID)
+	}
+
 	cb.Status = codebaseApi.CodebaseStatus{
 		Status:          util.StatusInProgress,
 		Available:       false,
@@ -23,6 +30,7 @@ func setIntermediateSuccessFields(ctx context.Context, c client.Client, cb *code
 		FailureCount:    cb.Status.FailureCount,
 		Git:             cb.Status.Git,
 		WebHookID:       cb.Status.WebHookID,
+		WebHookRef:      webHookRef,
 		GitWebUrl:       cb.Status.GitWebUrl,
 	}
 

diff --git a/controllers/codebase/service/chain/delete_webhook.go b/controllers/codebase/service/chain/delete_webhook.go
@@ -39,8 +39,8 @@ func (s *DeleteWebHook) ServeRequest(ctx context.Context, codebase *codebaseApi.
 
 	log.Info("Start deleting webhook...")
 
-	if codebase.Status.WebHookID == 0 {
-		log.Info("Webhook ID is empty. Skip deleting webhook.")
+	if codebase.Status.GetWebHookRef() == "" {
+		log.Info("Webhook ref is empty. Skip deleting webhook.")
 
 		return nil
 	}
@@ -59,7 +59,7 @@ func (s *DeleteWebHook) ServeRequest(ctx context.Context, codebase *codebaseApi.
 		return nil
 	}
 
-	gitProvider, err := gitprovider.NewProvider(gitServer, s.restyClient)
+	gitProvider, err := gitprovider.NewProvider(gitServer, s.restyClient, string(secret.Data[util.GitServerSecretTokenField]))
 	if err != nil {
 		log.Error(err, "Failed to delete webhook: unable to create git provider")
 
@@ -74,7 +74,7 @@ func (s *DeleteWebHook) ServeRequest(ctx context.Context, codebase *codebaseApi.
 		gitHost,
 		string(secret.Data[util.GitServerSecretTokenField]),
 		projectID,
-		codebase.Status.WebHookID,
+		codebase.Status.GetWebHookRef(),
 	)
 	if err != nil {
 		if errors.Is(err, gitprovider.ErrWebHookNotFound) {

diff --git a/controllers/codebase/service/chain/put_project.go b/controllers/codebase/service/chain/put_project.go
@@ -4,6 +4,7 @@ import (
 	"context"
 	"fmt"
 	"os"
+	"strconv"
 
 	"golang.org/x/exp/slices"
 	corev1 "k8s.io/api/core/v1"
@@ -23,7 +24,7 @@ type PutProject struct {
 	client             client.Client
 	git                git.Git
 	gerrit             gerrit.Client
-	gitProjectProvider func(gitServer *codebaseApi.GitServer) (gitprovider.GitProjectProvider, error)
+	gitProjectProvider func(gitServer *codebaseApi.GitServer, token string) (gitprovider.GitProjectProvider, error)
 }
 
 var (
@@ -35,7 +36,7 @@ func NewPutProject(
 	c client.Client,
 	g git.Git,
 	gerritProvider gerrit.Client,
-	gitProjectProvider func(gitServer *codebaseApi.GitServer) (gitprovider.GitProjectProvider, error),
+	gitProjectProvider func(gitServer *codebaseApi.GitServer, token string) (gitprovider.GitProjectProvider, error),
 ) *PutProject {
 	return &PutProject{client: c, git: g, gerrit: gerritProvider, gitProjectProvider: gitProjectProvider}
 }
@@ -280,7 +281,7 @@ func (h *PutProject) createGitThirdPartyProject(ctx context.Context, gitServer *
 
 	log.Info("Start creating project in git provider")
 
-	gitProvider, err := h.gitProjectProvider(gitServer)
+	gitProvider, err := h.gitProjectProvider(gitServer, gitProviderToken)
 	if err != nil {
 		return fmt.Errorf("failed to create git provider: %w", err)
 	}
@@ -355,7 +356,7 @@ func (h *PutProject) setDefaultBranch(
 
 	log.Info("Set default branch in git provider")
 
-	gitProvider, err := h.gitProjectProvider(gitServer)
+	gitProvider, err := h.gitProjectProvider(gitServer, gitProviderToken)
 	if err != nil {
 		return fmt.Errorf("failed to create git provider: %w", err)
 	}
@@ -480,6 +481,12 @@ func (h *PutProject) notEmptyProjectProvisioning(ctx context.Context, codebase *
 }
 
 func setFailedFields(c *codebaseApi.Codebase, a codebaseApi.ActionType, message string) {
+	// Set WebHookRef from WebHookID for backward compatibility.
+	webHookRef := c.Status.WebHookRef
+	if webHookRef == "" && c.Status.WebHookID != 0 {
+		webHookRef = strconv.Itoa(c.Status.WebHookID)
+	}
+
 	c.Status = codebaseApi.CodebaseStatus{
 		Status:          util.StatusFailed,
 		Available:       false,
@@ -492,6 +499,7 @@ func setFailedFields(c *codebaseApi.Codebase, a codebaseApi.ActionType, message
 		FailureCount:    c.Status.FailureCount,
 		Git:             c.Status.Git,
 		WebHookID:       c.Status.WebHookID,
+		WebHookRef:      webHookRef,
 		GitWebUrl:       c.Status.GitWebUrl,
 	}
 }
diff --git a/controllers/codebase/service/chain/put_project_test.go b/controllers/codebase/service/chain/put_project_test.go
@@ -82,8 +82,8 @@ func TestPutProject_ServeRequest(t *testing.T) {
 			Namespace: defaultNs,
 		},
 	}
-	defaultGitProvider := func(t *testing.T) func(gitServer *codebaseApi.GitServer) (gitprovider.GitProjectProvider, error) {
-		return func(gitServer *codebaseApi.GitServer) (gitprovider.GitProjectProvider, error) {
+	defaultGitProvider := func(t *testing.T) func(gitServer *codebaseApi.GitServer, token string) (gitprovider.GitProjectProvider, error) {
+		return func(gitServer *codebaseApi.GitServer, token string) (gitprovider.GitProjectProvider, error) {
 			return gitprovidermock.NewMockGitProjectProvider(t), nil
 		}
 	}
@@ -94,7 +94,7 @@ func TestPutProject_ServeRequest(t *testing.T) {
 		objects      []client.Object
 		gitClient    func(t *testing.T) git.Git
 		gerritClient func(t *testing.T) gerrit.Client
-		gitProvider  func(t *testing.T) func(gitServer *codebaseApi.GitServer) (gitprovider.GitProjectProvider, error)
+		gitProvider  func(t *testing.T) func(gitServer *codebaseApi.GitServer, token string) (gitprovider.GitProjectProvider, error)
 		wantErr      require.ErrorAssertionFunc
 		wantStatus   func(t *testing.T, status *codebaseApi.CodebaseStatus)
 	}{
@@ -898,7 +898,7 @@ func TestPutProject_ServeRequest(t *testing.T) {
 			gerritClient: func(t *testing.T) gerrit.Client {
 				return gerritmocks.NewMockClient(t)
 			},
-			gitProvider: func(t *testing.T) func(gitServer *codebaseApi.GitServer) (gitprovider.GitProjectProvider, error) {
+			gitProvider: func(t *testing.T) func(gitServer *codebaseApi.GitServer, token string) (gitprovider.GitProjectProvider, error) {
 				mock := gitprovidermock.NewMockGitProjectProvider(t)
 
 				mock.On("ProjectExists", testify.Anything, testify.Anything, testify.Anything, testify.Anything).
@@ -908,7 +908,7 @@ func TestPutProject_ServeRequest(t *testing.T) {
 					On("SetDefaultBranch", testify.Anything, testify.Anything, testify.Anything, testify.Anything, testify.Anything).
 					Return(nil)
 
-				return func(gitServer *codebaseApi.GitServer) (gitprovider.GitProjectProvider, error) {
+				return func(gitServer *codebaseApi.GitServer, token string) (gitprovider.GitProjectProvider, error) {
 					return mock, nil
 				}
 			},
@@ -954,7 +954,7 @@ func TestPutProject_ServeRequest(t *testing.T) {
 			gerritClient: func(t *testing.T) gerrit.Client {
 				return gerritmocks.NewMockClient(t)
 			},
-			gitProvider: func(t *testing.T) func(gitServer *codebaseApi.GitServer) (gitprovider.GitProjectProvider, error) {
+			gitProvider: func(t *testing.T) func(gitServer *codebaseApi.GitServer, token string) (gitprovider.GitProjectProvider, error) {
 				mock := gitprovidermock.NewMockGitProjectProvider(t)
 
 				mock.On("ProjectExists", testify.Anything, testify.Anything, testify.Anything, testify.Anything).
@@ -964,7 +964,7 @@ func TestPutProject_ServeRequest(t *testing.T) {
 					On("SetDefaultBranch", testify.Anything, testify.Anything, testify.Anything, testify.Anything, testify.Anything).
 					Return(nil)
 
-				return func(gitServer *codebaseApi.GitServer) (gitprovider.GitProjectProvider, error) {
+				return func(gitServer *codebaseApi.GitServer, token string) (gitprovider.GitProjectProvider, error) {
 					return mock, nil
 				}
 			},
@@ -1013,7 +1013,7 @@ func TestPutProject_ServeRequest(t *testing.T) {
 			gerritClient: func(t *testing.T) gerrit.Client {
 				return gerritmocks.NewMockClient(t)
 			},
-			gitProvider: func(t *testing.T) func(gitServer *codebaseApi.GitServer) (gitprovider.GitProjectProvider, error) {
+			gitProvider: func(t *testing.T) func(gitServer *codebaseApi.GitServer, token string) (gitprovider.GitProjectProvider, error) {
 				mock := gitprovidermock.NewMockGitProjectProvider(t)
 
 				mock.On("ProjectExists", testify.Anything, testify.Anything, testify.Anything, testify.Anything).
@@ -1023,7 +1023,7 @@ func TestPutProject_ServeRequest(t *testing.T) {
 					On("SetDefaultBranch", testify.Anything, testify.Anything, testify.Anything, testify.Anything, testify.Anything).
 					Return(nil)
 
-				return func(gitServer *codebaseApi.GitServer) (gitprovider.GitProjectProvider, error) {
+				return func(gitServer *codebaseApi.GitServer, token string) (gitprovider.GitProjectProvider, error) {
 					return mock, nil
 				}
 			},
@@ -1069,7 +1069,7 @@ func TestPutProject_ServeRequest(t *testing.T) {
 			gerritClient: func(t *testing.T) gerrit.Client {
 				return gerritmocks.NewMockClient(t)
 			},
-			gitProvider: func(t *testing.T) func(gitServer *codebaseApi.GitServer) (gitprovider.GitProjectProvider, error) {
+			gitProvider: func(t *testing.T) func(gitServer *codebaseApi.GitServer, token string) (gitprovider.GitProjectProvider, error) {
 				mock := gitprovidermock.NewMockGitProjectProvider(t)
 
 				mock.On("ProjectExists", testify.Anything, testify.Anything, testify.Anything, testify.Anything).
@@ -1079,7 +1079,7 @@ func TestPutProject_ServeRequest(t *testing.T) {
 					On("SetDefaultBranch", testify.Anything, testify.Anything, testify.Anything, testify.Anything, testify.Anything).
 					Return(nil)
 
-				return func(gitServer *codebaseApi.GitServer) (gitprovider.GitProjectProvider, error) {
+				return func(gitServer *codebaseApi.GitServer, token string) (gitprovider.GitProjectProvider, error) {
 					return mock, nil
 				}
 			},
@@ -1125,7 +1125,7 @@ func TestPutProject_ServeRequest(t *testing.T) {
 			gerritClient: func(t *testing.T) gerrit.Client {
 				return gerritmocks.NewMockClient(t)
 			},
-			gitProvider: func(t *testing.T) func(gitServer *codebaseApi.GitServer) (gitprovider.GitProjectProvider, error) {
+			gitProvider: func(t *testing.T) func(gitServer *codebaseApi.GitServer, token string) (gitprovider.GitProjectProvider, error) {
 				mock := gitprovidermock.NewMockGitProjectProvider(t)
 
 				mock.On("ProjectExists", testify.Anything, testify.Anything, testify.Anything, testify.Anything).
@@ -1135,7 +1135,7 @@ func TestPutProject_ServeRequest(t *testing.T) {
 					On("SetDefaultBranch", testify.Anything, testify.Anything, testify.Anything, testify.Anything, testify.Anything).
 					Return(errors.New("failed to set default branch"))
 
-				return func(gitServer *codebaseApi.GitServer) (gitprovider.GitProjectProvider, error) {
+				return func(gitServer *codebaseApi.GitServer, token string) (gitprovider.GitProjectProvider, error) {
 					return mock, nil
 				}
 			},
@@ -1164,7 +1164,7 @@ func TestPutProject_ServeRequest(t *testing.T) {
 			gerritClient: func(t *testing.T) gerrit.Client {
 				return nil
 			},
-			gitProvider: func(t *testing.T) func(gitServer *codebaseApi.GitServer) (gitprovider.GitProjectProvider, error) {
+			gitProvider: func(t *testing.T) func(gitServer *codebaseApi.GitServer, token string) (gitprovider.GitProjectProvider, error) {
 				return nil
 			},
 			wantErr: require.NoError,
@@ -1192,7 +1192,7 @@ func TestPutProject_ServeRequest(t *testing.T) {
 			gerritClient: func(t *testing.T) gerrit.Client {
 				return nil
 			},
-			gitProvider: func(t *testing.T) func(gitServer *codebaseApi.GitServer) (gitprovider.GitProjectProvider, error) {
+			gitProvider: func(t *testing.T) func(gitServer *codebaseApi.GitServer, token string) (gitprovider.GitProjectProvider, error) {
 				return nil
 			},
 			wantErr: require.NoError,
@@ -1220,7 +1220,7 @@ func TestPutProject_ServeRequest(t *testing.T) {
 			gerritClient: func(t *testing.T) gerrit.Client {
 				return nil
 			},
-			gitProvider: func(t *testing.T) func(gitServer *codebaseApi.GitServer) (gitprovider.GitProjectProvider, error) {
+			gitProvider: func(t *testing.T) func(gitServer *codebaseApi.GitServer, token string) (gitprovider.GitProjectProvider, error) {
 				return nil
 			},
 			wantErr: require.NoError,