Configuration de Specflow dans les projets .NET

Pour commencer à utiliser Specflow dans vos projets .NET, vous devez d'abord installer le package NuGet Specflow pour configurer votre framework de test, créer des fichiers de fonctionnalités et définir des scénarios de test.

1. Ouvrez Visual Studio.
2. Créez un nouveau projet .NET ou ouvrez-en un existant.
3. Allez au menu Extensions puis Gérer les extensions.
4. Recherchez "Specflow". Installez l'extension Specflow.

Un exemple de code de base

Une fois Specflow configuré, vous pouvez créer votre premier fichier de fonctionnalité, qui résidera dans le dossier des fonctionnalités. Un fichier de fonctionnalité dans Specflow décrit les comportements que vous souhaitez tester dans un format lisible. Voici un exemple simple de comment créer un nouveau fichier de fonctionnalité et définir des scénarios :

Feature: Login Feature
    Scenario: Successful Login with Valid Credentials
        Given I am on the login page
        When I enter valid credentials
        Then I should be redirected to the dashboard

Ce fichier de fonctionnalité décrit un processus de connexion de base. Given met en place le contexte du test. When décrit l'action. Then définit le résultat attendu. Vous écrivez ces déclarations en anglais simple. Cela facilite la compréhension du déroulement et de l'objectif du test.

Écrire des tests avec des définitions de pas

Dans Specflow, les tests sont conduits par les scénarios décrits dans les fichiers de fonctionnalités. Pour que ces scénarios soient exécutables, vous avez besoin de définitions de pas. Les définitions de pas lient les étapes en langage simple au code C#. Voici comment vous définissez des définitions de pas :

[Binding]
public class LoginSteps
{
    [Given(@"I am on the login page")]
    public void GivenIAmOnTheLoginPage()
    {
        // Code to navigate to the login page
    }

    [When(@"I enter valid credentials")]
    public void WhenIEnterValidCredentials()
    {
        // Code to input username and password
    }

    [Then(@"I should be redirected to the dashboard")]
    public void ThenIShouldBeRedirectedToTheDashboard()
    {
        // Code to verify the dashboard is displayed
    }
}

[Binding]
public class LoginSteps
{
    [Given(@"I am on the login page")]
    public void GivenIAmOnTheLoginPage()
    {
        // Code to navigate to the login page
    }

    [When(@"I enter valid credentials")]
    public void WhenIEnterValidCredentials()
    {
        // Code to input username and password
    }

    [Then(@"I should be redirected to the dashboard")]
    public void ThenIShouldBeRedirectedToTheDashboard()
    {
        // Code to verify the dashboard is displayed
    }
}

<Binding>
Public Class LoginSteps
	<Given("I am on the login page")>
	Public Sub GivenIAmOnTheLoginPage()
		' Code to navigate to the login page
	End Sub

	<[When]("I enter valid credentials")>
	Public Sub WhenIEnterValidCredentials()
		' Code to input username and password
	End Sub

	<[Then]("I should be redirected to the dashboard")>
	Public Sub ThenIShouldBeRedirectedToTheDashboard()
		' Code to verify the dashboard is displayed
	End Sub
End Class

Cette classe C# représente les étapes du scénario de connexion. Chaque méthode est étiquetée avec un attribut Specflow correspondant au type d'étape, comme une clé de chaîne pour identifier des étapes spécifiques.

Tests pilotés par les données

Specflow prend en charge les tests pilotés par les données en vous permettant d'utiliser divers ensembles de données de test dans vos scénarios. Cela vous permet de tester des scénarios avec divers ensembles de données. Voici un exemple utilisant un tableau dans un fichier de fonctionnalité :

Scenario: Login with multiple users
    Given I am on the login page
    When I login with the following credentials:
        | Username  | Password  |
        | user1     | pass1     |
        | user2     | pass2     |
    Then I should see user specific dashboard

Dans vos définitions de pas, vous pouvez accéder à ces données comme suit :

[When(@"I login with the following credentials:")]
public void WhenILoginWithTheFollowingCredentials(Table table)
{
    foreach(var row in table.Rows)
    {
        string username = row["Username"];
        string password = row["Password"];
        // Code to perform login
    }
}

[When(@"I login with the following credentials:")]
public void WhenILoginWithTheFollowingCredentials(Table table)
{
    foreach(var row in table.Rows)
    {
        string username = row["Username"];
        string password = row["Password"];
        // Code to perform login
    }
}

<[When]("I login with the following credentials:")>
Public Sub WhenILoginWithTheFollowingCredentials(ByVal table As Table)
	For Each row In table.Rows
		Dim username As String = row("Username")
		Dim password As String = row("Password")
		' Code to perform login
	Next row
End Sub

Intégration avec Test Explorer

Specflow s'intègre avec le Test Explorer de Visual Studio, où vous pouvez exécuter et gérer tous les tests efficacement. Cela facilite l'exécution et la gestion de vos tests. Assurez-vous que votre projet est configuré correctement. Vos tests apparaîtront dans Test Explorer une fois que vous aurez construit le projet. Vous pouvez exécuter des tests individuels ou tous les tests à la fois.

Exécution parallèle des tests

Specflow prend en charge l'exécution de tests parallèles pour réduire le temps d'exécution global. Cela réduit le temps nécessaire pour exécuter tous les tests. Vous devez configurer votre fichier specflow.json ou AssemblyInfo.cs pour permettre l'exécution parallèle :

{
  "specFlow": {
    "runtime": {
      "testThreadCount": 4,
      "testSchedulingMode": "Parallel"
    }
  }
}

Cette configuration permet à quatre tests de s'exécuter en même temps.

Hooks personnalisés

Specflow vous permet de définir des hooks personnalisés. Ces hooks peuvent exécuter du code à différents points du cycle de vie du test. Voici comment vous pouvez définir un hook pour configurer une base de données avant l'exécution de tout test :

[BeforeTestRun]
public static void SetUpDatabase()
{
    // Code to set up database
}

[BeforeTestRun]
public static void SetUpDatabase()
{
    // Code to set up database
}

<BeforeTestRun>
Public Shared Sub SetUpDatabase()
	' Code to set up database
End Sub

Les hooks personnalisés sont une fonctionnalité puissante. Ils vous aident à gérer les processus de configuration et de démontage des tests.

Cette section a couvert cinq fonctionnalités clés de Specflow qui peuvent améliorer votre framework de test dans les projets .NET. Chaque fonctionnalité est conçue pour améliorer la flexibilité et l'efficacité de vos efforts d'automatisation de test.

Cas d'utilisation de la fusion d'IronPDF avec Specflow C#

Un cas d'utilisation pratique pour combiner IronPDF avec Specflow est de valider le contenu et la mise en forme d'un rapport PDF généré par votre application. Par exemple, vous pouvez automatiquement tester si un rapport contient les données correctes, respecte la mise en page attendue et est accessible selon les exigences stipulées. Cette intégration s'avère particulièrement utile dans les scénarios où une documentation précise, telle que des factures ou des rapports de conformité, est cruciale.

Assurez-vous d'avoir installé IronPDF. Vous pouvez l'installer en utilisant la console de package NuGet :

Install-Package IronPdf

Exemple de code du cas d'utilisation

Voici un exemple de code complet qui montre comment configurer une définition de pas SpecFlow pour tester le contenu PDF à l'aide d'IronPDF. Cet exemple suppose que vous testez un document PDF généré par votre application qui devrait contenir du texte spécifique :

using IronPdf;
using TechTalk.SpecFlow;

[Binding]
public class PdfContentSteps
{
    private string? _pdfPath;
    private PdfDocument? _pdfDocument;

    [Given(@"a PDF file generated at '(.*)'")]
    public void GivenAPDFFileGeneratedAt(string pdfPath)
    {
        _pdfPath = pdfPath;
        _pdfDocument = new PdfDocument(_pdfPath);
    }

    [Then(@"the PDF should contain the text '(.*)'")]
    public void ThenThePDFShouldContainTheText(string expectedText)
    {
        // Extract text from the PDF and check if it contains the expected text
        var textContent = _pdfDocument.ExtractAllText();
        if (!textContent.Contains(expectedText))
        {
            throw new Exception("PDF content does not contain the expected text.");
        }
    }
}

using IronPdf;
using TechTalk.SpecFlow;

[Binding]
public class PdfContentSteps
{
    private string? _pdfPath;
    private PdfDocument? _pdfDocument;

    [Given(@"a PDF file generated at '(.*)'")]
    public void GivenAPDFFileGeneratedAt(string pdfPath)
    {
        _pdfPath = pdfPath;
        _pdfDocument = new PdfDocument(_pdfPath);
    }

    [Then(@"the PDF should contain the text '(.*)'")]
    public void ThenThePDFShouldContainTheText(string expectedText)
    {
        // Extract text from the PDF and check if it contains the expected text
        var textContent = _pdfDocument.ExtractAllText();
        if (!textContent.Contains(expectedText))
        {
            throw new Exception("PDF content does not contain the expected text.");
        }
    }
}

Imports IronPdf
Imports TechTalk.SpecFlow

<Binding>
Public Class PdfContentSteps
'INSTANT VB WARNING: Nullable reference types have no equivalent in VB:
'ORIGINAL LINE: private string? _pdfPath;
	Private _pdfPath As String
	Private _pdfDocument? As PdfDocument

	<Given("a PDF file generated at '(.*)'")>
	Public Sub GivenAPDFFileGeneratedAt(ByVal pdfPath As String)
		_pdfPath = pdfPath
		_pdfDocument = New PdfDocument(_pdfPath)
	End Sub

	<[Then]("the PDF should contain the text '(.*)'")>
	Public Sub ThenThePDFShouldContainTheText(ByVal expectedText As String)
		' Extract text from the PDF and check if it contains the expected text
		Dim textContent = _pdfDocument.ExtractAllText()
		If Not textContent.Contains(expectedText) Then
			Throw New Exception("PDF content does not contain the expected text.")
		End If
	End Sub
End Class

Dans ce code, nous définissons un pas Specflow qui charge d'abord un PDF à partir d'un chemin spécifié puis vérifie que ce PDF contient le texte attendu. La classe IronPdf.PdfDocument est utilisée pour charger et manipuler le fichier PDF. Cette configuration vous permet d'intégrer la validation PDF dans vos tests automatisés, facilitant la détection des erreurs.