Exemplarische Vorgehensweise: Verwenden einer benutzerdefinierten Testbedingung zur Überprüfung der Ergebnisse einer gespeicherten Prozedur

Artikel
06/02/2023

In dieser exemplarischen Vorgehensweise zu Funktionserweiterungen erstellen Sie eine Testbedingung und überprüfen deren Funktionsfähigkeit, indem Sie einen SQL Server-Komponententest erstellen. In diesem Verfahren wird ein Klassenbibliotheksprojekt für die Testbedingung erstellt und die Testbedingung signiert und installiert. Wenn Sie bereits eine Testbedingung haben, die aktualisiert werden soll, lesen Sie Gewusst wie: Durchführen eines Upgrades für eine benutzerdefinierte Visual Studio 2010-Testbedingung von einem älteren Release auf SQL Server Data Tools.

In dieser exemplarischen Vorgehensweise werden die folgenden Aufgaben veranschaulicht:

Erstellen einer Testbedingung
Signieren der Assembly mit einem starken Namen
Hinzufügen der erforderlichen Verweise zum Projekt
Erstellen einer Testbedingung
Installieren der neuen Testbedingung
Testen der neuen Testbedingung

Für die Durchführung dieser exemplarischen Vorgehensweise müssen Sie Visual Studio 2010 oder Visual Studio 2012 mit der neuesten Version von SQL Server Data Tools verwenden. Weitere Informationen finden Sie unter Installieren von SQL Server Data Tools.

Erstellen einer benutzerdefinierten Testbedingung

Zunächst erstellen Sie eine Klassenbibliothek.

Klicken Sie im Menü Datei auf Neu und dann auf Projekt.
Klicken Sie im Dialogfeld Neues Projekt unter Projekttypen auf „Visual C#“.
Wählen Sie unter Vorlagen den Eintrag Klassenbibliothek aus.
Geben Sie im Textfeld Name den Namen ColumnCountCondition ein, und klicken Sie dann auf OK.

Als Nächstes signieren Sie das Projekt.

Klicken Sie im Menü Projekt auf ColumnCountCondition-Eigenschaften.
Aktivieren Sie auf der Registerkarte Signierung das Kontrollkästchen Assembly signieren.
Klicken Sie im Feld Schlüsseldatei mit starkem Namen wählen auf <Neu...>.

Das Dialogfeld Schlüssel mit starkem Namen erstellen wird geöffnet.
Geben Sie im Feld Schlüsseldateiname die Zeichenfolge SampleKey ein.
Geben Sie das Kennwort ein, bestätigen Sie es, und klicken Sie dann auf OK. Wenn Sie die Projektmappe erstellen, wird die Schlüsseldatei zum Signieren der Assembly verwendet.
Klicken Sie im Menü Datei auf Alle speichern.
Klicken Sie im Menü Build auf Projektmappe erstellen.

Im nächsten Schritt fügen Sie dem Projekt die erforderlichen Verweise hinzu.

Wählen Sie im Projektmappen-Explorer das Projekt ColumnCountCondition aus.
Klicken Sie im Menü Projekt auf Verweis hinzufügen, um das Dialogfeld Verweis hinzufügen anzuzeigen.
Wählen Sie die Registerkarte .NET aus.
Suchen Sie in der Spalte Komponentenname die Komponente System.ComponentModel.Composition, und wählen Sie sie aus. Klicken Sie auf OK, nachdem Sie die Komponente ausgewählt haben.
Fügen Sie die erforderlichen Assemblyverweise hinzu. Klicken Sie mit der rechten Maustaste auf den Projektknoten, und klicken Sie dann auf Verweis hinzufügen. Klicken Sie auf Durchsuchen und navigieren Sie zum C:\Program Files (x86)\Microsoft SQL Server\110\DAC\Bin-Ordner. Wählen Sie „Microsoft.Data.Tools.Schema.Sql.dll“ aus, klicken Sie auf „Hinzufügen“, und klicken Sie dann auf „OK“.
Klicken Sie im Menü Projekt auf Projekt entladen.
Klicken Sie im Projektmappen-Explorer mit der rechten Maustaste auf das Projekt, und wählen Sie <Projektname>.csproj bearbeiten aus.

Fügen Sie nach dem Import von Microsoft.CSharp.targets folgende Import-Anweisung hinzu:

<Import Project="$(MSBuildExtensionsPath32)\Microsoft\VisualStudio\v10.0\SSDT\Microsoft.Data.Tools.Schema.Sql.UnitTesting.targets" Condition="'$(VisualStudioVersion)' == ''" />  

<Import Project="$(MSBuildExtensionsPath32)\Microsoft\VisualStudio\v$(VisualStudioVersion)\SSDT\Microsoft.Data.Tools.Schema.Sql.UnitTesting.targets" Condition="'$(VisualStudioVersion)' != ''" />

Speichern Sie die Datei, und schließen Sie sie. Klicken Sie im Projektmappen-Explorer mit der rechten Maustaste auf das Projekt, und wählen Sie Projekt erneut laden aus.

Die erforderlichen Verweise werden unter dem Knoten Verweise des Projekts im Projektmappen-Explorer angezeigt.

Erstellen der ResultSetColumnCountCondition-Klasse

Benennen Sie jetzt Class1 in ResultSetColumnCountCondition, und leiten Sie sie von testcondition ab. Die Klasse ResultSetColumnCountCondition ist eine einfache Testbedingung, mit der die Anzahl der im Resultset zurückgegebenen Spalten überprüft wird. Mit dieser Bedingung können Sie sicherstellen, dass der Vertrag für eine gespeicherte Prozedur richtig ist.

Klicken Sie im Projektmappen-Explorer mit der rechten Maustaste auf „Class1.cs“, klicken Sie auf Umbenennen, und geben Sie ResultSetColumnCountCondition.cs ein.
Klicken Sie auf Ja, um zu bestätigen, dass alle Verweise in „Class1“ umbenannt werden sollen.

Öffnen Sie die Datei ResultSetColumnCountCondition.cs, und fügen Sie der Datei die folgenden using-Anweisungen hinzu:

using System;  
using System.ComponentModel;  
using System.Data;  
using System.Data.Common;  
using Microsoft.Data.Tools.Schema.Sql.UnitTesting;  
using Microsoft.Data.Tools.Schema.Sql.UnitTesting.Conditions;  

namespace ColumnCountCondition {  
    public class ResultSetColumnCountCondition

Leiten Sie die Klasse von testcondition ab:

public class ResultSetColumnCountCondition : TestCondition

Fügen Sie ExportTestConditionAttribute hinzu. Unter Vorgehensweise: Erstellen von Testbedingungen für den SQL Server-Komponententest-Designer erhalten Sie weitere Informationen über UnitTesting.Conditions.ExportTestConditionAttribute.
```
[ExportTestCondition("ResultSet Column Count", typeof(ResultSetColumnCountCondition))]  
    public class ResultSetColumnCountCondition : TestCondition  
```

Erstellen Sie die Membervariablen und den Konstruktor:

        private int _resultSet;  
        private int _count;  
        private int _batch;  

        public ResultSetColumnCountCondition() {  
            _resultSet = 1;  
            _count = 0;  
            _batch = 1;  
        }

Überschreiben Sie die Assert-Methode. Die Methode enthält Argumente für IDbConnection, d.h. die Verbindung mit der Datenbank, sowie SqlExecutionResult. In der Methode wird DataSchemaException für die Fehlerbehandlung verwendet:

       //method you need to override  
        //to perform the condition verification  
        public override void Assert(DbConnection validationConnection, SqlExecutionResult[] results)  
        {  
            //call base for parameter validation  
            base.Assert(validationConnection, results);  

            //verify batch exists  
            if (results.Length < _batch)  
                throw new DataException(String.Format("Batch {0} does not exist", _batch));  

            SqlExecutionResult result = results[_batch - 1];  

            //verify resultset exists  
            if (result.DataSet.Tables.Count < ResultSet)  
                throw new DataException(String.Format("ResultSet {0} does not exist", ResultSet));  

            DataTable table = result.DataSet.Tables[ResultSet - 1];  

            //actual condition verification  
            //verify resultset column count matches expected  
            if (table.Columns.Count != Count)  
                throw new DataException(String.Format(  
                    "ResultSet {0}: {1} columns did not match the {2} columns expected",  
                    ResultSet, table.Columns.Count, Count));  
        }  

Add the following method, which overrides the ToString method:  
C#  
        //this method is called to provide the string shown in the  
        //test conditions panel grid describing what the condition tests  
        public override string ToString()  
        {  
            return String.Format(  
                "Condition fails if ResultSet {0} does not contain {1} columns",  
                ResultSet, Count);  
        }

Fügen Sie die folgenden Eigenschaften für Testbedingungen hinzu, indem Sie die Attribute CategoryAttribute, DisplayNameAttribute, und DescriptionAttribute verwenden:

        //below are the test condition properties  
        //that are exposed to the user in the property browser  
        #region Properties  

        //property specifying the resultset for which  
        //you want to check the column count  
        [Category("Test Condition")]  
        [DisplayName("ResultSet")]  
        [Description("ResultSet Number")]  
        public int ResultSet  
        {  
            get { return _resultSet; }  

            set  
            {  
                //basic validation  
                if (value < 1)  
                    throw new ArgumentException("ResultSet cannot be less than 1");  

                _resultSet = value;  
            }  
        }  

        //property specifying  
        //expected column count  
        [Category("Test Condition")]  
        [DisplayName("Count")]  
        [Description("Column Count")]  
        public int Count  
        {  
            get { return _count; }  

            set  
            {  
                //basic validation  
                if (value < 0)  
                    throw new ArgumentException("Count cannot be less than 0");  

                _count = value;  
            }  
        }  
         #endregion

Die fertige Codeauflistung lautet:

using System;  
using System.ComponentModel;  
using System.Data;  
using System.Data.Common;  
using Microsoft.Data.Tools.Schema.Sql.UnitTesting;  
using Microsoft.Data.Tools.Schema.Sql.UnitTesting.Conditions;  
  
namespace ColumnCountCondition  
{  
  
    [ExportTestCondition("ResultSet Column Count", typeof(ResultSetColumnCountCondition))]  
    public class ResultSetColumnCountCondition : TestCondition  
    {  
        private int _resultSet;  
        private int _count;  
        private int _batch;  
  
        public ResultSetColumnCountCondition()  
        {  
            _resultSet = 1;  
            _count = 0;  
            _batch = 1;  
        }  
  
        //method you need to override  
        //to perform the condition verification  
        public override void Assert(DbConnection validationConnection, SqlExecutionResult[] results)  
        {  
            //call base for parameter validation  
            base.Assert(validationConnection, results);  
  
            //verify batch exists  
            if (results.Length < _batch)  
                throw new DataException(String.Format("Batch {0} does not exist", _batch));  
  
            SqlExecutionResult result = results[_batch - 1];  
  
            //verify resultset exists  
            if (result.DataSet.Tables.Count < ResultSet)  
                throw new DataException(String.Format("ResultSet {0} does not exist", ResultSet));  
  
            DataTable table = result.DataSet.Tables[ResultSet - 1];  
  
            //actual condition verification  
            //verify resultset column count matches expected  
            if (table.Columns.Count != Count)  
                throw new DataException(String.Format(  
                    "ResultSet {0}: {1} columns did not match the {2} columns expected",  
                    ResultSet, table.Columns.Count, Count));  
        }  
  
        //this method is called to provide the string shown in the  
        //test conditions panel grid describing what the condition tests  
        public override string ToString()  
        {  
            return String.Format(  
                "Condition fails if ResultSet {0} does not contain {1} columns",  
                ResultSet, Count);  
        }  
  
        //below are the test condition properties  
        //that are exposed to the user in the property browser  
        #region Properties  
  
        //property specifying the resultset for which  
        //you want to check the column count  
        [Category("Test Condition")]  
        [DisplayName("ResultSet")]  
        [Description("ResultSet Number")]  
        public int ResultSet  
        {  
            get { return _resultSet; }  
  
            set  
            {  
                //basic validation  
                if (value < 1)  
                    throw new ArgumentException("ResultSet cannot be less than 1");  
  
                _resultSet = value;  
            }  
        }  
  
        //property specifying  
        //expected column count  
        [Category("Test Condition")]  
        [DisplayName("Count")]  
        [Description("Column Count")]  
        public int Count  
        {  
            get { return _count; }  
  
            set  
            {  
                //basic validation  
                if (value < 0)  
                    throw new ArgumentException("Count cannot be less than 0");  
  
                _count = value;  
            }  
        }  
  
        #endregion  
    }  
}

Als Nächstes wird das Projekt erstellt.

Kompilieren des Projekts und Installieren der Testbedingung

Klicken Sie im Menü Build auf Projektmappe erstellen.

Im nächsten Schritt kopieren Sie die Assemblyinformationen in das Verzeichnis „Extensions“. Beim Start von Visual Studio werden alle Erweiterungen im Ordner „%Program Files%\Microsoft Visual Studio <Version>\Common7\IDE\Extensions\Microsoft\SQLDB\TestConditions“ und den zugehörigen Unterverzeichnissen identifiziert und für die Verwendung zur Verfügung gestellt:

Kopieren Sie die Assemblydatei ColumnCountCondition.dll aus dem Ausgabeverzeichnis in das Verzeichnis „%Program Files%\Microsoft Visual Studio <Version>\Common7\IDE\Extensions\Microsoft\SQLDB\TestConditions“.

Der Pfad Ihrer kompilierten DLL-Datei lautet standardmäßig „IhrProjektmappenpfad\IhrProjektpfad\bin\Debug“ oder „IhrProjektmappenpfad\IhrProjektpfad\bin\Release“.

Als Nächstes starten Sie eine neue Visual Studio-Sitzung und erstellen ein Datenbankprojekt. So starten Sie eine neue Visual Studio-Sitzung und erstellen ein Datenbankprojekt

Starten Sie eine zweite Visual Studio-Sitzung.
Klicken Sie im Menü Datei auf Neu und dann auf Projekt.
Wählen Sie im Dialogfeld Neues Projekt in der Liste installierter Vorlagen den Knoten SQL Server aus.
Klicken Sie im Detailbereich auf SQL Server-Datenbankprojekt.
Geben Sie im Textfeld Name den Namen SampleConditionDB ein, und klicken Sie dann auf OK.

Jetzt muss ein Komponententest erstellt werden. So erstellen Sie einen SQL Server-Komponententest in einer neuen Testklasse

Klicken Sie im Menü Test auf Neuer Test, um das Dialogfeld Neuen Test hinzufügen aufzurufen.

Sie können auch den Projektmappen-Explorer öffnen, mit der rechten Maustaste auf ein Testprojekt klicken, auf Hinzufügen zeigen und dann auf Neuer Test klicken.
Klicken Sie in der Vorlagenliste auf SQL Server-Komponententest.
Geben Sie unter Testname Folgendes ein: SampleUnitTest.
Klicken Sie unter Zu Testprojekt hinzufügen auf Neues Visual C#-Testprojekt erstellen. Klicken Sie dann auf OK, um das Dialogfeld Neues Testprojekt anzuzeigen.
Geben Sie als Projektnamen SampleUnitTest ein.
Klicken Sie auf Abbrechen, um den Komponententest zu erstellen, ohne dass das Testprojekt für die Verwendung einer Datenbankverbindung konfiguriert wird. Der leere Test wird im SQL Server-Komponententest-Designer angezeigt. Dem Testprojekt wird eine Visual C#-Quellcodedatei hinzugefügt.

Weitere Informationen zum Erstellen und Konfigurieren von Datenbankkomponententests mit Datenbankverbindungen finden Sie unter Vorgehensweise: Erstellen eines leeren SQL Server-Komponententests.
Klicken Sie auf Klicken Sie zum Erstellen hierauf, um die Erstellung des Komponententests abzuschließen. Die neue Testbedingung wird im SQL Server-Projekt angezeigt.

Hinweis

Zur Verwendung der benutzerdefinierten Testbedingung mit vorhandenen Komponententestprojekten muss mindestens eine neue SQL Server-Komponententestklasse erstellt werden. Der erforderliche Verweis auf die Testbedingungsassembly wird dem Testprojekt während der Erstellung der Testklasse hinzugefügt.

So zeigen Sie die neue Testbedingung an

Klicken Sie im SQL Server-Komponententest-Designer unter Testbedingungen unter der Spalte Name auf den Test „inconclusiveCondition1“.
Klicken Sie auf die Symbolleistenschaltfläche Testbedingung löschen, um den Test „inconclusiveCondition1“ zu entfernen.
Klicken Sie auf das Dropdownmenü Testbedingungen, und wählen Sie ResultSet-Spaltenanzahl aus.
Klicken Sie auf die Symbolleistenschaltfläche Testbedingung hinzufügen, um die benutzerdefinierte Testbedingung hinzuzufügen.
Konfigurieren Sie im Fenster Eigenschaften die Eigenschaften „Count“, „Enabled“ und „ResultSet“.

Weitere Informationen finden Sie unter Vorgehensweise: Hinzufügen von Testbedingungen zu SQL Server-Komponententests.

Weitere Informationen

Benutzerdefinierte Testbedingungen für SQL Server-Komponententests

Freigeben über

Exemplarische Vorgehensweise: Verwenden einer benutzerdefinierten Testbedingung zur Überprüfung der Ergebnisse einer gespeicherten Prozedur

Erstellen einer benutzerdefinierten Testbedingung

Erstellen der ResultSetColumnCountCondition-Klasse

Kompilieren des Projekts und Installieren der Testbedingung

Weitere Informationen

Feedback

Zusätzliche Ressourcen