ดูข้อกําหนดทั้งหมดของ Build Event Protocol ได้ในคําจํากัดความของบัฟเฟอร์โปรโตคอล อย่างไรก็ตาม การสร้างสัญชาตญาณบางอย่าง ก่อนจะดูข้อกำหนด
ลองใช้พื้นที่ทำงาน Bazel แบบง่ายที่ประกอบด้วยสคริปต์ Shell ว่าง 2 สคริปต์ foo.sh
และ foo_test.sh
และไฟล์ BUILD
ต่อไปนี้
sh_library(
name = "foo_lib",
srcs = ["foo.sh"],
)
sh_test(
name = "foo_test",
srcs = ["foo_test.sh"],
deps = [":foo_lib"],
)
เมื่อเรียกใช้ bazel test ...
ในโปรเจ็กต์นี้ กราฟบิลด์ของเหตุการณ์บิลด์ที่สร้างขึ้นจะคล้ายกับกราฟด้านล่าง รูปลูกศรแสดงความสัมพันธ์หลักและย่อยที่กล่าวถึงข้างต้น โปรดทราบว่าบางเหตุการณ์บิลด์และช่องส่วนใหญ่ถูกตัดออกเพื่อความสั้นกระชับ
รูปที่ 1 กราฟ BEP
ในขั้นต้น ระบบจะเผยแพร่เหตุการณ์ BuildStarted
เหตุการณ์แจ้งให้เราทราบว่ามีการเรียกใช้บิลด์ผ่านคำสั่ง bazel test
และประกาศเหตุการณ์ย่อย ดังนี้
OptionsParsed
WorkspaceStatus
CommandLine
UnstructuredCommandLine
BuildMetadata
BuildFinished
PatternExpanded
Progress
เหตุการณ์ 3 รายการแรกให้ข้อมูลเกี่ยวกับวิธีเรียกใช้ Bazel
เหตุการณ์การสร้าง PatternExpanded
ให้ข้อมูลเชิงลึกเกี่ยวกับเป้าหมายที่เฉพาะเจาะจงซึ่งรูปแบบ ...
ขยายไปถึง //foo:foo_lib
และ //foo:foo_test
โดยประกาศเหตุการณ์ TargetConfigured
2 รายการเป็นเหตุการณ์ย่อย โปรดทราบว่าเหตุการณ์ TargetConfigured
จะประกาศเหตุการณ์ Configuration
ว่าเป็นกิจกรรมย่อย แม้ว่า Configuration
จะโพสต์ก่อนเหตุการณ์ TargetConfigured
ก็ตาม
นอกจากความสัมพันธ์ระดับบนสุดและย่อยแล้ว เหตุการณ์ยังอาจอ้างอิงกันและกันโดยใช้ตัวระบุเหตุการณ์บิลด์ด้วย เช่น ในกราฟด้านบน เหตุการณ์ TargetComplete
หมายถึงเหตุการณ์ NamedSetOfFiles
ในช่อง fileSets
เหตุการณ์การสร้างที่อ้างอิงถึงไฟล์มักจะไม่ได้ฝังชื่อและเส้นทางของไฟล์ไว้ในเหตุการณ์ แต่จะมีตัวระบุเหตุการณ์บิลด์ของเหตุการณ์ NamedSetOfFiles
ซึ่งจะมีชื่อไฟล์และเส้นทางจริงด้วย เหตุการณ์ NamedSetOfFiles
ช่วยให้รายงานชุดไฟล์ได้เพียงครั้งเดียวและมีการอ้างอิงโดยเป้าหมายหลายรายการ โครงสร้างนี้มีความจําเป็น เนื่องจากในบางกรณี ขนาดเอาต์พุตของโปรโตคอลกิจกรรมบิลด์จะเพิ่มขึ้นตามจํานวนไฟล์ เหตุการณ์ NamedSetOfFiles
อาจไม่ได้ฝังไฟล์ทั้งหมด แต่อ้างอิงเหตุการณ์ NamedSetOfFiles
อื่นๆ ผ่านตัวระบุเหตุการณ์ของบิลด์แทน
ด้านล่างนี้คืออินสแตนซ์ของเหตุการณ์ TargetComplete
สําหรับเป้าหมาย //foo:foo_lib
จากกราฟด้านบน ซึ่งแสดงในรูปแบบ JSON ของบัฟเฟอร์โปรโตคอล
ตัวระบุเหตุการณ์บิลด์มีเป้าหมายเป็นสตริงที่คลุมเครือและอ้างถึงเหตุการณ์ Configuration
โดยใช้ตัวระบุเหตุการณ์บิลด์ เหตุการณ์ไม่ได้ประกาศเหตุการณ์ย่อยใดๆ เพย์โหลดมีข้อมูลว่าสร้างเป้าหมายสำเร็จหรือไม่ ชุดไฟล์เอาต์พุต และประเภทเป้าหมายที่สร้างขึ้น
{
"id": {
"targetCompleted": {
"label": "//foo:foo_lib",
"configuration": {
"id": "544e39a7f0abdb3efdd29d675a48bc6a"
}
}
},
"completed": {
"success": true,
"outputGroup": [{
"name": "default",
"fileSets": [{
"id": "0"
}]
}],
"targetKind": "sh_library rule"
}
}
ผลลัพธ์ของภาพใน BEP
บิลด์ปกติจะประเมินการดําเนินการที่เกี่ยวข้องกับ(target, configuration)
คู่ เมื่อสร้างที่เปิดใช้มุมมอง Bazel จะประเมินเป้าหมายที่เชื่อมโยงกับ (target, configuration,
aspect)
เป้าหมายเพิ่มเติม สำหรับเป้าหมายแต่ละรายการที่ได้รับผลกระทบจากลักษณะที่เปิดใช้ที่กำหนด
ผลการประเมินด้านต่างๆ จะพร้อมใช้งานใน BEP แม้ว่าจะไม่มีประเภทเหตุการณ์ที่เฉพาะเจาะจงตามกลุ่มเป้าหมาย สําหรับคู่ (target, configuration)
แต่ละคู่ที่มีแง่มุมที่เกี่ยวข้อง Bazel จะเผยแพร่เหตุการณ์ TargetConfigured
และ TargetComplete
เพิ่มเติมซึ่งแสดงผลลัพธ์จากการใช้แง่มุมกับเป้าหมาย ตัวอย่างเช่น หาก //:foo_lib
สร้างด้วย --aspects=aspects/myaspect.bzl%custom_aspect
เหตุการณ์นี้จะปรากฏใน BEP ด้วย
{
"id": {
"targetCompleted": {
"label": "//foo:foo_lib",
"configuration": {
"id": "544e39a7f0abdb3efdd29d675a48bc6a"
},
"aspect": "aspects/myaspect.bzl%custom_aspect"
}
},
"completed": {
"success": true,
"outputGroup": [{
"name": "default",
"fileSets": [{
"id": "1"
}]
}]
}
}
กำลังใช้ NamedSetOfFiles
การระบุอาร์ติแฟกต์ที่ผลิตโดยเป้าหมาย (หรือแง่มุม) หนึ่งๆ เป็นกรณีการใช้งานทั่วไปของ BEP ที่สามารถดำเนินการได้อย่างมีประสิทธิภาพด้วยการเตรียมพร้อม ส่วนนี้กล่าวถึงโครงสร้างที่แชร์แบบซ้ำซ้อนซึ่ง NamedSetOfFiles
Event นำเสนอ ซึ่งตรงกับโครงสร้างของ Depset ของ Starlark
ผู้บริโภคต้องระมัดระวังเพื่อหลีกเลี่ยงอัลกอริทึมแบบกำลังสองเมื่อประมวลผลเหตุการณ์ NamedSetOfFiles
เนื่องจากบิลด์ขนาดใหญ่อาจมีเหตุการณ์ดังกล่าวหลายหมื่นรายการ ซึ่งต้องใช้การดำเนินการหลายร้อยล้านรายการในการเรียกดูที่มีความซับซ้อนแบบกำลังสอง
รูปที่ 2 NamedSetOfFiles
กราฟ BEP
เหตุการณ์ NamedSetOfFiles
จะปรากฏในสตรีม BEP ก่อนเหตุการณ์ TargetComplete
หรือ NamedSetOfFiles
ที่อ้างอิงถึงเสมอ ค่านี้เป็นค่าผกผันของความสัมพันธ์ของเหตุการณ์ "หลัก-ย่อย" ที่ทุกเหตุการณ์ยกเว้นเหตุการณ์แรกจะปรากฏหลังจากที่ประกาศอย่างน้อย 1 เหตุการณ์ เหตุการณ์ NamedSetOfFiles
ได้รับการประกาศโดยเหตุการณ์ Progress
ที่ไม่มีความหมาย
เมื่อพิจารณาข้อจำกัดด้านการจัดเรียงและการแชร์เหล่านี้ ผู้ใช้ทั่วไปจะต้องบัฟเฟอร์เหตุการณ์ NamedSetOfFiles
ทั้งหมดจนกว่าสตรีม BEP จะหมด สตรีมเหตุการณ์ JSON และโค้ด Python ต่อไปนี้แสดงวิธีป้อนข้อมูลการจับคู่จากเป้าหมาย/มุมมองไปจนถึงอาร์ติแฟกต์ที่สร้างขึ้นในกลุ่มเอาต์พุต "เริ่มต้น" และวิธีประมวลผลเอาต์พุตสำหรับชุดย่อยของเป้าหมาย/ด้านที่สร้างขึ้น
named_sets = {} # type: dict[str, NamedSetOfFiles]
outputs = {} # type: dict[str, dict[str, set[str]]]
for event in stream:
kind = event.id.WhichOneof("id")
if kind == "named_set":
named_sets[event.id.named_set.id] = event.named_set_of_files
elif kind == "target_completed":
tc = event.id.target_completed
target_id = (tc.label, tc.configuration.id, tc.aspect)
outputs[target_id] = {}
for group in event.completed.output_group:
outputs[target_id][group.name] = {fs.id for fs in group.file_sets}
for result_id in relevant_subset(outputs.keys()):
visit = outputs[result_id].get("default", [])
seen_sets = set(visit)
while visit:
set_name = visit.pop()
s = named_sets[set_name]
for f in s.files:
process_file(result_id, f)
for fs in s.file_sets:
if fs.id not in seen_sets:
visit.add(fs.id)
seen_sets.add(fs.id)