feat(buildDockerAndPublishImage): add optional disablePublication p…

…arameter (#784)

* feat(buildDockerAndPublishImage): add optional `disablePublication` parameter

* inform when publication is disabled

* keep stage

* remove comment

README.adoc

@@ -204,6 +204,7 @@ Name of the docker image to build
 * unstash: Allow to unstash files if not empty
 * dockerBakeFile: Allow to build from a bake file instead
 * dockerBakeTarget: Allow to specify a docker bake target other than 'default'
+* disablePublication: (Optional, default to false) Allow to disable tagging and publication of container image and GitHub release
 
 ==== Example
 [source, groovy]

test/groovy/BuildDockerAndPublishImageStepTests.groovy

@@ -247,6 +247,39 @@ class BuildDockerAndPublishImageStepTests extends BaseTest {
     verifyMocks()
   }
 
+  @Test
+  void itBuildsButDontDeploysWithAutomaticSemanticTagAndReleaseAndEnabledPublicationFalseOnPrincipalBranch() throws Exception {
+    def script = loadScript(scriptName)
+    mockPrincipalBranch()
+    withMocks{
+      script.call(testImageName, [
+        automaticSemanticVersioning: true,
+        gitCredentials: 'git-itbuildsanddeployswithautomaticsemantictagandreleaseonprincipalbranch',
+        disablePublication: true,
+      ])
+    }
+    printCallStack()
+    // Then we expect a successful build with the code cloned
+    assertJobStatusSuccess()
+    // With the common workflow run as expected
+    assertTrue(assertMethodCallContainsPattern('libraryResource','io/jenkins/infra/docker/Makefile'))
+    assertTrue(assertMethodCallContainsPattern('withEnv', "BUILD_DATE=${mockedSimpleDate}"))
+    assertTrue(assertMethodCallContainsPattern('sh','make lint'))
+    assertTrue(assertMethodCallContainsPattern('sh','make bake-build'))
+    assertTrue(assertMethodCallContainsPattern('node', 'docker'))
+    // And generated reports are recorded
+    assertTrue(assertRecordIssues())
+    // But the deploy step is not called
+    assertFalse(assertMethodCallContainsPattern('sh','make bake-deploy'))
+
+    // And the tag is not pushed
+    assertFalse(assertTagPushed(defaultGitTag))
+    // And no release created (no tag triggering the build)
+    assertFalse(assertReleaseCreated())
+    // And all mocked/stubbed methods have to be called
+    verifyMocks()
+  }
+
   @Test
   void itBuildsAndDeploysWithAutomaticSemanticTagAndincludeImageNameInTagAndReleaseOnPrincipalBranch() throws Exception {
     def script = loadScript(scriptName)

vars/buildDockerAndPublishImage.groovy

@@ -51,14 +51,15 @@ def call(String imageShortName, Map userConfig=[:]) {
     unstash: '', // Allow to unstash files if not empty
     dockerBakeFile: '', // Specify the path to a custom Docker Bake file to use instead of the default one
     dockerBakeTarget: 'default', // Specify the target of a custom Docker Bake file to work with
+    disablePublication: false, // Allow to disable tagging and publication of container image and GitHub release (true by default)
   ]
   // Merging the 2 maps - https://blog.mrhaki.com/2010/04/groovy-goodness-adding-maps-to-map_21.html
   final Map finalConfig = defaultConfig << userConfig
 
   // Retrieve Library's Static File Resources
   final String makefileContent = libraryResource 'io/jenkins/infra/docker/Makefile'
 
-  final boolean semVerEnabledOnPrimaryBranch = finalConfig.automaticSemanticVersioning && env.BRANCH_IS_PRIMARY
+  final boolean semVerEnabledOnPrimaryBranch = finalConfig.automaticSemanticVersioning && !finalConfig.disablePublication && env.BRANCH_IS_PRIMARY
 
   // Only run 1 build at a time on primary branch to ensure builds won't use the same tag when semantic versionning is activated
   if (env.BRANCH_IS_PRIMARY) {
@@ -225,7 +226,7 @@ def call(String imageShortName, Map userConfig=[:]) {
           } // if else
         } // each
 
-        // Automatic tagging on principal branch is not enabled by default
+        // Automatic tagging on principal branch is not enabled by default, and disabled if disablePublication is set to true
         if (semVerEnabledOnPrimaryBranch) {
           stage("Semantic Release of ${imageName}") {
             echo "Configuring credential.helper"
@@ -264,14 +265,18 @@ def call(String imageShortName, Map userConfig=[:]) {
           } // stage
         } // if
       }// withDockerPullCredentials
-      infra.withDockerPushCredentials{
-        if (env.TAG_NAME || env.BRANCH_IS_PRIMARY) {
-          stage("Deploy ${imageName}") {
-            makecall('deploy', imageName, operatingSystem, finalConfig.dockerBakeFile, finalConfig.dockerBakeTarget)
-          }
-        } // if
-      } // withDockerPushCredentials
 
+      if (env.TAG_NAME || env.BRANCH_IS_PRIMARY) {
+        stage("Deploy ${imageName}") {
+          if (!finalConfig.disablePublication) {
+            infra.withDockerPushCredentials{
+              makecall('deploy', imageName, operatingSystem, finalConfig.dockerBakeFile, finalConfig.dockerBakeTarget)
+            }
+          } else {
+            echo 'INFO: publication disabled.'
+          } // else
+        } // stage
+      } // if
 
       if (env.TAG_NAME && finalConfig.automaticSemanticVersioning) {
         stage('GitHub Release') {

vars/buildDockerAndPublishImage.txt

@@ -19,6 +19,7 @@ The following arguments are available for this function:
   * String **unstash**: (Optional, default to "") Allow to restore files from a previously saved stash if not empty, should contain the name of the last stashed as per https://www.jenkins.io/doc/pipeline/steps/workflow-basic-steps/#unstash-restore-files-previously-stashed.
   * String **dockerBakeFile**: (Optionan, default to "") Specify the path to a custom Docker Bake file to use instead of the default one
   * String **dockerBakeTarget**: (Optional, default to "default") Specify the target of a custom Docker Bake file to work with
+  * Boolean **disablePublication**: (Optional, default to false) Allow to disable tagging and publication of container image and GitHub release
 
 The lint phase generates a report when it fails, recorded by the hadolint tool in your Jenkins instance.