コマンド ラインからのコード分析の実行

Apache Ant を使用して、コマンド ラインからコード分析を実行できます。

.cobolBuild スクリプトでのコード分析のプロパティ

Enterprise Developer は、Apache Ant スクリプト .cobolBuild を使用して COBOL プロジェクトをビルドします。

.cobolBuild はプロジェクトの一部です。これは、.cobolProj ファイルとともにプロジェクトのディレクトリに保存されます。Eclipse では、[Navigator] ビューでプロジェクトを展開すると、アクセスできます。

スクリプトは、プロジェクトのプロパティの変更時、またはプロジェクト ファイル .cobolProj のリビルド時に自動で再生成されます。

プロジェクトのコード分析を有効にすると、次の要素が .cobolBuild スクリプトに追加されます。

  • Ant タスク analysis

    このタスクには、コード分析で結果を返すときにビルドが失敗であるか、続行するかどうかを指定する FailOnError 属性が必要です。

    さらに、実行するルールを指定する rule のネストされた要素を持つ ruleList 型も必要です。デフォルトではない場所から IDE にインポートされるルールを有効にした場合、これらのルールに関する詳細が ruleList.custom 型に追加されます。

    mffilelist 型は、コード分析を実行する COBOL ファイルを指定します。

  • cobol Ant タスクの analysisData および analysisDataDir パラメーター
  • analyze および build.and.analyze Ant ターゲット

    コマンド ラインでコード分析を実行するときに次のいずれかのターゲットを指定する必要があります。

    • analyze - ソース ファイルではコード分析のみを実行することを指定します。
    • build.and.analyze - ソース ファイルで分析とビルドの両方を実行することを指定します。
  • コード分析では、製品インストール ディレクトリ内のルールを検索します。検索するフォルダーは、rulesDir タグに追加されます。

    追加のルールを別のフォルダーから IDE にインポートした場合、そのフォルダーは rulesDir.custom タグに保存されます。

ネイティブ COBOL プロジェクトを作成し、プロジェクトのプロパティからそのコード分析を有効にし、さらにエディターで .cobolBuild ファイルを開く場合に、これらのパラメーターを調べることができます。

コード分析の Ant コマンドの構文

Apache Ant および .cobolBuild スクリプトを使用して、コマンド ラインでソース ファイルのコード分析を実行できます。プロセスの概要を次に示します。

  1. マシンに Apache Ant がインストールされている必要があります。http://ant.apache.org/ から Ant をダウンロードします。
  2. Eclipse で、プロジェクトのプロパティからコード分析を有効にして構成します。
  3. Enterprise Developer コマンド プロンプトを起動します ([Start > All Programs > Micro Focus Enterprise Developer > Tools > Enterprise Developer Command Prompt] の順にクリック)。
  4. コマンド プロンプトで、プロジェクトのディレクトリに移動します。
  5. 次のコマンドを実行して、CLASSPATH 環境変数を設定します。
    CLASSPATH=product-install-dir\bin\mfant.jar;%CLASSPATH%

    たとえば、Enterprise Developer がデフォルトの場所にインストールされている場合は、次のようになります。

    CLASSPATH=%ProgramFiles(x86)%\Micro Focus\Enterprise Developer\bin\mfant.jar;%CLASSPATH%
  6. 次のコマンドを実行し、.cobolBuild スクリプトおよびコード分析の Ant ターゲットを使用してプロジェクトでコード分析を実行します。
    Ant-install-dir\bin\ant -f .cobolBuild Ant-target -DanalysisFailOnError=value

    詳細は次のとおりです。

    • Ant-install-dir は、Ant のインストール ディレクトリです。Ant-dir\bin を PATH 環境変数に追加して、Ant 実行可能ファイルのフル パスを指定する必要を回避できます。
    • Ant-target は、コード分析でプロジェクトの .cobolBuild スクリプトへの追加を可能にするターゲットの 1 つです。
      analyze
      Ant でソースの分析のみが行われます。
      build.and.analyze
      Ant でプロジェクトのビルド、ビルド出力の作成が行われてから、ソース ファイルが分析されます。
    • FailOnError が取る valuetrue または false です。
      true
      分析ルールの実行によって結果が返された場合にコードの分析 (またはビルドおよび分析) を停止することを指定します。
      false
      分析ルールの実行によって結果が返された場合にコードの分析 (またはビルドおよび分析) を続行することを指定します。

    次に例を示します。

    c:\tools\antdir\bin\ant -f .cobolBuild build.and.analyze -DanalysisFailOnError=true

.cobolBuild スクリプトのカスタマイズ

プロジェクトのプロパティでコード分析の設定を変更すると、これにより、.cobolBuild スクリプト ファイルが変更されます。または、エディターで .cobolBuild スクリプトを開き、コード分析の設定を手動で変更できます (ただし、IDE でプロジェクトがリビルドされると、これらの変更は前の状態に戻ります)。

スクリプトおよびソース ファイルが同じ場所に保存されている場合には、ワークスペースの外側から .cobolBuild スクリプト ファイルを使用してコード分析を実行できます。これは、コード分析のタスクを継続的インテグレーション (CI) フレームワークに統合する場合、またはワークスペースの外側 (たとえば、Subversion などのバージョン管理システム) にアプリケーションを保存する場合に便利です。

この場合、ファイルを手動で変更してさらに複雑なコード分析ターゲットを作成できます。IDE ではプロジェクトをリビルドするたびにスクリプトをリビルドするため、スクリプトをプロジェクトの一部として開いた場合には、スクリプトを編集できません。

必要な .cobolBuild スクリプト パラメーターについては、このトピックの「.cobolBuild スクリプトでのコード分析のプロパティ」のセクションを参照してください。rulesDir タグおよび rulesDir.custom タグが、実行するコード分析ルールが含まれているファイルの場所をポイントしていることを確認します。

コード分析ジョブからの結果

コマンド ラインからのコード分析結果は、すべてのビルド メッセージとともにコマンド プロンプト ウィンドウに表示されます。

メッセージは、次の書式で構成されています。

[Filename and full path] [LocationInFile (start line, column, end line, column)] : [ErrorMessage (error/warning + output code)] :  [RuleSetName] :  [Rule] :  [Code snippet the location refers to]

次に例を示します。

C:\Tutorials\Projects\MyProject\MyProgram.cbl (14,8,14,33): warning MFCA0001 : Within Entire Program : Dead Statements : display "Some Message"