Microsoft MVP성태의 닷넷 이야기
글쓴 사람
정성태 (techsharer at outlook.com)
홈페이지
첨부 파일
(연관된 글이 2개 있습니다.)
Visual Studio 2010 - Code Coverage 결과를 외부 XML 파일로 출력하는 명령행 도구 제작

Visual Studio 2010에서 Code Coverage를 수행하면 다음과 같이 내부 "Code Coverage Results" 윈도우에서 그 결과를 확인해 볼 수 있는데요.

how_to_export_code_coverage_result_1.png

위와 같은 결과물은 로컬 상에 "[파일명].coverage"라는 이름으로 저장되어 있긴 한데, 애석하게도 바이너리 형식이라서 임의로 활용하는 것이 쉽지 않습니다. 물론, 위의 화면 자체에서 제공되는 "Export Results" 버튼을 이용해서 곧바로 XML 파일로 변환해서 보관하는 것이 가능하지만, 자동화된 빌드 시스템에서 코드 커버리지 결과도 함께 연동하고 싶을 때는 이렇게 UI를 통해서 하는 것은 전혀 도움이 되지 않습니다.

즉, "명령행"에서 빌드 및 테스트 수행 결과로 생성된 .coverage 파일을 "Export Results"와 동일한 형식의 XML로 변환하는 것이 해결 과제입니다.




다행히, Visual Studio는 ".coverage" 파일을 코드로 다룰 수 있도록 허용해 주고 있는데요. 이에 관해서는 다음의 글에서 설명해 주고 있습니다.

Is it possible to programmatically access code coverage data? 
; http://www.go4answers.com/Example/possible-programmatically-access-code-4285.aspx

위의 글에서는 "Visual Studio 2008"로 되어 있지만, 여기서는 "Visual Studio 2010"을 기준으로 설명합니다.

1. 새 프로젝트를 생성하고, "Microsoft.VisualStudio.Coverage.Analysis.dll"을 참조.


Microsoft.VisualStudio.Coverage.Analysis.dll 파일은 기본적으로 참조 대화상자에 나오지 않기 때문에, "C:\Program Files (x86)\Microsoft Visual Studio 10.0\Common7\IDE\PrivateAssemblies" 경로로 직접 찾아들어가야 합니다.

2. "Microsoft.VisualStudio.Coverage.Symbols.dll" 파일 추가

Microsoft.VisualStudio.Coverage.Analysis.dll 파일과 동일한 폴더("C:\Program Files (x86)\Microsoft Visual Studio 10.0\Common7\IDE\PrivateAssemblies")에 있는 "Microsoft.VisualStudio.Coverage.Symbols.dll" 파일을 추가합니다. "참조"가 아니라 그냥 파일 추가를 하고 속성 창에서 다음과 같이 설정을 해줍니다.

how_to_export_code_coverage_result_2.png

Build Action: None
Copy to Output Directory: Copy if newer


3. 코드 추가


Visual Studio 2010에서는 "Is it possible to programmatically access code coverage data?" 글에서 설명하고 있는 개체 모델이 다소 변경이 되었습니다. 따라서 다음과 같은 식으로 코딩을 해주어야 합니다.

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;

using Microsoft.VisualStudio.Coverage.Analysis;
using System.IO;

namespace CodeCoverageExporter
{
    class Program
    {
        static void Main(string[] args)
        {
            if (args.Length != 4)
            {
                Console.WriteLine("[example]");
                Console.WriteLine("\tCodeCoverageExporter.exe [exepath] [sympath] [coveragefilepath] [outputfilepath]");
                return;
            }

            string binaryPath = args[0];
            string symPath = args[1];
            string coverageFilePath = args[2];
            string outputPath = args[3];

            List symPaths = new List();
            List binaryPaths = new List();
            symPaths.Add(symPath);
            binaryPaths.Add(binaryPath);

            CoverageInfo coverageInfo = CoverageInfo.CreateFromFile(
                coverageFilePath, binaryPaths, symPaths);

            string exportFilePath = Path.Combine(Environment.CurrentDirectory, outputPath);

            CoverageDS data = coverageInfo.BuildDataSet();
            data.WriteXml(exportFilePath);
            // 또는 결과 XML 파일을 VS IDE에서 읽어들여야 한다면 아래와 같이 실행.
            // data.WriteXml(exportFilePath, System.Data.XmlWriteMode.WriteSchema);
        }
    }
}

[exepath]와 [sympath]는 보통 단위 테스트 했을 때 나오는 "TestResults"의 "Out" 폴더인데요. 예를 들면 다음과 같이 "*.instr.pdb" 파일들이 놓인 경로를 가리켜야 합니다.

how_to_export_code_coverage_result_3.png

[coveragefilepath]는 코드 커버리지 결과를 담고 있는 "[파일명].coverage"의 경로입니다. 이 파일은 단위 테스트 했을 때 보통 "TestResults"의 "In" 폴더에 "data.coverage"라는 이름으로 놓이게 됩니다.

how_to_export_code_coverage_result_4.png

마지막으로 [outputfilepath]는 새로 출력될 XML 파일의 경로를 적어주면 됩니다.

이제 빌드하고, 적절한 테스트 환경을 구성해서 실행해 보면 "Visual Studio 2010"의 "Code Coverage Results" 화면에서 "Export Results" 했을 때와 동일한 형식의 xml 파일이 생성되는 것을 확인할 수 있습니다.

첨부된 압축 파일은 위의 소스 코드를 포함한 프로젝트입니다.




참고로, "Is it possible to programmatically access code coverage data?" 글에서도 나오고 있지만, 만약 다음과 같은 오류가 발생한다면,

Unhandled Exception: Microsoft.VisualStudio.Coverage.Analysis.CoverageAnalysisException: Unable to load DLL 'Microsoft.VisualStudio.Coverage.Symbols.dll': The specified module could not be found. (Exception from HRESULT: 0x8007007E) ---> System.DllNotFoundException: Unable to load DLL 'Microsoft.VisualStudio.Coverage.Symbols.dll': The specified module could not be found. (Exception from HRESULT: 0x8007007E)
at Microsoft.VisualStudio.Coverage.Analysis.Vsp.SymbolInterop.CreateSession()
at Microsoft.VisualStudio.Coverage.Analysis.Vsp.VspSymbolReader..ctor(StringsymbolSearchPath, String expectedPath, String actualPath, UInt32 imageSize, MissingFileCallback callback)
at Microsoft.VisualStudio.Coverage.Analysis.Vsp.VspSymbolReaderFactory.CreateReader()
at Microsoft.VisualStudio.Coverage.Analysis.CoverageInfo.BuildDataSet(Boolean summaryOnly, IEnumerable`1 tests, IEnumerable`1 modules)
--- End of inner exception stack trace ---
at Microsoft.VisualStudio.Coverage.Analysis.CoverageInfo.BuildDataSet(Boolean summaryOnly, IEnumerable`1 tests, IEnumerable`1 modules)
at Microsoft.VisualStudio.Coverage.Analysis.CoverageInfo.BuildDataSet()
at CodeCoverageExporter.Program.Main(String[] args) in D:\...\Program.cs:line 37


원인은, "Microsoft.VisualStudio.Coverage.Symbols.dll" 파일을 실행 파일과 동일한 폴더에 놓지 않아서 발생하는 것입니다.



[이 토픽에 대해서 여러분들과 의견을 공유하고 싶습니다. 틀리거나 미흡한 부분 또는 의문 사항이 있으시면 언제든 댓글 남겨주십시오.]

[연관 글]






[최초 등록일: ]
[최종 수정일: 6/28/2023]

Creative Commons License
이 저작물은 크리에이티브 커먼즈 코리아 저작자표시-비영리-변경금지 2.0 대한민국 라이센스에 따라 이용하실 수 있습니다.
by SeongTae Jeong, mailto:techsharer at outlook.com

비밀번호

댓글 작성자
 



2010-09-08 10시44분
Developer Tool Manager (1.0.1.12) 버전에 추가했습니다. ^^ (Visual Studio 탭 - CodeCoverageExporter)
; http://www.sysnet.pe.kr/Default.aspx?mode=2&sub=0&detail=1&wid=-

kevin25

... [31]  32  33  34  35  36  37  38  39  40  41  42  43  44  45  ...
NoWriterDateCnt.TitleFile(s)
13162정성태11/15/202215712.NET Framework: 2069. .NET 7 - AOT(ahead-of-time) 컴파일 [1]
13161정성태11/14/202214363.NET Framework: 2068. C# - PublishSingleFile로 배포한 이미지의 역어셈블 가능 여부 (난독화 필요성) [4]
13160정성태11/11/202214323.NET Framework: 2067. C# - PublishSingleFile 적용 시 native/managed 모듈 통합 옵션
13159정성태11/10/202217640.NET Framework: 2066. C# - PublishSingleFile과 관련된 옵션 [3]
13158정성태11/9/202213327오류 유형: 826. Workload definition 'wasm-tools' in manifest 'microsoft.net.workload.mono.toolchain' [...] conflicts with manifest 'microsoft.net.workload.mono.toolchain.net7'
13157정성태11/8/202214367.NET Framework: 2065. C# - Mutex의 비동기 버전파일 다운로드1
13156정성태11/7/202215961.NET Framework: 2064. C# - Mutex와 Semaphore/SemaphoreSlim 차이점파일 다운로드1
13155정성태11/4/202214199디버깅 기술: 183. TCP 동시 접속 (연결이 아닌) 시도를 1개로 제한한 서버
13154정성태11/3/202214683.NET Framework: 2063. .NET 5+부터 지원되는 GC.GetGCMemoryInfo파일 다운로드1
13153정성태11/2/202216002.NET Framework: 2062. C# - 코드로 재현하는 소켓 상태(SYN_SENT, SYN_RECV)
13152정성태11/1/202214905.NET Framework: 2061. ASP.NET Core - DI로 추가한 클래스의 초기화 방법 [1]
13151정성태10/31/202214351C/C++: 161. Windows 11 환경에서 raw socket 테스트하는 방법파일 다운로드1
13150정성태10/30/202213250C/C++: 160. Visual Studio 2022로 빌드한 C++ 프로그램을 위한 다른 PC에서 실행하는 방법
13149정성태10/27/202213826오류 유형: 825. C# - CLR ETW 이벤트 수신이 GCHeapStats_V1/V2에 대해 안 되는 문제파일 다운로드1
13148정성태10/26/202213748오류 유형: 824. msbuild 에러 - error NETSDK1005: Assets file '...\project.assets.json' doesn't have a target for 'net5.0'. Ensure that restore has run and that you have included 'net5.0' in the TargetFramew
13147정성태10/25/202213026오류 유형: 823. Visual Studio 2022 - Unable to attach to CoreCLR. The debugger's protocol is incompatible with the debuggee.
13146정성태10/24/202214324.NET Framework: 2060. C# - Java의 Xmx와 유사한 힙 메모리 최댓값 제어 옵션 HeapHardLimit
13145정성태10/21/202214967오류 유형: 822. db2 - Password validation for user db2inst1 failed with rc = -2146500508
13144정성태10/20/202214657.NET Framework: 2059. ClrMD를 이용해 윈도우 환경의 메모리 덤프로부터 닷넷 모듈을 추출하는 방법파일 다운로드1
13143정성태10/19/202215603오류 유형: 821. windbg/sos - Error code - 0x000021BE
13142정성태10/18/202220404도서: 시작하세요! C# 12 프로그래밍
13141정성태10/17/202216138.NET Framework: 2058. [in,out] 배열을 C#에서 C/C++로 넘기는 방법 - 세 번째 이야기파일 다운로드1
13140정성태10/11/202215528C/C++: 159. C/C++ - 리눅스 환경에서 u16string 문자열을 출력하는 방법 [2]
13139정성태10/9/202213624.NET Framework: 2057. 리눅스 환경의 .NET Core 3/5+ 메모리 덤프로부터 모든 닷넷 모듈을 추출하는 방법파일 다운로드1
13138정성태10/8/202216216.NET Framework: 2056. C# - await 비동기 호출을 기대한 메서드가 동기로 호출되었을 때의 부작용 [1]
13137정성태10/8/202214133.NET Framework: 2055. 리눅스 환경의 .NET Core 3/5+ 메모리 덤프로부터 닷넷 모듈을 추출하는 방법
... [31]  32  33  34  35  36  37  38  39  40  41  42  43  44  45  ...