기본 콘텐츠로 건너뛰기

[ MSBUILD ] 개념 잡기... #3 응용 방법

기존 게시글까지 해서 기본적인 방법에 대해서 알아 보았으므로 이번 부터는 좀 더 다양하게 활용하는 방법에 대해서 알아보도록 하자. 뭐... 굉장한 응용은 아니고 이미 Visual Studio IDE를 통해서 처리되는 것들이지만 Visual Studio 의 도움 없이도 처리할 수 있도록 스크립트를 구성해 보는 것이기 때문에 아마도 모르고 지나간 원리들을 정리하는데 도움이 될 것이다.

MSBuild 응용

  요즘 거의 대부분의 PC 들이 멀티 프로세스 환경이기 때문에 이 환경에서 Rebuild 문제를 검토해 보고, 그 다음에는 MSBuildTasks 를 통해서 확장을 하는 것 까지 검토해 보도록 한다.

Rebuild on Multi Processor or Core

  개인 PC 와 빌드 서버의 차이는 아마도 Processor 나 Core 라고 해도 될 것이다. 2 CPU * 2 Core 인지, 1 CPU * 2 Core 일지 등등 말이다. 그냥 생각하면 별 것 아닌 것 같지만 아래의 내용을 검토해 보면 차이가 존재하고 이것이 문제가 될 수도 있으므로 이를 검토해 보도록 하자.

<Target Name="Build">
    <Message Text="타겟: Build" />
    <Message Text="빌드 조건: '$(BuildCondition)'" Importance="high" />
    <MSBuild Projects="@(ProjectReferences)" 
             Properties="Configuration=%(ProjectReferences.Configuration);Platform=%(ProjectReferences.Platform)" 
             StopOnFirstFailure="true" />
</Target>
 
<Target Name="Rebuild" DependsOnTargets="Clean; Build">
    <Message Text="타겟: Rebuild" />
</Target>
  위의 빌드 스크립트는 별다른 문제가 보이지 않는다. "Rebuild" 에 지정된 "DependsOnTargets" 로 "Clean" 과 "Build" 를 순차적으로 처리하도록 되어 있다.

  그럼 이제 아래의 빌드 스크립트를 확인해 보도록 하자.

<Target Name="Build">
    <Message Text="타겟: Build" />
    <Message Text="빌드 조건: '$(BuildCondition)'" Importance="high" />
 
    <MSBuild Projects="@(ProjectReferences)" 
             Properties="Configuration=%(ProjectReferences.Configuration);Platform=%(ProjectReferences.Platform)" 
             StopOnFirstFailure="true" />
</Target>
 
<Target Name="Rebuild" DependsOnTargets="Clean;">
    <Message Text="타겟: Rebuild" />
    <Message Text="빌드 조건: '$(BuildCondition)'" Importance="high" />
 
    <MSBuild Projects="@(ProjectReferences)" 
             Properties="Configuration=%(ProjectReferences.Configuration);Platform=%(ProjectReferences.Platform)" 
             Targets="Rebuild" 
             StopOnFirstFailure="true" />
</Target>
  위의 빌드 스크립트를 확인해 보면 "Rebuild" 작업이 변경된 것을 확인할 수 있다. 기존과 같이 Clean and Build 가 아니라 Clean and Rebuild 가 된다. 이론적으로는 빌드 스크립트는 문제가 없다. 문제는 솔루션 파일을 Rebuild 를 하는 것인데 이런 경우는 Visual Studio 2008 버전까지 솔루션 빌드가 깨지는 문제가 존재한다는 것이다.

  개인 PC와는 달리 서버의 빌드에서는 항상 Rebuild 작업을 진행한다. 예를 들어 솔루션이 A, B, C, D, DependsOnA_1, DependsOnA_2 로 6개로 구성되었다고 하자. 우선 빌드 시스템은 Core 4개를 가지고 A, B, C, D 를 동시에 빌드할 것이고 각각 Clean 과 Build 작업을 진행할 것이다.

  문제는 의존성이 존재하는 프로젝트인 A_1, A_2 프로젝트로  A_1 이 빌드되는 시점에 참조하고 있는 A 를 Clean 하고 Build 를 하게 된다. 이 시점에 다른 Core 에서 A_2 프로젝트의 빌드를 시작하게 되면 이미 A가 Clean 되어 있는 상태기 때문에 A_1 이 빌드 되는 시점에 A_2 에서 A 를 Clean 해 버리면 A_1 은 참조할 A 가 존재하지 않기 때문에 오류가 발생할 수 밖에는 없는 것이다.

  이런 문제를 해결하는 방법은 Visual Studio로 병렬 빌드를 진행할 경우는 Rebuild 를 하지 않으면 된다. 즉, 전체 프로젝트에 대해서 일괄 Clean 을 하고 일괄 Build 를 하면 문제가 생기지 않는다.

MSBuildTasks 확장

  이 확장은 오픈소스 프로젝트로 다운로드하여 설치를 하면 된다. 관리자에게 빌드 정보를 이메일로 알리거나 레지스트리를 조작하는 경우등을 지원하는 확장 기능을 제공한다. 대략 30여 가지의 기능을 제공하므로 프로젝트 사이트를 통해서 검토해 보는 것이 좋다.

  해당 사이트에 설치하는 방법도 나와 있으므로 참고하도록 한다. 설치가 제대로 완료되면 대 부분의 경우는 "C:\Program Files (x86)\MSBuild\MSBuildCommunityTasks" 폴더에 설치된다. 그럼 이제 빌드 스크립트에서도 사용할 수 있게 된다.

Create ODBC DSN with MSBuildTasks

  데이터베이스에 접근할 경우에 ADO 든 ODBC 든 모두 연결 문자열을 사용하기 때문에 예전과 같이 DSN 을 만들지는 않는다. 그러나 개발된지 오래된 소프트웨어의 경우는 ODBC DSN 을 사용하는 경우가 많다. 유지보수를 위해서 빌드 시스템을 사용하는 경우라면 이런 프로그램을 위해서라도 DSN 관련 처리가 필요할 것이다.

  DSN 은 제어판 > 관리도구 > 데이터원본 (ODBC) 를 통해서 추가하게 된다. 그런데 상황에 따라서 이 DSN 값이 변경이 되어야 한다면 사람이 매번 수정하는 것도 문제기 때문에 빌드 스크립트에서 자동으로 생성하게 되면 더할나위없이 좋을 것이다. DSN 생성에 대해서는 관련문서를 참고하도록 하고 여기서는 간단한 내용을 알아보도록 하자.

  DSN 설정은 레지스트리에 정보가 존재한다. 따랏 MSBuildTasks 를 이용해서 레지스트리를 처리할 수 있도록 적용하여야 한다.

<Project DefaultTargets="Build" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
    <!-- MSBuildTasks 참조 추가 -->
    <Import Project="$(MSBuildExtensionsPath)\MSBuildCommunityTasks\MSBuild.Community.Tasks.Targets"/>
 
    <!-- 생성할 DSN 정보 정의 -->
    <ItemGroup>
        <DSNToCreate Include="Item">
            <Name>DSN_NAME1</Name>
            <Server>DatabaseServer1</Server>
            <Database>InitialCatalog1</Database>
            <Description>ODBC DSN for the Database: DatabaseServer1</Description>
            <Driver>SQL Native Client</Driver>
            <LastUser>sa</LastUser>
            <Trusted_Connection>Yes</Trusted_Connection>
        </DSNToCreate>
        <DSNToCreate Include="Item">
            <Name>DSN_NAME2</Name>
            <Server>DatabaseServer2</Server>
            <Database>InitialCatalog2</Database>
            <Description>ODBC DSN for the Database: DatabaseServer2</Description>
            <Driver>SQL Native Client</Driver>
            <LastUser>sa</LastUser>
            <Trusted_Connection>Yes</Trusted_Connection>
        </DSNToCreate>
    </ItemGroup>
     
    <Target Name="CreateDSN">
        <RegistryRead KeyName="HKEY_LOCAL_MACHINE\SOFTWARE\ODBC\ODBCINST.INI\%(DSNToCreate.Driver)"
                      ValueName="Driver">
            <Output TaskParameter="Value" PropertyName="DriverPath" />
        </RegistryRead>
  
        <Message Text="DriverPath: $(DriverPath)" />
     
        <RegistryWrite KeyName="HKEY_LOCAL_MACHINE\SOFTWARE\ODBC\ODBC.INI\%(DSNToCreate.Name)"
                       ValueName="Server"
                       Value="%(DSNToCreate.Server)" />
        <RegistryWrite KeyName="HKEY_LOCAL_MACHINE\SOFTWARE\ODBC\ODBC.INI\%(DSNToCreate.Name)"
                       ValueName="Database"
                       Value="%(DSNToCreate.Database)" />
        <RegistryWrite KeyName="HKEY_LOCAL_MACHINE\SOFTWARE\ODBC\ODBC.INI\%(DSNToCreate.Name)"
                       ValueName="Description"
                       Value="%(DSNToCreate.Description)" />
        <RegistryWrite KeyName="HKEY_LOCAL_MACHINE\SOFTWARE\ODBC\ODBC.INI\%(DSNToCreate.Name)"
                       ValueName="Driver"
                       Value="$(DriverPath)" />
        <RegistryWrite KeyName="HKEY_LOCAL_MACHINE\SOFTWARE\ODBC\ODBC.INI\%(DSNToCreate.Name)"
                       ValueName="LastUser"
                       Value="%(DSNToCreate.LastUser)" />
        <RegistryWrite KeyName="HKEY_LOCAL_MACHINE\SOFTWARE\ODBC\ODBC.INI\%(DSNToCreate.Name)"
                       ValueName="Trusted_Connection"
                       Value="%(DSNToCreate.Trusted_Connection)" />
        <RegistryWrite KeyName="HKEY_LOCAL_MACHINE\SOFTWARE\ODBC\ODBC.INI\ODBC Data Sources\"
                       ValueName="%(DSNToCreate.Name)"
                       Value="%(DSNToCreate.Driver)" />
    </Target>
 </Project>
  위의 빌드 스크립트를 보면 "<Import>"를 통해서 MSBuildTasks 를 참조하고 있는 것을 볼 수 있고, ItemGroup에는 추가할 ODBC DSN 의 정보를 설정해 놓은 것을 확인 할 수 있다. 이렇게 ItemGroup 을 이용하는 이유는 서버 어플리케이션의 경우는 하나 이상의 DB 서버와 연계를 하여야 하는 경우가 많이 발생하기 때문이다.

  이렇게 설정된 정보를 가지고 "CreateDSN" Target 은 ItemGroup에 설정된 값을 기준으로 레지스트리를 생성하는 작업을 진행하는 것이다. 그리고 "RegistryRead", "RegistryWrite" 는 MSBuildTasks 가 제공하는 기능이다. 여기서 잘 봐야 하는 부분은 %(DSNToCreate.Name) 과 같이 값을 가져오는 것이다. 이를 이해하기 쉽게 코드로 표현을 하면 다음과 같다고 생각하면 된다.

foreach(DSNToCreate item in DSNToCreateArray) {
    RegistryWrite("HKEY_LOCAL_MACHINE\SOFTWARE\ODBC\ODBC.INI\ODBC Data Sources\", item.Name);
}
  이렇게 구성한 build.xml 파일을 "/t:createDSN" 으로 실행을 하면 레지스트리 정보를 처리하는 메시지를 확인할 수 있다.

Delete ODBC DSN with MSBuildTasks

  이번에는 Clean 과정에서 필요할 것이므로 반대로 존재하는 DSN 을 삭제해 보도록 하자. 

<!-- DSN 삭제 -->
<PropertyGroup>
    <DelDSN>
        <![CDATA[
            public static string ScriptMain() {
                System.Collections.Specialized.StringCollection dsnNames = new System.Collections.Specialized.StringCollection();
                dsnNames.Add("MyDSN1");
                dsnNames.Add("MyDSN2");
 
                string returnMsg = string.Empty;
 
                using (Microsoft.Win32.RegistryKey OurKey = Microsoft.Win32.Registry.LocalMachine)
                {
                    foreach (string dsnName in dsnNames)
                    {
                        using (Microsoft.Win32.RegistryKey dataSourcesKey = OurKey.OpenSubKey(@"SOFTWARE\ODBC\ODBC.INI\ODBC Data Sources\", true))
                        {
                            try
                            {
                                dataSourcesKey.DeleteValue(dsnName);
                            }
                            catch (Exception ex)
                            {
                                returnMsg += Environment.NewLine;
                                returnMsg += "While deleting a registry value " + @"SOFTWARE\ODBC\ODBC.INI\ODBC Data Sources\" + dsnName;
                                returnMsg += Environment.NewLine;
                                returnMsg += ex.ToString();
                                returnMsg += Environment.NewLine;
                            }
                        }
 
                        try
                        {
                            OurKey.DeleteSubKeyTree(@"SOFTWARE\ODBC\ODBC.INI\" + dsnName);
                        }
                        catch (Exception ex)
                        {
                            returnMsg += Environment.NewLine;
                            returnMsg += "While deleting a registry key " + @"SOFTWARE\ODBC\ODBC.INI\" + dsnName;
                            returnMsg += Environment.NewLine;
                            returnMsg += ex.ToString();
                            returnMsg += Environment.NewLine;
                        }
                    }
                }
 
                return returnMsg;
            }
        ]]>
    </DelDSN>
</PropertyGroup>
 
<!-- 깔끔하게 정리 -->
<Target Name="CleanDSN">
    <Script Language="C#" Code="$(DelDSN)" Imports="System">
        <Output TaskParameter="ReturnValue" PropertyName="DelDSNResult" />
    </Script>
    <Message Text="DSN deletion: $(DelDSNResult)" />
</Target>
  뭔가 빌드 스크립트가 이전의 처리 방식과 다른 것을 알 수 있다. "CleanDSN" Target 은 MSBuilderTasks 에서 제공하는 Script 기능을 사용하기 때문이다. 이 기능은 .NET Source Code 를 동적으로 수행하여 결과를 반환해 주는 것이다. 즉, "PropertyGroup" 으로 수행할 .NET Source Code 를 등록해 놓고, "<Script>" 의 code 설정을 통해서 해당 코드를 실행하고 출력을 "DelDSNResult" 라는 속성명으로 받는 것이다.

  Script 기능을 잘 활용하면 따로 MSBuild 확장을 만들지 않아도 거의 대부분의 처리를 수행할 수 있다. 다만 소스코드 때문에 빌드 스크립트 파일이 커진다는 것과 지저분해져서 알아 보기가 어렵게 된다는 것이 문제다. 이런 문제는 별도의 빌드 스크립트로 구성하고 "<import>"를 하는 것으로 해결하면 된다. 이렇게 Script 기능을 이용하는 이유는 MSbuildTasks 에서 RegistryDelete 와 같은 기능을 제공하지 않기 때문이다. 

DSN on Wow 64

  64 Wow 시스템은 사람을 놀라게 하는 재주가 있다. 그것도 아주 많이 -_-; 64bit Wow 시스템은 64bit 장비에서 32bit 어플리케이션을 에뮬레이션하기 위해서 등장했고, 나름대로 성공적이었지만 내부적으로는 상당히 어려운 상황을 만들기도 한다. DSN 도 역시 마찬가지의 경우로 빌드는 잘 동작하지만 이렇게 만들어진 DSN 이 실제 어플리케이션에서 제대로 읽혀서 동작하지는 않는다.

  동작하지 않는 이유는 빌드가 혹시 32bit MSBuild를 통해서 진행된 것일 경우에 레지스트리는 64비트용이 아니라 32비트용 레지스트리로 처리가 되기 때문이다. 따라서 64비트 어플리케이션의 입장에서는 레지스트리에 DSN 이 없는 것과 같다. 이런 문제점들에 대해서는 여기 문서를 검토해 볼 필요가 있다.   프로그래밍적인 문제만이 아니라 "제어판 > 관리도구 > 데이터원본 (ODBC)" 도 64비트용이기 때문에 여기서도 DSN 은 찾아 볼 수가 없다. 따라서 "C:\Windows\SysWow64\odbcad32.exe" 를 실행해서 확인을 하여야 한다.

  이렇게 고생하기 싫으면 빌드 스크립트를 구동시킬 때 어플리케이션에 맞는 msbuild 를 사용해야 한다

댓글