com.github.deltaspikedbunit.dataset.ReplacementDataSetLoader Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of deltaspike-dbunit Show documentation

Integration between Deltaspike and DBUnit. It allows, using simple annotations, to setup and teardown database tables as well as checking expected table contents once a test completes.

The newest version!

/*
 * Copyright 2002-2015 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
 *
 *   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.
 */

package com.github.deltaspikedbunit.dataset;

import java.util.Collections;
import java.util.LinkedHashMap;
import java.util.Map;

import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.ReplacementDataSet;


/**
 * A {@link DataSetLoader data set loader} that uses a {@link ReplacementDataSet} to replace specific objects or
 * sub-strings. By default will replace "[null]" with null.
 *
 * @author Luigi Bitonti
 * @author Stijn Van Bael
 * @author Phillip Webb
 */
public class ReplacementDataSetLoader implements DataSetLoader {

	public static final Map DEFAULT_OBJECT_REPLACEMENTS = Collections.singletonMap("[null]", null);

	private final DataSetLoader dataSetLoader;

	private final Map objectReplacements;

	private final Map subStringReplacements;

	/**
	 * Creates a new {@link ReplacementDataSetLoader} using a {@link FlatXmlDataSetLoader} to load the source
	 * data and with {@link #DEFAULT_OBJECT_REPLACEMENTS}.
	 */
	public ReplacementDataSetLoader() {
		this(new FlatXmlDataSetLoader());
	}

	/**
	 * Creates a new {@link ReplacementDataSetLoader} with {@link #DEFAULT_OBJECT_REPLACEMENTS}.
     *
	 * @param dataSetLoader the source data set loader
	 */
	public ReplacementDataSetLoader(DataSetLoader dataSetLoader) {
		this(dataSetLoader, DEFAULT_OBJECT_REPLACEMENTS);
	}

	/**
	 * Creates a new {@link ReplacementDataSetLoader}.
     *
	 * @param dataSetLoader the source data set loader
	 * @param objectReplacements the object replacements or {@code null} if no object replacements are required
	 */
	public ReplacementDataSetLoader(DataSetLoader dataSetLoader, Map objectReplacements) {
		this(dataSetLoader, objectReplacements, null);
	}

	/**
	 * Creates a new {@link ReplacementDataSetLoader}.
     *
	 * @param dataSetLoader the source data set loader
	 * @param objectReplacements the object replacements or {@code null} if no object replacements are required
	 * @param subStringReplacements the sub-string replacements or {@code null} if no sub-string replacements are
	 * required
	 */
	public ReplacementDataSetLoader(DataSetLoader dataSetLoader, Map objectReplacements,
			Map subStringReplacements) {
		if (dataSetLoader == null) {
			throw new IllegalArgumentException("Delegate must not be null");
		}
		this.dataSetLoader = dataSetLoader;
		this.objectReplacements = unmodifiableMap(objectReplacements);
		this.subStringReplacements = unmodifiableMap(subStringReplacements);
	}

	private  Map unmodifiableMap(Map map) {
		Map result = new LinkedHashMap();
		if (map != null) {
			result.putAll(map);
		}
		return Collections.unmodifiableMap(result);
	}

	public IDataSet loadDataSet(Class testClass, String location) throws Exception {
		IDataSet dataSet = this.dataSetLoader.loadDataSet(testClass, location);
		ReplacementDataSet replacementDataSet = new ReplacementDataSet(dataSet, this.objectReplacements,
				this.subStringReplacements);
		return replacementDataSet;
	}

}