adds Gitlab4J Api and first POC for Gitlab usage (#268)

nihussmann · web-flow · commit 296903d6b9d3 · 2025-03-13T14:03:46.000+01:00
diff --git a/argocd/argocd/applications/argocd.ftl.yaml b/argocd/argocd/applications/argocd.ftl.yaml
@@ -19,7 +19,7 @@ spec:
   project: argocd
   source:
     path: ${argocd.isOperator?string("operator/", "argocd/")}
-    repoURL: ${scmm.baseUrl}/repo/${namePrefix}argocd/argocd
+    repoURL: ${scmm.repoUrl}argocd/argocd<#if scmm.provider == "gitlab">.git</#if>
     targetRevision: main
     # needed to sync the operator/rbac folder
     <#if argocd.isOperator??>
diff --git a/argocd/argocd/applications/bootstrap.ftl.yaml b/argocd/argocd/applications/bootstrap.ftl.yaml
@@ -14,7 +14,7 @@ spec:
   project: argocd
   source:
     path: applications/
-    repoURL: ${scmm.baseUrl}/repo/${namePrefix}argocd/argocd
+    repoURL: ${scmm.repoUrl}argocd/argocd<#if scmm.provider == "gitlab">.git</#if>
     targetRevision: main
     directory:
       recurse: true
diff --git a/argocd/argocd/applications/cluster-resources.ftl.yaml b/argocd/argocd/applications/cluster-resources.ftl.yaml
@@ -13,7 +13,7 @@ spec:
   project: argocd
   source:
     path: argocd/
-    repoURL: ${scmm.baseUrl}/repo/${namePrefix}argocd/cluster-resources
+    repoURL: ${scmm.repoUrl}argocd/cluster-resources<#if scmm.provider == "gitlab">.git</#if>
     targetRevision: main
     directory:
       recurse: true
diff --git a/argocd/argocd/applications/example-apps.ftl.yaml b/argocd/argocd/applications/example-apps.ftl.yaml
@@ -13,7 +13,7 @@ spec:
   project: argocd
   source:
     path: argocd/
-    repoURL: ${scmm.baseUrl}/repo/${namePrefix}argocd/example-apps
+    repoURL: ${scmm.repoUrl}argocd/example-apps<#if scmm.provider == "gitlab">.git</#if>
     targetRevision: main
     directory:
       recurse: true
diff --git a/argocd/argocd/applications/projects.ftl.yaml b/argocd/argocd/applications/projects.ftl.yaml
@@ -13,7 +13,7 @@ spec:
   project: argocd
   source:
     path: projects/
-    repoURL: ${scmm.baseUrl}/repo/${namePrefix}argocd/argocd
+    repoURL: ${scmm.repoUrl}argocd/argocd<#if scmm.provider == "gitlab">.git</#if>
     targetRevision: main
     directory:
       recurse: true
diff --git a/argocd/argocd/argocd/values.ftl.yaml b/argocd/argocd/argocd/values.ftl.yaml
@@ -68,23 +68,23 @@ argo-cd:
     repositories:
       argocd:
         name: argocd
-        url: ${scmm.baseUrl}/repo/${namePrefix}argocd/argocd
+        url: ${scmm.repoUrl}argocd/argocd<#if scmm.provider == "gitlab">.git</#if>
         <#if isInsecure>insecure: "true"</#if>
       example-apps:
         name: example-apps
-        url: ${scmm.baseUrl}/repo/${namePrefix}argocd/example-apps
+        url: ${scmm.repoUrl}argocd/example-apps<#if scmm.provider == "gitlab">.git</#if>
         <#if isInsecure>insecure: "true"</#if>
       cluster-resources:
         name: cluster-resources
-        url: ${scmm.baseUrl}/repo/${namePrefix}argocd/cluster-resources
+        url: ${scmm.repoUrl}argocd/cluster-resources<#if scmm.provider == "gitlab">.git</#if>
         <#if isInsecure>insecure: "true"</#if>
       nginx-helm-jenkins:
         name: nginx-helm-jenkins
-        url: ${scmm.baseUrl}/repo/${namePrefix}argocd/nginx-helm-jenkins
+        url: ${scmm.repoUrl}argocd/nginx-helm-jenkins<#if scmm.provider == "gitlab">.git</#if>
         <#if isInsecure>insecure: "true"</#if>
       nginx-helm-umbrella:
         name: nginx-helm-umbrella
-        url: ${scmm.baseUrl}/repo/${namePrefix}argocd/nginx-helm-umbrella
+        url: ${scmm.repoUrl}argocd/nginx-helm-umbrella<#if scmm.provider == "gitlab">.git</#if>
         <#if isInsecure>insecure: "true"</#if>
 <#if mirrorRepos>
       prometheus:
diff --git a/argocd/argocd/operator/argocd.ftl.yaml b/argocd/argocd/operator/argocd.ftl.yaml
@@ -126,15 +126,15 @@ spec:
     </#if>
   initialRepositories: |
     - name: argocd
-      url: ${scmm.baseUrl}/repo/${namePrefix}argocd/argocd
+      url: ${scmm.repoUrl}argocd/argocd<#if scmm.provider == "gitlab">.git</#if>
     - name: example-apps
-      url: ${scmm.baseUrl}/repo/${namePrefix}argocd/example-apps
+      url: ${scmm.repoUrl}argocd/example-apps<#if scmm.provider == "gitlab">.git</#if>
     - name: cluster-resources
-      url: ${scmm.baseUrl}/repo/${namePrefix}argocd/cluster-resources
+      url: ${scmm.repoUrl}argocd/cluster-resources<#if scmm.provider == "gitlab">.git</#if>
     - name: nginx-helm-jenkins
-      url: ${scmm.baseUrl}/repo/${namePrefix}argocd/nginx-helm-jenkins
+      url: ${scmm.repoUrl}argocd/nginx-helm-jenkins<#if scmm.provider == "gitlab">.git</#if>
     - name: nginx-helm-umbrella
-      url: ${scmm.baseUrl}/repo/${namePrefix}argocd/nginx-helm-umbrella
+      url: ${scmm.repoUrl}argocd/nginx-helm-umbrella<#if scmm.provider == "gitlab">.git</#if>
     - name: bitnami
       type: helm
       url: https://raw.githubusercontent.com/bitnami/charts/archive-full-index/bitnami
diff --git a/argocd/argocd/projects/argocd.ftl.yaml b/argocd/argocd/projects/argocd.ftl.yaml
@@ -17,9 +17,9 @@ spec:
       kind: '*'
   # must be able to get all git repos because of the Applications pointing to other repos
   sourceRepos:
-    - ${scmm.baseUrl}/repo/${namePrefix}argocd/argocd
-    - ${scmm.baseUrl}/repo/${namePrefix}argocd/cluster-resources
-    - ${scmm.baseUrl}/repo/${namePrefix}argocd/example-apps
+    - ${scmm.repoUrl}argocd/argocd<#if scmm.provider == "gitlab">.git</#if>
+    - ${scmm.repoUrl}argocd/cluster-resources<#if scmm.provider == "gitlab">.git</#if>
+    - ${scmm.repoUrl}argocd/example-apps<#if scmm.provider == "gitlab">.git</#if>
   # Allow applications from all namespaces to use this project for now.
   sourceNamespaces:
     - '*'
diff --git a/argocd/argocd/projects/cluster-resources.ftl.yaml b/argocd/argocd/projects/cluster-resources.ftl.yaml
@@ -14,15 +14,15 @@ spec:
     - namespace: '*'
       server: https://kubernetes.default.svc
   sourceRepos:
-  - ${scmm.baseUrl}/repo/${namePrefix}argocd/cluster-resources
+  - ${scmm.repoUrl}argocd/cluster-resources<#if scmm.provider == "gitlab">.git</#if>
 
 <#if mirrorRepos>
-  - ${scmm.baseUrl}/repo/3rd-party-dependencies/kube-prometheus-stack
-  - ${scmm.baseUrl}/repo/3rd-party-dependencies/mailhog
-  - ${scmm.baseUrl}/repo/3rd-party-dependencies/ingress-nginx
-  - ${scmm.baseUrl}/repo/3rd-party-dependencies/external-secrets
-  - ${scmm.baseUrl}/repo/3rd-party-dependencies/vault
-  - ${scmm.baseUrl}/repo/3rd-party-dependencies/cert-manager
+  - ${scmm.repoUrl}3rd-party-dependencies/kube-prometheus-stack<#if scmm.provider == "gitlab">.git</#if>
+  - ${scmm.repoUrl}3rd-party-dependencies/mailhog<#if scmm.provider == "gitlab">.git</#if>
+  - ${scmm.repoUrl}3rd-party-dependencies/ingress-nginx<#if scmm.provider == "gitlab">.git</#if>
+  - ${scmm.repoUrl}3rd-party-dependencies/external-secrets<#if scmm.provider == "gitlab">.git</#if>
+  - ${scmm.repoUrl}3rd-party-dependencies/vault<#if scmm.provider == "gitlab">.git</#if>
+  - ${scmm.repoUrl}3rd-party-dependencies/cert-manager<#if scmm.provider == "gitlab">.git</#if>
 <#else>
   - https://prometheus-community.github.io/helm-charts
   - https://codecentric.github.io/helm-charts
diff --git a/argocd/argocd/projects/example-apps.ftl.yaml b/argocd/argocd/projects/example-apps.ftl.yaml
@@ -15,8 +15,8 @@ spec:
   - namespace: ${namePrefix}example-apps-staging
     server: https://kubernetes.default.svc
   sourceRepos:
-  - ${scmm.baseUrl}/repo/${namePrefix}argocd/example-apps
-  - ${scmm.baseUrl}/repo/${namePrefix}argocd/nginx-helm-umbrella
+  - ${scmm.repoUrl}argocd/example-apps<#if scmm.provider == "gitlab">.git</#if>
+  - ${scmm.repoUrl}argocd/nginx-helm-umbrella<#if scmm.provider == "gitlab">.git</#if>
   
   
   # allow to only see application resources from the specified namespace
diff --git a/argocd/cluster-resources/argocd/misc.ftl.yaml b/argocd/cluster-resources/argocd/misc.ftl.yaml
@@ -10,7 +10,7 @@ spec:
     server: https://kubernetes.default.svc
   source:
     path: misc/
-    repoURL: ${scmm.baseUrl}/repo/${namePrefix}argocd/cluster-resources
+    repoURL: ${scmm.repoUrl}argocd/cluster-resources<#if scmm.provider == "gitlab">.git</#if>
     targetRevision: main
     directory:
       recurse: true
diff --git a/docs/configuration.schema.json b/docs/configuration.schema.json
@@ -697,6 +697,14 @@
           "type" : [ "string", "null" ],
           "description" : "Mandatory when scmm-url is set"
         },
+        "provider" : {
+          "type" : [ "string", "null" ],
+          "description" : "Sets the scm Provider. Possible Options are \"scm-manager\" and \"gitlab\""
+        },
+        "rootPath" : {
+          "type" : [ "string", "null" ],
+          "description" : "Sets the root path for the Git Repositories. In SCM-Manager it is always \"repo\""
+        },
         "url" : {
           "type" : [ "string", "null" ],
           "description" : "The host of your external scm-manager"
diff --git a/docs/developers.md b/docs/developers.md
@@ -985,4 +985,10 @@ kubectl kustomize config/default | kubectl create -f - || true
 2. Apply a patch that disables the Cert-Manager webhooks by commenting out certain sections in the kustomization.yaml file in the default configuration. The ArgoCD Operator fails at startup if this webhook is not disabled and no cert-manager is present in the cluster.
 3. The patch also changes the image tag in the kustomization.yaml file located in the manager directory from version v0.11.1 to v0.11.0. The Version v0.11.1 does not exist in the Repository anymore, but is referenced in the Kustomization.
 4. Install the Prometheus CRDs. These Custom Resource Definitions are necessary for monitoring the operator and will prevent a successful startup if not present. 
-5. Install the ArgoCD Operator CRDs and components using kubectl kustomize.
+5. Install the ArgoCD Operator CRDs and components using kubectl kustomize.
+
+## Gitlab (Experimental)
+
+### Disclaimer
+The GitLab integration is for **experimental use only** and is **not fully implemented**. Features may be incomplete, unstable, or subject to change. Use at your own discretion.  
+
diff --git a/pom.xml b/pom.xml
@@ -305,6 +305,11 @@
     </dependency>
 
 
+    <dependency>
+      <groupId>org.gitlab4j</groupId>
+      <artifactId>gitlab4j-api</artifactId>
+      <version>6.0.0-rc.8</version>
+    </dependency>
 
     <dependency>
       <groupId>com.github.victools</groupId>
diff --git a/scripts/scm-manager/init-scmm.sh b/scripts/scm-manager/init-scmm.sh
@@ -1,5 +1,6 @@
 #!/usr/bin/env bash
 set -o errexit -o nounset -o pipefail
+set -x
 
 ABSOLUTE_BASEDIR="$(cd "$(dirname $0)" && pwd)"
 source ${ABSOLUTE_BASEDIR}/../utils.sh
@@ -23,21 +24,27 @@ function initSCMM() {
   SCMM_HOST=$(getHost "${SCMM_URL}")
   SCMM_PROTOCOL=$(getProtocol "${SCMM_URL}")
 
+  echo "SCM provider: ${SCM_PROVIDER}"
   if [[ ${INTERNAL_SCMM} == true ]]; then
     setExternalHostnameIfNecessary 'SCMM' 'scmm-scm-manager' 'default'
   fi
   
   [[ "${SCMM_URL}" != *scm ]] && SCMM_URL=${SCMM_URL}/scm
 
-  configureScmmManager "${SCMM_USERNAME}" "${SCMM_PASSWORD}" "${SCMM_URL}" "${JENKINS_URL_FOR_SCMM}" \
-    "${SCMM_URL_FOR_JENKINS}" "${INSTALL_ARGOCD}"
+  if [[ ${SCM_PROVIDER} == "scm-manager" ]]; then
+      configureScmmManager "${SCMM_USERNAME}" "${SCMM_PASSWORD}" "${SCMM_URL}" "${JENKINS_URL_FOR_SCMM}" \
+        "${SCMM_URL_FOR_JENKINS}" "${INSTALL_ARGOCD}"
+  fi
+
+
 
   pushHelmChartRepo "3rd-party-dependencies/spring-boot-helm-chart"
   pushHelmChartRepoWithDependency "3rd-party-dependencies/spring-boot-helm-chart-with-dependency"
   pushRepoMirror "${GITOPS_BUILD_LIB_REPO}" "3rd-party-dependencies/gitops-build-lib"
   pushRepoMirror "${CES_BUILD_LIB_REPO}" "3rd-party-dependencies/ces-build-lib" 'develop'
 }
 
+
 function pushHelmChartRepo() {
   TARGET_REPO_SCMM="$1"
 
@@ -55,8 +62,20 @@ function pushHelmChartRepo() {
     git checkout --quiet -b main
 
     waitForScmManager
-    git push "${SCMM_PROTOCOL}://${SCMM_USERNAME}:${SCMM_PASSWORD}@${SCMM_HOST}/repo/${TARGET_REPO_SCMM}" HEAD:main --force --quiet
-    git push "${SCMM_PROTOCOL}://${SCMM_USERNAME}:${SCMM_PASSWORD}@${SCMM_HOST}/repo/${TARGET_REPO_SCMM}" refs/tags/1.0.0 --quiet --force
+
+    local remote_url
+
+    if [[ ${SCM_PROVIDER} == "scm-manager" ]]; then
+        remote_url="${SCMM_PROTOCOL}://${SCMM_USERNAME}:${SCMM_PASSWORD}@${SCMM_HOST}/${SCM_ROOT_PATH}/${TARGET_REPO_SCMM}"
+    elif [[ ${SCM_PROVIDER} == "gitlab" ]]; then
+        remote_url="${SCMM_PROTOCOL}://oauth2:${SCMM_PASSWORD}@${SCMM_HOST}/${SCM_ROOT_PATH}/${TARGET_REPO_SCMM}.git"
+    else
+        echo "Unsupported SCM provider: ${SCM_PROVIDER}"
+        return 1
+    fi
+
+    git push "${remote_url}" HEAD:main --force --quiet
+    git push "${remote_url}" refs/tags/1.0.0 --quiet --force
   )
 
   rm -rf "${TMP_REPO}"
@@ -88,8 +107,20 @@ function pushHelmChartRepoWithDependency() {
     git commit -a -m "Added dependency" --quiet
 
     waitForScmManager
-    git push "${SCMM_PROTOCOL}://${SCMM_USERNAME}:${SCMM_PASSWORD}@${SCMM_HOST}/repo/${TARGET_REPO_SCMM}" HEAD:main --force --quiet
-    git push "${SCMM_PROTOCOL}://${SCMM_USERNAME}:${SCMM_PASSWORD}@${SCMM_HOST}/repo/${TARGET_REPO_SCMM}" refs/tags/1.0.0 --quiet --force
+
+    local remote_url
+
+    if [[ ${SCM_PROVIDER} == "scm-manager" ]]; then
+        remote_url="${SCMM_PROTOCOL}://${SCMM_USERNAME}:${SCMM_PASSWORD}@${SCMM_HOST}/${SCM_ROOT_PATH}/${TARGET_REPO_SCMM}"
+    elif [[ ${SCM_PROVIDER} == "gitlab" ]]; then
+        remote_url="${SCMM_PROTOCOL}://oauth2:${SCMM_PASSWORD}@${SCMM_HOST}/${SCM_ROOT_PATH}/${TARGET_REPO_SCMM}.git"
+    else
+        echo "Unsupported SCM provider: ${SCM_PROVIDER}"
+        return 1
+    fi
+
+    git push "${remote_url}" HEAD:main --force --quiet
+    git push "${remote_url}" refs/tags/1.0.0 --quiet --force
   )
 
   rm -rf "${TMP_REPO}"
@@ -107,7 +138,18 @@ function pushRepoMirror() {
   (
     cd "${TMP_REPO}"
     waitForScmManager
-    git push --mirror "${SCMM_PROTOCOL}://${SCMM_USERNAME}:${SCMM_PASSWORD}@${SCMM_HOST}/repo/${TARGET_REPO_SCMM}" --force --quiet
+
+    local remote_url
+
+    if [[ ${SCM_PROVIDER} == "scm-manager" ]]; then
+        remote_url="${SCMM_PROTOCOL}://${SCMM_USERNAME}:${SCMM_PASSWORD}@${SCMM_HOST}/${SCM_ROOT_PATH}/${TARGET_REPO_SCMM}"
+    elif [[ ${SCM_PROVIDER} == "gitlab" ]]; then
+        remote_url="${SCMM_PROTOCOL}://oauth2:${SCMM_PASSWORD}@${SCMM_HOST}/${SCM_ROOT_PATH}/${TARGET_REPO_SCMM}.git"
+    else
+        echo "Unsupported SCM provider: ${SCM_PROVIDER}"
+        return 1
+    fi
+    git push --mirror "${remote_url}" --force --quiet
   )
 
   rm -rf "${TMP_REPO}"
@@ -325,6 +367,7 @@ function configJenkins() {
 }
 
 function waitForScmManager() {
+
   echo -n "Waiting for Scmm to become available at ${SCMM_PROTOCOL}://${SCMM_HOST}/api/v2"
 
   HTTP_CODE="0"
diff --git a/src/main/groovy/com/cloudogu/gitops/config/ApplicationConfigurator.groovy b/src/main/groovy/com/cloudogu/gitops/config/ApplicationConfigurator.groovy
@@ -18,7 +18,7 @@ class ApplicationConfigurator {
     }
 
     /**
-     * Sets dynamic fields
+     * Sets dynamic fields and validates params
      */
     Config initConfig(Config newConfig) {
 
diff --git a/src/main/groovy/com/cloudogu/gitops/config/Config.groovy b/src/main/groovy/com/cloudogu/gitops/config/Config.groovy
@@ -245,6 +245,14 @@ class Config {
                 version: '3.2.1',
                 values: [:]
         )
+
+        @Option(names = ['--scm-root-path'], description = SCM_ROOT_PATH_DESCRIPTION)
+        @JsonPropertyDescription(SCM_ROOT_PATH_DESCRIPTION)
+        String rootPath = 'repo'
+
+        @Option(names = ['--scm-provider'], description = SCM_PROVIDER_DESCRIPTION)
+        @JsonPropertyDescription(SCM_PROVIDER_DESCRIPTION)
+        String provider = 'scm-manager'
     }
 
     static class ApplicationSchema {
@@ -699,6 +707,7 @@ class Config {
         }
     }
 
+
     static enum VaultMode {
         dev, prod
     }
diff --git a/src/main/groovy/com/cloudogu/gitops/config/ConfigConstants.groovy b/src/main/groovy/com/cloudogu/gitops/config/ConfigConstants.groovy
@@ -41,6 +41,8 @@ interface ConfigConstants {
     String SCMM_PASSWORD_DESCRIPTION = 'Mandatory when scmm-url is set'
     String GIT_NAME_DESCRIPTION = 'Sets git author and committer name used for initial commits'
     String GIT_EMAIL_DESCRIPTION = 'Sets git author and committer email used for initial commits'
+    String SCM_ROOT_PATH_DESCRIPTION = 'Sets the root path for the Git Repositories. In SCM-Manager it is always "repo"'
+    String SCM_PROVIDER_DESCRIPTION = 'Sets the scm Provider. Possible Options are "scm-manager" and "gitlab"'
 
     // group remote
     String REMOTE_DESCRIPTION = 'Expose services as LoadBalancers'
diff --git a/src/main/groovy/com/cloudogu/gitops/dependencyinjection/RetrofitFactory.groovy b/src/main/groovy/com/cloudogu/gitops/dependencyinjection/RetrofitFactory.groovy
@@ -2,10 +2,9 @@ package com.cloudogu.gitops.dependencyinjection
 
 import com.cloudogu.gitops.config.Config
 import com.cloudogu.gitops.okhttp.RetryInterceptor
-import com.cloudogu.gitops.scmm.api.AuthorizationInterceptor
-import com.cloudogu.gitops.scmm.api.RepositoryApi
-import com.cloudogu.gitops.scmm.api.UsersApi
+import com.cloudogu.gitops.scmm.api.*
 import io.micronaut.context.annotation.Factory
+import io.micronaut.context.annotation.Primary
 import jakarta.inject.Named
 import jakarta.inject.Provider
 import jakarta.inject.Singleton
@@ -17,17 +16,18 @@ import retrofit2.converter.jackson.JacksonConverterFactory
 @Factory
 class RetrofitFactory {
     @Singleton
-    UsersApi usersApi(Retrofit retrofit) {
+    UsersApi usersApi(@Named("scmm") Retrofit retrofit) {
         return retrofit.create(UsersApi)
     }
 
     @Singleton
-
-    RepositoryApi repositoryApi(Retrofit retrofit) {
+    RepositoryApi repositoryApi(@Named("scmm") Retrofit retrofit) {
         return retrofit.create(RepositoryApi)
     }
 
     @Singleton
+    @Primary
+    @Named("scmm")
     Retrofit retrofit(Config config, @Named("scmm") OkHttpClient okHttpClient) {
         return new Retrofit.Builder()
                 .baseUrl(config.scmm.url + '/api/')
@@ -52,4 +52,5 @@ class RetrofitFactory {
 
         return builder.build()
     }
+
 }
diff --git a/src/main/groovy/com/cloudogu/gitops/features/Jenkins.groovy b/src/main/groovy/com/cloudogu/gitops/features/Jenkins.groovy
diff --git a/src/main/groovy/com/cloudogu/gitops/features/ScmManager.groovy b/src/main/groovy/com/cloudogu/gitops/features/ScmManager.groovy
diff --git a/src/main/groovy/com/cloudogu/gitops/features/argocd/ArgoCD.groovy b/src/main/groovy/com/cloudogu/gitops/features/argocd/ArgoCD.groovy
diff --git a/src/main/groovy/com/cloudogu/gitops/scmm/ScmmRepo.groovy b/src/main/groovy/com/cloudogu/gitops/scmm/ScmmRepo.groovy
