Hệ thống xây dựng dựa trên nhiệm vụ

Báo cáo vấn đề Xem nguồn Nightly · 7.4 .

Trang này trình bày về các hệ thống xây dựng dựa trên tác vụ, cách hoạt động của các hệ thống này và một số vấn đề có thể xảy ra với các hệ thống dựa trên tác vụ. Sau tập lệnh shell, hệ thống xây dựng dựa trên tác vụ là bước phát triển logic tiếp theo của quá trình xây dựng.

Tìm hiểu về hệ thống xây dựng dựa trên tác vụ

Trong hệ thống xây dựng dựa trên nhiệm vụ, đơn vị công việc cơ bản là nhiệm vụ. Mỗi tác vụ là một tập lệnh có thể thực thi bất kỳ loại logic nào và các tác vụ chỉ định các tác vụ khác dưới dạng phần phụ thuộc phải chạy trước các tác vụ đó. Hầu hết các hệ thống xây dựng chính đang được sử dụng hiện nay, chẳng hạn như Ant, Maven, Gradle, Grunt và Rake, đều dựa trên tác vụ. Thay vì tập lệnh shell, hầu hết các hệ thống xây dựng hiện đại đều yêu cầu kỹ sư tạo tệp bản dựng mô tả cách thực hiện bản dựng.

Hãy xem ví dụ sau trong hướng dẫn về 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>

Tệp bản dựng được viết bằng XML và xác định một số siêu dữ liệu đơn giản về bản dựng cùng với danh sách tác vụ (thẻ <target> trong XML). (Ant sử dụng từ target để biểu thị một task (tác vụ) và từ task (tác vụ) để chỉ lệnh.) Mỗi tác vụ thực thi một danh sách các lệnh có thể được Ant xác định, trong đó bao gồm việc tạo và xoá thư mục, chạy javac và tạo tệp JAR. Nhóm lệnh này có thể được mở rộng bằng các trình bổ trợ do người dùng cung cấp để bao gồm mọi loại logic. Mỗi tác vụ cũng có thể xác định các nhiệm vụ phụ thuộc thông qua thuộc tính phụ thuộc. Các phần phụ thuộc này tạo thành một biểu đồ không tuần hoàn, như trong Hình 1.

Biểu đồ Acrylic cho thấy các phần phụ thuộc

Hình 1. Một đồ thị không chu trình thể hiện các phần phụ thuộc

Người dùng thực hiện bản dựng bằng cách cung cấp tác vụ cho công cụ dòng lệnh của Ant. Ví dụ: khi người dùng nhập ant dist, Ant sẽ thực hiện các bước sau:

  1. Tải tệp có tên build.xml trong thư mục hiện tại và phân tích cú pháp tệp đó để tạo cấu trúc biểu đồ như minh hoạ trong Hình 1.
  2. Tìm tác vụ có tên dist được cung cấp trên dòng lệnh và phát hiện tác vụ này có phần phụ thuộc trên tác vụ có tên compile.
  3. Tìm tác vụ có tên compile và phát hiện tác vụ này có phần phụ thuộc trên tác vụ có tên init.
  4. Tìm tác vụ có tên init và phát hiện tác vụ này không có phần phụ thuộc.
  5. Thực thi các lệnh được xác định trong tác vụ init.
  6. Thực thi các lệnh được xác định trong tác vụ compile, với điều kiện là tất cả phần phụ thuộc của tác vụ đó đã được chạy.
  7. Thực thi các lệnh được xác định trong tác vụ dist, với điều kiện là tất cả phần phụ thuộc của tác vụ đó đã được chạy.

Cuối cùng, mã do Ant thực thi khi chạy tác vụ dist tương đương với tập lệnh shell sau:

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

Khi cú pháp bị xoá, tệp bản dựng và tập lệnh bản dựng thực sự không quá khác biệt. Nhưng chúng tôi đã thu được nhiều lợi ích từ việc này. Chúng ta có thể tạo các tệp bản dựng mới trong các thư mục khác và liên kết các tệp đó với nhau. Chúng ta có thể dễ dàng thêm các tác vụ mới phụ thuộc vào các tác vụ hiện có theo cách tuỳ ý và phức tạp. Chúng tôi chỉ cần truyền tên của một tác vụ duy nhất cho công cụ dòng lệnh ant và công cụ này xác định mọi thứ cần chạy.

Ant là một phần mềm cũ, được phát hành lần đầu vào năm 2000. Các công cụ khác như Maven và Gradle đã cải thiện Ant trong những năm qua và về cơ bản đã thay thế công cụ này bằng cách thêm các tính năng như tự động quản lý các phần phụ thuộc bên ngoài và cú pháp rõ ràng hơn mà không cần XML. Tuy nhiên, bản chất của các hệ thống mới hơn này vẫn không thay đổi: chúng cho phép kỹ sư viết tập lệnh bản dựng theo cách nguyên tắc và mô-đun dưới dạng tác vụ, đồng thời cung cấp các công cụ để thực thi các tác vụ đó và quản lý các phần phụ thuộc giữa các tác vụ.

Mặt tối của hệ thống xây dựng dựa trên tác vụ

Vì về cơ bản, các công cụ này cho phép các kỹ sư xác định bất kỳ tập lệnh nào là một nhiệm vụ, nên chúng cực kỳ mạnh mẽ, cho phép bạn làm được hầu hết mọi việc mà bạn có thể hình dung ra với chúng. Tuy nhiên, sức mạnh đó đi kèm với nhiều hạn chế và hệ thống xây dựng dựa trên nhiệm vụ có thể gặp khó khăn khi xử lý các tập lệnh bản dựng ngày càng phức tạp hơn. Vấn đề với các hệ thống như vậy là cuối cùng chúng lại cấp quá nhiều quyền cho kỹ sư và không đủ quyền cho hệ thống. Vì hệ thống không biết tập lệnh đang làm gì, nên hiệu suất bị ảnh hưởng, vì hệ thống phải rất thận trọng trong cách lập lịch và thực thi các bước xây dựng. Và hệ thống không có cách nào để xác nhận rằng mỗi tập lệnh đang thực hiện đúng chức năng của nó, vì vậy, các tập lệnh có xu hướng trở nên phức tạp hơn và cuối cùng lại là một vấn đề khác cần gỡ lỗi.

Khó khăn trong việc song song hoá các bước tạo bản dựng

Các máy trạm phát triển hiện đại khá mạnh mẽ, với nhiều nhân có thể thực thi song song một số bước xây dựng. Tuy nhiên, các hệ thống dựa trên tác vụ thường không thể thực thi tác vụ song song ngay cả khi có vẻ như chúng có thể thực hiện được. Giả sử tác vụ A phụ thuộc vào tác vụ B và C. Vì tác vụ B và C không phụ thuộc lẫn nhau, nên có an toàn khi chạy các tác vụ này cùng lúc để hệ thống có thể chuyển sang tác vụ A nhanh hơn không? Có thể, nếu họ không đề cập đến bất kỳ tài nguyên nào giống nhau. Nhưng có thể không – có thể cả hai đều sử dụng cùng một tệp để theo dõi trạng thái và việc chạy đồng thời các tệp đó sẽ gây ra xung đột. Nhìn chung, hệ thống không có cách nào để biết được điều này, vì vậy, hệ thống phải chấp nhận rủi ro về những xung đột này (dẫn đến các vấn đề về bản dựng hiếm gặp nhưng rất khó gỡ lỗi) hoặc phải hạn chế toàn bộ bản dựng chạy trên một luồng trong một quy trình. Điều này có thể gây lãng phí rất lớn cho máy tính mạnh của nhà phát triển và hoàn toàn loại trừ khả năng phân phối bản dựng trên nhiều máy.

Khó tạo bản dựng tăng dần

Một hệ thống xây dựng tốt cho phép các kỹ sư tạo các bản dựng gia tăng đáng tin cậy, chẳng hạn như một thay đổi nhỏ không yêu cầu tạo lại toàn bộ cơ sở mã từ đầu. Điều này đặc biệt quan trọng nếu hệ thống xây dựng bị chậm và không thể chạy song song các bước xây dựng vì những lý do nêu trên. Nhưng thật không may, hệ thống xây dựng dựa trên tác vụ cũng gặp khó khăn ở đây. Vì tác vụ có thể làm bất cứ việc gì, nên nhìn chung, không có cách nào để kiểm tra xem chúng đã được thực hiện hay chưa. Nhiều tác vụ chỉ cần lấy một tập hợp tệp nguồn và chạy trình biên dịch để tạo một tập hợp tệp nhị phân; do đó, bạn không cần chạy lại các tác vụ này nếu các tệp nguồn cơ bản không thay đổi. Tuy nhiên, nếu không có thông tin bổ sung thì hệ thống không thể nói chắc chắn điều này – có thể tác vụ tải một tệp có thể đã thay đổi xuống, hoặc có thể tác vụ ghi một dấu thời gian khác nhau trong mỗi lần chạy. Để đảm bảo tính chính xác, hệ thống thường phải chạy lại mọi tác vụ trong mỗi bản dựng. Một số hệ thống xây dựng cố gắng bật các bản dựng gia tăng bằng cách cho phép kỹ sư chỉ định các điều kiện cần chạy lại một tác vụ. Đôi khi, việc này là khả thi, nhưng thường thì đây là một vấn đề phức tạp hơn nhiều so với vẻ bề ngoài. Ví dụ: trong các ngôn ngữ như C++ cho phép các tệp được đưa vào trực tiếp bởi các tệp khác, bạn không thể xác định toàn bộ tập hợp tệp cần được theo dõi để tìm thay đổi mà không phân tích cú pháp các nguồn đầu vào. Các kỹ sư thường sử dụng lối tắt và những lối tắt này có thể dẫn đến các vấn đề hiếm gặp và khó chịu, trong đó kết quả của một tác vụ được sử dụng lại ngay cả khi không nên. Khi điều này xảy ra thường xuyên, các kỹ sư sẽ có thói quen chạy sạch trước mỗi bản dựng để có trạng thái mới, hoàn toàn không đạt được mục đích ban đầu là có một bản dựng tăng dần. Việc xác định thời điểm cần chạy lại một tác vụ là một việc rất tinh tế và là công việc mà máy móc xử lý tốt hơn con người.

Khó duy trì và gỡ lỗi tập lệnh

Cuối cùng, các tập lệnh bản dựng do hệ thống bản dựng dựa trên tác vụ áp đặt thường rất khó sử dụng. Mặc dù thường ít được kiểm tra kỹ lưỡng hơn, nhưng tập lệnh bản dựng cũng là mã giống như hệ thống đang được tạo và là nơi dễ ẩn lỗi. Dưới đây là một số ví dụ về lỗi rất thường gặp khi làm việc với hệ thống xây dựng dựa trên tác vụ:

  • Tác vụ A phụ thuộc vào nhiệm vụ B để tạo một tệp cụ thể làm đầu ra. Chủ sở hữu của tác vụ B không nhận ra rằng các tác vụ khác phụ thuộc vào tác vụ này, vì vậy, họ thay đổi tác vụ này để tạo ra đầu ra ở một vị trí khác. Bạn không thể phát hiện điều này cho đến khi có người cố gắng chạy tác vụ A và nhận thấy tác vụ đó không thành công.
  • Tác vụ A phụ thuộc vào tác vụ B, tác vụ B phụ thuộc vào tác vụ C, tác vụ C đang tạo một tệp cụ thể làm đầu ra mà tác vụ A cần. Chủ sở hữu của tác vụ B quyết định rằng tác vụ này không cần phụ thuộc vào tác vụ C nữa, điều này khiến tác vụ A không thành công mặc dù tác vụ B hoàn toàn không quan tâm đến tác vụ C!
  • Nhà phát triển của một tác vụ mới vô tình đưa ra giả định về máy đang chạy tác vụ, chẳng hạn như vị trí của một công cụ hoặc giá trị của các biến môi trường cụ thể. Tác vụ hoạt động trên máy của họ nhưng không thành công mỗi khi một nhà phát triển khác thử.
  • Một tác vụ chứa một thành phần không xác định, chẳng hạn như tải tệp xuống từ Internet hoặc thêm dấu thời gian vào một bản dựng. Giờ đây, mọi người có thể nhận được kết quả khác nhau mỗi khi chạy bản dựng, nghĩa là các kỹ sư không phải lúc nào cũng có thể tái tạo và khắc phục lỗi của nhau hoặc lỗi xảy ra trên hệ thống xây dựng tự động.
  • Những tác vụ có nhiều phần phụ thuộc có thể tạo ra điều kiện tranh đấu. Nếu tác vụ A phụ thuộc vào cả tác vụ B và tác vụ C, đồng thời tác vụ B và C đều sửa đổi cùng một tệp, thì tác vụ A sẽ nhận được kết quả khác nhau tuỳ thuộc vào việc tác vụ B hay C hoàn tất trước.

Không có cách chung để giải quyết các vấn đề về hiệu suất, độ chính xác hoặc khả năng bảo trì trong khung dựa trên tác vụ được trình bày ở đây. Do các kỹ sư có thể viết mã tuỳ ý chạy trong quá trình tạo bản dựng, thì hệ thống sẽ không thể có đủ thông tin để luôn chạy các bản dựng một cách nhanh chóng và chính xác. Để giải quyết vấn đề này, chúng ta cần lấy một số quyền ra khỏi tay kỹ sư và đưa quyền đó trở lại hệ thống, đồng thời tái cấu trúc vai trò của hệ thống không phải là chạy tác vụ mà là tạo cấu phần phần mềm.

Phương pháp này đã dẫn đến việc tạo ra các hệ thống xây dựng dựa trên cấu phần phần mềm, như Blaze và Bazel.