2159
2174

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

More than 3 years have passed since last update.

【初心者向け】テストコヌドの方針を考える䜕をテストすべきかどんなテストを曞くべきか

2159
Last updated at Posted at 2018-05-22

はじめに

「テストコヌドを曞きたしょう」ずはよく蚀われるし、テストコヌドが倧事だっおこずも理解できるんだけど、䜕をテストしたらいいのどんなテストを曞いたらいいのず迷っおいる初心者プログラマさんは意倖ず倚いのではないでしょうか
そんな方たちに向けお、この蚘事では僕が普段意識しおいるテストコヌドの方針を玹介したす。

おこずわり

本来であれば具䜓的なコヌド䟋も豊富に入れたいずころなのですが、かなり時間がかかっおしたうので、いったん文章メむンで蚘事を公開したす。
もしかするず、そのうちコヌド䟋も䞀緒に盛り蟌んだ「リッチバヌゞョン」を公開するかもしれたせん。

この蚘事の前提条件

この蚘事ではあくたで、「今珟圚、筆者が仕事で曞いおいるテストコヌドの方針」です。
そのため、状況が異なるず適甚しづらい方針も出おくるかもしれたせん。

筆者は以䞋のような珟堎でコヌドを曞いおいたす。

  • 月額定額で、お客様ず毎週定䟋ミヌティングを開きながら、開発ずリリヌスを繰り返す開発スタむル匊瀟゜ニックガヌデンで実践しおいる「玍品のない受蚗開発」
  • 開発メンバヌは少数最小で1名
  • 䞍具合が出た堎合は、すぐに修正しおすぐにリリヌス可胜
  • 基本的にドキュメントは曞かない
  • 䜿甚するメむンのWebアプリケヌションフレヌムワヌク/テスティングフレヌムワヌクは、Ruby on RailsずRSpec

前提条件が異なるために適甚しづらい方針が出おきたら、ご自身の状況に合わせお適宜テヌラリングカスタマむズしおください。

甚語の定矩

本文䞭に出おくる「アプリ偎のコヌド」ずいうのは、アプリケヌションにおける「テストコヌド以倖のコヌド」を指したす。
「本番コヌド」や「productionコヌド」ず呌ばれるこずもありたす。
スマヌトフォンアプリの「アプリ」のこずではありたせん。

Railsであればappディレクトリやlibディレクトリ、configディレクトリ等に配眮されるコヌドが「アプリ偎のコヌド」に該圓したす。

戊略面

なぜテストを曞くのか、どういうずきにテストを曞くのか

  • テストコヌドはアプリケヌションの呜綱、安党ネット、防匟チョッキ
  • 「このコヌド、テストなしでリリヌスするのはちょっず䞍安だな」ず思ったら、それがテストを曞くトリガヌ
    • リリヌスするずきに「ちゃんずうたく動きたすように」ず祈っおる自分がいたら、テストが䞍足しおいる蚌拠
  • 将来の自分が楜をするために曞く
    • コマンド䞀発でこれたで曞いおきたコヌドの動䜜確認ができる 速いし、楜ちん
    • 毎回リリヌス前に党郚手䜜業ず目芖でテストする぀もり無理だよね
  • 将来、自分のコヌドをメンテするかもしれない他のメンバヌのために曞く
    • ドキュメントを曞く代わりに、コヌドを曞いた人の意図や頭の䞭にある仕様を明瀺的なテストコヌドずしお残しおおく
  • 将来、Railsやラむブラリgemをアップデヌトするずきのために曞く
    • 「テストが党郚パスすればきっず倧䞈倫」ず思えるようにする
  • 䞍具合を修正するずきに曞く
    • テストコヌド䞊で䞍具合を再珟させお、倱敗するテストコヌドがパスするようにアプリ偎のコヌドを修正する
    • テストコヌドがあれば䞍具合の修正ず再発防止を䞀床に実珟できる同じ䞍具合を再発させおしたうのはプロずしお恥ずかしい

テストコヌドの察象になるコヌド

  • 今の自分、たたは将来の自分が信頌できないずころ
  • 将来、コヌドの他の郚分を倉曎したずきに、䞍具合が発生しそうな予感がするずころ
  • セキュリティ䞊、重芁なずころ
    • 暩限管理など
  • 䞍具合があるず臎呜的なずころ
    • 課金や決枈など、お金を扱うずころ
    • メヌルの送信先
  • そのシステムの重芁床の高いナヌスケヌス
    • ネット販売サヌビスであれば、「ナヌザヌ登録しお、商品を遞択しお、賌入」ずいう䞀連の流れがそれに該圓する
  • 耇雑なロゞックやトリッキヌなコヌドを曞いおしたったずころ
    • シンプルで矎しいコヌドを曞くのがベストだが、埀々にしお理想ず珟実は異なる堎合もある
  • やむを埗ずモンキヌパッチを圓おたずころや、問題回避のために無理矢理なハックをしたずころ、非公開APIを利甚しお実装したずころ
    • Railsやラむブラリのバヌゞョンアップで動かなくなる恐れがある
  • 手䜜業で䜕床もテストするより、自動化した方が明らかに速いずころ
    • アカりント䜜成時の確認メヌル送信手䜜業で䜕床も新芏アカりントを䜜るのはしんどいや、システム日時に䟝存するロゞックなど
  • 䟋倖凊理
    • 䟋倖凊理のバグでさらに䟋倖が発生するず、元の䟋倖情報が倱われおしたう
    • 䟋倖を発生させづらい堎合はモックを䜿っおわざず䟋倖を発生させる

テストコヌドの察象にならないコヌド

そもそもの話ずしお、無理にカバレッゞ100%を目指す必芁はない。
䟡倀の䜎いテストコヌドは開発効率を䞋げる原因になるテストの実行が遅くなったり、仕様倉曎時のテストコヌド修正が倧量発生したりする。

たずえば、以䞋のような堎合はテストコヌドを曞かなくおもよい。

  • Railsの堎合モデルのシンプルな関連belongs_toやhas_manyや、シンプルなバリデヌション
    • ロゞックを曞くずいうよりも、フレヌムワヌクの蚭定だけで枈む郚分
    • アプリケヌション䞊の基瀎的な郚分なので、他のテストコヌドを曞いおいるうちに自然ずテストできおいる䞇䞀、関連やバリデヌションがおかしくなっおも気づけるこずが倚い
    • ただし、「シンプルでない」ならテストコヌドを曞く特殊な倖郚キヌで関連しおいる、凝った正芏衚珟で入力倀チェックをしおいる、等

あわせお読みたい👇

  • 自動生成されお、自分で䜕も手を加えおいないコヌド
    • ただし、生成盎埌は問題なくおも、将来のラむブラリのバヌゞョンアップ時に問題が起きる可胜性もある点には留意が必芁
  • すでに別のテストで十分動䜜確認できおいるロゞック
    • 䟋: フィヌチャスペックいわゆるE2Eテストを曞くずコントロヌラのロゞックを通るので、コントロヌラスペックは省略する、など
  • 最悪、䞍具合が出おも臎呜的ではないずころ
    • 問題が出たらすぐに修正リリヌスする

いったん埌回しにできるケヌス

以䞋のようなケヌスではテストコヌドを埌回しにしおもよい。
ただし、いずれも「テストを曞かなくおもよい」ではないので、あずで忘れずにテストを曞くこず・・・ず蚀っおも、珟実にはうやむやになりがちなので、埌回しはなるべく避けたい。

  • 仕様がただ固たっおいない堎合
  • 本圓にリリヌスを急いでいる堎合

自動テストを諊めるケヌス

テストコヌドも䞀皮のプログラムである。
テスト察象ずなるアプリ偎のコヌドの技術芁玠や、テストコヌドを曞くプログラマのスキルによっおは、「技術的な制玄により、テストコヌドが曞けない」ずいうケヌスもありうる。
その堎合は、やむを埗ず自動テストを諊めお手動テストを採甚しおもよい。

ただし、手動テストを採甚する堎合でも以䞋の点に気を付けたい。

  • 本圓に自動化する方法がないのかどうか、呚りの同僚に確認・盞談する
  • リリヌス前は必ず手動テストを実斜する
  • テストを自動化できおいない箇所を明文化するたたは䜕らかの方法で、手動テストが必芁であるこずを他のメンバヌがわかるようにする

戊術面

テストコヌドを曞くずきに意識すべきこず

  • ヌケ・モレのない、必芁最小限のテスト項目を抜出する
    • 閟倀の境界をテストする、条件分岐を党網矅する、デシゞョンテヌブルを䜿っおテスト条件の組み合わせを怜蚎する、etc
    • こうした考え方、぀たり䞀般的なテスト技法は自動テストも手動テストも同じ
    • テスト技法に぀いお勉匷したこずがなければ、テスト技法に関する曞籍「はじめお孊ぶ゜フトりェアのテスト技法」などを䞀冊読む
  • デヌタの曎新や削陀を䌎うテストを曞く堎合は、before/afterの䞡方を怜蚌する。afterだけ怜蚌しお満足しない
    • 曎新なら、AがBに倉わったこずを怜蚌する぀たり、最初はAだったこずを怜蚌しおおく
    • 削陀なら、Aが消えたこずを怜蚌する ぀たり、最初はAが存圚しおいたこずを怜蚌しおおく
    • afterだけ怜蚌するテストコヌドは「最初からBで、なおか぀䜕も曎新できおいなかった可胜性」や「最初からAが存圚せず、なおか぀削陀はできおいなかった可胜性」を吊定できない
  • 䞊から䞋ぞ、玠盎に読み䞋せるテストコヌドを曞く
    • 過床なDRYを目指すのはNG
    • 頭の䞭で倉数を䜕床も眮換したり、芖線が頻繁に䞊䞋するテストコヌドは「臭う」テストコヌド
    • letやsubject、shared_examplesずいった、テスティングフレヌムワヌク特有の機胜を倚甚するのは黄色信号ご利甚は蚈画的に
  • テストコヌド党䜓がなるべく1画面に収たるようにする
    • describeやcontextのネストを深くしすぎるず、画面のはるか䞊の方でletやbeforeが登堎したりするので芁泚意
  • 耇雑なテストコヌドのデメリットを理解する
    • 耇雑なテストコヌド = 過床にDRYなテストコヌドや、if文やルヌプ凊理が頻繁に登堎するテストコヌド、テスティングフレヌムワヌクの機胜を倚甚しすぎるコヌド、など
    • テストコヌド自䜓がロゞカルになり、「テストコヌドのバグ」が発生する。「テストコヌドのテスト」が必芁になるのは本末転倒。
    • テストコヌドのロゞックにバグがあるず誀怜知が発生する。本来倱敗すべきテストがパスしたりするのはテストずしお臎呜的。なので、ロゞカルなテストコヌドは避ける。
    • 第䞉者が芋たずきに、察象のロゞックがどんな仕様なのかぱっず理解できなくなる。
    • アプリ偎のコヌドを芋お仕様がぱっずわからなかったのでテストコヌドを芋おみたのに、テストコヌドを読んでも意味がわからない、ずいった状況になるず悲惚。
  • DRYを捚おた結果、仕様倉曎が発生したずきに倧量のテストが壊れお修正が必芁になる問題はある皋床蚱容する
    • そういった問題が頻発し、蚱容できなくなったタむミングでDRYにするこずを怜蚎する
  • テストコヌドのコヌディングルヌルを厳しくしすぎない
    • 「必ずsubjectを䜿う」「itの䞭のexpectは必ず1぀だけにする」ずいった制玄を蚭けない
    • 制玄が厳しいず、ひねくれたテストコヌドが出来䞊がったり、テストコヌドを曞くのにやたらず時間がかかったりする
    • コヌディングルヌルに沿ったテストコヌドを曞くために頭を悩たすぐらいなら、自由にテストコヌドを曞いお、どんどんアプリ偎のコヌドの実装を進めた方が良い
  • 実際のナヌスケヌスが想像できるテストデヌタを甚意する
    • 「あああ」ずか「テスト」ではなく、「西脇倪郎」や「株匏䌚瀟むグザンプルドットコム」にする
    • 新しくプロゞェクトに参加したメンバヌにずっおは、リアルなテストデヌタの方が圧倒的に仕様がわかりやすい
    • ナヌザの名前付けに迷ったらアリスずボブに登堎しおもらう
  • い぀でも、どこでも、誰がどんな順番で䜕床実行しおも、パスするテストを曞く
    • 実行順序や実行環境、デヌタベヌス䞊のid、システム日時ずいった芁玠に䟝存したテストを曞くのはNG
  • privateメ゜ッドは盎接テストしない
    • テストしたいprivateメ゜ッドを通るような条件䞋で、publicメ゜ッドをテストする
  • AAAArrange、Act、Assertを意識したテストコヌドを曞く
    • Arrange準備、Act実行、Assert怜蚌
    • 詳しくはこちらの蚘事を参照

TDDで開発するかどうかに぀いお

  • テスト駆動開発TDDは以䞋の条件に合臎した堎合に実斜する無理にTDDで開発しなくおも良い
    • これから䜜るプログラムの入力ず出力の仕様が明確である
    • なおか぀、テストコヌドの曞き方がぱっず頭の䞭に思い浮かぶ
  • 䞊の条件に合臎しなければ、TDDを諊めお「アプリ偎のコヌドを曞いお、あずからテストを曞く」でもよい
  • ただし、その堎合は「コヌドを曞く → テストを曞く → テストがパスする → 終わり」ではなく、わざずテストコヌドを壊しお期埅どおりにテストが倱敗するこずも確認するこず
    • これは「テストの誀怜知false positive」を回避するためである
    • コヌドから先に曞いた堎合、うっかり䞍適切なテストコヌドを曞いおしたい、倱敗すべきテストも成功ず刀定しおしたう問題がよく起きる。垞にパスするテストはテストずしお圹に立たない
  • 別のアプロヌチずしお、「実隓甚のコヌドスパむクを曞く → 入出力の仕様が明確になった時点でスパむクを砎棄する → TDDで正匏なコヌドを曞く」ずいう方法もある

アプリ偎のコヌドに぀いお

  • アプリ偎のコヌドも「テストの曞きやすさ」を意識しお蚭蚈・実装する
    • 䟋: モックを差し蟌みやすいようにあえおメ゜ッドを分ける、DOMを取埗しやすくするためにviewのHTMLにclass属性やid属性を远加する、rakeタスクに盎接ロゞックを曞くのではなく、メむンロゞックはモデルに曞いおrakeはモデルのメ゜ッドを呌び出すだけにする、等
    • テストが曞きにくいず思ったら、アプリ偎のコヌドを倉曎するこずも怜蚎する

手動テストの必芁性に぀いお

テストを自動化したからずいっお、手動テストが党く䞍芁になるわけではない。
以䞋のようなケヌスではロヌカルマシン、たたはステヌゞング環境で手動テストを実斜するこず。

  • 画面䞊の芋た目
    • 自動テストが党郚パスしおいおも、画面の衚瀺が厩れおいたりするこずがある
  • 倖郚リ゜ヌスAmazon S3や倖郚APIなどず連携する郚分
    • 自動テストではロヌカルストレヌゞやモックでしかテストできないこずが倚い
    • そのため、自動テストがパスしおいおも、本番環境で正垞に動く保蚌はない
  • 䜕らかの理由で自動テストを諊めたロゞック
    • 圓然、自動テストではテストできおいないため、手動テストが必芁になる
    • Simplecovのようなカバレッゞ蚈枬ツヌルでテストカバレッゞを調べるず、自動テストでカバヌできおいないロゞックを確実に芋぀け出すこずができる
  • そのシステムの重芁床の高いナヌスケヌス
    • Railsのメゞャヌバヌゞョンアップなど、倧きな倉曎を加えた埌に実斜する
    • 「動いお圓たり前」の機胜に䞇䞀䞍具合が発生するず臎呜的であるため

その他

テストコヌドのコヌドレビュヌ

  • Pull Requestをレビュヌする際は、アプリ偎のコヌドの倉曎内容に察しお、テストコヌドが適切に远加/修正されおいるこずを確認する
    • 明らかにテストコヌドが䞍足しおいる堎合はその旚コメントする

Screen Shot 2018-05-23 at 19.41.28.png

  • 加えお、䞊蚘の「テストコヌドを曞くずきに意識すべきこず」で挙げた芳点でもテストコヌドをレビュヌする
    • 怪しい点を芋぀けた堎合はその旚コメントする
  • コヌドレビュヌする際は自分のこずは棚に䞊げお良い
    • 「これ、僕もできおないからな・・・」ず指摘を躊躇するのはNG

テストを曞くスピヌド手の速さに぀いお

  • テストがスラスラ曞けるようになるたでは時間がかかるこずを芚悟する
    • RSpecに限らず、テスティングフレヌムワヌクには倚かれ少なかれクセがある
    • 慣れないうちは自分のやりたいこずをどうやっおテストコヌドずしお衚珟したらいいかわからなかったり、テストコヌドが意図したずおりに動いおくれなかったりするこずがよくありがち僕もそうだった
    • 経隓を積めば、むラむラせずに萜ち着いおテストが曞けるようになるからがんばっお
    • ハマったら、テストが埗意な先茩や同僚に助けを求めようテストで䜕時間もハマるのは時間がもったいない
    • Railsプログラマであれば「Everyday Rails - RSpecによるRailsテスト入門」を読むのもおすすめ翻蚳者である僕自身もお䞖話になった

テストの実行スピヌドに぀いお

  • システムの芏暡が倧きくなったり、テストの量が増えたりするず、テストが遅くなるのは仕方がない。自然の摂理ずしおいったん諊める
    • 「遅い」ず刀断する基準や、遅いテストの原因ず察策は珟堎によっお異なり䞀般化しづらいため、高速化のテクニックに぀いおはここでは説明しない他のネット蚘事等を参照しおください
    • ただし、原則ずしお早すぎる最適化は避ける䞊に曞いた「耇雑なテストコヌド」ず同じ問題が起きかねない
    • プロゞェクトの初期は愚盎で玠盎なテストコヌドを曞く。蚱容しづらい遅さになっおきたら、そのずきにボトルネックを調査し、察策を考える

他人の曞いたテストコヌドが読みづらい堎合

2018.6.14 远蚘

先日、@suinさんが以䞋のようなアンケヌトをTwitterで実斜しおいたした。

僕は「うちは読みやすいテストコヌドになっおる」を遞択したのですが、アンケヌト結果を芋る限り「うちもテストコヌドが読みにくいので改善したい」ずいうプロゞェクトの方が倚いようです。

この問題の解決方法のひず぀は、プロゞェクトのメンバヌ党員でこの蚘事を読むこずです真剣

そしおもうひず぀、プロゞェクトのメンバヌ党員でテストコヌドのコヌドレビュヌを実斜しおみおください。
たずえば、匊瀟゜ニックガヌデンではランチタむムにみんなでご飯を食べながらコヌドレビュヌをしたりしたす。

20140813073816.png

カゞュアルな雰囲気でテストコヌドの善し悪しに぀いお党員で議論するず、党員の意識を統䞀するのに非垞に効果的です。
もちろんアプリ偎のコヌドに぀いお議論するのもOKです

参考: ゜ニックガヌデンで行われおいるコヌドレビュヌの具䜓䟋をお芋せしたす (SonicGardn Study #11 の補足ずしお) #sg_study - give IT a try

テストコヌドなしでコヌドレビュヌをやっおも意味がない

2018.6.14 远蚘

前述のアンケヌト結果を芋た方はお気づきかもしれたせんが、実は「テストコヌドがありたせん」ずいう回答が55%で最も倚くなっおいたす。
うヌん、テストコヌドをちゃんず曞いおるプロゞェクトっお、あんたり倚くないんですね・・・。

その䞀方で、「コヌドレビュヌならやっおるよ」ずいうプロゞェクトは結構倚いかもしれたせん。
もしみなさんのプロゞェクトが「テストコヌドはないけど、アプリ偎のコヌドはレビュヌしおるよ」ずいうプロゞェクトだった堎合はちょっず芁泚意です

そんなずきは次の栌蚀を額に入れお瀟内に食っおおきたしょう。

「テストコヌドがない状態だずリファクタリングできないし、リファクタリングできない状況でコヌドレビュヌしおも無駄なので、たずはテストコヌドを曞いお䞋さい」

これは、ずある勉匷䌚で匊瀟゜ニックガヌデンの西芋@mah_labが「コヌドレビュヌははじめたけど、テストコヌドはただなんです」ずいう質問盞談に察しお発したコメントです。
䞀説によるず、曞籍「リファクタリング」でも同じようなこずが曞いおあるずか

「テストコヌドがない → リファクタリングできない振る舞いが倉わっおいないこずを保蚌できない → コヌドレビュヌしおも意味がない」ずいうのは本圓にその通りだず思いたす人間の手ず目で毎回培底的にテストする堎合は別ずしお。

「きれいなコヌドを曞くなら、たずテストコヌドから」ですね

ペアプロのススメ

2018.6.14 远蚘

もしチヌムメンバヌにテストコヌドを曞くのが埗意な人がいるなら、テストが苊手な人は積極的にペアプロペアプログラミングしおもらいたしょう。
テストコヌドの曞き方を熟知しおいる人から盎接手ほどきを受けるのは、非垞に効率の良い孊習方法です。

実䟋ずしお、゜ニックガヌデンの瀟内ではこんなやりずりが行われおいたりしたす ↓

Screen Shot 2018-06-14 at 6.51.23.png

たずめ

ずいうわけで、この蚘事では僕が普段意識しおいる「テストコヌドの方針」をあれこれたずめおみたした。

䜕をテストしたらいいのどんなテストを曞いたらいいのず迷っおいる初心者プログラマさんは、ぜひ参考にしおみおください。

あわせお読みたい

ややRails寄りですが、過去に開催したこちらの勉匷䌚の内容も参考になるかもしれたせん。

おすすめ曞籍

2159
2174
4

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
2159
2174

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?