Sdílet prostřednictvím

Microsoft.CodeCoverage.Console tool

  • Článek

Microsoft.CodeCoverage.Console je nástroj příkazového řádku, který můžete použít ke shromažďování pokrytí kódu pro kód C++ a C#. Podporuje také sloučení a převod zpráv o pokrytí kódu. Tento nástroj lze použít ke shromažďování pokrytí kódu v netestových scénářích (například pro jednoduchou konzolovou aplikaci).

Tento nástroj je rozšířením nástroje dotnet-coverage dotnet, který přidává podporu pro následující scénáře:

  • Přidává bezpečnostní funkce pro umožnění sběru dat pokrytí kódu pro ASP.NET z IIS.
  • Shromažďování dat o pokrytí C++ kódu.

Poznámka

Nástroj je k dispozici pouze se sadou Visual Studio Enterprise. Pro pokrytí kódu .NET můžete alternativně použít nástroj příkazového řádku, dotnet-coverage.

Microsoft.CodeCoverage.Console je k dispozici v sadě Visual Studio 2022 17.3 ve složce Common7\IDE\Extensions\Microsoft\CodeCoverage.Console. Můžete ho použít v příkazovém řádku pro vývojáře a v PowerShellu pro vývojáře:

D:\ConsoleApplication\x64\Debug>Microsoft.CodeCoverage.Console --help

Description:
  Code coverage tools.

Usage:
  Microsoft.CodeCoverage.Console [command] [options]

Options:
  --version       Show version information
  -?, -h, --help  Show help and usage information

Commands:
  collect <command> <args>            Collect code coverage from inner process and subprocesses.
  connect <session> <command> <args>  Connects to an existing code coverage session and collects code coverage from
                                      inner process and subprocesses.
  merge <files>                       Merge coverage reports
  shutdown <session>                  Close existing code coverage collection.
  snapshot <session>                  Creates coverage file for existing code coverage collection.
  instrument <input-file>             Instruments native and managed binary.
  uninstrument <input-file>           Restore original binary.

Shromažďování, připojení, vypnutí, sloučení, vytvoření snímku a zrušení registrace

Nástroj Microsoft.CodeCoverage.Console je rozšířením nástroje dotnet-coverage dotnet. Dokumentaci ke shromažďování, připojení, vypnutí, sloučení, snímkování a odinstrumentování najdete zde.

Microsoft.CodeCoverage.Console podporuje další funkce zabezpečení, které umožňují shromažďování pokrytí kódu ASP.NET z prostředí IIS. Nástroj Microsoft.CodeCoverage.Console navíc podporuje shromažďování pokrytí kódu pro kód C++. Příkaz instrument je specifický pro tyto scénáře.

Příkaz pro nástroj

Příkaz instrumentace slouží k instrumentaci nativního nebo spravovaného binárního souboru na disku.

Přehled

Microsoft.CodeCoverage.Console instrument
    <input-file>
    [-s|--settings <settings>] [-id|--session-id <session-id>]
    [-o|--output <output>]
    [-l|--log-file <log-file>] [-ll|--log-level <log-level>]
    [-dco|--disable-console-output] [--nologo]
    [-?|-h|--help]

Argumenty

  • <input-file>

    Vstupní binární soubor.

Možnosti

  • -s|--settings <settings>

    Nastaví cestu k nastavení pokrytí kódu XML. Soubor nastavení lze použít k vyloučení některých modulů nebo metod z analýzy pokrytí kódu. Formát je stejný jako konfigurace kolektoru dat uvnitř souboru .runsettings. Další informace naleznete v tématu Přizpůsobení analýzy pokrytí kódu.

  • -id|--session-id <session-id>

    Určuje ID relace pokrytí kódu. Pokud není zadaný, nástroj vygeneruje náhodný identifikátor GUID.

  • -o|--output <output>

    Nastaví cestu k binárnímu výstupnímu souboru. Pokud není k dispozici, provede se instrumentace na místě.

  • -l|--log-file <log-file>

    Nastaví cestu k souboru protokolu. Když zadáte adresář (s oddělovačem cest na konci), vygeneruje se pro každý proces v analýze nový soubor protokolu.

  • -ll|--log-level <log-level>

    Nastaví úroveň protokolu. Podporované hodnoty: Error, Infoa Verbose.

  • -dco|--disable-console-output

    Zakáže výstup konzoly.

  • --nologo

    Nezobrazovat banner pokrytí kódu.

Pokrytí statického kódu pro kód C++

Nástroj Microsoft.CodeCoverage.Console lze použít ke shromažďování pokrytí kódu pro C++ pomocí statické instrumentace. K dispozici jsou tři různé metody, které můžete použít. Předpokládejme, že máme jednoduchou konzolovou aplikaci C++ (propojenou s možností /PROFILE):

D:\ConsoleApplication\x64\Debug> .\ConsoleApplication.exe
Hello World!

Pokrytí kódu pomocí příkazu collect s konfiguračním souborem (C++)

Pokud nechcete použít příkaz instrument, můžete místo toho použít konfigurační soubor k určení souborů, které se mají instrumentovat, následujícím způsobem:

<ModulePaths>
  <IncludeDirectories>
    <Directory>D:\ConsoleApplication\x64\Debug</Directory>
  </IncludeDirectories>
</ModulePaths>

Zjistěte pokrytí kódu následujícím způsobem:

D:\ConsoleApplication\x64\Debug>Microsoft.CodeCoverage.Console collect --settings coverage.config .\ConsoleApplication.exe
SessionId: 85d9d49e-38a7-43a4-81ff-9e12f0e6b04b
Hello World!
Code coverage results: output.coverage.

Soubor nastavení lze použít k vyloučení některých modulů nebo metod z analýzy pokrytí kódu. Formát je stejný jako konfigurace kolektoru dat uvnitř souboru .runsettings. Další informace naleznete v tématu Přizpůsobení analýzy pokrytí kódu.

Pokrytí kódu pomocí příkazu instrument a příkazu collect (C++)

Před shromažďováním dat pokrytí kódu nejprve instrumentujte binární soubor následujícím způsobem:

D:\ConsoleApplication\x64\Debug>Microsoft.CodeCoverage.Console instrument ConsoleApplication.exe
Input file successfully instrumented.

Zjistěte pokrytí kódu následujícím způsobem:

D:\ConsoleApplication\x64\Debug>Microsoft.CodeCoverage.Console collect .\ConsoleApplication.exe
SessionId: e85e657f-9ff3-42a0-88d7-2349598a1ecd
Hello World!
Code coverage results: output.coverage.

Pokrytí kódu pomocí příkazu 'instrument' a příkazu 'collect' v serverovém režimu (C++)

Pomocí této metody můžete oddělit kolekci pokrytí kódu od spuštění aplikace. Nejprve instrumentujte binární soubor následujícím způsobem:

D:\ConsoleApplication\x64\Debug>Microsoft.CodeCoverage.Console instrument --session-id 73c34ce5-501c-4369-a4cb-04d31427d1a4 ConsoleApplication.exe
Input file successfully instrumented.

Poznámka

V tomto scénáři je potřeba použít ID relace, abyste měli jistotu, že se aplikace může připojit a poskytnout data externímu kolektoru.

Ve druhém kroku musíte spustit sběrač pokrytí kódu následujícím způsobem:

D:\ConsoleApplication\x64\Debug>Microsoft.CodeCoverage.Console collect --session-id 73c34ce5-501c-4369-a4cb-04d31427d1a4 --server-mode
SessionId: 73c34ce5-501c-4369-a4cb-04d31427d1a4

Pak spusťte aplikaci následujícím způsobem:

D:\ConsoleApplication\x64\Debug>.\ConsoleApplication.exe
Hello World!

Poznámka

Instrumentovaný nativní binární soubor obsahuje odkaz na static_covrun64.dll. Ujistěte se, že je tento soubor vedle instrumentovaného binárního souboru nebo adresáře, ve kterém je umístěn static_covrun64.dll, je uveden v proměnné prostředí Path. Příkazy collect a connect přidávají do Path automaticky správné adresáře.

Nakonec sběrač zavřete tímto způsobem:

D:\ConsoleApplication\x64\Debug>Microsoft.CodeCoverage.Console shutdown 73c34ce5-501c-4369-a4cb-04d31427d1a4

Související obsah