デコード コード カバレッジ: 種類、ツール、ベスト プラクティス

ソフトウェアを作成するとき、コード内で必ずエラーが発生します。これは、構文エラー、論理エラー、実行時エラー、パフォーマンス エラー、データ エラー、またはさらに悪い形で発生する可能性があります。

ソフトウェアの作成中にエラーはほぼ遍在する性質があるため、ソフトウェア テストはソフトウェア開発における重要なステップとなっています。適切かつ効果的なテストにより、ユーザーのニーズを満たす高品質のソフトウェアが得られるだけでなく、規制に準拠し、攻撃者に悪用される可能性のある脆弱性がほとんどないソフトウェアも得られます。

ソフトウェア テストは、自動テスト、単体テスト、統合テスト、またはシステム テストによるソフトウェア全体のテストの形式で実行できます。

ただし、ソフトウェアを作成する際に重要になるのは、ソフトウェアが包括的にテストされているかどうかをどのように判断するかです。ソフトウェア上で実行したテストは十分ですか?

ソフトウェアのすべての部分を完全にテストしましたか? それともまったくテストされていないコード部分はありますか?

ソフトウェアのテストを行う際には、このような疑問が必ず生じます。これが、コード カバレッジが非常に重要になる理由です。

コード カバレッジ は、どのくらいのコードが実行され、テスト対象のソフトウェアで実行したテストによってテストされたかを示すソフトウェア テストの指標です。コード カバレッジの結果はパーセンテージで表されます。

このパーセンテージは、コードに対して実行したテストによってコードのどの程度がカバーされたかを示します。たとえば、テストを実行して 60% のコード カバレッジが得られた場合、コードの 40% が作成したテストでカバーされていないことを意味するため、テストされていないコードにはエラーや脆弱性が存在する可能性があります。

このため、コード カバレッジを使用すると、ソフトウェアで実行したテストの有効性と完全性を分析できます。これには、ソフトウェアがリリースされる前に適切かつ包括的にテストされることが保証されるという利点があります。これにより、ソフトウェアのユーザー エクスペリエンスに影響を与える可能性のある、実稼働ソフトウェアのソフトウェア バグが軽減されます。

コード カバレッジ 100% は、作成しているソフトウェアにまったくエラーがないことを必ずしも意味するわけではありませんが、ソフトウェアの効率的なテストを確実にするために、高いコード カバレッジを目指す必要があります。

ソフトウェアエラーが死に至る可能性がある航空宇宙や医療などの重要な業界では、テスト中にソフトウェアを100%カバーすることが規制により要求されています。

コードカバレッジメトリクスの種類

ソフトウェアのテスト中に測定できるコード カバレッジ メトリックには、いくつかの種類があります。それらには次のものが含まれます。

• ステートメント カバレッジ – テスト中に実行されたソース コード内の実行可能ステートメントの割合を測定します。
• 関数カバレッジ – テスト中に呼び出された定義済み関数の割合を測定します。
• 分岐カバレッジ – ソース コード内のすべての決定点から実行された分岐または考えられるパスの割合を測定します。これは、if、switch ステートメント、if else ステートメントなどの意思決定制御構造から生じるすべての分岐が完全にテストされていることを確認するために使用されます。
• 条件カバレッジ – true 値と false 値の両方についてテストされたブール式の割合を測定します。
• ループ カバレッジ – テスト中に実行されたソース コード内のループの割合を測定します。
• パス カバレッジ – テストされたソース コード内のすべての可能な実行パスの割合を測定します。

上記のメトリクスは通常、コード カバレッジ レポートに含まれます。

コードカバレッジのベストプラクティス

コード カバレッジの有効性と品質を確保するために、コード カバレッジを実施する際に推奨される特定のベスト プラクティスがあります。それらには次のものが含まれます。

明確なカバレッジ目標を持つ

実施するソフトウェア テストでは、適切なテスト カバレッジ メトリックごとに目標カバレッジ パーセンテージを設定します。これには、明確なテスト目標を提供するだけでなく、チームの努力をコード カバレッジの向上に向けることでソフトウェアの欠陥を減らすのにも役立つという利点があります。また、ソフトウェア開発中にソフトウェア テストに当然の注意が払われるようにするのにも役立ちます。

テストの品質に重点を置く

コード カバレッジは、テストされたコードの割合を示すだけであり、コードが正しくテストされたかどうか、またはソフトウェアにバグがないかどうかを示すものではないことに注意することが重要です。したがって、単にコード カバレッジを 100% に近づけることに重点を置くのではなく、ソフトウェアを正しくテストして価値を付加する、高品質で効果的なテストを作成することに重点を置く必要があります。

頻繁に変更されるコードのコード カバレッジを増やす

大規模なプロジェクトで高いコード カバレッジ数値を達成するのは難しいかもしれませんが、時間の経過とともにコード カバレッジが確実に向上するように努力することはできます。

これを実現する優れた方法は、プロジェクトのコード ベースに対して行われるすべての新しいコミットで 90 パーセントを超える高いコード カバレッジを要求することです。

コミットレベルのコードカバレッジを強制することは、現実的かつ実行可能であるだけでなく、ソフトウェアに加えられた新しい変更が優れたコードカバレッジを持つことを保証します。

コードカバレッジデータの測定と分析

コード カバレッジから得られた結果を利用して、まだテストが必要な領域を特定し、コード カバレッジが低い領域を優先して今後のテストの取り組みをガイドします。

コード カバレッジ データを分析して、まだテストされていないアプリケーションの重要な領域を特定し、未テストの重要な領域を完全にテストするよう努力します。コード カバレッジ データを使用してソフトウェアを改善し、優先順位を付けると、欠陥が少なく、より適切にテストされたソフトウェアが得られます。

コードカバレッジとテストカバレッジ

どちらもテストの有効性を確認するために使用されますが、コード カバレッジとテスト カバレッジは、その使用法と測定対象が根本的に異なります。

テスト カバレッジは、記述されたテストがソフトウェアの要件をどの程度カバーしているかを判断するために使用される指標です。これには各ソフトウェア要件のテストが含まれ、ソフトウェアがその要件を満たすかどうかについてどの程度テストされているかを確認するのに役立ちます。

テスト カバレッジの結果は、テストされたソフトウェア要件の割合を示します。テストカバレッジは通常、品質保証の専門家によって行われます。

一方、コード カバレッジは、作成されたテストによって実行されたソース コードの割合を決定するために使用されるソフトウェア テストの指標です。

コード カバレッジの結果は、ソース コード内のステートメント、関数、パス、ループ、分岐、および条件が、作成された単体テストによってどの程度実行されたかを示します。コード カバレッジは、作成されたテストがソース コードをどの程度カバーしているかを評価するために使用され、通常はソフトウェア開発者によって行われます。

コード カバレッジは、ソフトウェア テストの実行中に測定する重要な指標です。コード カバレッジに役立つツールをいくつか紹介します。

クローバー

Clover は、ソフトウェア開発チーム向けの製品を開発するオーストラリアのソフトウェア会社である Atlassian によって最初に開発されたオープンソースのコード カバレッジ ツールです。このツールは純粋に Java で書かれており、Java ランタイム環境の要件を満たす任意のオペレーティング システム上で実行できます。

Clover を使用すると、Java、Groovy、または AspectJ プログラミング言語で記述されたコードに対してコード カバレッジを実行できます。 JUnit、TestNG、Spock などのテスト フレームワークをサポートしており、IntelliJ IDEA や Eclipse などの IDE と統合することもできます。

Clover を使用すると、メソッド、ステートメント、ブランチ、グローバルおよびテストごとのカバレッジなどのコード カバレッジ メトリックを測定できます。

コード カバレッジの実行から、ソフトウェア内の最も危険な領域に加えてコード カバレッジの結果を示す高度に構成可能な HTML レポートを生成でき、テストの最適化に使用できます。

レポートは PDF、XML、JSON、またはプレーン テキストで生成することもできます。 clover の主な利点は、さまざまなツールと統合でき、積極的に開発および改良が行われていることです。

ジャココ

JaCoCo は、 EclEmma チームによって開発された Java プログラミング言語用の無料のコード カバレッジ ライブラリです。このライブラリは、Eclipse IDE 用の無料の Java コード カバレッジ ツールである EclEmma に実装されています。

JaCoCo は豊富なカバレッジ分析を提供し、その結果は Java ソース コード エディターで即座に要約および強調表示され、ユーザーはカバレッジ結果をメソッド レベルまでドリルダウンできます。

結果は、ソース コード上で実行されたテストで完全に、部分的に、またはまだカバーされていないコード行を強調表示するカスタマイズ可能なカラー コードを使用して表示されます。これにより、ソース コードの合計コード カバレッジを達成するために、さまざまなテスト実行を結合して検討することができます。

JaCoCo は軽量のツールであり、コード カバレッジ分析に使用するためにプロジェクトを変更したり、その他のセットアップを実行したりする必要はありません。

コベルトゥーラ

Cobertura は、Jcoverage に基づいた無料のオープンソース Java コード カバレッジ ツールで、単独で、Ant スクリプトを通じて、または Maven プラグインを通じて使用できます。 Maven プラグインを介して使用するのが、コード カバレッジに Cobertura を使用する最も一般的な方法です。

Cobertura は、Java ソース コード上で実行されたテストによって実行された行または分岐の割合を測定します。テスト中に実行されたステートメントの割合を示すライン カバレッジや、テスト中にカバーされた分岐の割合を示すブランチ カバレッジなどのメトリクスを提供します。

また、Java コード内の分岐の数が増加するにつれて増加する複雑さの要因も示しています。

コード カバレッジの結果は HTML または XML で表示され、ソース コードのどの部分がテストされていないかを示します。 Cobertura は、テスト カバレッジの結果を表示するだけでなく、テストされていないコードやバグを見つけたり、到達不能なコードを特定したりするためにも使用できます。

イスタンブール

Istanbul は、 ES6+ をサポートする JavaScript コード用のコード カバレッジ ツールです。このツールは、ノード パッケージ マネージャーを使用して、開発依存関係として任意の Javascript プロジェクトにインストールできます。

Istanbul は、ステートメント、ブランチ、関数、行カバレッジなどのコード カバレッジ メトリックを提供します。また、テストでカバーされていないソース コードの行も表示されます。これは、単体テストがソース コードを実行する範囲を追跡できるように、JavaScript コードに行カウンターを追加することによって行われます。

Istanbul によるコード カバレッジの結果は、ターミナルまたは HTML 形式で出力できます。さらに、Istanbul は、サブプロセスを生成するアプリケーション、Babel および TypeScript プロジェクトのソース マップされたカバレッジのサポートを提供します。

Pytest-cov

Pytest-cov は、 Python コードのコード カバレッジ レポートを生成するために使用される無料の Python プラグインです。 Python のパッケージ インストーラー Pip を使用してインストールされ、コマンド ラインから操作します。

コード カバレッジ レポートには、Python プロジェクト内のステートメントとテストでカバーされていないステートメントが表示され、テストでカバーされた Python コードの割合を示すテスト カバレッジ パーセンテージが表示されます。

Pytest-cov は、サブプロセスのサポート、xdist のサポート、および一貫した pytest の動作を提供します。テスト実行中の Pytest-cov のデフォルト動作は、新しいテスト実行ごとに新しいクリーンなデータを確保するために既存のカバレッジ データ ファイルを削除することです。ただし、ユーザーは以前のテスト実行のコード カバレッジ テスト結果を結合することもできます。

カバレッジ.py

Coverage.py は Python プログラム用のコード カバレッジ ツールであり、pip を使用してプロジェクトにインストールされます。

デフォルトでは、行またはステートメントのカバレッジを測定し、プログラム内のステートメントの数、テストで欠落したステートメントの数、テストでのカバレッジの割合を示す結果を提供します。また、Python ソース コードで欠落した行も表示します。テスト。ただし、Python プログラムのブランチ カバレッジを測定するように構成することはできます。

Coverage.py を使用して、どのテストがソース コードのどの行を実行したかを確認することもできます。そのコード カバレッジ レポートは、端末に表示できるほか、HTML、XML、JSON、LCOV 形式でも表示できます。

シンプルコブ

SimpleCov は 、Ruby プログラミング言語用の堅牢なコード カバレッジ ツールです。 Ruby の組み込みカバレッジ ライブラリを利用して、テスト実行後のコード カバレッジの決定に使用される関連データを収集します。

SimpleCov の最も優れている点は、コード カバレッジの結果が表示されることです。また、実行されたさまざまな種類のテストの結果がマージされるため、生成されたレポートには実行されたすべてのテストの結果が表示され、コードのテストされていない部分を簡単に識別できるようになります。

また、コードのテスト済み部分とテストされていない部分を簡単に識別するために使用できるカラー コードを使用してソース コードをフォーマットします。デフォルトでは、SimpleCov はテストのライン カバレッジを測定してレポートします。ただし、実行されたテストのブランチ カバレッジを測定してレポートするように構成できます。

隠蔽

Deep Cover は 、Ruby コードの正確なコード カバレッジ ツールです。ラインが部分的ではなく完全に実行された場合にのみカバーされているとみなされるようにすることで、より正確なライン カバレッジ レポートを提供します。

さらに、テストで使用されなかったブランチがあるかどうかを確認するためにオプションで使用できるノードおよびブランチ カバレッジのサポートも提供します。

Deep Cover は構成を必要とせずに使いやすいだけでなく、Ruby の組み込みコード カバレッジ ライブラリや SimpleCov などの他のコード カバレッジ ツールを使用してプロジェクトに統合できます。このような場合、Deep Cover は、コード行のすべてが完全に実行された場合にのみ行を実行済みとしてマークすることで、ツールをより厳密にします。

結論

コード カバレッジが高くても、必ずしもエラーのないソフトウェアが得られるわけではありませんが、ソフトウェアをテストする際に考慮する必要がある重要な指標です。コード カバレッジは、作成されたテストが実際にソフトウェアのソース コードをどの程度テストしているかを評価する際に重要です。

さらに、テスト中にコード カバレッジの改善に取り組むと、本番環境でエラーが発生しにくくなり、より適切にテストされたソフトウェアが得られます。ソフトウェアのテスト中にコード カバレッジを実行するには、この記事で提案されているツールの使用を検討してください。

クラウドベースの負荷テスト ツールを検討することもできます。