กฎ
sh_binary
ดูแหล่งที่มาของกฎsh_binary(name, deps, srcs, data, args, compatible_with, deprecation, distribs, env, exec_compatible_with, exec_properties, features, licenses, output_licenses, restricted_to, tags, target_compatible_with, testonly, toolchains, visibility)
กฎ sh_binary ใช้เพื่อประกาศสคริปต์ Shell ที่เรียกใช้งานได้
(sh_binary เป็นชื่อที่ไม่ถูกต้อง เนื่องจากเอาต์พุตของ sh_binary ไม่จำเป็นต้องเป็นไบนารี) กฎนี้ช่วยให้มั่นใจว่าระบบจะสร้างทรัพยากร Dependency ทั้งหมดและปรากฏในพื้นที่ runfiles ณ เวลาเรียกใช้
เราขอแนะนำให้ตั้งชื่อกฎ sh_binary() ตามชื่อสคริปต์โดยตัดนามสกุลออก (เช่น .sh) โดยชื่อกฎและชื่อไฟล์ต้องไม่เหมือนกัน
sh_binary จะใช้ shebangs ดังนั้นจึงใช้โปรแกรมล่ามที่พร้อมใช้งานได้ (เช่น
#!/bin/zsh)
ตัวอย่าง
สําหรับสคริปต์เชลล์แบบง่ายที่ไม่มีข้อกําหนดพึ่งพาและไฟล์ข้อมูลบางไฟล์ ให้ทำดังนี้
sh_binary(
name = "foo",
srcs = ["foo.sh"],
data = glob(["datafiles/*.txt"]),
)
อาร์กิวเมนต์
| Attributes | |
|---|---|
name |
ชื่อ ต้องระบุ ชื่อที่ไม่ซ้ำกันสำหรับเป้าหมายนี้ |
deps
|
รายการป้ายกํากับ ค่าเริ่มต้นคือ deps
ได้ที่แอตทริบิวต์ทั่วไปที่กฎการสร้างส่วนใหญ่กำหนด
ควรใช้แอตทริบิวต์นี้เพื่อแสดงรายการกฎ |
srcs
|
รายการป้ายกำกับ (ต้องระบุ) ไฟล์ที่มีสคริปต์เชลล์
แอตทริบิวต์นี้ต้องเป็นลิสต์แบบเดี่ยวที่มีองค์ประกอบเป็นเชลล์สคริปต์
สคริปต์นี้ต้องสามารถเรียกใช้ได้ และอาจเป็นไฟล์ต้นฉบับหรือไฟล์ที่สร้างขึ้น
ไฟล์อื่นๆ ทั้งหมดที่จำเป็นในรันไทม์ (ไม่ว่าจะเป็นสคริปต์หรือข้อมูล) จะอยู่ในแอตทริบิวต์ |
sh_library
ดูแหล่งที่มาของกฎsh_library(name, deps, srcs, data, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, features, licenses, restricted_to, tags, target_compatible_with, testonly, visibility)
การใช้หลักของกฎนี้คือเพื่อรวบรวม "ไลบรารี" เชิงตรรกะซึ่งประกอบด้วยสคริปต์ที่เกี่ยวข้อง ซึ่งเป็นโปรแกรมในภาษาที่แปลความหมายได้ซึ่งไม่จำเป็นต้องคอมไพล์หรือลิงก์ เช่น Bourne Shell และข้อมูลทั้งหมดที่โปรแกรมเหล่านั้นต้องการในรันไทม์ จากนั้นจะใช้ "คลัง" ดังกล่าวได้จากแอตทริบิวต์ data ของกฎ sh_binary อย่างน้อย 1 กฎ
คุณสามารถใช้กฎ filegroup เพื่อรวบรวมไฟล์ข้อมูลได้
ในภาษาโปรแกรมแบบล่าม ความแตกต่างระหว่าง "โค้ด" กับ "ข้อมูล" นั้นไม่ชัดเจนเสมอไป เพราะโปรแกรมเป็นเพียง "ข้อมูล" จากมุมมองของผู้ตีความ ด้วยเหตุนี้ กฎนี้จึงมีแอตทริบิวต์ 3 รายการที่เทียบเท่ากันทั้งหมด ได้แก่ srcs, deps และ data
การใช้งานในปัจจุบันไม่ได้แยกความแตกต่างระหว่างองค์ประกอบของรายการเหล่านี้
แอตทริบิวต์ทั้ง 3 รายการยอมรับกฎ ไฟล์ต้นทาง และไฟล์ที่สร้างขึ้น
อย่างไรก็ตาม แนวทางปฏิบัติแนะนำคือใช้แอตทริบิวต์ตามวัตถุประสงค์ปกติ (เช่นเดียวกับกฎอื่นๆ)
ตัวอย่าง
sh_library(
name = "foo",
data = [
":foo_service_script", # an sh_binary with srcs
":deploy_foo", # another sh_binary with srcs
],
)
อาร์กิวเมนต์
| Attributes | |
|---|---|
name |
ชื่อ ต้องระบุ ชื่อที่ไม่ซ้ำกันสำหรับเป้าหมายนี้ |
deps
|
รายการป้ายกํากับ ค่าเริ่มต้นคือ deps
ได้ที่แอตทริบิวต์ทั่วไปที่กฎการสร้างส่วนใหญ่กำหนด
ควรใช้แอตทริบิวต์นี้เพื่อแสดงรายการกฎ |
srcs
|
รายการป้ายกํากับ ค่าเริ่มต้นคือ
คุณควรใช้แอตทริบิวต์นี้เพื่อแสดงรายการไฟล์ต้นฉบับสคริปต์เชลล์ที่เป็นของไลบรารีนี้ สคริปต์จะโหลดสคริปต์อื่นๆ ได้โดยใช้คำสั่ง |
sh_test
ดูแหล่งที่มาของกฎsh_test(name, deps, srcs, data, args, compatible_with, deprecation, distribs, env, env_inherit, exec_compatible_with, exec_properties, features, flaky, licenses, local, restricted_to, shard_count, size, tags, target_compatible_with, testonly, timeout, toolchains, visibility)
กฎ sh_test() จะสร้างการทดสอบที่เขียนเป็นสคริปต์ Bourne Shell
ดู แอตทริบิวต์ที่ใช้ร่วมกันกับกฎทดสอบทั้งหมด ("*_test)")
ตัวอย่าง
sh_test(
name = "foo_integration_test",
size = "small",
srcs = ["foo_integration_test.sh"],
deps = [":foo_sh_lib"],
data = glob(["testdata/*.txt"]),
)
อาร์กิวเมนต์
| Attributes | |
|---|---|
name |
ชื่อ ต้องระบุ ชื่อที่ไม่ซ้ำกันสำหรับเป้าหมายนี้ |
deps
|
รายการป้ายกํากับ ค่าเริ่มต้นคือ deps
ได้ที่แอตทริบิวต์ทั่วไปที่กฎการสร้างส่วนใหญ่กำหนด
ควรใช้แอตทริบิวต์นี้เพื่อแสดงรายการกฎ |
srcs
|
รายการป้ายกำกับ (ต้องระบุ) ไฟล์ที่มีสคริปต์เชลล์
แอตทริบิวต์นี้ต้องเป็นลิสต์แบบเดี่ยวที่มีองค์ประกอบเป็นเชลล์สคริปต์
สคริปต์นี้ต้องสามารถเรียกใช้ได้ และอาจเป็นไฟล์ต้นฉบับหรือไฟล์ที่สร้างขึ้น
ไฟล์อื่นๆ ทั้งหมดที่จำเป็นในรันไทม์ (ไม่ว่าจะเป็นสคริปต์หรือข้อมูล) จะอยู่ในแอตทริบิวต์ |