Specflowでビヘイビア駆動開発に触れてみた

2018年12月23日

ソフトウェア開発には、その考え方や特徴によって「○○開発」と名前が付いている開発プロセスがいくつかありますが、今回はビヘイビア駆動開発（BDD）というものに触れる機会があったので、その覚え書きです。

1 ビヘイビア駆動開発とは？
2 SpecflowでBDDに触れてみる
3 まとめ

ビヘイビア駆動開発とは？

ビヘイビア駆動開発（以下、BDD）とは、ソフトウェアの「振る舞い」に注目した手法です。あらかじめ、開発したいソフトウェアの仕様を「振る舞い」として定義しておき、それを満たすコードを実装するというやり方を取ります。

事前にテストコードを作成する形になるので、テストファーストの開発手法の1つです。

SpecflowでBDDに触れてみる

一般的なテスト駆動開発と違い、BDDは自然言語に近い構文でテストを記述していくことが特徴的です。これを実現するためのフレームワークとして、今回はSpecflowというツールを使ってみます。

SpecflowはCucumberというBDDフレームワークのC#版で、VisualStudioに組み込んで使うことができます。ということで、さっそくBDDの一端に触れてみましょう(･∀･)

Specflowプラグインの導入

まずは、VisualStudioにSpecflowのプラグインを導入します。VS2010以降（Express版以外）に対応しているので、今回はVS2017（Community版）に導入してみました。導入自体は「ツール」>「拡張機能と更新プログラム」から検索してインストールするだけです。

テストプロジェクトの作成

続いて、テストプロジェクトを作成します。「ファイル」>「新規作成」>「プロジェクト」からC#の単体テストプロジェクトを選択します。

プロジェクトができたら、デフォルトで作成されるテストコード（UnitTest1.cs）は不要なので削除しておきます。

必要なファイルのインストール

Specflowの動作に必要なファイルをインストールしていきます。「ツール」>「NuGetパッケージマネージャー」>「パッケージマネージャーコンソール」を開いて、以下のコマンドを実行します。

PM> Install-Package SpecFlow -ProjectName <プロジェクト名>

プロジェクト中に「App.config」という設定ファイルができていれば、インストールは成功です。

Featureファイルの作成

ここからはテストシナリオの作成に入ります。まずはFeatureファイルというファイルを作ります。プロジェクトで「追加」>「新しい項目」>「Specflow Feature File」を選択します。

すると、以下のように英語で書かれたファイルが追加されますが、実はこれがテストシナリオそのものです。このように自然言語でテストシナリオを記述できるのが、BDDの特徴となります。


Feature: SpecFlowFeature1
	In order to avoid silly mistakes
	As a math idiot
	I want to be told the sum of two numbers

@mytag
Scenario: Add two numbers
	Given I have entered 50 into the calculator
	And I have also entered 70 into the calculator
	When I press add
	Then the result should be 120 on the screen

Feature: SpecFlowFeature1

In order to avoid silly mistakes

As a math idiot

I want to be told the sum of two numbers

@mytag

Scenario: Add two numbers

Given I have entered 50 into the calculator

And I have also entered 70 into the calculator

When I press add

Then the result should be 120 on the screen

上記のテストシナリオでは、電卓の足し算を例にいくつかのキーワードでシナリオを定義しています。以下、各キーワードとそれに対応したシナリオの説明です。

キーワード	意味	シナリオ
Given	事前条件	電卓に50を入力する
And	追加の事前条件	電卓に70を入力する
When	試行	足し算のボタンを押す
Then	事後条件（期待する結果）	結果が120となっていること

一見するとテストコードに見えませんが、これをSpecflowが解釈してテストとして実行してくれます。これにはちょっとびっくりしました(ﾟ_ﾟ;)

Stepファイルの作成

もちろん、シナリオだけではテストができないので、シナリオと紐付けるテストコードを実装する必要があります。

まずは、テストそのものを実行するテストランナーを指定します。App.configを開き、以下のような記述を書き加えます。今回はVS2017にデフォルトで入っているMSTestを指定しました。

続いて、先ほど作成したFeatureファイルを開き「右クリック」>「Generate Step Definitions」を選択すると、以下のようなウインドウが開きます。シナリオ全てが選択されていることを確認し「Generate」を押下しましょう。

これでfeatureファイルに定義したシナリオに対応したテストコードのひな形が自動生成されます。ちゃんと各キーワードに対応したメソッドが用意されていることが分かります。


using System;
using TechTalk.SpecFlow;

namespace CalcTest
{
    [Binding]
    public class SpecFlowFeature1Steps
    {
        [Given(@"I have entered (.*) into the calculator")]
        public void GivenIHaveEnteredIntoTheCalculator(int p0)
        {
            ScenarioContext.Current.Pending();
        }
        
        [Given(@"I have also entered (.*) into the calculator")]
        public void GivenIHaveAlsoEnteredIntoTheCalculator(int p0)
        {
            ScenarioContext.Current.Pending();
        }
        
        [When(@"I press add")]
        public void WhenIPressAdd()
        {
            ScenarioContext.Current.Pending();
        }
        
        [Then(@"the result should be (.*) on the screen")]
        public void ThenTheResultShouldBeOnTheScreen(int p0)
        {
            ScenarioContext.Current.Pending();
        }
    }
}

using System;

using TechTalk.SpecFlow;

namespace CalcTest

{

[Binding]

public class SpecFlowFeature1Steps

{

[Given(@"I have entered (.*) into the calculator")]

public void GivenIHaveEnteredIntoTheCalculator(int p0)

{

ScenarioContext.Current.Pending();

}

[Given(@"I have also entered (.*) into the calculator")]

public void GivenIHaveAlsoEnteredIntoTheCalculator(int p0)

{

ScenarioContext.Current.Pending();

}

[When(@"I press add")]

public void WhenIPressAdd()

{

ScenarioContext.Current.Pending();

}

[Then(@"the result should be (.*) on the screen")]

public void ThenTheResultShouldBeOnTheScreen(int p0)

{

ScenarioContext.Current.Pending();

}

テスト対象の作成とテストコード実装

ここまでで、テストシナリオ＋テストコードのひな形は作成できました。あとはテスト対象となるプログラムと、それに合わせたテストコードを実装していくだけです。

まずは電卓クラス。今回は簡単のために、2つの数の足し算のみを実装しました。


namespace Calc
{
	public class Calculator
	{
		public int number1;
		public int number2;

		public int Add()
		{
			return number1 + number2;
		}
    }
}

namespace Calc

{

public class Calculator

{

public int number1;

public int number2;

public int Add()

{

return number1 + number2;

}

続いてテストコード。こちらは電卓クラスのインスタンスを最初に作成し、各シナリオに対応するメソッド中でそのインスタンスに対する操作をしています。最後の「Then」に対応するコードは計算結果のチェックなので、Assertを入れています。


using TechTalk.SpecFlow;
using Calc;
using Microsoft.VisualStudio.TestTools.UnitTesting;

namespace CalcTest
{
    [Binding]
    public class SpecFlowFeature1Steps
    {
		private Calculator calc = new Calculator();
		private int result;

        [Given(@"I have entered (.*) into the calculator")]
        public void GivenIHaveEnteredIntoTheCalculator(int n)
        {
			calc.number1 = n;
        }
        
        [Given(@"I have also entered (.*) into the calculator")]
        public void GivenIHaveAlsoEnteredIntoTheCalculator(int n)
        {
			calc.number2 = n;
        }
        
        [When(@"I press add")]
        public void WhenIPressAdd()
        {
			result = calc.Add();
        }
        
        [Then(@"the result should be (.*) on the screen")]
        public void ThenTheResultShouldBeOnTheScreen(int expected)
        {
			Assert.AreEqual(expected, result);
		}
    }
}

using TechTalk.SpecFlow;

using Calc;

using Microsoft.VisualStudio.TestTools.UnitTesting;

namespace CalcTest

{

[Binding]

public class SpecFlowFeature1Steps

{

private Calculator calc = new Calculator();

private int result;

[Given(@"I have entered (.*) into the calculator")]

public void GivenIHaveEnteredIntoTheCalculator(int n)

{

calc.number1 = n;

}

[Given(@"I have also entered (.*) into the calculator")]

public void GivenIHaveAlsoEnteredIntoTheCalculator(int n)

{

calc.number2 = n;

}

[When(@"I press add")]

public void WhenIPressAdd()

{

result = calc.Add();

}

[Then(@"the result should be (.*) on the screen")]

public void ThenTheResultShouldBeOnTheScreen(int expected)

{

Assert.AreEqual(expected, result);

}

テスト実行

ようやくテスト実行までこぎ着けました。「テストエクスプローラー」>「すべて実行」からテストを実行してみます。ちゃんと足し算ができているようですね(・∀・)

このように、自然言語に近い形で記述したテストシナリオに従ってテストを実行することができました。

まとめ

今回はだいぶ簡単な例ではありましたが、Specflowを使ってBDDの一端に触れてみました。

個人的に感じたところとしては、テストシナリオ自体を自然言語で書けるところはかなり魅力的でした。あとから振り返っても何をテストしたいのか一目瞭然なので、メンテナンス性も上がりそうです。

なかなかテスト手法に対して学ぶ機会は多くないので、今回はとても良い勉強になりました。興味のある方はこれを参考に試してみてはいかがでしょうか？

ではではノシ

C++ 自作物

2020/8/14

言語処理系をつくろう（第7回）：比較演算子を実装する

自作の言語処理系開発日記の第7回です。前回までで変数の実装が終わったので、ここからはいよいよ制御構文を実装…と思ったのですが、制御のためには比較演算子を実装する必要がありました。ということで、今回は比較演算子を実装していきます。基本的には四則演算と変わりないのであまり難しくはありません。目次1 比較演算子の仕様2 実装してみる2.1 トークナイザ2.2 構文解析器2.3 コード生成器2.4 実行系（仮想マシン）比較演算子の仕様比較演算子を実装する前に、その仕様について少し考えておきます。比較演算 ...

この記事を読む

C++ 自作物

2020/8/14

言語処理系をつくろう（第6回）：変数を実装する

自作の言語処理系開発日記、第6回です。これまでは四則演算など、電卓レベルの機能実装に取り組んでいましたが、いよいよ変数を扱えるようにしていきたいと思います。これでかなりプログラミング言語っぽくなるかも(・∀・) 今回は新しい仕組みを入れたりと、割と修正がごちゃごちゃしてしまったので、うまくまとめきれていません。ごめんなさい…。目次1 変数の実装について2 実装してみる2.1 トークナイザ2.2 構文解析器2.3 コード生成器2.4 実行系（仮想マシン）変数の実装についてこれまでは即値しか扱っていな ...

この記事を読む

C++ 自作物

2020/8/14

言語処理系をつくろう（第5回）：連続した式の実行

自作の言語処理系開発日記の第5回です。前回までで括弧を含んだ四則演算ができるようになりましたが、このままでは単なる電卓止まりです。ということで、今回は複数の式を連続して実行できる仕組みを実装していきたいと思います。目次1 生成規則を考える2 実装してみる2.1 構文解析器2.2 コード生成生成規則を考えるこれまでは入力全体を1つの式として解釈していましたが、今回は式の区切りを定義して複数の式として解釈できるようにします。 C言語だと「;」や「,」が区切り文字として使われますが、開発中の言語（roo ...

この記事を読む

C++ 自作物

2020/8/14

言語処理系をつくろう（第4回）：括弧付き計算と単項演算子

自作の言語処理系開発日記の第4回です。前回までで乗除算を実装できたので、この調子でもう少し複雑な計算に対応したいと思います。今回はそれぞれの実装が少ないので、一気に2つのステップを進めます。目次1 括弧を含む計算1.1 生成規則をいじる2 単項演算子（+と-）2.1 生成規則をいじる括弧を含む計算これまでの実装では、乗除算は必ず加減算に先立って実行されます。しかし、それでは不十分なので、括弧を含む計算（例：（1+2)*3）を実行できるようにします。生成規則をいじる今回も構文解析器の生成規則を修正 ...

この記事を読む

C++ 自作物

2020/8/14

言語処理系をつくろう（第3回）：乗除算を実装する

自作の言語処理系開発日記の第3回です。前回は加減算を実装したので、今回は乗除算の実装にチャレンジしていきます。目次1 実装してみる1.1 構文解析器実装してみる今回の実装において、トークナイザ・コード生成器・実行系（仮想マシン）については加減算のときと変わりません。単純に各種定義を追加して、それを扱えるようにしてあげるだけです。一方、構文解析器についてはちょっとややこしいので、そこだけ解説します。構文解析器加減算では演算の優先順位がなかったので、単純に左結合（＝左から順に計算していく）で処理し ...

この記事を読む

Ryo Yoneyama

とある会社でソフトウェアエンジニアをしています。技術的な備忘録を中心にまとめてます。ネタがあれば日記も書きます。

-Windows

Specflowでビヘイビア駆動開発に触れてみた

ビヘイビア駆動開発とは？

SpecflowでBDDに触れてみる

Specflowプラグインの導入

テストプロジェクトの作成

必要なファイルのインストール

Featureファイルの作成

Stepファイルの作成

テスト対象の作成とテストコード実装

テスト実行

まとめ

関連記事