Izolowanie testowanego kodu za pomocą struktury Microsoft FakesIsolate code under test with Microsoft Fakes

Microsoft Fakes pomaga w izolowaniu kodu testowanego przez zastąpienie innych części aplikacji przy użyciu wycinków lub podkładki.Microsoft Fakes helps you isolate the code you are testing by replacing other parts of the application with stubs or shims. Są to małe fragmenty kodu, będące pod kontrolą Twoich testów.These are small pieces of code that are under the control of your tests. Izolując kod do testowania, wiesz, że jeśli test wypadnie niepomyślnie, przyczyna leży tam, a nie w żadnym innym miejscu.By isolating your code for testing, you know that if the test fails, the cause is there and not somewhere else. Podkładki i wycinki pozwalają na testowanie kodu, nawet jeśli pozostałe części aplikacji jeszcze nie działają.Stubs and shims also let you test your code even if other parts of your application are not working yet.

Podróbki występują w dwóch wersjach:Fakes come in two flavors:

  • A wycinka zamieniają klasy za pomocą małych substytutów, która implementuje ten interfejs.A stub replaces a class with a small substitute that implements the same interface. Aby użyć wycinków, należy tak zaprojektować aplikację, aby każdy składnik zależał jedynie od interfejsów, a nie od innych składników.To use stubs, you have to design your application so that each component depends only on interfaces, and not on other components. (Przez „składnik” rozumie się klasy lub grupy klas, które są zaprojektowane i aktualizowane łącznie i zwykle są zawarte w zestawie).(By "component" we mean a class or group of classes that are designed and updated together and typically contained in an assembly.)

  • A podkładki modyfikuje skompilowany kod aplikacji w czasie wykonywania, aby zamiast wywołania określonej metody wykonywała kod podkładki, który zawiera test.A shim modifies the compiled code of your application at run time so that instead of making a specified method call, it runs the shim code that your test provides. Podkładki może służyć do zastępowania wywołań do zestawów, których nie można modyfikować, takich jak zestawy .NET.Shims can be used to replace calls to assemblies that you cannot modify, such as .NET assemblies.

Substytuty zastąpić inne składniki

WymaganiaRequirements

  • Visual Studio EnterpriseVisual Studio Enterprise
  • Projekt programu .NET FrameworkA .NET Framework project

Note

  • Projekty .NET standard nie są obsługiwane..NET Standard projects are not supported.
  • Profilowanie za pomocą programu Visual Studio nie jest dostępne dla testów korzystających z elementów sztucznych firmy Microsoft.Profiling with Visual Studio is not available for tests that use Microsoft Fakes.

Wybór między typami podkładek i wycinkówChoose between stub and shim types

Projekt Visual Studio zazwyczaj zostanie zakwalifikowany jako składnik, ponieważ klasy te są opracowywane i aktualizowane równocześnie.Typically, you would consider a Visual Studio project to be a component, because you develop and update those classes at the same time. Można rozważyć użycie wycinków i podkładek do wywołań, które dany projekt kieruje w stronę innych projektów w rozwiązaniu, lub w stronę innych zestawów, do których projekt się odnosi.You would consider using stubs and shims for calls that the project makes to other projects in your solution, or to other assemblies that the project references.

Jako ogólnej wskazówki należy użyć fragmentów dla wywołań w ramach rozwiązania Visual Studio i podkładek dla wywołań do innych zestawów, do których istnieje odwołanie.As a general guide, use stubs for calls within your Visual Studio solution, and shims for calls to other referenced assemblies. Dzieje się tak, ponieważ wewnątrz własnego rozwiązania warto ćwiczyć rozdzielanie par składników przez definiowanie interfejsów w sposób wymagany przez wycinkowanie.This is because within your own solution it is good practice to decouple the components by defining interfaces in the way that stubbing requires. Zestawy ale zewnętrzne, takie jak System.dll zwykle nie są dostarczane z osobne definicje interfejsu, dlatego należy używać podkładek.But external assemblies such as System.dll typically are not provided with separate interface definitions, so you must use shims instead.

Inne zagadnienia to:Other considerations are:

Wydajność.Performance. Podkładki działają wolniej, ponieważ przepisują kod w czasie wykonywania.Shims run slower because they rewrite your code at run time. Wycinki kodu nie mają dodatkowego obciążenia i są równie szybkie, jak metody wirtualne.Stubs do not have this performance overhead and are as fast as virtual methods can go.

Metody statyczne, zamknięte typy.Static methods, sealed types. Możesz używać wycinków tylko do implementacji interfejsów.You can only use stubs to implement interfaces. Tym samym typy wycinka nie mogą być stosowane dla metod statycznych, metod niewirtualnych, zaplombowanych metod wirtualnych, metod w zaplombowanych typach itd.Therefore, stub types cannot be used for static methods, non-virtual methods, sealed virtual methods, methods in sealed types, and so on.

Typy wewnętrzne.Internal types. Odcinków i podkładek używać z wewnętrznych typów, które są udostępniane przy użyciu atrybutu zestawu InternalsVisibleToAttribute.Both stubs and shims can be used with internal types that are made accessible by using the assembly attribute InternalsVisibleToAttribute.

Metody prywatne.Private methods. Podkładki zastępują wywołania metod prywatnych, jeśli widoczne są wszystkie typy podpisów metody.Shims can replace calls to private methods if all the types on the method signature are visible. Wycinki kodu mogą zastąpić jedynie metody widoczne.Stubs can only replace visible methods.

Interfejsy i metody abstrakcyjne.Interfaces and abstract methods. Wycinki kodu zapewniają implementacje interfejsów i metody abstrakcyjne, które mogą służyć do testowania.Stubs provide implementations of interfaces and abstract methods that can be used in testing. Podkładki nie mogą instrumentować interfejsów i metod abstrakcyjnych, ponieważ nie zawierają treści metody.Shims can't instrument interfaces and abstract methods, because they don't have method bodies.

Zasadniczo zaleca się używanie typów wycinków w celu odseparowania od zależności w ramach własnej bazy kodów.In general, we recommend that you use stub types to isolate from dependencies within your codebase. Można to zrobić, ukrywając składniki za interfejsami.You can do this by hiding the components behind interfaces. Typy podkładek można wykorzystywać do izolowania od składników innych firm, które nie mają sprawdzalnego API.Shim types can be used to isolate from third-party components that do not provide a testable API.

Wprowadzenie do wycinkówGet started with stubs

Aby uzyskać bardziej szczegółowy opis, zobacz używają wycinków kodu do izolowania poszczególnych części aplikacji od siebie nawzajem testów jednostkowych.For a more detailed description, see Use stubs to isolate parts of your application from each other for unit testing.

  1. Interfejsy wsunięćInject interfaces

    Aby użyć wycinków, musisz napisać kod, który chcesz przetestować w taki sposób, aby nie wymieniał wprost klas w innych składnikach Twojej aplikacji.To use stubs, you have to write the code you want to test in such a way that it does not explicitly mention classes in another component of your application. Przez „składnik” rozumie się klasę lub grupę klas, które są opracowane i aktualizowane łącznie i zwykle są zawarte w jednym projekcie Visual Studio.By "component" we mean a class or classes that are developed and updated together, and typically contained in one Visual Studio project. Zmienne i parametry powinny być zdeklarowane przy użyciu interfejsów, a wystąpienia innych składników powinny zostać przekazane lub utworzone za pomocą fabryki.Variables and parameters should be declared by using interfaces and instances of other components should be passed in or created by using a factory. Jeśli na przykład StockFeed jest klasą w innym składniku aplikacji, zostałoby to uznane za nieprawidłowe:For example, if StockFeed is a class in another component of the application, then this would be considered bad:

    return (new StockFeed()).GetSharePrice("COOO"); // Bad

    Zamiast tego zdefiniuj interfejs, który może być implementowany przez inny składnik, a także przez wycinek dla celów testowych:Instead, define an interface that can be implemented by the other component, and which can also be implemented by a stub for test purposes:

    public int GetContosoPrice(IStockFeed feed) => feed.GetSharePrice("COOO");
    
    Public Function GetContosoPrice(feed As IStockFeed) As Integer
     Return feed.GetSharePrice("COOO")
    End Function
    
    
  2. Dodawanie podrobionych zestawówAdd Fakes Assembly

    1. W Eksploratora rozwiązań, rozwiń listę odwołań projektu testowego.In Solution Explorer, expand the test project's reference list. Jeśli pracujesz w języku Visual Basic, należy wybrać Pokaż wszystkie pliki aby zobaczyć listę odwołań.If you are working in Visual Basic, you must choose Show All Files in order to see the reference list.

    2. Wybierz odwołanie do zestawu, w którym zdefiniowano interfejs (na przykład IStockFeed).Select the reference to the assembly in which the interface (for example IStockFeed) is defined. W menu skrótów tego odwołania wybierz Dodaj zestawy Substytuowane.On the shortcut menu of this reference, choose Add Fakes Assembly.

    3. Ponownie skompiluj rozwiązanie.Rebuild the solution.

  3. W testach należy skonstruować wystąpienia wycinka i podać kod dla jego metody:In your tests, construct instances of the stub and provide code for its methods:

    [TestClass]
    class TestStockAnalyzer
    {
        [TestMethod]
        public void TestContosoStockPrice()
        {
          // Arrange:
    
            // Create the fake stockFeed:
            IStockFeed stockFeed =
                 new StockAnalysis.Fakes.StubIStockFeed() // Generated by Fakes.
                     {
                         // Define each method:
                         // Name is original name + parameter types:
                         GetSharePriceString = (company) => { return 1234; }
                     };
    
            // In the completed application, stockFeed would be a real one:
            var componentUnderTest = new StockAnalyzer(stockFeed);
    
          // Act:
            int actualValue = componentUnderTest.GetContosoPrice();
    
          // Assert:
            Assert.AreEqual(1234, actualValue);
        }
        ...
    }
    
    <TestClass()> _
    Class TestStockAnalyzer
    
        <TestMethod()> _
        Public Sub TestContosoStockPrice()
            ' Arrange:
            ' Create the fake stockFeed:
            Dim stockFeed As New StockAnalysis.Fakes.StubIStockFeed
            With stockFeed
                .GetSharePriceString = Function(company)
                                           Return 1234
                                       End Function
            End With
            ' In the completed application, stockFeed would be a real one:
            Dim componentUnderTest As New StockAnalyzer(stockFeed)
            ' Act:
            Dim actualValue As Integer = componentUnderTest.GetContosoPrice
            ' Assert:
            Assert.AreEqual(1234, actualValue)
        End Sub
    End Class
    
    

    Specjalną funkcję PE łni tutaj jest klasą StubIStockFeed.The special piece of magic here is the class StubIStockFeed. Dla każdego interfejsu w zestawie, do którego istnieje odwołanie, mechanizm Microsoft Fakes generuje klasę zastępczą.For every interface in the referenced assembly, the Microsoft Fakes mechanism generates a stub class. Nazwa klasy wycinka jest tworzona od nazwy interfejsu, z "Fakes.Stub" jako prefiksem i dołączonymi nazwami typu parametru.The name of the stub class is the derived from the name of the interface, with "Fakes.Stub" as a prefix, and the parameter type names appended.

    Wycinki kodu są generowane także dla metod pobierających i ustawiających właściwości, dla zdarzeń i metod ogólnych.Stubs are also generated for the getters and setters of properties, for events, and for generic methods. Aby uzyskać więcej informacji, zobacz używają wycinków kodu do izolowania poszczególnych części aplikacji od siebie nawzajem testów jednostkowych.For more information, see Use stubs to isolate parts of your application from each other for unit testing.

Wprowadzenie do podkładekGet started with shims

(Aby uzyskać bardziej szczegółowy opis, zobacz stosowanie podkładek do izolowania aplikacji od innych zestawów w celu przeprowadzania testów jednostkowych.)(For a more detailed description, see Use shims to isolate your application from other assemblies for unit testing.)

Załóżmy, że składnik zawiera wywołania DateTime.Now:Suppose your component contains calls to DateTime.Now:

// Code under test:
    public int GetTheCurrentYear()
    {
       return DateTime.Now.Year;
    }

Podczas testowania, które chcesz podkładkę Now właściwość, ponieważ wersja rzeczywista niekorzystnie zwraca inną wartość w każdym wywołaniu.During testing, you would like to shim the Now property, because the real version inconveniently returns a different value at every call.

Aby użyć podkładek, nie trzeba modyfikować kodu aplikacji ani pisać go w określony sposób.To use shims, you don't have to modify the application code or write it a particular way.

  1. Dodawanie podrobionych zestawówAdd Fakes Assembly

    W Eksploratora rozwiązań, otwórz odniesienia projektu testu jednostkowego i wybierz odwołanie do zestawu, który zawiera metodę, którą chcesz substytuować.In Solution Explorer, open your unit test project's references and select the reference to the assembly that contains the method you want to fake. W tym przykładzie DateTime klasa się zebrała System.dll.In this example, the DateTime class is in System.dll. Aby zobaczyć odwołania w projekcie języka Visual Basic, wybierz Pokaż wszystkie pliki.To see the references in a Visual Basic project, choose Show All Files.

    Wybierz Dodaj zestawy Substytuowane.Choose Add Fakes Assembly.

  2. Wstaw podkładkę w ShimsContextInsert a shim in a ShimsContext

    [TestClass]
    public class TestClass1
    {
            [TestMethod]
            public void TestCurrentYear()
            {
                int fixedYear = 2000;
    
                // Shims can be used only in a ShimsContext:
                using (ShimsContext.Create())
                {
                  // Arrange:
                    // Shim DateTime.Now to return a fixed date:
                    System.Fakes.ShimDateTime.NowGet =
                    () =>
                    { return new DateTime(fixedYear, 1, 1); };
    
                    // Instantiate the component under test:
                    var componentUnderTest = new MyComponent();
    
                  // Act:
                    int year = componentUnderTest.GetTheCurrentYear();
    
                  // Assert:
                    // This will always be true if the component is working:
                    Assert.AreEqual(fixedYear, year);
                }
            }
    }
    
    <TestClass()> _
    Public Class TestClass1
        <TestMethod()> _
        Public Sub TestCurrentYear()
            Using s = Microsoft.QualityTools.Testing.Fakes.ShimsContext.Create()
                Dim fixedYear As Integer = 2000
                ' Arrange:
                ' Detour DateTime.Now to return a fixed date:
                System.Fakes.ShimDateTime.NowGet = _
                    Function() As DateTime
                        Return New DateTime(fixedYear, 1, 1)
                    End Function
    
                ' Instantiate the component under test:
                Dim componentUnderTest = New MyComponent()
                ' Act:
                Dim year As Integer = componentUnderTest.GetTheCurrentYear
                ' Assert:
                ' This will always be true if the component is working:
                Assert.AreEqual(fixedYear, year)
            End Using
        End Sub
    End Class
    

    Nazwy klasy shim są tworzone przez dodanie przedrostka Fakes.Shim do oryginalnej nazwy typu.Shim class names are made up by prefixing Fakes.Shim to the original type name. Nazwy parametrów są dołączane do nazwy metody.Parameter names are appended to the method name. (Nie trzeba dodać wszystkie odwołania do zestawu do System.Fakes).(You don't have to add any assembly reference to System.Fakes.)

W poprzednim przykładzie podkładka jest wykorzystana do metody statycznej.The previous example uses a shim for a static method. Aby użyć podkładu dla metody wystąpienia, napisz AllInstances między nazwę typu, a nazwa metody:To use a shim for an instance method, write AllInstances between the type name and the method name:

System.IO.Fakes.ShimFile.AllInstances.ReadToEnd = ...

(Brak żadnego zestawu "System.IO.Fakes", aby odwołać.(There is no 'System.IO.Fakes' assembly to reference. Przestrzeń nazw jest generowany przez proces tworzenia podkładki.The namespace is generated by the shim creation process. Ale można użyć "using" lub "Import", które znajdują się w zwykły sposób).But you can use 'using' or 'Import' in the usual way.)

Można również utworzyć podkładki dla konkretnych wystąpień, konstruktorów i właściwości.You can also create shims for specific instances, for constructors, and for properties. Aby uzyskać więcej informacji, zobacz stosowanie podkładek do izolowania aplikacji od innych zestawów w celu przeprowadzania testów jednostkowych.For more information, see Use shims to isolate your application from other assemblies for unit testing.

W tej sekcjiIn this section

Stosowanie wycinków kodu do izolowania od siebie poszczególnych części aplikacji w celu przeprowadzania testów jednostkowychUse stubs to isolate parts of your application from each other for unit testing

Stosowanie podkładek do izolowania aplikacji od innych zestawów w celu przeprowadzania testów jednostkowychUse shims to isolate your application from other assemblies for unit testing

Konwencje dotyczące generowania kodu, jego kompilowania i nazywania w Microsoft FakesCode generation, compilation, and naming conventions in Microsoft Fakes