Jenkins：PHPプロジェクトの継続的な統(tǒng)合および配信ツールJenkinsは、PHPプロジェクトの継続的な統(tǒng)合と継続的な配信において重要な役割を果たしているオープンソース自動化サーバーであり、リアルタイムでバグを検出および解決し、コードの品質(zhì)改善の提案を継続的にフィードバックすることができます。

PHPツールとのJenkinsの統(tǒng)合 Jenkinsは、PHP CodesNiffer、PHP MD、PHP CPD、PHP依存、PHPLOC、PHPUNIT、およびPHPDOXなど、幅広いPHPプロジェクトツールと互換性があり、各ツールは獨自のコード分析の洞察とメトリックを提供します。ジェンキンスの利點は、チャートと概要を生成し、コマンドラインの検索よりも効率的に問題を提示し、コードの問題を識別して解決しやすくすることです。

既に設(shè)定されたツールに加えて、Jenkinsは、PHP CodesNiffer、PHP MD、PHP CPD違反の概要などの追加情報を収集し、各ビルド間のすべてのコミットを示す「変更」の概要を収集します。

ジェンキンスの解釈結(jié)果：プロジェクトビューとビルドビュー

ジェンキンスの結(jié)果はさまざまなツールから來ており、ジェンキンスGUIのさまざまな場所に配置されます。 2つの異なるページを閲覧します。最初はプロジェクトビューページで、プロジェクト名が上部に表示されます。このページでは、プロジェクトの概要を取得でき、複數(shù)のビルドを簡単に比較できます。このページにアクセスして、デフォルトの概要ページからアイテムをクリックしてください。プロジェクトビューページに加えて、ビルドビューページもあります。サイドバーのビルド番號をクリックして、このページに移動できます。ここでは、この特定のビルドに関するさまざまな詳細(xì)を表示できます。

この記事では、各ツールとそのレポートコンテンツを段階的に紹介します。最後に、ジェンキンスが私たちのために集めた追加の詳細(xì)のいくつかも見ていきます。同じプロジェクトを複數(shù)回構(gòu)築するため、チャートに直線が表示されます。実際のプロジェクトでは、チャートが変動します。

php codesniffer

CodesNifferは、コードが共通のルールセットまたは獨自のカスタムルールセットに準(zhǔn)拠しているかどうかを確認(rèn)するためのツールです。この例では、PSR2に対してテストするツールを構(gòu)成しました。これをbuild.xmlファイルで定義しました。

概要ページには、「CheckStyle Trend」と呼ばれるチャートが表示されます。このチャートは、各ビルドのPSR2問題の數(shù)を表しています。コードでは、ほぼ完全にPSR2に準(zhǔn)拠しているため、チャートには1つの問題のみが表示されます。

<arg value="--standard=PSR2" />

3つのツールからのデータを組み合わせたページの下にチャートもあります。 CodesNifferはその1つです。

問題がどこにあるかを確認(rèn)するには、最新のビルドの左メニューの「チェックスタイル警告」をクリックするか、特定のビルドをクリックして、その特定のビルドの「チェックスタイル警告」をクリックしてください。

このページでは、問題の説明をはっきりと見ることができます。複數(shù)のフィルターを使用できることに注意してください。上のバーでは、新品の問題と修正された問題の數(shù)がはっきりとわかります。番號をクリックして変更を明確に確認(rèn)できます。要約では、優(yōu)先順位によって分類された質(zhì)問をすばやく表示できます。

php md

MDはMESS検出器を表します。このツールは、コードにいくつかの問題を示しようとします。これは、潛在的なバグ、未使用のコード、または複雑なアプローチである可能性があります。利用可能なチェックの完全なリストについては、このページを表示できます。すべてのルールを確認(rèn)するわけではないことに注意してください。 phpmd.xmlファイルをチェックインするルールを定義できます。

PHP CodesNifferと同様に、プロジェクトビューページに、混亂検出が時間の経過とともにどのように進行するかを示すチャートが表示されます。

問題が何であるかを知るには、左側(cè)のメニューの「PMD警告」をクリックして、最新のビルドに移動できます。別のビルドを表示する場合は、1つのビルドをクリックして、PMD警告を選択します。 PHP CodesNifferページに似たページに到著します。

上部では、新しい問題がいくつあるか、いくつの問題が固定されているかを再度確認(rèn)できます。それとは別に、各質(zhì)問の優(yōu)先順位を見ることができます。

詳細(xì)ページでは、問題を見つける場所に関する詳細(xì)情報を入手できます。同じ情報をさまざまな方法で提供するために使用できるタブがたくさんあります。たとえば、「タイプ」をクリックして、各タイプの詳細(xì)を確認(rèn)できます。

ご覧のとおり、「UnsuseformalParameter」が私たちの最大の問題です。それをクリックすると、どのファイルが未使用のパラメーターがあるかを再度確認(rèn)します。

php cpd

CPDはコピーペースト検出器を表します。このツールはすべてのコードを分析し、複數(shù)の重複した行を探します。重複した行がたくさんある場合は、ロジックが複數(shù)のクラス間で共有されるように、特定の部分を書き換える必要があることを意味する場合があります。プロジェクトビューページでは、すべてのビルドの全體的な進捗が再び表示されます。

左側(cè)のメニューでは、「Duplicate Code」をクリックして、見つかった問題の概要を取得できます。前と同じように、そのビルドの詳細(xì)については、[ビルド]をクリックしてください。概要は前のページに似ていることがわかります。詳細(xì)については、[詳細(xì)]タブをクリックしましょう。

ご覧のとおり、CompanyFilterクラスには58行がUserFilterおよびTimeCategoryFilterクラスにあります。このデータに基づいて、3つのクラスのほとんどを処理する何らかのベースフィルターまたは実裝サービスが必要であると判斷できます。ソリューションはあなたの狀況に依存し、PHP CPDは問題を発見した場所を教えてください。

php依存

PHP依存は、おそらく理解するのが最も難しいメトリックです。 PHP依存は、コードベースで靜的コード分析を?qū)g行します。 2つの畫像と概要ページを生成します。プロジェクトビューページの上部には、畫像を表示するHTMLがいくつかあることに気付くかもしれません。

畫像が表示されないという事実は、Jenkins構(gòu)成でスイッチを切り替える必要があることを意味します。 「ジェンキンスの管理」に移動し、「グローバルセキュリティの構(gòu)成」に移動します。 「マークアップフォーマッタ」の構(gòu)成に使用できる選択ボックスがあります。 「安全なHTML」に設(shè)定し、設(shè)定を保存します。プロジェクトビューページに戻ると、HTMLが2つの畫像に変換されていることがわかります。

これらの2つのチャートを完全に理解するために、このツールの公式ドキュメントを読むことをお勧めします。ピラミッドの詳細(xì)については、このリンクを表示できます。抽象不安定性チャートの詳細(xì)については、このリンクを表示できます。

特定のビルドをクリックして、左側(cè)のメニューで「JDepend」を選択することで、詳細(xì)を取得できます。次の概要が表示されます。

このページの説明も非常に大きく複雑なので、すべてが説明されている公式のドキュメントにあなたを向けました。

phploc

phplocは、アイテムのサイズを迅速に測定するためのツールです。コードの行の総數(shù)、靜的メソッドの総數(shù)などが表示されます。左側(cè)のメニューでは、「プロット」をクリックしてこのツールの結(jié)果を取得できます。 11のチャートを使用してこの情報を見つけることができます。以下に、コードとコメントの総數(shù)と、メソッド、クラス、プロパティ、および関數(shù)の総數(shù)を示すチャートのスクリーンショットが表示されます。

phpunit

ジェンキンスの大量の統(tǒng)計は、phpunitによって生成されます。概要のみで、phpunitデータによって生成される3つのチャートが表示されます。

最初のチャートは、テストでカバーされているコードの量を示します。この場合、71.1％です。このカバレッジを生成するために、背景はXdebugを使用します。

2番目のチャートは、あなたのがらくたレベルを示しています。 CRAPは、変化リスク分析と予測を表しています。 CRAPは、コードの複雑さとコードで実行されるテストの量をチェックすることによって計算されます。 PHP MDルールを閲覧した場合、PHP MDがコードの複雑さを確認(rèn)できることに気付いたかもしれませんが、単體テストを考慮していません。 PHP MDがあなたの複雑さをどのように計算するかを?qū)Wぶためにここを読んでください。

最終チャートは、成功したテストの數(shù)と失敗したテストの數(shù)を示しています。この場合、それらはすべて成功しました。

左側(cè)のサイドバーメニューには、PHPunitによって生成された2つのプロジェクトがあります。最初のものはがらくたです。このページでは、現(xiàn)在のがらくたレベルがどれだけ高いかを示すいくつかのチャートの概要を見ることができます。一番下では、実際にどの方法ががらくたとしてマークされているかがわかります。カバレッジと複雑さを示す列に気付くでしょう。

2番目のメニュー項目は「Clover HTMLレポート」です。このページでは、ユニットテストによって上書きされるコンテンツの量をディレクトリごとに概説できます。

ディレクトリをクリックして、ソースコードの洞察を得ることができます。ファイルに到達した場合、それを開いて、上書きの量を行ごとに表示できます。どの部分がテストされているか、どのパーツがテストされていないかを示す色を使用します。ラインの上にホバリングすると、ユニットテストがラインと呼ばれる回數(shù)を示します。

この例では、IFステートメントの一部が単位テストで呼び出されていないことを明確に確認(rèn)できます。この場合、これは正しいです。このメソッドは、POSTリクエストではなく、GETリクエストのみを?qū)g行します。ユニットテストでPOSTリクエストを?qū)g裝すると、このIFステートメントはグリーンとマークされます。これにより、ユニットテストの不足している部分を簡単に発見できます。

phpdox

コードとコメントに基づいてドキュメントを生成するための多くのツールがあります。 PHPDOXは、このタスクを?qū)g行できる別のツールです。左側(cè)のメニューでは、「APIドキュメント」をクリックしてドキュメントに移動できます。 PHPDoxの利點は、他のすべてのツールの結(jié)果も含まれていることです。

上部のナビゲーションを使用すると、すべてのクラスの概要を確認(rèn)できますが、1つのクラスを掘り下げて、すべてのメソッドと説明の概要を確認(rèn)することもできます。ファイル履歴とソースコードを表示することもできます。

その他のページ

以前の記事で設(shè)定したツールに加えて、ジェンキンスはお客様のために追加情報を収集します。インストールした違反プラグインは、PHP CodesNiffer、PHP MD、およびPHP CPDの概要を表示する追加のページを作成します。

特定のビルドをクリックして、左側(cè)のメニューに「変更」という名前のメニュー項目を見つけることもできます。このページにアクセスすると、以前のビルドとこのビルドの間に行われたすべてのコミットの概要が表示されます。変更が行われない場合、ページは空白になります。

結(jié)論

この記事では、すべてのツールから得られた指標(biāo)の種類を注意深く調(diào)べます。取得するすべての情報は、コマンドラインで取得することもできます。ジェンキンスの利點は、問題をよりよく表すチャートと概要を作成できることです。

最後の部分では、いくつかのツールを置き換えて、いくつかの追加メトリックを追加します。また、CSS、JavaScript、およびHTMLコードを分析する方法についても検討します。

（FAQパーツはここでは省略されています。FAQパーツのコンテンツは記事の主要な內(nèi)容と非常に繰り返され、重複を避けるために、ここで省略されます。）

以上がJenkinsとのPHPプロジェクトの分析の詳細(xì)內(nèi)容です。詳細(xì)については、PHP 中國語 Web サイトの他の関連記事を參照してください。