java - 对 Liquibase 脚本执行检查

Question

在 Oracle 上部署 Liquibase 脚本时，我经常遇到问题，因为在部署它们之前我没有一种简单的方法来运行它们。它们在新的 H2 DB 上总是运行良好，但是当我在管道中部署时，我经常遇到基本问题。

我想在部署脚本之前对脚本进行一些质量检查，通常作为构建的一部分。有没有一种简单的方法可以做到这一点？例如，一些基本的事情，比如检查列名和表名对于 Oracle 来说是否太长。因为我不经常这样做，所以我往往会忘记这个限制，当我在 Oracle 上部署时，我会得到一个糟糕的惊喜..

谢谢!

Answer 1

我找到了一种方法来解析我创建的最新 Liquibase 文件，并执行一些基本检查。我想这可以扩展到更高级的检查，但这已经相当不错了。这里有4个测试，使用AssertJ进行断言

import liquibase.change.core.AddColumnChange;
import liquibase.change.core.CreateTableChange;
import liquibase.change.core.RenameColumnChange;
import liquibase.change.core.RenameTableChange;
import liquibase.changelog.ChangeLogParameters;
import liquibase.changelog.ChangeSet;
import liquibase.changelog.DatabaseChangeLog;
import liquibase.exception.ChangeLogParseException;
import liquibase.parser.core.yaml.YamlChangeLogParser;
import liquibase.resource.FileSystemResourceAccessor;
import org.junit.Before;
import org.junit.Test;
import org.springframework.core.io.Resource;
import org.springframework.core.io.support.PathMatchingResourcePatternResolver;
import org.springframework.core.io.support.ResourcePatternResolver;

import java.io.IOException;
import java.util.Arrays;
import java.util.Comparator;
import java.util.List;
import java.util.stream.Stream;

import static java.util.stream.Collectors.toList;
import static org.assertj.core.api.Assertions.assertThat;
import static org.junit.Assert.fail;

public class LiquibaseScriptsTest {

    public static final String LIQUIBASE_FILES_LOCATION = "src/main/resources/db/changelog/changes/*.yml";

    public static final int NB_LAST_FILES_TO_CHECK = 5;

    private static final int ORACLE_TABLE_NAME_MAX_LENGTH = 30;

    private static final int ORACLE_COLUMN_NAME_MAX_LENGTH = 30;

    private List<DatabaseChangeLog> scriptsToCheck;

    private final static Comparator<Resource> resourceComparator = (r1, r2) -> r1.getFilename().compareTo(r2.getFilename());

    private static YamlChangeLogParser parser = new YamlChangeLogParser();

    @Before
    public void setUp() throws IOException {

        ResourcePatternResolver resourceFinder = new PathMatchingResourcePatternResolver(this.getClass().getClassLoader());
        Resource[] resources = resourceFinder.getResources("file:" + LIQUIBASE_FILES_LOCATION);

        scriptsToCheck = Arrays.asList(resources).stream()
                //looking only at the latest files, assuming their name is indexed
                .sorted(resourceComparator.reversed())
                .limit(NB_LAST_FILES_TO_CHECK)
                .map(r -> toLiquibaseScript(r))
                .collect(toList());
    }

    @Test
    public void someScriptsAreChecked() {
        assertThat(scriptsToCheck).as("There's no script to check - are you sure you configured the path correctly ? ").isNotEmpty();
        assertThat(scriptsToCheck.size()).isLessThanOrEqualTo(NB_LAST_FILES_TO_CHECK);
    }

    @Test
    public void tableNamesShouldBeLessThanOracleMaxSize_whenCreated() {

        Stream<CreateTableChange> createTableChanges = getChangesAsStreamOf(CreateTableChange.class);

        createTableChanges.forEach(tableCreationChange -> {

            assertThat(tableCreationChange.getTableName().length())
                    .as("change " + tableCreationChange.getChangeSet().getId() + " - table name is too long - " +
                            tableCreationChange.getTableName() + " is " + tableCreationChange.getTableName().length() +
                            "char long while maximum for Oracle is " + ORACLE_TABLE_NAME_MAX_LENGTH)
                    .isLessThanOrEqualTo(ORACLE_TABLE_NAME_MAX_LENGTH);
        });
    }

    @Test
    public void tableNamesShouldBeLessThanOracleMaxSize_whenModified() {

        Stream<RenameTableChange> renameTableChanges = getChangesAsStreamOf(RenameTableChange.class);

        renameTableChanges.forEach(tableRenameChange -> {

            assertThat(tableRenameChange.getNewTableName().length())
                    .as("change " + tableRenameChange.getChangeSet().getId() + " - table name is too long - " +
                            tableRenameChange.getNewTableName() + " is " + tableRenameChange.getNewTableName().length() +
                            "char long while maximum for Oracle is " + ORACLE_TABLE_NAME_MAX_LENGTH)
                    .isLessThanOrEqualTo(ORACLE_TABLE_NAME_MAX_LENGTH);
        });
    }

    @Test
    public void columnNamesShouldBeLessThanOracleMaxSize_whenCreated() {

        Stream<AddColumnChange> addColumnChanges = getChangesAsStreamOf(AddColumnChange.class);

        addColumnChanges.flatMap(columnCreationChanges -> columnCreationChanges.getColumns().stream())
                        .forEach(columnCreationChange -> {

                    assertThat(columnCreationChange.getName().length())
                            .as("column name is too long - " + columnCreationChange.getName() + " is " + columnCreationChange.getName().length() +
                                    "char long while maximum for Oracle is " + ORACLE_COLUMN_NAME_MAX_LENGTH)
                            .isLessThanOrEqualTo(ORACLE_COLUMN_NAME_MAX_LENGTH);

                });
    }

    @Test
    public void columnNamesShouldBeLessThanOracleMaxSize_whenModified() {

        Stream<RenameColumnChange> renameColumnChanges = getChangesAsStreamOf(RenameColumnChange.class);

        renameColumnChanges.forEach(columnRenameChange -> {

                    assertThat(columnRenameChange.getNewColumnName().length())
                            .as("column name is too long - " + columnRenameChange.getNewColumnName() + " is " +
                                    columnRenameChange.getNewColumnName().length() + "char long while maximum for Oracle is " +
                                    ORACLE_COLUMN_NAME_MAX_LENGTH)
                            .isLessThanOrEqualTo(ORACLE_COLUMN_NAME_MAX_LENGTH);

                });
    }

    private <E> Stream<E> getChangesAsStreamOf(Class E) {
        Stream<Stream<ChangeSet>> changeSets = scriptsToCheck.stream().map(script -> script.getChangeSets().stream());

        Stream<ChangeSet> changeSetStream = changeSets.flatMap(changeSet -> changeSet);

        return changeSetStream.flatMap(changeSet -> changeSet.getChanges().stream())
                .filter(E::isInstance)
                .map(change -> (E) change);
    }

    private DatabaseChangeLog toLiquibaseScript(Resource r) {
        try {

            System.out.println("going to apply checks on "+r.getFilename());

            return parser.parse(r.getFile().getCanonicalPath(), new ChangeLogParameters(), new FileSystemResourceAccessor());
        } catch (ChangeLogParseException | IOException e) {
            fail("couldn't parse Liquibase script - " + r.getFilename() + " - " + e.getMessage());
        }
        return null;
    }
}