経緯
『ソフトウェア品質を高める開発者テスト アジャイル時代の実践的・効率的なテストのやり方』 を読んでいると、バグの発生しやすさを予測する「Hotspot」という概念が出てきました。 もとは Googleのブログ記事 のようです。 すでにRubyで実装された bugspots というOSSがありますが、ポータビリティを考慮してPythonで実装しました。
概要
アルゴリズムのもとになる考え方は、「最近よくバグが修正されたファイルはまだバグがある可能性が高い」です。 実際にそれを支持する研究結果もあるようです。
バグ修正のための変更の40%が新たなバグを混入するという研究結果 - Googleのバグ予測方法との共通点：森崎修司の「どうやってはかるの？」：オルタナティブ・ブログ
bugspotsでは、コミットメッセージに fix や close が含まれているコミットをバグ修正としてカウントしています。
また、コミット日が新しいものほど重みを付けています。
具体的な計算式は下の記事で解説されているのでご覧ください。 グーグルはコードの品質向上のため「バグ予測アルゴリズム」を採用している － Publickey
今回私が実装したツールはオリジナルと少し違いがあります。
- バグ修正だけでなくすべてのコミットをカウント
- バグ修正かどうかによらず、すべての変更にエンバグの可能性があり、変更回数が多いほどバグが発生しやすいため
- オプションでコミットメッセージによるフィルタも可能
- 全ファイルのHotspot値を計算後、[0, 1] の範囲に正規化
- 正規化しないと最後のコミットから時間が経つほど値が小さくなって、ファイル間の差異がわかりにくくなるため
- オプションで正規化しないことも可能
また、ファイル行数も出力するようにしています。 行数が多いほど複雑度が高くなり、バグの発生しやすさだけでなくデバッグのしにくさにもつながるためです。
使い方
- Python 3.7 以上がインストールされていない場合はインストールする
- リポジトリ から
hotspotsをダウンロードし、PATHを通す - Gitリポジトリで
hotspotsコマンドを実行する
詳しい使い方は hotspots -h を参照してください。