com.intershop.gradle.icm.docker.tasks.DBPrepareTask.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of icm-docker-plugin Show documentation
Intershop Commerce Management Plugins for Docker Integration
There is a newer version: 5.3.1
/*
 * Copyright 2020 Intershop Communications AG.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 */
package com.intershop.gradle.icm.docker.tasks

import com.intershop.gradle.icm.docker.tasks.utils.DBPrepareCallback
import org.gradle.api.GradleException
import org.gradle.api.provider.Property
import org.gradle.api.tasks.Input
import org.gradle.api.tasks.options.Option

/**
 * Task to run dbinit on a running container.
 */
open class DBPrepareTask: AbstractContainerTask() {

    @get:Option(option = "mode", description = "Mode in which dbprepare runs: 'init', 'migrate' or 'auto'. " +
            "The default is 'auto'.")
    @get:Input
    val mode: Property = project.objects.property(String::class.java)

    @get:Option(option = "clean-db", description = "can be 'only', 'yes' or 'no', default is 'no'. In case of 'only'," +
            " only the database is cleaned up. If 'yes' is shown, the database is cleaned up before preparing other " +
            " steps. If 'no' is displayed, no database cleanup is done.")
    @get:Input
    val cleanDB: Property = project.objects.property(String::class.java)

    @get:Option(option = "cartridges", description = "A comma-separated cartridge list. Executes the cartridges in " +
            "that list. This is an optional parameter.")
    @get:Input
    val cartridges: Property = project.objects.property(String::class.java)

    @get:Option(option = "property-keys", description = "Comma-separated list of preparer property keys to execute. " +
            "This is an optional parameter.")
    @get:Input
    val propertyKeys: Property = project.objects.property(String::class.java)

    init {
        mode.convention("auto")
        cleanDB.convention("no")
        cartridges.convention("")
        propertyKeys.convention("")
        debugProperty.convention(false)

        group = "icm docker project"
    }

    /**
     * Executes the remote Docker command.
     */
    override fun runRemoteCommand() {
        val execCallback = createCallback()

        val execCmd = dockerClient.execCreateCmd(containerId.get())
        execCmd.withAttachStderr(true)
        execCmd.withAttachStdout(true)

        val command = mutableListOf()
        command.addAll(listOf("/intershop/bin/intershop.sh", "dbprepare", "-classic"))

        if(debugProperty.get()) {
            execCmd.withEnv(listOf("ENABLE_DEBUG=true"))
        }

        command.add("--mode=${mode.get()}")
        command.add("--clean-db=${cleanDB.get()}")
        if(cartridges.get().trim().isNotEmpty()) {
            command.add("--cartridges=${cartridges.get().replace(" ", "")}")
        }
        if(propertyKeys.get().isNotEmpty()) {
            command.add("--property-keys=${propertyKeys.get().replace(" ", "")}")
        }

        execCmd.withCmd(*command.toTypedArray())
        val localExecId = execCmd.exec().id

        dockerClient.execStartCmd(localExecId).withDetach(false).exec(execCallback).awaitCompletion()

        if(waitForExit(localExecId) > 0) {
            throw GradleException("DBPrepare failed! Please check your log files")
        }

        val info = execCallback.getDBInfo()

        if(info == null) {
            throw GradleException("DBPrepare does not finished correctly! Please check your log files")
        } else {
            if(info.failure > 0) {
                throw GradleException("DBPrepare failed with '" + info.failure + "' failures. " +
                        "Please check your log files")
            }
        }
    }

    private fun createCallback(): DBPrepareCallback {
        return DBPrepareCallback(System.out, System.err)
    }
}