org.jdbi.v3.testing.Migration 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;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;

/**
 * Represents a Flyway migration Jdbi should run.
 */
public class Migration {

    final List schemas = new ArrayList<>();
    final List paths = new ArrayList<>();
    boolean cleanAfter = true;

    /**
     * Use Default {@code db/migration} Flyway schema migration location.
     * Migration scripts must be on the classpath.
     */
    public Migration withDefaultPath() {
        this.paths.add("db/migration");
        return this;
    }

    /**
     * Add flyway migration path.
     */
    public Migration withPath(final String migrationPath) {
        this.paths.add(migrationPath);
        return this;
    }

    /**
     * Add flyway migration paths.
     */
    public Migration withPaths(final String... migrationPaths) {
        this.paths.addAll(Arrays.asList(migrationPaths));
        return this;
    }

    /**
     * Add flyway migration schema.
     */
    public Migration withSchema(final String schema) {
        this.schemas.add(schema);
        return this;
    }

    /**
     * Add flyway migration schemas.
     */
    public Migration withSchemas(final String... schemas) {
        this.schemas.addAll(Arrays.asList(schemas));
        return this;
    }

    /**
     * Will drop all objects in the configured schemas after tests using Flyway.
     */
    public Migration cleanAfter() {
        this.cleanAfter = true;
        return this;
    }

    /**
     * Create new Migration.
     */
    public static Migration before() {
        return new Migration();
    }

}