org.jdbi.v3.testing.junit5.JdbiPostgresExtension Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jdbi3-testing Show documentation
Utilities for testing Jdbi
There is a newer version: 3.47.0
/*
 * 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.jdbi.v3.testing.junit5;

import javax.sql.DataSource;

import de.softwareforge.testing.postgres.embedded.DatabaseInfo;
import de.softwareforge.testing.postgres.junit5.EmbeddedPgExtension;
import de.softwareforge.testing.postgres.junit5.SingleDatabaseBuilder;
import org.junit.jupiter.api.extension.ExtensionContext;

/**
 * Jdbi PostgreSQL JUnit 5 rule using the pg-embedded component.
 * 
 * Using this class with the {@code @ExtendWith} annotation is equivalent to using the {@link SingleDatabaseBuilder} to create a {@link EmbeddedPgExtension}
 * that creates a new postgres instance per test. This is slower than using the {@link de.softwareforge.testing.postgres.junit5.MultiDatabaseBuilder} and using
 * {@link JdbiExtension#postgres(EmbeddedPgExtension)}.
 * 

 * Override methods for special case construction:
 *
 * 
{@code
 *     @RegisterExtension
 *     public JdbiExtension extension = new JdbiPostgresExtension(pg) {
 *         @Override
 *         protected DataSource createDataSource() {
 *            ...
 *         }
 *     };
 * }
 * 
 * Use with {@link org.junit.jupiter.api.extension.ExtendWith}:
 *
 * 
{@code
 * @ExtendWith(JdbiPostgresExtension.class)
 * public class DatabaseTest {
 *     @Test
 *     public void testWithJdbi(Jdbi jdbi) {
 *         ...
 *     }
 *
 *     @Test
 *     public void testWithHandle(Handle handle) {
 *         ...
 *     }
 * }
 * }
 */
public class JdbiPostgresExtension extends JdbiExtension {

    private final EmbeddedPgExtension pg;
    private final boolean pgIsManaged;

    private volatile DatabaseInfo info;

    static JdbiExtension instance(EmbeddedPgExtension pg) {
        return new JdbiPostgresExtension(pg);
    }

    protected JdbiPostgresExtension(EmbeddedPgExtension pg) {
        this.pg = pg;
        this.pgIsManaged = false;
    }

    public JdbiPostgresExtension() {
        this.pg = SingleDatabaseBuilder.instanceWithDefaults().build();
        this.pgIsManaged = true;
    }

    @Override
    public String getUrl() {
        return info.asJdbcUrl();
    }

    @Override
    protected DataSource createDataSource() throws Exception {
        return info.asDataSource();
    }

    @Override
    public void beforeEach(ExtensionContext context) throws Exception {

        try {
            if (this.pgIsManaged) {
                pg.beforeEach(context);
            }
        } finally {
            super.beforeEach(context);
        }
    }

    @Override
    public void beforeAll(ExtensionContext context) throws Exception {

        try {
            if (this.pgIsManaged) {
                pg.beforeAll(context);
            }
        } finally {
            super.beforeAll(context);
        }
    }

    @Override
    public void afterEach(ExtensionContext context) throws Exception {

        try {
            super.afterEach(context);
        } finally {
            if (this.pgIsManaged) {
                pg.afterEach(context);
            }
        }
    }

    @Override
    public void afterAll(ExtensionContext context) throws Exception {

        try {
            super.afterAll(context);
        } finally {
            if (this.pgIsManaged) {
                pg.afterAll(context);
            }
        }
    }

    @Override
    protected void startExtension() throws Exception {

        if (info != null) {
            throw new IllegalStateException("Extension was already started!");
        }

        info = pg.createDatabaseInfo();

        super.startExtension();
    }

    @Override
    protected void stopExtension() throws Exception {

        if (info == null) {
            throw new IllegalStateException("Extension was already stopped!");
        }

        try {
            super.stopExtension();
        } finally {
            this.info = null;
        }
    }
}