Migra de Xcode a Bazel

Informar un problema Ver fuente

En esta página, se describe cómo compilar o probar un proyecto de Xcode con Bazel. Se describen las diferencias entre Xcode y Bazel, y se proporcionan los pasos para convertir un proyecto de Xcode en un proyecto de Bazel. También se proporcionan soluciones para solucionar problemas a fin de abordar errores comunes.

Diferencias entre Xcode y Bazel

  • Bazel requiere que especifiques de forma explícita cada destino de compilación y sus dependencias, además de la configuración de compilación correspondiente a través de reglas de compilación.

  • Bazel requiere que todos los archivos de los que depende el proyecto estén presentes en el directorio del lugar de trabajo o se especifiquen como importaciones en el archivo WORKSPACE.

  • Cuando compilas proyectos de Xcode con Bazel, los archivos BUILD se convierten en la fuente de información. Si trabajas en el proyecto en Xcode, debes generar una versión nueva de este que coincida con los archivos BUILD mediante rules_xcodeproj cada vez que actualices los archivos BUILD. Algunos cambios en los archivos BUILD, como agregar dependencias a un destino, no requieren volver a generar el proyecto, lo que puede acelerar el desarrollo. Si no usas Xcode, los comandos bazel build y bazel test proporcionan capacidades de compilación y prueba con ciertas limitaciones que se describen más adelante en esta guía.

Antes de comenzar

Antes de comenzar, haz lo siguiente:

  1. Instala Bazel si aún no lo hiciste.

  2. Si no conoces Bazel y sus conceptos, completa el instructivo de apps para iOS. Debes comprender el lugar de trabajo de Bazel, incluidos los archivos WORKSPACE y BUILD, así como los conceptos de destinos, reglas de compilación y paquetes de Bazel.

  3. Analizar y comprender las dependencias del proyecto.

Analizar las dependencias del proyecto

A diferencia de Xcode, Bazel requiere que declares de forma explícita todas las dependencias para cada destino en el archivo BUILD.

Para obtener más información sobre las dependencias externas, consulta Trabaja con dependencias externas.

Compila o prueba un proyecto de Xcode con Bazel

Para compilar o probar un proyecto de Xcode con Bazel, haz lo siguiente:

  1. Crea el archivo WORKSPACE

  2. (Experimental) Integra dependencias de SwiftPM

  3. Crea un archivo BUILD:

    a. Agrega el destino de la aplicación

    b. (Opcional) Agrega los destinos de prueba

    c. Agrega los destinos de la biblioteca

  4. Detalles de la compilación(opcional)

  5. Ejecuta la compilación

  6. Genera el proyecto de Xcode con rules_xcodeproj

Paso 1: Crea el archivo WORKSPACE

Crea un archivo WORKSPACE en un directorio nuevo. Este directorio se convierte en la raíz del lugar de trabajo de Bazel. Si el proyecto no usa dependencias externas, este archivo puede estar vacío. Si el proyecto depende de archivos o paquetes que no se encuentran en uno de sus directorios, especifica estas dependencias externas en el archivo WORKSPACE.

Paso 2: Integra las dependencias de SwiftPM (experimental)

Para integrar dependencias de SwiftPM en el lugar de trabajo de Bazel con swift_bazel, debes convertirlas en paquetes de Bazel como se describe en el siguiente instructivo.

Paso 3: Crea un archivo BUILD

Una vez que hayas definido el lugar de trabajo y las dependencias externas, deberás crear un archivo BUILD que le indique a Bazel cómo se estructura el proyecto. Crea el archivo BUILD en la raíz del lugar de trabajo de Bazel y configúralo para realizar una compilación inicial del proyecto de la siguiente manera:

Sugerencia: Para obtener más información sobre los paquetes y otros conceptos de Bazel, consulta Lugares de trabajo, paquetes y destinos.

Paso 3a: Agrega el destino de la aplicación

Agrega un destino de regla macos_application o ios_application. Este destino compila un paquete de aplicación de macOS o iOS, respectivamente. En el destino, especifica lo siguiente como mínimo:

  • bundle_id: Es el ID del paquete (ruta de DNS inversa seguido del nombre de la app) del objeto binario.

  • provisioning_profile: Es el perfil de aprovisionamiento de tu cuenta de desarrollador de Apple (si se crea para un dispositivo iOS).

  • families (solo para iOS): Indica si se debe compilar la aplicación para iPhone, iPad o ambos.

  • infoplists: Es la lista de archivos .plist que se combinarán en el archivo final Info.plist.

  • minimum_os_version: Es la versión mínima de macOS o iOS que admite la aplicación. Esto garantiza que Bazel compile la aplicación con los niveles de API correctos.

Paso 3b: Agrega los objetivos de prueba (opcional)

Las reglas de compilación de Apple de Bazel admiten la ejecución de pruebas de IU y unidades en todas las plataformas de Apple. Agrega destinos de prueba de la siguiente manera:

  • macos_unit_test para ejecutar pruebas de unidades basadas en bibliotecas y aplicaciones en macOS

  • ios_unit_test para compilar y ejecutar pruebas de unidades basadas en bibliotecas en iOS.

  • ios_ui_test para compilar y ejecutar pruebas de la interfaz de usuario en el simulador de iOS

  • Existen reglas de prueba similares para tvOS, watchOS y visionOS.

Como mínimo, especifica un valor para el atributo minimum_os_version. Mientras que otros atributos de empaquetado, como bundle_identifier y infoplists, usan de forma predeterminada los valores más usados, asegúrate de que esos valores predeterminados sean compatibles con el proyecto y ajústalos según sea necesario. Para las pruebas que requieren el simulador de iOS, también especifica el nombre de destino ios_application como el valor del atributo test_host.

Paso 3c: Agrega las orientaciones de la biblioteca

Agrega un objetivo objc_library para cada biblioteca de Objective-C y un objetivo de swift_library para cada biblioteca de Swift de la que dependan la aplicación o las pruebas.

Agrega los destinos de la biblioteca de la siguiente manera:

  • Agrega los destinos de la biblioteca de la aplicación como dependencias a los destinos de la aplicación.

  • Agrega los destinos de la biblioteca de pruebas como dependencias a los destinos de prueba.

  • Enumera las fuentes de implementación en el atributo srcs.

  • Muestra los encabezados en el atributo hdrs.

Puedes explorar los ejemplos existentes de varios tipos de aplicaciones directamente en el directorio de ejemplos de rules_apple. Por ejemplo:

Para obtener más información sobre las reglas de compilación, consulta Reglas de Apple para Bazel.

En este punto, se recomienda probar la compilación:

bazel build //:<application_target>

Paso 4: Detalla la compilación (opcional)

Si el proyecto es grande o a medida que crece, considera fragmentarlo en varios paquetes de Bazel. Este mayor nivel de detalle proporciona lo siguiente:

  • Mayor incrementalidad de las compilaciones

  • Mayor paralelización de tareas de compilación

  • Mejor mantenimiento para los usuarios futuros

  • Mejor control sobre la visibilidad del código fuente entre objetivos y paquetes De esta manera, se evita que las bibliotecas con detalles de implementación se filtren en APIs públicas.

Sugerencias para detallar el proyecto:

  • Coloca cada biblioteca en su propio paquete de Bazel. Comienza con las que requieren la menor cantidad de dependencias y avanza hacia arriba en el árbol de dependencias.

  • A medida que agregas archivos BUILD y especificas objetivos, agrega estos destinos nuevos a los atributos deps de los destinos que dependen de ellos.

  • La función glob() no cruza los límites del paquete, por lo que, a medida que aumente la cantidad de paquetes, se reducirán los archivos que coincidan con glob().

  • Cuando agregues un archivo BUILD a un directorio main, también agrega un archivo BUILD al directorio test correspondiente.

  • Aplica límites de visibilidad de buen estado en todos los paquetes.

  • Compila el proyecto después de cada cambio importante en los archivos BUILD y corrige los errores de compilación a medida que los encuentres.

Paso 5: Ejecuta la compilación

Ejecuta la compilación completamente migrada para asegurarte de que se complete sin errores ni advertencias. Ejecuta cada aplicación y destino de prueba de forma individual para encontrar con mayor facilidad las fuentes de cualquier error que ocurra.

Por ejemplo:

bazel build //:my-target

Paso 6: Genera el proyecto de Xcode con rules_xcodeproj

Cuando compilas con Bazel, los archivos WORKSPACE y BUILD se convierten en la fuente de información sobre la compilación. Para que Xcode esté al tanto de esto, debes generar un proyecto de Xcode compatible con Bazel mediante rules_xcodeproj.

Solución de problemas

Pueden surgir errores de Bazel cuando no se sincroniza con la versión de Xcode seleccionada, por ejemplo, cuando aplicas una actualización. A continuación, se indican algunos pasos que puedes probar si experimentas errores con Xcode. Por ejemplo, “se debe especificar la versión de Xcode para usar una CROSSTOOL de Apple”.

  • Ejecuta Xcode manualmente y acepta los Términos y Condiciones.

  • Usa la selección de Xcode para indicar la versión correcta, aceptar la licencia y borrar el estado de Bazel.

  sudo xcode-select -s /Applications/Xcode.app/Contents/Developer
  sudo xcodebuild -license
  bazel sync --configure
  • Si esto no funciona, puedes intentar ejecutar bazel clean --expunge.