디버깅 기술: 18.1. 소스 서버 구성, 그 외의 이야기

부모글 보이기/감추기

TFS Team Build + Source Server = 소스 코드 디버깅

많은 분들이 아시겠지만, .NET Framework 소스 코드가 디버깅이 가능한 유형으로 공개되어 있습니다. 즉, .NET 응용 프로그램을 디버깅하면서 Microsoft가 만들어 놓은 "System.DLL"들에 정의된 타입에 대해서 소스 코드 수준까지 디버깅하는 것이 가능하다는 것입니다. (이에 대한 자세한 설명은 "Configuring Visual Studio to Debug .NET Framework Source Code"을 참조하십시오. 덧붙여서, Win32 API도 제한된 사용자들에 한해서 소스 코드 수준의 디버깅이 가능합니다. [참조: CCP를 이용한 Windows Source Code 수준의 디버깅])

물론, 소스 코드 자체를 보호해야 하는 응용 프로그램이라면 이렇게 할 수는 없지만. 오픈 소스로 공유될 프로젝트이거나 그 외의 수많은 사이트에서의 안정성을 검증받는 과정에 있는 프로젝트라면 매우 매력적인 기능임에는 틀림없습니다. 심지어 어떤 경우에는, 특정 PC에서만 문제가 발생하기도 하는데, 그런 문제를 해결하기 위해 해당 PC에 복잡한 "빌드 환경"을 구성하고 디버깅을 해야 하는 것은 여간 곤혹스러운 일이 아닙니다. (물론, 원격 디버깅도 있지만.) 그런 때, "Symbol Server + Source Server"를 이용해서 곧바로 소스 코드 수준까지 디버깅이 된다면 거의 대부분의 문제가 매우 쉽게 해결이 될 수 있습니다.

그럼, 이 매력적인 방법을 ^^ Team Build와 연계시켜 볼까요!

"Source Server"를 구성하기 위해서는, 우선 지난번 토픽 "TFS Team Build + Symbol Server"에서 설명한 환경 구성을 먼저 해놓으셔야 합니다. 이번엔, 지난번에 만들어놓은 팀빌드 유형에 "Source Server"를 구성하는 것까지 추가할 것입니다.

먼저, 이번에 하는 설명들은 다음의 토픽을 기반으로 작성되었습니다.

Setting up Source Server for TFS Builds
; http://jelle.druyts.net/2007/12/09/SettingUpSourceServerForTFSBuilds.aspx

굳이, 제가 여기서 다시 쓸 필요는 없어보이지만 한글로 된 자료를 구글에서 검색해 보니 아직 아무도 쓰지 않은 듯 싶고 저 또한 위의 내용대로 실습하면서 정리할 필요성을 느꼈기 때문에 이곳에 다시 써봅니다. (여차하면, 그냥 바로 위의 토픽을 보시면서 소스 서버를 구성하셔도 됩니다. ^^)

참고로, 소스 서버에 대한 "John Robbins"의 글을 MSDN Magazine에서도 보실 수 있습니다.

Use The Source, Luke - Source Server Helps You Kill Bugs Dead In Visual Studio 2005
; https://docs.microsoft.com/en-us/archive/msdn-magazine/2006/august/source-server-helps-you-kill-bugs-dead-in-visual-studio-2005

자, 그럼, 지난번에 만들어 놓은 "BaseClassLibrary" 팀 프로젝트를 대상으로 한 단계씩 설명해 보겠습니다.

1. ActivePerl 설치
팀 빌드 서버에 "ActivePerl"을 설치합니다. 왜냐하면, 이후에 나올 tfsindex.cmd 파일에서 perl 런타임을 필요로 하기 때문입니다.

ActivePerl
; http://www.activestate.com/Products/activeperl/index.mhtml

버전 5.10.0(빌드 1004) 다운로드(x86)
; http://downloads.activestate.com/ActivePerl/Windows/5.10/ActivePerl-5.10.0.1004-MSWin32-x86-287188.msi

2. tfsindex.cmd 편집
"%ProgramFiles(x86)%\Debugging Tools for Windows (x86)\srcsrv" 폴더에 위치한 "tfsindex.cmd" 파일을 메모장으로 열어서 다음과 같이 편집해 줍니다.

@echo off
@REM ----------------------------------------
@REM Now just a stub to call SSIndex.cmd
@REM ----------------------------------------
@call "%~dp0SSIndex.cmd" -SYSTEM=TFS -SYMBOLS=%1 %*

3. srcsrv.ini 편집
소스 서버 경로를 알리기 위해 "%ProgramFiles(x86)%\Debugging Tools for Windows (x86)\srcsrv" 폴더에 위치한 "srcsrv.ini" 파일의 내용 중에서 "MYSERVER" 키의 값을 자신의 환경에 맞게 변경합니다. 제 경우에는 다음과 같이 변경했습니다.

[variables]
MYSERVER=http://tfsenu:8080/

위의 주소는, Team Explorer에서 TFS 서버를 지정할 때 사용된 URL 입니다. 정확하게는, Workspace에 매핑된 폴더에서 "tf.exe workfold" 명령어를 통해 출력되는 주소를 입력해 줘야 합니다. 예를 들어, 저 같은 경우에 "BaseClassLibrary" 팀 빌드가 이뤄지는 경로에서 "tf.exe workfold"를 실행하면 다음과 같은 결과가 나옵니다.

D:\TeamBuild\BaseClassLibrary>tf.exe workfold
===============================================================================
Workspace: TFSENU_1 (tfsservice)
Server   : http://tfsenu:8080/
 $/BaseClassLibrary: D:\TeamBuild\BaseClassLibrary\FastBuild\Sources

보시는 것처럼, 위에서 출력된 Server에 대한 값 "http://tfsenu:8080/" 값을 입력해 줘야 합니다.

4. TF.exe를 환경 변수 PATH에 설정
지난번, Symbol Server 구성에서도 "symstore.exe"에 대해 파일 경로를 전역 환경 변수 PATH에 설정했는데, 이와 마찬가지로 tf.exe 역시 설정을 해둡니다. (반드시, "TFSBuildService.exe"를 구동시키는 계정에서 tf.exe 실행이 가능해야 합니다.) 설정 후, 팀 빌드 서비스에 변경된 환경 변수 설정이 반영될 수 있도록 "Visual Studio Team Foundation Build" 서비스를 재시작합니다.

5. 팀 빌드에 소스 서버 지정
이 과정은 매우 간단합니다. 아래와 같이 해당 팀 빌드 파일에 tfsindex.cmd를 실행시켜 주는 빌드 태스크를 추가해 주면 됩니다.

    <Target Name="RunSourceServerIndexing">
        <Exec
           Command="tfsindex.cmd &quot;$(BinariesRoot)&quot;"
           WorkingDirectory="$(SolutionRoot)" />
    </Target>

    <Target Name="AfterCompile" DependsOnTargets="RunSourceServerIndexing" />

    <Target Name="AfterDropBuild">
        <!-- PDB Symbol 배포 -->
        <Exec IgnoreExitCode="false" 
            Command="symstore add /r /f $(OutDir)*.* /s \\web2008\Symbols /t $(TeamProject) /v $(BuildNumber) " />
    </Target>

그리하여, 팀 빌드를 해보면, 빌드 로그 파일에 다음과 같은 내용이 실려 있는 것을 볼 수 있습니다.

Task "Exec"
  Command:
  tfsindex.cmd "d:\TeamBuild\BaseClassLibrary\FastBuild\Binaries" 
  --------------------------------------------------------------------------------
  ssindex.cmd [STATUS] : Server ini file: C:\Program Files\Debugging Tools for Windows (x86)\srcsrv\srcsrv.ini
  ssindex.cmd [STATUS] : Source root    : d:\TeamBuild\BaseClassLibrary\FastBuild\Sources
  ssindex.cmd [STATUS] : Symbols root   : d:\TeamBuild\BaseClassLibrary\FastBuild\Binaries
  ssindex.cmd [STATUS] : Control system : TFS
  ssindex.cmd [STATUS] : TFS program name: tf.exe
  ssindex.cmd [STATUS] : TFS Label      : <N/A>
  ssindex.cmd [STATUS] : Old path root  : <N/A>
  ssindex.cmd [STATUS] : New path root  : <N/A>
  --------------------------------------------------------------------------------
  ssindex.cmd [STATUS] : Running... this will take some time...   
  ssindex.cmd [STATUS] : d:\TeamBuild\BaseClassLibrary\FastBuild\Sources\Sources\BaseClassLibrary\BaseClassLibrary.sln
  ssindex.cmd [STATUS] : /BaseClassLibrary/Sources/BaseClassLibrary/BaseClassLibrary.sln
  ssindex.cmd [STATUS] : 3
  
  ssindex.cmd [STATUS] : d:\TeamBuild\BaseClassLibrary\FastBuild\Sources\Sources\BaseClassLibrary\BaseClassLibrary.snk
  ssindex.cmd [STATUS] : /BaseClassLibrary/Sources/BaseClassLibrary/BaseClassLibrary.snk
  ssindex.cmd [STATUS] : 3
  
  [중간생략]
  
  ssindex.cmd [STATUS] : /BaseClassLibrary/TeamBuildTypes/FastBuild/TFSBuild.rsp
  ssindex.cmd [STATUS] : 4

마지막으로, PDB 파일에 소스 코드 파일 정보가 정상적으로 인덱싱 되었는지 확인을 하기 위해 srctool.exe를 이용해서 다음과 같이 실행해 줍니다.

D:\TeamBuild\BaseClassLibrary>srctool .\FastBuild\Binaries\Debug\BclExtension.pdb
[d:\TeamBuild\BaseClassLibrary\FastBuild\Sources\Sources\BaseClassLibrary\Library\BclExtension\ObjectExtension.cs] 
cmd: tf.exe view /version:12 /noprompt 
"$/BaseClassLibrary/Sources/BaseClassLibrary/Library/BclExtension/ObjectExtension.cs"
/server:http://tfsenu:8080/ 
/console >"D:\TeamBuild\BaseClassLibrary\MYSERVER\BaseClassLibrary\Sources\BaseClassLibrary\Library\BclExtension\ObjectExtension.cs\12\ObjectExtension.cs"
.\FastBuild\Binaries\Debug\BclExtension.pdb: 1 source files are indexed

TFS 서버 측의 설정은 이것으로 완료가 되었습니다.

자, 그럼 정말로 소스 레벨의 디버깅이 가능한지 확인을 해봐야 겠지요. ^^ 이번에도 역시 제가 만들어놓은 예제 프로젝트를 기반으로 테스트를 해보겠습니다.

1. 예제 프로젝트 다운로드
이제까지의 단계를 밟은 후, 팀 빌드를 실행하면, 새롭게 소스 코드 파일 정보가 들어간 PDB 파일이 http://www.sysnet.pe.kr/Symbols 폴더에 위치하게 됩니다. 그리고, 그 팀 빌드에서 산출된 DLL을 참조한 예제 프로젝트를 새롭게 다운로드 받습니다.

2. 소스 코드 디버깅을 위한 옵션 설정
VS 2008 에서 "Tools" / "Options"의 "Debugging" / "General"을 선택한 후, 아래와 같이 "Enable Just My Code(Managed only)" 옵션을 해제하고, "Enable source server support" 옵션을 켜둡니다. ("Print source server diagnostic messages to the Output window" 옵션은 원하는 데로 설정합니다.)

[그림 1: "Debugging" / "General" 옵션 설정]

3. 심벌 서버 지정
VS 2008에서 "Tools" / "Options"의 "Debugging" / "Symbols"를 선택한 후, 소스 코드 인덱싱 정보가 들어있는 PDB 파일에 대한 심벌 서버 위치를 지정해 줍니다.

[그림 2: "Debugging" / "Symbols" 옵션 설정]

4. 테스트를 위한 tfsenu IP 지정
제가 테스트 한 서버가 tfsenu인데, 집에서 구성된 테스트 서버입니다. 소스 코드를 받아오기 위해 tfsenu 서버 주소를 이용하게 되는데, 현재 여러분들의 컴퓨터에서는 IP 주소가 안 나올 것이기 때문에, 우선 그에 대한 주소를 "C:\Windows\System32\drivers\etc\hosts" 파일에 등록해 주어야 합니다. 등록될 주소는 아래와 같이 "ping www.sysnet.pe.kr"로 확인해 주시면 됩니다.

[그림 3: tfsenu 서버를 위한 주소 지정]

5. 디버깅 시작
이제 VS 2008에서 아래 화면과 같이 정지점(BP:Break Point)를 잡고, ObjectToString 소스 코드 안으로 진입하기 위해 Step Into (F11) 기능을 이용하게 되면, PDB 파일에 인덱싱된 소스 코드 파일에 대한 정보를 읽어서 "tf.exe"를 통해 "http://tfsenu:8080"으로부터 소스 코드를 받아와서 로컬에 캐쉬한 후, 진입하게 됩니다.

[그림 4: 소스 코드 디버깅]

와~~~~~~~~~ ^^

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

(연관된 글이 2개 있습니다.)

소스 서버 구성, 그 외의 이야기

소스 서버 구성과 관련한 몇 가지 뒷 이야기를 정리해 보면.

1. ActivePerl 설치시 유의점
처음에 소스 서버를 구성한 이후, 정상적으로 동작이 안되어 서투른 perl 스크립트를 구동하는 vssindex.cmd를 직접 실행하여 원인을 찾기 시작했습니다. (물론, 아래의 메시지는 팀 빌드 로그에도 나옵니다.)

D:\TeamBuild\...\Sources>vssindex -SYSTEM=TFS -SYMBOLS="D:\TeamBuild\BaseClassLibrary" -SOURCE="D:\TeamBuild\BaseClassLibrary\Sources"
--------------------------------------------------------------------------------
ssindex.cmd [STATUS] : Server ini file: E:\Program Files\Debugging Tools for Windows (x86)\srcsrv\srcsrv.ini
ssindex.cmd [STATUS] : Source root    : D:\TeamBuild\BaseClassLibrary\Sources
ssindex.cmd [STATUS] : Symbols root   : D:\TeamBuild\BaseClassLibrary
ssindex.cmd [STATUS] : Control system : TFS
ssindex.cmd [STATUS] : TFS program name: tf.exe
ssindex.cmd [STATUS] : TFS Label      : <N/A>
ssindex.cmd [STATUS] : Old path root  : <N/A>
ssindex.cmd [STATUS] : New path root  : <N/A>
--------------------------------------------------------------------------------

ssindex.cmd [STATUS] : Running... this will take some time...
ssindex.cmd [STATUS] : Server name not returned by tf.exe info for D:\TeamBuild\BaseClassLibrary\Sources.Skipping all files in the working folder.

보시는 것처럼, "Server name not returned by tf.exe"라는 메시지가 빌드 로그에 남았습니다. 어흑... ;;; 괴로워라. 왜 늘 한방에 안되는 거지!!!

어쨌든, 생전 처음 보는 perl 스크립트를 훑어보면서 알아낸 점은, open 파일 메서드가 다른 파일은 모두 여는 데, "tf.exe"를 실행하는 부분에서만 오류가 발생하는 것이었습니다. 여러 가지 이거저거 해보는 과정 중에, PATH 환경 변수를 들여다 보게 되었고 아래와 같이 이상하게 설정이 되어 있었습니다.

C:\perl\...;PATH=%SystemRoot%..."

생각해 보니, ActivePerl을 설치하는 과정 중에, PATH에 ActivePerl의 바이너리 폴더를 설정하는 옵션을 아래와 같이 제공해 주는데,

[그림 1: ActivePerl 설치 시 환경 변수 자동 설정 옵션]

아무래도 그때 해당 설치 루틴이 PATH 설정을 위와 같이 잘못하는 것 같습니다. 어쨌든 PATH 환경 변수를 정상적으로 "C:\perl\...;%SystemRoot%...."와 같이 해주는 것으로 문제를 해결했습니다.

2. 팀 빌드 계정
환경 설정 시, 유의해야 될 사항이 바로 "팀 빌드" 서비스를 실행하는 계정이 여러분들이 작업 중인 로그인 계정이 아닐 수 있다는 점에 주의하셔야 합니다. 즉, PATH 환경 변수를 설정하더라도 현재 팀 빌드 서버에 로그인 해서 사용중인 계정에 지정하는 것은 아무런 도움이 되지 않습니다. 게다가 tf.exe를 실행해서 검증하는 과정에서도 팀 빌드 계정의 Workspace와 현재 시스템에 로그인 한 계정의 Workspace는 다르기 때문에 자칫 문제를 다르게 해석할 수가 있습니다.

참고로, 팀 프로젝트에 대해 "팀 빌드"를 설정하게 되면, 팀 빌드 서버에 자동으로 "팀 빌드 서비스 구동 계정"으로 소스 컨트롤 관련 Workspace가 기본적으로 하나 생성이 됩니다.

3. 소스 버전 관리
혹시나, 궁금하실 분들이 계실지 몰라서 미리 말씀드리면. 예를 들어, 빌드된 바이너리가 배포된 이후, 지속적인 소스 코드 변경이 되었다고 할 때, 이전 빌드된 바이너리에서 소스 코드 레벨의 디버깅을 하면 어떻게 될까요? ^^

"Print source server diagnostic message to the Output window" 옵션을 켜고 직접 해보신 분이라면, 소스 코드 디버깅 화면의 "Output" 창을 보면 "SRCSRV: ..."하는 내용을 보실 수 있을 텐데요. 구체적인 메시지는 아래와 같은 식입니다.

SRCSRV: tf.exe view /version:12 /noprompt "$/BaseClassLibrary/Sources/BaseClassLibrary/Library/BclExtension/ObjectExtension.cs" /server:http://tfsenu:8080/ /console >"C:\Users\SEONGT~1\AppData\Local\SOURCE~1\MYSERVER\BaseClassLibrary\Sources\BaseClassLibrary\Library\BclExtension\ObjectExtension.cs\12\ObjectExtension.cs"

보시는 것처럼, /version 정보가 들어가 있기 때문에 해당 바이너리가 빌드된 시점의 소스 코드가 정확하게 내려오게 됩니다. 또한, 로컬에 소스 코드가 캐쉬되는 폴더가 위의 정보에 포함되어 있는 것도 눈여겨 볼만 하겠지요.

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

[다음 글] 디버깅 기술: 18. TFS Team Build + Source Server = 소스 코드 디버깅
[이전 글] 디버깅 기술: 17. TFS Team Build + Symbol Server

[연관 글]

[최초 등록일: 10/15/2008]
[최종 수정일: 7/5/2021]

이 저작물은 크리에이티브 커먼즈 코리아 저작자표시-비영리-변경금지 2.0 대한민국 라이센스에 따라 이용하실 수 있습니다.

by SeongTae Jeong, mailto:techsharer at outlook.com

No	Writer	Date	Cnt.	Title	File(s)
12211	정성태	4/27/2020	19311	개발 환경 구성: 486. WSL에서 Makefile로 공개된 리눅스 환경의 C/C++ 소스 코드 빌드
12210	정성태	4/20/2020	20785	.NET Framework: 903. .NET Framework의 Strong-named 어셈블리 바인딩 (1) - app.config을 이용한 바인딩 리디렉션 [1]	1
12209	정성태	4/13/2020	17458	오류 유형: 614. 리눅스 환경에서 C/C++ 프로그램이 Segmentation fault 에러가 발생한 경우 (2)
12208	정성태	4/12/2020	16037	Linux: 29. 리눅스 환경에서 C/C++ 프로그램이 Segmentation fault 에러가 발생한 경우
12207	정성태	4/2/2020	15942	스크립트: 19. Windows PowerShell의 NonInteractive 모드
12206	정성태	4/2/2020	18525	오류 유형: 613. 파일 잠금이 바로 안 풀린다면? - The process cannot access the file '...' because it is being used by another process.
12205	정성태	4/2/2020	15156	스크립트: 18. Powershell에서는 cmd.exe의 명령어를 지원하진 않습니다.
12204	정성태	4/1/2020	15181	스크립트: 17. Powershell 명령어에 ';' (semi-colon) 문자가 포함된 경우
12203	정성태	3/18/2020	18030	오류 유형: 612. warning: 'C:\ProgramData/Git/config' has a dubious owner: '...'.
12202	정성태	3/18/2020	21252	개발 환경 구성: 486. .NET Framework 프로젝트를 위한 GitLab CI/CD Runner 구성
12201	정성태	3/18/2020	18492	오류 유형: 611. git-credential-manager.exe: Using credentials for username "Personal Access Token". [1]
12200	정성태	3/18/2020	18581	VS.NET IDE: 145. NuGet + Github 라이브러리 디버깅 관련 옵션 3가지 - "Enable Just My Code" / "Enable Source Link support" / "Suppress JIT optimization on module load (Managed only)"
12199	정성태	3/17/2020	16228	오류 유형: 610. C# - CodeDomProvider 사용 시 Unhandled Exception: System.IO.DirectoryNotFoundException: Could not find a part of the path '...\f2_6uod0.tmp'.
12198	정성태	3/17/2020	19588	오류 유형: 609. SQL 서버 접속 시 "Cannot open user default database. Login failed."
12197	정성태	3/17/2020	18936	VS.NET IDE: 144. .NET Core 콘솔 응용 프로그램을 배포(publish) 시 docker image 자동 생성 - 두 번째 이야기 [1]
12196	정성태	3/17/2020	16024	오류 유형: 608. The ServicedComponent being invoked is not correctly configured (Use regsvcs to re-register).
12195	정성태	3/16/2020	18339	.NET Framework: 902. C# - 프로세스의 모든 핸들을 열람 - 세 번째 이야기
12194	정성태	3/16/2020	21035	오류 유형: 607. PostgreSQL - Npgsql.NpgsqlException: sorry, too many clients already
12193	정성태	3/16/2020	18022	개발 환경 구성: 485. docker - SAP Adaptive Server Enterprise 컨테이너 실행 [1]
12192	정성태	3/14/2020	20043	개발 환경 구성: 484. docker - Sybase Anywhere 16 컨테이너 실행
12191	정성태	3/14/2020	21111	개발 환경 구성: 483. docker - OracleXE 컨테이너 실행 [1]
12190	정성태	3/14/2020	15726	오류 유형: 606. Docker Desktop 업그레이드 시 "The process cannot access the file 'C:\Program Files\Docker\Docker\resources\dockerd.exe' because it is being used by another process."
12189	정성태	3/13/2020	21335	개발 환경 구성: 482. Facebook OAuth 처리 시 상태 정보 전달 방법과 "유효한 OAuth 리디렉션 URI" 설정 규칙
12188	정성태	3/13/2020	26094	Windows: 169. 부팅 시점에 실행되는 chkdsk 결과를 확인하는 방법
12187	정성태	3/12/2020	15702	오류 유형: 605. NtpClient was unable to set a manual peer to use as a time source because of duplicate error on '...'.
12186	정성태	3/12/2020	17457	오류 유형: 604. The SysVol Permissions for one or more GPOs on this domain controller and not in sync with the permissions for the GPOs on the Baseline domain controller.

AD BLOCK 해제 요청