org.arquillian.ape.rdbms.ShouldMatchDataSet Maven / Gradle / Ivy

Go to download
/*
 * JBoss, Home of Professional Open Source
 * Copyright 2011 Red Hat Inc. and/or its affiliates and other contributors
 * as indicated by the @authors tag. All rights reserved.
 * See the copyright.txt in the distribution for a
 * full listing of individual contributors.
 *
 * 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 org.arquillian.ape.rdbms;

import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;

import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.ElementType.TYPE;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

/**
 * Verifies state of underlying data store using data sets
 * defined by this annotation. Verification is invoked after test's
 * execution (including transaction if enabled).
 * 
 * 

 * If files are not specified explicitly, following strategy is applied:
 * 

 * Assumption that files are stored in datasets folder.
 * 
 * If annotation is defined on method level, file name has following format:
 * expected-[fully qualified class name]#[test method name].[default format].
 * 
 * 
 * If annotation is defined on class level, file name has following format:
 * expected-[fully qualified class name].[default format].
 * 
 * 
 * 


 * If not specified in arquillian.xml, then expected format is XML.
 * 
 * Presence of this annotation in the test class enables Arquillian Persistence Extension.
 *
 * @author Bartosz Majsak
 */
@Target({TYPE, METHOD})
@Retention(RUNTIME)
@Inherited
public @interface ShouldMatchDataSet {
    /**
     * List of data set files used for comparison.
     */
    String[] value() default "";

    /**
     * List of columns to be used for sorting rows to determine order of data sets comparison.
     */
    String[] orderBy() default "";

    /**
     * List of columns to be excluded.
     * Alternatively can be defined for all tests in arquillian.xml.
     */
    String[] excludeColumns() default "";
}