Gewusst wie: Erstellen einer benutzerdefinierten Extraktionsregel

Artikel
09/02/2008

Aktualisiert: November 2007

Sie können eigene Extraktionsregeln erstellen. Leiten Sie hierzu Ihre Regeln von einer bereits vorhandenen Klasse für Extraktionsregeln ab. Extraktionsregeln werden von der ExtractionRule-Basisklasse abgeleitet.

Visual Studio Team System Test Edition stellt einige vordefinierte Extraktionsregeln bereit. Weitere Informationen finden Sie unter Extraktionsregeln.

Hinweis:
Sie können auch benutzerdefinierte Validierungsregeln erstellen. Weitere Informationen finden Sie unter Validierungsregeln.

So erstellen Sie eine benutzerdefinierte Extraktionsregel

Öffnen Sie ein Testprojekt, das einen Webtest enthält.

(Optional) Erstellen Sie ein separates Klassenbibliotheksprojekt zum Speichern der Extraktionsregel.

Wichtiger Hinweis:
Die Klasse kann im Projekt erstellt werden, in dem sich die Tests befinden. Wenn die Regel jedoch erneut verwendet werden soll, wird empfohlen, ein separates Klassenbibliotheksprojekt zum Speichern der Regel zu erstellen. Zum Erstellen eines separaten Projekts müssen Sie die optionalen Schritte dieses Verfahrens ausführen.

(Optional) Fügen Sie im Klassenbibliotheksprojekt einen Verweis auf Microsoft.VisualStudio.QualityTools.WebTestFramework dll hinzu.
Erstellen Sie eine von der ExtractionRule-Klasse abgeleitete Klasse. Implementieren Sie den Extract-Member und den RuleName-Member.
(Optional) Erstellen Sie das neue Klassenbibliotheksprojekt.
(Optional) Fügen Sie im Testprojekt einen Verweis auf das Klassenbibliotheksprojekt mit der benutzerdefinierten Extraktionsregel hinzu.
Öffnen Sie einen Webtest des Testprojekts im Webtest-Editor.
Um die benutzerdefinierte Extraktionsregel hinzuzufügen, klicken Sie mit der rechten Maustaste auf eine Webtestanforderung, und wählen Sie Extraktionsregel hinzufügen aus.

Das Dialogfeld Extraktionsregel hinzufügen wird angezeigt. Die benutzerdefinierte Validierungsregel wird zusammen mit den vordefinierten Validierungsregeln in der Liste Regel auswählen angezeigt. Wählen Sie die benutzerdefinierte Extraktionsregel aus, und klicken Sie auf OK.
Führen Sie den Webtest aus.

Beispiel

Im folgenden Code wird eine Implementierung einer benutzerdefinierten Extraktionsregel dargestellt. Diese Extraktionsregel extrahiert den Wert eines angegebenen Eingabefelds. Verwenden Sie dieses Beispiel als Ausgangspunkt für eigene benutzerdefinierte Extraktionsregeln.

using System;
using System.Collections.Generic;
using Microsoft.VisualStudio.TestTools.WebTesting;
using System.Globalization;

namespace ClassLibrary2
{
    //-------------------------------------------------------------------------
    // This class creates a custom extraction rule named "Custom Extract Input"
    // The user of the rule specifies the name of an input field, and the
    // rule attempts to extract the value of that input field.
    //-------------------------------------------------------------------------
    public class CustomExtractInput : ExtractionRule
    {
        /// Specify a name for use in the user interface.
        /// The user sees this name in the Add Extraction dialog box.
        //---------------------------------------------------------------------
        public override string RuleName
        {
            get { return "Custom Extract Input"; }
        }

        /// Specify a description for use in the user interface.
        /// The user sees this description in the Add Extraction dialog box.
        //---------------------------------------------------------------------
        public override string RuleDescription
        {
            get { return "Extracts the value from a specified input field"; }
        }

        // The name of the desired input field
        private string NameValue;
        public string Name
        {
            get { return NameValue; }
            set { NameValue = value; }
        }

        // The Extract method.  The parameter e contains the Web test context.
        //---------------------------------------------------------------------
        public override void Extract(object sender, ExtractionEventArgs e)
        {
            if (e.Response.HtmlDocument != null)
            {
                foreach (HtmlTag tag in e.Response.HtmlDocument.GetFilteredHtmlTags(new string[] { "input" }))
                {
                    if (String.Equals(tag.GetAttributeValueAsString("name"), Name, StringComparison.InvariantCultureIgnoreCase))
                    {
                        string formFieldValue = tag.GetAttributeValueAsString("value");
                        if (formFieldValue == null)
                        {
                            formFieldValue = String.Empty;
                        }

                        // add the extracted value to the Web test context
                        e.WebTest.Context.Add(this.ContextParameterName, formFieldValue);
                        e.Success = true;
                        return;
                    }
                }
            }
            // If the extraction fails, set the error text that the user sees
            e.Success = false;
            e.Message = String.Format(CultureInfo.CurrentCulture, "Not Found: {0}", Name);
        }
    }
}

Imports System
Imports System.Collections.Generic
Imports Microsoft.VisualStudio.TestTools.WebTesting
Imports System.Globalization

Namespace ClassLibrary2

    '-------------------------------------------------------------------------
    ' This class creates a custom extraction rule named "Custom Extract Input"
    ' The user of the rule specifies the name of an input field, and the
    ' rule attempts to extract the value of that input field.
    '-------------------------------------------------------------------------
    Public Class CustomExtractInput
        Inherits ExtractionRule

        ' Specify a name for use in the user interface.
        ' The user sees this name in the Add Extraction dialog box.
        '---------------------------------------------------------------------
        Public Overrides ReadOnly Property RuleName() As String
            Get
                Return "Custom Extract Input"
            End Get
        End Property

        ' Specify a description for use in the user interface.
        ' The user sees this description in the Add Extraction dialog box.
        '---------------------------------------------------------------------
        Public Overrides ReadOnly Property RuleDescription() As String
            Get
                Return "Extracts the value from a specified input field"
            End Get
        End Property

        ' The name of the desired input field
        Private NameValue As String
        Public Property Name() As String
            Get
                Return NameValue
            End Get
            Set(ByVal value As String)
                NameValue = value
            End Set
        End Property

        ' The Extract method.  The parameter e contains the Web test context.
        '---------------------------------------------------------------------
        Public Overrides Sub Extract(ByVal sender As Object, ByVal e As ExtractionEventArgs)

            If Not e.Response.HtmlDocument Is Nothing Then

                For Each tag As HtmlTag In e.Response.HtmlDocument.GetFilteredHtmlTags(New String() {"input"})

                    If String.Equals(tag.GetAttributeValueAsString("name"), Name, StringComparison.InvariantCultureIgnoreCase) Then

                        Dim formFieldValue As String = tag.GetAttributeValueAsString("value")
                        If formFieldValue Is Nothing Then

                            formFieldValue = String.Empty
                        End If

                        ' add the extracted value to the Web test context
                        e.WebTest.Context.Add(Me.ContextParameterName, formFieldValue)
                        e.Success = True
                        Return
                    End If
                Next
            End If
            ' If the extraction fails, set the error text that the user sees
            e.Success = False
            e.Message = String.Format(CultureInfo.CurrentCulture, "Not Found: {0}", Name)
        End Sub
    End Class
end namespace

Die Extract-Methode enthält die Basisfunktionalität einer Extraktionsregel. An die Extract-Methode im vorherigen Beispiel wird ExtractionEventArgs übergeben, worin die Antwort der Anforderung zurückgegeben wird, auf die diese Extraktionsregel angewendet wird. Die Antwort beinhaltet ein HtmlDocument, das alle Tags aus der Antwort enthält. Eingabetags werden dabei aus dem HtmlDocument herausgefiltert. Jedes Eingabetag wird auf ein name-Attribut hin überprüft, dessen Wert mit der vom Benutzer bereitgestellten Name-Eigenschaft übereinstimmt. Wenn ein Tag mit diesem übereinstimmenden Attribut gefunden wird, wird versucht, einen im value-Attribut enthaltenen Wert zu extrahieren, sofern ein value-Attribut vorhanden ist. Ist dieses Attribut ebenfalls vorhanden, werden Name und Wert des Tags extrahiert und dem Webtestkontext hinzugefügt. Die Extraktionsregel wurde damit erfolgreich ausgeführt.