org.dalesbred.junit.TransactionalTests Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of dalesbred-junit Show documentation
Dalesbred JUnit-support
There is a newer version: 1.3.6
/*
 * Copyright (c) 2017 Evident Solutions Oy
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

package org.dalesbred.junit;

import org.dalesbred.Database;
import org.jetbrains.annotations.NotNull;
import org.junit.rules.TestRule;
import org.junit.runner.Description;
import org.junit.runners.model.Statement;

import javax.inject.Provider;

import static java.util.Objects.requireNonNull;
import static org.dalesbred.junit.TransactionalTests.RollbackPolicy.*;

/**
 * A JUnit {@link TestRule} that can be used to run the test-methods in transactions.
 * 
 * To use the rule, create a database and add the following lines to your test:
 * 
 * {@literal @Rule}
 * public final TransactionalTests transactionalTests = new TransactionalTests(db);
 * 
 */
public final class TransactionalTests implements TestRule {

    private final @NotNull Provider db;

    private final @NotNull RollbackPolicy rollbackPolicy;

    /**
     * Specified the rollback-policy for tests.
     */
    public enum RollbackPolicy {
        ROLLBACK_ON_FAILURE, ROLLBACK_NEVER, ROLLBACK_ALWAYS
    }

    /**
     * Constructs a rule that will wrap tests in transactions and use the default
     * rollback-policy ({@link RollbackPolicy#ROLLBACK_ON_FAILURE}) for rolling back
     * the transaction.
     */
    public TransactionalTests(@NotNull Database db) {
        this(db, ROLLBACK_ON_FAILURE);
    }

    /**
     * Constructs a rule that will wrap tests in transactions and use the specified
     * rollback-policy for rolling back the transaction.
     */
    public TransactionalTests(@NotNull Database db, @NotNull RollbackPolicy rollbackPolicy) {
        this(() -> db, rollbackPolicy);
    }

    /**
     * Constructs a rule that will wrap tests in transactions and use the default
     * rollback-policy ({@link RollbackPolicy#ROLLBACK_ON_FAILURE}) for rolling back
     * the transaction.
     */
    public TransactionalTests(@NotNull Provider db) {
        this(db, ROLLBACK_ON_FAILURE);
    }

    /**
     * Constructs a rule that will wrap tests in transactions and use the specified
     * rollback-policy for rolling back the transaction.
     */
    public TransactionalTests(@NotNull Provider db, @NotNull RollbackPolicy rollbackPolicy) {
        this.db = requireNonNull(db);
        this.rollbackPolicy = requireNonNull(rollbackPolicy);
    }

    @Override
    public @NotNull Statement apply(@NotNull Statement base, @NotNull Description description) {
        return new Statement() {
            @Override
            public void evaluate() throws Throwable {
                Throwable throwable =
                    db.get().withTransaction(tx -> {
                        try {
                            base.evaluate();
                            if (rollbackPolicy == ROLLBACK_ALWAYS)
                                tx.setRollbackOnly();
                            //noinspection ReturnOfNull
                            return null;
                        } catch (Throwable e) {
                            if (rollbackPolicy != ROLLBACK_NEVER)
                                tx.setRollbackOnly();
                            return e;
                        }
                    });
                if (throwable != null)
                    throw throwable;
            }
        };
    }
}