Aquí encontrarás algunos de los casos de uso más comunes para compilar proyectos de C++ con Bazel. Si aún no lo has hecho, comienza a compilar proyectos de C++ con Bazel. Para ello, completa el instructivo Introducción a Bazel: compila un proyecto de C++.
Para obtener más información sobre los archivos de encabezado cc_library y hdrs, consulta cc_library.
Cómo incluir varios archivos en un destino
Puedes incluir varios archivos en un solo destino con glob. Por ejemplo:
cc_library(
name = "build-all-the-files",
srcs = glob(["*.cc"]),
hdrs = glob(["*.h"]),
)
Con este destino, Bazel compilará todos los archivos .cc y .h que encuentre en el
mismo directorio que el archivo BUILD que contiene este destino (excepto
los subdirectorios).
Usa inclusiones transitivas
Si un archivo incluye un encabezado, cualquier regla con ese archivo como fuente (es decir, que tenga ese archivo en el atributo srcs, hdrs o textual_hdrs) debe depender de la regla de biblioteca del encabezado incluido. Por el contrario, solo las dependencias directas deben especificarse como dependencias. Por ejemplo, supongamos que sandwich.h incluye bread.h y bread.h incluye flour.h. sandwich.h no incluye flour.h (¿quién quiere harina en su sándwich?), por lo que el archivo BUILD se vería de la siguiente manera:
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"],
)
Aquí, la biblioteca sandwich depende de la biblioteca bread, que depende de la biblioteca flour.
Cómo agregar rutas de inclusión
A veces, no puedes (o no quieres) incluir rutas de acceso raíz en la raíz del espacio de trabajo. Es posible que las bibliotecas existentes ya tengan un directorio de inclusión que no coincida con su ruta en tu lugar de trabajo. Por ejemplo, supongamos que tienes la siguiente estructura de directorios:
└── my-project
├── legacy
│ └── some_lib
│ ├── BUILD
│ ├── include
│ │ └── some_lib.h
│ └── some_lib.cc
└── WORKSPACE
Bazel esperará que some_lib.h se incluya como legacy/some_lib/include/some_lib.h, pero supongamos que some_lib.cc incluye "some_lib.h". Para que esa ruta de inclusión sea válida, legacy/some_lib/BUILD deberá especificar que el directorio some_lib/include es de inclusión:
cc_library(
name = "some_lib",
srcs = ["some_lib.cc"],
hdrs = ["include/some_lib.h"],
copts = ["-Ilegacy/some_lib/include"],
)
Esto es especialmente útil para dependencias externas, ya que, de lo contrario, sus archivos de encabezado deben incluirse con un prefijo /.
Incluye bibliotecas externas
Supongamos que usas Google Test.
Puedes usar una de las funciones del repositorio en el archivo WORKSPACE para
descargar Google Test y hacer que esté disponible en tu repositorio:
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",
)
Luego, crea gtest.BUILD, un archivo BUILD que se usa para compilar Google Test.
Google Test tiene varios requisitos “especiales” que hacen que su regla cc_library sea más complicada:
googletest-release-1.10.0/src/gtest-all.cc#includes todos los demás archivos engoogletest-release-1.10.0/src/: exclúyelo de la compilación para evitar errores de vinculación de símbolos duplicados.Usa archivos de encabezado relacionados con el directorio
googletest-release-1.10.0/include/("gtest/gtest.h"), por lo que debes agregar ese directorio a las rutas de inclusión.Debe vincularse en
pthread, así que agrégalo comolinkopt.
Por lo tanto, la regla final se ve de la siguiente manera:
cc_library(
name = "main",
srcs = glob(
["googletest-release-1.10.0/src/*.cc"],
exclude = ["googletest-release-1.10.0/src/gtest-all.cc"]
),
hdrs = glob([
"googletest-release-1.10.0/include/**/*.h",
"googletest-release-1.10.0/src/*.h"
]),
copts = [
"-Iexternal/gtest/googletest-release-1.10.0/include",
"-Iexternal/gtest/googletest-release-1.10.0"
],
linkopts = ["-pthread"],
visibility = ["//visibility:public"],
)
Esto es un poco desordenado: todo tiene el prefijo googletest-release-1.10.0 como subproducto de la estructura del archivo. Para hacer que http_archive quite
este prefijo, agrega el atributo 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",
)
Luego, gtest.BUILD se vería de la siguiente manera:
cc_library(
name = "main",
srcs = glob(
["src/*.cc"],
exclude = ["src/gtest-all.cc"]
),
hdrs = glob([
"include/**/*.h",
"src/*.h"
]),
copts = ["-Iexternal/gtest/include"],
linkopts = ["-pthread"],
visibility = ["//visibility:public"],
)
Ahora, las reglas de cc_ pueden depender de @gtest//:main.
Cómo escribir y ejecutar pruebas de C++
Por ejemplo, puedes crear un ./test/hello-test.cc de prueba, como:
#include "gtest/gtest.h"
#include "main/hello-greet.h"
TEST(HelloTest, GetGreet) {
EXPECT_EQ(get_greet("Bazel"), "Hello Bazel");
}
Luego, crea el archivo ./test/BUILD para tus pruebas:
cc_test(
name = "hello-test",
srcs = ["hello-test.cc"],
copts = ["-Iexternal/gtest/include"],
deps = [
"@gtest//:main",
"//main:hello-greet",
],
)
Para que hello-greet sea visible para hello-test, debes agregar "//test:__pkg__", al atributo visibility en ./main/BUILD.
Ahora puedes usar bazel test para ejecutar la prueba.
bazel test test:hello-test
Esto produce el siguiente resultado:
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.
Cómo agregar dependencias en bibliotecas compiladas previamente
Si deseas usar una biblioteca de la que solo tienes una versión compilada (por ejemplo, encabezados y un archivo .so), unela en una regla cc_library:
cc_library(
name = "mylib",
srcs = ["mylib.so"],
hdrs = ["mylib.h"],
)
De esta manera, otros destinos de C++ en tu lugar de trabajo pueden depender de esta regla.