DrupalでBDDテストを実施してみる②

DrupalでBDDテストを
実施してみる②
発表者 K.H

はじめに
前回はBDDの概要やBDDテストの実行環境の作成方法等について解説し
た。今回はテストシナリオの書き方を説明する。

テストシナリオ
テストシナリオはgherkinと呼ばれている言語で記載することができる。
gherkinの特徴は以下
• 自然言語で記載できる
• YAML等と同様にインデントが重要になる
• 行の最初に特別なキーワードを入れる必要がある(後述)
Feature: テストフィーチャー
Scenario: 未ログインで存在しないページを表示
Given I am not logged in
When I go to "foobar"
Then I should get a 404 HTTP response

キーワード
行の最初に使用できるキーワードとしては以下がある。
• Feature
• Scenario
• Given
• When
• Then

Feature
Featureは何をしたいのかを簡潔で説明的な文章で記載する。1つのファ
イルで使用できるのは1回のみ。

Scenario
Scenarioでは実行するテストシナリオにタイトルをつけることができ
る。また、Scenarioは1つのファイルに複数記載することができる。

Scenario
Scenarioでタイトルを記載した後にテストケースを記載することができ
る。テストケースは基本的に以下の単語から始める。
• Given
• When
• Then

Scenario
• Given
• 初期条件を定義する
• When
• 実行するアクションを定義する
• Then
• whenで記載した処理を実行したときに期待する結果を定義する

And
GivenやWhen等を複数行記載する場合はandを使用することができる。
これを使用することでテストシナリオの可読性を上げられる。
Scenario: Multiple Givens
Given one thing
Given another thing
Given yet another thing
When I open my eyes
Then I see something
Scenario: Multiple Givens
Given one thing
And another thing
And yet another thing
When I open my eyes
Then I see something
Givenを複数記載する例 Andに書き換えた例

Drushを使用する場合
一部のテストケースではDrushを使用している。これらのテストケースを
使用する場合は以下の3点に気をつける必要がある。
1. Drushのパスを通していること
2. behat.ymlにDrushの設定を記載する
3. テストシナリオの最初に「@api」をつける

behat.ymlにDrushの設定を記載する
以下３行を追記する。
「root」はDrupal rootのパスとなる。
DrupalDrupalExtension:
blackbox: ~
api̲driver: 'drush'
drush:
root: '/var/www/html/drupal'

テストシナリオに「@api」をつける
以下のようにテストシナリオに「@api」をつける
@api
Scenario: publisher can not create node
Given I am logged in as a "publisher"
When I go to "/node/add/basic"
Then the response status code should be 403

テストケース紹介の前に
これから紹介するテストケースは以下を前提としている。
• Drupalを英語でインストールしていること
• 日本語でインストールしている状態だとエラーになるため

実際のテストケース
今回はwork
fl
owモジュールを使用してwork
fl
owを設定する。その後にそ
の設定になっているかをBDDで確認する。work
fl
owに登場する役割は以
下の2つ。
• writer
• コンテンツを作成することができる
• コンテンツの状態はDraftのみ
• publisher
• コンテンツをDraftからPublishedに変更することができる
• コンテンツを作成することはできない

今回実行するテストケース
以下のテストケースを紹介する。2のテストを実施する場合は事前にDraft
状態のコンテンツを作成する必要がある。
正常系
1. writerでコンテンツを作成できること
2. publisherでコンテンツの公開ができること

writerでコンテンツを作成できること
writerでコンテンツが作成できることのテストケースは以下のようにな
る。
@api
Scenario: writer can create node
Given I am logged in as a "writer"
Then I should not see "Published" in the "select" element
And I should see "Draft" in the "select" element

【参考】コンテンツの作成画面

publisherでコンテンツの公開ができること
publisherでコンテンツの公開ができることのテストケースは以下のよう
になる。
@api
Scenario: publisher can change published
Given I am logged in as a "publisher"
When I go to "/node/37"
Then I should see "Published" in the "select" element
And I should see the button "Apply"

【参考】コンテンツの公開画面

小ネタ
ここからは小ネタとして以下を紹介していく。
• 「Given I am logged in as a/an :role」について
• デバッグ方法
• 定義されていないテストケースを記載した場合
• Drupalが日本語の場合どのようなエラーが発生するか

Given I am logged in as a "role"
「Given I am logged in as a "role"」ではランダムなユーザが作成され
る。作成されたユーザはテスト終了後に削除される。
/**
* Creates and authenticates a user with the given
role(s).
*
* @Given I am logged in as a user with the :role role(s)
* @Given I am logged in as a/an :role
*/
public function assertAuthenticatedByRole($role)
{
// Check if a user with this role is already logged in.
if (!$this->loggedInWithRole($role)) {
// Create user (and project)
$user = (object) [
'name' => $this->getRandom()->name(8),
'pass' => $this->getRandom()->name(16),
'role' => $role,
];
$user->mail = "{$user->name}@example.com";
//中略
}

デバッグ方法
「Then (I )break」でテストを一時的に中断してデバッグするができる。
例えば以下のように「 I break」を記載した場合はユーザが作成された状
態で中断する。
@api
Scenario: writer can create node
Given I am logged in as a "writer"
And I break
Then I should not see "Published" in the "select" element
And I should see "Draft" in the "select" element

デバッグ方法
中断した状態で管理者でログインしてユーザ一覧を表示するとテスト用の
ユーザが作成されていることが分かる。

定義されていないテストケースを実行した場合
定義されていないテストケースを実行した場合は以下のようにwarnが発
生する。

定義されていないテストケースを実行した場合
コンテキストを選択するとサンプルコードが表示される。このコードを指
定したコンテキストに記載し、処理を追記することでテストケースを定義
することができる。

DrupalでBDDテストを実施してみる②

Recommended

Recommended

More Related Content

More from iPride Co., Ltd.

More from iPride Co., Ltd. (20)

Recently uploaded

Recently uploaded (8)