技術的負債に立ち向かうためにテストを書いてる話

技術的負債に立ち向かうためにテストを書いてる話レバテック開発部前原宗太朗

|　© Leverages inc. 2 自己紹介お名前前原宗太朗所属レバテック開発部 /
BSD第１開発部趣味世界で大人気なゲーム League of Legendsの動画を見ること

|　© Leverages inc. 3 アジェンダ • なぜテストを書くのか • EntrySyncにおけるテストの課題と工夫

1. なぜテストを書くのか

|　© Leverages inc. 5 なぜテストを書くのか社内でテストの重要性が認知されつつある • 社内勉強会 ◦ 単体テストの考え方
/使い方 • レバレジーズテックフェス 2023春のテーマ ◦ 「急がば品質。ワンランク上のレバクオリティへ」 • インシデントの増加 ◦ チーム内でテストを書こうとなったきっかけも障害から ◦ 複数チームを巻き込む、データリペア作業もありきっかけこそインシデントだが、テストを書く意義についてもう少し考えてみる Vladimir Khorikov (著), 須田智之 (翻訳) 単体テストの考え方 /使い方

|　© Leverages inc. 6 なぜテストを書くのか積み上げられた仕様 • 改修に改修を重ねたシステムで、正しい仕様の把握が難しいデータの項目が多い •
100超えるテーブルもあり、テストケースを用意するのが大変 • どの項目を変化させると、何が変わるのか把握が難しい連携するシステムが多く、データやビジネスロジックが密に結合している • 業務システムのAPIでデータを取得してビジネスロジックを組み、再度 APIで更新を行っている • 他サービスを立ち上げないといけないので、真面目に取り組もうとすると面倒なことが多すぎるシステムの負債が積み重なり、ちょっとした改善でも腰が重いと感じてしまう重要性は理解している。それでもテストを書くのは腰が重い

|　© Leverages inc. 7 なぜテストを書くのか一人歩きする技術的負債という言葉技術的負債という言葉はどこか抽象的リファクタしたい、１から作り直しリニューアルをしたいという声をよく聞くが、何が問題なのかわからないままリファクタを行っても状況は良くならない
負債を解消するために、まずは負債に対する解像度をあげる必要がある

|　© Leverages inc. 8 なぜテストを書くのかソフトウェアの複雑さには２種類ある偶発的な複雑さいわゆる実装の都合によるもの命名規則やアーキテクチャパターンなどを含む本質的な複雑さ
問題空間に潜むソフトウェアそのものの複雑さソフトウェアの複雑性は本質的な性質であって、偶有的なものではない複雑性を取り去ったソフトウェア実体の記述は、しばしばその本質も取り去ることになる。引用　フレデリック・ P・ブルックス , Jr. 著ピアソン・エディケーション『人月の神話新装版』

|　© Leverages inc. 9 なぜテストを書くのかソフトウェアの複雑さには２種類ある偶発的な複雑さいわゆる実装の都合によるもの命名規則やアーキテクチャパターンなどを含む本質的な複雑さ
問題空間に潜むソフトウェアそのものの複雑さ技術的負債を解消したいと口にした時、偶発的複雑さを指すことが多いしかし本質的な複雑さを軽減しない限り、問題空間全体の複雑さは減らない

|　© Leverages inc. 10 なぜテストを書くのか本質的な複雑さはどうやって減らすのか問題を分割して考える = 複雑に混じり合った概念を分離するそのために、仕様の直交性に注目する
引用スケールする要求を支える仕様の「意図」と「直交性」 https://qiita.com/hirokidaichi/items/61ad129eae43771d0fc3#%E4%BB%95%E6%A7%98%E3%81%AE%E7%9B%B4%E4%BA%A4%E6%80%A7 The Art of Unix Programming http://www.catb.org/~esr/writings/taoup/html/ch04s02.html#orthogonality 2つの機能は直交している = 2つの機能が無関係に動作することモニターには直交コントロールがあります。コントラストレベルに関係なく明るさを変更でき、（モニターに 1つある場合）カラーバランスコントロールは両方に依存しません。明るさのノブがカラーバランスに影響を与えるモニターを調整するのがどれほど難しいか想像してみてください。明るさを変更した後は、毎回カラーバランスを調整して補正する必要があります。問題空間全体の複雑さは変わらないが、個別の問題で見た時の複雑さは軽減される

|　© Leverages inc. 11 複雑さの正体が分からないと１つの大きな複雑さの塊に見えてしまう我々は正体不明な複雑性に対して、技術的負債という言葉で片付けてしまうあくまで個人的な見解ですがリプレースは偶発的複雑性を軽減するものでしかなく、本質的な複雑さは軽減されない複雑に混じり合った概念を分離しない限り、リニューアルをしても本質的な複雑さが軽減されることはないソフトウェアの本質は複雑さであり、この複雑さに立ち向かいたい
しかし偶発的な複雑さに圧倒されてしまって、本質的な複雑さに立ち向かえずにいるなぜテストを書くのか 1つの大きな複雑さに見えてしまう問題（自戒をこめて）文字文字してすみません。。。

|　© Leverages inc. 12 本質的な複雑さと偶発的な複雑さを同時に対処するのは難しい偶発的な複雑さを減らした上で、本質的な複雑さに立ち向かいたいそのために継続的改善は必要だし、継続的改善のために既存の資産にもテストが必要なぜテストを書くのか複雑さに立ち向かうのは難しい（主観）文字文字してすみません。。。

2. EntrySyncにおけるテストの課題と工夫

|　© Leverages inc. 14 我々の扱うシステムオウンドメディア ※ 他にもありますが詳細は割愛プラットフォームサブシステム
社内業務システム • 社内業務システムやプラットフォームを支えるための各種マイクロサービス • エージェント業務遂行のためのシステム • 面談や推薦の管理を行う • 求人の閲覧や応募、エージェントの申し込みなど • ユーザーのマイページ • 求人の応募や作業報告書、請求書の管理など

|　© Leverages inc. 15 我々の扱うシステムオウンドメディア ※ 他にもありますが詳細は割愛プラットフォームサブシステム
社内業務システム • 社内業務システムやプラットフォームを支えるための各種マイクロサービス • エージェント業務遂行のためのシステム • 面談や推薦の管理を行う • 求人の閲覧や応募、エージェントの申し込みなど • ユーザーのマイページ • 求人の応募や作業報告書、請求書の管理など EntrySyncとはオウンドメディアと社内業務システムを繋ぐサブシステム

|　© Leverages inc. 16 EntrySyncにおけるテストの課題と工夫オウンドメディアから応募した求職者情報を社内業務システムに連携オウンドメディアB オウンドメディアA プラットフォーム EntrySync
社内業務システム DB ① 流入情報をDBに保存 ② 流入情報を取得 ③ 営業情報を取得 ⑤ 営業情報を更新 ④ 2、3の情報を元に重複判定のビジネスロジック

|　© Leverages inc. 17 EntrySyncにおけるテストの課題と工夫 EntrySyncでテストを書く上で辛いポイントオウンドメディアB オウンドメディアA プラットフォーム EntrySync
社内業務システム DB ① 流入情報をDBに保存 ② 流入情報を取得 ③ 営業情報を取得 ⑤ 営業情報を更新 ④ 2、3の情報を元に重複判定のビジネスロジックデータを作ってるのが別システムビジネスロジックのために別システムに問い合わせが必要テストで確認したい結果も別システムメディアごとに別のパラメタを持つが、全て同じテーブルに保存される

|　© Leverages inc. 18 認知負荷が高いと感じる • データの項目の数が多い • 確認しないといけないテストの数も多いと感じる他のアプリケーションとの連携が面倒
• 他のアプリケーションをいい感じに立ち上げないといけない • 初期設定や初期データを用意してあげないといけないこれ全てやるのは大変そう、道筋が遠くて腰が重くなる EntrySyncにおけるテストの課題と工夫 “腰が重い状態”を脱したいので、腰が重くなる原因を考える

|　© Leverages inc. 19 一つのことに集中して認知負荷を下げる • テストのコンテキストに不要なものはできるだけ隠蔽する ◦ よくよくコードを読むと１つのテストケースに影響する変数はそこまで多くない •
1つのテストで１つのことしか確認しない複数サービスとの連携は妥協している部分が多い • 本当は複数サービスを立ち上げて CIでe2eとかしたい • まずはローカルで動かせるところから始める EntrySyncにおけるテストの課題と工夫テストがない状態から、テストがある状態にするのが最重要

|　© Leverages inc. 20 一見テストデータの項目数が多くとも、１つのテストケースに影響を与える項目はそう多くはないテスト結果に影響する項目以外はデフォルト値を与えることで、テストに作用する項目がわかりやすくなる EntrySyncにおけるテストの課題と工夫テストのコンテキストに不要なものは隠蔽する

|　© Leverages inc. 21 EntrySyncにおけるテストの課題と工夫テストの書き方によって認知負荷を軽減する Arrange-Act-Assertパターンによるテストの記述 • テストのフォーマットを準備、実行、結果の確認のフォーマットで記述する •
フォーマットが統一されることでテストを読む際の認知負荷が軽減される 1つのテストでは一つのことしか確認しない • 複数のAssertを1つのテストケースで確認したくなる • 特にArrange-Actが同じ場合はコードを再利用したくなる • 全体の冗長性を許容しても、１つあたりのテストケースの認知負荷を下げる

|　© Leverages inc. 23 EntrySyncにおけるテストの課題と工夫他のアプリケーションとの連携オウンドメディアB オウンドメディアA
プラットフォーム EntrySync 社内業務システム DB ① 流入情報をDBに保存 ② 流入情報を取得 ③ 営業情報を取得 ⑤ 営業情報を更新 ④ 2、3の情報を元に重複判定のビジネスロジック本当は全部のサービス起動して e2e なテストを実行したい現実は全部の環境をシュッと立ち上げれるほど整っていない全部を整備するのは億劫

|　© Leverages inc. 24 EntrySyncにおけるテストの課題と工夫腰が重いポイント（再掲）オウンドメディアB オウンドメディアA
プラットフォーム EntrySync 社内業務システム DB ① 流入情報をDBに保存 ② 流入情報を取得 ③ 営業情報を取得 ⑤ 営業情報を更新 ④ 2、3の情報を元に重複判定のビジネスロジック他のアプリケーションをいい感じに立ち上げないといけない・一旦諦めて最低限ローカル動くことを目指す・ある程度完成したら CIに移行初期設定や初期データを用意してあげないといけない・ヘルパーを作って beforeAllで呼び出す

|　© Leverages inc. 25 EntrySyncにおけるテストの課題と工夫一部に絞って構築、まずは最低限ローカルで動くようにオウンドメディアB オウンドメディアA
プラットフォーム EntrySync 社内業務システム DB ① 流入情報をDBに保存 ② 流入情報を取得 ③ 営業情報を取得 ⑤ 営業情報を更新 ④ 2、3の情報を元に重複判定のビジネスロジックこの部分に絞って構築残りの環境はDB経由での依存になるためシステムを立ち上げる必要はない初期データをSQLでDBに突っ込むだけでOK データを作る責務はオウンドメディアが持っているので、そこに作らせたいが、ここは妥協点

|　© Leverages inc. 26 EntrySyncにおけるテストの課題と工夫自サービスのデータは TypeORMのRepository経由でEntityを指定して削除他サービスは最低限のテーブル削除データの初期化は関数にまとめて、
beforeAllで呼び出す ※ 後日気がついたことですが他サービスでもちょうどテストを書いていて、最低限のデータを含む Dumpを用意されていたので、今後はそっちを使う予定ですサービス単位でこういうのが整備されていると嬉しいですね

|　© Leverages inc. 27 まとめ • ソフトウェアには本質的な複雑さと偶発的な複雑さがある ◦ 本質的複雑さに対処するためにも、継続的改善で偶発的な複雑さを減らしていこう ◦
そのために既存の資産にもテスト書いていこう • テストを書こうにも複雑さにやられて嫌になってしまうこともある ◦ 本質的な複雑さは減らせないので、偶発的な複雑さを積極的に解消していこう

|　© Leverages inc. 28 今後 • 負債が溜まっているシステムにテストを書いただけだと、テストそのものの認知負荷が高く負債となってしまう ◦
テストによってリファクタ耐性がついたので、コードを綺麗にするようなリファクタリングを行う ◦ さらに本質的な複雑さに立ち向かうために概念の分離を行う

技術的負債に立ち向かうためにテストを書いてる話

技術的負債に立ち向かうためにテストを書いてる話

Tech Leverages

More Decks by Tech Leverages

Other Decks in Technology

Featured

Transcript