refactor: Project onboarding workflow (#231)

- Refactored `put_project.go` to improve code maintainability
  - Extracted error handling into reusable `handleError` helper method
  - Consolidated git provider initialization throughout the code
  - Simplified push operation to use single call with multiple refspecs
  - Improved error messages with more context
- Rewrote tests in `put_project_test.go` with better coverage
  - Split tests into separate files for third-party Git providers and Gerrit
  - Added comprehensive test cases for success and error scenarios
  - Reduced test complexity and improved maintainability
- Enhanced GitServer API documentation
  - Added detailed description for `nameSshKeySecret` field
  - Documented required and optional secret keys for each Git provider
- Move Git package from v2 to main pkg directory
  - Updated import paths across the codebase
  - Removed deprecated package files

Author: zmotso

.mockery.yaml

@@ -21,10 +21,6 @@ packages:
     interfaces:
       Client:
   github.com/epam/edp-codebase-operator/v2/pkg/git:
-    interfaces:
-      Git:
-      Command:
-  github.com/epam/edp-codebase-operator/v2/pkg/git/v2:
     interfaces:
       Git:
   github.com/epam/edp-codebase-operator/v2/pkg/gitprovider:

api/v1/git_server_types.go

@@ -24,6 +24,16 @@ type GitServerSpec struct {
 
 	SshPort int32 `json:"sshPort"`
 
+	// NameSshKeySecret is the name of the Kubernetes secret containing Git repository credentials.
+	// Required keys:
+	//   - token: Git provider access token (required)
+	// Optional keys:
+	//   - id_rsa: SSH private key for Git operations over SSH
+	//   - secretString: Webhook secret for validating webhook requests
+	//   - username: Git username to override the default GitUser
+	// For Gerrit provider, only id_rsa key is required and used.
+	// +kubebuilder:example:=my-git-credentials
+	// +required
 	NameSshKeySecret string `json:"nameSshKeySecret"`
 
 	// GitProvider is a git provider type. It can be gerrit, github or gitlab. Default value is gerrit.

config/crd/bases/v2.edp.epam.com_gitservers.yaml

@@ -74,6 +74,16 @@ spec:
                 format: int32
                 type: integer
               nameSshKeySecret:
+                description: |-
+                  NameSshKeySecret is the name of the Kubernetes secret containing Git repository credentials.
+                  Required keys:
+                    - token: Git provider access token (required)
+                  Optional keys:
+                    - id_rsa: SSH private key for Git operations over SSH
+                    - secretString: Webhook secret for validating webhook requests
+                    - username: Git username to override the default GitUser
+                  For Gerrit provider, only id_rsa key is required and used.
+                example: my-git-credentials
                 type: string
               skipWebhookSSLVerification:
                 description: SkipWebhookSSLVerification is a flag to skip webhook

controllers/codebase/service/chain/checkout_branch.go

@@ -9,7 +9,7 @@ import (
 
 	codebaseApi "github.com/epam/edp-codebase-operator/v2/api/v1"
 	codebaseutil "github.com/epam/edp-codebase-operator/v2/pkg/codebase"
-	gitproviderv2 "github.com/epam/edp-codebase-operator/v2/pkg/git/v2"
+	gitproviderv2 "github.com/epam/edp-codebase-operator/v2/pkg/git"
 )
 
 func CheckoutBranch(

controllers/codebase/service/chain/checkout_branch_test.go

@@ -14,8 +14,8 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/client/fake"
 
 	codebaseApi "github.com/epam/edp-codebase-operator/v2/api/v1"
-	gitproviderv2 "github.com/epam/edp-codebase-operator/v2/pkg/git/v2"
-	gitServerMocks "github.com/epam/edp-codebase-operator/v2/pkg/git/v2/mocks"
+	gitproviderv2 "github.com/epam/edp-codebase-operator/v2/pkg/git"
+	gitServerMocks "github.com/epam/edp-codebase-operator/v2/pkg/git/mocks"
 	"github.com/epam/edp-codebase-operator/v2/pkg/util"
 )
 

controllers/codebase/service/chain/common.go

@@ -11,7 +11,7 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/client"
 
 	codebaseApi "github.com/epam/edp-codebase-operator/v2/api/v1"
-	gitproviderv2 "github.com/epam/edp-codebase-operator/v2/pkg/git/v2"
+	gitproviderv2 "github.com/epam/edp-codebase-operator/v2/pkg/git"
 	"github.com/epam/edp-codebase-operator/v2/pkg/util"
 )
 

controllers/codebase/service/chain/common_test.go

@@ -16,8 +16,8 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/client/fake"
 
 	codebaseApi "github.com/epam/edp-codebase-operator/v2/api/v1"
-	gitproviderv2 "github.com/epam/edp-codebase-operator/v2/pkg/git/v2"
-	gitMocks "github.com/epam/edp-codebase-operator/v2/pkg/git/v2/mocks"
+	gitproviderv2 "github.com/epam/edp-codebase-operator/v2/pkg/git"
+	gitMocks "github.com/epam/edp-codebase-operator/v2/pkg/git/mocks"
 	"github.com/epam/edp-codebase-operator/v2/pkg/util"
 )
 

controllers/codebase/service/chain/factory.go

@@ -9,7 +9,7 @@ import (
 
 	"github.com/epam/edp-codebase-operator/v2/controllers/codebase/service/chain/handler"
 	"github.com/epam/edp-codebase-operator/v2/pkg/gerrit"
-	gitproviderv2 "github.com/epam/edp-codebase-operator/v2/pkg/git/v2"
+	gitproviderv2 "github.com/epam/edp-codebase-operator/v2/pkg/git"
 	gitlabci "github.com/epam/edp-codebase-operator/v2/pkg/gitlab"
 	"github.com/epam/edp-codebase-operator/v2/pkg/gitprovider"
 )

controllers/codebase/service/chain/put_deploy_configs.go

@@ -9,7 +9,7 @@ import (
 
 	codebaseApi "github.com/epam/edp-codebase-operator/v2/api/v1"
 	"github.com/epam/edp-codebase-operator/v2/controllers/codebase/service/template"
-	gitproviderv2 "github.com/epam/edp-codebase-operator/v2/pkg/git/v2"
+	gitproviderv2 "github.com/epam/edp-codebase-operator/v2/pkg/git"
 	"github.com/epam/edp-codebase-operator/v2/pkg/util"
 )
 

controllers/codebase/service/chain/put_deploy_configs_test.go

@@ -13,8 +13,8 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/client/fake"
 
 	codebaseApi "github.com/epam/edp-codebase-operator/v2/api/v1"
-	gitproviderv2 "github.com/epam/edp-codebase-operator/v2/pkg/git/v2"
-	gitServerMocks "github.com/epam/edp-codebase-operator/v2/pkg/git/v2/mocks"
+	gitproviderv2 "github.com/epam/edp-codebase-operator/v2/pkg/git"
+	gitServerMocks "github.com/epam/edp-codebase-operator/v2/pkg/git/mocks"
 	"github.com/epam/edp-codebase-operator/v2/pkg/platform"
 	"github.com/epam/edp-codebase-operator/v2/pkg/util"
 )