Exemplarische Vorgehensweise: Erstellen und Ausführen von Komponententests für verwalteten Code

Artikel
11/03/2023

Dieser Artikel führt Sie durch das Erstellen, Ausführen und Anpassen verschiedener Komponententests mithilfe des Microsoft-Komponententestframeworks für verwalteten Code und Visual Studio-Test-Explorer. Sie beginnen mit einem C#-Projekt in der Entwicklungsphase und erstellen Tests zur Codeüberprüfung. Anschließend führen Sie die Tests aus und überprüfen die Ergebnisse. Dann können Sie den Projektcode ändern und die Tests erneut ausführen. Eine konzeptionelle Übersicht über diese Aufgaben, bevor Sie diese Schritte ausführen, finden Sie unter Grundlagen zu den Komponententests. Wenn Sie Tests automatisch aus vorhandenem Code generieren möchten, lesen Sie Erstellen von Stubs für Unittest-Methoden aus Code.

Erstellen eines zu testenden Projekts

Öffnen Sie Visual Studio.
Wählen Sie im Startfenster Neues Projekt erstellen aus.
Wählen Sie die C#-Projektvorlage Konsolen-App für .NET aus, und klicken Sie dann auf Weiter.

Hinweis

Wenn die Vorlage Konsolen-App nicht angezeigt wird, können Sie sie im Fenster Neues Projekt erstellen installieren. Wählen Sie in der Meldung Sie finden nicht, wonach Sie suchen? den Link Weitere Tools und Features installieren aus. Wählen Sie dann im Visual Studio-Installer die Workload .NET-Desktopentwicklung aus.
Geben Sie dem Projekt den Namen Bank, und klicken Sie dann auf Weiter.

Wählen Sie entweder das empfohlene Zielframework oder .NET 8 aus, und wählen Sie Erstellen aus.

Das Projekt „Bank“ wird erstellt und im Projektmappen-Explorer angezeigt, und der Code-Editor mit der Datei Program.cs wird geöffnet.

Hinweis

Wenn die Datei Program.cs nicht im Editor geöffnet wird, doppelklicken Sie im Projektmappen-Explorer auf die Datei Program.cs, um diese zu öffnen.

Ersetzen Sie den Inhalt der Datei Program.cs durch den folgenden C#-Code, der die Klasse BankAccount definiert:

using System;

namespace BankAccountNS
{
    /// <summary>
    /// Bank account demo class.
    /// </summary>
    public class BankAccount
    {
        private readonly string m_customerName;
        private double m_balance;

        private BankAccount() { }

        public BankAccount(string customerName, double balance)
        {
            m_customerName = customerName;
            m_balance = balance;
        }

        public string CustomerName
        {
            get { return m_customerName; }
        }

        public double Balance
        {
            get { return m_balance; }
        }

        public void Debit(double amount)
        {
            if (amount > m_balance)
            {
                throw new ArgumentOutOfRangeException("amount");
            }

            if (amount < 0)
            {
                throw new ArgumentOutOfRangeException("amount");
            }

            m_balance += amount; // intentionally incorrect code
        }

        public void Credit(double amount)
        {
            if (amount < 0)
            {
                throw new ArgumentOutOfRangeException("amount");
            }

            m_balance += amount;
        }

        public static void Main()
        {
            BankAccount ba = new BankAccount("Mr. Bryan Walton", 11.99);

            ba.Credit(5.77);
            ba.Debit(11.22);
            Console.WriteLine("Current balance is ${0}", ba.Balance);
        }
    }
}

Ändern Sie den Dateinamen per Rechtsklick zu BankAccount.cs und wählen Sie Umbenennen in Projektmappen-Explorer.
Wählen Sie im Menü Erstellen die Option Projektmappe erstellen aus, oder drücken Sie STRG + UMSCHALT + B.

Sie haben nun ein Projekt mit Methoden, die Sie testen können. Die Tests in diesem Artikel beziehen sich auf die Debit-Methode. Die Debit-Methode wird aufgerufen, wenn von einem Konto Geld abgehoben wird.

Ein Komponententestprojekt erstellen

Klicken Sie im Menü Datei auf Hinzufügen>Neues Projekt.

Tipp

Alternativ können Sie im Projektmappen-Explorer mit der rechten Maustaste auf die Projektmappe klicken und anschließend Hinzufügen>Neues Projekt auswählen.
Geben Sie Test in das Suchfeld ein, wählen Sie C#- als Sprache aus, und wählen Sie dann das C# MSTest Unit Test Project für .NET-Vorlage aus, und klicken Sie dann auf Weiter.

Hinweis

In der Version 16.9 von Visual Studio 2019 heißt die MSTest-Projektvorlage Komponententestprojekt.
Geben Sie dem Projekt den Namen BankTests, und klicken Sie auf Weiter.
Wählen Sie entweder das empfohlene Zielframework oder .NET 8 aus, und wählen Sie Erstellen aus.

Das Projekt BankTests wird der Projektmappe Bank hinzugefügt.
Fügen Sie im Projekt BankTests einen Verweis auf die Projektmappe Bank ein.

Wählen Sie im Projektmappen-Explorer im Projekt BankTests erst Abhängigkeiten und dann im Kontextmenü Verweis hinzufügen (oder Projektverweis hinzufügen) aus.
Erweitern Sie im Dialogfeld Verweis-Manager die Option Projekte, wählen Sie Lösung aus, und überprüfen Sie das Element Bank.
Klicken Sie auf OK.

Die Testklasse erstellen

Erstellen Sie eine Testklasse, um die BankAccount-Klasse zu überprüfen. Sie können die Datei UnitTest1.cs verwenden, die von der Projektvorlage generiert wurde; Datei und Klasse sollten jedoch einen aussagekräftigeren Namen erhalten.

Umbenennen einer Datei und Klasse

Wählen Sie zum Umbenennen der Datei im Projektmappen-Explorer im BankTests-Projekt die Datei UnitTest1.cs aus. Wählen Sie im Kontextmenü die Option Umbenennen aus, oder drücken Sie F2, und benennen Sie dann die Datei in BankAccountTests.cs um.
Zeigen Sie im Code-Editor mit dem Cursor auf UnitTest1, klicken Sie mit der rechten Maustaste, und wählen Sie dann Umbenennen aus (oder drücken Sie F2), um die Klasse umzubenennen. Geben Sie BankAccountTests ein, und drücken Sie dann die EINGABETASTE.

Die Datei BankAccountTests.cs enthält nun den folgenden Code:

// The 'using' statement for Test Tools is in GlobalUsings.cs
// using Microsoft.VisualStudio.TestTools.UnitTesting;

namespace BankTests
{
    [TestClass]
    public class BankAccountTests
    {
        [TestMethod]
        public void TestMethod1()
        {
        }
    }
}

Hinzufügen einer Using-Anweisung

Fügen Sie der Testklasse eine using-Anweisung hinzu, damit Sie das Testprojekt ohne vollqualifizierte Namen aufrufen können. Fügen Sie am Anfang der Klassendatei Folgendes hinzu:

using BankAccountNS;

Testklassenanforderungen

Die Mindestanforderungen für eine Testklasse lauten wie folgt:

Das [TestClass]-Attribut ist für jede Klasse erforderlich, die in Test-Explorer auszuführende Komponententestmethoden enthält.
Jede Testmethode, die vom Test-Explorer erkannt werden soll, muss über das [TestMethod]-Attribut verfügen.

Ein Komponententestprojekt kann auch über andere Klassen ohne das [TestClass] -Attribut verfügen, und Testklassen können andere Methoden ohne das [TestMethod] -Attribut aufweisen. Sie können diese anderen Klassen und Methoden in den Testmethoden aufrufen.

Die erste Testmethode erstellen

In dieser Vorgehensweise schreiben Sie Komponententestmethoden, um das Verhalten der Debit-Methode der BankAccount-Klasse zu überprüfen.

Es müssen mindestens drei Verhalten überprüft werden:

Die Methode löst eine ArgumentOutOfRangeException aus, wenn der Abbuchungsbetrag größer ist als das Guthaben.
Außerdem löst sie eine ArgumentOutOfRangeException aus, wenn der Abbuchungsbetrag kleiner als 0 (null) ist.
Wenn der Abbuchungsbetrag gültig ist, zieht die Methode diesen vom Kontoguthaben ab.

Tipp

Sie können die Standardmethode TestMethod1 löschen, da Sie sie für diese exemplarische Vorgehensweise nicht benötigen.

So erstellen Sie eine Testmethode

Im ersten Test überprüfen Sie, ob durch einen gültigen Betrag (kleiner als das Kontoguthaben und größer als null) der richtige Betrag vom Konto abgebucht wird. Fügen Sie dieser BankAccountTests -Klasse die folgende Methode hinzu.

[TestMethod]
public void Debit_WithValidAmount_UpdatesBalance()
{
    // Arrange
    double beginningBalance = 11.99;
    double debitAmount = 4.55;
    double expected = 7.44;
    BankAccount account = new BankAccount("Mr. Bryan Walton", beginningBalance);

    // Act
    account.Debit(debitAmount);

    // Assert
    double actual = account.Balance;
    Assert.AreEqual(expected, actual, 0.001, "Account not debited correctly");
}

Die Methode ist ganz einfach: Sie richtet ein neues BankAccount-Objekt mit einem Startguthaben ein und bucht dann einen gültigen Betrag ab. Sie verwendet die Assert.AreEqual-Methode, um zu überprüfen, ob das Guthaben zum Schluss den Erwartungen entspricht. Die Methoden wie Assert.AreEqual, Assert.IsTrue und andere werden häufig in Komponententests verwendet. Weitere konzeptionelle Informationen zum Schreiben eines Komponententests finden Sie unter Schreiben ihrer Tests.

Testmethodenanforderungen

Eine Testmethode muss die folgenden Anforderungen erfüllen:

Sie ist mit dem [TestMethod]-Attribut ausgestattet.
Er gibt void zurück.
Die darf keine Parameter aufweisen.

Den Test erstellen und ausführen

Wählen Sie im Menü Erstellen die Option Projektmappe erstellen aus, oder drücken Sie STRG + UMSCHALT + B.
Wenn Test Explorer nicht geöffnet ist, öffnen Sie ihn, indem Sie Test>Test Explorer (oder Test>Windows>Test Explorer) in der oberen Menüleiste auswählen (oder STRG + EE, Tdrücken).
Wählen Sie Alle ausführen aus, oder drücken Sie STRG + R, V, um den Test auszuführen.

Während der Test ausgeführt wird, gibt die Statusleiste am oberen Rand des Fensters Test-Explorer den aktuellen Status an. Am Ende des Testlaufs wird die Leiste grün, wenn alle Tests erfolgreich sind, oder rot, sofern bei einem der Tests ein Fehler auftritt.

In diesem Fall schlägt der Test fehl.
Wählen Sie die Methode im Test-Explorer aus, um die Details unten im Fenster anzuzeigen.

Den Code korrigieren und die Tests erneut ausführen

Das Testergebnis enthält eine Meldung mit der Fehlerbeschreibung. Möglicherweise müssen Sie einen Drilldown ausführen, um diese Meldung sehen zu können. Bei der AreEqual-Methode zeigt die Meldung an, was erwartet und was tatsächlich empfangen wurde. Es wurde davon ausgegangen, dass sich das Guthaben verringern würde. Stattdessen hat es sich aber um den Betrag der Abhebung erhöht.

Beim Komponententest wurde ein Fehler festgestellt: Der Abbuchungsbetrag wird dem Kontoguthaben hinzugerechnet, anstatt davon abgezogen zu werden.

Korrigieren des Fehlers

Um den Fehler zu beheben, ersetzten Sie in der Datei BankAccount.cs die Zeile:

m_balance += amount;

Durch:

m_balance -= amount;

Erneutes Ausführen des Tests

Wählen Sie im Test-Explorer die Option Alle ausführen aus, oder drücken Sie STRG + R, V, um den Test erneut auszuführen. Wenn die rote oder grüne Statusleiste grün wird, war der Test erfolgreich.

Test-Explorer in Visual Studio 2019, der erfolgreiche Tests anzeigt

Den Code mit Komponententests verbessern

In diesem Abschnitt wird beschrieben, wie ein iterativer Prozess bestehend aus Analyse, Komponententestentwicklung und Umgestaltung helfen kann, die Robustheit und Effektivität des Produktionscodes zu verbessern.

Analysieren der Probleme

Sie haben eine Testmethode erstellt, um zu bestätigen, dass zum jeweiligen Zeitpunkt in der Debit-Methode ein gültiger Betrag abgezogen wird. Überprüfen Sie jetzt, ob die Methode eine ArgumentOutOfRangeException auslöst, wenn der Abbuchungsbetrag

entweder höher als das Guthaben ist
oder unter 0 liegt.

Erstellen und Ausführen neuer Testmethoden

Erstellen Sie eine Testmethode, um die Richtigkeit zu bestätigen, wenn der Abbuchungsbetrag unter 0 liegt:

[TestMethod]
public void Debit_WhenAmountIsLessThanZero_ShouldThrowArgumentOutOfRange()
{
    // Arrange
    double beginningBalance = 11.99;
    double debitAmount = -100.00;
    BankAccount account = new BankAccount("Mr. Bryan Walton", beginningBalance);

    // Act and assert
    Assert.ThrowsException<System.ArgumentOutOfRangeException>(() => account.Debit(debitAmount));
}

Verwenden Sie die ThrowsException-Methode, um zu bestätigen, dass die richtige Ausnahme ausgelöst wurde. Diese Methode führt zu einem Fehler des Tests, es sei denn, eine ArgumentOutOfRangeException wird ausgelöst. Wenn Sie die zu testende Methode kurzzeitig ändern, um eine generischere ApplicationException auszulösen, wenn der Abbuchungsbetrag unter 0 liegt, wird der Test richtig ausgeführt, d. h. er schlägt fehl.

Gehen Sie folgendermaßen vor, um das Verhalten zu testen, wenn der abzubuchende Betrag höher ist als das Guthaben:

Erstellen Sie eine neue Testmethode mit dem Namen Debit_WhenAmountIsMoreThanBalance_ShouldThrowArgumentOutOfRange.
Kopieren Sie den Methodentext aus Debit_WhenAmountIsLessThanZero_ShouldThrowArgumentOutOfRange in die neue Methode.
Legen Sie debitAmount auf eine Zahl größer als das Guthaben fest.

Führen Sie die zwei Tests aus, und stellen Sie sicher, dass sie erfolgreich abgeschlossen werden.

Fortführen der Analyse

Die zu testende Methode kann weiter verbessert werden. In der aktuellen Implementierung gibt es keine Möglichkeit, zu erfahren, welche Bedingung (amount > m_balance oder amount < 0) zu der Ausnahme geführt hat, die während des Tests ausgelöst wurde. Wir wissen nur, dass irgendwo in der Methode eine ArgumentOutOfRangeException ausgelöst wurde. Es wäre wünschenswert zu wissen, welche Bedingung in BankAccount.Debit das Auslösen der Ausnahme verursacht hat (amount > m_balance oder amount < 0), sodass wir sicher sein können, dass die Methode die Integrität ihrer Argumente ordnungsgemäß überprüft.

Wenn Sie sich die zu testende Methode (BankAccount.Debit) noch einmal ansehen, werden Sie feststellen, dass beide Bedingungsanweisungen einen ArgumentOutOfRangeException-Konstruktor verwenden, der einfach den Namen des Arguments als Parameter übernimmt:

throw new ArgumentOutOfRangeException("amount");

Sie können einen Konstruktor verwenden, der weitaus ausführlichere Informationen übermittelt: ArgumentOutOfRangeException(String, Object, String) umfasst den Namen des Arguments, den Argumentwert und eine benutzerdefinierte Meldung. Sie können die zu testende Methode so umgestalten, dass sie diesen Konstruktor verwendet. Besser noch, Sie können öffentlich verfügbare Typmitglieder verwenden, um die Fehler anzugeben.

Umgestalten des zu testenden Codes

Definieren Sie zunächst zwei Konstanten für die Fehlermeldungen im Klassengültigkeitsbereich. Platzieren Sie die Definitionen in der Klasse unter Test: BankAccount

public const string DebitAmountExceedsBalanceMessage = "Debit amount exceeds balance";
public const string DebitAmountLessThanZeroMessage = "Debit amount is less than zero";

Ändern Sie dann die beiden Bedingungsanweisungen in der Debit-Methode:

if (amount > m_balance)
{
    throw new System.ArgumentOutOfRangeException("amount", amount, DebitAmountExceedsBalanceMessage);
}

if (amount < 0)
{
    throw new System.ArgumentOutOfRangeException("amount", amount, DebitAmountLessThanZeroMessage);
}

Umgestalten der Testmethoden

Gestalten Sie die Testmethoden um, indem Sie den Aufruf von Assert.ThrowsException entfernen. Umschließen Sie den Aufruf von Debit() in einem try/catch-Block, fangen Sie die spezifische erwartete Ausnahme ab, und verifizieren Sie die zugehörige Meldung. Mithilfe der Microsoft.VisualStudio.TestTools.UnitTesting.StringAssert.Contains-Methode können Sie zwei Zeichenfolgen miteinander vergleichen.

Debit_WhenAmountIsMoreThanBalance_ShouldThrowArgumentOutOfRange wird wie folgt formuliert:

[TestMethod]
public void Debit_WhenAmountIsMoreThanBalance_ShouldThrowArgumentOutOfRange()
{
    // Arrange
    double beginningBalance = 11.99;
    double debitAmount = 20.0;
    BankAccount account = new BankAccount("Mr. Bryan Walton", beginningBalance);

    // Act
    try
    {
        account.Debit(debitAmount);
    }
    catch (System.ArgumentOutOfRangeException e)
    {
        // Assert
        StringAssert.Contains(e.Message, BankAccount.DebitAmountExceedsBalanceMessage);
    }
}

Erneut testen, umschreiben und neu analysieren

Derzeit verarbeitet die Testmethode nicht alle Fälle, die sie verarbeiten sollte. Wenn die zu testende Methode, die Debit-Methode, keine ArgumentOutOfRangeException-Ausnahme auslöst, wenn der debitAmount-Wert größer als der Saldo (oder unter null (0)) liegt, wird die Testmethode erfolgreich ausgeführt. Dieses Szenario ist nicht gut, da bei der Testmethode ein Fehler auftreten soll, wenn keine Ausnahme ausgelöst wird.

Dieses Ergebnis ist ein Fehler der Testmethode. Um das Problem zu beheben, fügen Sie eine Assert.Fail-Assertion am Ende der Testmethode hinzu, um den Fall abzudecken, in dem keine Ausnahme ausgelöst wird.

Ein erneuter Test zeigt, dass der Test jetzt fehlschlägt, wenn die richtige Ausnahme erfasst wird. Der catch-Block fängt die Ausnahme zwar ab, aber die Methode wird weiterhin ausgeführt und schlägt bei der neuen Assert.Fail-Assertion fehl. Um dieses Problem zu beheben, fügen Sie nach return eine StringAssert-Anweisung zum Block catch hinzu. Wenn Sie den Test erneut ausführen, bestätigen Sie, dass Sie dieses Problem behoben haben. Die fertige Version von Debit_WhenAmountIsMoreThanBalance_ShouldThrowArgumentOutOfRange sieht wie folgt aus:

[TestMethod]
public void Debit_WhenAmountIsMoreThanBalance_ShouldThrowArgumentOutOfRange()
{
    // Arrange
    double beginningBalance = 11.99;
    double debitAmount = 20.0;
    BankAccount account = new BankAccount("Mr. Bryan Walton", beginningBalance);

    // Act
    try
    {
        account.Debit(debitAmount);
    }
    catch (System.ArgumentOutOfRangeException e)
    {
        // Assert
        StringAssert.Contains(e.Message, BankAccount.DebitAmountExceedsBalanceMessage);
        return;
    }

    Assert.Fail("The expected exception was not thrown.");
}

Schlussbemerkung

Aufgrund der Verbesserungen des Testcodes wurden stabilere und informationsreichere Testmethoden erstellt. Aber noch wichtiger: es wurde auch der Code verbessert, der getestet werden soll.

Tipp

In dieser exemplarischen Vorgehensweise wird das Microsoft-Komponententest-Framework für verwalteten Code verwendet. Der Test-Explorer kann außerdem Tests von Komponententestframeworks von Drittanbietern ausführen, die über Adapter für den Test-Explorer verfügen. Weitere Informationen finden Sie unter Installieren von Frameworks für Komponententests von Drittanbietern.

Informationen zum Ausführen von Tests über die Befehlszeile finden Sie unter Exemplarische Vorgehensweise: Befehlszeilenoptionen für VSTest.Console.exe.

Freigeben über

Exemplarische Vorgehensweise: Erstellen und Ausführen von Komponententests für verwalteten Code

Erstellen eines zu testenden Projekts

Ein Komponententestprojekt erstellen

Die Testklasse erstellen

Umbenennen einer Datei und Klasse

Hinzufügen einer Using-Anweisung

Testklassenanforderungen

Die erste Testmethode erstellen

So erstellen Sie eine Testmethode

Testmethodenanforderungen

Den Test erstellen und ausführen

Den Code korrigieren und die Tests erneut ausführen

Korrigieren des Fehlers

Erneutes Ausführen des Tests

Den Code mit Komponententests verbessern

Analysieren der Probleme

Erstellen und Ausführen neuer Testmethoden

Fortführen der Analyse

Umgestalten des zu testenden Codes

Umgestalten der Testmethoden

Erneut testen, umschreiben und neu analysieren

Schlussbemerkung

Feedback

Zusätzliche Ressourcen

Freigeben über

Exemplarische Vorgehensweise: Erstellen und Ausführen von Komponententests für verwalteten Code

Erstellen eines zu testenden Projekts

Ein Komponententestprojekt erstellen

Die Testklasse erstellen

Umbenennen einer Datei und Klasse

Hinzufügen einer Using-Anweisung

Testklassenanforderungen

Die erste Testmethode erstellen

So erstellen Sie eine Testmethode

Testmethodenanforderungen

Den Test erstellen und ausführen

Den Code korrigieren und die Tests erneut ausführen

Korrigieren des Fehlers

Erneutes Ausführen des Tests

Den Code mit Komponententests verbessern

Analysieren der Probleme

Erstellen und Ausführen neuer Testmethoden

Fortführen der Analyse

Umgestalten des zu testenden Codes

Umgestalten der Testmethoden

Erneut testen, umschreiben und neu analysieren

Schlussbemerkung

Zugehöriger Inhalt

Feedback

Zusätzliche Ressourcen