com.intershop.gradle.icm.docker.tasks.CreateASContainer.kt Maven / Gradle / Ivy
/*
* 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.extension.IntershopDockerExtension
import com.intershop.gradle.icm.docker.tasks.utils.ClasspathLayout
import com.intershop.gradle.icm.docker.tasks.utils.ICMContainerEnvironmentBuilder
import com.intershop.gradle.icm.docker.utils.Configuration
import com.intershop.gradle.icm.docker.utils.HostAndPort
import com.intershop.gradle.icm.tasks.CopyLibraries
import com.intershop.gradle.icm.utils.JavaDebugSupport
import org.gradle.api.model.ObjectFactory
import org.gradle.api.provider.Property
import org.gradle.api.provider.Provider
import org.gradle.api.provider.SetProperty
import org.gradle.api.tasks.Input
import org.gradle.api.tasks.Optional
import org.gradle.api.tasks.options.Option
import org.gradle.api.tasks.options.OptionValues
import org.gradle.kotlin.dsl.getByType
import javax.inject.Inject
abstract class CreateASContainer @Inject constructor(objectFactory: ObjectFactory) :
CreateExtraContainer(objectFactory) {
private val debugProperty: Property =
objectFactory.property(JavaDebugSupport::class.java).convention(JavaDebugSupport.defaults(project))
private val gcLogProperty: Property = objectFactory.property(Boolean::class.java).convention(false)
private val heapDumpProperty: Property = objectFactory.property(Boolean::class.java).convention(false)
private val appserverNameProperty: Property = objectFactory.property(String::class.java).convention("")
private val classpathLayoutProperty: SetProperty = project.objects
.setProperty(ClasspathLayout::class.java)
.convention(ClasspathLayout.default())
companion object {
const val PATTERN_READINESS_PROBE_URL = "http://localhost:%d/status/ReadinessProbe"
}
/**
* Enable debugging for the JVM running the ICM-AS inside the container. This option defaults to the value
* of the JVM property `SYSPROP_DEBUG_JVM` respectively `false` if not set.
* The port on the host can be configured using the property `icm.properties/intershop.as.debug.port`
*
* @property debug is the task property
* @see com.intershop.gradle.icm.docker.utils.Configuration.AS_DEBUG_PORT
*/
@set:Option(
option = "debug-icm",
description = """
Enable/control debugging for the process. The following values are supported:
${JavaDebugSupport.TASK_OPTION_VALUE_TRUE}/${JavaDebugSupport.TASK_OPTION_VALUE_YES} - enable debugging,
${JavaDebugSupport.TASK_OPTION_VALUE_SUSPEND} - enable debugging in suspend-mode,
- disable debugging.
The debugging port is controlled by icm-property '${Configuration.AS_DEBUG_PORT}'.
"""
)
@get:Input
var debug: String
get() = debugProperty.map { it.renderTaskOptionValue() }.getOrElse("")
set(value) {
val debugOptions = JavaDebugSupport.parse(project, value)
debugProperty.set(debugOptions)
withEnvironment(
project.provider { ICMContainerEnvironmentBuilder().withDebugOptions(debugOptions).build() })
}
/**
* Return the possible values for the task option [debug]
*/
@OptionValues("debug-icm")
fun getDebugOptionValues(): Collection = listOf(JavaDebugSupport.TASK_OPTION_VALUE_TRUE,
JavaDebugSupport.TASK_OPTION_VALUE_YES,
JavaDebugSupport.TASK_OPTION_VALUE_SUSPEND,
JavaDebugSupport.TASK_OPTION_VALUE_FALSE,
JavaDebugSupport.TASK_OPTION_VALUE_NO)
/**
* Enable GC logging for the process.
*
* @property gcLog is the task property
*/
@set:Option(
option = "gclog",
description = "Enable gclog for the process."
)
@get:Input
var gcLog: Boolean
get() = gcLogProperty.get()
set(value) {
gcLogProperty.set(value)
withEnvironment(project.provider { ICMContainerEnvironmentBuilder().enableGCLog(value).build() })
}
/**
* Enable heap dumps for the process.
*
* @property heapDump is the task property
*/
@set:Option(
option = "heapdump",
description = "Enable heapdump creation for the process."
)
@get:Input
var heapDump: Boolean
get() = heapDumpProperty.get()
set(value) {
heapDumpProperty.set(value)
withEnvironment(project.provider { ICMContainerEnvironmentBuilder().enableHeapDump(value).build() })
}
/**
* Set a special name for the appserver
*/
@set:Option(
option = "appserver-name",
description = "Provide a special name for the appserver."
)
@get:Input
var appserverName: String
get() = appserverNameProperty.get()
set(value) {
appserverNameProperty.set(value)
withEnvironment(project.provider { ICMContainerEnvironmentBuilder().withServerName(value).build() })
}
/**
* Provide a custom classpath layout. Default value is `sourceJar,release`.
*
* @property classpathLayout is the task property
*/
@set:Option(
option = "classpathLayout",
description = "Provide a custom classpath layout (comma separated list of " +
"{release,source,sourceJar,eclipse}, default value is 'sourceJar,release')."
)
@get:Optional
@get:Input
var classpathLayout: String?
get() = ClasspathLayout.render(classpathLayoutProperty.get())
set(value) {
classpathLayoutProperty.set(ClasspathLayout.parse(value))
withEnvironment(project.provider {
ICMContainerEnvironmentBuilder().withClasspathLayout(classpathLayoutProperty.get()).build()
})
}
/**
* Provide the host list of the Zookeeper required by Solr Cloud
*/
fun withSolrCloudZookeeperHostList(solrCloudZookeeperHostList: Provider) {
withEnvironment(project.provider {
ICMContainerEnvironmentBuilder().withSolrCloudZookeeperHostList(solrCloudZookeeperHostList).build()
})
}
/**
* Provide the mail host+port
*/
fun withMailServer(hostAndPort: Provider) {
withEnvironment(project.provider { ICMContainerEnvironmentBuilder().withMailServer(hostAndPort).build() })
}
init {
val devConfig = project.extensions.getByType().developmentConfig
withEnvironment(
project.provider {
ICMContainerEnvironmentBuilder()
.withContainerName(containerName.get())
.withDatabaseConfig(devConfig.databaseConfiguration)
.withDevelopmentConfig(devConfig.developmentProperties)
.withEnvironmentProperties(devConfig.intershopEnvironmentProperties)
.withEnvironment(devConfig.asEnvironment)
.withWebserverConfig(devConfig.webserverConfiguration)
.withPortConfig(devConfig.asPortConfiguration)
.withCartridgeList(devConfig.cartridgeList.get())
.withClasspathLayout(classpathLayoutProperty.get())
.build()
}
)
}
fun forCustomization(containerPrefix: String) {
// if there are customizations add some more volumes
withVolumes(
// build a volumes-Provider that
// 1. adds a task dependency: CreateASContainer -> each CopyLibraries
// 2. adds a volume CopyLibraries-directory -> `-libs/lib`
project.provider {
val customizationVolumes = mutableMapOf()
project.tasks.withType(CopyLibraries::class.java) { cl ->
// ensure `CopyLibraries`-tasks get executed prior to this task
dependsOn(cl)
// "add" the volume
val dir = cl.librariesDirectory.get().asFile
customizationVolumes[dir.absolutePath] =
"/intershop/customizations/${containerPrefix}-${dir.name}-libs/lib"
}
customizationVolumes
}
)
}
} © 2015 - 2025 Weber Informatics LLC | Privacy Policy