Refactor: ignoreJenkins to createJenkinsJob

Creating jenkins jobs is more of an edge case.
Searching all files in all branches is expensive.
Lets only do it if required.

Author: Thomas Michael

docs/configuration.schema.json

@@ -164,9 +164,9 @@
           "items" : {
             "type" : "object",
             "properties" : {
-              "ignoreJenkins" : {
+              "createJenkinsJob" : {
                 "type" : [ "boolean", "null" ],
-                "description" : "If true, no Jenkinsjob will be created."
+                "description" : "If true, creates a Jenkins job, if jenkinsfile exists in one of the content repo's branches."
               },
               "overwriteMode" : {
                 "anyOf" : [ {
@@ -175,7 +175,7 @@
                   "type" : "string",
                   "enum" : [ "INIT", "RESET", "UPGRADE" ]
                 } ],
-                "description" : "This defines, how customer repos will be updated.\nINIT - push only if repo does not exist.\nRESET - delete all files after cloning source - files not in content are deleted\nUPGRADE - clone and copy - existing files will be overwritten, files not in content are kept"
+                "description" : "This defines, how customer repos will be updated.\nINIT - push only if repo does not exist.\nRESET - delete all files after cloning source - files not in content are deleted\nUPGRADE - clone and copy - existing files will be overwritten, files not in content are kept. For type: MIRROR reset and upgrade have same result: in both cases source repo will be force pushed to target repo."
               },
               "password" : {
                 "type" : [ "string", "null" ],

src/main/groovy/com/cloudogu/gitops/config/Config.groovy

@@ -135,11 +135,11 @@ class Config {
             @JsonPropertyDescription(CONTENT_REPO_TARGET_DESCRIPTION)
             String target = ''
 
-            @JsonPropertyDescription(CONTENT_REPO_TARGET_OVERWRITE_MODE)
+            @JsonPropertyDescription(CONTENT_REPO_TARGET_OVERWRITE_MODE_DESCRIPTION)
             OverwriteMode overwriteMode = OverwriteMode.INIT // Defensively use init to not override existing files by default
 
-            @JsonPropertyDescription(CONTENT_REPO_IGNORE_JENKINS)
-            Boolean ignoreJenkins = false
+            @JsonPropertyDescription(CONTENT_REPO_CREATE_JENKINS_JOB_DESCRIPTION)
+            Boolean createJenkinsJob = false
         }
     }
 
@@ -806,7 +806,7 @@ class Config {
 
     /**
      * This defines, how customer repos will be updated.
-     * See {@link ConfigConstants#CONTENT_REPO_TARGET_OVERWRITE_MODE}
+     * See {@link ConfigConstants#CONTENT_REPO_TARGET_OVERWRITE_MODE_DESCRIPTION}
      */
     static enum OverwriteMode {
         INIT, RESET, UPGRADE

src/main/groovy/com/cloudogu/gitops/config/ConfigConstants.groovy

@@ -40,8 +40,8 @@ interface ConfigConstants {
     String CONTENT_REPO_TEMPLATING_DESCRIPTION = "When true, template all files ending in .ftl within the repo"
     String CONTENT_REPO_TYPE_DESCRIPTION = "Content Repos can either be:\ncopied (only the files, starting on ref, starting at path within the repo. Requires target)\n, mirrored (FORCE pushes ref or the whole git repo if no ref set). Requires target, does not allow path and template.)\nfolderBased (folder structure is interpreted as repos. That is, root folder becomes namespace in SCM, sub folders become repository names in SCM, files are copied. Requires target.)"
     String CONTENT_REPO_TARGET_DESCRIPTION = "Target repo for the repository in the for of namespace/name. Must contain one slash to separate namespace from name."
-    String CONTENT_REPO_TARGET_OVERWRITE_MODE = "This defines, how customer repos will be updated.\nINIT - push only if repo does not exist.\nRESET - delete all files after cloning source - files not in content are deleted\nUPGRADE - clone and copy - existing files will be overwritten, files not in content are kept"
-    String CONTENT_REPO_IGNORE_JENKINS = "If true, no Jenkinsjob will be created."
+    String CONTENT_REPO_TARGET_OVERWRITE_MODE_DESCRIPTION = "This defines, how customer repos will be updated.\nINIT - push only if repo does not exist.\nRESET - delete all files after cloning source - files not in content are deleted\nUPGRADE - clone and copy - existing files will be overwritten, files not in content are kept. For type: MIRROR reset and upgrade have same result: in both cases source repo will be force pushed to target repo."
+    String CONTENT_REPO_CREATE_JENKINS_JOB_DESCRIPTION = "If true, creates a Jenkins job, if jenkinsfile exists in one of the content repo's branches."
     String CONTENT_VARIABLES_DESCRIPTION = "Additional variables to use in custom templates."
 
     // group jenkins

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

@@ -363,9 +363,7 @@ class Content extends Feature {
     }
 
     private void createJenkinsJob(RepoCoordinate repoCoordinate, ScmmRepo repo) {
-        // easy condition
-        if (!repoCoordinate.repoConfig.ignoreJenkins && jenkins.isEnabled()) {
-            // this conditions iterates over all branches
+        if (repoCoordinate.repoConfig.createJenkinsJob && jenkins.isEnabled()) {
             if (existFileInSomeBranch(repo.absoluteLocalRepoTmpDir, 'Jenkinsfile')) {
                 jenkins.createJenkinsjob(repoCoordinate.namespace, repoCoordinate.namespace)
             }

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

@@ -749,7 +749,7 @@ class ContentTest {
          * file content after that should be: nonFolderRepo1
          */
         config.content.repos = [
-                new ContentRepositorySchema(url: createContentRepo('nonFolderBasedRepo1'), ref: 'main', type: ContentRepoType.COPY, ignoreJenkins: false, target: 'common/repo'),
+                new ContentRepositorySchema(url: createContentRepo('nonFolderBasedRepo1'), ref: 'main', type: ContentRepoType.COPY, createJenkinsJob: true, target: 'common/repo'),
         ]
         scmmApiClient.mockRepoApiBehaviour()
         when(jenkins.isEnabled()).thenReturn(true)
@@ -768,10 +768,10 @@ class ContentTest {
          * file content after that should be: nonFolderRepo1
          */
         config.content.repos = [
-                new ContentRepositorySchema(url: createContentRepo('nonFolderBasedRepo1'), ref: 'main', type: ContentRepoType.COPY, ignoreJenkins: true, target: 'common/repo'),
+                new ContentRepositorySchema(url: createContentRepo('nonFolderBasedRepo1'), ref: 'main', type: ContentRepoType.COPY, createJenkinsJob: false, target: 'common/repo'),
         ]
         scmmApiClient.mockRepoApiBehaviour()
-        when(jenkins.isEnabled()).thenReturn(true)
+        when(jenkins.isEnabled()).thenReturn(false)
         createContent().install()
         verify(jenkins, never()).createJenkinsjob(any(), any())
     }
@@ -787,7 +787,7 @@ class ContentTest {
          * file content after that should be: nonFolderRepo1
          */
         config.content.repos = [
-                new ContentRepositorySchema(url: createContentRepo('nonFolderBasedRepo1'), ref: 'main', type: ContentRepoType.COPY, ignoreJenkins: false, target: 'common/repo'),
+                new ContentRepositorySchema(url: createContentRepo('nonFolderBasedRepo1'), ref: 'main', type: ContentRepoType.COPY, createJenkinsJob: false, target: 'common/repo'),
         ]
         def response = scmmApiClient.mockSuccessfulResponse(201)
         when(scmmApiClient.repositoryApi.create(any(Repository), anyBoolean())).thenReturn(response)