テストを多段で記述できるようにしていただけないでしょうか about chibineko

[tabbyz]

ふと思ったのですが、@RustyNailさんの要望は「複数行のテスト書きたい」というより「テスト手順と期待値を分けて書きたい」ということですよね。

であれば、この記事のような記法を仕様に追加するのが自然で良い気がします。

# ログイン画面
## ログイン機能
- 正しいメールアドレスとパスワードを入力してログインボタンをタップする
  - ホーム画面に遷移すること

※先頭が ハイフン の場合は**「手順」で、先頭が 半角スペース＋ハイフン の場合は「期待値」**とみなす。

そのうえで、下記のように現在の仕様も残しておけば既存ユーザへの混乱も無いですし。

# ログイン画面
## ログイン機能
正しいメールアドレスとパスワードを入力してログインボタンをタップすると、ホーム画面に遷移すること

[tabbyz]

前提手順を記載したい、または手順と期待値を分けて書きたいということですね。
以前から同様の要望は聞いており、個人的にも対応を検討しているところではありますが、なかなか仕様がまとまらず実装を見送っていました。

単純に考えると以下のような仕様が思いつきますが、どちらもイマイチですよね。
@RustyNail さんの方で何かよいアイディアはありませんか？

---

A. 項目をカンマ区切りなどで複数列の指定ができるようにする

Facebookアカウントを入力する, ログインボタンを押下するとXXサービスにログインできること

→ CSVを直接手書きしているようで、ユーザーフレンドリーな仕様とは言えない

B. 行頭が特定の記号の場合、テスト項目としてカウントしないようにする

> Facebookアカウントを入力する
ログインボタンを押下するとXXサービスにログインできること

→ ユーザーはグループ化の#に続いて新たな記法を覚える必要があり、直感性が失われる可能性がある。
またそれを許容するとしても、#のようにMarkdownから推測できる自然な記号が思い当たらない。
※入力のしやすさや見た目を考えると例にあげた>は悪くないが、本来のMarkdownの意味（引用）とは用途が違いすぎて直感的でない。

[Arakaki]

#でコンテキストを切るのでは難しいですかね

[tabbyz]

そうですね、今の仕様であればそれも良い方法だと思います。

[Arakaki]

自分で言っておきながらですが強引に運用でカバーなのでフレンドリーでは無いですね。
現在の利用者に影響なく実装する前提だと、悩みどころですね。

他の案としては、'クォーテーション'で括るなどでしょうか。
互換無視でドラスティックにできるなら、テスト間に必ず空白行を入れる。
などでしょうか。

[tabbyz]

はい、現在の利用者に影響ないというのは必須かと思います。

他の案としては、'クォーテーション'で括るなどでしょうか。

記号で括るのはアイディアにありませんでした。
ただ「クォーテーションで括る」＝「手順」は、ちょっと連想しづらいですね・・・。

[Arakaki]

手順を記載するというよりは、
クォーテーションでくくれば改行をテストの終わりとみなさないというイメージです
こういう落としどころもアリかなと思いました

'Facebookアカウントを入力する
ログインボタンを押下するとXXサービスにログインできること'

こう記載できると一つのテストと扱うかたちです。

[RustyNail]

検討いただきありがとうございます。
私も @Arakaki さんの案に賛成です。

#5 (comment)

私の方からも１つ提案します！
今の発想とは逆で、行末の後ろに何かをつけるとOK/NGなどの結果をつけないフラグをつけるのも１つあるかなと思いました。
ただ、これだと行が多くなるとツライかもしれませんね。

[tabbyz]

@Arakaki さん

クォーテーションでくくれば改行をテストの終わりとみなさないというイメージです

なるほど！良いアイディアですね。
少し気になるところとしては、下記のように単数行/複数行が入り混じった場合、記入時に見づらくないかというところですね。

レイアウトが崩れていないこと
'正しいユーザー情報を入力してログインボタン押下
ログインできること'
'誤ったユーザー情報を入力してログインボタン押下
エラーが表示されてログインできないこと'

[tabbyz]

@RustyNail さん

今の発想とは逆で、行末の後ろに何かをつけるとOK/NGなどの結果をつけないフラグをつけるのも１つあるかなと思いました。
ただ、これだと行が多くなるとツライかもしれませんね。

逆転の発想ですね。
ただ、たしかに可読性には欠けそうなのと、あえて#とは異なるルールにする意味が見えにくいかもしれませんね。

[Arakaki]

@tabbyz 返信おくれました、すみません。

少し気になるところとしては、下記のように単数行/複数行が入り混じった場合、記入時に見づらくないかというところですね。

仰るとおり、混乱してしまいますね。

最近Redmineのwiki記法を利用する事になって思ったのですが、
空白行をそのコンテキストの終わりとみなす、ということがあまり違和感が無いなぁと思いました。

既存ユーザさんのことも考慮すべきですが、歪な仕様を提供するよりもドラスティックにAPIを変えてもいいのでは？と思っています。

イメージは下記です。

テスト1

テスト2

テスト3

[tabbyz]

歪な仕様を提供するよりもドラスティックにAPIを変えてもいいのでは？と思っています。

そうですね、私もそう思います。

空白行をそのコンテキストの終わりとみなす、ということがあまり違和感が無いなぁと思いました。

たしかにあまり違和感無いですね。

ただChibinekoの場合、「メモ帳に箇条書きにしたチェックリストがそのままテストケースになる」という手軽さ、分かりやすさが少し失われてしまう気がしますね...。

でも今までで一番よいアイディアだと思います。ありがとうございます！

[RustyNail]

コメント遅くなってすみません。
はい、おっしゃる通りです！