Djangoで「良い」Factoryを書きたい

みんなのPython勉強会#105でのLT資料

Transcript

1. Djangoで「良い」 Factoryを書きたい やっしー みんなのPython勉強会#105
2. 自己紹介 名前 やっしー https://github.com/YaCpotato https://www.leadingmark.jp/ 現在業務でDjangoを使っています その他Rails, Nuxt.jsなどなど、3年ほどのWebエンジニアです 　　：＠Yasshieeee
3. 今回の発表はトークメインで、発表しきれないことなど具体 例はQiitaに書いてあります！ https://qiita.com/leadingmark_yashiro/items/0e38b0cbccd88505c9e8
4. 「良い」Factory、書きたいですよね 問題提起：テスト導入初期、新しい viewsのテストの度にFactoryが修正される →　割れ窓的にできがちになる不完全な Factory →　テストだけに集中したいのに Factoryもみなければならず、コスト増 →　絶賛改修中の機能周りのモデルだった場合、コンフリクトの可能性 ここ最近書くことが多くなり、知見をシェアさせていただきます。 ※本当にモデルに仕様変更はいったらしょうがないですコレ
5. 「良い」Factoryとはなにか考える • 読みやすい、修正しやすい →作って終わりではない。使い続ける、変化に対応させるため • 使い方がわかりやすい →自分にしかわからないオレオレ Factoryはダメ （大体みんな同じ書き方にはなるのだが、 細かい部分で自身の想定との差異はコー ディングが統一されない原因となる。細かいから指摘する優先度が下がる ） • データは現実に即している →自動生成してくれるFaker、便利だけれど、そのデータ、実際に入りうるの？
6. 読みやすい、修正しやすい • 書き方（ルール）が統一されている ◦ f文字列、.format()など、文字列内の変数使用の方法 ◦ fakerの使用メソッドの統一 ◦ 変数をどう受け取り、どう作るか
7. 使い方がわかりやすい DocStringを使おう！ 引数としてカラム名で渡せば、 Factoryで参照し ていなくても使ってくれるが、極力書いてあげた い 上記でもこれができてしまう →
8. データは現実に即している Fakerから現実に即した出力を満たすメソッド探すの、つらいけど頑張らないとですね https://faker.readthedocs.io/en/master/locales/ja_JP.html# こういうときはぶっちゃけrandomパッケージ使ってます。 →　ChoiceField：選択肢形式。データベース的に varchar
9. そのテストのための要件を満た すFactoryは、必ずしも他のテ ストの要件を満たすとは限らな い →新しいviewsのテストの度に 修正されがちになる
10. ではどうするか 新しいテスト書く度に仕様変更されないモデ ルのFactoryが修正されないために • テスト、Factoryにもコーディングルール • Factoryも詳細設計 • viewsではなくmodelのテストをまず書き、 Factoryを使い倒す