PublishCodeCoverageResults@1 – Publicera kodtäckningsresultat v1-uppgift

  • Artikel

Använd den här uppgiften för att publicera Cobertura- eller JaCoCo-kodtäckningsresultat från en version.

Viktigt

Den här uppgiften är inaktuell. Användare rekommenderas att växla till PublishCodeCoverageResults@2. Mer information finns i Ny version av aktiviteten Publicera kodtäckningsresultat.

Använd den här uppgiften för att publicera Cobertura- eller JaCoCo-kodtäckningsresultat från en version.

Syntax

# Publish code coverage results v1
# [DEPRECATION WARNING! Users are recommended to switch to version 2*.] 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.

# 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.

# 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. 
    #reportDirectory: # string. Report directory. 
    #additionalCodeCoverageFiles: # string. Additional files. 
    #failIfCoverageEmpty: false # boolean. Fail when code coverage results are missing. Default: false.

# YAML Syntax is not supported in TFS 2018.
# Use the classic designer to add and configure tasks.
# See the following Inputs section for details on the inputs that this task supports.

Indata

codeCoverageTool - Kodtäckningsverktyg
string. Krävs. Tillåtna värden: Cobertura, JaCoCo. Standardvärde: JaCoCo.

Anger det verktyg som genererar kodtäckningsresultat.


summaryFileLocation - Sammanfattningsfil
string. Krävs.

Anger sökvägen till sammanfattningsfilen som innehåller kodtäckningsstatistik, till exempel rad-, metod- och klasstäckning. Flera sammanfattningsfiler sammanfogas i en enda rapport. Värdet kan innehålla minimatchmönster. Exempel: $(System.DefaultWorkingDirectory)/MyApp/**/site/cobertura/coverage.xml.


pathToSources - Sökväg till källfiler
string.

Du måste ange en sökväg till källfiler när XML-rapporter för täckning inte innehåller en absolut sökväg till källfiler. JaCoCo-rapporter använder till exempel inte absoluta sökvägar, så när du publicerar JaCoCo-täckning för Java-appar liknar $(System.DefaultWorkingDirectory)/MyApp/src/main/java/mönstret . Dessa indata bör peka på en absolut sökväg till källfiler på värden. Till exempel $(System.DefaultWorkingDirectory)/MyApp/.

Dessa indata kan användas om tester körs i en Docker-container.

Flera källor kan läggas till genom att avgränsa varje listobjekt med ; tecknet, till exempel pathToSources: $(System.DefaultWorkingDirectory)/path/to/first/source;$(System.DefaultWorkingDirectory)/path/to/second/source.


reportDirectory - Rapportkatalog
string.

Anger sökvägen till HTML-rapportkatalogen för kodtäckning. Rapportkatalogen publiceras för senare visning som en artefakt av bygget. Värdet kan innehålla minimatchmönster. Exempel: $(System.DefaultWorkingDirectory)/MyApp/**/site/cobertura.


additionalCodeCoverageFiles - Ytterligare filer
string.

Anger filsökvägsmönstret och noterar eventuella ytterligare kodtäckningsfiler som ska publiceras som artefakter i bygget. Värdet kan innehålla minimatchmönster. Exempel: $(System.DefaultWorkingDirectory)/**/*.exec.


failIfCoverageEmpty - Misslyckas när kodtäckningsresultat saknas
boolean. Standardvärde: false.

Aktiviteten misslyckas om kodtäckningen inte gav några resultat att publicera.


Kontrollalternativ för aktivitet

Alla aktiviteter har kontrollalternativ utöver sina aktivitetsindata. Mer information finns i Kontrollalternativ och vanliga uppgiftsegenskaper.

Utdatavariabler

Inga.

Kommentarer

Viktigt

Den här uppgiften är inaktuell. Användare rekommenderas att växla till PublishCodeCoverageResults@2. Mer information finns i Ny version av aktiviteten Publicera kodtäckningsresultat.

Anteckning

Se Ny version av aktiviteten Publicera kodtäckningsresultat på Azure DevOps-bloggen för information om de nya funktionerna i V2 för aktiviteten Publicera kodtäckningsresultat och migrering från V1 till V2.

Använd den här uppgiften i en byggpipeline för att publicera kodtäckningsresultat som genereras när du kör tester till Azure Pipelines eller TFS för att få täckningsrapportering. Uppgiften stöder populära täckningsresultatformat som Cobertura och JaCoCo.

Den här uppgiften stöds bara i bygg-pipelines, inte versionspipelines.

Uppgifter som Visual Studio Test, .NET Core, Ant, Maven, Gulp och Grunt ger också möjlighet att publicera kodtäckningsdata till pipelinen. Om du använder dessa uppgifter behöver du inte en separat aktivitet för publicering av kodtäckningsresultat i pipelinen.

För att generera HTML-kodtäckningsrapporten behöver du dotnet framework 2.0.0 eller senare på agenten. Dotnet-mappen måste finnas i miljösökvägen. Om det finns flera mappar som innehåller dotnet måste den med version 2.0.0 finnas före andra i sökvägslistan.

Kodtäckningsresultat för JavaScript med Istanbul med YAML

Information om hur du publicerar kodtäckningsresultat för JavaScript med Istanbul med YAML finns i Anpassa JavaScript i avsnittet Ekosystem i de här avsnitten, som även innehåller exempel på andra språk.

Se ett exempel på publicering av kodtäckning med Cobertura.

Docker

För appar som använder Docker kan kompilering och tester köras i containern och generera kodtäckningsresultat i containern. För att publicera resultaten till pipelinen bör de resulterande artefakterna göras tillgängliga för aktiviteten Publicera kodtäckningsresultat . Som referens kan du se ett liknande exempel för publicering av testresultat under avsnittet Skapa, testa och publicera resultat med en Docker-fil för Docker.

Visa resultat

Information om hur du visar kodtäckningsresultaten i pipelinen finns i Granska kodtäckningsresultat.

Sammanfogas kodtäckningsdata när flera filer tillhandahålls som indata till uppgiften eller används flera aktiviteter i pipelinen?

För närvarande är funktionen för rapportering av kodtäckning som tillhandahålls av den här uppgiften begränsad och den sammanfogar inte täckningsdata. Om du anger flera filer som indata för uppgiften beaktas endast den första matchningen. Om du använder flera publiceringskodtäckningsuppgifter i pipelinen visas sammanfattningen och rapporten för den sista aktiviteten. Tidigare uppladdade data ignoreras.

Kända problem

Uppgiften publicera kodtäckningsresultat genererar och publicerar HTML-rapporten, som är en uppsättning HTML-filer som är länkade från huvudfilenindex.html . Om kodtäckningsfliken inte visar kodtäckningsrapporten kontrollerar du om storleken på denindex.html filen är nära eller större än 7 MB. Utför följande steg för att kontrollera filens storlek. Om filstorleken sedan är nära eller större än 7 MB kan du använda följande lösning för att visa täckningsrapporten.

  1. Välj fliken Skapa sammanfattning och välj sedan den publicerade länken:

    Skärmbild som visar den publicerade länken i fönstret Sammanfattning.

  2. Bredvid artefakten Kodtäckning Report_* väljer du Ladda ned artefakter:

    Skärmbild som visar länken Ladda ned artefakter för kodtäckningsrapporten under Artefakter.

  3. När kodtäckningsrapporten laddas ned extraherar du .zip-filen.

  4. I kodtäckningsrapporten kontrollerar du storleken på index.html för att avgöra om filstorleken orsakar problemet som beskrivs här.

  5. Öppna index.html i en webbläsare för att visa kodtäckningsrapporten.

Krav

Krav Beskrivning
Pipelinetyper YAML, klassisk version
Körs på Agent, DeploymentGroup
Krav Ingen
Funktioner Den här aktiviteten uppfyller inte några krav för efterföljande uppgifter i jobbet.
Kommandobegränsningar Valfri
Inställningsbara variabler Den här aktiviteten har behörighet att ange följande variabler: Inställningsvariabler är inaktiverade
Agentversion 2.182.1 eller senare
Uppgiftskategori Test
Krav Beskrivning
Pipelinetyper YAML, klassisk version
Körs på Agent, DeploymentGroup
Krav Ingen
Funktioner Den här aktiviteten uppfyller inte några krav för efterföljande uppgifter i jobbet.
Kommandobegränsningar Valfri
Inställningsbara variabler Valfri
Agentversion 2.102.0 eller senare
Uppgiftskategori Test

Se även