2020-11-24

This plugin collection contains plugins for building container images and starting container of and for Intershop Commerce Management. It is necessary that the 'ICM Gradle plugin' was applied to the project. Version 3.4.0 of this plugin is the minimum version. This plugin is based on 'Gradle Docker plugin' and the 'Docker-Java Framework'.

This plugin configures the basics of an Intershop Commerce Management product project.

The plugins must be applied to the root project.

Groovy

plugins { id 'com.intershop.gradle.icm.base' version '3.4.0' id 'com.intershop.gradle.icm.docker' version '{latestRevision}' } docker { registryCredentials { url = "https://<registry hostname>" username = "<registry user name>" password = "<registry user password>" email = "<registry user email>" } } intershop { // see https://github.com/IntershopCommunicationsAG/icm-gradle-plugin projectInfo {} projectConfig {} } intershop_docker { images { icmsetup = 'registry.intershop.de/intershop/icm-base:1.9.2' webadapter = 'registry.intershop.de/intershop/icm-webadapter:2.0.6' webadapteragent = 'registry.intershop.de/intershop/icm-webadapteragent:3.0.4' mssql = '<image with an prepares installation for Intershop>' oracle = '<image with an prepares installation for Intershop>' mailsrv = 'mailhog/mailhog:latest' } imageBuild { license = 'Intershop Communications AG' maintainer = 'Intershop Communications AG "www.intershop.de"' baseDescription = 'Intershop Commerce Management' baseImageName = '${dockerRegHostName}/intershop/icm' images { mainImage { dockerfile = file('docker/main/Dockerfile') addFiles(tasks.createMainPkg.outputs.files) dockerBuildDir = 'main' description = 'AppServer Container' enabled = true } initImage { dockerfile = file('docker/init/Dockerfile') addFiles(tasks.createInitPkg.outputs.files) dockerBuildDir = 'init' description = 'Init Container' enabled = true } testImage { dockerfile = file('docker/test/Dockerfile') addFiles(tasks.createTestPkg.outputs.files) dockerBuildDir = 'test' description = 'AppServer Test Container' enabled = true } initTestImage { dockerfile = file('docker/initTest/Dockerfile') addFiles(tasks.createInitTestPkg.outputs.files) dockerBuildDir = 'inittest' description = 'Test Init Conainer' enabled = true } } } }

Kotlin

plugins { id("com.intershop.gradle.icm.base") version "2.2.0" id("com.intershop.gradle.icm.docker") version "{latestRevision}" } docker { registryCredentials { url.set("https://<registry hostname>") username.set("<registry user name>") password.set("<registry user password>") email.set("<registry user email>") } } intershop { // see https://github.com/IntershopCommunicationsAG/icm-gradle-plugin projectInfo {} projectConfig {} } intershop_docker { images { icmsetup.set("docker-public.rnd.intershop.de/intershop/icm-base:1.9.2") webadapter.set("docker-public.rnd.intershop.de/intershop/icm-webadapter:2.0.6") webadapteragent.set("docker-public.rnd.intershop.de/intershop/icm-webadapteragent:3.0.4") mssqldb.set("<image with an prepares installation for Intershop>") oracle.set("<image with an prepares installation for Intershop>") mailsrv.set("mailhog/mailhog:latest") } imageBuild { license.set("Intershop Communications AG") maintainer.set("Intershop Communications AG 'www.intershop.de'") baseDescription.set("Intershop Commerce Management") baseImageName.set("${dockerRegHostName}/intershop/icm") images { mainImage { dockerfile.set(file("docker/main/Dockerfile")) addFiles(tasks.createMainPkg.get().outputs.files) dockerBuildDir.set("main") description.set("AppServer Container") enabled.set(true) } initImage { dockerfile.set(file("docker/init/Dockerfile")) addFiles(tasks.createInitPkg.get().outputs.files) dockerBuildDir.set("init") description.set("Init Container") enabled.set(true) } testImage { dockerfile.set(file("docker/test/Dockerfile")) addFiles(tasks.createTestPkg.get().outputs.files) dockerBuildDir.set("test") description.set("AppServer Test Container") enabled.set(true) } initTestImage { dockerfile.set(file("docker/initTest/Dockerfile")) addFiles(tasks.createInitTestPkg.get().outputs.files) dockerBuildDir.set("inittest") description.set("Test Init Conainer") enabled.set(true) } } } }

Properties Property Type Default value Description containerProjectPrefix Property<String> <project name> Underscores will be replaced with dashes. This property is used for container names, volumes and network in Docker. developmentConfig DevelopmentConfiguration This extension handles the access to a local property file, to adapt the configuration to a local environment. See . images Images This extension contains the configuration of all supported and necessary images. imageBuild ProjectConfiguration This part contains the configuration for all image artifacts of a build project. Methods Method Parameter Description developmentConfig Closure<DevelopmentConfiguration> Configures the development configuration of this project in a Groovy context. developmentConfig Action<in DevelopmentConfiguration> Configures the development configuration of this project in a Kotlin script context. images Closure<Images> Configures the images' configuration of this project in a Groovy context. images Action<in Images> Configures the images' configuration of this project in a Kotlin script context. imageBuild Closure<ProjectConfiguration> Configures the image build configuration of this project in a Groovy context. imageBuild Action<in ProjectConfiguration> Configures the image build configuration of this project in a Kotlin script context.

Properties Property Type Default value Description appserverAsContainer Boolean false If the appserver runs as a container this value must be true. This is used for customer projects. licenseDirectory String <GRADLE_USER_HOME>/icm-default/lic The directory with a valid license file for the running project. configDirectory String <GRADLE_USER_HOME>/icm-default/conf This directory contains the environment specific development configuration for ICM. See . licenseFilePath String <licenseDirectory>/license.xml The file path of the license file (read only). configFilePath String <configDirectory>/icm.properties The path of the configuration file (read only). Methods Method Parameter Description getConfigProperty String Get a property from the configuration file. If the property key is not available the return value is empty. getConfigProperty String, String Get a property from the configuration file. If the property key is not available the return value is specified by the second parameter.

Properties Property Type Default value Description icmsetup Property<String> docker.intershop.de/intershop/icm-base:latest This image is used as a base image for the most ICM images. webadapter Property<String> docker.intershop.de/intershop/icm-webadapter:latest The image contains the web server of the Intershop Commerce Management application with a special Intershop Apache module. webadapteragent Property<String> docker.intershop.de/intershop/icm-webadapteragent:latest The web adapter agent image of the Intershop Commerce Management application. mssqldb Property<String> mcr.microsoft.com/mssql/server:2019-latest The Microsoft SQL server image. There will be also a build file available. oracledb Property<String> docker.intershop.de/intershop/oracle-xe-server:18.4.0 This image is only available internally. The build files will be provided. mailsrv Property<String> mailhog/mailhog:latest A mail server for testing the mail feature of the application.

Properties Property Type Default value Description license Property<String> "Intershop Communications AG" The license of image artifacts created by this build. maintainer Property<String> "Intershop Communications AG \"www.intershop.de\"" The maintainer of image artifacts created by this build. baseDescription Property<String> "Intershop Commerce Management" The base description for all image artifacts created by this build. version Property<String> The version of image artifacts created by this build. created Property<String> <build time> The build time of image artifacts created by this build. The machine time is used for the default value. baseImageName Property<String> "server/intershop/icm" The base image name for all image artifacts created by this build. images Images The detailed configuration of all image builds.

Properties Property Type Default value Description mainImage ImageConfiguration The configuration of the main server image build. testImage ImageConfiguration The configuration of the test server image build. This image uses the main image as a base image. initImage ImageConfiguration The configuration of the init image for the ICM application server. initTestImage ImageConfiguration The configuration of the test init image. This image uses the init image as a base image. For all properties configurations methods with a closure or an action are available.

Properties Property Type Default value Description nameExtension Property<String> Image name extension of the special image. The base is used from the . description Property<String> Extended description of the image. srcFiles ConfigurableFileCollection Source files for the build (start scripts etc.). This files are referenced by the Dockerfile. pkgTaskName Property<String> Files will be packaged by the build for an installation in a docker image. This is the name of the package task. dockerfile RegularFileProperty The docker file for the image build. dockerBuildDir Property<String> The working director for the image build. enabled Property<Boolean> The build of the image can be disabled for the project.

Task name Description prepareNetwork Creates a network with the specified name <extension name>-network. All start tasks are dependend on this task. removeNetwork Removes the network from the Docker configuration. *MSSQL These tasks pull, start, stop and remove the MSSQL image. *Oracle These tasks pull, start, stop and remove the Oracle DB image. *MailSrv These tasks pull, start, stop and remove the Mail server image. createWebVolumes Creates necessary volumes for the ICM web server with WebAdapter Agent. removeWebVolumes Removes web server volumes from the Docker configuration. *WAA These tasks pull, start, stop and remove the ICM Web Adapter Agent image. *WA These tasks pull, start, stop and remove the ICM Web Adapter image. This image contains a Apache webserver with the ICM WA module. *WebServer These tasks orchestrate all web server related tasks. containerClean This task starts the remove tasks for all available objects. The package of all tasks is com.intershop.gradle.icm.docker.tasks. Task name Class Description pull* AbstractPullImage These task pull the image or a set of images. start* StartExtraContainer Start image with the necessary configuration. stop* StopExtraContainer Stop image by name. remove* RemoveContainerByName Removes image from Docker by name. and Image Properties There are no special configuration properties for the mail server. The SMTP port is 25 and the web interface listened on 8025. Mails are stored in the build directory mailoutput. Task Property Key Property Value MSSQL intershop.db.mssql.hostport Exposed port of the database intershop.db.mssql.sa.password Name of the admin password. Default value is "1ntershop5A". intershop.db.mssql.recreatedb The db will be recreated after a restart if the value is true. Default value is "false". intershop.db.mssql.recreateuser The db will be recreated after a restart if the value is true. Default value is "false". intershop.db.mssql.dbname The name of the database. Default is "icmtestdb" Oracle intershop.db.oracle.listenerport Exposed listener port of the database. intershop.db.oracle.port Exposed enterprise manager port of the oracle db. WA webserver.http.port Exposed http port of the webserver. webserver.https.port Exposed https port of the webserver. intershop.local.hostname Hostname or IP of the local host. This is used for the connection between WA and AS on the local host.

This plugin configures additional tasks of an Intershop Commerce Management customer project. It uses the same Gradle configuration like the Docker Plugin. With this plugin additional task will be configured and the task dependencies are adapted for the development process. The plugins must be applied to the root project.

Properties Property Type Default value Description ishUnitTests NamedDomainObjectContainer<Suite> This is a configuration for special Intershop server unit tests. This configuration is used only in a customer project.

Properties Property Type Default value Description cartridge Property<String> This is the name of a cartridge that also contains ishUnitTests. testSuite Property<String> The name of the test suite.

Properties Property Type Default value Description icmbase Property<String> docker.intershop.de/intershop/icm-as:latest This image is used as a base image for the ICM application server image. icminit Property<String> docker.intershop.de/intershop/icm-as-init:latest This image is used as a base image for ICM application server initialization image. solr Property<String> solr/latest This image is used for the Solr Cloud configuration with a single node. zookeeper Property<String> zookeeper:latest This image is used for the Solr Cloud configuration with a single node.

Task name Description *SolrCloud These tasks orchestrate all Solr Cloud related tasks. *ZK These tasks pull, start, stop and remove the Zookeeper image. *Solr These tasks pull, start, stop and remove the Solr image. *Container These tasks pull, start, stop and remove the ICM application server image with a special command. There is no running process inside, but it uses the same configuration like the appserver container. *AS These tasks pull, start, stop and remove the ICM application server image. *Server These tasks orchestrate all ICM server related tasks (web server and app server) dbPrepare This task starts dbPrepare inside the running "Container" docker container. ishUnitTestReport This task starts the creation of a report for all ISHUnit test executions. *ISHUnitTest These tasks starts ishUnit tests inside the running "Container" docker container. For task classes see the documentation of task in the Intershop Commerce Management Docker Plugin. The task startContainer and startAs uses StartServerContainer. pullContainer and pullAS uses PullImage. With this task it is possible to use an alternative image for these tasks with a command line parameter --altImage.

Additional test tasks of an Intershop Commerce Management project will be added by this plugin. It uses the same Gradle configuration like the Docker Plugin. One additional task is added by this plugin. The plugins must be applied to the root project.

Properties Property Type Default value Description testmailsrv Property<String> docker-internal.rnd.intershop.de/icm-test/iste-mail:latest This image is used for ICM HTMLUnitTests.

Task name Description *TestMailSrv These tasks pull, start, stop and remove the Test mail server image. For task classes see the documentation of task in the Intershop Commerce Management Docker Plugin.

This plugin adds test tasks for Geb.

The plugin must be applied to the project with included Geb tests. It requires an applied ICM Docker plugin. Furthermore it depends on the configuration of Geb self (GebConfig.groovy).

Groovy

plugins { id 'com.intershop.gradle.icm.docker.gebtest' version '3.4.0' } gebConfiguration { localDriver { geckoDriver { osPackages { linux { url = 'https://github.com/mozilla/geckodriver/releases/download/v0.24.0/geckodriver-v0.24.0-linux64.tar.gz' archiveType = 'tar.gz' webDriverExecName = 'geckodriver' } win { url = 'https://github.com/mozilla/geckodriver/releases/download/v0.24.0/geckodriver-v0.24.0-win32.zip' archiveType = 'zip' webDriverExecName = 'geckodriver.exe' } mac { url = 'https://github.com/mozilla/geckodriver/releases/download/v0.24.0/geckodriver-v0.24.0-macos.tar.gz' archiveType = 'tar.gz' webDriverExecName = 'geckodriver' } } } chromeDriver { osPackages { linux { url = 'https://chromedriver.storage.googleapis.com/86.0.4240.22/chromedriver_linux64.zip' archiveType = 'zip' webDriverExecName = 'chromedriver' } win { url = 'https://chromedriver.storage.googleapis.com/86.0.4240.22/chromedriver_win32.zip' archiveType = 'zip' webDriverExecName = 'chromedriver.exe' } mac { url = 'https://chromedriver.storage.googleapis.com/86.0.4240.22/chromedriver_mac64.zip' archiveType = 'zip' webDriverExecName = 'chromedriver' } } } } }

Kotlin

plugins { id("com.intershop.gradle.icm.docker.gebtest") version "3.4.0" } extensions.getByType(GebConfiguration::class.java).apply { localDriver { register("geckoDriver") { osPackages { register("linux") { url.set("https://github.com/mozilla/geckodriver/releases/download/v0.24.0/geckodriver-v0.24.0-linux64.tar.gz") archiveType.set("tar.gz") webDriverExecName.set("geckodriver") } register("win") { url.set("https://github.com/mozilla/geckodriver/releases/download/v0.24.0/geckodriver-v0.24.0-win32.zip") archiveType.set("zip") webDriverExecName.set("geckodriver.exe") } register("mac") { url.set("https://github.com/mozilla/geckodriver/releases/download/v0.24.0/geckodriver-v0.24.0-macos.tar.gz") archiveType.set("tar.gz") webDriverExecName.set("geckodriver") } } } register("chromeDriver") { osPackages { register("linux") { url.set("https://chromedriver.storage.googleapis.com/86.0.4240.22/chromedriver_linux64.zip") archiveType.set("zip") webDriverExecName.set("chromedriver") } register("win") { url.set("https://chromedriver.storage.googleapis.com/86.0.4240.22/chromedriver_win32.zip") archiveType.set("zip") webDriverExecName.set("chromedriver.exe") } register("mac") { url.set("https://chromedriver.storage.googleapis.com/86.0.4240.22/chromedriver_mac64.zip") archiveType.set("zip") webDriverExecName.set("chromedriver") } } } } }

This plugin adds also a source set configuration for gebTests: source directory is "src/gebTest/groovy" resource directory is "src/gebTest/resources" The plugin is based on the following GebTest configuration: import org.junit.runner.Description import org.junit.runners.model.Statement import org.openqa.selenium.Dimension import org.openqa.selenium.chrome.ChromeDriver import org.openqa.selenium.chrome.ChromeOptions import org.openqa.selenium.firefox.FirefoxDriver import org.openqa.selenium.firefox.FirefoxOptions import org.openqa.selenium.firefox.FirefoxDriverLogLevel import org.testcontainers.DockerClientFactory import org.testcontainers.containers.BrowserWebDriverContainer import org.testcontainers.containers.Network def webDriverExec = System.getProperty('webdriverExec') def containerNetwork = System.getProperty('container.network') waiting { // max request time in seconds timeout = 90 // http://gebish.org/manual/current/#failure-causes includeCauseInMessage = true } environments { firefoxContainer { driver = { def networkId = findNetworkIdForName(containerNetwork) BrowserWebDriverContainer webdriverContainer = addFirefoxContainerToNetwork(networkId) webdriverContainer.start() driver = webdriverContainer.getWebDriver() driver } } chromeContainer { driver = { def networkId = findNetworkIdForName(containerNetwork) BrowserWebDriverContainer webdriverContainer = addFirefoxContainerToNetwork(networkId) webdriverContainer.start() driver = webdriverContainer.getWebDriver() driver } } chromeTablet { driver = { def driver = createChromeDriverInstance(webDriverExec) driver.manage().window().setSize(new Dimension(1024, 768)) driver } } chromePC { driver = { def driver = createChromeDriverInstance(webDriverExec) driver.manage().window().setSize(new Dimension(1920, 1200)) driver } } geckoPC { driver = { def driver = createGeckoDriverInstance(webDriverExec) driver.manage().window().setSize(new Dimension(1920, 1200)) driver } } geckoTablet { driver = { def driver = createGeckoDriverInstance(webDriverExec) driver.manage().window().setSize(new Dimension(1024, 768)) driver } } } private def createGeckoDriverInstance(String webDriverExec) { System.setProperty("webdriver.gecko.driver", webDriverExec) FirefoxOptions options = new FirefoxOptions() //options.setHeadless(true) options.setLogLevel(FirefoxDriverLogLevel.ERROR) driverInstance = new FirefoxDriver(options) driverInstance } private def createChromeDriverInstance(String webDriverExec) { System.setProperty("webdriver.chrome.driver", webDriverExec) driverInstance = new ChromeDriver() driverInstance } private BrowserWebDriverContainer addFirefoxContainerToNetwork(String networkId){ Network tcNet = createNetwork(networkId) FirefoxOptions options = new FirefoxOptions() options.setHeadless(true) BrowserWebDriverContainer webdriverContainer = new BrowserWebDriverContainer<>() .withCapabilities(options) .withNetwork(tcNet) return webdriverContainer } private BrowserWebDriverContainer addChromeContainerToNetwork(String networkId){ Network tcNet = createNetwork(networkId) ChromeOptions options = new ChromeOptions() options.setHeadless(true) BrowserWebDriverContainer webdriverContainer = new BrowserWebDriverContainer<>() .withCapabilities(options) .withNetwork(tcNet) return webdriverContainer } private String findNetworkIdForName(String name) { def client = DockerClientFactory.instance().client() def rv = client.inspectNetworkCmd().withNetworkId(name).exec().id return rv } private createNetwork(networkId) { Network tcNet = new Network() { @Override String getId() { return networkId } @Override void close() throws Exception {} @Override Statement apply(Statement base, Description description) { return null } } return tcNet } The plugin set the following system properties for the test: webdriverExec Executable name for local drivers from the extension configuration. container.network Network for the test containers framework. geb.build.baseUrl The url will be calculated from the base configuration of the web server image. If the container framework is used, the internal network name is used. Furthermore the host

Properties Property Type Default value Description gebEnvironment Property<String> "firefoxContainer" Name of the configured in the Geb configuration file GebConfig.groovy. localDriver NamedDomainObjectContainer<GebLocalDriver> Container with local driver configurations.

Properties Property Type Default value Description osPackages NamedDomainObjectContainer<GebDriverDownload> Container with a configuration to download the necessary driver download.

Properties Property Type Default value Description url Property<String> Container with a configuration to download the necessary driver download. archiveType Property<String> Container with a configuration to download the necessary driver download. webDriverExecName Property<String> Container with a configuration to download the necessary driver download.

Task name Class Description gebTest Test GebTest Starts the Geb Test form the gebTest source set. downloadDriver GebDriverDownload Downloads and unpack the configured local driver if necessary. and Image Properties It is possible to switch to a local driver for development purposes. Task Property Key Property Value gebTest geb.local.driver The name of the local driver. geb.local.environment The name of the local environment. For container configuration * webserver.container.http.port The exposed http port of the webserver. Default: 808 webserver.container.https.port The exposed https port of the webserver. Default: 8443 For local configuration * intershop.local.hostname The hostname or the IP of the local machine. webserver.http.port The exposed http port of the webserver. webserver.https.port The exposed https port of the webserver.

If the project includes SolrCloud as a search engine, this plugin provides some necessary tasks for the management of search indexes. It uses the same configuration like the ICM Docker plugin.

Task name Class Description cleanUpSolr CleanUpSolr Removes all search configurations and collections with a specified prefix. listSolr ListSolr List all search configurations and collections with a specified prefix. rebuildSearchIndex RebuildSolrSearchIndex Starts an ICM job over the ICM Rest interface to rebuild all search indexes. and Image Properties Task Property Key Property Value cleanUpSolr listSolr solr.zooKeeperHostList A list of all Zookeeper hosts with port and the Solr server prefix. e.g. zookeeper1:2181,zookeeper2:2181,zookeeper3:2181/solr solr.clusterIndexPrefix A simple installation specific prefix for the Solr search configuration, e.g. the hostname. rebuildSearchIndex intershop.smc.admin.user.name This is the ICM SMC admin user. Default: admin. intershop.smc.admin.user.password This is the password of the SMC admin user. disable.ssl.verification If no public SSL certificate is installed on the webserver, it is possible to disable the verification with the value true. * intershop.local.hostname The hostname or the IP of the local machine. webserver.http.port The exposed http port of the webserver. webserver.https.port The exposed https port of the webserver.

For the configuration on a special local maschine it is necessary to provide an Intershop licence file and a imc.properties file in file structure. It is possible to configure the location with environment properties. This is a minimum set of properties. icm.properties # database connection configuration intershop.databaseType = oracle|mssql intershop.jdbc.url = jdbc:oracle:thin:@host:1521:XE | jdbc:sqlserver://host:1433;databaseName=dbname intershop.jdbc.user = user intershop.jdbc.password = password # webserver configuration of the appserver intershop.WebServerURL=http://host:8080 intershop.WebServerSecureURL=https://host:8443 # webserver configuration webserver.http.port = 8080 webserver.https.port = 8080 # database container configuration intershop.db.mssql.dbname = dbname # server configuration intershop.servletEngine.connector.port = 7743 # local host configuration # this is not always 'localhost'. intershop.local.hostname = 192.168.2.205 # solr configuiration solr.zooKeeperHostList = jengsolr1.intershop.de:2181;jengsolr2.intershop.de:2181;jengsolr3.intershop.de:2181/solr8 solr.clusterIndexPrefix = devhost intershop.smc.admin.user.name = admin intershop.smc.admin.user.password = password # disable the ssl verification of the webserver disable.ssl.verification = true # geb.local.environment = chromePC # geb.local.driver = chromeDriver

Copyright 2014-2020 Intershop Communications. 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.