👨🏾‍🍳 🛒 🔔 PVS-Studioを使用したPVS-Studioプラグインのソースコードの確認 👩‍💼 🀄️ ↗️

私たちが直面する永遠の質問の1つは、「PVS-Studioを使用してPVS-Studioをテストしましたか？検証結果に関する記事はどこにありますか？」はい、私たちは定期的にこれを行っているため、自分で見つけたエラーに関する記事を書くことができませんでした。間違いは、コードを記述する段階で開発者によって修正されますが、この時点で書き出すことを常に忘れています。しかし今回は読者は幸運でした。 C＃の監視により、Visual Studioのプラグインコードは、当社が実施する毎日の夜間チェックに追加されませんでした。また、それに応じて、アナライザーコアとは異なり、C＃PVS-Studioの開発全体を通じてエラーが検出されませんでした。彼らが言うように、銀の裏地はありません、そしてこれのおかげであなたはこの記事を読みました。

PVS-Studioのテストについてもう少し

おそらく読者は、PVS-Studioのテストプロセスが一般的にどのように構築されているかを知りたいと思うでしょう。このトピックに関する記事はすでに書いています。しかし、それ以来多くの時間が経過し、何かが変わりました。したがって、現在の状況を簡単に説明します。

PVS-Studioを開発する場合、7つのテスト方法を使用します。

開発者のマシンでの静的コード分析。すべての開発者にPVS-Studioがインストールされています。新規または変更されたコードは、インクリメンタル分析メカニズムを使用してすぐにチェックされます。 C ++およびC＃コードがチェックされます。
夜間ビルド中の静的コード分析。警告に気付かなかった場合は、サーバーでの夜間のアセンブリの段階で警告が表示されます。 PVS-Studioは、C＃およびC ++コードをチェックします。さらに、C ++コードのテストにもClangを使用します。
クラス、メソッド、関数のレベルの単体テスト。テスト用に大量の入力データを準備する必要があるため、多くのポイントをテストするのは難しいため、あまり開発されたシステムではありません。より高度なテストに依存しています。
エラーのある特別に準備されマークされたファイルのレベルの機能テスト。
メインシステムヘッダーファイルを正しく解析することを確認する機能テスト。
個々のサードパーティプロジェクトとソリューション（プロジェクトとソリューション）のレベルの回帰テスト。私たちにとって最も重要で有用なタイプのテスト。それを実装するために、C ++で105個のオープンソースプロジェクトを、C＃で49個のオープンソースプロジェクトを定期的にチェックします。古い分析結果と新しい分析結果を比較して、何かを壊さず、新しい診断メッセージを磨くことを管理します。
Visual Studioと統合するアドインである拡張ユーザーインターフェイスの機能テスト。

プラグインチェックを逃したのはどうしてですか？知りませんサーバーにプラグインコードチェックを追加したことを誰も覚えていませんでした。新しいC＃アナライザーのテストが追加されましたが、プラグインは追加されていません。その結果、C＃アナライザーは独自にエラーを開発して発見しました。そして、同じくC＃で書かれたプラグインは傍観者のままでした。最近はあまり変わっていません。そのため、プラグインコードはほとんど機能しなかったため、インクリメンタル分析は役に立たないことがわかりました。しかし、夜間チェックはありませんでした。

PVS-Studioプラグイン

お客様への誠実さとオープンさのおかげで、また会話を回避するために、「見知らぬ人の目に斑点が見えますが、自分の目でログに気づかない」と、私たちはすべてのタイプミスとエラーを面白いものまで書きます。見つかったエラーはすべて、C＃をサポートするPVS-Studio v6.02アナライザーが原因です。

実際のエラーから始めましょう。これは、これらの行を書いている時点ですでに修正されています。

public void ProcessFiles(....) { .... int RowsCount = DynamicErrorListControl.Instance.Plog.NumberOfRows; if (RowsCount > 20000) DatatableUpdateInterval = 30000; //30s else if (RowsCount > 100000) DatatableUpdateInterval = 60000; //1min else if (RowsCount > 200000) DatatableUpdateInterval = 120000; //2min .... }

したがって、アナライザーは2つの警告を発行しました。

V3022式 'RowsCount> 100000'は常にfalseです。 ProcessingEngine.cs 559

V3022式 'RowsCount> 200000'は常にfalseです。 ProcessingEngine.cs 561

人間の脳は、単純なものから複雑なものまで、またはこの場合のように小さなものから大きなものまで、すべての値をチェックするという連続的な思考に慣れています。この場合、このような人間の論理により、プログラムが正しく動作しませんでした。テーブル内の行数の確認中にエラーが発生しました。 20,000行を超える最初の条件を確認した後、プログラムはすぐにDatatableUpdateInterval値を30秒に設定します。そして、もちろん、残りの条件はチェックしません。 RowsCountが1,000,000だったとしても。

このコードは、Visual StudioのPVS-Studio IDEウィンドウでエラーメッセージの出力を最適化するために作成されました。当初、PVS-Studioプラグインは受信するとすぐに分析結果を生成しました。つまり、これらの結果がcmdプロセス（アナライザーコアを開始する）から来た瞬間です。しかし、非常に大規模なプロジェクトでは、インターフェイスの深刻な「ブレーキ」に気づき始めました。特に、プロジェクトに多数の* .cファイルが存在する場合に問題が発生しました。これは、* .cファイルが非常に迅速にチェックされ、UIスレッドが常に結果テーブルの再描画でビジーだったためです。更新の間に遅延を追加することが決定されました。これは、メッセージ数の増加とともに増加します。リスト内の20,000メッセージに達する前に、遅延は15秒に設定されていました。

この場合、私たちは幸運であり、プログラムの速度がわずかに低下します（特に、チェック後に数十万を超えるメッセージを受信することは非常にまれなので）が、このメッセージはより深刻なケースを識別することを目的としています。たとえば、Infragistics社のプロジェクトのように。

 public static double GenerateTemperature(GeoLocation location){ .... else if (location.Latitude > 10 || location.Latitude < 25) .... else if (location.Latitude > -40 || location.Latitude < 10) .... }

ここでも、条件は常に真となり、誤った計算につながります。

次のエラーは、プロジェクトにとってより深刻です。

 public bool GeneratePreprocessedFile(....) { .... if (info.PreprocessorCommandLine.Contains(" /arch:SSE")) ClangCommandLine += " /D \"_M_IX86_FP=1\""; else if (info.PreprocessorCommandLine.Contains(" /arch:SSE2")) ClangCommandLine += " /D \"_M_IX86_FP=2\""; else if (info.PreprocessorCommandLine.Contains(" /arch:IA32")) ClangCommandLine += " /U \"_M_IX86_FP\""; else if (info.PreprocessorCommandLine.Contains(" /arch:AVX")) ClangCommandLine += " /D \"_M_IX86_FP=2\""; .... }

V3053過剰なチェック。サブストリング「/ arch：SSE」および「/ arch：SSE2」の検索を含む条件を調べます。 StandaloneProjectItem.cs 229

間違いの数は異なりますが、その本質は同じです。人間の論理-単純なものから複雑なものへと続くために、ここで失望させてください。サブストリング「/ arch：SSE」のinfo.PreprocessorCommandLineの値をチェックすることにより、「info.PreprocessorCommandLine」に次のサブストリング「/ arch：SSE2」が含まれる場合の条件を同時に満たします。ご覧のとおり、自然に読めるテキストは、プログラムで設定したいロジックにまったく対応していません。 PreprocessorCommandLineに「/ arch：SSE2」が含まれていることがわかっていても、コードの目を通して、「/ D \」_ M_IX86_FP =ではなく、値「/ D \」_ M_IX86_FP = 2 \ ""を投機的にClangCommandLine変数に追加します1 \ "";

アナライザーの観点から、エラーは、/ arch：SSE2フラグをコンパイラーに渡すときの_M_IX86_FPマクロの誤った定義にありました。実際、分析自体の前の前処理には、PVS-Studioはcl（標準のVisual C ++プリプロセッサ）の代わりにClangを使用します。 Clangははるかに高速です。残念ながら、ClangでのMicrosoftのC ++言語方言のサポートはまだ理想からはほど遠いです。したがって、Clangが何かを前処理できなかった場合、PVS-Studioはclを呼び出します。そのため、コンパイラclのフラグを変換してClangを定義します。詳細

このエラーは、ほとんどの場合、Clang操作のエラーや分析結果の誤った出力には至らなかったため、コード内に非常に長い間存在していました。

もう1つの本当の間違いは、ProcessAnalyzerOutput関数の呼び出しです。

 private void PVSFinishKey(ref Hashtable PathExcludes) { .... ProcessAnalyzerOutput(fileName, projectName, task.strStandardOutput, task.strStandardError, false, ref ParsedOutput, ref PathExcludes); }

関数の宣言を見ても、エラーに気付くのは簡単ではありません。

 private void ProcessAnalyzerOutput( String fileName, String projectName, String strStandardError, String strStandardOutput, bool LargeFileMode, ref List<ErrorInfo> ParsedOutputLines, ref Hashtable PathExcludes) { .... }

問題は、関数パラメーター名とそこに渡す引数名の不一致です。

V3066 「ProcessAnalyzerOutput」メソッドに渡される引数の誤った順序の可能性：「strStandardError」および「strStandardOutput」。 ProcessingEngine.cs 1995

関数パラメーターのこのような長いリストでは、不一致を検出することは常に困難です。そのような場合のIntelliSenseでさえ、常に保存されるとは限りません。大規模なプロジェクトでは、速度が低下する可能性があります。そのため、現在どの要素を使用しているのかが必ずしも明確ではありません。

このため、非常に不快な状況が発生する可能性があります。この診断は、他のすべてのヒューリスティック診断と同様に第3レベルに属しますが、非常に有用であり、無視してはなりません。

このエラーが検出された場所は「スタブ」です。空行以外のものがstderrおよびstdoutパラメーターに入力されたことはありません。このエラーは、このスタブの使用を開始するとすぐに見つかります。

別のエラーは、現在開発中のV3072という番号の診断によって特定されました。

 sealed class ProcessingEngine { .... private readonly PVSMessageBase _retiredMessageBase; .... } public sealed class PVSMessageBase : ContextBoundObject, IDisposable { .... }

この診断は、IDisposableインターフェイスを実装するタイプのIDisposableインターフェイスフィールドを実装しないクラスで検出することを目的としています。同様のコードは、クラスのオブジェクトを使用した後、プログラマーがいくつかのリソースをクリアするのを忘れることがあることを示しています。

この場合、ProcessingEngineクラス（IDisposableインターフェイスを実装しない）には、IDisposableインターフェイスを実装するPVSMessageBaseクラスのフィールドが含まれます。

この応答は、「きちんとした」アーキテクチャではないために、誤検知に起因する可能性があります。 ProcessingEngineクラスは、プログラムでシングルトンとして使用されます。したがって、PVSMessageBaseフィールドと同様に、プログラムの実行中はそのインスタンスのみが存在します。リソースは、プログラムの完了時に解放されます。

悪者をいじめ、喜んでいただけるように、コードには他の重大なエラーは見つかりませんでした。残りの「エラー」はほとんどの場合、「念のため」という形式を指します。

たとえば、次の式では：

 private int GetSetRemainingClicks(....) { .... if ((CurrentRemClicks != 0) || ((CurrentRemClicks == 0) && DecrementCurrent)) { .... } .... }

V3031過剰なチェックを簡素化できます。「||」演算子は反対の式で囲まれています。 DynamicErrorList.cs 383

このコードは安全に次のように縮小できます

 if (CurrentRemClicks != 0 || DecrementCurrent) {

いくつかの「再保険」も見つかりました。

 private void comboBoxFind_KeyDown(object sender, KeyEventArgs e) { .... if (e.KeyCode == Keys.Escape) { if (e.KeyCode == Keys.Escape) { ProcessingEngine.PluginInstance.HidePVSSearchWindow(); } } }

そして、ここでも明らかなことが二重にチェックされました。

 public IList<KeyValuePair<String, DataRow>> GetSortedNonRetiredRows() { if (ei.ProjectNames.Count == 1) { .... } else if (ei.ProjectNames.Count > 1) { .... } else if (ei.ProjectNames.Count == 0) { .... } }

V3022式 'ei.ProjectNames.Count == 0'は常にtrueです。 PlogController.cs 277

まあ、あなたがそれを安全にプレイし始めたなら、あなたは最後を握ってすべてをチェックする必要があります。ここの例のように：

 void ProcessVCProjAnalysisIntegration (String Path, bool Remove) { if (Remove) { .... } else if (!Remove) { .... } }

V3022式 '！Remove'は常にtrueです。 VCProjectEngine.cs 733

コードは「非常に奇妙な幽霊」になることがありますが、すべてについて書くことを約束した場合は、次のように記述します。

 private bool PostWebRequest(String post_data) { .... String Sts = ex.Status.ToString() as string; .... string sts = wex.Status.ToString() as string; .... }

V3051過剰な型キャスト。オブジェクトはすでに「String」タイプです。 TrialExtensionRequest.cs 181

V3051過剰な型キャスト。オブジェクトはすでに「String」タイプです。 TrialExtensionRequest.cs 241

コードには次のチェックも含まれています。

 private String Get_StructMemberAlignment() { .... if (CompileAsManaged.Equals("false") || String.IsNullOrEmpty(CompileAsManaged)) Params += " /GR-"; .... }

V3027変数 'CompileAsManaged'は、同じ論理式のヌルに対して検証される前に、論理式で使用されました。 MSVCParamsGenerator.cs 801

そしてまた：

 private String Get_DisableLanguageExtensions() { .... else if (DisableLanguageExtensions.Equals("false") || String.IsNullOrEmpty(DisableLanguageExtensions)) { .... }

V3027変数 'DisableLanguageExtensions'は、同じ論理式でnullに対して検証される前に、論理式で使用されました。 MSVCParamsGenerator.cs 1118

Equals関数が呼び出された後、nullの変数をチェックするのは間違いです。実際、APIによると、変数 "CompileAsManaged"および "DisableLanguageExtensions"をnullにすることはできないため、実際の間違いはありません。したがって、チェックは次のように簡略化できます。

 CompileAsManaged == string.Empty DisableLanguageExtensions == string.Empty

アナライザーから注目に値するコードを書いた他の場所を見てみましょう。

 private static DialogResult ShowModalDialog(....) { .... if (buttons == MessageBoxButtons.YesNo || buttons == MessageBoxButtons.YesNoCancel) return DialogResult.Yes; else if (buttons == MessageBoxButtons.OKCancel) return DialogResult.OK; else return DialogResult.OK; }

V3004 「then」ステートメントは「else」ステートメントと同等です。 Utilities.cs 496

MessageBoxButtons.OKCancelの等価性のボタン変数をチェックすることは意味がありません。とにかく、DialogResult.OKを返します。その結果、この場合、コードは次のように削減されます。

 return (buttons == MessageBoxButtons.YesNo || buttons == MessageBoxButtons.YesNoCancel) ? DialogResult.Yes : DialogResult.OK;

そして最後の1つ。ここでは、リファクタリングが原因である可能性が最も高くなります。

 public bool ReadPlog(....) { .... XmlReadMode readMode = XmlReadMode.Auto; .... readMode = dataset.ReadXml(filename); .... }

V3008 「readMode」変数には、連続して2回値が割り当てられます。おそらくこれは間違いです。行を確認してください：512、507。PlogController.cs 512

おわりに

コードを確認すると、さまざまな気持ちになります。自分の手で間違いを犯した場合、あなたはそれを修正するか、その言い訳を見つけようとしています。間違いが異なる場合、あなたはそれに対して全く異なる感情を経験します。これは、私たちはすべて人間であり、私たちはすべて間違っているという認識の大きな問題です。私たちの一部はこれを認識しており、これはすでに良好であり、一部は持続しています：

「...これらは間違いではありません...」

「...簡単に修正できます...」

-... 5年働いたが、誰も不満を言わなかった...

はい、確かに、多くのエラーは簡単に修正でき、これは非常に良いことです。しかし、このタイプミスや間違いに気付くことは非常に困難です。多くの場合、エラーはプログラマーではなく、テスターによって、さらに悪いことにユーザーによって認識されます。

アナライザの目的は、これらのエラーとタイプミスを確認できるようにすることです。同意して、メモ帳よりもMicrosoft Wordで大きなテキストを書く方がはるかに良いです。また、プログラムコードは、多くのセンセーショナルなベストセラーよりも大きいことがよくあります。

実際、PVS-Studioは、コード用のMicrosoft Wordのスペルチェックです。彼はここであなたが急いで封印された、またはおそらくあなたの考えを間違った方法で表明したとあなたに言うでしょう。同意-読者にとって本のテキストにおける思考の正しい定式化は非常に重要であり、プログラムロジックの正しい形成はエンドユーザーにとって重要です。 PVS-Studioを使用すると、考えをより適切に表現および定式化できます。

インスピレーションと明確な考えをお祈りします。これをお手伝いします。

この記事を英語圏の聴衆と共有したい場合は、翻訳へのリンクを使用してください：Vitaliy Alferov。 PVS-Studioアナライザーを使用したPVS-Studioプラグインの確認。

記事を読んで質問がありますか？

多くの場合、記事には同じ質問が寄せられます。ここで回答を集めました： PVS-Studioバージョン2015に関する記事の読者からの質問への回答。リストをご覧ください。

PVS-Studioを使用したPVS-Studioプラグインのソースコードの確認

PVS-Studioのテストについてもう少し

PVS-Studioプラグイン

おわりに

More articles: