Udostępnij za pośrednictwem

Testowanie jednostkowe bibliotek języka F# na platformie .NET Core przy użyciu testu dotnet i narzędzia xUnit

Ten samouczek przeprowadzi Cię przez interaktywne środowisko tworzenia przykładowego rozwiązania krok po kroku, aby poznać pojęcia dotyczące testowania jednostkowego. Jeśli wolisz korzystać z samouczka z gotowym rozwiązaniem, wyświetl lub pobierz przykładowy kod przed rozpoczęciem. Aby uzyskać instrukcje dotyczące pobierania, zobacz Przykłady i samouczki.

Ten artykuł dotyczy testowania projektu platformy .NET Core. Jeśli testujesz projekt ASP.NET Core, zobacz Testy integracyjne w ASP.NET Core.

Tworzenie projektu źródłowego

Otwórz okno powłoki. Utwórz katalog o nazwie unit-testing-with-fsharp w celu przechowywania rozwiązania. W tym nowym katalogu uruchom polecenie dotnet new sln , aby utworzyć nowe rozwiązanie. Ułatwia to zarządzanie zarówno biblioteką klas, jak i projektem testów jednostkowych. W katalogu rozwiązania utwórz katalog MathService . Do tej pory przedstawiono strukturę katalogów i plików:

/unit-testing-with-fsharp
    unit-testing-with-fsharp.sln
    /MathService

Utwórz aplikację MathService jako bieżący katalog i uruchom polecenie dotnet new classlib -lang "F#" , aby utworzyć projekt źródłowy. Utworzysz nieudaną implementację usługi matematycznej:

module MyMath =
    let squaresOfOdds xs = raise (System.NotImplementedException("You haven't written a test yet!"))

Zmień katalog z powrotem na katalog unit-testing-with-fsharp . Uruchom dotnet sln add .\MathService\MathService.fsproj, aby dodać projekt biblioteki klas do rozwiązania.

Tworzenie projektu testowego

Następnie utwórz katalog MathService.Tests . W poniższym zarysie przedstawiono strukturę katalogu:

/unit-testing-with-fsharp
    unit-testing-with-fsharp.sln
    /MathService
        Source Files
        MathService.fsproj
    /MathService.Tests

Utwórz katalog MathService.Tests jako bieżący katalog i utwórz nowy projekt przy użyciu polecenia dotnet new xunit -lang "F#". Spowoduje to utworzenie projektu testowego, który używa narzędzia xUnit jako biblioteki testowej. Wygenerowany szablon konfiguruje moduł uruchamiający testy w pliku MathServiceTests.fsproj:

<ItemGroup>
  <PackageReference Include="Microsoft.NET.Test.Sdk" Version="15.3.0-preview-20170628-02" />
  <PackageReference Include="xunit" Version="2.2.0" />
  <PackageReference Include="xunit.runner.visualstudio" Version="2.2.0" />
</ItemGroup>

Projekt testowy wymaga innych pakietów do tworzenia i uruchamiania testów jednostkowych. dotnet new w poprzednim kroku dodano pakiet xUnit i narzędzie uruchamiające xUnit. Teraz dodaj bibliotekę klas MathService jako inną zależność do projektu. Użyj polecenia dotnet reference add:

dotnet reference add ../MathService/MathService.fsproj

Cały plik można zobaczyć w repozytorium przykładów w witrynie GitHub.

Masz następujący końcowy układ rozwiązania:

/unit-testing-with-fsharp
    unit-testing-with-fsharp.sln
    /MathService
        Source Files
        MathService.fsproj
    /MathService.Tests
        Test Source Files
        MathServiceTests.fsproj

Wykonaj polecenie dotnet sln add .\MathService.Tests\MathService.Tests.fsproj w katalogu unit-testing-with-fsharp .

Tworzenie pierwszego testu

Napisz jeden test zakończony niepowodzeniem, wykonaj go pomyślnie, a następnie powtórz ten proces. Otwórz plik Tests.fs i dodaj następujący kod:

[<Fact>]
let ``My test`` () =
    Assert.True(true)

[<Fact>]
let ``Fail every time`` () = Assert.True(false)

Atrybut [<Fact>] określa metodę testową uruchamianą przez moduł uruchamiający testy. W module unit-testing-with-fsharp wykonaj polecenie dotnet test , aby skompilować testy i bibliotekę klas, a następnie uruchomić testy. Moduł uruchamiający testy xUnit zawiera punkt wejścia programu w celu uruchomienia testów. dotnet test uruchamia moduł uruchamiający testy przy użyciu utworzonego projektu testów jednostkowych.

Te dwa testy ilustrują najbardziej podstawowe testy zaliczające i niezaliczające. My test przechodzi i Fail every time nie przechodzi. Teraz utwórz test dla squaresOfOdds metody . Metoda squaresOfOdds zwraca sekwencję kwadratów wszystkich nieparzystnych wartości całkowitych, które są częścią sekwencji danych wejściowych. Zamiast próbować napisać wszystkie te funkcje jednocześnie, można iteracyjne tworzyć testy sprawdzające funkcjonalność. Sprawienie, by każdy test przeszedł pomyślnie, oznacza stworzenie niezbędnej funkcjonalności dla metody.

Najprostszym testem, który możemy napisać, jest wywołanie squaresOfOdds ze wszystkimi liczbami parzystymi, gdzie wynikiem powinna być pusta sekwencja liczb całkowitych. Oto ten test:

[<Fact>]
let ``Sequence of Evens returns empty collection`` () =
    let expected = Seq.empty<int>
    let actual = MyMath.squaresOfOdds [2; 4; 6; 8; 10]
    Assert.Equal<Collections.Generic.IEnumerable<int>>(expected, actual)

Test kończy się niepowodzeniem. Nie utworzyłeś jeszcze implementacji. Wykonaj ten test, pisząc najprostszy kod w klasie MathService, która działa:

let squaresOfOdds xs =
    Seq.empty<int>

W katalogu unit-testing-with-fsharp ponownie uruchom dotnet test. Polecenie dotnet test uruchamia kompilację dla projektu MathService, a następnie dla projektu MathService.Tests. Po utworzeniu obu projektów zostanie uruchomiony ten pojedynczy test. Przechodzi.

Spełnianie wymagań

Teraz, gdy zrealizowałeś jeden test, nadszedł czas, aby napisać więcej. Następny prosty przypadek działa z sekwencją, której jedyną nieparzystą liczbą jest 1. Liczba 1 jest łatwiejsza, ponieważ kwadrat 1 wynosi 1. Oto następny test:

[<Fact>]
let ``Sequences of Ones and Evens returns Ones`` () =
    let expected = [1; 1; 1; 1]
    let actual = MyMath.squaresOfOdds [2; 1; 4; 1; 6; 1; 8; 1; 10]
    Assert.Equal<Collections.Generic.IEnumerable<int>>(expected, actual)

Uruchomienie dotnet test wykonuje twoje testy i pokazuje, że nowy test nie przechodzi. Teraz zaktualizuj metodę squaresOfOdds , aby obsłużyć ten nowy test. Filtrujesz wszystkie liczby parzystowe z sekwencji, aby wykonać ten test. Można to zrobić, pisząc małą funkcję filtru i używając polecenia Seq.filter:

let private isOdd x = x % 2 <> 0

let squaresOfOdds xs =
    xs
    |> Seq.filter isOdd

Został jeszcze jeden krok: podnieś każdą z nieparzystych liczb do kwadratu. Zacznij od napisania nowego testu:

[<Fact>]
let ``SquaresOfOdds works`` () =
    let expected = [1; 9; 25; 49; 81]
    let actual = MyMath.squaresOfOdds [1; 2; 3; 4; 5; 6; 7; 8; 9; 10]
    Assert.Equal(expected, actual)

Test można naprawić, przekazując filtrowaną sekwencję za pomocą operacji mapowania w celu obliczenia kwadratu każdej liczby nieparzystej.

let private square x = x * x
let private isOdd x = x % 2 <> 0

let squaresOfOdds xs =
    xs
    |> Seq.filter isOdd
    |> Seq.map square

Ty zbudowałeś małą bibliotekę i zestaw testów jednostkowych dla tej biblioteki. Rozwiązanie zostało ustrukturyzowane tak, aby dodawanie nowych pakietów i testów było częścią normalnego przepływu pracy. Skoncentrowałeś większość swojego czasu i wysiłku na osiągnięciu celów aplikacji.

Zobacz też