com.github.springtestdbunit.annotation.ExpectedDatabase Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of spring-test-dbunit-core Show documentation
Core module for the integration between the Spring testing framework and DBUnit
There is a newer version: 6.0.0
Show newest version
/*
 * Copyright 2002-2019 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.springtestdbunit.annotation;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Inherited;
import java.lang.annotation.Repeatable;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import org.dbunit.dataset.IDataSet;
import org.dbunit.dataset.filter.IColumnFilter;

import com.github.springtestdbunit.DbUnitTestExecutionListener;
import com.github.springtestdbunit.assertion.DatabaseAssertionMode;
import com.github.springtestdbunit.dataset.DataSetLoader;
import com.github.springtestdbunit.dataset.DataSetModifier;

/**
 * Test annotation that can be used to assert that a database is in given state after tests have run.
 *
 * @see DbUnitTestExecutionListener
 *
 * @author Phillip Webb
 * @author Mario Zagar
 * @author Paul Podgorsek
 */
@Documented
@Inherited
@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.TYPE, ElementType.METHOD })
@Repeatable(ExpectedDatabases.class)
public @interface ExpectedDatabase {

	/**
	 * The name of the connection that should be used when verifying data. Can refer to a connection specified in
	 * {@link DbUnitConfiguration @DbUnitConfiguration} or left blank to use the default connection.
	 *
	 * @return the connection
	 */
	String connection() default "";

	/**
	 * Returns the class that will be used to load {@link IDataSet} resources. The specified class must implement
	 * {@link DataSetLoader} and must have a default constructor. If not provided, the one defined on the
	 * {@link DbUnitConfiguration} will be used instead.
	 *
	 * Leave blank to use the default dataset loader. If both the {@code dataSetLoader} and {@code dataSetLoaderBean}
	 * are defined, the latter will be used.
	 *
	 * @return The data set loader class.
	 */
	Class dataSetLoader() default DataSetLoader.class;

	/**
	 * Returns the name of the bean that will be used to load {@link IDataSet} resources. The specified bean must
	 * implement {@link DataSetLoader}. If not provided, the one defined on the {@link DbUnitConfiguration} will be used
	 * instead.
	 *
	 * Leave blank to use the default dataset loader. If both the {@code dataSetLoader} and {@code dataSetLoaderBean}
	 * are defined, the latter will be used.
	 *
	 * @return The data set loader bean name.
	 */
	String dataSetLoaderBean() default "";

	/**
	 * Provides the location of the dataset that will be used to test the database.
	 *
	 * @return The dataset locations
	 * @see DbUnitConfiguration#dataSetLoader()
	 */
	String value() default "";

	/**
	 * Database assertion mode to use. Default is {@link DatabaseAssertionMode#DEFAULT}.
	 *
	 * @return Database assertion mode to use
	 */
	DatabaseAssertionMode assertionMode() default DatabaseAssertionMode.DEFAULT;

	/**
	 * Optional table name that can be used to limit the comparison to a specific table.
	 *
	 * @return the table name
	 */
	String table() default "";

	/**
	 * Optional SQL to retrieve the actual subset of the table rows from the database. NOTE: a {@link #table() table
	 * name} must also be specified when using a query.
	 *
	 * @return the SQL Query
	 */
	String query() default "";

	/**
	 * If this expectation overrides any others that have been defined at a higher level. Defaults to {@code true}
	 *
	 * @return if this annotation overrides any others
	 */
	boolean override() default true;

	/**
	 * A set of {@link DataSetModifier} that will be applied to the {@link IDataSet} before it is used. Can refer to a
	 * static or inner class of the test.
	 *
	 * @return the modifiers to apply
	 */
	Class[] modifiers() default {};

	/**
	 * A set of {@link org.dbunit.dataset.filter.IColumnFilter} that will be applied to column comparison when using
	 * non-strict {@link DatabaseAssertionMode}.
	 * 
	 * Specify this when you want to use DTD with your expected dataset XML file but want to exclude some columns from
	 * comparison.
	 *
	 * @return column filters to apply
	 */
	Class[] columnFilters() default {};

}