Sistem Build Berbasis Tugas

Laporkan masalah Lihat sumber

Halaman ini membahas sistem build berbasis tugas, cara kerjanya, dan beberapa detail yang dapat terjadi dengan sistem berbasis tugas. Setelah skrip shell, sistem build berbasis tugas adalah evolusi logis berikutnya dari build.

Memahami sistem build berbasis tugas

Dalam sistem build berbasis tugas, unit kerja dasar adalah tugas. Setiap tugas adalah skrip yang dapat menjalankan logika apa pun, dan tugas menentukan tugas lain sebagai dependensi yang harus dijalankan sebelumnya. Sebagian besar sistem build utama yang digunakan saat ini, seperti Ant, Maven, Gradle, Grunt, dan Rake, berbasis tugas. Alih-alih skrip shell, sebagian besar sistem build modern mengharuskan engineer untuk membuat file build yang menjelaskan cara menjalankan build.

Lihat contoh ini dari Panduan 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 ini ditulis dalam XML dan menentukan beberapa metadata sederhana tentang build beserta daftar tugas (tag <target> dalam XML). (Ant menggunakan kata target untuk mewakili task, dan menggunakan kata task untuk merujuk pada perintah.) Setiap tugas mengeksekusi daftar kemungkinan perintah yang ditentukan oleh Ant, yang di sini meliputi pembuatan dan penghapusan direktori, menjalankan javac, dan membuat file JAR. Rangkaian perintah ini dapat diperluas oleh plugin yang disediakan pengguna untuk mencakup logika apa pun. Setiap tugas juga dapat menentukan tugas yang menjadi dependensinya melalui atribut dependen. Dependensi ini membentuk grafik asiklik, seperti yang terlihat pada Gambar 1.

Grafik akrilik yang menunjukkan dependensi

Gambar 1. Grafik asiklik yang menunjukkan dependensi

Pengguna melakukan build dengan memberikan tugas ke alat command line Ant. Misalnya, saat pengguna mengetik ant dist, Ant akan melakukan langkah-langkah berikut:

  1. Memuat file bernama build.xml di direktori saat ini dan mengurainya untuk membuat struktur grafik yang ditunjukkan pada Gambar 1.
  2. Mencari tugas bernama dist yang disediakan pada command line dan menemukan bahwa tugas tersebut memiliki dependensi pada tugas bernama compile.
  3. Mencari tugas bernama compile dan menemukan bahwa tugas tersebut memiliki dependensi pada tugas bernama init.
  4. Mencari tugas bernama init dan menemukan bahwa tugas tersebut tidak memiliki dependensi.
  5. Menjalankan perintah yang ditentukan dalam tugas init.
  6. Menjalankan perintah yang ditentukan dalam tugas compile mengingat semua dependensi tugas tersebut telah dijalankan.
  7. Menjalankan perintah yang ditentukan dalam tugas dist mengingat semua dependensi tugas tersebut telah dijalankan.

Pada akhirnya, kode yang dieksekusi oleh Ant saat menjalankan tugas dist setara dengan skrip shell berikut:

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

Jika sintaksis dihilangkan, buildfile dan skrip build sebenarnya tidak terlalu berbeda. Namun, kami telah memperoleh banyak manfaat dengan melakukan hal ini. Kita bisa membuat buildfile baru di direktori lain dan menautkannya. Kita dapat dengan mudah menambahkan tugas baru yang bergantung pada tugas yang ada dengan cara yang arbitrer dan kompleks. Kita hanya perlu meneruskan nama satu tugas ke alat command line ant, dan alat tersebut akan menentukan semua yang perlu dijalankan.

Ant adalah software lawas, awalnya dirilis pada tahun 2000. Alat lain seperti Maven dan Gradle telah meningkatkan Ant selama bertahun-tahun intervensi dan pada dasarnya menggantikannya dengan menambahkan fitur seperti pengelolaan otomatis dependensi eksternal dan sintaksis yang lebih rapi tanpa XML apa pun. Namun, karakteristik sistem yang lebih baru ini tetap sama: sistem ini memungkinkan engineer untuk menulis skrip build dengan cara yang berprinsip dan modular sebagai tugas dan menyediakan alat untuk menjalankan tugas tersebut serta mengelola dependensi di antaranya.

Sisi gelap sistem build berbasis tugas

Karena pada dasarnya alat ini memungkinkan engineer menentukan skrip apa pun sebagai tugas, alat ini sangat ampuh, sehingga Anda dapat melakukan hampir semua hal yang dapat Anda bayangkan dengannya. Namun, keunggulan tersebut memiliki kelemahan, dan sistem build berbasis tugas dapat menjadi sulit digunakan karena skrip build-nya menjadi lebih kompleks. Masalah dengan sistem seperti ini adalah sebenarnya pada akhirnya sistem memberikan terlalu banyak daya kepada para engineer dan tidak cukup daya bagi sistem. Karena sistem tidak mengetahui apa yang dilakukan skrip, performa akan menurun, karena sistem harus sangat konservatif dalam menjadwalkan dan menjalankan langkah-langkah build. Selain itu, tidak ada cara bagi sistem untuk mengonfirmasi bahwa setiap skrip melakukan fungsi yang seharusnya, sehingga skrip cenderung menjadi kompleksitas dan pada akhirnya menjadi hal lain yang memerlukan proses debug.

Kesulitan dalam memparalelkan langkah build

Workstation pengembangan modern sangatlah canggih, dengan beberapa core yang mampu menjalankan beberapa langkah build secara paralel. Namun, sistem berbasis tugas sering kali tidak dapat memparalelkan eksekusi tugas meskipun kelihatannya seharusnya dapat dilakukan. Misalkan tugas A tergantung pada tugas B dan C. Karena tugas B dan C tidak saling bergantung, apakah aman untuk menjalankannya secara bersamaan sehingga sistem dapat lebih cepat menuju tugas A? Mungkin, jika mereka tidak menggunakan sumber daya yang sama. Tapi mungkin tidak—mungkin keduanya menggunakan file yang sama untuk melacak status dan menjalankannya secara bersamaan akan menyebabkan konflik. Secara umum, tidak ada cara untuk mengetahui sistem, jadi sistem harus berisiko menimbulkan konflik ini (yang menyebabkan masalah build yang jarang terjadi tetapi sangat sulit di-debug), atau sistem harus membatasi seluruh build agar berjalan pada satu thread dalam satu proses. Hal ini dapat menjadi pemborosan besar dari mesin developer yang canggih, dan sepenuhnya mengesampingkan kemungkinan distribusi build di beberapa mesin.

Kesulitan saat melakukan build inkremental

Sistem build yang baik memungkinkan engineer melakukan build inkremental yang andal, sehingga perubahan kecil tidak memerlukan seluruh codebase untuk dibangun ulang dari awal. Hal ini sangat penting jika sistem build lambat dan tidak dapat memparalelkan langkah-langkah build karena alasan yang disebutkan di atas. Namun sayangnya, sistem build berbasis tugas juga kesulitan. Karena tugas dapat melakukan apa saja, secara umum tidak ada cara untuk memeriksa apakah tugas tersebut sudah dilakukan. Banyak tugas hanya mengambil kumpulan file sumber dan menjalankan compiler untuk membuat sekumpulan biner; dengan demikian, tugas tersebut tidak perlu dijalankan ulang jika file sumber yang mendasarinya tidak berubah. Namun, tanpa informasi tambahan, sistem tidak dapat memastikannya —mungkin tugas mendownload file yang dapat berubah, atau mungkin menulis stempel waktu yang mungkin berbeda setiap kali dijalankan. Untuk menjamin kebenaran, sistem biasanya harus menjalankan ulang setiap tugas selama setiap build. Beberapa sistem build mencoba mengaktifkan build inkremental dengan mengizinkan engineer menentukan kondisi yang mendasari tugas untuk dijalankan kembali. Terkadang hal ini bisa dilakukan, tetapi sering kali, masalah ini jauh lebih rumit dari yang terlihat. Misalnya, dalam bahasa seperti C++ yang memungkinkan file disertakan secara langsung oleh file lain, Anda tidak dapat menentukan seluruh kumpulan file yang harus dipantau tanpa mengurai sumber input. Engineer sering kali mengambil jalan pintas, dan pintasan ini dapat menyebabkan masalah yang jarang terjadi dan membuat frustrasi, yang menyebabkan hasil tugas digunakan kembali meskipun seharusnya tidak. Jika hal ini sering terjadi, engineer akan terbiasa menjalankan clean sebelum setiap build untuk mendapatkan status baru, yang sepenuhnya menggagalkan tujuan memiliki build inkremental. Mencari tahu kapan tugas perlu dijalankan ulang ternyata sangat halus, dan merupakan pekerjaan yang lebih baik ditangani oleh mesin daripada manusia.

Kesulitan mempertahankan dan men-debug skrip

Terakhir, skrip build yang diberlakukan oleh sistem build berbasis tugas sering kali sulit untuk digunakan. Meskipun skrip tersebut sering kali tidak begitu diperhatikan, skrip build adalah kode yang mirip dengan sistem yang sedang dibangun, dan merupakan tempat mudah bagi bug untuk bersembunyi. Berikut beberapa contoh bug yang sangat umum saat bekerja dengan sistem build berbasis tugas:

  • Tugas A bergantung pada tugas B untuk menghasilkan file tertentu sebagai {i>output<i}. Pemilik tugas B tidak menyadari bahwa tugas lain bergantung pada tugas tersebut, sehingga mereka mengubahnya untuk menghasilkan output di lokasi yang berbeda. Ini tidak dapat dideteksi sampai seseorang mencoba menjalankan tugas A dan menemukan bahwa tugas itu gagal.
  • Tugas A bergantung pada tugas B, yang bergantung pada tugas C, yang menghasilkan file tertentu sebagai output yang diperlukan oleh tugas A. Pemilik tugas B memutuskan bahwa tugas tidak perlu bergantung pada tugas C lagi, yang menyebabkan tugas A gagal meskipun tugas B sama sekali tidak peduli dengan tugas C.
  • Developer tugas baru tidak sengaja membuat asumsi tentang mesin yang menjalankan tugas tersebut, seperti lokasi alat atau nilai variabel lingkungan tertentu. Tugas tersebut dapat berfungsi di komputernya, tetapi akan gagal setiap kali developer lain mencobanya.
  • Tugas berisi komponen nondeterministik, seperti mendownload file dari internet atau menambahkan stempel waktu ke build. Sekarang, pengguna akan mendapatkan hasil yang berpotensi berbeda setiap kali mereka menjalankan build, yang berarti bahwa engineer tidak akan selalu dapat mereproduksi dan memperbaiki kegagalan atau kegagalan satu sama lain yang terjadi di sistem build otomatis.
  • Tugas dengan beberapa dependensi dapat membuat kondisi race. Jika tugas A bergantung pada tugas B dan tugas C, dan tugas B serta C memodifikasi file yang sama, tugas A akan mendapatkan hasil yang berbeda, bergantung pada tugas B dan C yang mana yang selesai terlebih dahulu.

Tidak ada cara umum untuk menyelesaikan masalah performa, ketepatan, atau pengelolaan dalam framework berbasis tugas yang diuraikan di sini. Selama engineer dapat menulis kode arbitrer yang berjalan selama build, sistem tidak akan memiliki cukup informasi untuk selalu dapat menjalankan build dengan cepat dan benar. Untuk mengatasi masalah ini, kita perlu mengambil sejumlah kemampuan dari tangan engineer dan menyerahkannya kembali ke sistem serta mengkonsep ulang peran sistem bukan sebagai tugas yang sedang berjalan, tetapi sebagai menghasilkan artefak.

Pendekatan ini mengarah pada pembuatan sistem build berbasis artefak, seperti Blaze dan Bazel.