ไฟล์ BUILD

ส่วนก่อนหน้านี้อธิบายแพ็กเกจ เป้าหมาย และป้ายกำกับ รวมถึงกราฟทรัพยากร Dependency ของการสร้างในเชิงนามธรรม ส่วนนี้จะอธิบายไวยากรณ์ที่เป็นรูปธรรมซึ่งใช้กำหนดแพ็กเกจ

ตามคำจำกัดความ ทุกแพ็กเกจจะมีไฟล์ BUILD ซึ่งเป็นโปรแกรมสั้นๆ ระบบจะประเมินไฟล์ BUILD โดยใช้ภาษาที่จำเป็นต้องทำตามขั้นตอน Starlark

ระบบจะตีความไฟล์เหล่านี้เป็นรายการคำสั่งตามลำดับ

โดยทั่วไปแล้วลำดับมีความสำคัญ เช่น ตัวแปรต้องได้รับการกำหนดก่อนที่จะนำไปใช้ อย่างไรก็ตาม ไฟล์ BUILD ส่วนใหญ่ประกอบด้วยการประกาศกฎการสร้างเท่านั้น และลำดับสัมพัทธ์ของคำสั่งเหล่านี้ไม่มีความสำคัญ สิ่งสำคัญคือระบบประกาศกฎ ใด และมีค่าใดบ้างเมื่อการประเมินแพ็กเกจเสร็จสมบูรณ์

เมื่อมีการเรียกใช้ฟังก์ชันกฎการสร้าง เช่น cc_library ฟังก์ชันดังกล่าวจะสร้างเป้าหมายใหม่ในกราฟ ซึ่งสามารถอ้างอิงเป้าหมายนี้ได้ในภายหลังโดยใช้ป้ายกำกับ

ในไฟล์ BUILD อย่างง่าย คุณสามารถจัดลำดับการประกาศกฎใหม่ได้อย่างอิสระโดยไม่เปลี่ยนลักษณะการทำงาน

ไฟล์ BUILD จะต้องไม่มีคำจำกัดความของฟังก์ชัน คำสั่ง for หรือคำสั่ง if (แต่สามารถใช้การทำความเข้าใจรายการและนิพจน์ if ได้) เพื่อส่งเสริมการแยกโค้ดและข้อมูลออกจากกันอย่างชัดเจน คุณสามารถประกาศฟังก์ชันในไฟล์ .bzl แทนได้ นอกจากนี้ ระบบยังไม่อนุญาตให้อาร์กิวเมนต์ *args และ **kwargs อยู่ในไฟล์ BUILD แต่คุณควรระบุอาร์กิวเมนต์ทั้งหมดอย่างชัดเจน

สิ่งสำคัญคือโปรแกรมใน Starlark ไม่สามารถดำเนินการ I/O ที่กำหนดเองได้ ค่าคงที่นี้ทำให้การตีความไฟล์ BUILD เป็นแบบ hermetic ซึ่งขึ้นอยู่กับชุดอินพุตที่ทราบเท่านั้น ซึ่งจำเป็นอย่างยิ่งต่อการรับประกันว่าการสร้างจะทำซ้ำได้ ดูรายละเอียดเพิ่มเติมได้ที่ Hermeticity

คุณควรเขียนไฟล์ BUILD โดยใช้อักขระ ASCII เท่านั้น แม้ว่าในทางเทคนิคแล้วระบบจะตีความไฟล์เหล่านี้โดยใช้ชุดอักขระ Latin-1

เนื่องจากต้องอัปเดตไฟล์ BUILD ทุกครั้งที่ทรัพยากร Dependency ของโค้ดพื้นฐานมีการเปลี่ยนแปลง โดยปกติแล้วจะมีผู้ใช้หลายคนในทีมเป็นผู้ดูแลไฟล์เหล่านี้ ผู้เขียนไฟล์ BUILD ควรใส่ความคิดเห็นอย่างละเอียดเพื่ออธิบายบทบาทของเป้าหมายการสร้างแต่ละรายการ ไม่ว่าจะตั้งใจให้ใช้เป็นการสาธารณะหรือไม่ก็ตาม รวมถึงอธิบายบทบาทของแพ็กเกจเอง

การโหลดส่วนขยาย

ส่วนขยายของ Bazel คือไฟล์ที่ลงท้ายด้วย .bzl ใช้คำสั่ง load เพื่อนำเข้าสัญลักษณ์จากส่วนขยาย

load("//foo/bar:file.bzl", "some_library")

โค้ดนี้จะโหลดไฟล์ foo/bar/file.bzl และเพิ่มสัญลักษณ์ some_library ลงในสภาพแวดล้อม ซึ่งใช้โหลดกฎ ฟังก์ชัน หรือค่าคงที่ใหม่ (เช่น สตริงหรือรายการ) คุณสามารถนำเข้าสัญลักษณ์หลายรายการได้โดยใช้อาร์กิวเมนต์เพิ่มเติมในการเรียก load อาร์กิวเมนต์ต้องเป็นสตริงลิเทอรัล (ไม่มีตัวแปร) และคำสั่ง load ต้องปรากฏที่ระดับบนสุด โดยจะอยู่ในเนื้อหาของฟังก์ชันไม่ได้

อาร์กิวเมนต์แรกของ load คือ ป้ายกำกับที่ระบุไฟล์ .bzl หากเป็นป้ายกำกับสัมพัทธ์ ระบบจะแก้ปัญหาโดยอิงตามแพ็กเกจ (ไม่ใช่ไดเรกทอรี) ที่มีไฟล์ bzl ปัจจุบัน ป้ายกำกับสัมพัทธ์ในคำสั่ง load ควรใช้ : นำหน้า

load ยังรองรับนามแฝงด้วย คุณจึงกำหนดชื่อต่างๆ ให้กับสัญลักษณ์ที่นำเข้าได้

load("//foo/bar:file.bzl", library_alias = "some_library")

คุณกำหนดนามแฝงหลายรายการได้ภายในคำสั่ง load เดียว นอกจากนี้ รายการอาร์กิวเมนต์ยังสามารถมีทั้งนามแฝงและชื่อสัญลักษณ์ปกติ ตัวอย่างต่อไปนี้ถูกต้องตามกฎหมาย (โปรดสังเกตว่าควรใช้เครื่องหมายคำพูดเมื่อใด)

load(":my_rules.bzl", "some_rule", nice_alias = "some_other_rule")

ในไฟล์ .bzl ระบบจะไม่ส่งออกสัญลักษณ์ที่ขึ้นต้นด้วย _ และจะโหลดจากไฟล์อื่นไม่ได้

คุณสามารถใช้ การมองเห็นการโหลด เพื่อจำกัด ผู้ที่โหลดไฟล์ .bzl ได้

ประเภทของกฎการสร้าง

กฎการสร้างส่วนใหญ่มาเป็นชุด โดยจัดกลุ่มตามภาษา เช่น cc_binary, cc_library และ cc_test เป็นกฎการสร้างสำหรับไบนารี ไลบรารี และการทดสอบ C++ ตามลำดับ ภาษาอื่นๆ ใช้รูปแบบการตั้งชื่อเดียวกัน โดยมีคำนำหน้าต่างกัน เช่น java_* สำหรับ Java ฟังก์ชันบางอย่างเหล่านี้มีการอธิบายไว้ใน Build Encyclopedia แต่ทุกคนสามารถสร้างกฎใหม่ได้

• กฎ *_binary จะสร้างโปรแกรมที่เรียกใช้งานได้ในภาษาที่กำหนด หลังจากสร้างแล้ว โปรแกรมที่เรียกใช้งานได้จะอยู่ในแผนผังเอาต์พุตไบนารีของเครื่องมือสร้างที่ชื่อที่สอดคล้องกับป้ายกำกับของกฎ ดังนั้น //my:program จะปรากฏที่ (เช่น) $(BINDIR)/my/program

  ในบางภาษา กฎดังกล่าวจะสร้างไดเรกทอรี runfiles ซึ่งมีไฟล์ทั้งหมดที่ระบุไว้ในแอตทริบิวต์ data ที่เป็นของกฎ หรือกฎใดก็ตามในการปิดการเปลี่ยนผ่านของทรัพยากร Dependency โดยระบบจะรวบรวมชุดไฟล์นี้ไว้ในที่เดียวเพื่อให้ใช้งานจริงได้ง่าย

• กฎ *_test เป็นกฎ *_binary ที่มีความเฉพาะเจาะจงมากขึ้น ซึ่งใช้สำหรับการทดสอบอัตโนมัติ การทดสอบเป็นเพียงโปรแกรมที่แสดงผลเป็น 0 เมื่อสำเร็จ

  การทดสอบจะมีแผนผัง runfiles เช่นเดียวกับไบนารี และไฟล์ที่อยู่ใต้แผนผังนี้เป็นไฟล์เดียวที่การทดสอบสามารถเปิดได้อย่างถูกต้องตามกฎหมายในระหว่างรันไทม์ ตัวอย่างเช่น โปรแกรม cc_test(name='x', data=['//foo:bar']) อาจเปิดและอ่าน $TEST_SRCDIR/workspace/foo/bar ในระหว่างการดำเนินการ (ภาษาโปรแกรมแต่ละภาษาจะมีฟังก์ชันยูทิลิตีของตัวเองสำหรับการเข้าถึงค่าของ $TEST_SRCDIR แต่ฟังก์ชันทั้งหมดจะเทียบเท่ากับการใช้ตัวแปรสภาพแวดล้อมโดยตรง) หากไม่ปฏิบัติตามกฎ การทดสอบจะล้มเหลวเมื่อเรียกใช้ในโฮสต์การทดสอบระยะไกล

• กฎ *_library จะระบุโมดูลที่คอมไพล์แยกกันในภาษาโปรแกรมที่กำหนด ไลบรารีสามารถขึ้นอยู่กับไลบรารีอื่นๆ และไบนารีและการทดสอบสามารถขึ้นอยู่กับไลบรารีได้ โดยมีลักษณะการทำงานของการคอมไพล์แยกกันตามที่คาดไว้