Guía de inicio rápido de consultas

En este instructivo, se explica cómo trabajar con Bazel para rastrear dependencias en tu código con un proyecto de Bazel prediseñado.

Para obtener detalles sobre el lenguaje y la marca --output, consulta los manuales Referencia de consultas de Bazel y Referencia de cquery de Bazel. Para obtener ayuda en tu IDE, escribe bazel help query o bazel help cquery en la línea de comandos.

Objetivo

En esta guía, se explica un conjunto de consultas básicas que puedes usar para obtener más información sobre las dependencias de archivos de tu proyecto. Está dirigido a desarrolladores nuevos de Bazel que tengan conocimientos básicos sobre el funcionamiento de Bazel y los archivos BUILD.

Requisitos previos

Primero, instala Bazel, si aún no lo hiciste. En este instructivo, se usa Git para el control de código fuente, por lo que, para obtener los mejores resultados, también debes instalar Git.

Para visualizar los gráficos de dependencias, se usa la herramienta Graphviz, que puedes descargar para seguir el proceso.

Obtén el proyecto de ejemplo

A continuación, recupera la app de ejemplo del repositorio de ejemplos de Bazel ejecutando lo siguiente en la herramienta de línea de comandos que prefieras:

git clone https://github.com/bazelbuild/examples.git

El proyecto de ejemplo de este instructivo se encuentra en el directorio examples/query-quickstart.

Cómo comenzar

¿Qué son las consultas de Bazel?

Las consultas te ayudan a obtener información sobre una base de código de Bazel analizando las relaciones entre los archivos BUILD y examinando el resultado para obtener información útil. En esta guía, se muestra una vista previa de algunas funciones de consulta básicas, pero para obtener más opciones, consulta la guía de consultas. Las consultas te ayudan a obtener información sobre las dependencias en proyectos a gran escala sin tener que navegar manualmente por los archivos BUILD.

Para ejecutar una consulta, abre la terminal de línea de comandos y escribe lo siguiente:

bazel query 'query_function'

Situación

Imagina una situación en la que se ahonde en la relación entre Cafe Bazel y su respectivo chef. Esta cafetería vende exclusivamente pizza y macarrones con queso. A continuación, observa cómo se estructura el proyecto:

bazelqueryguide
├── BUILD
├── src
│   └── main
│       └── java
│           └── com
│               └── example
│                   ├── customers
│                   │   ├── Jenny.java
│                   │   ├── Amir.java
│                   │   └── BUILD
│                   ├── dishes
│                   │   ├── Pizza.java
│                   │   ├── MacAndCheese.java
│                   │   └── BUILD
│                   ├── ingredients
│                   │   ├── Cheese.java
│                   │   ├── Tomatoes.java
│                   │   ├── Dough.java
│                   │   ├── Macaroni.java
│                   │   └── BUILD
│                   ├── restaurant
│                   │   ├── Cafe.java
│                   │   ├── Chef.java
│                   │   └── BUILD
│                   ├── reviews
│                   │   ├── Review.java
│                   │   └── BUILD
│                   └── Runner.java
└── MODULE.bazel

A lo largo de este instructivo, a menos que se indique lo contrario, intenta no buscar en los archivos BUILD para encontrar la información que necesitas y, en su lugar, usa solo la función de consulta.

Un proyecto consta de diferentes paquetes que conforman un Café. Se dividen en: restaurant, ingredients, dishes, customers y reviews. Las reglas dentro de estos paquetes definen diferentes componentes de Cafe con varias etiquetas y dependencias.

Cómo ejecutar una compilación

Este proyecto contiene un método principal dentro de Runner.java que puedes ejecutar para imprimir un menú de la cafetería. Compila el proyecto con Bazel con el comando bazel build y usa : para indicar que el destino se llama runner. Consulta los nombres de destino para aprender a hacer referencia a los destinos.

Para compilar este proyecto, pega el siguiente comando en una terminal:

bazel build :runner

El resultado debería ser similar a este si la compilación se realiza correctamente.

INFO: Analyzed target //:runner (49 packages loaded, 784 targets configured).
INFO: Found 1 target...
Target //:runner up-to-date:
  bazel-bin/runner.jar
  bazel-bin/runner
INFO: Elapsed time: 16.593s, Critical Path: 4.32s
INFO: 23 processes: 4 internal, 10 darwin-sandbox, 9 worker.
INFO: Build completed successfully, 23 total actions

Después de que se compile correctamente, pega este comando para ejecutar la aplicación:

bazel-bin/runner

--------------------- MENU -------------------------

Pizza - Cheesy Delicious Goodness
Macaroni & Cheese - Kid-approved Dinner

----------------------------------------------------

Esto te deja con una lista de los elementos del menú proporcionados junto con una breve descripción.

Exploración de los objetivos

El proyecto enumera los ingredientes y los platos en sus propios paquetes. Para usar una consulta y ver las reglas de un paquete, ejecuta el comando bazel query package/….

En este caso, puedes usar esto para ver los ingredientes y los platos que tiene esta cafetería. Para ello, ejecuta el siguiente comando:

bazel query //src/main/java/com/example/dishes/...

bazel query //src/main/java/com/example/ingredients/...

Si consultas los objetivos del paquete de ingredientes, el resultado debería ser similar al siguiente:

//src/main/java/com/example/ingredients:cheese
//src/main/java/com/example/ingredients:dough
//src/main/java/com/example/ingredients:macaroni
//src/main/java/com/example/ingredients:tomato

Cómo encontrar dependencias

¿En qué objetivos se basa tu ejecutor para ejecutarse?

Supongamos que quieres profundizar en la estructura de tu proyecto sin indagar en el sistema de archivos (lo que puede ser insostenible para proyectos grandes). ¿Qué reglas usa Cafe Bazel?

Si, como en este ejemplo, el destino de tu ejecutor es runner, ejecuta el siguiente comando para descubrir las dependencias subyacentes del destino:

bazel query --noimplicit_deps "deps(target)"

bazel query --noimplicit_deps "deps(:runner)"

//:runner
//:src/main/java/com/example/Runner.java
//src/main/java/com/example/dishes:MacAndCheese.java
//src/main/java/com/example/dishes:Pizza.java
//src/main/java/com/example/dishes:macAndCheese
//src/main/java/com/example/dishes:pizza
//src/main/java/com/example/ingredients:Cheese.java
//src/main/java/com/example/ingredients:Dough.java
//src/main/java/com/example/ingredients:Macaroni.java
//src/main/java/com/example/ingredients:Tomato.java
//src/main/java/com/example/ingredients:cheese
//src/main/java/com/example/ingredients:dough
//src/main/java/com/example/ingredients:macaroni
//src/main/java/com/example/ingredients:tomato
//src/main/java/com/example/restaurant:Cafe.java
//src/main/java/com/example/restaurant:Chef.java
//src/main/java/com/example/restaurant:cafe
//src/main/java/com/example/restaurant:chef

En la mayoría de los casos, usa la función de consulta deps() para ver las dependencias de salida individuales de un objetivo específico.

Visualiza el gráfico de dependencias (opcional)

En la sección, se describe cómo puedes visualizar las rutas de dependencia de una consulta específica. Graphviz ayuda a ver la ruta de acceso como una imagen de grafo acíclico dirigido en lugar de una lista aplanada. Puedes alterar la visualización del gráfico de consulta de Bazel con varias opciones de línea de comandos de --output. Consulta Formatos de salida para conocer las opciones.

Para comenzar, ejecuta la consulta deseada y agrega la marca --noimplicit_deps para quitar las dependencias de herramientas excesivas. Luego, sigue la consulta con la marca de salida y almacena el gráfico en un archivo llamado graph.in para crear una representación de texto del gráfico.

Para buscar todas las dependencias del :runner de destino y dar formato al resultado como un gráfico, haz lo siguiente:

bazel query --noimplicit_deps 'deps(:runner)' --output graph > graph.in

Esto crea un archivo llamado graph.in, que es una representación de texto del gráfico de compilación. Graphviz usa dot , una herramienta que procesa texto en una visualización, para crear un archivo png:

dot -Tpng < graph.in > graph.png

Si abres graph.png, deberías ver algo como lo siguiente. El siguiente gráfico se simplificó para que los detalles esenciales de la ruta sean más claros en esta guía.

Esto es útil cuando quieres ver los resultados de las diferentes funciones de consulta a lo largo de esta guía.

Cómo encontrar dependencias inversas

Si, en cambio, tienes un objetivo y deseas analizar qué otros objetivos lo usan, puedes usar una consulta para examinar qué objetivos dependen de una regla determinada. Esto se denomina “dependencia inversa”. El uso de rdeps() puede ser útil cuando editas un archivo en una base de código con la que no estás familiarizado y puede evitar que, sin saberlo, dañes otros archivos que dependían de él.

Por ejemplo, quieres hacer algunos cambios en el ingrediente cheese. Para evitar causar un problema en Cafe Bazel, debes verificar qué platos dependen de cheese.

Para ver qué objetivos dependen de un objetivo o paquete en particular, puedes usar rdeps(universe_scope, target). La función de consulta rdeps() toma al menos dos argumentos: un universe_scope (el directorio relevante) y un target. Bazel busca las dependencias inversas del destino dentro del universe_scope proporcionado. El operador rdeps() acepta un tercer argumento opcional: un literal de número entero que especifica el límite superior de la profundidad de la búsqueda.

Para buscar dependencias inversas del cheese de destino dentro del alcance de todo el proyecto “//…”, ejecuta el siguiente comando:

bazel query "rdeps(universe_scope, target)"

ex) bazel query "rdeps(//... , //src/main/java/com/example/ingredients:cheese)"

//:runner
//src/main/java/com/example/dishes:macAndCheese
//src/main/java/com/example/dishes:pizza
//src/main/java/com/example/ingredients:cheese
//src/main/java/com/example/restaurant:cafe
//src/main/java/com/example/restaurant:chef

El resultado de la consulta muestra que tanto la pizza como el mac and cheese dependen del queso. ¡Qué sorpresa!

Cómo encontrar objetivos basados en etiquetas

Dos clientes entran a Bazel Cafe: Amir y Jenny. No se sabe nada sobre ellos, excepto sus nombres. Por suerte, sus pedidos están etiquetados en el archivo BUILD “customers”. ¿Cómo puedes acceder a esta etiqueta?

Los desarrolladores pueden etiquetar los destinos de Bazel con diferentes identificadores, a menudo con fines de prueba. Por ejemplo, las etiquetas en las pruebas pueden anotar el rol de una prueba en tu proceso de depuración y lanzamiento, en especial para las pruebas de C++ y Python, que no tienen ninguna capacidad de anotación del tiempo de ejecución. El uso de etiquetas y elementos de tamaño brinda flexibilidad para ensamblar paquetes de pruebas en función de la política de confirmación de una base de código.

En este ejemplo, las etiquetas son pizza o macAndCheese para representar los elementos del menú. Este comando busca destinos que tengan etiquetas que coincidan con tu identificador dentro de un paquete determinado.

bazel query 'attr(tags, "pizza", //src/main/java/com/example/customers/...)'

Esta consulta muestra todos los objetivos del paquete "customers" que tienen la etiqueta "pizza".

Haz una prueba

Usa esta consulta para saber qué quiere pedir Jenny.

Cómo agregar una dependencia nueva

Cafe Bazel amplió su menú: ahora los clientes pueden pedir un batido. Este batido específico consta de los ingredientes Strawberry y Banana.

Primero, agrega los ingredientes de los que depende el batido: Strawberry.java y Banana.java. Agrega las clases Java vacías.

src/main/java/com/example/ingredients/Strawberry.java

package com.example.ingredients;

public class Strawberry {

}

src/main/java/com/example/ingredients/Banana.java

package com.example.ingredients;

public class Banana {

}

A continuación, agrega Smoothie.java al directorio correspondiente: dishes.

src/main/java/com/example/dishes/Smoothie.java

package com.example.dishes;

public class Smoothie {
    public static final String DISH_NAME = "Smoothie";
    public static final String DESCRIPTION = "Yummy and Refreshing";
}

Por último, agrega estos archivos como reglas en los archivos BUILD correspondientes. Crea una nueva biblioteca de Java para cada ingrediente nuevo, incluido su nombre, visibilidad pública y el archivo "src" recién creado. Deberías terminar con este archivo BUILD actualizado:

src/main/java/com/example/ingredients/BUILD

java_library(
    name = "cheese",
    visibility = ["//visibility:public"],
    srcs = ["Cheese.java"],
)

java_library(
    name = "dough",
    visibility = ["//visibility:public"],
    srcs = ["Dough.java"],
)

java_library(
    name = "macaroni",
    visibility = ["//visibility:public"],
    srcs = ["Macaroni.java"],
)

java_library(
    name = "tomato",
    visibility = ["//visibility:public"],
    srcs = ["Tomato.java"],
)

java_library(
    name = "strawberry",
    visibility = ["//visibility:public"],
    srcs = ["Strawberry.java"],
)

java_library(
    name = "banana",
    visibility = ["//visibility:public"],
    srcs = ["Banana.java"],
)

En el archivo BUILD de los platos, quieres agregar una regla nueva para Smoothie. De esta manera, se incluye el archivo Java creado para Smoothie como un archivo "src" y las reglas nuevas que creaste para cada ingrediente del batido.

src/main/java/com/example/dishes/BUILD

java_library(
    name = "macAndCheese",
    visibility = ["//visibility:public"],
    srcs = ["MacAndCheese.java"],
    deps = [
        "//src/main/java/com/example/ingredients:cheese",
        "//src/main/java/com/example/ingredients:macaroni",
    ],
)

java_library(
    name = "pizza",
    visibility = ["//visibility:public"],
    srcs = ["Pizza.java"],
    deps = [
        "//src/main/java/com/example/ingredients:cheese",
        "//src/main/java/com/example/ingredients:dough",
        "//src/main/java/com/example/ingredients:tomato",
    ],
)

java_library(
    name = "smoothie",
    visibility = ["//visibility:public"],
    srcs = ["Smoothie.java"],
    deps = [
        "//src/main/java/com/example/ingredients:strawberry",
        "//src/main/java/com/example/ingredients:banana",
    ],
)

Por último, debes incluir el batido como una dependencia en el archivo BUILD de Chef.

src/main/java/com/example/restaurant/BUILD

java\_library(
    name = "chef",
    visibility = ["//visibility:public"],
    srcs = [
        "Chef.java",
    ],

    deps = [
        "//src/main/java/com/example/dishes:macAndCheese",
        "//src/main/java/com/example/dishes:pizza",
        "//src/main/java/com/example/dishes:smoothie",
    ],
)

java\_library(
    name = "cafe",
    visibility = ["//visibility:public"],
    srcs = [
        "Cafe.java",
    ],
    deps = [
        ":chef",
    ],
)

Vuelve a compilar cafe para confirmar que no haya errores. Si se compila correctamente, felicitaciones. Agregaste una nueva dependencia para "Cafe". De lo contrario, presta atención a los errores ortográficos y a los nombres de los paquetes. Para obtener más información sobre cómo escribir archivos BUILD, consulta la Guía de estilo de BUILD.

Ahora, visualiza el nuevo gráfico de dependencias con la adición de Smoothie para compararlo con el anterior. Para mayor claridad, asigna el nombre graph2.in y graph2.png a las entradas del gráfico.

bazel query --noimplicit_deps 'deps(:runner)' --output graph > graph2.in

dot -Tpng < graph2.in > graph2.png

Si observas graph2.png, puedes ver que Smoothie no tiene dependencias compartidas con otros platos, sino que es solo otro objetivo en el que se basa Chef.

somepath() y allpaths()

¿Qué sucede si quieres consultar por qué un paquete depende de otro? La respuesta se obtiene cuando se muestra una ruta de dependencia entre los dos.

Dos funciones pueden ayudarte a encontrar las rutas de acceso de las dependencias: somepath() y allpaths(). Dado un objetivo de partida S y un punto final E, busca una ruta entre S y E con somepath(S,E).

Para explorar las diferencias entre estas dos funciones, observa las relaciones entre los objetivos "Chef" y "Queso". Existen diferentes rutas posibles para llegar de un destino al otro:

• Chef → MacAndCheese → Cheese
• Chef → Pizza → Queso

somepath() te brinda una sola ruta de las dos opciones, mientras que "allpaths()" muestra todas las rutas posibles.

A modo de ejemplo, con Cafe Bazel, ejecuta lo siguiente:

bazel query "somepath(//src/main/java/com/example/restaurant/..., //src/main/java/com/example/ingredients:cheese)"

//src/main/java/com/example/restaurant:cafe
//src/main/java/com/example/restaurant:chef
//src/main/java/com/example/dishes:macAndCheese
//src/main/java/com/example/ingredients:cheese

El resultado sigue la primera ruta de Cafe → Chef → MacAndCheese → Cheese. En cambio, si usas allpaths(), obtienes lo siguiente:

bazel query "allpaths(//src/main/java/com/example/restaurant/..., //src/main/java/com/example/ingredients:cheese)"

//src/main/java/com/example/dishes:macAndCheese
//src/main/java/com/example/dishes:pizza
//src/main/java/com/example/ingredients:cheese
//src/main/java/com/example/restaurant:cafe
//src/main/java/com/example/restaurant:chef

El resultado de allpaths() es un poco más difícil de leer, ya que es una lista plana de las dependencias. Visualizar este gráfico con Graphviz permite comprender mejor la relación.

Haz una prueba

Uno de los clientes de Cafe Bazel dejó la primera opinión del restaurante. Lamentablemente, faltan algunos detalles en la opinión, como la identidad del usuario que la dejó y a qué plato hace referencia. Por suerte, puedes acceder a esta información con Bazel. El paquete reviews contiene un programa que imprime una opinión de un cliente misterioso. Compila y ejecútala con lo siguiente:

bazel build //src/main/java/com/example/reviews:review

bazel-bin/src/main/java/com/example/reviews/review

Solo con las consultas de Bazel, intenta averiguar quién escribió la opinión y qué plato describía.

Conclusión

¡Felicitaciones! Ya ejecutaste varias consultas básicas, que puedes probar en tus propios proyectos. Para obtener más información sobre la sintaxis del lenguaje de consulta, consulta la página de referencia de consultas. ¿Quieres realizar consultas más avanzadas? En la Guía de consultas, se muestra una lista detallada de más casos de uso que los que se abordan en esta guía.