main
Gerada por tools/gerar_documentacao.py. Definição: tools/cobertura.py:153.
Regenera tests/COBERTURA.md de forma determinística a partir dos nomes e casos.
Tipo: função Python · Visibilidade: pública · Arquivo: tools/cobertura.py.
Assinatura e expansão
def main() -> None:
Como funciona
Regenera tests/COBERTURA.md de forma determinística a partir dos nomes e casos.
Implementação completa · 142 linhas
def main() -> None:
"""Regenera tests/COBERTURA.md de forma determinística a partir dos nomes e casos."""
# A saída é DETERMINÍSTICA: nada de data no arquivo. O CI compara
# `make cobertura` com o arquivo versionado (`git diff --exit-code`), e uma
# data embutida fazia essa checagem falhar todo dia seguinte ao commit.
# Para um relatório datado, use --data (a data vai só no texto do rodapé).
datado = "--data" in sys.argv[1:] or "--data-com-hoje" in sys.argv[1:]
nomes = nomes_curtos()
suites = casos_por_suite()
total_casos = sum(n for _, n, _ in suites)
hoje = date.today().isoformat() if datado else None
saida: list[str] = []
w = saida.append
w("# Cobertura de testes — BASICGOL")
w("")
w("> Documento **gerado** por `python3 tools/cobertura.py` (ou `make cobertura`).")
if hoje is not None:
w(f"> Gerado em {hoje} (`python3 tools/cobertura.py --data`). Não edite à mão: as"
" seções 1–3 saem da árvore de testes.")
else:
w("> Não edite à mão: as seções 1–3 saem da árvore de testes. A saída é"
" determinística (sem data) para o CI poder compará-la com a versão"
" versionada; use `--data` para um relatório datado.")
w("")
w("## 0. Como rodar")
w("")
w("```sh")
w("make # compila o transpilador e build/libbasicgol.a")
w("make test # suíte completa (M0 + M1 + biblioteca)")
w("make test-biblioteca # somente os módulos da biblioteca padrão")
w("make test-v # idem, listando cada verificação aprovada")
w("./tests/run.sh 03 # uma suíte só (prefixo do nome)")
w("```")
w("")
w("Cada caso de execução roda **duas vezes** — caminho M0 (macros do cabeçalho) e")
w("caminho M1 (transpilador) — e só passa se os dois produzirem exatamente a saída")
w(f"esperada. Hoje são **{total_casos} casos em disco**; o total de verificações")
n_neg = len([d for d in (CASOS / "06_negativos").iterdir() if d.is_dir()])
n_m1 = len([d for d in (CASOS / "12_negativos_m1").iterdir() if d.is_dir()])
w("(impresso no fim de `make test`) inclui também as checagens de sanidade, de linha de")
w(f"comando, os 7 avisos, os {n_neg + n_m1} casos negativos e as 4 provas de estresse.")
w("")
w("Legenda das suítes nas seções seguintes: os diretórios `tests/casos/*` são executados")
w("pelo `run.sh`; as suítes `01_sanidade`, `09_m1`, `10_exemplos` e `11_estresse` são")
w("blocos de shell dentro do próprio `run.sh` (não aparecem como diretório).")
w("")
w("## 1. Superfície da linguagem (nomes curtos do cabeçalho)")
w("")
w(f"Todos os **{len(nomes)}** nomes curtos aparecem em pelo menos um arquivo de teste.")
w("")
w("| nome | onde é exercitado |")
w("|---|---|")
for nome in nomes:
onde = arquivos_com(nome)
# casos de teste primeiro, depois scripts/tabelas; dentro de cada grupo, o
# caminho mais curto primeiro (lê-se melhor)
onde.sort(key=lambda a: (0 if a.startswith("tests/casos/") else 1, len(a)))
celula = ", ".join(f"`{a}`" for a in onde[:4])
if len(onde) > 4:
celula += f" (+{len(onde) - 4})"
w(f"| `{nome}` | {celula or '—'} |")
w("")
w("## 2. Diagnósticos")
w("")
w("### 2.1 Avisos do transpilador (implementados e testados)")
w("")
w("| código | caso |")
w("|---|---|")
avisos = sorted((CASOS / "13_avisos").iterdir())
for d in avisos:
if d.is_dir():
codigo = d.name.split("_")[0].upper()
w(f"| {codigo[:1]}-{codigo[1:]} | `tests/casos/13_avisos/{d.name}` |")
w("")
w("### 2.2 Erros")
w("")
n_neg = len([d for d in (CASOS / "06_negativos").iterdir() if d.is_dir()])
n_m1 = len([d for d in (CASOS / "12_negativos_m1").iterdir() if d.is_dir()])
w(f"* **{n_neg} casos** de erro do compilador C (`tests/casos/06_negativos/`), cada um")
w(" afirmando um trecho exato da mensagem (o catálogo humano está em")
w(" [01 §12.3](../docs/01-especificacao.md)).")
w(f"* **{n_m1} casos** de erro do transpilador (`tests/casos/12_negativos_m1/`), que")
w(" acusa antes do C e com a linha do fonte.")
w("")
w("## 3. Suítes e casos em disco")
w("")
w("| suíte | casos | o que cobre |")
w("|---|---|---|")
for suite, n, desc in suites:
w(f"| `{suite}` | {n} | {desc} |")
w("")
w("## 4. Biblioteca padrão (Fase 5)")
w("")
w("| módulo | helpers exercitados | cobertura executável |")
w("|---|---|---|")
w("| Console | `bg_erro`, `bg_passo_zero`, `bg_leia_linha`, `bg_leia_texto`, `bg_leia_inteiro[_de]`, `bg_leia_real[_de]`, `bg_escreva_texto`, `bg_escreva_linha` | `tests/test_biblioteca.c` + `tests/run_biblioteca.sh`: EOF, linha vazia/longa, CRLF, NUL, argumentos de fluxo inválidos e casos fatais |")
w("| Matemática | `bg_divide_*`, `bg_resto_*`, `bg_abs_*`, `bg_min_*`, `bg_max_*`, `bg_round_l` e macros `ABS`/`MINIMO`/`MAXIMO`/`POTENCIA`/`RAIZ`/`ARREDONDA`/`PISO`/`TETO` | teste unitário por tipo, sinais, limites e subprocessos para divisor zero/overflow |")
w("| Texto | `bg_tamanho_texto`, `bg_copia_texto`, `bg_junta_texto`, `bg_acrescenta_texto`, `bg_trecho_texto`, `bg_compara_texto`, `bg_texto_vazio`, `bg_formata_texto`, conversões texto/número | capacidades, sobreposição, NULL, texto vazio, truncamento, conversões inválidas e overflow |")
w("| Caractere | `bg_e_digito`, `bg_e_letra`, `bg_caractere_maiusculo`, `bg_caractere_minusculo` | ASCII, pontuação, limites e macros curtas |")
w("| Utilidades | `bg_inicia_sorteio`, `bg_sorteia_ate`, `bg_sorteia` | semente reproduzível, limites aceitos/rejeitados e intervalo de retorno |")
w("")
w("A biblioteca tem **230 verificações unitárias** e 30 verificações de integração/falha fatal; rode `make test-biblioteca`.")
w("")
w("## 5. Critérios de aceitação (Fases 2–5)")
w("")
w("| AC | critério | verificação automatizada |")
w("|---|---|---|")
for ac, criterio, onde in AC:
w(f"| {ac} | {criterio} | {onde} |")
w("")
w("## 6. Restrições técnicas e o teste que as fixa")
w("")
w("| restrição | o que a suíte faz |")
w("|---|---|")
for c, o_que, onde in RESTRICOES:
w(f"| {c} | {o_que} — {onde} |")
w("")
w("## 7. Estresse")
w("")
w("| situação | onde |")
w("|---|---|")
for o_que, onde in ESTRESSE:
w(f"| {o_que} | `{onde}` |")
w("")
w("## 8. O que ainda não é automatizado")
w("")
w("* **AC-17 / AC-18** (leitura por pessoa de fora): não há como um programa julgar")
w(" legibilidade. O que a Fase 2 fez foi a parte verificável — percorrer a tabela de")
w(" mapeamento e executar cada construtor — e essa revisão encontrou **três** erros")
w(" reais de especificação (C-04, `PARA_PASSO` com passo negativo e o `;` de")
w(" `ATE_QUE`), todos corrigidos e fixados por teste.")
w("* **D-09** (`BG_ESTRITO`), **D-12** (funções de vetor) e **D-17** (locale do")
w(" sistema): fora da v1.0 por decisão registrada em")
w(" [04](../docs/04-restricoes-e-decisoes.md).")
w("* Desempenho além do limite de 1 s por compilação (AC-29): medido, não otimizado.")
w("")
destino = RAIZ / "tests" / "COBERTURA.md"
destino.write_text("\n".join(saida), encoding="utf-8")
print(f"escrito {destino.relative_to(RAIZ)} ({len(nomes)} nomes, {total_casos} casos)")
Interface BASICGOL relacionada
Nomes internos referenciados: arquivos_com, casos_por_suite, nomes_curtos.
Como este símbolo aparece nos testes
9 ocorrência(s) em 9 arquivo(s) de teste. Os links apontam para linhas exatas; os trechos mostram o contexto local. Uma menção não prova que todos os ramos foi executado.
tests/auditar_exemplos.py
Contexto: auditar_exemplos.py. Linhas: 151. Tipo de evidência: código; via main.
Linhas 149–151 · abrir contexto
if __name__ == '__main__':
sys.exit(main())
tests/documentacao/check_llms_build.py
Contexto: check_llms_build.py. Linhas: 35. Tipo de evidência: código; via main.
Linhas 33–35 · abrir contexto
if __name__ == '__main__':
main()
tests/documentacao/test_gerador.py
Contexto: test_gerador.py. Linhas: 160. Tipo de evidência: código; via main.
Linhas 158–160 · abrir contexto
if __name__ == "__main__":
unittest.main()
tests/fuzz_basicgolc.py
Contexto: fuzz_basicgolc.py. Linhas: 184. Tipo de evidência: código; via main.
Linhas 182–184 · abrir contexto
if __name__ == "__main__":
sys.exit(main())
tests/portabilidade/cpp_inclusao.cpp
Contexto: cpp_inclusao.cpp. Linhas: 19. Tipo de evidência: código; via main.
Linhas 17–21 · abrir contexto
#include <cstring>
int main()
{
char destino[8] = {0};
tests/run.sh · heredoc na linha 174
Contexto: C incorporado no runner (linha 174). Linhas: 191. Tipo de evidência: código; via main.
Linhas 189–191 · abrir contexto
#error "nome curto NATURAL_CURTO nao deveria existir"
#endif
int main(void) { return 0; }
tests/run.sh · heredoc na linha 202
Contexto: C incorporado no runner (linha 202). Linhas: 209. Tipo de evidência: código; via main.
Linhas 207–209 · abrir contexto
#error "SOMA_SEGURA nao deveria existir sem BG_USAR_EXTENSOES"
#endif
int main(void) { return 0; }
tests/test_biblioteca.c
Contexto: test_biblioteca.c. Linhas: 551. Tipo de evidência: código; via main.
Linhas 549–553 · abrir contexto
}
int main(int argc, char **argv)
{
if (argc == 2 && strcmp(argv[1], "--stdin") == 0) {
tests/test_filesystem.c
Contexto: test_filesystem.c. Linhas: 16. Tipo de evidência: código; via main.
Linhas 14–18 · abrir contexto
}
int main(void) {
// temp file
char tmp[256];
Evidência indireta
Estes símbolos chamam/encaminham para este nome. As referências deles ajudam a rastrear o caminho, mas não substituem um teste específico deste símbolo.
BG_INICIO→ tests/casos/06_negativos/n09_dois_inicio/programa.c, tests/run.sh, tests/run_portabilidade.sh
Compiladores, padrão C e sistema operacional
Nenhum ramo condicional externo foi detectado para este símbolo. A implementação é compartilhada no fonte; isso não certifica compiladores ou sistemas não executados.
- Script Python: usa a biblioteca padrão e pathlib/subprocess quando aplicável; caminhos não devem depender do separador de um único OS.
A matriz histórica distingue executado, compilado, avaliado e não testado. Consulte a matriz, os compiladores e os logs atuais dos workflows antes de chamar um alvo de suportado.
Perguntas frequentes
Perguntas reunidas a partir da definição, do contrato editorial e dos testes de main. As respostas repetem apenas o que o repositório mostra; quando não há evidência, isso é dito.
Em uma frase, o que main faz?
Regenera tests/COBERTURA.md de forma determinística a partir dos nomes e casos.
Qual é a assinatura e o tipo de retorno de main?
Assinatura extraída de tools/cobertura.py; visibilidade pública.
def main() -> None:
Como main aparece em código real deste repositório?
Uso extraído de tests/auditar_exemplos.py:149, com as linhas vizinhas preservadas:
if __name__ == '__main__':
sys.exit(main())
Onde main é exercitado nos testes?
Há 9 ocorrência(s) em 9 arquivo(s): tests/auditar_exemplos.py, tests/documentacao/check_llms_build.py, tests/documentacao/test_gerador.py, tests/fuzz_basicgolc.py, tests/portabilidade/cpp_inclusao.cpp …. Os links da seção de evidência apontam para a linha exata; uma menção não prova que todos os ramos foram executados.
main depende de compilador, padrão C ou sistema operacional?
main é uma função Python: requer Python 3.10+ e biblioteca padrão, sem compilador C.
O que acontece em caso de falha ou uso inválido?
Não há ressalva editorial específica para este nome. O comportamento em falha é o do corpo/expansão mostrado acima; não invente validação que o fonte não faz.