Merge pull request #297 from cloudogu/feature/refactor_content_hooks

Content Repos: Refactoring + Fixes

Author: schnatterer

src/main/groovy/com/cloudogu/gitops/Application.groovy

@@ -26,6 +26,10 @@ class Application {
         log.debug("Starting Application")
 
         setNamespaceListToConfig(config)
+
+        features.forEach(feature -> {
+            feature.validate()
+        })
         features.forEach(feature -> {
             feature.install()
         })

src/main/groovy/com/cloudogu/gitops/Feature.groovy

@@ -71,10 +71,19 @@ abstract class Feature {
     }
 
     abstract boolean isEnabled()
-    
+
+
+
     /*
      *  Hooks for enabling or disabling a feature. Both optional, because not always needed.
      */
     protected void enable() {}
     protected void disable() {}
+
+    /*
+     * Hook for special feature validation. Optional.
+     * Feature should throw RuntimeException to stop immediately.
+     */
+    protected void validate() { }
+
 }

src/main/groovy/com/cloudogu/gitops/features/Content.groovy

@@ -95,24 +95,26 @@ class ScmmRepo {
         }
     }
 
-
     void cloneRepo() {
         log.debug("Cloning $scmmRepoTarget repo")
-        gitClone()
-        checkoutOrCreateBranch('main')
+        Git.cloneRepository()
+                .setURI(getGitRepositoryUrl())
+                .setDirectory(new File(absoluteLocalRepoTmpDir))
+                .setCredentialsProvider(getCredentialProvider())
+                .call()
     }
 
     /**
      * @return true if created, false if already exists. Throw exception on all other errors
      */
-    boolean create(String description, ScmmApiClient scmmApiClient) {
+    boolean create(String description, ScmmApiClient scmmApiClient, boolean initialize = true) {
         def namespace = scmmRepoTarget.split('/', 2)[0]
         def repoName = scmmRepoTarget.split('/', 2)[1]
 
         def repositoryApi = scmmApiClient.repositoryApi()
         def repo = new Repository(namespace, repoName, description)
         log.debug("Creating repo: ${namespace}/${repoName}")
-        def createResponse = repositoryApi.create(repo, true).execute()
+        def createResponse = repositoryApi.create(repo, initialize).execute()
         handleResponse(createResponse, repo)
 
         def permission = new Permission(config.scmm.gitOpsUsername as String, Permission.Role.WRITE)
@@ -218,33 +220,6 @@ class ScmmRepo {
                 .setCredentialsProvider(getCredentialProvider())
     }
 
-    void checkoutOrCreateBranch(String branch) {
-        log.debug("Checking out $branch for repo $scmmRepoTarget")
-        getGit()
-                .checkout()
-                .setCreateBranch(!branchExists(branch))
-                .setName(branch)
-                .call()
-    }
-
-    private boolean branchExists(String branch) {
-        return getGit()
-                .branchList()
-                .call()
-                .collect { it.name.replace("refs/heads/", "") }
-                .contains(branch)
-    }
-
-    protected Git gitClone() {
-        Git.cloneRepository()
-                .setURI(getGitRepositoryUrl())
-                .setDirectory(new File(absoluteLocalRepoTmpDir))
-                .setNoCheckout(true)
-                .setCredentialsProvider(getCredentialProvider())
-                .call()
-
-    }
-
     private CredentialsProvider getCredentialProvider() {
         if (scmProvider == "gitlab") {
             username = "oauth2"

src/main/groovy/com/cloudogu/gitops/scmm/ScmmRepo.groovy

@@ -4,9 +4,8 @@ import com.cloudogu.gitops.config.Config
 import com.cloudogu.gitops.scmm.ScmmRepo
 import com.cloudogu.gitops.scmm.ScmmRepoProvider
 import org.apache.commons.io.FileUtils
-import org.eclipse.jgit.api.Git
 
-import static org.mockito.Mockito.spy
+import static org.mockito.Mockito.spy 
 
 class TestScmmRepoProvider extends ScmmRepoProvider {
     Map<String, ScmmRepo> repos = [:]
@@ -45,24 +44,6 @@ class TestScmmRepoProvider extends ScmmRepoProvider {
                 return remoteGitRepopUrl
             }
 
-            @Override
-            protected Git gitClone() {
-                // Cloning from filepath does not work without setting branch
-                try {
-                    Git.cloneRepository()
-                            .setURI(getGitRepositoryUrl())
-                            .setDirectory(new File(absoluteLocalRepoTmpDir))
-                            .setNoCheckout(true)
-                            .setBranch('main')
-                            .call()
-
-                } catch (Exception e) {
-                    // test workaround for testing same repo again. Clean folder with .git and do it again.
-                    // it need 2-3 tries
-                    fileSystemUtils.deleteFilesExcept(new File(absoluteLocalRepoTmpDir))
-                    gitClone()
-                }
-            }
         }
         // Create a spy to enable verification while keeping real behavior
         ScmmRepo spyRepo = spy(repoNew)

src/test/groovy/com/cloudogu/gitops/features/ContentTest.groovy

@@ -0,0 +1 @@
+copyRepo1

src/test/groovy/com/cloudogu/gitops/utils/TestScmmRepoProvider.groovy

@@ -0,0 +1 @@
+copyRepo1

src/test/groovy/com/cloudogu/gitops/utils/data/contentRepos/nonFolderBasedRepo1/Jenkinsfile renamed to src/test/groovy/com/cloudogu/gitops/utils/data/contentRepos/copyRepo1/Jenkinsfile

@@ -0,0 +1 @@
+copyRepo2