org.testng.spring.test.AbstractTransactionalDataSourceSpringContextTests.java Source code

Introduction

Here is the source code for org.testng.spring.test.AbstractTransactionalDataSourceSpringContextTests.java

Source

/*
 * Copyright 2002-2007 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 org.testng.spring.test;

import java.io.IOException;
import java.io.InputStreamReader;
import java.io.LineNumberReader;
import java.util.Iterator;
import java.util.LinkedList;
import java.util.List;

import javax.sql.DataSource;

import org.springframework.core.io.Resource;
import org.springframework.dao.DataAccessException;
import org.springframework.dao.DataAccessResourceFailureException;
import org.springframework.jdbc.core.JdbcTemplate;
import org.springframework.util.StringUtils;

/**
 * Subclass of AbstractTransactionalSpringContextTests that adds some convenience
 * functionality for JDBC access. Expects a {@link javax.sql.DataSource} bean
 * to be defined in the Spring application context.
 *
 * <p>This class exposes a {@link org.springframework.jdbc.core.JdbcTemplate}
 * and provides an easy way to delete from the database in a new transaction.
 *
 * @author Rod Johnson
 * @author Juergen Hoeller
 * @since 1.1.1
 * @see #setDataSource(javax.sql.DataSource)
 * @see #getJdbcTemplate()
 */
public abstract class AbstractTransactionalDataSourceSpringContextTests
        extends AbstractTransactionalSpringContextTests {

    protected JdbcTemplate jdbcTemplate;

    /**
     * Did this test delete any tables? If so, we forbid transaction completion,
     * and only allow rollback.
     */
    private boolean zappedTables;

    /**
     * Default constructor for AbstractTransactionalDataSourceSpringContextTests.
     */
    public AbstractTransactionalDataSourceSpringContextTests() {
    }

    /**
     * Setter: DataSource is provided by Dependency Injection.
     */
    public void setDataSource(DataSource dataSource) {
        this.jdbcTemplate = new JdbcTemplate(dataSource);
    }

    /**
     * Return the JdbcTemplate that this base class manages.
     */
    public final JdbcTemplate getJdbcTemplate() {
        return this.jdbcTemplate;
    }

    /**
     * Convenient method to delete all rows from these tables.
     * Calling this method will make avoidance of rollback by calling
     * <code>setComplete()</code> impossible.
     * @see #setComplete
     */
    protected void deleteFromTables(String[] names) {
        for (int i = 0; i < names.length; i++) {
            int rowCount = this.jdbcTemplate.update("DELETE FROM " + names[i]);
            if (logger.isInfoEnabled()) {
                logger.info("Deleted " + rowCount + " rows from table " + names[i]);
            }
        }
        this.zappedTables = true;
    }

    /**
     * Overridden to prevent the transaction committing if a number of tables have been
     * cleared, as a defensive measure against accidental <i>permanent</i> wiping of a database.
     * @see org.springframework.test.AbstractTransactionalSpringContextTests#setComplete()
     */
    protected final void setComplete() {
        if (this.zappedTables) {
            throw new IllegalStateException("Cannot set complete after deleting tables");
        }
        super.setComplete();
    }

    /**
     * Count the rows in the given table
     * @param tableName table name to count rows in
     * @return the number of rows in the table
     */
    protected int countRowsInTable(String tableName) {
        return this.jdbcTemplate.queryForInt("SELECT COUNT(0) FROM " + tableName);
    }

    /**
     * Execute the given SQL script. Will be rolled back by default,
     * according to the fate of the current transaction.
     * @param sqlResourcePath Spring resource path for the SQL script.
     * Should normally be loaded by classpath. There should be one statement
     * per line. Any semicolons will be removed.
     * <b>Do not use this method to execute DDL if you expect rollback.</b>
     * @param continueOnError whether or not to continue without throwing
     * an exception in the event of an error
     * @throws DataAccessException if there is an error executing a statement
     * and continueOnError was false
     */
    protected void executeSqlScript(String sqlResourcePath, boolean continueOnError) throws DataAccessException {
        if (logger.isInfoEnabled()) {
            logger.info("Executing SQL script '" + sqlResourcePath + "'");
        }

        long startTime = System.currentTimeMillis();
        List statements = new LinkedList();
        Resource res = getApplicationContext().getResource(sqlResourcePath);
        try {
            LineNumberReader lnr = new LineNumberReader(new InputStreamReader(res.getInputStream()));
            String currentStatement = lnr.readLine();
            while (currentStatement != null) {
                currentStatement = StringUtils.replace(currentStatement, ";", "");
                statements.add(currentStatement);
                currentStatement = lnr.readLine();
            }

            for (Iterator itr = statements.iterator(); itr.hasNext();) {
                String statement = (String) itr.next();
                try {
                    int rowsAffected = this.jdbcTemplate.update(statement);
                    if (logger.isDebugEnabled()) {
                        logger.debug(rowsAffected + " rows affected by SQL: " + statement);
                    }
                } catch (DataAccessException ex) {
                    if (continueOnError) {
                        if (logger.isWarnEnabled()) {
                            logger.warn("SQL: " + statement + " failed", ex);
                        }
                    } else {
                        throw ex;
                    }
                }
            }
            long elapsedTime = System.currentTimeMillis() - startTime;
            logger.info("Done executing SQL script '" + sqlResourcePath + "' in " + elapsedTime + " ms");
        } catch (IOException ex) {
            throw new DataAccessResourceFailureException("Failed to open SQL script '" + sqlResourcePath + "'", ex);
        }
    }

}