Guia de Desenvolvimento do Servidor

Este guia aborda a depuração, a execução do conjunto de testes do servidor e a contribuição para o VillageSQL. Ele pressupõe uma compilação de código-fonte funcional; consulte Compilar a Partir do Código-Fonte se você ainda não fez isso.

Depuração

A depuração do servidor VillageSQL usa GDB no Linux e lldb no macOS. O GDB no macOS requer assinatura de código, o que é trabalhoso de configurar; o lldb é o depurador padrão do macOS e funciona imediatamente.

Linux (GDB)

Execute o VillageSQL sob o GDB:

gdb --args $HOME/build/villagesql/bin/mysqld --gdb --datadir=$HOME/mysql-data/data --basedir=$HOME/build/villagesql

Dentro do GDB:

(gdb) run                    # Start the server
(gdb) break function_name    # Set breakpoints
(gdb) continue               # Resume execution
(gdb) bt                     # Show backtrace on crash

Comandos GDB comuns:

# Break on specific SQL command execution
(gdb) break mysql_execute_command

# Break on extension loading
(gdb) break Sql_cmd_install_extension::execute

# Print variable values
(gdb) print variable_name

# Step through code
(gdb) step      # Step into functions
(gdb) next      # Step over functions

macOS (lldb)

Execute o VillageSQL sob o lldb:

lldb -- $HOME/build/villagesql/bin/mysqld --datadir=$HOME/mysql-data/data --basedir=$HOME/build/villagesql

Dentro do lldb:

(lldb) run                         # Start the server
(lldb) breakpoint set -n function_name  # Set breakpoints
(lldb) continue                    # Resume execution
(lldb) bt                          # Show backtrace on crash

Comandos lldb comuns:

# Break on specific SQL command execution
(lldb) breakpoint set -n mysql_execute_command

# Break on extension loading
(lldb) breakpoint set -n Sql_cmd_install_extension::execute

# Print variable values
(lldb) print variable_name

# Step through code
(lldb) step      # Step into functions
(lldb) next      # Step over functions

Executando Testes

O VillageSQL inclui tanto testes de unidade quanto testes de regressão para verificar a funcionalidade.

Testes de Unidade

Execute os testes de unidade específicos do VillageSQL (de dentro do seu diretório de compilação):

make -j10 villagesql-unit-tests && ctest -L villagesql

Ou execute todos os testes de unidade:

ctest --output-on-failure

Testes de Regressão

Vá para o diretório mysql-test:

cd mysql-test

Execute o conjunto de testes completo do MySQL (lento):

./mysql-test-run.pl --parallel=auto

Execute apenas os testes específicos do VillageSQL:

./mysql-test-run.pl --suite=villagesql

Execute os testes do VillageSQL incluindo todos os subconjuntos:

./mysql-test-run.pl --do-suite=villagesql --parallel=auto

—suite vs —do-suite:

--suite=villagesql executa apenas os testes villagesql de nível superior
--do-suite=villagesql executa todos os testes, incluindo os subconjuntos (insert, select, stored_procedure, etc.)

Executando Testes Individuais

Execute um teste específico pelo nome:

./mysql-test-run.pl villagesql.complex_index

Execute um teste de um subconjunto:

./mysql-test-run.pl --suite=villagesql/insert

Atualizando Resultados de Testes

Se você alterou a funcionalidade e precisa atualizar a saída esperada dos testes:

./mysql-test-run.pl --record villagesql.complex_index

Gravação de Testes: Sempre revise as alterações nos arquivos .result para garantir que elas reflitam o comportamento pretendido, e não bugs. A flag --record sobrescreve cegamente a saída esperada.

Portabilidade de Testes

Quando a saída de um teste inclui caminhos do diretório temporário do executor de testes, adicione esta diretiva dentro do seu arquivo .test para que os resultados gravados não contenham caminhos absolutos que quebram em outras máquinas:

--replace_result $MYSQLTEST_VARDIR MYSQLTEST_VARDIR

Depurando Falhas de Testes

As mensagens de log específicas do VillageSQL (emitidas via LogVSQL()) são suprimidas por padrão. Para exibi-las no log de erros durante uma execução de teste:

./mysql-test-run.pl --mysqld=--log-error-verbosity=3 villagesql.complex_index

O log de erros completo fica em mysql-test/var/log/mysqld.1.err. Para escrever testes de regressão de extensões, consulte o Desenvolvimento em C++.

Instalando Binários

Para instalar o VillageSQL em todo o sistema (requer as permissões apropriadas):

cmake --build build --target install

Isso instala os binários em /usr/local/mysql/ por padrão. Você pode personalizar o prefixo de instalação:

cmake -S . -B build -DCMAKE_INSTALL_PREFIX=/opt/villagesql
cmake --build build --target install

Contribuindo

Se você está contribuindo para o VillageSQL, consulte as diretrizes de contribuição para conhecer os padrões de codificação e os fluxos de trabalho de desenvolvimento.

Getting Started

Server Development

Extensions

Using Extensions

Creating Extensions

Depuração

Linux (GDB)

macOS (lldb)

Executando Testes

Testes de Unidade

Testes de Regressão

Executando Testes Individuais

Atualizando Resultados de Testes

Portabilidade de Testes

Depurando Falhas de Testes

Instalando Binários

Contribuindo

​Depuração

​Linux (GDB)

​macOS (lldb)

​Executando Testes

​Testes de Unidade

​Testes de Regressão

​Executando Testes Individuais

​Atualizando Resultados de Testes

​Portabilidade de Testes

​Depurando Falhas de Testes

​Instalando Binários

​Contribuindo

Depuração

Linux (GDB)

macOS (lldb)

Executando Testes

Testes de Unidade

Testes de Regressão

Executando Testes Individuais

Atualizando Resultados de Testes

Portabilidade de Testes

Depurando Falhas de Testes

Instalando Binários

Contribuindo