BDDフレームワークのgodogでブラウザで動く振る舞いのテストを書く

$ go get -u github.com/cucumber/godog/cmd/godog

$ docker run -p 8080:80 nginx

Feature: nginx画面
  エンドユーザーがnginxの様々なページで動作を行うシナリオ

  Scenario: nginxの初期画面から公式ページに飛ぶことができる
    Given nginxの初期画面が表示されている
    When "nginx.com" のリンクをクリックする
    Then 遷移したページに "Welcome to NGINX!" が表示されている

$ cd e2e; godog
Feature: nginx画面
  エンドユーザーがnginxの様々なページで動作を行うシナリオ

  Scenario: nginxの初期画面から公式ページに飛ぶことができる         # features/nginx_scenraio.feature:4
    Given nginxの初期画面が表示されている
    When "nginx.com" のリンクをクリックする
    Then 遷移したページに "Welcome to NGINX!" が表示されている

1 scenarios (1 undefined)
3 steps (3 undefined)
647.359µs

You can implement step definitions for undefined steps with these snippets:

func StepDefinitioninition1(arg1 string) error {
    return godog.ErrPending
}

func StepDefinitioninition2(arg1 string) error {
    return godog.ErrPending
}

func nginx() error {
    return godog.ErrPending
}

func FeatureContext(s *godog.Suite) {
    s.Step(`^"([^"]*)" のリンクをクリックする$`, StepDefinitioninition1)
    s.Step(`^遷移したページに "([^"]*)" が表示されている$`, StepDefinitioninition2)
    s.Step(`^nginxの初期画面が表示されている$`, nginx)
}

package e2e

import "github.com/cucumber/godog"

func StepDefinitioninition1(arg1 string) error {
    return godog.ErrPending
}

func StepDefinitioninition2(arg1 string) error {
    return godog.ErrPending
}

func nginx() error {
    return godog.ErrPending
}

func FeatureContext(s *godog.Suite) {
    s.Step(`^"([^"]*)" のリンクをクリックする$`, StepDefinitioninition1)
    s.Step(`^遷移したページに "([^"]*)" が表示されている$`, StepDefinitioninition2)
    s.Step(`^nginxの初期画面が表示されている$`, nginx)
}

❯ godog
Feature: nginx画面
  エンドユーザーがnginxの様々なページで動作を行うシナリオ

  Scenario: nginxの初期画面から公式ページに飛ぶことができる         # features/nginx_scenario.feature:4
    Given nginxの初期画面が表示されている                   # nginx_scenario_test.go:14 -> nginx
      TODO: write pending definition
    When "nginx.com" のリンクをクリックする               # nginx_scenario_test.go:6 -> StepDefinitioninition1
    Then 遷移したページに "Welcome to NGINX!" が表示されている # nginx_scenario_test.go:10 -> StepDefinitioninition2

1 scenarios (1 pending)
3 steps (1 pending, 2 skipped)
266.809µs

package e2e

import (
    "errors"
    "fmt"
    "time"

    "github.com/cucumber/godog"
    "github.com/sclevine/agouti"
)

var globalPage *agouti.Page
var globalDriver *agouti.WebDriver

func SeeNginxWelcomeView() error {
    // ブラウザでnginxのwelcomeページにアクセス
    if err := globalPage.Navigate("http://localhost:8080"); err != nil {
        return err
    }

    h1Text, err := globalPage.Find("h1").Text()
    if err != nil {
        return err
    }

    if h1Text != "Welcome to nginx!" {
        return errors.New("nginx初期画面ではありません")
    }
    return nil
}

func ClickLink(text string) error {
    // text が書かれているリンクをクリックする
    err := globalPage.FirstByLink(text).Click()
    if err != nil {
        return err
    }

    // 遷移時間分待つ(本当はsleep使わないで頑張りたい)
    time.Sleep(1 * time.Second)
    return nil
}

func SeeH1(wantText string) error {
    h1Text, err := globalPage.Find("h1").Text()
    if err != nil {
        return err
    }

    if h1Text != wantText {
        return fmt.Errorf("%s は h1 要素として見つかりません", wantText)
    }
    return nil
}

func FeatureContext(s *godog.Suite) {
    // テストシナリオの前処理でセッションを用意する
    s.BeforeSuite(func() {
        globalDriver = agouti.ChromeDriver(agouti.Browser("chrome"))
        if err := globalDriver.Start(); err != nil {
            panic(err)
        }

        page, err := globalDriver.NewPage()
        if err != nil {
            panic(err)
        }
        globalPage = page
    })

    // テストシナリオの後処理でWebdriverを止める
    s.AfterSuite(func() {
        globalDriver.Stop()
    })
    s.Step(`^nginxの初期画面が表示されている$`, SeeNginxWelcomeView)
    s.Step(`^"([^"]*)" のリンクをクリックする$`, ClickLink)
    s.Step(`^遷移したページに "([^"]*)" が表示されている$`, SeeH1)
}

❯ godog
Feature: nginx画面
  エンドユーザーがnginxの様々なページで動作を行うシナリオ

  Scenario: nginxの初期画面から公式ページに飛ぶことができる         # features/nginx_scenario.feature:4
    Given nginxの初期画面が表示されている                   # nginx_scenario_test.go:15 -> SeeNginxWelcomeView
    When "nginx.com" のリンクをクリックする               # nginx_scenario_test.go:32 -> ClickLink
    Then 遷移したページに "Welcome to NGINX!" が表示されている # nginx_scenario_test.go:42 -> SeeH1

1 scenarios (1 passed)
3 steps (3 passed)
9.789966057s