PublishCodeCoverageResults@1 - Publicar resultados de cobertura de código v1 tarefa

Use esta tarefa para publicar os resultados da cobertura de código Cobertura ou JaCoCo de uma compilação.

Sintaxe

# Publish code coverage results v1
# Publish Cobertura or JaCoCo code coverage results from a build.
- task: PublishCodeCoverageResults@1
  inputs:
    codeCoverageTool: 'JaCoCo' # 'Cobertura' | 'JaCoCo'. Required. Code coverage tool. Default: JaCoCo.
    summaryFileLocation: # string. Required. Summary file. 
    #pathToSources: # string. Path to Source files. 
    #reportDirectory: # string. Report directory. 
    #additionalCodeCoverageFiles: # string. Additional files. 
    #failIfCoverageEmpty: false # boolean. Fail when code coverage results are missing. Default: false.

Insumos

codeCoverageTool - Ferramenta de cobertura de código
string. Necessário. Valores permitidos: Cobertura, JaCoCo. Valor padrão: JaCoCo.

Especifica a ferramenta que gera resultados de cobertura de código.

summaryFileLocation - Arquivo de resumo
string. Necessário.

Especifica o caminho do arquivo de resumo que contém estatísticas de cobertura de código, como cobertura de linha, método e classe. Vários arquivos de resumo são mesclados em um único relatório. O valor pode conter padrões de minicorrespondência. Por exemplo: $(System.DefaultWorkingDirectory)/MyApp/**/site/cobertura/coverage.xml.

pathToSources - caminho para arquivos de origem
string.

A especificação de um caminho para os arquivos de origem é necessária quando os relatórios XML de cobertura não contêm um caminho absoluto para os arquivos de origem. Por exemplo, os relatórios JaCoCo não usam caminhos absolutos, portanto, ao publicar a cobertura do JaCoCo para aplicativos Java, o padrão é semelhante ao $(System.DefaultWorkingDirectory)/MyApp/src/main/java/. Essa entrada deve apontar para um caminho absoluto para os arquivos de origem no host. Por exemplo, $(System.DefaultWorkingDirectory)/MyApp/.

Essa entrada pode ser usada se os testes forem executados em um contêiner do Docker.

Várias fontes podem ser adicionadas delimitando cada item da lista com o caractere ;, por exemplo, pathToSources: $(System.DefaultWorkingDirectory)/path/to/first/source;$(System.DefaultWorkingDirectory)/path/to/second/source.

reportDirectory - Diretório de relatórios
string.

Especifica o caminho do diretório de relatório HTML de cobertura de código. O diretório de relatório é publicado para exibição posterior como um artefato da compilação. O valor pode conter padrões de minicorrespondência. Por exemplo: $(System.DefaultWorkingDirectory)/MyApp/**/site/cobertura.

additionalCodeCoverageFiles - Ficheiros adicionais
string.

Especifica o padrão de caminho do arquivo e observa quaisquer arquivos de cobertura de código adicionais a serem publicados como artefatos da compilação. O valor pode conter padrões de minicorrespondência. Por exemplo: $(System.DefaultWorkingDirectory)/**/*.exec.

failIfCoverageEmpty - Falha quando os resultados da cobertura de código estão faltando
boolean. Valor padrão: false.

Falha na tarefa se a cobertura do código não produzir nenhum resultado para publicar.

Opções de controlo de tarefas

Todas as tarefas têm opções de controle, além de suas entradas de tarefas. Para obter mais informações, consulte Opções de controle de e propriedades de tarefas comuns.

Variáveis de saída

Nenhuma.

Comentários

Use esta tarefa em um pipeline de compilação para publicar resultados de cobertura de código produzidos ao executar testes no Azure Pipelines ou TFS para obter relatórios de cobertura. A tarefa suporta formatos populares de resultados de cobertura, como Cobertura e JaCoCo.

Essa tarefa só é suportada em pipelines de compilação, não em pipelines de liberação.

Tarefas como Visual Studio Test, .NET Core, Ant, Maven, Gulpe Grunt também oferecem a opção de publicar dados de cobertura de código no pipeline. Se você estiver usando essas tarefas, não precisará de uma tarefa separada Publicar resultados de cobertura de código no pipeline.

Para gerar o relatório de cobertura de código HTML, você precisa do dotnet framework 2.0.0 ou posterior no agente. A pasta dotnet deve estar no caminho do ambiente. Se houver várias pastas contendo dotnet, aquela com a versão 2.0.0 deve estar antes de quaisquer outras na lista de caminhos.

Resultados de cobertura de código para JavaScript com Istambul usando YAML

Para publicar resultados de cobertura de código para JavaScript com Istambul usando YAML, consulte Personalizar JavaScript na seção Ecossistemas destes tópicos, que também inclui exemplos para outros idiomas.

Veja um exemplo de cobertura de código de publicação usando Cobertura.

Docker

Para aplicativos que usam o Docker, a compilação e os testes podem ser executados dentro do contêiner e gerar resultados de cobertura de código dentro do contêiner. Para publicar os resultados no pipeline, os artefatos resultantes devem ser disponibilizados para a tarefa Publicar resultados de cobertura de código. Para referência, você pode ver um exemplo semelhante para publicar resultados de teste na seção Compilar, testar e publicar resultados com um arquivo do Docker para Docker.

Ver resultados

Para exibir os resultados da cobertura de código no pipeline, consulte Revisar os resultados da cobertura de código.

Os dados de cobertura de código são mesclados quando vários arquivos são fornecidos como entrada para a tarefa ou várias tarefas são usadas no pipeline?

No momento, a funcionalidade de relatório de cobertura de código fornecida por essa tarefa é limitada e não mescla dados de cobertura. Se você fornecer vários arquivos como entrada para a tarefa, somente a primeira correspondência será considerada. Se você usar várias tarefas de cobertura de código de publicação no pipeline, o resumo e o relatório serão mostrados para a última tarefa. Todos os dados carregados anteriormente são ignorados.

Problemas conhecidos

A tarefa de resultados de cobertura de código de publicação gera e publica o relatório HTML, que é um conjunto de arquivos HTML vinculados a partir do arquivo index.html principal. Se a guia de cobertura de código não mostrar o relatório de cobertura de código, verifique se o tamanho do arquivo de index.html está próximo ou maior que 7 MB. Conclua as etapas a seguir para verificar o tamanho do arquivo. Em seguida, se o tamanho do arquivo for próximo ou maior que 7 MB, você poderá usar a seguinte solução alternativa para exibir o relatório de cobertura.

1. Selecione a guia Resumo da compilação e, em seguida, selecione o link publicado:

   

2. Ao lado do artefato de Report_* Cobertura de Código, selecione Baixar artefatos:

   

3. Quando o relatório de cobertura de código for baixado, extraia o arquivo .zip.

4. No relatório de cobertura de código, verifique o tamanho do index.html para ajudar a determinar se o tamanho do arquivo está causando o problema descrito aqui.

5. Abra index.html em um navegador para exibir o relatório de cobertura de código.

Requerimentos

Exigência	Descrição
Tipos de pipeline	YAML, construção clássica
Funciona em	Agente, DeploymentGroup
Exigências	Nenhum
Capacidades	Esta tarefa não satisfaz quaisquer exigências para tarefas subsequentes no trabalho.
Restrições de comando	Qualquer
Variáveis configuráveis	Esta tarefa tem permissão para definir as seguintes variáveis: A configuração de variáveis está desativada
Versão do agente	2.182.1 ou superior
Categoria de tarefa	Teste

Ver também

• Publicar resultados de testes