.NETプロジェクトでのSpecflowのセットアップ

あなたの.NETプロジェクトでSpecflowを使用し始めるには、まずSpecflow NuGetパッケージをインストールしてテストフレームワークをセットアップし、機能ファイルを作成し、テストシナリオを定義する必要があります。

1. Visual Studioを開きます。
2. 新しい.NETプロジェクトを作成するか、既存のものを開く。
3. 拡張機能メニューに移動して拡張機能を管理します。
4. 「Specflow」を検索します。 Specflow拡張機能をインストールします。

基本的なコード例

Specflowがセットアップされると、最初の機能ファイルを作成できます。これは、機能フォルダ内に配置されます。 Specflowの機能ファイルは、テストしたい振る舞いを読みやすい形式で概説します。 新しい機能ファイルを作成してシナリオを定義する方法の簡単な例です:

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

この機能ファイルは、基本的なログインプロセスを説明しています。 Givenはテストの場面を設定します。 Whenはアクションを説明します。 Thenは予想される結果を定義します。 これらの文を平易な英語で書きます。 これにより、テストの流れと目的を理解しやすくなります。

ステップ定義を使用したテストの記述

Specflowでは、テストは機能ファイルに概説されたシナリオによって駆動されます。 これらのシナリオを実行可能にするために、ステップ定義が必要です。 ステップ定義は、平易な言葉のステップをC#コードに結びつけます。 ステップ定義を定義する方法は次のとおりです。

[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

このC#クラスはログインシナリオのステップを表しています。 各メソッドは特定のステップを識別するための文字列キーなど、ステップタイプに対応するSpecflow属性でタグ付けされています。

データ駆動型テスト

Specflowはデータ駆動型テストをサポートし、シナリオでさまざまなテストデータセットを利用できます。 これにより、さまざまなデータセットを使用してシナリオをテストできます。 機能ファイルでテーブルを使用した例は次のとおりです。

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

ステップ定義でこのデータにアクセスする方法:

[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

Test Explorerとの統合

SpecflowはVisual StudioのTest Explorerと統合しており、すべてのテストを効率的に実行および管理できます。 これにより、テストを簡単に実行および管理できます。 プロジェクトが正しく構成されていることを確認してください。 プロジェクトをビルドするとテストがTest Explorerに表示されます。 個別のテストまたは全テストを一度に実行できます。

並列テスト実行

Specflowは全体の実行時間を短縮するために並列テストをサポートしています。これにより、すべてのテストを実行する時間が短縮されます。 並列実行を有効にするためにspecflow.jsonまたはAssemblyInfo.csファイルを設定する必要があります:

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

この構成により、最大4つのテストを同時に実行できます。

カスタムフック

Specflowはカスタムフックを定義することを許可しています。 これらのフックはテストライフサイクルのさまざまなポイントでコードを実行できます。 データベースを設定するためのフックを定義し、どのテストも実行される前に設定する方法は次のとおりです。

[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

カスタムフックは強力な機能です。 それはテスト設定と解除プロセスを管理するのに役立ちます。

このセクションは、.NETプロジェクトのテスティングフレームワークを強化するSpecflowの5つの重要な機能を紹介しました。 各機能は、テスト自動化の柔軟性と効率を向上させるように設計されています。

IronPDFとSpecflow C#を組み合わせたユースケース

IronPDFとSpecflowを組み合わせた実用的なユースケースは、アプリケーションが生成したPDFレポートの内容とフォーマットを検証することです。 たとえば、レポートに正しいデータが含まれていないか、予想されたレイアウトに従い、必要な要件内でアクセス可能であるかを自動でテストできます。 この統合は、請求書やコンプライアンスレポートなど、正確なドキュメントが重要なシナリオで特に役立ちます。

IronPDFをインストールしていることを確認してください。 NuGetパッケージコンソールを使用してインストールできます:

Install-Package IronPdf

ユースケースのコード例

IronPDFを使用してPDF内容をテストするためのSpecflowステップ定義を設定する方法を示す完全なコード例を次に示します。 この例は、特定のテキストを含むべきアプリケーションによって生成されたPDFドキュメントをテストしていると仮定しています。

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

このコードでは、指定されたパスからPDFを最初にロードし、それが期待されるテキストを含んでいることを確認するSpecflowステップを定義します。 IronPdf.PdfDocumentクラスが使用され、PDFファイルをロードおよび操作します。このセットアップにより、PDF検証を自動化されたテストに統合し、エラーを容易に見つけられるようにします。