Added dryRun to dockerlogin, dockerlogout and dockercomposepull. Fixed string replacement in PublishDockerImagesWithNewTag to include only first instance of source string in image name.

Author: idasc

DockerBuildSystem/DockerComposeTools.py

@@ -51,11 +51,14 @@ def DockerComposePush(composeFiles):
     TerminalTools.ExecuteTerminalCommands([terminalCommand], True)
 
 
-def DockerComposePull(composeFiles):
+def DockerComposePull(composeFiles, dryRun=False):
     terminalCommand = "docker-compose"
     terminalCommand += MergeComposeFileToTerminalCommand(composeFiles)
     terminalCommand += " pull"
-    TerminalTools.ExecuteTerminalCommands([terminalCommand], True)
+    if(dryRun):
+        print("would have called {}".format(terminalCommand))
+    else:
+        TerminalTools.ExecuteTerminalCommands([terminalCommand], True)
 
 
 def TagImages(composeFile, newTag, dryRun = False):
@@ -91,14 +94,14 @@ def PublishDockerImages(composeFile, dryRun = False):
             print('Would have pushed {}'.format(sourceImage))
 
 def PromoteDockerImages(composeFile, targetTags, sourceFeed, targetFeed, user, password, dryRun = False):
-    DockerImageTools.DockerLogin(sourceFeed, user, password)
-    DockerComposePull([composeFile])
-    DockerImageTools.DockerLogout(sourceFeed)
+    DockerImageTools.DockerLogin(sourceFeed, user, password, dryRun)
+    DockerComposePull([composeFile], dryRun)
+    DockerImageTools.DockerLogout(sourceFeed, dryRun)
 
-    DockerImageTools.DockerLogin(targetFeed, user, password)
+    DockerImageTools.DockerLogin(targetFeed, user, password, dryRun)
     for tag in targetTags:
         PublishDockerImagesWithNewTag(composeFile, tag, sourceFeed, targetFeed, dryRun)
-    DockerImageTools.DockerLogout(targetFeed)
+    DockerImageTools.DockerLogout(targetFeed, dryRun)
 
 def PublishDockerImagesWithNewTag(composeFile, newTag, sourceRepository= "", targetRepository="", dryRun=False):
     dockerComposeMap = YamlTools.GetYamlData([composeFile])
@@ -107,7 +110,7 @@ def PublishDockerImagesWithNewTag(composeFile, newTag, sourceRepository= "", tar
         tagIndex = sourceImage.rfind(':')
         targetImage = sourceImage[:tagIndex+1] + str(newTag)
         if(len(sourceRepository) > 0 and len(targetRepository) > 0):
-            targetImage = targetImage.replace(sourceRepository, targetRepository)
+            targetImage = targetImage.replace(sourceRepository, targetRepository, 1)
         if(dryRun):
             print("Would have tagged image {} as {}".format(sourceImage, targetImage))
             print("Would have pushed image {}".format(targetImage))

DockerBuildSystem/DockerImageTools.py

@@ -99,16 +99,22 @@ def GetLogsFromContainer(containerName):
     logs = str(TerminalTools.ExecuteTerminalCommandAndGetOutput(terminalCommand, includeErrorOutput=True).decode("utf-8"))
     return logs
 
-def DockerLogin(server, userName, password):
-    terminalCommand = 'docker login {0} -u {1} -p {2}'.format(server, userName, password)
-    TerminalTools.ExecuteTerminalCommands(
-        terminalCommands=[terminalCommand], 
-        raiseExceptionWithErrorCode=True, 
-        printCommand=False)
-
-def DockerLogout(server):
-    terminalCommand = 'docker logout {0}'.format(server)
-    TerminalTools.ExecuteTerminalCommands(
-        terminalCommands=[terminalCommand], 
-        raiseExceptionWithErrorCode=True, 
-        printCommand=False)
+def DockerLogin(server, userName, password, dryRun=False):
+    if(dryRun):
+        print("Would have logged in to {0} with user {1}".format(server, userName))
+    else:
+        terminalCommand = 'docker login {0} -u {1} -p {2}'.format(server, userName, password)
+        TerminalTools.ExecuteTerminalCommands(
+            terminalCommands=[terminalCommand], 
+            raiseExceptionWithErrorCode=True, 
+            printCommand=False)
+
+def DockerLogout(server, dryRun=False):
+    if(dryRun):
+        print("Would have logged out of {0}".format(server))
+    else:
+        terminalCommand = 'docker logout {0}'.format(server)
+        TerminalTools.ExecuteTerminalCommands(
+            terminalCommands=[terminalCommand], 
+            raiseExceptionWithErrorCode=True, 
+            printCommand=False)

README.md

@@ -70,7 +70,7 @@ VersionTools.ExportVersionFromChangelogToEnvironment("path_to/CHANGELOG.md", "ve
 - targetFeed - the feed you want to push to
 - user - used for authenticating to sourceFeed and targetFeed
 - password - used for authenticating to sourceFeed and targetFeed
-- dryRun - boolean. True if you want to do a dryRun, i.e. print what would have happened)
+- dryRun - boolean. True if you want to do a dryRun, i.e. print what would have happened
 
 Please have a look at an example of use here:
 - https://github.com/DIPSAS/DockerBuildSystem/tree/master/example