คําจํากัดความที่พบบ่อย

รายงานปัญหา ดูแหล่งที่มา รุ่น Nightly · 7.4

ส่วนนี้จะอธิบายคำศัพท์และแนวคิดต่างๆ ที่เหมือนกับฟังก์ชันหลายรายการหรือกฎสร้างกฎ

เนื้อหา

• การแปลงข้อมูลเป็นโทเค็นของ Bourne Shell
• การขยายป้ายกำกับ
• แอตทริบิวต์ทั่วไปที่กฎการสร้างส่วนใหญ่กำหนด
• แอตทริบิวต์ที่พบบ่อยในกฎบิลด์ทั้งหมด
• แอตทริบิวต์ที่ใช้ร่วมกันในกฎทดสอบทั้งหมด (*_test)
• แอตทริบิวต์ที่ใช้ร่วมกันสำหรับกฎไบนารีทั้งหมด (*_binary)
• แอตทริบิวต์ที่กำหนดค่าได้
• เป้าหมายเอาต์พุตที่ไม่เจาะจง

การแปลงข้อมูลเป็นโทเค็นของ Bourne shell

แอตทริบิวต์สตริงบางอย่างของกฎบางข้อจะแบ่งออกเป็นหลายคำตามกฎการแยกออกเป็นโทเค็นของ Bourne Shell ดังนี้ เว้นวรรคที่ไม่ได้อยู่ในเครื่องหมายคำพูดจะคั่นคำต่างๆ และใช้อักขระเครื่องหมายคำพูดเดี่ยวและเครื่องหมายคำพูดคู่ รวมถึงแบ็กสแลชเพื่อป้องกันการแยกออกเป็นโทเค็น

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

แอตทริบิวต์ที่อยู่ภายใต้การขยายตัวแปร "Make" และการแปลงเป็นโทเค็นแบบ Bourne มักจะใช้เพื่อส่งตัวเลือกที่กำหนดเองไปยังคอมไพเลอร์และเครื่องมืออื่นๆ ตัวอย่างแอตทริบิวต์ดังกล่าว ได้แก่ cc_library.copts และ java_library.javacopts การใช้การแทนที่เหล่านี้ร่วมกันจะช่วยให้ตัวแปรสตริงเดี่ยวขยายลงในรายการคำตัวเลือกที่เฉพาะเจาะจงสำหรับการกำหนดค่าได้

การขยายป้ายกำกับ

แอตทริบิวต์สตริงบางรายการของกฎจำนวนน้อยมากจะขึ้นอยู่กับการขยายป้ายกำกับ: หากสตริงเหล่านั้นมีป้ายกำกับที่ถูกต้องเป็นสตริงย่อย เช่น //mypkg:target และป้ายกำกับนั้นเป็นข้อกําหนดเบื้องต้นที่ประกาศไว้ของกฎปัจจุบัน ระบบจะขยายป้ายกำกับนั้นให้เป็นเส้นทางของไฟล์ที่แสดงโดย target //mypkg:target

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

แอตทริบิวต์ทั่วไปที่กฎการสร้างส่วนใหญ่กำหนด

ส่วนนี้อธิบายแอตทริบิวต์ที่กฎการสร้างหลายข้อกำหนดไว้ แต่ไม่ใช่ทั้งหมด

แอตทริบิวต์	คำอธิบาย
data	รายการป้ายกํากับ ค่าเริ่มต้นคือ [] ไฟล์ที่จําเป็นสําหรับกฎนี้เมื่อรันไทม์ อาจแสดงไฟล์หรือเป้าหมายกฎ โดยทั่วไปแล้วอนุญาตให้ใช้เป้าหมายใดก็ได้ เอาต์พุตเริ่มต้นและไฟล์การเรียกใช้ของเป้าหมายในแอตทริบิวต์ data ควรปรากฏในพื้นที่ *.runfiles ของไฟล์ปฏิบัติการใดๆ ซึ่งเอาต์พุตโดยหรือมีทรัพยากร Dependency รันไทม์กับเป้าหมายนี้ ซึ่งอาจรวมถึงไฟล์ข้อมูลหรือไบนารีที่ใช้เมื่อมีการเรียกใช้ srcs ของเป้าหมายนี้ ดูข้อมูลเพิ่มเติมเกี่ยวกับวิธีใช้และพึ่งพาไฟล์ข้อมูลได้ในส่วนการพึ่งพาข้อมูล กฎใหม่ควรกำหนดแอตทริบิวต์ data หากประมวลผลอินพุตซึ่งอาจใช้อินพุตอื่นๆ ขณะรันไทม์ ฟังก์ชันการใช้งานของกฎต้องป้อนข้อมูลไฟล์เรียกใช้ของเป้าหมายจากเอาต์พุตและรันไฟล์ของแอตทริบิวต์ data รวมถึงรันไฟล์จากแอตทริบิวต์ทรัพยากร Dependency ที่มีซอร์สโค้ดหรือทรัพยากร Dependency อย่างใดอย่างหนึ่ง
deps	รายการป้ายกํากับ ค่าเริ่มต้นคือ [] ข้อมูลอ้างอิงสำหรับเป้าหมายนี้ โดยทั่วไปควรแสดงเฉพาะเป้าหมายของกฎเท่านั้น (แม้ว่ากฎบางข้อจะอนุญาตให้ไฟล์ปรากฏใน deps โดยตรง แต่ควรหลีกเลี่ยงเมื่อเป็นไปได้) โดยทั่วไป กฎเฉพาะภาษาจะจํากัดเป้าหมายที่แสดงไว้ให้ผู้ให้บริการที่เฉพาะเจาะจงเท่านั้น ความหมายที่แน่นอนของสิ่งที่เป็นเป้าหมายที่ขึ้นอยู่กับอีกเป้าหมายหนึ่งโดยใช้ deps จะเจาะจงตามประเภทของกฎ และเอกสารประกอบเฉพาะกฎจะอธิบายรายละเอียดเพิ่มเติม สำหรับกฎที่ประมวลผลซอร์สโค้ด โดยทั่วไปแล้ว deps จะระบุทรัพยากร Dependency ของโค้ดที่โค้ดใช้ใน srcs ส่วนใหญ่แล้ว Dependency deps จะใช้เพื่อให้โมดูลหนึ่งใช้สัญลักษณ์ที่กําหนดไว้ในโมดูลอื่นซึ่งเขียนด้วยภาษาโปรแกรมเดียวกันและคอมไพล์แยกต่างหากได้ นอกจากนี้ ระบบยังอนุญาตให้ใช้การพึ่งพาข้ามภาษาในหลายกรณี เช่น เป้าหมาย java_library อาจใช้โค้ด C++ ในเป้าหมาย cc_library โดยระบุเป้าหมายหลังในแอตทริบิวต์ deps ดูข้อมูลเพิ่มเติมได้ที่คำจำกัดความของทรัพยากร Dependencies
licenses	รายการสตริง nonconfigurable ค่าเริ่มต้นคือ ["none"] รายการสตริงประเภทใบอนุญาตที่จะใช้สำหรับเป้าหมายนี้ ซึ่งเป็นส่วนหนึ่งของ API การอนุญาตให้ใช้สิทธิที่เลิกใช้งานแล้วซึ่ง Bazel ไม่ได้ใช้งานแล้ว อย่าใช้
srcs	รายการป้ายกำกับ ค่าเริ่มต้นคือ [] ไฟล์ที่ประมวลผลหรือรวมไว้โดยกฎนี้ โดยทั่วไปจะแสดงไฟล์โดยตรง แต่อาจแสดงเป้าหมายของกฎ (เช่น filegroup หรือ genrule) เพื่อรวมเอาเอาต์พุตเริ่มต้นของกฎ กฎสำหรับภาษาใดภาษาหนึ่งมักกำหนดให้ไฟล์ที่ระบุมีส่วนขยายไฟล์ที่เฉพาะเจาะจง

แอตทริบิวต์ทั่วไปสำหรับกฎบิลด์ทั้งหมด

ส่วนนี้อธิบายแอตทริบิวต์ที่เพิ่มโดยนัยลงในกฎการสร้างทั้งหมด

แอตทริบิวต์	คำอธิบาย
compatible_with	รายการป้ายกำกับ; ไม่สามารถกำหนดค่าได้; ค่าเริ่มต้นคือ [] รายการสภาพแวดล้อมที่เป้าหมายนี้สร้างได้นอกเหนือจากสภาพแวดล้อมที่รองรับเริ่มต้น วิธีนี้เป็นส่วนหนึ่งของระบบข้อจำกัดของ Bazel ที่ช่วยให้ผู้ใช้ประกาศว่าเป้าหมายใดที่ทำได้และไม่ได้ เช่น ไบนารีที่ทำให้ใช้งานได้ภายนอกไม่ควรพึ่งพาไลบรารีที่มีรหัสลับของบริษัท ดูรายละเอียดได้ที่ ConstraintSemantics
deprecation	สตริง nonconfigurable ค่าเริ่มต้นคือ None ข้อความเตือนอธิบายที่เชื่อมโยงกับเป้าหมายนี้ ซึ่งโดยปกติแล้วจะใช้เพื่อแจ้งให้ผู้ใช้ทราบว่าเป้าหมายนั้นล้าสมัยแล้ว หรือมีการใช้กฎอื่นแทนที่แล้ว เป็นเรื่องส่วนตัวสำหรับแพ็กเกจ หรืออาจถือว่าเป็นอันตรายเนื่องด้วยเหตุผลบางอย่าง ควรใส่ข้อมูลอ้างอิง (เช่น หน้าเว็บ หมายเลขข้อบกพร่อง หรือตัวอย่าง CL สำหรับการย้ายข้อมูล) เพื่อให้ทราบถึงการเปลี่ยนแปลงที่จำเป็นสำหรับการหลีกเลี่ยงข้อความได้อย่างง่ายดาย หากมีเป้าหมายใหม่ที่สามารถใช้แทนแบบลดลงได้ ขอแนะนำให้ย้ายผู้ใช้ทั้งหมดของเป้าหมายเดิม แอตทริบิวต์นี้ไม่มีผลต่อวิธีสร้าง แต่อาจส่งผลต่อเอาต์พุตการวินิจฉัยของเครื่องมือสร้าง เครื่องมือสร้างจะออกคำเตือนเมื่อกฎที่มีแอตทริบิวต์ deprecation ขึ้นอยู่กับเป้าหมายในแพ็กเกจอื่น ไลบรารีภายในแพ็กเกจจะได้รับการยกเว้นจากคำเตือนนี้ เช่น การสร้างการทดสอบของกฎที่เลิกใช้งานจะไม่แสดงคำเตือน หากเป้าหมายที่เลิกใช้งานแล้วนั้นขึ้นอยู่กับเป้าหมายอื่นที่เลิกใช้งานแล้ว จะไม่มีการออกข้อความเตือน เมื่อผู้คนหยุดใช้เป้าหมายแล้ว คุณสามารถนำเป้าหมายออกได้
distribs	รายการสตริง ไม่สามารถกําหนดค่าได้ ค่าเริ่มต้นคือ [] รายการสตริงวิธีการเผยแพร่ที่จะใช้กับเป้าหมายนี้ ซึ่งเป็นส่วนหนึ่งของ API การอนุญาตให้ใช้สิทธิที่เลิกใช้งานแล้วซึ่ง Bazel ไม่ได้ใช้อีกต่อไป อย่าใช้งานสิ่งนี้
exec_compatible_with	รายการป้ายกำกับ nonconfigurable ค่าเริ่มต้นคือ [] รายการ constraint_values ที่ต้องมีในแพลตฟอร์มการดำเนินการสำหรับเป้าหมายนี้ ซึ่งจะเป็นส่วนเพิ่มเติมนอกเหนือจากข้อจำกัดใดๆ ที่ตั้งค่าไว้แล้วโดยประเภทของกฎ มีการใช้ข้อจำกัดเพื่อจำกัดรายการแพลตฟอร์มการดำเนินการที่ใช้ได้ โปรดดูรายละเอียดเพิ่มเติมที่คำอธิบายการแก้ไขชุดเครื่องมือ
exec_properties	พจนานุกรมของสตริง ค่าเริ่มต้นคือ {} พจนานุกรมสตริงที่จะเพิ่มลงใน exec_properties ของแพลตฟอร์มที่เลือกสําหรับเป้าหมายนี้ ดู exec_properties ของกฎแพลตฟอร์ม หากคีย์มีอยู่ในทั้งพร็อพเพอร์ตี้ระดับแพลตฟอร์มและระดับเป้าหมาย ระบบจะนำค่าจากเป้าหมาย
features	รายการสตริงฟีเจอร์ ค่าเริ่มต้นคือ [] ฟีเจอร์คือแท็กสตริงที่เปิดหรือปิดใช้ในเป้าหมายได้ ความหมายของฟีเจอร์จะขึ้นอยู่กับกฎนั้นๆ ระบบจะรวมแอตทริบิวต์ features นี้เข้ากับแอตทริบิวต์ features ระดับแพ็กเกจ ตัวอย่างเช่น หากเปิดใช้ฟีเจอร์ ["a", "b"] ในระดับแพ็กเกจ และแอตทริบิวต์ features ของเป้าหมายมี ["-a", "c"] ฟีเจอร์ที่เปิดใช้สำหรับกฎจะเป็น "b" และ "c" ดูตัวอย่าง
restricted_to	รายการป้ายกำกับ nonconfigurable ค่าเริ่มต้นคือ [] รายการสภาพแวดล้อมที่สามารถสร้างเป้าหมายนี้ได้แทนสภาพแวดล้อมที่รองรับโดยค่าเริ่มต้น ซึ่งเป็นส่วนหนึ่งของระบบข้อจำกัดของ Bazel ดูรายละเอียดได้ที่ compatible_with
tags	รายการสตริง ไม่สามารถกําหนดค่าได้ ค่าเริ่มต้นคือ [] แท็กสามารถใช้กับกฎใดก็ได้ แท็กในกฎการทดสอบและtest_suiteมีประโยชน์ในการจัดหมวดหมู่การทดสอบ แท็กในเป้าหมายที่ไม่ใช่การทดสอบใช้เพื่อควบคุมการดำเนินการของ genrule และ Starlark ที่ทำแซนด์บ็อกซ์ และสำหรับการแยกวิเคราะห์โดยมนุษย์และ/หรือเครื่องมือภายนอก Bazel แก้ไขลักษณะการทำงานของโค้ดแซนด์บ็อกซ์หากพบคีย์เวิร์ดต่อไปนี้ในแอตทริบิวต์ tags ของเป้าหมายการทดสอบหรือเป้าหมาย genrule หรือคีย์ execution_requirements สำหรับการดำเนินการของ Starlark คีย์เวิร์ด no-sandbox จะทำให้การดำเนินการหรือการทดสอบไม่อยู่ในแซนด์บ็อกซ์ การดำเนินการหรือทดสอบดังกล่าวจะยังคงแคชหรือทำงานจากระยะไกลได้ ใช้ no-cache หรือ no-remote เพื่อป้องกันการดําเนินการหรือการทดสอบดังกล่าว no-cache ผลลัพธ์ของคีย์เวิร์ดในการดําเนินการหรือการทดสอบจะไม่แคชไว้ (จากระยะไกลหรือในเครื่อง) คีย์เวิร์ด no-remote-cache ส่งผลให้การดำเนินการหรือการทดสอบไม่ได้รับการแคชจากระยะไกล (แต่อาจแคชไว้ในเครื่องและอาจดำเนินการจากระยะไกลได้) หมายเหตุ: สําหรับวัตถุประสงค์ของแท็กนี้ ระบบจะถือว่าแคชดิสก์เป็นแคชในเครื่อง ส่วนแคช http และ gRPC จะถือว่าอยู่ระยะไกล หากใช้แคชในดิสก์ในเครื่องและแคชระยะไกลร่วมกัน (แคชแบบรวม) ระบบจะถือว่าแคชดังกล่าวเป็นแคชระยะไกลและปิดใช้โดยสมบูรณ์ เว้นแต่จะมีการตั้งค่า --incompatible_remote_results_ignore_disk ซึ่งในกรณีนี้ระบบจะใช้คอมโพเนนต์ในเครื่อง คีย์เวิร์ด no-remote-exec ทําให้การดำเนินการหรือการทดสอบไม่ทํางานจากระยะไกล (แต่อาจแคชไว้จากระยะไกล) คีย์เวิร์ด no-remote ป้องกันไม่ให้ดำเนินการหรือทดสอบจากระยะไกลหรือแคชจากระยะไกล ซึ่งเทียบเท่ากับการใช้ทั้ง no-remote-cache และ no-remote-exec คีย์เวิร์ด no-remote-cache-upload ปิดใช้การอัปโหลดส่วนหนึ่งของแคชระยะไกลของการเกิด แต่จะไม่ปิดใช้การดำเนินการระยะไกล คีย์เวิร์ด local จะป้องกันไม่ให้การดำเนินการหรือการทดสอบถูกแคชไว้จากระยะไกล ดำเนินการจากระยะไกล หรือเรียกใช้ภายในแซนด์บ็อกซ์ สำหรับ Genrules และการทดสอบ การทำเครื่องหมายกฎด้วยแอตทริบิวต์ local = True จะมีผลเท่ากัน คีย์เวิร์ด requires-network อนุญาตให้เข้าถึงเครือข่ายภายนอกจากภายในแซนด์บ็อกซ์ แท็กนี้จะมีผลก็ต่อเมื่อเปิดใช้แซนด์บ็อกซ์ คีย์เวิร์ด block-network บล็อกการเข้าถึงเครือข่ายภายนอกจากภายในแซนด์บ็อกซ์ ในกรณีนี้ ระบบจะอนุญาตเฉพาะการสื่อสารกับ localhost เท่านั้น แท็กนี้จะมีผลก็ต่อเมื่อเปิดใช้แซนด์บ็อกซ์เท่านั้น requires-fakeroot เรียกใช้การทดสอบหรือการดำเนินการเป็น uid และ gid 0 (ผู้ใช้ระดับรูท) ฟีเจอร์นี้รองรับเฉพาะใน Linux แท็กนี้จะมีลำดับความสำคัญเหนือตัวเลือกบรรทัดคำสั่ง --sandbox_fake_username โดยทั่วไปแล้ว แท็กในการทดสอบจะใช้เพื่ออธิบายบทบาทของการทดสอบในกระบวนการแก้ไขข้อบกพร่องและการเผยแพร่ โดยปกติแล้ว แท็กจะมีประโยชน์มากที่สุดสำหรับการทดสอบ C++ และ Python ซึ่งไม่มีความสามารถของคำอธิบายประกอบรันไทม์ การใช้แท็กและองค์ประกอบขนาดช่วยให้คุณประกอบชุดทดสอบตามนโยบายการเช็คอินโค้ดเบสได้อย่างยืดหยุ่น Bazel จะแก้ไขลักษณะการทํางานของการทดสอบหากพบคีย์เวิร์ดต่อไปนี้ในแอตทริบิวต์ tags ของกฎการทดสอบ exclusive จะบังคับให้ทำการทดสอบในโหมด "พิเศษ" เพื่อให้ไม่มีการทดสอบอื่นทำงานอยู่ในเวลาเดียวกัน การทดสอบดังกล่าวจะดำเนินการแบบต่อเนื่องหลังจากที่กิจกรรมบิลด์ทั้งหมดและการทดสอบที่ไม่เฉพาะตัวเสร็จสมบูรณ์แล้ว ระบบได้ปิดใช้การดำเนินการระยะไกลสำหรับการทดสอบดังกล่าวเนื่องจาก Bazel ควบคุมสิ่งที่ทำงานอยู่ในเครื่องระยะไกลไม่ได้ exclusive-if-local จะบังคับให้เรียกใช้การทดสอบในโหมด "พิเศษ" หากเรียกใช้จากเครื่อง แต่จะใช้การทดสอบแบบขนานหากเรียกใช้จากระยะไกล คีย์เวิร์ด manual จะยกเว้นเป้าหมายจากการขยายไวลด์การ์ดรูปแบบเป้าหมาย (..., :*, :all ฯลฯ) และกฎ test_suite ที่ไม่ได้แสดงการทดสอบไว้อย่างชัดแจ้งเมื่อคำนวณชุดของเป้าหมายระดับบนสุดเพื่อสร้าง/เรียกใช้สำหรับคำสั่ง build, test และ coverage แต่จะไม่ได้ส่งผลต่อไวลด์การ์ดเป้าหมายหรือการขยายชุดทดสอบในบริบทอื่นๆ รวมถึงคำสั่ง query โปรดทราบว่า manual ไม่ได้บอกเป็นนัยว่าระบบการสร้าง/ทดสอบอย่างต่อเนื่องไม่ควรสร้าง/เรียกใช้เป้าหมายโดยอัตโนมัติ เช่น ควรยกเว้นเป้าหมายจาก bazel test ... เนื่องจากต้องใช้แฟล็ก Bazel ที่เฉพาะเจาะจง แต่ยังคงรวมเป้าหมายดังกล่าวไว้ในการส่งล่วงหน้าหรือการทดสอบอย่างต่อเนื่องที่กำหนดค่าไว้อย่างเหมาะสม คีย์เวิร์ด external คำจะบังคับให้ดำเนินการทดสอบโดยไม่มีเงื่อนไข (โดยไม่คำนึงถึงค่า --cache_test_results) ดูรูปแบบเพิ่มเติมเกี่ยวกับแท็กที่แนบกับเป้าหมายการทดสอบได้ที่รูปแบบแท็กในสารานุกรมการทดสอบ
target_compatible_with	รายการป้ายกํากับ ค่าเริ่มต้นคือ [] รายการ constraint_value ที่ต้องมีอยู่ในแพลตฟอร์มเป้าหมายเพื่อให้ระบบพิจารณาเป้าหมายนี้เข้ากันได้ ข้อจำกัดนี้เพิ่มเติมนอกเหนือจากข้อจำกัดใดๆ ที่กำหนดไว้แล้วโดยประเภทกฎ หากแพลตฟอร์มเป้าหมายไม่เป็นไปตามข้อจำกัดที่ระบุไว้ทั้งหมด ระบบจะถือว่าเป้าหมายใช้ร่วมกันไม่ได้ ระบบจะข้ามเป้าหมายที่เข้ากันไม่ได้สำหรับการสร้างและการทดสอบเมื่อขยายรูปแบบเป้าหมาย (เช่น //..., :all) เมื่อระบุเป้าหมายอย่างชัดเจนในบรรทัดคำสั่ง เป้าหมายที่เข้ากันไม่ได้จะทำให้ Bazel แสดงข้อผิดพลาดและทำให้การสร้างหรือการทดสอบไม่สำเร็จ ส่วนเป้าหมายที่ขึ้นอยู่กับเป้าหมายที่ใช้ร่วมกันไม่ได้จะถือว่าเข้ากันไม่ได้ นอกจากนี้ยังข้ามขั้นตอนดังกล่าวสําหรับการสร้างและการทดสอบด้วย รายการที่ว่างเปล่า (ซึ่งเป็นค่าเริ่มต้น) หมายถึงเป้าหมายที่เข้ากันได้กับทุกแพลตฟอร์ม กฎทั้งหมดที่ไม่ใช่กฎ Workspace จะรองรับแอตทริบิวต์นี้ แอตทริบิวต์นี้จะไม่มีผลในบางกฎ ตัวอย่างเช่น การระบุ target_compatible_with สำหรับ cc_toolchain จะไม่มีประโยชน์ ดูข้อมูลเพิ่มเติมเกี่ยวกับการข้ามเป้าหมายที่เข้ากันไม่ได้ได้ที่หน้าแพลตฟอร์ม
testonly	บูลีน ไม่สามารถกําหนดค่าได้ ค่าเริ่มต้นคือ False ยกเว้นเป้าหมายการทดสอบและชุดทดสอบ หากเป็น True จะมีเพียงเป้าหมายทดสอบเท่านั้น (เช่น การทดสอบ) ที่สามารถใช้เป้าหมายนี้ได้ ในทำนองเดียวกัน กฎที่ไม่ใช่ testonly จะไม่ได้รับอนุญาตให้ขึ้นอยู่กับกฎที่เป็น testonly การทดสอบ (กฎ *_test) และชุดทดสอบ (กฎ test_suite) จะเป็น testonly โดยค่าเริ่มต้น แอตทริบิวต์นี้มีไว้เพื่อระบุว่าเป้าหมายไม่ควรอยู่ในไบนารีที่เผยแพร่ไปยังเวอร์ชันที่ใช้งานจริง เนื่องจากมีการบังคับใช้ Testonly ในเวลาบิลด์ ไม่ใช่เวลาที่ทำงานอยู่ และแพร่กระจายผ่านแผนผัง Dependency ได้แบบเสมือนจริง คุณจึงควรใช้วิธีนี้อย่างรอบคอบ ตัวอย่างเช่น สแต็บและข้อมูลจำลองที่มีประโยชน์สำหรับการทดสอบหน่วยอาจมีประโยชน์สำหรับการทดสอบการผสานรวมที่เกี่ยวข้องกับไบนารีเดียวกันที่จะเผยแพร่ไปยังเวอร์ชันที่ใช้งานจริงด้วย ดังนั้นจึงไม่ควรทําเครื่องหมายเป็น testonly ในทางกลับกัน กฎที่เป็นอันตรายต่อลิงก์ อาจเป็นเพราะมีการลบล้างลักษณะการทำงานปกติโดยไม่มีเงื่อนไข ควรทำเครื่องหมายเป็น testonly
toolchains	รายการป้ายกำกับ; ไม่สามารถกำหนดค่าได้ ค่าเริ่มต้นคือ [] ชุดของเป้าหมายที่สร้างตัวแปรเป้าหมายนี้ สามารถเข้าถึงได้ เป้าหมายเหล่านี้คืออินสแตนซ์ของกฎที่ให้ TemplateVariableInfo หรือเป้าหมายพิเศษสำหรับประเภทเครื่องมือที่อยู่ใน Bazel ซึ่งรวมถึง @bazel_tools//tools/cpp:current_cc_toolchain @bazel_tools//tools/jdk:current_java_runtime โปรดทราบว่าค่านี้แตกต่างจากแนวคิดความละเอียดของ Toolchain ที่ใช้โดยการใช้กฎสำหรับการกำหนดค่าตามแพลตฟอร์ม คุณไม่สามารถใช้แอตทริบิวต์นี้เพื่อระบุ cc_toolchain หรือ java_toolchain ที่เฉพาะเจาะจงซึ่งเป้าหมายจะใช้
visibility	รายการป้ายกํากับ ไม่สามารถกําหนดค่าได้ ค่าเริ่มต้นคือ default_visibility จาก package หากระบุไว้ หรือ "//visibility:private" ในกรณีอื่น แอตทริบิวต์ visibility ในเป้าหมายควบคุมว่าจะใช้เป้าหมายในแพ็กเกจอื่นๆ ได้หรือไม่ ดูระดับการเข้าถึงในเอกสารประกอบ

แอตทริบิวต์ที่ใช้ร่วมกันกับกฎทดสอบทั้งหมด (*_test)

ส่วนนี้อธิบายแอตทริบิวต์ที่ใช้ร่วมกันกับกฎการทดสอบทั้งหมด

แอตทริบิวต์	คำอธิบาย
args	รายการสตริง ขึ้นอยู่กับการแทนที่ $(location) และ "Make variable" รวมถึง การแยกสตริงคำสั่ง Bourne Shell ค่าเริ่มต้นคือ [] อาร์กิวเมนต์บรรทัดคำสั่งที่ Bazel ส่งไปยังเป้าหมายเมื่อเรียกใช้ด้วย bazel test ระบบจะส่งอาร์กิวเมนต์เหล่านี้ก่อนค่า --test_arg ที่ระบุไว้ในบรรทัดคำสั่ง bazel test
env	พจนานุกรมสตริง ค่าจะขึ้นอยู่กับการแทนที่ $(location) และ "Make variable" ค่าเริ่มต้นคือ [] ระบุตัวแปรสภาพแวดล้อมเพิ่มเติมที่จะตั้งค่าเมื่อทำการทดสอบโดย bazel test แอตทริบิวต์นี้ใช้กับกฎเนทีฟเท่านั้น เช่น cc_test, py_test และ sh_test แต่จะไม่มีผลกับกฎการทดสอบที่ Starlark กำหนด สําหรับกฎ Starlark ของคุณเอง คุณสามารถเพิ่มแอตทริบิวต์ "env" และใช้เพื่อป้อนข้อมูลผู้ให้บริการ TestEnvironment ได้
env_inherit	รายการสตริง ค่าเริ่มต้นคือ [] ระบุตัวแปรสภาพแวดล้อมเพิ่มเติมที่จะรับค่าจากสภาพแวดล้อมภายนอกเมื่อ bazel test ทำการทดสอบ แอตทริบิวต์นี้ใช้กับกฎเนทีฟเท่านั้น เช่น cc_test, py_test และ sh_test แต่จะไม่มีผลกับกฎการทดสอบที่ Starlark กำหนด
size	สตริง "enormous", "large", "medium" หรือ "small" nonconfigurable ค่าเริ่มต้นคือ "medium" ระบุ "ความหนัก" ของเป้าหมายการทดสอบ นั่นคือ เวลา/ทรัพยากรที่ต้องใช้ในการเรียกใช้ การทดสอบ 1 หน่วยถือเป็นการทดสอบ "เล็ก" การทดสอบการผสานรวม "ปานกลาง" และการทดสอบจากต้นทางถึงปลายทาง "ใหญ่" หรือ "ใหญ่" Bazel ใช้ขนาดเพื่อกำหนดการหมดเวลาเริ่มต้น ซึ่งสามารถลบล้างได้โดยใช้แอตทริบิวต์ timeout การหมดเวลาจะมีผลกับการทดสอบทั้งหมดในเป้าหมาย BUILD ไม่ใช่การทดสอบแต่ละรายการ เมื่อทำการทดสอบในเครื่อง size จะใช้เพื่อวัตถุประสงค์ในการกำหนดเวลาเพิ่มเติมด้วย โดย Bazel จะพยายามปฏิบัติตาม --local_{ram,cpu}_resources และไม่ให้เครื่องทำงานหนักเกินไปด้วยการเรียกใช้การทดสอบที่หนักหน่วงหลายรายการพร้อมกัน ขนาดการทดสอบสอดคล้องกับการหมดเวลาเริ่มต้นและการคาดการณ์การใช้ทรัพยากรในเครื่องสูงสุดต่อไปนี้ ขนาด RAM (เป็น MB) CPU (ในแกน CPU) ระยะหมดเวลาเริ่มต้น เล็ก 20 1 สั้น (1 นาที) ปานกลาง 100 1 ปานกลาง (5 นาที) ใหญ่ 300 1 ยาว (15 นาที) มหึมา 800 1 ถาวร (60 นาที) ระบบจะกำหนดตัวแปรสภาพแวดล้อม TEST_SIZE เป็นค่าของแอตทริบิวต์นี้เมื่อสร้างการทดสอบ
timeout	สตริง "short", "moderate", "long" หรือ "eternal" nonconfigurable ค่าเริ่มต้นมาจากแอตทริบิวต์ size ของการทดสอบ ระยะเวลาที่คาดว่าจะเรียกใช้การทดสอบก่อนที่จะกลับ แม้ว่าแอตทริบิวต์ขนาดของการทดสอบจะควบคุมการประมาณทรัพยากร แต่อาจตั้งค่าระยะหมดเวลาของการทดสอบแยกกัน หากไม่ได้ระบุไว้อย่างชัดเจน ระบบจะกำหนดเวลาหมดอายุตามขนาดของการทดสอบ คุณลบล้างการหมดเวลาการทดสอบได้ด้วย Flag --test_timeout เช่น สำหรับการทํางานภายใต้เงื่อนไขบางอย่างที่ทราบว่าทํางานช้า ทดสอบค่าระยะหมดเวลาที่สอดคล้องกับระยะเวลาต่อไปนี้ ค่าระยะหมดเวลา ระยะเวลา วิดีโอสั้น 1 นาที ปานกลาง 5 นาที ยาว 15 นาที นิรันดร์ 60 นาที สำหรับเวลานอกเหนือจากที่กล่าวมาข้างต้น คุณจะลบล้างการหมดเวลาของการทดสอบได้ด้วยแฟล็ก Bazel ของ --test_timeout เช่น สำหรับการทำงานด้วยตนเองภายใต้เงื่อนไขที่ทราบแล้วว่าทำงานช้า ค่า --test_timeout จะมีหน่วยเป็นวินาที ตัวอย่างเช่น --test_timeout=120 จะตั้งระยะหมดเวลาทดสอบเป็น 2 นาที ระบบจะตั้งค่าตัวแปรสภาพแวดล้อม TEST_TIMEOUT เป็นระยะหมดเวลาการทดสอบ (เป็นวินาที) เมื่อสร้างการทดสอบ
flaky	บูลีน ไม่สามารถกําหนดค่าได้ ค่าเริ่มต้นคือ False ทำเครื่องหมายการทดสอบว่าไม่น่าเชื่อถือ หากตั้งค่าไว้ จะดำเนินการทดสอบสูงสุด 3 ครั้ง โดยทำเครื่องหมายว่าล้มเหลวเฉพาะกรณีที่ล้มเหลวในแต่ละครั้ง โดยค่าเริ่มต้น แอตทริบิวต์นี้จะตั้งค่าเป็น False และการทดสอบจะทําเพียงครั้งเดียว โปรดทราบว่าเราไม่แนะนำให้ใช้แอตทริบิวต์นี้ โดยการทดสอบควรผ่านการทดสอบอย่างถูกต้องเมื่อยืนยันการยืนยันแล้ว
shard_count	จํานวนเต็มที่ไม่ติดลบซึ่งน้อยกว่าหรือเท่ากับ 50 ค่าเริ่มต้นคือ -1 ระบุจํานวนชาร์ดแบบขนานที่จะใช้เพื่อเรียกใช้การทดสอบ หากมีการตั้งค่า ค่านี้จะลบล้างการเรียนรู้ใดก็ตามที่ใช้เพื่อกำหนดจำนวนชาร์ดคู่ขนานที่จะทำการทดสอบ โปรดทราบว่ากฎทดสอบบางกฎอาจต้องเปิดใช้พารามิเตอร์นี้เพื่อเปิดใช้ชาร์ดดิ้งตั้งแต่แรก โปรดดู --test_sharding_strategy ด้วย หากเปิดใช้ชาร์ดดิ้งทดสอบ ระบบจะตั้งค่าตัวแปรสภาพแวดล้อม TEST_TOTAL_SHARDS เป็นค่านี้เมื่อสร้างการทดสอบ ชาร์ดดิ้งต้องใช้ตัวดำเนินการทดสอบเพื่อรองรับโปรโตคอลการชาร์ดทดสอบ หากไม่มี เป็นไปได้ว่าระบบจะทำการทดสอบทุกรายการในทุกกลุ่ม ซึ่งไม่ใช่สิ่งที่คุณต้องการ ดูรายละเอียดการแยกกลุ่มได้ที่หัวข้อการแยกกลุ่มการทดสอบในสารานุกรมการทดสอบ
local	บูลีน nonconfigurable ค่าเริ่มต้นคือ False บังคับให้เรียกใช้การทดสอบในเครื่องโดยไม่ต้องใช้แซนด์บ็อกซ์ การตั้งค่านี้เป็น "จริง" เทียบเท่ากับการระบุ "ท้องถิ่น" เป็นแท็ก (tags=["local"])

แอตทริบิวต์ทั่วไปสำหรับกฎไบนารีทั้งหมด (*_binary)

ส่วนนี้จะอธิบายแอตทริบิวต์ทั่วไปในกฎไบนารีทั้งหมด

แอตทริบิวต์	คำอธิบาย
args	รายการสตริง ขึ้นอยู่กับการแทนที่ $(location) และ "Make variable" และ การแยกสตริงของ Bourne Shell ไม่สามารถกำหนดค่าได้ โดยค่าเริ่มต้นคือ [] อาร์กิวเมนต์บรรทัดคำสั่งที่ Bazel จะส่งไปยังเป้าหมายเมื่อมีการเรียกใช้ ไม่ว่าจะด้วยคำสั่ง run หรือเป็นการทดสอบ ระบบจะส่งอาร์กิวเมนต์เหล่านี้ก่อนอาร์กิวเมนต์ที่ระบุไว้ในบรรทัดคำสั่ง bazel run หรือ bazel test หมายเหตุ: ระบบจะไม่ส่งอาร์กิวเมนต์เมื่อคุณเรียกใช้เป้าหมายนอก Bazel (เช่น การเรียกใช้ไบนารีใน bazel-bin/ ด้วยตนเอง)
env	พจนานุกรมของสตริง ค่าจะขึ้นอยู่กับการใช้แทน $(location) และ "Makeตัวแปร" ค่าเริ่มต้นคือ {} ระบุตัวแปรสภาพแวดล้อมเพิ่มเติมที่จะตั้งค่าเมื่อ bazel run เรียกใช้เป้าหมาย แอตทริบิวต์นี้ใช้กับกฎแบบเนทีฟเท่านั้น เช่น cc_binary, py_binary และ sh_binary แต่จะมีผลกับกฎที่เรียกใช้ได้ซึ่ง Starlark กำหนด หมายเหตุ: ระบบจะไม่ตั้งค่าตัวแปรสภาพแวดล้อมเมื่อคุณเรียกใช้เป้าหมายนอก Bazel (เช่น โดยการเรียกใช้ไบนารีใน bazel-bin/ ด้วยตนเอง)
output_licenses	รายการสตริง ค่าเริ่มต้นคือ [] ใบอนุญาตของไฟล์เอาต์พุตที่ไบนารีนี้สร้างขึ้น ซึ่งเป็นส่วนหนึ่งของ API การอนุญาตให้ใช้สิทธิที่เลิกใช้งานแล้วซึ่ง Bazel ไม่ได้ใช้อีกต่อไป อย่าใช้

แอตทริบิวต์ที่กำหนดค่าได้

แอตทริบิวต์ส่วนใหญ่ "กําหนดค่าได้" ซึ่งหมายความว่าค่าของแอตทริบิวต์อาจเปลี่ยนแปลงเมื่อสร้างเป้าหมายด้วยวิธีอื่น กล่าวโดยละเอียดคือ แอตทริบิวต์ที่กำหนดค่าได้อาจแตกต่างกันไปตาม Flag ที่ส่งไปยังบรรทัดคำสั่ง Bazel หรือสิ่งที่เป็น Dependency ดาวน์สตรีมกำลังขอเป้าหมาย ซึ่งอาจใช้เพื่อปรับแต่งเป้าหมายสำหรับแพลตฟอร์มต่างๆ หรือโหมดคอมไพล์

ตัวอย่างต่อไปนี้จะประกาศแหล่งที่มาที่แตกต่างกันสำหรับสถาปัตยกรรมเป้าหมายที่แตกต่างกัน การใช้ bazel build :multiplatform_lib --cpu x86 จะสร้างเป้าหมายโดยใช้ x86_impl.cc ส่วนการใช้ --cpu arm แทนจะทำให้ใช้ arm_impl.cc แทน

cc_library(
    name = "multiplatform_lib",
    srcs = select({
        ":x86_mode": ["x86_impl.cc"],
        ":arm_mode": ["arm_impl.cc"]
    })
)
config_setting(
    name = "x86_mode",
    values = { "cpu": "x86" }
)
config_setting(
    name = "arm_mode",
    values = { "cpu": "arm" }
)

ฟังก์ชัน select() จะเลือกค่าทางเลือกต่างๆ สําหรับแอตทริบิวต์ที่กำหนดค่าได้ โดยอิงตามเกณฑ์ config_setting หรือ constraint_value ที่กำหนดค่าเป้าหมายได้

Bazel จะประเมินแอตทริบิวต์ที่กำหนดค่าได้หลังจากประมวลผลมาโครและก่อนประมวลผลกฎ (ในทางเทคนิคคือระหว่างระยะการโหลดและการวิเคราะห์) การประมวลผลก่อนการประเมิน select() จะไม่ทราบว่า select() จะเลือกสาขาใด ตัวอย่างเช่น มาโครจะเปลี่ยนลักษณะการทำงานตามสาขาที่เลือกไม่ได้ และbazel queryจะเดาอย่างถี่ถ้วนเกี่ยวกับข้อกำหนดที่พารามิเตอร์เป้าหมายกำหนดได้เท่านั้น ดูข้อมูลเพิ่มเติมเกี่ยวกับการใช้ select() กับกฎและมาโครได้ในคำถามที่พบบ่อยนี้

แอตทริบิวต์ที่มีเครื่องหมาย nonconfigurable ในเอกสารประกอบจะใช้ฟีเจอร์นี้ไม่ได้ โดยทั่วไปแอตทริบิวต์จะกำหนดค่าไม่ได้เนื่องจาก Bazel ต้องการทราบค่าภายในก่อนที่จะระบุวิธีแก้ไข select() ได้

ดูภาพรวมโดยละเอียดได้ที่ แอตทริบิวต์บิลด์ที่กำหนดค่าได้

เป้าหมายเอาต์พุตโดยนัย

เลิกใช้งานเอาต์พุตโดยนัยใน C++ แล้ว โปรดอย่าใช้ไฟล์นี้ในภาษาอื่นหากเป็นไปได้ เรายังไม่มีเส้นทางการเลิกใช้งาน แต่ในที่สุดเราก็จะเลิกใช้งานเช่นเดียวกัน

เมื่อคุณกำหนดกฎการสร้างในไฟล์ BUILD แสดงว่าคุณกําลังประกาศเป้าหมายกฎที่มีชื่อใหม่ในแพ็กเกจอย่างชัดเจน ฟังก์ชันของกฎบิลด์หลายรายการยังโดยปริยายจะมีเป้าหมายไฟล์เอาต์พุตอย่างน้อย 1 รายการ ซึ่งมีเนื้อหาและความหมายเฉพาะเจาะจงตามกฎ เช่น เมื่อประกาศกฎ java_binary(name='foo', ...) อย่างชัดแจ้ง แสดงว่าคุณประกาศไฟล์เอาต์พุต foo_deploy.jar เป้าหมายโดยปริยายเป็นสมาชิกของแพ็กเกจเดียวกันด้วย (เป้าหมายเฉพาะนี้เป็นที่เก็บถาวรของ Java ที่ทำงานในตัวเองซึ่งเหมาะสำหรับการทำให้ใช้งานได้)

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

สำหรับกฎบิลด์แต่ละประเภท เอกสารประกอบของกฎจะมีส่วนพิเศษที่มีรายละเอียดชื่อและเนื้อหาของเอาต์พุตโดยนัยที่เกิดจากการประกาศกฎประเภทนั้น

ข้อแตกต่างที่สำคัญแต่ค่อนข้างละเอียดระหว่างเนมสเปซ 2 รายการที่ระบบบิลด์ใช้คือ ป้ายกำกับจะระบุเป้าหมาย ซึ่งอาจเป็นกฎหรือไฟล์ และเป้าหมายไฟล์อาจแบ่งออกเป็นเป้าหมายไฟล์ต้นทาง (หรืออินพุต) และเป้าหมายไฟล์ที่ดึงข้อมูล (หรือเอาต์พุต) สิ่งที่คุณจะพูดถึงในไฟล์ BUILD, สร้างจากบรรทัดคำสั่ง หรือตรวจสอบโดยใช้ bazel query ได้ก็คือเนมสเปซเป้าหมาย เป้าหมายไฟล์แต่ละรายการสอดคล้องกับไฟล์จริง 1 ไฟล์ในดิสก์ ("เนมสเปซของระบบไฟล์") โดยเป้าหมายกฎแต่ละข้ออาจสอดคล้องกับไฟล์จริง 0 หรืออย่างน้อย 1 ไฟล์ในดิสก์ อาจมีไฟล์ในดิสก์ที่ไม่มีเป้าหมายที่เกี่ยวข้อง ตัวอย่างเช่น ไฟล์ออบเจ็กต์ .o ที่สร้างขึ้นระหว่างการคอมไพล์ C++ จะอ้างอิงจากภายในไฟล์ BUILD หรือจากบรรทัดคำสั่งไม่ได้ วิธีนี้ทำให้เครื่องมือสร้างอาจซ่อนรายละเอียดการใช้งานบางอย่างเกี่ยวกับวิธีทํางาน ซึ่งอธิบายโดยละเอียดเพิ่มเติมในการอ้างอิงแนวคิดของ BUILD