Migra de Xcode a Bazel

Nightly · 9.0 · 8.6 · 8.5 · 8.4 · 8.3 · 8.2 · 7.7

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 de solución de problemas para 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 espacio de trabajo o se especifiquen como importaciones en el WORKSPACE archivo.

  • Cuando se compilan 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 del proyecto de Xcode que coincida con los archivos BUILD con Tulsi cada vez que actualices los archivos BUILD. 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.

  • Debido a las diferencias en los esquemas de configuración de compilación, como los diseños de directorios o las marcas de compilación, es posible que Xcode no esté completamente al tanto del "panorama general" de la compilación y, por lo tanto, es posible que algunas funciones de Xcode no funcionen. En particular:

    • Según los destinos que selecciones para la conversión en Tulsi, es posible que Xcode no pueda indexar correctamente la fuente del proyecto. Esto afecta la finalización y la navegación del código en Xcode, ya que Xcode no podrá ver todo el código fuente del proyecto.

    • Es posible que el análisis estático, los sanitizadores de direcciones y los sanitizadores de subprocesos no funcionen, ya que Bazel no produce los resultados que Xcode espera para esas funciones.

    • Si generas un proyecto de Xcode con Tulsi y lo usas para ejecutar pruebas desde Xcode, Xcode ejecutará las pruebas en lugar de Bazel. Para ejecutar pruebas con Bazel, ejecuta el comando bazel test de forma manual.

Antes de comenzar

Antes de comenzar, haz lo siguiente:

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

  2. Si no estás familiarizado con Bazel y sus conceptos, completa el instructivo de la app para iOS). Debes comprender el espacio 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. Analiza y comprende las dependencias del proyecto.

Analiza 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 Cómo trabajar 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 CocoaPods

  3. Crea un archivo BUILD:

    a. Agrega el destino de la aplicación.

    b. Agrega los destinos de prueba (opcional).

    c. Agrega los destinos de la biblioteca.

  4. Granulariza la compilación(opcional).

  5. Ejecuta la compilación.

  6. Genera el proyecto de Xcode con Tulsi

Paso 1: Crea el archivo WORKSPACE

Crea un archivo WORKSPACE en un directorio nuevo. Este directorio se convierte en la raíz del espacio 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 están en uno de los directorios del proyecto, especifica estas dependencias externas en el WORKSPACE archivo.

Paso 2: (Experimental) Integra dependencias de CocoaPods

Para integrar dependencias de CocoaPods en el espacio de trabajo de Bazel, debes convertir las en paquetes de Bazel como se describe en Cómo convertir dependencias de CocoaPods.

Paso 3: Crea un archivo BUILD

Una vez que hayas definido el espacio 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 espacio de trabajo de Bazel y configúralo para que realice 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 Espacios de trabajo, paquetes y destinos.

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

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

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

  • provisioning_profile - perfil de aprovisionamiento de tu cuenta de desarrollador de Apple (si compilas para un dispositivo iOS).

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

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

  • 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 destinos de prueba (opcional)

Las reglas de compilación de Apple de Bazel admiten la ejecución de pruebas de unidades basadas en bibliotecas en iOS y macOS, así como pruebas basadas en aplicaciones en macOS. Para las pruebas basadas en aplicaciones en iOS o las pruebas de IU en cualquiera de las plataformas, Bazel compilará los resultados de la prueba, pero las pruebas deben ejecutarse en Xcode a través de un proyecto generado con Tulsi. 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 ejecutar pruebas de unidades basadas en bibliotecas en iOS. Para las pruebas que requieren el simulador de iOS , Bazel compilará los resultados de la prueba, pero no la ejecutará. Debes generar un proyecto de Xcode con Tulsi y ejecutar las pruebas desde Xcode.

  • ios_ui_test para compilar los resultados necesarios para ejecutar pruebas de interfaz de usuario en el simulador de iOS con Xcode. Debes generar un proyecto de Xcode con Tulsi y ejecutar las pruebas desde Xcode. Bazel no puede ejecutar pruebas de IU de forma nativa.

Como mínimo, especifica un valor para el atributo minimum_os_version. Si bien otros atributos de empaquetado, como bundle_identifier y infoplists, usan de forma predeterminada los valores más comunes, 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 del destino ios_application como el valor del atributo test_host.

Paso 3c: Agrega los destinos de la biblioteca

Agrega un objc_library destino para cada biblioteca de Objective C y un swift_library destino para cada biblioteca de Swift de la que dependen 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 srcs atributo.

  • Enumera los encabezados en el hdrs atributo.

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

En este punto, es recomendable probar la compilación:

bazel build //:<application_target>

Paso 4: Granulariza la compilación (opcional)

Si el proyecto es grande o a medida que crece, considera dividirlo en varios paquetes de Bazel. Este aumento de la granularidad proporciona lo siguiente:

  • Mayor incrementalidad de las compilaciones

  • Mayor paralelización de las tareas de compilación

  • Mejor capacidad de mantenimiento para los usuarios futuros

  • Mejor control sobre la visibilidad del código fuente en todos los destinos y paquetes Esto evita problemas, como que las bibliotecas que contienen detalles de implementación se filtren en las APIs públicas.

Sugerencias para granularizar el proyecto:

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

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

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

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

  • Aplica límites de visibilidad saludables 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 destino de aplicación y prueba de forma individual para encontrar más fácilmente las fuentes de los errores que se producen.

Por ejemplo:

bazel build //:my-target

Paso 6: Genera el proyecto de Xcode con Tulsi

Cuando se compila con Bazel, los archivos WORKSPACE y BUILD se convierten en la fuente de información sobre la compilación. Para que Xcode lo sepa, debes generar un proyecto de Xcode compatible con Bazel usando Tulsi.

Solución de problemas

Pueden surgir errores de Bazel cuando se desincroniza con la versión de Xcode seleccionada, como cuando aplicas una actualización. Estas son algunas cosas que puedes probar si tienes errores con Xcode, por ejemplo, "Se debe especificar la versión de Xcode para usar un CROSSTOOL de Apple".

  • Ejecuta Xcode de forma manual y acepta los términos y condiciones.

  • Usa Xcode select 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, también puedes intentar ejecutar bazel clean --expunge.