ในสไลด์นี้ คุณจะได้พบกับกรณีการใช้งานที่พบบ่อยที่สุดสำหรับการสร้างโปรเจ็กต์ C++ ด้วย Bazel หากยังไม่ได้ทำ ให้เริ่มสร้างโปรเจ็กต์ C++ ด้วย Bazel โดยดูบทแนะนำจนจบข้อมูลเบื้องต้นเกี่ยวกับ Bazel: สร้างโปรเจ็กต์ C++
ดูข้อมูลเกี่ยวกับไฟล์ส่วนหัว cc_library และ hdrs ที่ cc_library
การรวมไฟล์หลายไฟล์ในเป้าหมาย
คุณจะรวมไฟล์หลายไฟล์ไว้ในเป้าหมายเดียวได้ด้วย glob เช่น
cc_library(
name = "build-all-the-files",
srcs = glob(["*.cc"]),
hdrs = glob(["*.h"]),
)
เมื่อใช้เป้าหมายนี้ Bazel จะสร้างไฟล์ .cc และ .h ทั้งหมดที่พบในไดเรกทอรีเดียวกับไฟล์ BUILD ที่มีเป้าหมายนี้ (ยกเว้นไดเรกทอรีย่อย)
การใช้สกรรมกริยาประกอบด้วย
หากไฟล์มีส่วนหัว กฎใดๆ ที่มีไฟล์นั้นเป็นแหล่งที่มา (กล่าวคือ มีไฟล์นั้นในแอตทริบิวต์ srcs, hdrs หรือ textual_hdrs) ควรขึ้นอยู่กับกฎไลบรารีของส่วนหัวที่รวมอยู่ ในทางกลับกัน ต้องระบุเฉพาะ Dependency โดยตรงเท่านั้น ตัวอย่างเช่น สมมติว่า sandwich.h มี bread.h และ bread.h มี flour.h sandwich.h
ไม่มี flour.h (ใครอยากใส่แป้งในแซนด์วิช) ไฟล์ BUILD จึงจะมีหน้าตาดังนี้
cc_library(
name = "sandwich",
srcs = ["sandwich.cc"],
hdrs = ["sandwich.h"],
deps = [":bread"],
)
cc_library(
name = "bread",
srcs = ["bread.cc"],
hdrs = ["bread.h"],
deps = [":flour"],
)
cc_library(
name = "flour",
srcs = ["flour.cc"],
hdrs = ["flour.h"],
)
ในที่นี้ ไลบรารี sandwich จะขึ้นอยู่กับไลบรารี bread ซึ่งขึ้นอยู่กับไลบรารี flour
การเพิ่มเส้นทางรวม
บางครั้งคุณ (หรือไม่ต้องการ) รูทจะรวมเส้นทางที่รูทของพื้นที่ทำงานไม่ได้ ไลบรารีที่มีอยู่อาจมีไดเรกทอรีรวมที่ไม่ตรงกับเส้นทางในพื้นที่ทำงานของคุณอยู่แล้ว ตัวอย่างเช่น สมมติว่าคุณมีโครงสร้างไดเรกทอรีต่อไปนี้
└── my-project
├── legacy
│ └── some_lib
│ ├── BUILD
│ ├── include
│ │ └── some_lib.h
│ └── some_lib.cc
└── WORKSPACE
Bazel คาดหวังให้ some_lib.h รวมเป็น legacy/some_lib/include/some_lib.h แต่สมมติว่า some_lib.cc มี "some_lib.h" หากต้องการให้เส้นทางที่รวมถูกต้อง legacy/some_lib/BUILD จะต้องระบุว่าไดเรกทอรี some_lib/include เป็นไดเรกทอรีรวม ดังนี้
cc_library(
name = "some_lib",
srcs = ["some_lib.cc"],
hdrs = ["include/some_lib.h"],
copts = ["-Ilegacy/some_lib/include"],
)
ซึ่งมีประโยชน์อย่างยิ่งสำหรับทรัพยากร Dependency ภายนอก เนื่องจากไฟล์ส่วนหัวต้องมีคำนำหน้า /
รวมไลบรารีภายนอก
สมมติว่าคุณใช้ Google Test
{: .external}
คุณใช้ฟังก์ชันที่เก็บในไฟล์ WORKSPACE เพื่อดาวน์โหลด Google Test และทำให้พร้อมใช้งานในที่เก็บได้ ดังนี้
load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
http_archive(
name = "gtest",
url = "https://github.com/google/googletest/archive/release-1.10.0.zip",
sha256 = "94c634d499558a76fa649edb13721dce6e98fb1e7018dfaeba3cd7a083945e91",
build_file = "@//:gtest.BUILD",
)
จากนั้นสร้าง gtest.BUILD ซึ่งเป็นไฟล์ BUILD ที่ใช้คอมไพล์ Google Test
Google Test มีข้อกำหนด "พิเศษ" หลายข้อที่ทำให้กฎ cc_library ซับซ้อนขึ้น ดังนี้
googletest-release-1.10.0/googletest/src/gtest-all.cc#includeไฟล์อื่นๆ ทั้งหมดในgoogletest-release-1.10.0/googletest/src/: ยกเว้นจากคอมไพล์เพื่อป้องกันข้อผิดพลาดของลิงก์สำหรับสัญลักษณ์ที่ซ้ำกันโดยจะใช้ไฟล์ส่วนหัวที่สัมพันธ์กับไดเรกทอรี
googletest-release-1.10.0/googletest/include/("gtest/gtest.h") คุณจึงต้องเพิ่มไดเรกทอรีดังกล่าวลงในเส้นทางที่รวมจำเป็นต้องลิงก์ใน
pthreadจึงจะเพิ่มเป็นlinkoptได้
ดังนั้น กฎสุดท้ายจะมีลักษณะดังนี้
cc_library(
name = "main",
srcs = glob(
["googletest-release-1.10.0/googletest/src/*.cc"],
exclude = ["googletest-release-1.10.0/googletest/src/gtest-all.cc"]
),
hdrs = glob([
"googletest-release-1.10.0/googletest/include/**/*.h",
"googletest-release-1.10.0/googletest/src/*.h"
]),
copts = [
"-Iexternal/gtest/googletest-release-1.10.0/googletest/include",
"-Iexternal/gtest/googletest-release-1.10.0/googletest"
],
linkopts = ["-pthread"],
visibility = ["//visibility:public"],
)
ขั้นตอนนี้ค่อนข้างยุ่งเหยิงเนื่องจากทุกสิ่งนำหน้าด้วย googletest-release-1.10.0 เป็นผลสืบเนื่องมาจากโครงสร้างของที่เก็บถาวร คุณทำให้ http_archive ตัดคำนำหน้านี้ได้โดยเพิ่มแอตทริบิวต์ strip_prefix ดังนี้
load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
http_archive(
name = "gtest",
url = "https://github.com/google/googletest/archive/release-1.10.0.zip",
sha256 = "94c634d499558a76fa649edb13721dce6e98fb1e7018dfaeba3cd7a083945e91",
build_file = "@//:gtest.BUILD",
strip_prefix = "googletest-release-1.10.0",
)
จากนั้น gtest.BUILD จะมีลักษณะดังนี้
cc_library(
name = "main",
srcs = glob(
["googletest/src/*.cc"],
exclude = ["googletest/src/gtest-all.cc"]
),
hdrs = glob([
"googletest/include/**/*.h",
"googletest/src/*.h"
]),
copts = [
"-Iexternal/gtest/googletest/include",
"-Iexternal/gtest/googletest",
],
linkopts = ["-pthread"],
visibility = ["//visibility:public"],
)
ตอนนี้กฎ cc_ รายการขึ้นอยู่กับ @gtest//:main ได้
การเขียนและเรียกใช้การทดสอบ C++
ตัวอย่าง คุณสร้าง ./test/hello-test.cc ทดสอบได้ เช่น
#include "gtest/gtest.h"
#include "main/hello-greet.h"
TEST(HelloTest, GetGreet) {
EXPECT_EQ(get_greet("Bazel"), "Hello Bazel");
}
จากนั้นสร้างไฟล์ ./test/BUILD สำหรับการทดสอบโดยทำดังนี้
cc_test(
name = "hello-test",
srcs = ["hello-test.cc"],
copts = [
"-Iexternal/gtest/googletest/include",
"-Iexternal/gtest/googletest",
],
deps = [
"@gtest//:main",
"//main:hello-greet",
],
)
หากต้องการให้ hello-test เห็น hello-greet คุณต้องเพิ่ม "//test:__pkg__", ลงในแอตทริบิวต์ visibility ใน ./main/BUILD
ตอนนี้คุณใช้ bazel test เพื่อทำการทดสอบได้แล้ว
bazel test test:hello-test
ซึ่งสร้างเอาต์พุตต่อไปนี้
INFO: Found 1 test target...
Target //test:hello-test up-to-date:
bazel-bin/test/hello-test
INFO: Elapsed time: 4.497s, Critical Path: 2.53s
//test:hello-test PASSED in 0.3s
Executed 1 out of 1 tests: 1 test passes.
การเพิ่มทรัพยากร Dependency บนไลบรารีที่คอมไพล์ล่วงหน้า
หากต้องการใช้ไลบรารีที่คุณมีเฉพาะเวอร์ชันที่คอมไพล์แล้ว (เช่น ส่วนหัวและไฟล์ .so) ให้รวมไฟล์ไว้ในกฎ cc_library ดังนี้
cc_library(
name = "mylib",
srcs = ["mylib.so"],
hdrs = ["mylib.h"],
)
เมื่อทำเช่นนี้ เป้าหมาย C++ อื่นๆ ในพื้นที่ทำงานของคุณก็จะขึ้นอยู่กับกฎนี้