org.springframework.batch.test.DataSourceInitializer Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of spring-batch-test Show documentation
Domain for batch job testing
There is a newer version: 5.2.1
/*
 * Copyright 2006-2022 the original author or authors.
 *
 * 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
 *
 *      https://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 org.springframework.batch.test;

import java.io.IOException;
import java.net.URI;
import java.nio.charset.StandardCharsets;
import java.nio.file.FileSystemNotFoundException;
import java.nio.file.FileSystems;
import java.nio.file.Files;
import java.nio.file.Paths;
import java.util.Collections;
import java.util.List;

import javax.sql.DataSource;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.springframework.beans.factory.BeanInitializationException;
import org.springframework.beans.factory.DisposableBean;
import org.springframework.beans.factory.InitializingBean;
import org.springframework.context.support.ClassPathXmlApplicationContext;
import org.springframework.core.io.Resource;
import org.springframework.dao.DataAccessException;
import org.springframework.jdbc.core.JdbcTemplate;
import org.springframework.jdbc.support.JdbcTransactionManager;
import org.springframework.transaction.support.TransactionCallback;
import org.springframework.transaction.support.TransactionTemplate;
import org.springframework.util.Assert;
import org.springframework.util.ClassUtils;
import org.springframework.util.StringUtils;

/**
 * Wrapper for a {@link DataSource} that can run scripts on start up and shut down. Use as
 * a bean definition 

 *
 * Run this class to initialize a database in a running server process. Make sure the
 * server is running first by launching the "hsql-server" from the
 * hsql.server project. Then you can right click in Eclipse and Run As ->
 * Java Application. Do the same any time you want to wipe the database and start again.
 *
 * @author Dave Syer
 * @author Drummond Dawson
 * @author Mahmoud Ben Hassine
 * @deprecated since 5.0 in favor of similar utilities provided by Spring Framework.
 * Scheduled for removal in 5.2.
 *
 */
@Deprecated(since = "5.0", forRemoval = true)
public class DataSourceInitializer implements InitializingBean, DisposableBean {

	private static final Log logger = LogFactory.getLog(DataSourceInitializer.class);

	private Resource[] initScripts;

	private Resource[] destroyScripts;

	private DataSource dataSource;

	private boolean ignoreFailedDrop = true;

	private boolean initialized = false;

	/**
	 * Main method as convenient entry point.
	 * @param args arguments to be passed to main.
	 */
	@SuppressWarnings("resource")
	public static void main(String... args) {
		new ClassPathXmlApplicationContext(ClassUtils.addResourcePathToPackagePath(DataSourceInitializer.class,
				DataSourceInitializer.class.getSimpleName() + "-context.xml"));
	}

	@Override
	public void destroy() {
		if (this.destroyScripts == null) {
			return;
		}
		for (Resource destroyScript : this.destroyScripts) {
			try {
				doExecuteScript(destroyScript);
			}
			catch (Exception e) {
				if (logger.isDebugEnabled()) {
					logger.warn("Could not execute destroy script [" + destroyScript + "]", e);
				}
				else {
					logger.warn("Could not execute destroy script [" + destroyScript + "]");
				}
			}
		}
	}

	@Override
	public void afterPropertiesSet() {
		Assert.state(this.dataSource != null, "A DataSource is required");
		initialize();
	}

	private void initialize() {
		if (!this.initialized) {
			destroy();
			if (this.initScripts != null) {
				for (Resource initScript : this.initScripts) {
					doExecuteScript(initScript);
				}
			}
			this.initialized = true;
		}
	}

	private void doExecuteScript(final Resource scriptResource) {
		if (scriptResource == null || !scriptResource.exists()) {
			return;
		}
		TransactionTemplate transactionTemplate = new TransactionTemplate(new JdbcTransactionManager(this.dataSource));
		transactionTemplate.execute((TransactionCallback) status -> {
			JdbcTemplate jdbcTemplate = new JdbcTemplate(this.dataSource);
			String[] scripts;
			try {
				scripts = StringUtils.delimitedListToStringArray(stripComments(getScriptLines(scriptResource)), ";");
			}
			catch (IOException e) {
				throw new BeanInitializationException("Cannot load script from [" + scriptResource + "]", e);
			}
			for (String script : scripts) {
				String trimmedScript = script.trim();
				if (StringUtils.hasText(trimmedScript)) {
					try {
						jdbcTemplate.execute(trimmedScript);
					}
					catch (DataAccessException e) {
						if (this.ignoreFailedDrop && trimmedScript.toLowerCase().startsWith("drop")
								&& logger.isDebugEnabled()) {
							logger.debug("DROP script failed (ignoring): " + trimmedScript);
						}
						else {
							throw e;
						}
					}
				}
			}
			return null;
		});

	}

	private List getScriptLines(Resource scriptResource) throws IOException {
		URI uri = scriptResource.getURI();
		initFileSystem(uri);
		return Files.readAllLines(Paths.get(uri), StandardCharsets.UTF_8);
	}

	private void initFileSystem(URI uri) throws IOException {
		try {
			FileSystems.getFileSystem(uri);
		}
		catch (FileSystemNotFoundException e) {
			FileSystems.newFileSystem(uri, Collections.emptyMap());
		}
		catch (IllegalArgumentException e) {
			FileSystems.getDefault();
		}
	}

	private String stripComments(List list) {
		StringBuilder buffer = new StringBuilder();
		for (String line : list) {
			if (!line.startsWith("//") && !line.startsWith("--")) {
				buffer.append(line).append("\n");
			}
		}
		return buffer.toString();
	}

	public void setInitScripts(Resource[] initScripts) {
		this.initScripts = initScripts;
	}

	public void setDestroyScripts(Resource[] destroyScripts) {
		this.destroyScripts = destroyScripts;
	}

	public void setDataSource(DataSource dataSource) {
		this.dataSource = dataSource;
	}

	public void setIgnoreFailedDrop(boolean ignoreFailedDrop) {
		this.ignoreFailedDrop = ignoreFailedDrop;
	}

}