タスクベースのビルドシステム

このページでは、タスクベースのビルドシステム、その仕組み、タスクベースのシステムで発生する可能性のある複雑さについて説明します。シェルスクリプトの次に、タスクベースのビルドシステムがビルドの論理的な進化です。

タスクベースのビルドシステムについて

タスクベースのビルドシステムでは、タスクが基本的な処理単位です。各タスクは、あらゆる種類のロジックを実行できるスクリプトであり、タスクは、他のタスクをその前に実行する必要がある依存関係として指定します。Ant、Maven、Gradle、Grunt、Rake など、現在使用されているほとんどの主要なビルドシステムはタスクベースです。ほとんどの最新のビルドシステムでは、シェルスクリプトではなく、ビルドを実行する方法を記述するビルドファイルを作成する必要があります。

Ant マニュアルから次の例を取り上げます。

<project name="MyProject" default="dist" basedir=".">
   <description>
     simple example build file
   </description>
   <!-- set global properties for this build -->
   <property name="src" location="src"/>
   <property name="build" location="build"/>
   <property name="dist" location="dist"/>

   <target name="init">
     <!-- Create the time stamp -->
     <tstamp/>
     <!-- Create the build directory structure used by compile -->
     <mkdir dir="${build}"/>
   </target>
   <target name="compile" depends="init"
       description="compile the source">
     <!-- Compile the Java code from ${src} into ${build} -->
     <javac srcdir="${src}" destdir="${build}"/>
   </target>
   <target name="dist" depends="compile"
       description="generate the distribution">
     <!-- Create the distribution directory -->
     <mkdir dir="${dist}/lib"/>
     <!-- Put everything in ${build} into the MyProject-${DSTAMP}.jar file -->
     <jar jarfile="${dist}/lib/MyProject-${DSTAMP}.jar" basedir="${build}"/>
   </target>
   <target name="clean"
       description="clean up">
     <!-- Delete the ${build} and ${dist} directory trees -->
     <delete dir="${build}"/>
     <delete dir="${dist}"/>
   </target>
</project>

buildfile は XML で記述され、タスクのリスト（XML の <target> タグ）とともに、ビルドに関する簡単なメタデータを定義します。（Ant では、タスクを表すために「ターゲット」という単語を使用し、コマンドを表すために「タスク」という単語を使用します）。各タスクは、Ant で定義された実行可能なコマンドのリストを実行します。ここでは、ディレクトリの作成と削除、javac の実行、JAR ファイルの作成などがあります。このコマンドセットは、ユーザー提供のプラグインで拡張して、あらゆる種類のロジックに対応しています。各タスクは、depends 属性を使用して、依存するタスクを定義することもできます。これらの依存関係は、図 1 に示すように非巡回グラフを形成します。

図 1. 依存関係を示す非巡回グラフ

ユーザーは、Ant のコマンドラインツールにタスクを指定することでビルドを実行します。たとえば、ユーザーが「ant dist」と入力すると、Ant は次の処理を行います。

現在のディレクトリにある build.xml という名前のファイルを読み込み、解析して図 1 に示すグラフ構造を作成します。
コマンドラインで指定された dist という名前のタスクを検索し、compile という名前のタスクに依存していることを確認します。
compile という名前のタスクを検索し、init という名前のタスクに依存していることを確認します。
init という名前のタスクを探し、依存関係がないことを確認します。
init タスクで定義されたコマンドを実行します。
タスクのすべての依存関係が実行されていることを前提として、compile タスクで定義されたコマンドを実行します。
タスクのすべての依存関係が実行されていることを前提として、dist タスクで定義されたコマンドを実行します。

最終的に、dist タスクの実行時に Ant によって実行されるコードは、次のシェルスクリプトと同等です。

./createTimestamp.sh
mkdir build/
javac src/* -d build/
mkdir -p dist/lib/
jar cf dist/lib/MyProject-$(date --iso-8601).jar build/*

構文を削除すると、ビルドファイルとビルドスクリプトは実際にはほとんど同じです。しかし、この取り組みによってすでに多くの成果が得られています。他のディレクトリに新しい buildfile を作成して、それらをリンクできます。既存のタスクに依存する新しいタスクを任意の複雑な方法で簡単に追加できます。ant コマンドラインツールに単一のタスクの名前を渡すだけで、実行が必要なすべてのタスクが決定されます。

Ant は 2000 年にリリースされた古いソフトウェアです。Maven や Gradle などの他のツールは、Ant の登場から数年の間に改善され、外部依存関係の自動管理や XML のないクリーンな構文などの機能を追加することで、実質的に Ant に取って代わっています。しかし、こうした新しいシステムの性質は変わりません。エンジニアは、原則的かつモジュール方式の方法でビルドスクリプトをタスクとして記述し、タスクの実行とタスク間の依存関係を管理するためのツールを提供できます。

タスクベースのビルドシステムのダークサイド

これらのツールでは、基本的にエンジニアが任意のスクリプトをタスクとして定義できるため、非常に強力で、想像できるほとんどのことを実行できます。ただし、その強力さには欠点もあります。タスクベースのビルドシステムは、ビルドスクリプトが複雑になるにつれて扱いづらくなる可能性があります。このようなシステムの問題は、エンジニアに過剰な権限を与え、システムに十分な権限を与えない結果になるということです。システムはスクリプトが何をしているのかを認識していないため、ビルドステップのスケジューリングと実行方法が非常に保守的になり、パフォーマンスが低下します。また、各スクリプトが想定どおりに動作していることをシステムが確認する方法がないため、スクリプトは複雑になり、最終的にはデバッグが必要になります。

ビルドステップの並列化の難しさ

最新の開発ワークステーションは非常に強力で、複数のコアによって複数のビルドステップを並行して実行できます。ただし、タスクベースのシステムでは、タスクの実行を並列化できると思われる場合でも、並列化できないことがよくあります。タスク A がタスク B と C に依存しているとします。タスク B とタスク C は相互に依存していないため、システムがタスク A に迅速に移行できるように、タスク B とタスク C を同時に実行しても安全ですか？同じリソースにアクセスしない場合は可能です。ただし、両方が同じファイルを使用してステータスを追跡し、同時に実行すると競合が発生する可能性があります。システムがこれを認識する方法は一般的にないため、これらの競合のリスクを負うか（まれではあるがデバッグが非常に難しいビルドの問題につながる）、ビルド全体を単一のプロセス内の単一スレッドで実行するように制限する必要があります。これは、強力なデベロッパーマシンを大幅に浪費する可能性があり、ビルドを複数のマシンに分散する可能性を完全に排除します。

増分ビルドの実行が困難

優れたビルドシステムがあれば、エンジニアは信頼性の高い増分ビルドを実行できます。そのため、小さな変更でコードベース全体をゼロから再構築する必要はありません。これは、ビルドシステムが遅く、前述の理由でビルドステップを並列化できない場合に特に重要です。残念ながら、タスクベースのビルドシステムでも同様の問題が発生します。タスクは任意の処理を行うことができるため、タスクがすでに実行されているかどうかを確認する方法はありません。多くのタスクは、単純にソースファイルのセットを取得し、コンパイラを実行してバイナリのセットを作成します。そのため、基盤となるソースファイルが変更されていない限り、再実行する必要はありません。ただし、追加情報なしでは、タスクが変更された可能性のあるファイルをダウンロードしたり、実行ごとに異なるタイムスタンプを書き込んだりする可能性があるため、システムはこれを明確に判断できません。正確性を確保するために、通常、システムは各ビルドですべてのタスクを再実行する必要があります。一部のビルドシステムでは、タスクを再実行する必要がある条件をエンジニアが指定できるようにすることで、増分ビルドを有効にしようとします。場合によっては可能ですが、多くの場合、問題は見かけよりもはるかに複雑です。たとえば、他のファイルによってファイルを直接含めることができる C++ などの言語では、入力ソースを解析せずに、変更を監視する必要があるファイルのセット全体を特定することはできません。エンジニアは、しばしば近道をとってしまい、その近道が、タスクの結果が再利用されるべきでないときに再利用されるという、まれでイライラする問題につながる可能性があります。これが頻繁に発生する場合、エンジニアはすべてのビルドの前にクリーンに実行する習慣を身に付け、新しい状態を取得するため、そもそも増分ビルドを行うという目的を完全に果たせません。タスクを再実行する必要があるタイミングを判断するのは、意外に微妙な作業であり、人間よりもマシンが適しています。

スクリプトの管理とデバッグが困難

最後に、タスクベースのビルドシステムによって課せられるビルドスクリプトは、多くの場合、扱いにくいものです。多くの場合、あまり精査されることはあまりありませんが、ビルドスクリプトはビルドされるシステムと同様のコードであり、バグが簡単に隠れてしまう場所です。タスクベースのビルドシステムでよく発生するバグの例を次に示します。

タスク A はタスク B に依存して、特定のファイルを出力します。タスク B のオーナーは、他のタスクがそれに依存していることに気付かないため、別の場所に出力を生成するように変更します。これは、タスク A の実行を試みて失敗するまで検出できません。
タスク A はタスク B に依存し、タスク B はタスク C に依存します。タスク C は、タスク A に必要な出力として特定のファイルを生成します。タスク B のオーナーは、タスク C にこれ以上依存する必要がないと判断します。これにより、タスク B はタスク C にまったく依存していなくても、タスク A は失敗します。
新しいタスクのデベロッパーが、タスクを実行するマシンについて、ツールの場所や特定の環境変数の値など、誤って前提条件を設定している。タスクは自分のマシンでは動作するが、別のデベロッパーが試すたびに失敗する。
インターネットからのファイルのダウンロードやビルドへのタイムスタンプの追加など、タスクに非決定的なコンポーネントが含まれている。現在、ビルドを実行するたびに結果が変わる可能性があります。つまり、エンジニアがお互いの障害や自動ビルドシステムで発生した障害を常に再現して修正できるとは限りません。
複数の依存関係を持つタスクは、競合状態を引き起こす可能性があります。タスク A がタスク B とタスク C の両方に依存し、タスク B とタスク C の両方が同じファイルを変更する場合、タスク A は、タスク B とタスク C のどちらが先に完了するかによって異なる結果になります。

ここで説明するタスクベースのフレームワークでは、パフォーマンス、正確性、メンテナンス性に関する問題を解決するための汎用的な方法はありません。エンジニアがビルド中に実行される任意のコードを記述できる限り、システムは、ビルドを常に迅速かつ正確に実行できる十分な情報を保持できません。この問題を解決するには、エンジニアの負担を軽減し、システムに負担を移行し、システムの役割をタスクの実行ではなくアーティファクトの生成として再定義する必要があります。

このアプローチにより、Blaze や Bazel などのアーティファクトベースのビルドシステムが誕生しました。