DataSourceFactoryImplTest.java

/**
 * Copyright (c) 2000-present Liferay, Inc. All rights reserved.
 *
 * This library is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License as published by the Free
 * Software Foundation; either version 2.1 of the License, or (at your option)
 * any later version.
 *
 * This library is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
 * details.
 */

package com.liferay.portal.dao.jdbc;

import com.liferay.portal.kernel.configuration.Filter;
import com.liferay.portal.kernel.dao.jdbc.DataSourceFactoryUtil;
import com.liferay.portal.kernel.test.rule.NewEnv;
import com.liferay.portal.kernel.test.rule.NewEnv.JVMArgsLine;
import com.liferay.portal.kernel.test.rule.NewEnvTestRule;
import com.liferay.portal.kernel.util.PropsKeys;
import com.liferay.portal.kernel.util.PropsUtil;
import com.liferay.portal.test.log.CaptureAppender;
import com.liferay.portal.test.log.Log4JLoggerTestUtil;
import com.liferay.portal.util.InitUtil;
import com.liferay.portal.util.JarUtil;
import com.liferay.portal.util.PropsImpl;
import com.liferay.portal.util.PropsValues;
import com.liferay.registry.BasicRegistryImpl;
import com.liferay.registry.RegistryUtil;

import java.io.IOException;

import java.lang.management.ManagementFactory;

import java.net.URI;
import java.net.URL;

import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.nio.file.StandardCopyOption;

import java.sql.Connection;
import java.sql.PreparedStatement;

import java.util.List;
import java.util.Properties;

import javax.management.MBeanServer;
import javax.management.ObjectName;

import javax.sql.DataSource;

import org.apache.log4j.Level;
import org.apache.log4j.spi.LoggingEvent;

import org.hsqldb.jdbc.JDBCDriver;

import org.junit.After;
import org.junit.AfterClass;
import org.junit.Assert;
import org.junit.Before;
import org.junit.BeforeClass;
import org.junit.Rule;
import org.junit.Test;

/**
 * @author Dante Wang
 */
public class DataSourceFactoryImplTest {

	@BeforeClass
	public static void setUpClass() throws IOException {

		// Run before the test JVM starts to ensure the dynamic download
		// actually happens during the test run

		PropsUtil.setProps(new PropsImpl());

		String jarName = PropsUtil.get(
			PropsKeys.SETUP_LIFERAY_POOL_PROVIDER_JAR_NAME,
			new Filter("hikaricp"));

		Path jarPath = Paths.get("lib/portal", jarName);

		if (Files.exists(jarPath)) {
			Path tempFilePath = Files.createTempFile(null, null);

			Files.move(
				jarPath, tempFilePath, StandardCopyOption.REPLACE_EXISTING);

			URI uri = tempFilePath.toUri();

			URL url = uri.toURL();

			System.setProperty(_HIKARICP_JAR_URL, url.toExternalForm());
		}
	}

	@AfterClass
	public static void tearDownClass() throws Exception {
		String hikaricpJarURL = System.clearProperty(_HIKARICP_JAR_URL);

		if (hikaricpJarURL != null) {
			PropsUtil.setProps(new PropsImpl());

			String jarName = PropsUtil.get(
				PropsKeys.SETUP_LIFERAY_POOL_PROVIDER_JAR_NAME,
				new Filter("hikaricp"));

			URL url = new URL(hikaricpJarURL);

			Files.move(
				Paths.get(url.toURI()), Paths.get("lib/portal", jarName),
				StandardCopyOption.REPLACE_EXISTING);
		}
	}

	@Before
	public void setUp() {
		_properties.setProperty("driverClassName", JDBCDriver.class.getName());
		_properties.setProperty("initializationFailFast", "false");
		_properties.setProperty("maximumPoolSize", "10");
		_properties.setProperty("password", "");
		_properties.setProperty("poolName", "TestJDBCPool");
		_properties.setProperty("url", "jdbc:hsqldb:mem:testDB;shutdown=true");
		_properties.setProperty("username", "sa");
	}

	@After
	public void tearDown() throws IOException {
		String jarName = PropsUtil.get(
			PropsKeys.SETUP_LIFERAY_POOL_PROVIDER_JAR_NAME,
			new Filter("hikaricp"));

		Files.deleteIfExists(
			Paths.get(PropsValues.LIFERAY_LIB_PORTAL_DIR, jarName));
	}

	@JVMArgsLine(
		"-Dcatalina.base=. -D" + _HIKARICP_JAR_URL + "=${" + _HIKARICP_JAR_URL +
			"}"
	)
	@NewEnv(type = NewEnv.Type.JVM)
	@Test
	public void testHikariCP() throws Exception {
		RegistryUtil.setRegistry(new BasicRegistryImpl());

		System.setProperty(
			"portal:jdbc.default.liferay.pool.provider", "hikaricp");

		String hikaricpJarURL = System.getProperty(_HIKARICP_JAR_URL);

		if (hikaricpJarURL != null) {
			System.setProperty(
				"portal:" + PropsKeys.SETUP_LIFERAY_POOL_PROVIDER_JAR_URL +
					"[hikaricp]",
				hikaricpJarURL);
		}

		InitUtil.init();

		DataSource dataSource = null;

		try (CaptureAppender captureAppender =
				Log4JLoggerTestUtil.configureLog4JLogger(
					JarUtil.class.getName(), Level.INFO)) {

			dataSource = DataSourceFactoryUtil.initDataSource(_properties);

			List<LoggingEvent> loggingEvents =
				captureAppender.getLoggingEvents();

			Assert.assertEquals(
				loggingEvents.toString(), 4, loggingEvents.size());

			LoggingEvent loggingEvent = loggingEvents.get(0);

			String message = (String)loggingEvent.getMessage();

			Assert.assertTrue(message.startsWith("Downloading "));

			loggingEvent = loggingEvents.get(1);

			message = (String)loggingEvent.getMessage();

			Assert.assertTrue(message.startsWith("Downloaded "));

			loggingEvent = loggingEvents.get(2);

			message = (String)loggingEvent.getMessage();

			Assert.assertTrue(message.startsWith("Installing "));

			loggingEvent = loggingEvents.get(3);

			message = (String)loggingEvent.getMessage();

			Assert.assertTrue(message.startsWith("Installed "));
		}

		Class<?> dataSourceClass = dataSource.getClass();

		Assert.assertEquals(
			"com.zaxxer.hikari.HikariDataSource", dataSourceClass.getName());

		for (int i = 0; i < _CHECKOUT_COUNT; i++) {
			Connection connection = dataSource.getConnection();

			PreparedStatement preparedStatement = connection.prepareStatement(
				"SELECT 1 FROM INFORMATION_SCHEMA.SYSTEM_USERS");

			preparedStatement.execute();
		}

		MBeanServer mBeanServer = ManagementFactory.getPlatformMBeanServer();

		ObjectName poolName = new ObjectName(
			"com.zaxxer.hikari:type=Pool (TestJDBCPool)");

		int activeConnections = (int)mBeanServer.getAttribute(
			poolName, "ActiveConnections");

		Assert.assertEquals(_CHECKOUT_COUNT, activeConnections);

		int idleConnections = (int)mBeanServer.getAttribute(
			poolName, "IdleConnections");

		int totalConnections = (int)mBeanServer.getAttribute(
			poolName, "TotalConnections");

		Assert.assertEquals(
			totalConnections, activeConnections + idleConnections);
	}

	@Rule
	public final NewEnvTestRule newEnvTestRule = NewEnvTestRule.INSTANCE;

	private static final int _CHECKOUT_COUNT = 5;

	private static final String _HIKARICP_JAR_URL = "HIKARICP_JAR_URL";

	private final Properties _properties = new Properties();

}