Microsoft Fakes의 코드 생성, 컴파일 및 명명 규칙
이 아티클에서는 Fakes 코드 생성 및 컴파일의 옵션과 문제에 대해 설명하고 Fakes 생성 형식, 멤버 및 매개 변수에 대한 명명 규칙을 설명합니다.
요구 사항
Visual Studio Enterprise
.NET Framework 프로젝트
Visual Studio 2019 업데이트 6에서 미리 보기로 제공한 .NET Core, .NET 5.0 이상 및 SDK 스타일 프로젝트 지원은 업데이트 8에서 기본적으로 사용하도록 설정되어 있습니다. 자세한 내용은 .NET Core 및 SDK 스타일 프로젝트용 Microsoft Fakes를 참조하세요.
코드 생성 및 컴파일
스텁의 코드 생성 구성
스텁 형식의 생성은 .fakes 파일 확장명을 가진 XML 파일에서 구성됩니다. Fakes 프레임워크는 사용자 지정 MSBuild 작업을 통해 빌드 프로세스에서 통합되고 빌드 시 해당 파일을 검색합니다. Fakes 코드 생성기는 스텁 형식을 어셈블리로 컴파일하고 프로젝트에 대한 참조를 추가합니다.
다음 예제에서는 FileSystem.dll에 정의된 스텁 형식을 보여 줍니다.
<Fakes xmlns="http://schemas.microsoft.com/fakes/2011/">
<Assembly Name="FileSystem"/>
</Fakes>
형식 필터링
.fakes 파일에서 필터를 설정하여 스텁해야 하는 형식을 제한할 수 있습니다. StubGeneration 요소 아래에 Clear, Add, Remove 요소를 무제한으로 추가하여 선택한 형식 목록을 빌드할 수 있습니다.
예를 들어 다음의 .fakes 파일은 형식에 대한 스텁을 System 및 System.IO 네임스페이스에 생성하지만 System에서 "Handle"을 포함하는 형식은 제외합니다.
<Fakes xmlns="http://schemas.microsoft.com/fakes/2011/">
<Assembly Name="mscorlib" />
<!-- user code -->
<StubGeneration>
<Clear />
<Add Namespace="System!" />
<Add Namespace="System.IO!"/>
<Remove TypeName="Handle" />
</StubGeneration>
<!-- /user code -->
</Fakes>
필터 문자열은 간단한 문법을 사용하여 일치를 수행하는 방법을 정의합니다.
필터는 기본적으로 대/소문자를 구분하지 않으며 부분 문자열 일치를 수행합니다.
el는 "hello"와 일치합니다.필터의 끝에
!를 추가하여 정확하게 대/소문자를 구분하여 일치하도록 합니다.el!는 "hello"와 일치하지 않습니다.hello!는 "hello"와 일치합니다.필터의 끝에
*를 추가하여 문자열의 접두사가 일치하도록 합니다.el*는 "hello"와 일치하지 않습니다.he*는 "hello"와 일치합니다.세미콜론으로 구분된 목록의 여러 필터는 분리로 결합됩니다.
el;wo는 "hello" 및 "world"와 일치합니다.
구체적인 클래스 및 가상 메서드 스텁
기본적으로 스텁 형식은 봉인되지 않은 모든 클래스에 대해 생성됩니다. .fakes 구성 파일을 통해 스텁 형식을 추상 클래스로 제한할 수 있습니다.
<Fakes xmlns="http://schemas.microsoft.com/fakes/2011/">
<Assembly Name="mscorlib" />
<!-- user code -->
<StubGeneration>
<Types>
<Clear />
<Add AbstractClasses="true"/>
</Types>
</StubGeneration>
<!-- /user code -->
</Fakes>
내부 형식
Fakes 코드 생성기는 생성된 Fakes 어셈블리에 표시되는 형식에 대해 shim 형식 및 스텁 형식을 생성합니다. Fakes에 표시되는 shim된 어셈블리 및 테스트 어셈블리의 내부 형식을 만들려면 생성된 Fakes 어셈블리 및 테스트 어셈블리에 표시 유형을 지정하는 shim된 어셈블리 코드에 InternalsVisibleToAttribute 특성을 추가합니다. 예를 들면 다음과 같습니다.
// FileSystem\AssemblyInfo.cs
[assembly: InternalsVisibleTo("FileSystem.Fakes")]
[assembly: InternalsVisibleTo("FileSystem.Tests")]
강력한 이름이 지정된 어셈블리의 내부 형식
shim된 어셈블리에 강력한 이름을 지정하고 어셈블리의 내부 형식에 액세스하려는 경우:
테스트 어셈블리와 Fakes 어셈블리에 모두 강력한 이름을 지정해야 합니다.
테스트 및 Fakes 어셈블리의 공용 키를 shim된 어셈블리의 InternalsVisibleToAttribute 특성에 추가합니다. 다음은 shim된 어셈블리에 강력한 이름을 지정할 경우 shim된 어셈블리 코드의 예제 특성이 표시되는 모양입니다.
// FileSystem\AssemblyInfo.cs [assembly: InternalsVisibleTo("FileSystem.Fakes", PublicKey=<Fakes_assembly_public_key>)] [assembly: InternalsVisibleTo("FileSystem.Tests", PublicKey=<Test_assembly_public_key>)]
shim된 어셈블리에 강력한 이름을 지정하는 경우 Fake 프레임워크는 생성된 Fake 어셈블리에 자동으로 강력하게 서명합니다. 테스트 어셈블리에 강력하게 서명해야 합니다. 강력한 이름의 어셈블리를 참조하세요.
Fakes 프레임워크는 동일한 키를 사용하여 생성된 모든 어셈블리에 서명하므로 이 코드 조각을 시작 지점으로 사용하여 fakes 어셈블리에 대한 InternalsVisibleTo 특성을 shim된 어셈블리 코드에 추가할 수 있습니다.
[assembly: InternalsVisibleTo("FileSystem.Fakes, PublicKey=0024000004800000940000000602000000240000525341310004000001000100e92decb949446f688ab9f6973436c535bf50acd1fd580495aae3f875aa4e4f663ca77908c63b7f0996977cb98fcfdb35e05aa2c842002703cad835473caac5ef14107e3a7fae01120a96558785f48319f66daabc862872b2c53f5ac11fa335c0165e202b4c011334c7bc8f4c4e570cf255190f4e3e2cbc9137ca57cb687947bc")]
대체 키를 KeyFile 특성 값으로 .fakes 파일의 Fakes\Compilation 요소에 포함하는 .snk 파일의 전체 경로를 지정하면 shim된 어셈블리에 대해 만든 키와 같은 다른 공용 키를 Fakes 어셈블리에 지정할 수 있습니다. 예시:
<-- FileSystem.Fakes.fakes -->
<Fakes ...>
<Compilation KeyFile="full_path_to_the_alternate_snk_file" />
</Fakes>
그런 다음 대체 .snk 파일의 공용 키를 Fakes 어셈블리에 대한 InternalVisibleTo 특성의 두 번째 매개 변수로 shim된 어셈블리 코드에서 사용해야 합니다.
// FileSystem\AssemblyInfo.cs
[assembly: InternalsVisibleTo("FileSystem.Fakes",
PublicKey=<Alternate_public_key>)]
[assembly: InternalsVisibleTo("FileSystem.Tests",
PublicKey=<Test_assembly_public_key>)]
위의 예제에서 Alternate_public_key 및 Test_assembly_public_key 값은 같을 수 있습니다.
빌드 시간 최적화
Fakes 어셈블리를 컴파일하면 빌드 시간이 현저하게 길어질 수 있습니다. .NET 시스템 어셈블리 및 타사 어셈블리에 대한 Fakes 어셈블리를 별도의 중앙 집중식 프로젝트에 생성하면 빌드 시간을 최소화할 수 있습니다. 이러한 어셈블리는 컴퓨터에서 거의 변경되지 않으므로 생성된 Fakes 어셈블리를 다른 프로젝트에서 다시 사용할 수 있습니다.
단위 테스트 프로젝트에서 프로젝트 폴더의 FakesAssemblies 아래에 배치된 컴파일된 Fakes 어셈블리에 대한 참조를 추가합니다.
테스트 프로젝트와 일치하는 .NET 런타임 버전을 사용하여 새 클래스 라이브러리를 만듭니다. 이 라이브러리를 Fakes.Prebuild라고 하겠습니다. 프로젝트에서 필요 없는 class1.cs 파일을 제거합니다.
Fakes가 필요한 모든 시스템 및 타사 어셈블리에 대한 참조를 추가합니다.
각 어셈블리에 대한 .fakes 파일을 추가하고 빌드합니다.
테스트 프로젝트에서 다음을 수행합니다.
Fakes 런타임 DLL에 대한 참조가 있는지 확인합니다.
%ProgramFiles(x86)%\Microsoft Visual Studio\2017\Enterprise\Common7\IDE\PublicAssemblies\Microsoft.QualityTools.Testing.Fakes.dll
Fakes를 만든 각 어셈블리에 대해 프로젝트의 Fakes.Prebuild\FakesAssemblies 폴더에서 해당 DLL 파일에 대한 참조를 추가합니다.
어셈블리 이름 충돌 방지
팀 빌드 환경에서는 모든 빌드 출력이 단일 디렉터리에 병합됩니다. 여러 프로젝트가 Fakes를 사용하는 경우 서로 다른 버전의 Fakes 어셈블리가 서로를 재정의할 수 있습니다. 예를 들어 .NET Framework 2.0의 TestProject1 fakes mscorlib.dll과 .NET Framework 4의 TestProject2 fakes mscorlib.dll 모두 mscorlib.Fakes.dll Fakes 어셈블리를 생성할 수 있습니다.
이 문제를 방지하려면 Fakes가 .fakes 파일을 추가할 때 프로젝트 이외 참조에 대해 버전 정규화된 Fakes 어셈블리 이름을 자동으로 만들어야 합니다. 버전 정규화된 Fakes 어셈블리 이름은 Fakes 어셈블리 이름을 만들 때 버전 번호를 포함합니다.
어셈블리에 MyAssembly 및 버전 1.2.3.4를 지정하는 경우 Fakes 어셈블리 이름은 MyAssembly.1.2.3.4.Fakes입니다.
이 버전은 .fakes에서 어셈블리 요소의 버전 특성을 편집하여 변경하거나 제거할 수 있습니다.
attribute of the Assembly element in the .fakes:
<Fakes ...>
<Assembly Name="MyAssembly" Version="1.2.3.4" />
...
</Fakes>
Fakes 명명 규칙
shim 형식 및 스텁 형식 명명 규칙
네임스페이스
네임스페이스에 .Fakes 접미사를 추가합니다.
예를 들어
System.Fakes네임스페이스에는 System 네임스페이스의 shim 형식이 포함됩니다.Global.Fakes에는 빈 네임스페이스의 shim 형식이 포함됩니다.
형식 이름
Shim 접두사를 형식 이름에 추가하여 shim 형식 이름을 작성합니다.
예를 들어 ShimExample은 Example 형식의 shim 형식입니다.
스텁 접두사를 형식 이름에 추가하여 스텁 형식 이름을 작성합니다.
예를 들어 StubIExample은 IExample 형식의 스텁 형식입니다.
형식 인수 및 중첩된 형식 구조
제네릭 형식 인수가 복사됩니다.
중첩된 형식 구조는 shim 형식에 대해 복사됩니다.
shim 대리자 속성 또는 스텁 대리자 필드 명명 규칙
필드 명명에 대한 기본 규칙이며, 빈 이름에서 시작합니다.
메서드 이름을 추가합니다.
메서드 이름이 명시적 인터페이스 구현인 경우 점이 제거됩니다.
메서드가 제네릭인 경우
Ofn이 추가됩니다. 여기서 n은 제네릭 메서드 인수 수입니다.getter 또는 setter 속성과 같은 특수 메서드 이름은 다음 표에 설명된 대로 처리됩니다.
| 메서드 특성... | 예시 | 추가되는 메서드 이름 |
|---|---|---|
| 생성자 | .ctor |
Constructor |
| 정적 생성자 | .cctor |
StaticConstructor |
| 메서드 이름이 "_"로 구분되는 두 부분으로 구성된 접근자(예: 속성 getter) | kind_name(일반적인 경우이지만 ECMA에 의해 강제되지 않음) | NameKind, 여기서 두 부분이 대문자로 처리되고 교환됨 |
Prop 속성의 getter |
PropGet |
|
Prop 속성의 setter |
PropSet |
|
| 이벤트 adder | Add |
|
| 이벤트 remover | Remove |
|
| 두 부분으로 구성된 연산자 | op_name |
NameOp |
| 예: + 연산자 | op_Add |
AddOp |
| 변환 연산자의 경우 반환 형식이 추가됩니다. | T op_Implicit |
ImplicitOpT |
참고 항목
- 인덱서의 getter 및 setter는 속성과 유사하게 처리됩니다. 인덱서의 기본 이름은
Item입니다. - 매개 변수 형식 이름은 변형되고 연결됩니다.
- 반환 형식은 오버로드 모호성이 제거될 때까지 무시됩니다. 오버로드 모호성이 있는 경우 반환 형식은 이름의 끝에 추가됩니다.
매개 변수 형식 명명 규칙
| 조건 | 추가되는 문자열... |
|---|---|
형식T |
T 네임스페이스, 중첩 구조 및 제네릭 tics가 삭제됩니다. |
out 매개 변수out T |
TOut |
ref 매개 변수ref T |
TRef |
배열 형식T[] |
TArray |
다차원 배열 형식 T[ , , ] |
T3 |
포인터 형식 T* |
TPtr |
제네릭 형식T<R1, ...> |
TOfR1 |
C<TType> 형식의 제네릭 형식 인수!i |
Ti |
M<MMethod> 메서드의 제네릭 메서드 인수!!i |
Mi |
중첩 형식N.T |
N이 추가된 다음 T |
재귀적 규칙
다음 규칙은 재귀적으로 적용됩니다.
Fakes는 C#을 사용하여 Fakes 어셈블리를 생성하므로 잘못된 C# 토큰을 생성하는 모든 문자는 "_"(밑줄)로 이스케이프됩니다.
결과 이름이 선언 형식의 멤버와 충돌하는 경우 01부터 시작하는 두 자리 카운터를 추가하여 번호 매기기 구성표를 사용합니다.
연속 통합에서 Microsoft Fakes 활용
Microsoft Fakes 어셈블리 생성
Microsoft Fakes는 Visual Studio Enterprise에서만 사용할 수 있는 기능입니다. 따라서 Fakes 어셈블리를 생성하려면 프로젝트를 빌드할 때 Visual Studio 빌드 작업을 사용해야 합니다.
참고 항목
대체할 수 있는 전략에는 Fakes 어셈블리를 CI(연속 통합) 시스템에 직접 검사하고 MSBuild 작업을 활용하는 것이 포함됩니다. 이 방법을 선택하는 경우 다음 코드 조각과 같이 생성된 Fakes 어셈블리에 대한 어셈블리 참조를 테스트 프로젝트에 포함해야 합니다.
<Project Sdk="Microsoft.NET.Sdk">
<ItemGroup>
<Reference Include="FakesAssemblies\System.Fakes.dll"/>
</ItemGroup>
</Project>
이러한 프로젝트는 이제 어셈블리 참조를 암시적으로 추가하기 때문에 이 참조는 특히 SDK 스타일 프로젝트(예: .NET Core, .NET 5+ 및 .NET Framework)에 수동으로 추가해야 합니다. 이 메서드를 사용하려는 경우 부모 어셈블리가 변경될 때마다 Fakes 어셈블리를 업데이트해야 합니다.
관련 콘텐츠
피드백
출시 예정: 2024년 내내 콘텐츠에 대한 피드백 메커니즘으로 GitHub 문제를 단계적으로 폐지하고 이를 새로운 피드백 시스템으로 바꿀 예정입니다. 자세한 내용은 다음을 참조하세요. https://aka.ms/ContentUserFeedback
다음에 대한 사용자 의견 제출 및 보기