msbuild의 Exec Task에 robocopy를 사용하는 방법
robocopy를 msbuild의 Exec Task에 추가해 볼까요? ^^
실습을 위해 .NET Core(또는 5+) 프로젝트를 만들고 csproj 파일에서 다음과 같이 빌드 후에 실행할 수 있는 Task를 하나 정의합니다.
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<OutputType>Exe</OutputType>
<TargetFramework>net5.0</TargetFramework>
</PropertyGroup>
<Target Name="MyAfterBuild" AfterTargets="CoreBuild">
<Message Importance="high" Text="AfterBuild: $(ProjectDir)$(OutDir)" />
</Target>
</Project>
실제로 정의한 Task가 실행되는지 저렇게 Message 작업으로 "Importance" 값을 "High"로 두고 테스트할 수 있습니다. 이와 함께 내부 작업에서 사용하는 Property/Item 이름을 함께 확인해 주면 디버깅에 도움이 됩니다. 위와 같이 설정하고, 빌드를 해보면 다음과 같은 출력 결과를 확인할 수 있습니다.
Rebuild started...
Restored C:\temp\ConsoleApp1\ConsoleApp1\ConsoleApp1.csproj (in 2 ms).
1>------ Rebuild All started: Project: ConsoleApp1, Configuration: Debug Any CPU ------
1>You are using a preview version of .NET. See: https://aka.ms/dotnet-core-preview
1>ConsoleApp1 -> C:\temp\ConsoleApp1\ConsoleApp1\bin\Debug\ConsoleApp1.dll
1>AfterBuild: C:\temp\ConsoleApp1\ConsoleApp1\bin\Debug\
========== Rebuild All: 1 succeeded, 0 failed, 0 skipped ==========
자, 그럼 빌드 결과물을 별도의 디렉터리로 robocopy를 이용해 복사해 볼까요? ^^
<Target Name="MyAfterBuild" AfterTargets="CoreBuild">
<Message Importance="high" Text="AfterBuild: $(ProjectDir)$(OutDir)" />
<Exec Command="robocopy $(ProjectDir)$(OutDir) c:\temp *.* /S" />
</Target>
빌드하면, c:\temp 디렉터리에 정상적으로 복사가 되었지만 빌드 실패를 알리는 메시지가 나옵니다.
Error MSB3073 The command "robocopy c:\temp\ConsoleApp1\ConsoleApp1\bin\Debug\ c:\temp *.* /S" exited with code 1.
왜냐하면, 이전에도 설명한 것처럼 robocopy는 복사가 되었을 때 exit code가 0이 아니기 때문입니다.
Build Events에 robocopy 작업이 있는 경우 "VCEnd exited with code 3" 오류 발생
; https://www.sysnet.pe.kr/2/0/1813
즉, 우리가 실습한 경우에는 robocopy가 exit code를 1을 반환한 것입니다. 이 오류를 없애려면, 위의 글에서 했던 것처럼 강제로 "exit 0" 처리를 해줘야 합니다.
Exec Task에서 이런 처리를 할 수 있는 방법으로 2가지 정도가 있습니다.
msbuild fails with successful robocopy exit code
; https://stackoverflow.com/questions/39795328/msbuild-fails-with-successful-robocopy-exit-code
우선 한 줄로 처리할 수 있는 방법이 선호될 테지만,
<Exec Command="(robocopy $(ProjectDir)$(OutDir) c:\temp /MIR) ^& IF %ERRORLEVEL% LEQ 1 exit 0" />
그래도 Error task 사용법도 익힐 겸 다음의 코드도 살펴볼까요?
<Exec ContinueOnError="true" Command="robocopy $(ProjectDir)$(OutDir) c:\temp /MIR">
<Output TaskParameter="ExitCode" PropertyName="CopyErrorCode"/>
</Exec>
<Error Condition="$(CopyErrorCode) > 8" Text="Robocopy failed"/>
그런데 위와 같은 상태로 빌드하면 다음과 같은 경고 메시지가 빌드에 남습니다.
1>C:\temp\ConsoleApp1\ConsoleApp1\ConsoleApp1.csproj(12,9): warning MSB3073: The command "robocopy C:\temp\ConsoleApp1\ConsoleApp1\bin\Debug\ c:\temp /MIR" exited with code 1.
1>C:\temp\ConsoleApp1\ConsoleApp1\ConsoleApp1.csproj(12,9): warning MSB4181: The "Exec" task returned false but did not log an error.
1>Done building project "ConsoleApp1.csproj".
왠지 기분 나쁩니다. ^^; 따라서 어차피 에러 상황은 Error Task에서 판정해 주기 때문에 저 오류 메시지가 발생하지 않도록 IgnoreExitCode 설정도 함께 추가하는 것이 좋습니다.
<Exec ContinueOnError="true" IgnoreExitCode="true" Command="robocopy $(ProjectDir)$(OutDir) c:\temp /MIR">
<Output TaskParameter="ExitCode" PropertyName="CopyErrorCode"/>
</Exec>
<Error Condition="$(CopyErrorCode) > 8" Text="Robocopy failed"/>
어떤 경우에는 robocopy를 사용 시 다음과 같은 식으로 오류가 발생합니다.
Rebuild started...
1>------ Rebuild All started: Project: ConsoleApp1, Configuration: Debug Any CPU ------
Restored C:\my work\ConsoleApp1\ConsoleApp1.csproj (in 2 ms).
1>You are using a preview version of .NET. See: https://aka.ms/dotnet-core-preview
1>ConsoleApp1 -> C:\my work\ConsoleApp1\bin\Debug\net5.0\ConsoleApp1.dll
1>AfterBuild: C:\my work\ConsoleApp1\bin\Debug\net5.0\
1>
1>-------------------------------------------------------------------------------
1> ROBOCOPY :: Robust File Copy for Windows
1>-------------------------------------------------------------------------------
1>
1> Started : 17 7월 2021 오전 11:44:53
1> Source - C:\my\
1> Dest - C:\my work\ConsoleApp1\work\ConsoleApp1\bin\Debug\net5.0\
1>
1> Files :
1> Options : /DCOPY:DA /COPY:DAT /R:1000000 /W:30
1>
1>------------------------------------------------------------------------------
1>
1>EXEC : warning : Invalid Parameter #3 : "c:\temp"
1>
1> Simple Usage :: ROBOCOPY source destination /MIR
1>
1> source :: Source Directory (drive:\path or \\server\share\path).
1> destination :: Destination Dir (drive:\path or \\server\share\path).
1> /MIR :: Mirror a complete directory tree.
1>
1> For more usage information run ROBOCOPY /?
1>
1>
1>**** /MIR can DELETE files as well as copy them !
1>C:\my work\ConsoleApp1\ConsoleApp1.csproj(15,9): error : Robocopy failed
1>Done building project "ConsoleApp1.csproj" -- FAILED.
========== Rebuild All: 0 succeeded, 1 failed, 0 skipped ==========
robocopy가 해석한 Source와 Dest 경로가 좀 이상한데요, 왜냐하면, "robocopy
$(ProjectDir)
$(OutDir) c:\temp /MIR"에서 "$(ProjectDir)"에 공백이 있기 때문입니다. (위의 경우는 프로젝트 디렉터리가 "c:\my work"에 위치합니다.)
이런 경우는, 디렉터리를 큰따옴표로 감싸야 하는데, msbuild에는 escape를 16진수로 쓰는 방법이 있습니다. 따라서 큰따옴표(")에 대한 16진수 ascii 코드인 %22를 사용해 다음과 같이 경로를 감쌀 수 있습니다.
<Exec ContinueOnError="true" IgnoreExitCode="true" Command="robocopy %22$(ProjectDir)$(OutDir)%22 c:\temp /MIR">
<Output TaskParameter="ExitCode" PropertyName="CopyErrorCode"/>
</Exec>
그런데, 이렇게 하면 이제 다음과 같은 오류가 발생합니다.
1>------ Rebuild All started: Project: ConsoleApp1, Configuration: Debug Any CPU ------
Restored C:\my work\ConsoleApp1\ConsoleApp1.csproj (in 2 ms).
1>You are using a preview version of .NET. See: https://aka.ms/dotnet-core-preview
1>ConsoleApp1 -> C:\my work\ConsoleApp1\bin\Debug\net5.0\ConsoleApp1.dll
1>AfterBuild: C:\my work\ConsoleApp1\bin\Debug\net5.0\
1>
1>-------------------------------------------------------------------------------
1> ROBOCOPY :: Robust File Copy for Windows
1>-------------------------------------------------------------------------------
1>
1> Started : 17 7월 2021 오후 12:32:51
1> Source : C:\my work\ConsoleApp1\bin\Debug\net5.0" c:\temp \MIR\
1> Dest -
1>
1> Files : *.*
1>
1> Options : *.* /DCOPY:DA /COPY:DAT /R:1000000 /W:30
1>
1>------------------------------------------------------------------------------
1>
1>EXEC : warning : No Destination Directory Specified.
1>
1> Simple Usage :: ROBOCOPY source destination /MIR
1>
1> source :: Source Directory (drive:\path or \\server\share\path).
1> destination :: Destination Dir (drive:\path or \\server\share\path).
1> /MIR :: Mirror a complete directory tree.
1>
1> For more usage information run ROBOCOPY /?
1>
1>
1>**** /MIR can DELETE files as well as copy them !
1>C:\my work\ConsoleApp1\ConsoleApp1.csproj(15,9): error : Robocopy failed
1>Done building project "ConsoleApp1.csproj" -- FAILED.
여전히 robocopy는 Source와 Dest 디렉터리에 대한 잘못된 해석을 하고 있습니다. Source와 Dest에 지정한 실제 경로를 다시 잘 살펴보면,
Source: C:\my work\ConsoleApp1\bin\Debug\net5.0\
Destk: c:\temp
Source의 경우 끝에 역슬래시('\') 문자가 하나 더 들어 있어 그것이 큰따옴표와 이어지면서 escape 역할을 해 '\"' 문자열이 단일하게 큰따옴표(") 문자로 해석된 듯합니다. 따라서 이런 경우에는 역슬래시를 없애면 되는데요, 이것을 하려면 별도로 Trim 함수 등을 호출해야 하기 때문에 사용법만 더 복잡해집니다. 대신 마지막에 '\' 문자를 두지 않으면서 경로를 변조하지 않을 수 있는 '.'을 함께 쓰는 우회 방법을 선택할 수 있습니다.
<Exec ContinueOnError="true" IgnoreExitCode="true" Command="robocopy %22$(ProjectDir)$(OutDir).%22 c:\temp /MIR">
<Output TaskParameter="ExitCode" PropertyName="CopyErrorCode"/>
</Exec>
(
첨부 파일은 이 글의 예제 프로젝트를 포함합니다.)
참고로, %22 표기는 "로 대체할 수 있습니다.
<Exec ContinueOnError="true" IgnoreExitCode="true" Command="robocopy %22$(ProjectDir)$(OutDir)." c:\temp /MIR">
<Output TaskParameter="ExitCode" PropertyName="CopyErrorCode"/>
</Exec>
[이 글에 대해서 여러분들과 의견을 공유하고 싶습니다. 틀리거나 미흡한 부분 또는 의문 사항이 있으시면 언제든 댓글 남겨주십시오.]