LPD-62912 Add support for Microsoft SQL Server 2022

.gitignore

@@ -1,6 +1,7 @@
 **/*.iml
 **/*.so
 **/*db2jcc4.jar
+**/*mssql-jdbc-12.10.1.jre11.jar
 **/*dxp-license-*.xml
 **/*hotfix*.zip
 **/.classpath

Dockerfile.helper

@@ -2,6 +2,10 @@ FROM busybox:latest
 
 ARG DATA_DIRECTORY=data
 
-USER 1000
+COPY --chown=1000:1000 ${DATA_DIRECTORY} /container-data
 
-COPY --chown=1000:1000 ${DATA_DIRECTORY} /container-data
+RUN ([ -d /container-data/sqlserver ] && addgroup --gid 10001 mssql && adduser -S -s /usr/sbin/nologin -h /home/mssql --disabled-password -G mssql -u 10001 mssql) || echo
+
+RUN ([ -d /container-data/sqlserver ] && chown -R 10001:10001 /container-data/sqlserver) || echo
+
+USER 1000

README.markdown

@@ -29,6 +29,9 @@ To shut down the environment, run `./gradlew stop`.
 
 - [Enable MySQL 8.4](#enable-mysql-84)
 - [Enable PostgreSQL 16.3](#enable-postgresql-163)
+- [Enable DB2 11.5](#enable-db2-115)
+- [Enable MariaDB 10.6](#enable-mariadb-106)
+- [Enable Microsoft SQL Server 2022](#enable-microsoft-sql-server-2022)
 - [Import a database dump](#import-a-database-dump)
 - [Enable database partitioning (MySQL and PostgreSQL only)](#enable-database-partitioning-mysql-and-postgresql-only)
 - [Configure database port](#configure-database-port)
@@ -228,6 +231,36 @@ Set the `lr.docker.environment.service.enabled[postgres]` property to `true` or
 lr.docker.environment.service.enabled[postgres]=true
 ```
 
+#### Enable DB2 11.5
+
+Set the `lr.docker.environment.service.enabled[db2]` property to `true` or `1` in `gradle.properties`.
+
+`gradle.properties`:
+
+```properties
+lr.docker.environment.service.enabled[db2]=true
+```
+
+#### Enable MariaDB 10.6
+
+Set the `lr.docker.environment.service.enabled[mariadb]` property to `true` or `1` in `gradle.properties`.
+
+`gradle.properties`:
+
+```properties
+lr.docker.environment.service.enabled[mariadb]=true
+```
+
+#### Enable Microsoft SQL Server 2022
+
+Set the `lr.docker.environment.service.enabled[sqlserver]` property to `true` or `1` in `gradle.properties`.
+
+`gradle.properties`:
+
+```properties
+lr.docker.environment.service.enabled[sqlserver]=true
+```
+
 #### Import a database dump
 
 Database dump files can be added to the `./dumps` directory at the root of the Workspace. They will automatically be copied into the database container.

build.gradle

@@ -129,13 +129,13 @@ buildDockerImage {
 	}
 
 	dependsOn ":checkForLiferayLicense"
-	dependsOn ":prepareDB2JDBCDriver"
+	dependsOn ":prepareJDBCDriver"
 
 	mustRunAfter ":importDatabaseDumps"
 }
 
 clean {
-	dependsOn ":cleanPrepareDB2JDBCDriver"
+	dependsOn ":cleanPrepareJDBCDriver"
 	dependsOn ":cleanPrepareHotfixes"
 	dependsOn ":cleanPrepareSelfSignedCert"
 	dependsOn ":cleanPrepareWebserverConfig"
@@ -144,7 +144,7 @@ clean {
 }
 
 dockerDeploy {
-	dependsOn ":prepareDB2JDBCDriver"
+	dependsOn ":prepareJDBCDriver"
 	dependsOn ":prepareHotfixes"
 	dependsOn ":prepareYourKitAgent"
 }

buildSrc/src/main/groovy/com/liferay/docker/workspace/environments/Config.groovy

@@ -169,26 +169,33 @@ class Config {
 		this.useClustering = this.useLiferay && this.clusterNodes > 0
 
 		if (this.services.contains("db2")) {
+			this.databaseType = "db2"
 			this.useDatabase = true
 			this.useDatabaseDB2 = true
-			this.dockerContainerDatabase = "${this.namespace}-database-db2"
 		}
 
 		if (this.services.contains("mariadb")) {
+			this.databaseType = "mariadb"
 			this.useDatabase = true
 			this.useDatabaseMariaDB = true
 		}
 
 		if (this.services.contains("mysql")) {
+			this.databaseType = "mysql"
 			this.useDatabase = true
 			this.useDatabaseMySQL = true
-			this.dockerContainerDatabase = "${this.namespace}-database-mysql"
 		}
 
 		if (this.services.contains("postgres")) {
+			this.databaseType = "postgres"
 			this.useDatabase = true
 			this.useDatabasePostgreSQL = true
-			this.dockerContainerDatabase = "${this.namespace}-database-postgres"
+		}
+
+		if (this.services.contains("sqlserver")) {
+			this.databaseType = "sqlserver"
+			this.useDatabase = true
+			this.useDatabaseSQLServer = true
 		}
 
 		if (this.services.contains("webserver_http") && this.services.contains("webserver_https")) {
@@ -277,10 +284,10 @@ class Config {
 	public List<Map<String, String>> companyVirtualHosts = null
 	public List<String> composeFiles = new ArrayList<String>()
 	public String databaseName = "lportal"
+	public String databaseType = ""
 	public boolean databasePartitioningEnabled = false
 	public String dataDirectory = "data"
 	public Map<String, String> defaultCompanyVirtualHost = null
-	public String dockerContainerDatabase = null
 	public String dockerImageLiferay = null
 	public boolean dockerImageLiferayDXP = false
 	public boolean glowrootEnabled = false
@@ -300,6 +307,7 @@ class Config {
 	public boolean useDatabaseMariaDB = false
 	public boolean useDatabaseMySQL = false
 	public boolean useDatabasePostgreSQL = false
+	public boolean useDatabaseSQLServer = false
 	public boolean useLiferay = false
 	public boolean useWebserverHttp = false
 	public boolean useWebserverHttps = false

buildSrc/src/main/groovy/docker-common.gradle

@@ -22,6 +22,10 @@ ext {
 
 		println waitForCommand("docker run --rm -v ${volumeName}:/target busybox:latest du -sh /target/${targetName}")
 
+		if (config.useDatabaseSQLServer) {
+			waitForCommand("docker run --rm -v ${volumeName}:/target busybox:latest chown 10001:10001 /target/${targetName}")
+		}
+
 		println "Copied file ${sourcePath} to ${volumeName}"
 	}
 
@@ -50,9 +54,13 @@ ext {
 			return toResultRows(results, /,/)
 		}
 
-		if (config.useDatabaseDB2) {
+		if (config.useDatabaseDB2 || config.useDatabaseSQLServer) {
 			List<String> results = waitForCommand("${getDatabaseAccessCommand(schema)} \"${sql}\"").split("\n").minus("")
 
+			if (results.size() <= 1) {
+				return Collections.emptyMap()
+			}
+
 			results.removeLast()
 			results.remove(1)
 
@@ -98,7 +106,12 @@ ext {
 			return config.companyVirtualHosts
 		}
 
-		config.companyVirtualHosts = executeSQLQuery("select companyId, hostname, webId from VirtualHost inner join Company using (companyId) where layoutSetId = 0", config.databaseName)
+		if (config.useDatabaseSQLServer) {
+			config.companyVirtualHosts = executeSQLQuery("select VirtualHost.companyId, hostname, webId from VirtualHost inner join Company on (VirtualHost.companyId = Company.companyId) where layoutSetId = 0", config.databaseName)
+		}
+		else {
+			config.companyVirtualHosts = executeSQLQuery("select companyId, hostname, webId from VirtualHost inner join Company using (companyId) where layoutSetId = 0", config.databaseName)
+		}
 
 		return config.companyVirtualHosts
 	}
@@ -134,6 +147,10 @@ ext {
 				"docker compose exec --user db2admin -it database /opt/ibm/db2/V11.5/bin/db2"
 			].join("\n")
 		}
+
+		if (config.useDatabaseSQLServer) {
+			return "docker compose exec -it database /opt/mssql-tools18/bin/sqlcmd -S localhost -U sa -C -P Liferay123 -d ${config.databaseName} -Q"
+		}
 	}
 
 	getCompanyDefaultWebId = {

buildSrc/src/main/groovy/docker-database-saas.gradle

@@ -175,7 +175,7 @@ ext {
 	disableUserObjectValidations = {
 		String schema ->
 
-		executeSQLQuery("update ObjectValidationRule set active_ = false where objectDefinitionId in (select objectDefinitionId from ObjectDefinition where externalReferenceCode = 'L_USER')", schema)
+		executeSQLQuery("update ObjectValidationRule set active_ = 'false' where objectDefinitionId in (select objectDefinitionId from ObjectDefinition where externalReferenceCode = 'L_USER')", schema)
 
 		println "Disabled object validation users for User system object in schema ${schema}"
 	}
@@ -253,7 +253,7 @@ ext {
 
 		sanitizePortalPreferenceValues(schema, sanitizedPreferences)
 
-		executeSQLQuery("update MBMailingList set inServerName = 'fake-pop3-host', outServerName = 'fake-smtp-host', inPassword = 'fake-pop3-password', outPassword = 'fake-smtp-password', active_ = false", schema)
+		executeSQLQuery("update MBMailingList set inServerName = 'fake-pop3-host', outServerName = 'fake-smtp-host', inPassword = 'fake-pop3-password', outPassword = 'fake-smtp-password', active_ = 'false'", schema)
 
 		println "Sanitized known POP and SMTP configurations in schema ${schema}"
 	}
@@ -457,6 +457,7 @@ tasks.register("copyDatabaseDumpsToDumpsVolume") {
 		waitForCommand("docker compose create database")
 
 		fileTree("dumps") {
+			include "**/*.bak"
 			include "**/*.sql"
 			include "**/*.sql.gz"
 			include "**/*.gz"

buildSrc/src/main/groovy/docker-liferay-bundle.gradle

@@ -12,10 +12,12 @@ project.plugins.apply "docker-common"
 
 configurations {
 	db2
+	sqlserver
 }
 
 dependencies {
 	db2 group: "com.ibm.db2.jcc", name: "db2jcc", version: "db2jcc4"
+	sqlserver group: "com.microsoft.sqlserver", name: "mssql-jdbc", version: "12.10.1.jre11"
 }
 
 Closure<Boolean> isValidLicenseFile = {
@@ -190,15 +192,19 @@ tasks.register("checkForLiferayLicense") {
 	}
 }
 
-tasks.register("prepareDB2JDBCDriver", Copy) {
+Configuration dbDriverConfiguration = configurations.findByName(config.databaseType)
+
+tasks.register("prepareJDBCDriver", Copy) {
 	onlyIf("using the Liferay service") {
 		config.useLiferay
 	}
-	onlyIf("using the DB2 database") {
-		config.useDatabaseDB2
+	onlyIf("there is a database driver to install") {
+		dbDriverConfiguration != null
 	}
 
-	from configurations.db2
+	from {
+		dbDriverConfiguration
+	}
 	into "configs/common/tomcat/webapps/ROOT/WEB-INF/shielded-container-lib"
 }
 

compose-recipes/sqlserver/Dockerfile

@@ -0,0 +1,20 @@
+FROM mcr.microsoft.com/mssql/server:2022-CU21-ubuntu-22.04
+
+USER root
+
+RUN mkdir -p /var/opt/mssql/backups /var/opt/mssql/data
+RUN chown -R mssql:mssql /var/opt/mssql/
+RUN touch /startup_log.txt
+RUN chown mssql:mssql /startup_log.txt
+
+COPY entrypoint.sh /init/
+COPY init.sql /init/
+COPY reinit.sql /init
+COPY restore.sql /init
+
+RUN chown -R mssql:mssql /init && \
+    chmod a+x /init/entrypoint.sh
+
+USER mssql
+
+ENTRYPOINT ["/bin/bash", "/init/entrypoint.sh"]

compose-recipes/sqlserver/clustering.sqlserver.yaml

@@ -0,0 +1,7 @@
+services:
+    liferay-cluster-node:
+        environment:
+            -   LIFERAY_JDBC_PERIOD_DEFAULT_PERIOD_DRIVER_UPPERCASEC_LASS_UPPERCASEN_AME=com.microsoft.sqlserver.jdbc.SQLServerDriver
+            -   LIFERAY_JDBC_PERIOD_DEFAULT_PERIOD_PASSWORD=Liferay123
+            -   LIFERAY_JDBC_PERIOD_DEFAULT_PERIOD_URL=jdbc:sqlserver://database:1433;databaseName=lportal;Encrypt=True;TrustServerCertificate=True
+            -   LIFERAY_JDBC_PERIOD_DEFAULT_PERIOD_USERNAME=sa

compose-recipes/sqlserver/entrypoint.sh

@@ -0,0 +1,79 @@
+#!/bin/bash
+
+_sqlcmd="/opt/mssql-tools18/bin/sqlcmd -C -S localhost -U sa -P ${MSSQL_SA_PASSWORD}"
+
+_has_backup_file() {
+	if [[ $(find /var/opt/mssql/backups -type f -iname "*.bak") ]]; then
+		echo true
+	fi
+}
+
+_has_database_files() {
+	local database_name=${1}
+
+	if [[ $(find /var/opt/mssql/data -type f -iname "${database_name}.*") ]]; then
+		echo true
+	fi
+}
+
+_is_database_present() {
+	local database_name=${1}
+
+	if	[[ $(${_sqlcmd} -Q "select name from sys.databases" | grep "${database_name}") ]]; then
+
+		echo true
+	fi
+}
+
+create_database() {
+	local database_name=${1}
+
+	if [[ $(_is_database_present ${database_name}) ]]; then
+		echo "[entrypoint] Database ${database_name} is present; skipping database creation"
+
+		return
+	fi
+
+	if [[ $(_has_backup_file) ]]; then
+		echo "[entrypoint] Database backup found; restoring database ${database_name}..."
+
+		sed -i "s,%DATABASE_NAME%,${database_name},g" /init/restore.sql
+
+		local backup_file=$(find /var/opt/mssql/backups -type f -iname "*.bak")
+
+		sed -i "s,%BACKUP_FILE%,${backup_file},g" /init/restore.sql
+
+		${_sqlcmd} -i /init/restore.sql
+
+		return
+	fi
+
+	if [[ $(_has_database_files ${database_name}) ]]; then
+		echo "Database files found; reattaching database ${database_name}..."
+
+		sed -i "s,%DATABASE_NAME%,${database_name},g" /init/reinit.sql
+
+		${_sqlcmd} -i /init/reinit.sql
+
+		return
+	fi
+
+	echo "[entrypoint] Could not find database ${database_name}; creating database..."
+
+	sed -i "s,%DATABASE_NAME%,${database_name},g" /init/init.sql
+
+	${_sqlcmd} -i /init/init.sql
+}
+
+main() {
+	until ${_sqlcmd} -Q "SELECT 1"; do
+		sleep 1
+		echo "[entrypoint] Waiting for SQL Server to be available..."
+	done
+
+	create_database ${COMPOSER_DATABASE_NAME}
+}
+
+main & /opt/mssql/bin/sqlservr
+
+wait

compose-recipes/sqlserver/init.sql

@@ -0,0 +1,2 @@
+CREATE DATABASE %DATABASE_NAME%
+GO

compose-recipes/sqlserver/liferay.sqlserver.yaml

@@ -0,0 +1,10 @@
+services:
+    liferay:
+        depends_on:
+            database:
+                condition: service_healthy
+        environment:
+            -   LIFERAY_JDBC_PERIOD_DEFAULT_PERIOD_DRIVER_UPPERCASEC_LASS_UPPERCASEN_AME=com.microsoft.sqlserver.jdbc.SQLServerDriver
+            -   LIFERAY_JDBC_PERIOD_DEFAULT_PERIOD_PASSWORD=Liferay123
+            -   LIFERAY_JDBC_PERIOD_DEFAULT_PERIOD_URL=jdbc:sqlserver://database:1433;databaseName=lportal;Encrypt=True;TrustServerCertificate=True
+            -   LIFERAY_JDBC_PERIOD_DEFAULT_PERIOD_USERNAME=sa