การค้นหาพฤติกรรมที่ไม่สม่ำเสมอในกฎของ WORKSPACE

รายงานปัญหา ดูแหล่งข้อมูล ดูแหล่งข้อมูล 7.3 · 7.2 · 7.1 · 7.0 · 6.5

ต่อไปนี้ เครื่องโฮสต์คือเครื่องที่ Bazel ทำงานอยู่

เมื่อใช้การดําเนินการจากระยะไกล ขั้นตอนการสร้างและ/หรือการทดสอบจริงจะไม่เกิดขึ้นบนเครื่องโฮสต์ แต่ระบบจะส่งไปยังระบบการดําเนินการจากระยะไกลแทน อย่างไรก็ตาม ขั้นตอนที่เกี่ยวข้องกับการแก้ไขกฎของ Workspace จะเกิดขึ้นในเครื่องโฮสต์ หากกฎของเวิร์กスペースเข้าถึงข้อมูลเกี่ยวกับเครื่องโฮสต์เพื่อใช้งานระหว่างการดำเนินการ บิลด์มีแนวโน้มที่จะใช้งานไม่ได้เนื่องจากสภาพแวดล้อมไม่เข้ากันได้

ในการปรับกฎ Bazel สําหรับการดําเนินการจากระยะไกล คุณต้องค้นหากฎของ Workspace ดังกล่าวและแก้ไข หน้านี้จะอธิบายวิธีค้นหากฎของพื้นที่ทำงานที่อาจทำให้เกิดปัญหาโดยใช้บันทึกของพื้นที่ทำงาน

การค้นหากฎที่ไม่ใช่แบบปิด

กฎของ Workspace ช่วยให้นักพัฒนาแอปเพิ่มข้อกำหนดในพื้นที่ทำงานภายนอกได้ แต่มีความซับซ้อนเพียงพอที่จะประมวลผลแบบกำหนดเองในกระบวนการ คำสั่งที่เกี่ยวข้องทั้งหมดจะดำเนินการในเครื่องและอาจเป็นแหล่งที่มาที่อาจทำให้เกิดช่องโหว่ โดยปกติแล้ว ลักษณะการทำงานที่ไม่ปิดผนึกจะแสดงผ่าน repository_ctx ซึ่งช่วยให้โต้ตอบกับเครื่องโฮสต์ได้

ตั้งแต่ Bazel 0.18 เป็นต้นไป คุณสามารถดูบันทึกของการดำเนินการบางอย่างที่อาจไม่เป็นไปตามหลักการรักษาความปลอดภัยโดยเพิ่ม Flag --experimental_workspace_rules_log_file=[PATH] ลงในคำสั่ง Bazel [PATH] คือชื่อไฟล์ที่ใช้สร้างบันทึก

สิ่งที่ควรทราบ

  • บันทึกจะบันทึกเหตุการณ์ขณะที่ดำเนินการ หากแคชขั้นตอนไว้ ขั้นตอนเหล่านั้นจะไม่แสดงในบันทึก ดังนั้นอย่าลืมเรียกใช้ bazel clean --expunge ล่วงหน้าเพื่อให้ได้ผลลัพธ์ที่สมบูรณ์

  • บางครั้งฟังก์ชันอาจทำงานอีกครั้ง ซึ่งในกรณีนี้ เหตุการณ์ที่เกี่ยวข้องจะปรากฏในบันทึกหลายครั้ง

  • ขณะนี้กฎ Workspace บันทึกเฉพาะเหตุการณ์ Starlark เท่านั้น

วิธีค้นหาสิ่งที่ดำเนินการระหว่างการเริ่มต้นใช้งานพื้นที่ทำงาน

  1. เรียกใช้ bazel clean --expunge คำสั่งนี้จะล้างแคชในเครื่องและที่เก็บข้อมูลแคชทั้งหมด เพื่อให้แน่ใจว่าการเริ่มต้นทั้งหมดจะทำงานอีกครั้ง

  2. เพิ่ม --experimental_workspace_rules_log_file=/tmp/workspacelog ลงในคำสั่ง Bazel แล้วเรียกใช้การสร้าง

    ซึ่งจะสร้างไฟล์โปรโตคอลแบบไบนารีที่แสดงรายการข้อความประเภท WorkspaceEvent

  3. ดาวน์โหลดซอร์สโค้ด Bazel และไปยังโฟลเดอร์ Bazel โดยใช้คำสั่งด้านล่าง คุณต้องมีซอร์สโค้ดจึงจะแยกวิเคราะห์บันทึกพื้นที่ทำงานด้วยโปรแกรมแยกวิเคราะห์ workspacelog ได้

    git clone https://github.com/bazelbuild/bazel.git
cd bazel

  4. แปลงบันทึกพื้นที่ทำงานทั้งหมดเป็นข้อความในที่เก็บซอร์สโค้ด Bazel

    bazel build src/tools/workspacelog:parser
bazel-bin/src/tools/workspacelog/parser --log_path=/tmp/workspacelog > /tmp/workspacelog.txt

  5. เอาต์พุตอาจมีความละเอียดมากและมีเอาต์พุตจากกฎ Bazel ในตัว

    หากต้องการยกเว้นกฎที่เฉพาะเจาะจงจากเอาต์พุต ให้ใช้ตัวเลือก --exclude_rule เช่น

    bazel build src/tools/workspacelog:parser
bazel-bin/src/tools/workspacelog/parser --log_path=/tmp/workspacelog \
    --exclude_rule "//external:local_config_cc" \
    --exclude_rule "//external:dep" > /tmp/workspacelog.txt

  6. เปิด /tmp/workspacelog.txt และตรวจสอบการดำเนินการที่ไม่ปลอดภัย

บันทึกประกอบด้วยข้อความ WorkspaceEvent ที่ระบุการดำเนินการบางอย่างที่อาจไม่ปลอดภัยซึ่งดำเนินการใน repository_ctx

การดำเนินการที่ไฮไลต์ว่าอาจไม่เป็นไปตามข้อกำหนดการแยกส่วนมีดังนี้

  • execute: เรียกใช้คำสั่งที่กำหนดเองบนสภาพแวดล้อมของโฮสต์ โปรดตรวจสอบว่าทรัพยากรเหล่านี้อาจทำให้เกิดทรัพยากร Dependency ในสภาพแวดล้อมของโฮสต์หรือไม่

  • download, download_and_extract: ตรวจดูว่าได้ระบุ sha256 แล้วสำหรับบิลด์ที่เฉพาะตัว

  • file, template: การดำเนินการนี้ไม่ได้หมายความว่าไม่เป็นไปตามหลักการรักษาความปลอดภัย แต่อาจเป็นกลไกในการนําข้อกําหนดในสภาพแวดล้อมโฮสต์มาไว้ในที่เก็บ ตรวจสอบว่าคุณเข้าใจว่าอินพุตมาจากที่ใด และไม่ได้ขึ้นอยู่กับสภาพแวดล้อมของโฮสต์

  • os: วิธีนี้ไม่ได้เป็นแบบเฉพาะตัว แต่เป็นวิธีง่ายๆ ในการรับทรัพยากร Dependency ในสภาพแวดล้อมของโฮสต์ โดยปกติแล้วบิลด์แบบปิดผนึกจะไม่เรียกใช้การดำเนินการนี้ ในการประเมินว่าการใช้งานของคุณเป็นแบบเฉพาะตัวหรือไม่ โปรดทราบว่าการทำงานนี้ทำงานบนโฮสต์ ไม่ใช่บนผู้ปฏิบัติงาน โดยทั่วไปแล้ว การรับข้อมูลเฉพาะของสภาพแวดล้อมจากโฮสต์ไม่ใช่แนวทางที่ดีสำหรับบิลด์ระยะไกล

  • symlink: ปกติแล้วปลอดภัย แต่ให้สังเกตสัญญาณอันตราย ลิงก์สัญลักษณ์ไปยังภายนอกที่เก็บหรือไปยังเส้นทางสัมบูรณ์อาจก่อให้เกิดปัญหากับผู้ปฏิบัติงานระยะไกล หากสร้างลิงก์สัญลักษณ์ตามพร็อพเพอร์ตี้ของเครื่องโฮสต์ ก็อาจมีปัญหาเช่นกัน

  • which: การตรวจสอบโปรแกรมที่ติดตั้งในโฮสต์มักจะมีปัญหาเนื่องจากผู้ปฏิบัติงานอาจมีการกำหนดค่าที่แตกต่างกัน