Merge pull request #7319 from vritant24/dev/vrbhardw/fakes

Update Documentation with .NET Core support

Author: v-dihans

docs/test/code-generation-compilation-and-naming-conventions-in-microsoft-fakes.md

@@ -16,9 +16,9 @@ This article discusses options and issues in Fakes code generation and compilati
 
 - Visual Studio Enterprise
 - A .NET Framework project
-
-> [!NOTE]
-> .NET Standard projects are not supported.
+::: moniker range=">=vs-2019"
+- .NET Core and SDK-style project support previewed in Visual Studio 2019 Update 6, and is enabled by default in Update 8. For more information, see [Microsoft Fakes for .NET Core and SDK-style projects](/visualstudio/releases/2019/release-notes#microsoft-fakes-for-net-core-and-sdk-style-projects).
+::: moniker-end
 
 ## Code generation and compilation
 

docs/test/isolating-code-under-test-with-microsoft-fakes.md

@@ -27,10 +27,11 @@ Fakes come in two flavors:
 
 - Visual Studio Enterprise
 - A .NET Framework project
-- .NET Core and SDK-style project support is currently in preview. [Read More](/visualstudio/releases/2019/release-notes#microsoft-fakes-for-net-core-and-sdk-style-projects)
+::: moniker range=">=vs-2019"
+- .NET Core and SDK-style project support previewed in Visual Studio 2019 Update 6, and is enabled by default in Update 8. For more information, see [Microsoft Fakes for .NET Core and SDK-style projects](/visualstudio/releases/2019/release-notes#microsoft-fakes-for-net-core-and-sdk-style-projects).
+::: moniker-end
 
 > [!NOTE]
-> - .NET Standard projects are not supported.
 > - Profiling with Visual Studio is not available for tests that use Microsoft Fakes.
 
 ## Choose between stub and shim types
@@ -76,11 +77,15 @@ For a more detailed description, see [Use stubs to isolate parts of your applica
 
 2. **Add Fakes Assembly**
 
-    1. In **Solution Explorer**, expand the test project's reference list. If you are working in Visual Basic, you must choose **Show All Files** in order to see the reference list.
+   1. In **Solution Explorer**, 
+       - For an older .NET Framework Project (non-SDK style), expand your unit test project's **References** node.
+       ::: moniker range=">=vs-2019"
+       - For an SDK-style project targeting .NET Framework or .NET Core, expand the **Dependencies** node to find the assembly you would like to fake under **Assemblies**, **Projects**, or **Packages**.
+       ::: moniker-end
+       - If you're working in Visual Basic, select **Show All Files** in the **Solution Explorer** toolbar to see the **References** node.
+   2. Select the assembly that contains the class definitions for which you want to create shims. For example, if you want to shim **DateTime**, select **System.dll**.
 
-    2. Select the reference to the assembly in which the interface (for example IStockFeed) is defined. On the shortcut menu of this reference, choose **Add Fakes Assembly**.
-
-    3. Rebuild the solution.
+   3. On the shortcut menu, choose **Add Fakes Assembly**.
 
 3. In your tests, construct instances of the stub and provide code for its methods:
 
@@ -239,6 +244,61 @@ System.IO.Fakes.ShimFile.AllInstances.ReadToEnd = ...
 
 You can also create shims for specific instances, for constructors, and for properties. For more information, see [Use shims to isolate your application from other assemblies for unit testing](../test/using-shims-to-isolate-your-application-from-other-assemblies-for-unit-testing.md).
 
+## Using Microsoft Fakes in the CI
+
+### Microsoft Fakes Assembly Generation
+Since Microsoft Fakes requires Visual Studio Enterprise, the generation of Fakes Assemblies requires that you build your project using [Visual Studio Build Task](/azure/devops/pipelines/tasks/build/visual-studio-build?view=azure-devops).
+
+::: moniker range=">=vs-2019"
+> [!NOTE]
+> An alternative to this is to check your Fakes Assemblies into the CI and use the [MSBuild Task](../msbuild/msbuild-task.md?view=vs-2019). When you do this, you need to ensure that you have an assembly reference to the generated Fakes assembly in your test project, similar to the following code snippet :
+
+```xml
+<Project Sdk="Microsoft.NET.Sdk">
+    <ItemGroup>
+        <Reference Include="FakesAssemblies\System.Fakes.dll">
+    </ItemGroup>
+</Project>
+```
+
+This reference is required to be added in manually specifically SDK-style projects (.NET Core and .NET Framework) because we have moved to implicitly adding assembly references to your test project. If you follow this method, you need to ensure that the fakes assembly is updated when the parent assembly changes.
+::: moniker-end
+
+### Running Microsoft Fakes tests
+As long as Microsoft Fakes assemblies are present in the configured `FakesAssemblies` directory (The default being `$(ProjectDir)FakesAssemblies`), you can run tests using the [vstest task](/azure/devops/pipelines/tasks/test/vstest?view=azure-devops).
+
+::: moniker range=">=vs-2019"
+Distributed testing with the [vstest task](/azure/devops/pipelines/tasks/test/vstest?view=azure-devops) .NET Core projects using Microsoft Fakes requires Visual Studio 2019 Update 9 Preview `20201020-06` and higher.
+::: moniker-end
+
+::: moniker range=">=vs-2019"
+## Transitioning your .NET Framework test projects that use Microsoft Fakes to SDK-style .NET Framework or .NET Core projects
+You will need minimal changes in your .NET Framework set up for Microsoft Fakes to transition to .NET Core. The cases that you would have to consider are:
+- If you are using a custom project template, you need to ensure that it is SDK-style and builds for a compatible target framework.
+- Certain types exist in different assemblies in .NET Framework and .NET Core (for example, `System.DateTime` exists in `System`/`mscorlib` in .NET Framework, and in `System.Runtime` in .NET Core), and in these scenarios you need to change the assembly being faked.
+- If you have an assembly reference to a fakes assembly and the test project, you might see a build warning about a missing reference similar to:
+  ```
+  (ResolveAssemblyReferences target) ->
+  warning MSB3245: Could not resolve this reference. Could not locate the assembly "AssemblyName.Fakes". Check to make sure the assembly exists on disk.
+  If this reference is required by your code, you may get compilation errors.
+  ```
+  This warning is due to necessary changes made in Fakes generation can be ignored. It can be avoided by removing the assembly reference from the project file, because we now implicitly add them during the build.
+::: moniker-end
+
+## Microsoft Fakes support 
+### Microsoft Fakes in older projects targeting .NET Framework (non-SDK style).
+- Microsoft Fakes assembly generation is supported in Visual Studio Enterprise 2015 and higher.
+- Microsoft Fakes tests can run with all available Microsoft.TestPlatform NuGet packages.
+- Code coverage is supported for test projects using Microsoft Fakes in Visual Studio Enterprise 2015 and higher.
+
+### Microsoft Fakes in SDK-style .NET Framework and .NET Core projects
+- Microsoft Fakes assembly generation previewed in Visual Studio Enterprise 2019 Update 6 and is enabled by default in Update 8.
+- Microsoft Fakes tests for projects that target .NET Framework can run with all available Microsoft.TestPlatform NuGet packages.
+- Microsoft Fakes tests for projects that target .NET Core can run with Microsoft.TestPlatform NuGet packages with versions [16.8.0-preview-20200921-01](https://www.nuget.org/packages/Microsoft.TestPlatform/16.8.0-preview-20200921-01) and higher.
+- Code coverage is supported for test projects targeting .NET Framework using Microsoft Fakes in Visual Studio Enterprise version 2015 and higher.
+- Code coverage support for test projects targeting .NET Core using Microsoft Fakes is under development.
+
+
 ## In this section
 [Use stubs to isolate parts of your application from each other for unit testing](../test/using-stubs-to-isolate-parts-of-your-application-from-each-other-for-unit-testing.md)
 

docs/test/using-shims-to-isolate-your-application-from-other-assemblies-for-unit-testing.md

@@ -22,9 +22,9 @@ For an overview and "quick start" guidance, see [Isolate code under test with Mi
 
 - Visual Studio Enterprise
 - A .NET Framework project
-
-> [!NOTE]
-> .NET Standard projects are not supported.
+::: moniker range=">=vs-2019"
+- .NET Core and SDK-style project support previewed in Visual Studio 2019 Update 6, and is enabled by default in Update 8. For more information, see [Microsoft Fakes for .NET Core and SDK-style projects](/visualstudio/releases/2019/release-notes#microsoft-fakes-for-net-core-and-sdk-style-projects).
+::: moniker-end
 
 ## Example: The Y2K bug
 
@@ -61,9 +61,12 @@ using (ShimsContext.Create()) {
 
 First, add a Fakes assembly:
 
-1. In **Solution Explorer**, expand your unit test project's **References** node.
-
-   - If you're working in Visual Basic, select **Show All Files** in the **Solution Explorer** toolbar in order to see the **References** node.
+1. In **Solution Explorer**, 
+    - For an older .NET Framework Project (non-SDK style), expand your unit test project's **References** node.
+    ::: moniker range=">=vs-2019"
+    - For an SDK-style project targeting .NET Framework or .NET Core, expand the **Dependencies** node to find the assembly you would like to fake under **Assemblies**, **Projects**, or **Packages**.
+    ::: moniker-end
+    - If you're working in Visual Basic, select **Show All Files** in the **Solution Explorer** toolbar to see the **References** node.
 
 2. Select the assembly that contains the class definitions for which you want to create shims. For example, if you want to shim **DateTime**, select **System.dll**.
 
@@ -514,7 +517,7 @@ System.Fakes.ShimEnvironment.GetCommandLineArgsGet = ...
 
 ## Limitations
 
-Shims cannot be used on all types from the .NET base class library **mscorlib** and **System**.
+Shims cannot be used on all types from the .NET base class library **mscorlib** and **System** in .NET Framework, and in **System.Runtime** in .NET Core.
 
 ## See also
 

docs/test/using-stubs-to-isolate-parts-of-your-application-from-each-other-for-unit-testing.md

@@ -141,11 +141,14 @@ To use stubs, you must first generate stub types from the interface definitions.
 
 #### Add a Fakes Assembly
 
-1. In **Solution Explorer**, expand your unit test project's **References**.
-
-   If you're working in Visual Basic, select **Show All Files** in the **Solution Explorer** toolbar in order to see the **References** node.
-
-2. Select the assembly that contains the interface definitions for which you want to create stubs.
+1. In **Solution Explorer**, 
+    - For an older .NET Framework Project (non-SDK style), expand your unit test project's **References** node.
+    ::: moniker range=">=vs-2019"
+    - For an SDK-style project targeting .NET Framework or .NET Core, expand the **Dependencies** node to find the assembly you would like to fake under **Assemblies**, **Projects**, or **Packages**.
+    ::: moniker-end
+    - If you're working in Visual Basic, select **Show All Files** in the **Solution Explorer** toolbar to see the **References** node.
+
+2. Select the assembly that contains the class definitions for which you want to create shims. For example, if you want to shim **DateTime**, select **System.dll**.
 
 3. On the shortcut menu, choose **Add Fakes Assembly**.