Skip to content

Commit

Permalink
Merge pull request #45 from IntershopCommunicationsAG/74112-EnsureSit…
Browse files Browse the repository at this point in the history 
…esFolderIsAccessible

74112-EnsureSitesFolderIsAccessible
  • Loading branch information
@skiesewetter-intershop
skiesewetter-intershop authored Mar 2, 2022
2 parents 87e7f7b + 2ad2344 commit 1de01e5
Show file tree
Hide file tree
Showing 3 changed files with 64 additions and 55 deletions.
12 changes: 1 addition & 11 deletions src/main/kotlin/com/intershop/gradle/icm/docker/ICMGebTestPlugin.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ class ICMGebTestPlugin : Plugin<Project> {

val networkTask = rootProject.tasks.named(NetworkPreparer.PREPARE_NETWORK, PrepareNetwork::class.java)

val os = getOS()
val os = OS.bySystem()
val localDriverConfig = extension.developmentConfig.getConfigProperty(GEB_LOCAL_DRIVER, "")
val localEnvironmentConfig = extension.developmentConfig.getConfigProperty(GEB_LOCAL_ENVIRONMENT, "")

Expand Down Expand Up @@ -130,14 +130,4 @@ class ICMGebTestPlugin : Plugin<Project> {
}
}

private fun getOS(): OS? {
val os = System.getProperty("os.name").lowercase()

return when {
os.contains(OS.WINDOWS.value) -> { OS.WINDOWS }
os.contains("nix") || os.contains("nux") || os.contains("aix") -> { OS.LINUX }
os.contains(OS.MAC.value) -> { OS.MAC }
else -> null
}
}
}
21 changes: 20 additions & 1 deletion src/main/kotlin/com/intershop/gradle/icm/docker/utils/OS.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,5 +21,24 @@ enum class OS(val value: String) {

WINDOWS("win"),
LINUX("linux"),
MAC("mac")
MAC("mac");

companion object {
fun bySystem(): OS? {
val os = System.getProperty("os.name").lowercase()

return when {
os.contains(WINDOWS.value) -> {
WINDOWS
}
os.contains("nix") || os.contains("nux") || os.contains("aix") -> {
LINUX
}
os.contains(MAC.value) -> {
MAC
}
else -> null
}
}
}
}
86 changes: 43 additions & 43 deletions src/main/kotlin/com/intershop/gradle/icm/docker/utils/appserver/AbstractTaskPreparer.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@ import com.intershop.gradle.icm.docker.tasks.PrepareNetwork
import com.intershop.gradle.icm.docker.tasks.PullImage
import com.intershop.gradle.icm.docker.tasks.RemoveContainerByName
import com.intershop.gradle.icm.docker.tasks.StopExtraContainer
import com.intershop.gradle.icm.docker.utils.Configuration
import com.intershop.gradle.icm.docker.utils.Configuration.SITES_FOLDER_PATH
import com.intershop.gradle.icm.docker.utils.ContainerUtils
import com.intershop.gradle.icm.docker.utils.OS
import com.intershop.gradle.icm.docker.utils.PortMapping
import com.intershop.gradle.icm.tasks.CollectLibraries
import org.gradle.api.GradleException
Expand All @@ -34,6 +34,7 @@ import org.gradle.api.file.Directory
import org.gradle.api.provider.Provider
import org.gradle.api.tasks.TaskProvider
import java.io.File
import java.util.concurrent.TimeUnit

abstract class AbstractTaskPreparer(
project: Project,
Expand Down Expand Up @@ -90,7 +91,7 @@ abstract class AbstractTaskPreparer(
}

protected fun getServerVolumes(): Map<String,String> {
addDirectories.forEach { _, path ->
addDirectories.forEach { (_, path) ->
path.get().asFile.mkdirs()
}

Expand Down Expand Up @@ -136,65 +137,64 @@ abstract class AbstractTaskPreparer(
private fun prepareSitesFolder(project: Project, extension: IntershopDockerExtension) {
with(project) {
val sitesFolderPath = extension.developmentConfig.getConfigProperty(
Configuration.SITES_FOLDER_PATH, ""
SITES_FOLDER_PATH, ""
)

val defaultSitesFolder =
project.layout.buildDirectory.dir("sites_folder").forUseAtConfigurationTime().get().asFile

val sitesFolder : File
if (sitesFolderPath.isEmpty()) {
logger.warn(
"There is no configuration for the sites folder. Check '{}' in your icm.properties! \n" +
"The default '{}' value will be used!",
Configuration.SITES_FOLDER_PATH,
"The default '{}' value will be used!",
SITES_FOLDER_PATH,
defaultSitesFolder.path
)
sitesFolder = defaultSitesFolder
}
else {
sitesFolder = File(sitesFolderPath)
logger.quiet("Using configured sites folder '{}'", sitesFolder.path)
}

if (! defaultSitesFolder.exists()) {
if (! defaultSitesFolder.mkdirs()) {
logger.error(
"It was not possible to create the sites folder '{}'!",
defaultSitesFolder.path
)
throw GradleException(
"It was not possible to create the sites folder '{" +
defaultSitesFolder.path + "'!"
)
if (sitesFolder.exists() && sitesFolder.canWrite()) {
logger.quiet("The sites folder '{}' exists and can be used", sitesFolder.path)
} else {
if (sitesFolder.exists()){
if (!sitesFolder.canWrite()) {
throw GradleException("The sites folder '${sitesFolder.path}' exists, but is not writable!")
}
} else {
logger.warn(
"The sites folder exists and will be used '{}'!",
defaultSitesFolder.path
)
logger.warn("The sites folder '{}' does not exist -> trying to create", sitesFolder.path)
if (!sitesFolder.mkdirs()) {
throw GradleException("The sites folder '${sitesFolder.path}' does not exist, but can not be " +
"created!")
}
logger.quiet("Created sites folder '{}'", sitesFolder.path)
}
} else {
val sitesFolder = File(sitesFolderPath)
}

if (sitesFolder.exists() && sitesFolder.canWrite()) {
logger.warn("The sites folder exists and can be used '{}'!", sitesFolder.path)
} else {
if (!sitesFolder.canWrite()) {
logger.warn(
"The sites folder exists, but it is not possible to write '{}'!",
sitesFolder.path
)
// try to make sites folder accessible to other users especially 'intershop' (inside the container)
val os = OS.bySystem()
os?.run {
if (this == OS.LINUX || this == OS.MAC){
// execute '/bin/sh -c chmod a+rwx <sitesFolder>', stdout/stderr are just redirected to gradle's
// stdout/stderr
val process = ProcessBuilder().command("/bin/sh", "-c", "chmod a+rwx '${sitesFolder.path}'").
inheritIO().start()
val isTimeout = !process.waitFor(5, TimeUnit.SECONDS)
if (isTimeout){
throw GradleException("Timed out while making the sites folder '${sitesFolder.path}' " +
"accessible to everyone!")
}
if (sitesFolder.mkdirs()) {
logger.warn(
"The sites folder does not exist, but it is was possible to create '{}'!",
sitesFolder.path
)
} else {
logger.error(
"The sites folder does not exist and it is was possible to create '{}'!",
sitesFolder.path
)
throw GradleException(
"It was not possible to create the sites folder '{" +
sitesFolder.path + "'!"
)
val exitCode = process.exitValue()
if (exitCode != 0){
throw GradleException("Failed to make the sites folder '${sitesFolder.path}' accessible to " +
"everyone (exitCode=$exitCode)!")
}
}

}
}
}
Expand Down

0 comments on commit 1de01e5

Please sign in to comment.