NUnit ve .NET Core ile C# birim testi

Makale
04/05/2024

Bu öğreticide, birim testi kavramlarını öğrenmek için adım adım örnek bir çözüm oluşturma etkileşimli bir deneyime geçilir. Önceden oluşturulmuş bir çözüm kullanarak öğreticiyi izlemeyi tercih ediyorsanız başlamadan önce örnek kodu görüntüleyin veya indirin. İndirme yönergeleri için bkz . Örnekler ve Öğreticiler.

Bu makale bir .NET Core projelerini test etme hakkındadır. ASP.NET Core projesini test ediyorsanız bkz . ASP.NET Core'da tümleştirme testleri.

Önkoşullar

.NET 8.0 veya sonraki sürümleri.
Tercih ettiğiniz bir metin veya kod düzenleyicisi.

Kaynak projeyi oluşturma

Bir kabuk penceresi açın. Çözümü tutmak için unit-testing-using-nunit adlı bir dizin oluşturun. Bu yeni dizinin içinde aşağıdaki komutu çalıştırarak sınıf kitaplığı ve test projesi için yeni bir çözüm dosyası oluşturun:

dotnet new sln

Ardından bir PrimeService dizini oluşturun. Şu ana hat, şu ana kadarki dizin ve dosya yapısını gösterir:

/unit-testing-using-nunit
    unit-testing-using-nunit.sln
    /PrimeService

PrimeService'i geçerli dizin yapın ve aşağıdaki komutu çalıştırarak kaynak projeyi oluşturun:

dotnet new classlib

Class1.cs PrimeService.cs olarak yeniden adlandırın. Sınıfın PrimeService başarısız bir uygulamasını oluşturursunuz:

using System;

namespace Prime.Services
{
    public class PrimeService
    {
        public bool IsPrime(int candidate)
        {
            throw new NotImplementedException("Please create a test first.");
        }
    }
}

Dizini unit-testing-using-nunit dizinine geri değiştirin. Çözüme sınıf kitaplığı projesini eklemek için aşağıdaki komutu çalıştırın:

dotnet sln add PrimeService/PrimeService.csproj

Test projesi oluşturma

Ardından PrimeService.Tests dizinini oluşturun. Aşağıdaki ana hat dizin yapısını gösterir:

/unit-testing-using-nunit
    unit-testing-using-nunit.sln
    /PrimeService
        Source Files
        PrimeService.csproj
    /PrimeService.Tests

PrimeService.Tests dizinini geçerli dizin yapın ve aşağıdaki komutu kullanarak yeni bir proje oluşturun:

dotnet new nunit

dotnet new komutu, test kitaplığı olarak NUnit kullanan bir test projesi oluşturur. Oluşturulan şablon, PrimeService.Tests.csproj dosyasında test çalıştırıcısını yapılandırıyor:

<ItemGroup>
  <PackageReference Include="nunit" Version="4.1.0" />
  <PackageReference Include="NUnit3TestAdapter" Version="4.5.0" />
  <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.9.0" />
  <PackageReference Include="NUnit.Analyzers" Version="4.2.0">
      <PrivateAssets>all</PrivateAssets>
      <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
  </PackageReference>
</ItemGroup>

Not

.NET 9'dan önce, oluşturulan kod NUnit test çerçevesinin eski sürümlerine başvurabilir. Paketleri güncelleştirmek için dotnet CLI kullanabilirsiniz. Alternatif olarak, PrimeService.Tests.csproj dosyasını açın ve paket başvuruları öğe grubunun içeriğini yukarıdaki kodla değiştirin.

Test projesi, birim testleri oluşturmak ve çalıştırmak için başka paketler gerektirir. Önceki dotnet new adımdaki komut Microsoft test SDK'sını, NUnit test çerçevesini ve NUnit test bağdaştırıcısını ekledi. Şimdi, sınıf kitaplığını PrimeService projeye başka bir bağımlılık olarak ekleyin. dotnet add reference Komutunu kullanın:

dotnet add reference ../PrimeService/PrimeService.csproj

Dosyanın tamamını GitHub'daki örnek deposunda görebilirsiniz.

Aşağıdaki ana hat, son çözüm düzenini gösterir:

/unit-testing-using-nunit
    unit-testing-using-nunit.sln
    /PrimeService
        Source Files
        PrimeService.csproj
    /PrimeService.Tests
        Test Source Files
        PrimeService.Tests.csproj

Unit-testing-using-nunit dizininde aşağıdaki komutu yürütür:

dotnet sln add ./PrimeService.Tests/PrimeService.Tests.csproj

İlk testi oluşturma

Başarısız bir test yazar, başarılı olur ve işlemi tekrarlarsınız. PrimeService.Tests dizininde UnitTest1.cs dosyasını PrimeService_IsPrimeShould.cs olarak yeniden adlandırın ve içeriğinin tamamını aşağıdaki kodla değiştirin:

using NUnit.Framework;
using Prime.Services;

namespace Prime.UnitTests.Services
{
    [TestFixture]
    public class PrimeService_IsPrimeShould
    {
        private PrimeService _primeService;

        [SetUp]
        public void SetUp()
        {
            _primeService = new PrimeService();
        }

        [Test]
        public void IsPrime_InputIs1_ReturnFalse()
        {
            var result = _primeService.IsPrime(1);

            Assert.That(result, Is.False, "1 should not be prime");
        }
    }
}

özniteliği, [TestFixture] birim testleri içeren bir sınıfı belirtir. [Test] özniteliği bir yöntemin bir test yöntemi olduğunu gösterir.

Bu dosyayı kaydedin ve testleri ve sınıf kitaplığını derlemek ve testleri çalıştırmak için komutunu yürütür dotnet test . NUnit test çalıştırıcısı, testlerinizi çalıştırmak için program giriş noktasını içerir. dotnet test oluşturduğunuz birim testi projesini kullanarak test çalıştırıcısını başlatır.

Testiniz başarısız oluyor. Uygulamayı henüz oluşturmadınız. Sınıfında çalışan en basit kodu yazarak test geçişini PrimeService yapın:

public bool IsPrime(int candidate)
{
    if (candidate == 1)
    {
        return false;
    }
    throw new NotImplementedException("Please create a test first.");
}

Unit-testing-using-nunit dizininde yeniden çalıştırındotnet test. komutu, dotnet test proje için PrimeService ve ardından proje için PrimeService.Tests bir derleme çalıştırır. Her iki projeyi de derledikten sonra bu tek testi çalıştırır. Geçti.

Daha fazla özellik ekleme

Artık bir test geçişi yaptığınıza göre, daha fazla yazmanın zamanı geldi. Asal sayılar için birkaç basit durum daha vardır: 0, -1. özniteliğiyle [Test] yeni testler ekleyebilirsiniz, ancak bu hızlı bir şekilde sıkıcı hale gelir. Benzer testlerden oluşan bir paket yazmanızı sağlayan başka NUnit öznitelikleri de vardır. [TestCase] Öznitelik, aynı kodu yürüten ancak farklı giriş bağımsız değişkenleri olan bir test paketi oluşturmak için kullanılır. Bu girişler için değerleri belirtmek için özniteliğini kullanabilirsiniz [TestCase] .

Yeni testler oluşturmak yerine bu özniteliği uygulayarak tek bir veri temelli test oluşturun. Veri temelli test, en düşük asal sayı olan ikiden küçük birkaç değeri test eden bir yöntemdir:

[TestCase(-1)]
[TestCase(0)]
[TestCase(1)]
public void IsPrime_ValuesLessThan2_ReturnFalse(int value)
{
    var result = _primeService?.IsPrime(value);

    Assert.That(result, Is.False, $"{value} should not be prime");
}

komutunu çalıştırın dotnet testve bu testlerden ikisi başarısız olur. Tüm testlerin geçmesini sağlamak için PrimeService.cs dosyasında yöntemin Main başındaki yan tümcesini değiştirinif:

if (candidate < 2)

Ana kitaplığa daha fazla test, teori ve kod ekleyerek yinelemeye devam edin. Testlerin tamamlanmış sürümüne ve kitaplığın tam uygulamasına sahipsiniz.

Bu kitaplık için küçük bir kitaplık ve bir dizi birim testi oluşturdunuz. Ayrıca çözümü, yeni paket ve test eklemenin standart iş akışının bir parçası olacak şekilde yapılandırmış olmanız gerekir. Zamanınızın ve çabanızın çoğunu uygulamanın hedeflerini çözmeye yoğunlaştırmışsınız.