第3章 ソースから FindBugs をビルドする

目次

1. 必須条件
2. ソース配布物の展開
3. build.properties の修正
4. Ant の実行
5. FindBugs の実行

この章では、 FindBugs をソースコードからどのようにビルドするのかを説明します。 FindBugs を修正することに興味がないのであれば、この章を飛ばすことができます。 次の章.

1. 必須条件

ソースから FindBugs をビルドするには、次の手順にしたがう必要があります:

[Warning]警告

Redhat Linux システムに /usr/bin/ant として 含まれているバージョンの Ant は、FindBugs のコンパイルのためには 動作しませんAnt web サイト から Ant のバイナリ配布物をダウンロードしてインストールすることを お勧めします。 Ant を実行するときには、JAVA_HOME 環境変数が、JDK 1.5 (またはそれ以降) がインストールされている 正しいディレクトリを指していることを確認してください。

整形されたバージョンの FindBugs ドキュメントを生成したい場合は、 以下のソフトウェアも必要となります:

2. ソース配布物の展開

ソース配布物をダウンロードした後に、それを作業用ディレクトリに展開する 必要があるでしょう。 通常は、次のコマンドを行います:

$ unzip findbugs-0.9.1-source.zip

3. build.properties の修正

もし、FindBugs 文書をビルドするつもりであれば、 FindBugs のビルドに使われる Ant build.xmlbuild.properties を 修正する必要があるでしょう。 FindBugs 文書をビルドしたくない場合は、このファイルを無視しても かまいません。

build.properties は次のような内容です:


# User Configuration:
# This section must be modified to reflect your system.

local.software.home     =/export/home/daveho/linux

# Set this to the directory containing the DocBook Modular XSL Stylesheets
#  from http://docbook.sourceforge.net/projects/xsl/

xsl.stylesheet.home     =${local.software.home}/docbook/docbook-xsl-1.61.0

# Set this to the directory where Saxon (http://saxon.sourceforge.net/)
# is installed. 

saxon.home              =${local.software.home}/java/saxon-6.5.2

xsl.stylesheet.home プロパティは、 DocBook Modular XSL スタイルシート がインストールされているフルパスが指定されます。 FindBugs ドキュメンテーションを 生成する場合にのみ、このプロパティを設定する必要があります。

saxon.home プロパティは、 Saxon XSLT Processor が インストールされているディレクトリへのフルパスが指定されます。 FindBugs ドキュメンテーションを生成する場合にのみ、 このプロパティを設定する必要があります。

4. Ant の実行

ソース配布物を展開したならば、 Ant がインストールされていることを確かめて、 build.xml を修正します。 (オプション) Saxon などの関連するツールを設定することで、 FindBugs をビルドする準備が整います。 Ant の起動は、コマンドを走らせる 単純なものです

$ ant target

target には次のいずれかを指定します:

build

このターゲットは FindBugs のコードをコンパイルします。 これはデフォルトのターゲットです。

docs

このターゲットは、ドキュメントを整形します。 (これは、副作用として ソースコードのいくつかをコンパイルします)

runjunit

このターゲットは、コンパイルして FindBugs 中に含まれている 内部 JUnit テストを実行します。 もし、ユニットテストが 失敗した場合、エラーメッセージを表示します。

bindist

FindBugs のバイナリ配布物をビルドします。 このターゲットは、.zip および .tar.gz の両方のアーカイブを 作成します。

Ant コマンドを実行した後は、次に示すような出力を見るはずです (タスクに関するいくつかの他のメッセージの後に、Ant は 実行されています):


BUILD SUCCESSFUL
Total time: 17 seconds

5. FindBugs の実行

build ターゲットでビルドした後などに、 FindBugs 用の Ant ビルドスクリプトはセットアップされます。 作業用ディレクトリはちょうどバイナリ配布物のようにセットアップされます。 なので、章 2. FindBugs のインストールおよび起動 にある FindBugs の バイナリ配布物のインストール方法は、ソース配布物にも同じように 適用されます。