กฎเชลล์

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

กฎ

• sh_binary
• sh_library
• sh_test

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 ใช้เพื่อประกาศสคริปต์เชลล์ที่เรียกใช้ได้ (sh_binary เป็นชื่อที่ไม่ถูกต้อง เนื่องจากเอาต์พุตของ sh_binary ไม่จำเป็นต้องเป็นไบนารี) กฎนี้ดูแลให้มีการสร้างทรัพยากร Dependency ทั้งหมดและปรากฏในพื้นที่ runfiles ขณะดำเนินการ เราขอแนะนำให้ตั้งชื่อกฎ sh_binary() ตามชื่อสคริปต์โดยตัดนามสกุลออก (เช่น .sh) โดยชื่อกฎและชื่อไฟล์ต้องไม่เหมือนกัน sh_binary จะใช้ shebangs ดังนั้นจึงใช้โปรแกรมล่ามที่พร้อมใช้งานได้ (เช่น #!/bin/zsh)

ตัวอย่าง

สําหรับสคริปต์ Shell ง่ายๆ ที่ไม่มีข้อกําหนดพึ่งพาและไฟล์ข้อมูลบางไฟล์ ให้ทำดังนี้

sh_binary(
    name = "foo",
    srcs = ["foo.sh"],
    data = glob(["datafiles/*.txt"]),
)

อาร์กิวเมนต์

Attributes
name	ชื่อ ต้องระบุ ชื่อที่ไม่ซ้ำกันสําหรับเป้าหมายนี้
deps	รายการป้ายกำกับ ค่าเริ่มต้นคือ [] รายการเป้าหมาย "คลัง" ที่จะรวมเข้ากับเป้าหมายนี้ ดูความคิดเห็นทั่วไปเกี่ยวกับ deps ได้ที่แอตทริบิวต์ทั่วไปที่กำหนดโดยกฎบิลด์ส่วนใหญ่ แอตทริบิวต์นี้ควรใช้เพื่อแสดงกฎ sh_library อื่นๆ ที่ระบุซอร์สโค้ดของโปรแกรมที่ตีความแล้ว ซึ่งขึ้นอยู่กับโค้ดใน srcs ไฟล์ที่ระบุโดยกฎเหล่านี้จะปรากฏอยู่ใน runfiles ของเป้าหมายนี้
srcs	รายการป้ายกำกับ (ต้องระบุ) ไฟล์ที่มีสคริปต์ Shell แอตทริบิวต์นี้ต้องเป็นรายการ Singleton ซึ่งมีองค์ประกอบที่เป็นสคริปต์ Shell สคริปต์นี้ต้องสามารถเรียกใช้ได้ และอาจเป็นไฟล์ต้นฉบับหรือไฟล์ที่สร้างขึ้น ไฟล์อื่นๆ ทั้งหมดที่จำเป็นในรันไทม์ (ไม่ว่าจะเป็นสคริปต์หรือข้อมูล) จะอยู่ในแอตทริบิวต์ data

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 ได้ที่แอตทริบิวต์ทั่วไปที่กฎการสร้างส่วนใหญ่กำหนด คุณควรใช้แอตทริบิวต์นี้เพื่อแสดงรายการกฎ sh_library อื่นๆ ที่ให้ซอร์สโค้ดโปรแกรมที่ตีความซึ่งโค้ดใน srcs ต้องใช้ ไฟล์ที่ระบุโดยกฎเหล่านี้จะแสดงอยู่ใน runfiles ของเป้าหมายนี้
srcs	รายการป้ายกํากับ ค่าเริ่มต้นคือ [] รายการไฟล์อินพุต คุณควรใช้แอตทริบิวต์นี้เพื่อแสดงรายการไฟล์ต้นฉบับสคริปต์เชลล์ที่เป็นของไลบรารีนี้ สคริปต์จะโหลดสคริปต์อื่นๆ ได้โดยใช้คำสั่ง source หรือ . ของเชลล์

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 ได้ที่แอตทริบิวต์ทั่วไปที่กฎการสร้างส่วนใหญ่กำหนด ควรใช้แอตทริบิวต์นี้เพื่อแสดงรายการกฎ sh_library อื่นๆ ที่ให้ซอร์สโค้ดโปรแกรมที่ตีความซึ่งโค้ดใน srcs ต้องใช้ ไฟล์ที่ระบุโดยกฎเหล่านี้จะแสดงอยู่ใน runfiles ของเป้าหมายนี้
srcs	รายการป้ายกำกับ (ต้องระบุ) ไฟล์ที่มีสคริปต์ของ Shell แอตทริบิวต์นี้ต้องเป็นลิสต์แบบเดี่ยวที่มีองค์ประกอบเป็นเชลล์สคริปต์ สคริปต์นี้ต้องเป็นไฟล์ปฏิบัติการและอาจเป็นไฟล์ต้นฉบับหรือไฟล์ที่สร้างขึ้น ไฟล์อื่นๆ ทั้งหมดที่จำเป็นในรันไทม์ (ไม่ว่าจะเป็นสคริปต์หรือข้อมูล) จะอยู่ในแอตทริบิวต์ data