More than 5 years have passed since last update.

そのAnt→Gradle移行、もうちょい工数積んだ方がいいですよ

Posted at 2016-08-14

ビルドスクリプトがAntで書かれたレガシーなプロジェクトをGradle移行しようとして工数が見積もりより大幅に膨らんだ話。

GradleのAnt互換な作りは素晴らしい

Gradle ドキュメントが詳しいが、GradleはAntとの親和性が非常に高い。

例えば既存のAntビルドスクリプトがこんな感じであったとき

build.xml

<project>
    <target name="compile">
      <javac srcdir="src" destdir="classes" includeantruntime="false"/>
    </target>
</project>

Gradleのビルドスクリプトにただ一行、

build.gradle

ant.importBuild 'build.xml'

と書いてあげれば、GradleタスクとしてAntターゲットを取り込むことができる。
取り込んであげたタスクは、普通にGradleタスクとして実行が可能。

Shell

$ ant compile
Buildfile: /path/to/build.xml

compile:

BUILD SUCCESSFUL
Total time: 0 seconds

$ gradle compile
:compile

BUILD SUCCESSFUL

もしもGradle側の既存タスクと名前が被ってしまう場合も心配無用。Antターゲットの名前を変更してインポートできます。

build.gradle

ant.importBuild('build.xml') {
  antTaskName -> "ant.${antTaskName}".toString()
}

Shell

$ gradle ant.compile
:ant.compile

BUILD SUCCESSFUL

この辺でGradle大好き人間一丁あがり。

スクリプトをGradleに書き換える作業は後でやるとして、ひとまずGradleからAntを呼び出す形なら簡単だねと言ってました。当初は。

ant.importBuildを駆使して実際にスクリプトを書いてみたところ、以下の問題が。

GradleスクリプトをAntスクリプトと別の場所に置く要件があった場合、つまりAntのbasedirと、GradleのprojectDirが異なる場合、
スクリプトが意図通りに動きません。

ありがちなんですが、既存プロジェクトは複数のAntスクリプトをバッチファイルやシェルスクリプトでこねくり回してビルドしてました。
はじめは単純だったんでしょうけど、時を経るごとにAnt同士やスクリプトどうしの依存関係がぐちゃぐちゃに。

そのためかbasedirの指定が必須な作りになっており、そのままインポートできない、と。

仕方ないのでbasedir必須な既存のスクリプトを書き換えて、Gradleからでもインポートできるように変更しました。でもそこで章題の問題が顕在化。

Antは変数の上書きはせず、先勝ちことで知られています。
また、あるAntスクリプト内でantタスクを使い、別のAntスクリプトを呼び出す場合、プロパティを引き継ぐか否かをinheritAll属性で制御できます。

既存のプロジェクトには、以下のケースが混在していました。

Gradleスクリプトで単純にant.importBuildをすると、２.のケースになってしまいます。

結局この問題も、既存のAntスクリプトに手を加えずに解決することはできませんでした。

どうにか既存の資産を使おうと試行錯誤しましたが、全部Gradleスクリプトに書き換えた方がスッキリするという結論に。

既存のビルドスクリプトがぐちゃぐちゃしているなら、ant.importBuildを使わずに全部Gradleスクリプトで書き換える前提で見積もりましょう。