Implantando o Flyway em sistemas Java - Parte 1

 

Quando temos uma empresa terceirizada de fábrica de software desenvolvendo, geralmente especificamos no edital de licitação que essa empresa precisa entregar alguns artefatos obrigatórios para poder receber pelos serviços prestados: o código-fonte (óbvio!), diagramas UML (quando necessário), evidências de testes (artefato que cada vez mais me convenço que de nada serve)... e um plano de implantação. Esse plano de implantação precisa trazer os passos necessários para colocar o produto no ambiente de homologação (e, posteriormente, no ambiente de produção). Na maioria das vezes, um ou mais scripts de banco de dados que devem ser executados. Nós, servidores, tínhamos que abrir o plano de implantação, verificar os passos, acessar o versionador, abrir a ferramenta de banco de dados, copiar o(s) script(s), executá-los, tudo manualmente, gerando um trabalhinho chato e propenso a erros.

Além disso, os scripts sempre ficavam meio perdidos: as vezes espalhados por pastas relativas às ordens de serviço, outras vezes em uma pasta específica do código-fonte do projeto. A ordem de execução dos scripts precisava ser mantida de forma artificial (olhando para os passos do plano de implantação), e reconstruir um ambiente a partir desses scripts era uma tarefa muito difícil, quase impossível.

Adicione a essa equação o nosso eterno desejo de versionar os objetos de banco de dados, que nunca foi realizado por não termos encontrado uma ferramenta que facilitasse / garantisse o versionamento. Até que esbarramos no Flyway (chegamos a avaliar também o Liquibase, mas consideramos o Flyway mais simples de se utilizar em projetos já existentes), um produto open source que se integra perfeitamente ao Maven e permite esse controle dos scripts de banco. Com algum estudo e pouco tempo de implementação, passamos a utilizar essa ferramenta que tem nos garantido bons resultados.

No padrão para o Maven, o Flyway é um plugin que é declarado no pom.xml e pode ser configurado a partir de um driver JDBC para acessar o banco de dados e executar os scripts. Na primeira execução, a ferramenta criará uma tabela de controle (você pode escolher o nome da tabela) que guardará a versão em que se encontra o banco. Os scripts devem ficar localizados na pasta src/main/resources/db/migration (também podemos escolher outra pasta) e podemos ter scripts incrementais e também scripts que o Flyway chama de repeatable - caso de views, stored procedures e similares que podem ter várias versões, e um checksum guardado na tabela de controle é comparado ao checksum do script para detectar uma alteração e forçar uma atualização.

O plugin do Flyway para o Maven possui alguns goals que realizam as principais tarefas:

• migrate - é o principal, realiza o trabalho de ler os scripts da pasta, ler o conteúdo da tabela de controle e realizar o batimento, determinando quais scripts devem ser executados no banco de dados.
• clean - cuidado com esse, ele apaga os objetos existentes no schema de banco de dados!
• info - uma forma de consultar as migrações já executadas.
• validate - realiza a validação das migrações já executadas.
• baseline - outro muito importante, permite introduzir a ferramenta em um projeto já existente e com tabelas já criadas no banco de dados.

No próximo post, eu entrarei em mais detalhes sobre como configurar um projeto Maven para passar a utilizar o Flyway!