feature: names refactoring, Jenkinsfile edit, example edit, bug fixes

2025-03-05 01:36:24 +03:00
parent 7f3a76c984
commit 1b34bd5df1
11 changed files with 128 additions and 67 deletions
--- a/src/main/groovy/script/build_docker.groovy
+++ b/src/main/groovy/script/build_docker.groovy
@@ -32,7 +32,7 @@ ScriptLog.printf "Building docker image without tags..."

 for (def dockerfileName : Dockerfiles.getPresetDockerfiles()) {
    def dockerCommand = DockerBuildCommandFactory.getBuildCommand(dockerfileName)
-    println "Using dockerfile '${dockerfileName}', full command: '$dockerCommand'"
+    ScriptLog.printf "Building dockerfile '${dockerfileName}', full command: '$dockerCommand'"
    sh dockerCommand
 }

--- a/src/main/groovy/script/deploy_docker_build_push_update_compose_via_ssh.groovy
+++ b/src/main/groovy/script/deploy_docker_build_push_update_compose_via_ssh.groovy
@@ -1,7 +1,9 @@
 package script

 import util.CIProperties
+import util.DockerBuildCommandFactory
 import util.DockerImageNames
+import util.DockerLogin
 import util.DockerTags
 import util.Dockerfiles

@@ -36,15 +38,15 @@ if (deployGitTags.isNullOrEmpty()) {
 def deployDockerfiles = Dockerfiles.getDeployDockerfiles()

 def dockerComposeBaseCommand = CIProperties.findProperty("deploy.docker-compose.base-command")
-    .orElse("docker compose")
+        .orElse("docker compose")

 def dockerComposeDirectory = CIProperties.getProperty("deploy.docker-compose.dir")

 def dockerComposeFileName = CIProperties.findProperty("deploy.docker-compose.filename")
-    .orElse("docker-compose.yml")
+        .orElse("docker-compose.yml")

 def sshDeployProfile = CIProperties.findProperty("deploy.ssh.profile")
-    .orElse("deploy")
+        .orElse("deploy")

 if (deployGitTags.size() > 1) {
    throw new IllegalStateException("Can not deploy more than one git tag via docker-compose. Found multiple deploy tags: ${deployGitTags}")
@@ -54,6 +56,8 @@ def deployGitTag = deployGitTags.first()

 ScriptLog.printf "Starting, total ${deployDockerfiles.size()} dockerfiles marked to be deployed... (tag: ${deployGitTag}, dockerfiles: ${deployDockerfiles})"

+DockerLogin.perform()
+
 for (def dockerfileName : deployDockerfiles) {
    ScriptLog.printf "Deploying image for dockerfile named '${dockerfileName}' via ssh profile ${sshDeployProfile}"

@@ -61,25 +65,52 @@ for (def dockerfileName : deployDockerfiles) {

    ScriptLog.printf "Docker image ${dockerImageToUpdateTagBaseName} base name will be used for dockerfile named '${dockerfileName}'"

-    def dockerReleaseTagToSetup = DockerTags.getDockerTagPostfixForDockerfile(
-        GitTags.sanitizeTagFromPrefixes(deployGitTag, GitTags.deployPrefixes)
+    def dockerReleaseTagToSetup = DockerTags.getDockerTagForDockerfile(
+            dockerfileName,
+            GitTags.sanitizeTagFromPrefixes(deployGitTag, GitTags.deployPrefixes)
    )

+    def dockerReleaseImageToSetup = "${dockerImageToUpdateTagBaseName}:${dockerReleaseTagToSetup}"
+
+    def dockerImageBuildCommand = DockerBuildCommandFactory.getBuildCommand(dockerfileName, "-t ${dockerReleaseImageToSetup}")
+    ScriptLog.printf "Rebuilding docker image '${dockerReleaseImageToSetup}' before deploy by command '${dockerImageBuildCommand}'..."
+
+    sh dockerImageBuildCommand
+
+    ScriptLog.printf "Pushing docker image '${dockerReleaseImageToSetup}' before deploy..."
+    sh "docker push ${dockerReleaseImageToSetup}"
+
    ScriptLog.printf "Updating docker-compose image tag to '${dockerReleaseTagToSetup}' in service '${dockerImageToUpdateTagBaseName}' in file '${dockerComposeFileName}' located in directory '${dockerComposeDirectory}'..."

-    sh """ ssh -tt ${sshDeployProfile} "\\
-       cd '${dockerComposeDirectory}' && \\
-       sed -i 's|image: ${dockerImageToUpdateTagBaseName}:.*|image: ${dockerImageToUpdateTagBaseName}:${dockerReleaseTagToSetup}|g' '${dockerComposeFileName}'\\
-       "
-    """
+    if (dockerReleaseTagToSetup.isNullOrBlank()) {
+        throw new IllegalStateException("Build tag was not resolved (empty or null '${dockerReleaseTagToSetup}')")
+    }

-    ScriptLog.printf "Service tag updated, restarting compose..."
+    def dockerComposeRollbackFileName = "${dockerComposeFileName}.backup.${System.currentTimeMillis()}.yml"

-    sh """ ssh -tt ${sshDeployProfile} "\\
-       cd '${dockerComposeDirectory}' && \\
-       ${dockerComposeBaseCommand} -f '${dockerComposeFileName}' up -d \\
-       "
-    """
+    try {
+        sh """ ssh -tt ${sshDeployProfile} "\\
+           cd '${dockerComposeDirectory}' && \\
+           cp ${dockerComposeFileName} ${dockerComposeRollbackFileName} && \\
+           sed -i 's|image: ${dockerImageToUpdateTagBaseName}:.*|image: ${dockerReleaseImageToSetup}|g' '${dockerComposeFileName}'\\ &&
+           ${dockerComposeBaseCommand} -f '${dockerComposeFileName}' up -d \\
+           "
+        """
+    } catch (Throwable e) {
+        ScriptLog.printf("Exception occurred while updating docker-compose tag on deploy, rolling back")
+        e.printStackTrace()
+
+        sh """ ssh -tt ${sshDeployProfile} "\\
+           cd '${dockerComposeDirectory}' && \\
+           rm ${dockerComposeFileName} && \\
+           cp ${dockerComposeRollbackFileName} ${dockerComposeFileName} \\
+           "
+        """
+
+        ScriptLog.printf("Application restored from backup")
+
+        throw e
+    }

    ScriptLog.printf "Deploying of docker tag '${dockerReleaseTagToSetup}' successfully completed!"
 }
--- a/src/main/groovy/script/release_docker_build_push.groovy
+++ b/src/main/groovy/script/release_docker_build_push.groovy
@@ -1,7 +1,9 @@
 package script

+import util.CIProperties
 import util.DockerImageNames

+
 /**
 * Скрипт для публикации докер образа при сборке.
 */
@@ -11,8 +13,10 @@ import util.DockerImageNames
        @Grab(group='io.tswf.groovy.better-groovy', module='better-groovy-scripting-shell', version='2.0.2-SNAPSHOT', changing = true),
        @Grab(group='io.tswf.groovy.better-groovy', module='better-groovy-scripting-gitea', version='2.0.2-SNAPSHOT', changing = true)
 ])
+@groovy.transform.CompileStatic
 import util.DockerLogin
 import util.DockerBuildCommandFactory
+import util.DockerTags
 import util.Dockerfiles
 import util.GitTags
 import util.GlobalProperties
@@ -39,7 +43,7 @@ ScriptLog.printf "Starting docker publishing..."

 DockerLogin.perform()

-def dockerfilesToPush = System.findGlobalPropertyList("ci.docker.image.push.files").orElse([])
+def dockerfilesToPush = CIProperties.findListProperty("docker.image.push.files").orElse([])

 gitReleaseTags.each { gitTag ->
    Dockerfiles.getPresetDockerfiles().each { dockerfileName ->
@@ -53,8 +57,12 @@ gitReleaseTags.each { gitTag ->
        def dockerImageBaseName = DockerImageNames.getImageName(dockerfileName)

        // Для докер-тегов образов используем гит-теги с отброшенным префиксом
-        def imageBaseTag = gitTag.replace(GitTags.getPrefix(), "")
-        def imageTag = DockerImageNames.getImageTag(imageBaseTag, dockerfileName)
+        def imageBaseTag = GitTags.sanitizeTagFromPrefixes(gitTag, GitTags.getReleasePrefixes())
+        def imageTag = DockerTags.getDockerTagForDockerfile(imageBaseTag, dockerfileName)
+
+        if (imageTag.isNullOrBlank()) {
+            throw new IllegalStateException("Build tag was not resolved (empty or null '${imageTag}')")
+        }

        def imageFullName = "${dockerImageBaseName}:${imageTag}"

--- a/src/main/groovy/script/release_gitea_artifacts_publish_docker.groovy
+++ b/src/main/groovy/script/release_gitea_artifacts_publish_docker.groovy
--- a/src/main/groovy/util/DockerBuildCommandFactory.groovy
+++ b/src/main/groovy/util/DockerBuildCommandFactory.groovy
@@ -12,7 +12,7 @@ class DockerBuildCommandFactory {
        ]

        return propertyNames.stream()
-            .map { CIProperties.findProperty("ci.docker.build.additional-args").orNull() }
+            .map { CIProperties.findProperty(it).orNull() }
            .filter { it != null }
            .findFirst()
            .orElse("")
--- a/src/main/groovy/util/DockerImageNames.groovy
+++ b/src/main/groovy/util/DockerImageNames.groovy
@@ -5,11 +5,6 @@ import groovy.transform.CompileStatic
@CompileStatic
 class DockerImageNames {

-    static String getImageTag(String baseName, String dockerfile) {
-        def imageTagPostfix = CIProperties.findProperty("docker.image.tag.${dockerfile.toLowerCase()}.postfix").orElse("")
-        return "${baseName}${imageTagPostfix}"
-    }
-
    static String getImageName(String dockerfileName) {
        def propertyNames = [
                "docker.image.${dockerfileName.toLowerCase()}.name",
--- a/src/main/groovy/util/DockerLogin.groovy
+++ b/src/main/groovy/util/DockerLogin.groovy
@@ -18,9 +18,20 @@ class DockerLogin {

        // Логинимся в Registry
        ScriptLog.printf "Performing login to registry..."
-        def registryName = System.getGlobalProperty("ci.docker.registry")
-        def registryUser = System.getGlobalProperty("ci.docker.registry.username")
-        def registryPassword = System.getGlobalProperty("ci.docker.registry.password")
+
+        def registryName = CIProperties.getProperty("docker.registry")
+        def registryUser = CIProperties.getProperty("docker.registry.username")
+        def registryPassword = CIProperties.getProperty("docker.registry.password")
+
+        if (registryName.isNullOrBlank()) {
+            throw new IllegalStateException("Docker registry name not set")
+        }
+        if (registryUser.isNullOrBlank()) {
+            throw new IllegalStateException("Docker registry user not set")
+        }
+        if (registryPassword.isNullOrBlank()) {
+            throw new IllegalStateException("Docker registry password not set")
+        }

        sh "docker login $registryName -u $registryUser -p $registryPassword"

--- a/src/main/groovy/util/GitTags.groovy
+++ b/src/main/groovy/util/GitTags.groovy
@@ -38,7 +38,16 @@ class GitTags {
        return getTagsWithPrefix(deployPrefixes)
    }

-    static String sanitizeTagFromPrefixes(String tag, Collection<String> prefixes) {
+    static List<String> getAllPrefixes() {
+        def result = new ArrayList<String>()
+
+        result.addAll(getReleasePrefixes())
+        result.addAll(getDeployPrefixes())
+
+        return result
+    }
+
+    static String sanitizeTagFromPrefixes(String tag, Collection<String> prefixes = getAllPrefixes()) {
        return tag.removeAll(prefixes)
    }
 }
--- a/src/main/groovy/util/ScriptLog.groovy
+++ b/src/main/groovy/util/ScriptLog.groovy
@@ -1,8 +1,19 @@
 package util

+import groovy.transform.CompileStatic
+
+@CompileStatic
 class ScriptLog {
    static void printf(Object text, Object... args) {
-        def callerClassName = new Throwable().getStackTrace()[1].getClassName().split("\\.").last()
-        println "[${callerClassName}]: ${String.format(String.valueOf(text), args)}"
+        def scriptPrefix = new Throwable().getStackTrace()
+            .stream()
+                .map { it.className }
+                .filter { it != null }
+                .map { it.split("\\.").last() }
+                .filter { it.isNotNullOrBlank() && it.charAt(0).isLowerCase() }
+                .toList()
+            .lastOrNull() ?: "ci script"
+
+        println "[${scriptPrefix}]: ${String.format(String.valueOf(text), args)}"
    }
 }