Skip to main content

Códigos de saída

Quem pode usar esse recurso?

O CodeQL está disponível para os seguintes tipos de repositórios:

  • Repositórios pertencentes à organização com o Code Security habilitado

A CodeQL CLI relata o status de cada comando executado como um código de saída. Esse código de saída fornece informações para os próximos comandos ou para outras ferramentas que dependem da CodeQL CLI.

Êxito, término normal.

O comando determinou com sucesso que a resposta à pergunta é "Não".

Esse código de saída só é usado por alguns comandos, como test run, dataset check, query format e resolve extractor. Para obter mais detalhes, confira a documentação desses comandos.

Algo deu errado.

A CLI grava uma mensagem de erro legível por pessoas no stderr. Isso inclui casos em que um extrator falha com um erro interno, porque o driver do codeql não consegue distinguir entre erros internos e voltados ao usuário no comportamento do extrator.

O inicializador não conseguiu localizar o diretório de instalação do CodeQL.

Nesse caso, o inicializador não pode iniciar o código Java para a CodeQL CLI. Isso só deve acontecer quando algo estiver muito errado com a instalação do CodeQL.

O extrator não encontrou nenhum código a ser analisado ao executar database create ou database finalize.

Uma ou mais avaliações de consulta atingiu o tempo limite.

É possível que algumas consultas que foram avaliadas em paralelo não tenham atingido o tempo limite. Os resultados dessas consultas são produzidos como de costume.

A avaliação foi cancelada explicitamente.

A CodeQL CLI ficou sem memória.

Isso não significa necessariamente que toda a RAM física do computador tenha sido usada. Se você não usar a opção --ram para definir um limite explicitamente, a JVM escolherá um limite padrão na inicialização.

Ocorreu um erro fatal interno.

Isso deve ser considerado um bug. A CLI geralmente grava uma descrição de erro abreviada no stderr. Se você puder reproduzir o bug, será útil usar --logdir e enviar os arquivos de log para em um relatório de bugs.

No caso de problemas realmente graves na JVM que executa o codeql, pode ser retornado um código de saída diferente de zero escolhido. Isso só deve acontecer se houver algo muito errado com a instalação do CodeQL ou se houver algum problema de memória com o sistema host que executa o processo do CodeQL. Por exemplo, os sistemas Unix podem retornar o Código de Saída 137 para indicar que o kernel encerrou um processo que o CodeQL iniciou. Uma forma de solucionar isso é modificar o sinalizador –ram= da etapa codeql database analyze e executar novamente o fluxo de trabalho.