Compila aplicaciones de Go

En esta página, se explica cómo usar Cloud Build para compilar, probar e implementar aplicaciones de Go. Si estás dando los primeros pasos en Cloud Build, lee primero las guías de inicio rápido y la descripción general de la configuración de compilación.

Antes de comenzar

En las instrucciones de esta página, se supone que estás familiarizado con Go. Además, ten en cuenta la siguiente información:

  • Habilita las API de Cloud Build, Cloud Run, and Artifact Registry.

    Habilita las API

  • Para ejecutar los comandos de gcloud en esta página, instala el SDK de Cloud.
  • Ten a mano tu proyecto de Go.
  • Si deseas crear contenedores para tu app de Go mediante Cloud Build, necesitarás un Dockerfile junto con tu código fuente.
  • Si deseas almacenar el contenedor compilado en Artifact Registry, crea un repositorio de Docker en Artifact Registry.
  • Si quieres almacenar registros de prueba en Cloud Storage, crea un bucket en Cloud Storage.

Permisos de IAM obligatorios

Para obtener instrucciones sobre cómo otorgar estas funciones, consulta Otorga una función mediante la página IAM.

Configurar compilaciones de Go

La imagen pública golang de Docker Hub admite la compilación mediante módulos de Go. El uso de esta imagen como un paso de compilación en el archivo de configuración de Cloud Build te permite invocar comandos go dentro de la imagen. Los argumentos que se pasan a este paso de compilación se pasan directamente a la herramienta de golang, lo que te permite ejecutar cualquier comando de go en esta imagen.

En esta sección, se brinda un ejemplo del archivo de configuración de compilación para una app de Go. Tiene pasos de compilación para compilar la app, agregar pruebas de unidades y, después de que se hayan aprobado las pruebas, crear contenedores para ella y, luego, implementarla.

Para compilar la aplicación de Go, sigue estos pasos:

  1. En el directorio raíz del proyecto, crea un archivo de configuración de Cloud Build llamado cloudbuild.yaml.

  2. Compilación y prueba: Si definiste pruebas de unidades en la aplicación, puedes configurar Cloud Build para ejecutar las pruebas. Para ello, agrega los siguientes campos en un paso de compilación:

    • name: Establece el valor de este campo en golang a fin de usar la imagen golang de Docker Hub para tu tarea.
    • entrypoint: Establece el valor de este campo en /bin/bash. Esto te permite ejecutar comandos de Bash de varias líneas directamente desde el paso de compilación.
    • args: El campo args de un paso de compilación toma una lista de argumentos y los pasa a la imagen a la que hace referencia el campo name. En el siguiente ejemplo, el campo args toma los argumentos para:

      • Ejecuta el formateador del registro de prueba para descargar el resultado del registro de prueba.
      • Cómo imprimir el resultado del registro
      • Se guardarán los resultados de la prueba en sponge.log.
      • Enviar los resultados en sponge.log a un archivo XML JUNIT El nombre del archivo XML JUNIT se construye con la versión corta del ID de confirmación asociado con tu compilación. Un paso de compilación posterior guardará los registros de este archivo en Cloud Storage.
      steps:
        # Run tests and save to file
        - name: golang
          entrypoint: /bin/bash
          args:
            - -c
            - |
              go get -u github.com/jstemmer/go-junit-report
              2>&1 go test -timeout 1m -v ./... | tee sponge.log
              /go/bin/go-junit-report -set-exit-code < sponge.log > ${SHORT_SHA}_test_log.xml
  3. Organiza la app en contenedores: Después de agregar el paso de compilación para asegurarte de que las pruebas se hayan aprobado, puedes compilar la aplicación. Cloud Build proporciona una imagen de Docker compilada con anterioridad que puedes usar para organizar tu aplicación de Go en contenedores. Para crear contenedores para tu app, agrega los siguientes campos en un paso de compilación:

    • name: Configura el valor de este campo como gcr.io/cloud-builders/docker para usar la imagen de Docker compilada previamente de Container Registry en tu tarea.
    • args: Agrega los argumentos para el comando docker build como valores para este campo.

    En el siguiente paso de compilación, se compila la imagen myimage y se etiqueta con la versión corta del ID de confirmación. En el paso de compilación, se usan sustituciones por el ID del proyecto, el nombre del repositorio y los valores de SHA cortos, por lo que estos valores se sustituyen de forma automática en el momento de la compilación. Ten en cuenta que deberás crear o tener un repositorio de Docker en Artifact Registry para almacenar la imagen.

    # Docker Build
    - name: 'gcr.io/cloud-builders/docker'
      args: ['build', '-t',
             'us-central1-docker.pkg.dev/$PROJECT_ID/$_REPO_NAME/myimage:$SHORT_SHA', '.']
  4. Envía el contenedor a Artifact Registry: Puedes almacenar el contenedor compilado en Artifact Registry, un servicio de Google Cloud que puedes usar para almacenar, administrar y proteger los artefactos de compilación. Para ello, deberás tener un repositorio de Docker existente en Artifact Registry. Si deseas configurar Cloud Build para almacenar la imagen en un repositorio de Docker de Artifact Registry, agrega un paso de compilación con los siguientes campos:

    • name: Establece el valor de este campo en gcr.io/cloud-builders/docker a fin de usar la imagen oficial del compilador docker de Container Registry para tu tarea.
    • args: Agrega los argumentos para el comando docker push como valores de este campo. Para la URL de destino, ingresa el repositorio de Docker de Artifact Registry en el que deseas almacenar la imagen.

    En el siguiente paso de compilación, se envía la imagen que compilaste en el paso anterior a Artifact Registry:

    # Docker push to Google Artifact Registry
    - name: 'gcr.io/cloud-builders/docker'
      args: ['push', 'us-central1-docker.pkg.dev/$PROJECT_ID/$_REPO_NAME/myimage:$SHORT_SHA']
  5. Implementa el contenedor en Cloud Run: Para implementar la imagen en Cloud Run, agrega un paso de compilación con los siguientes campos:

    • name: Establece el valor de este campo en google/cloud-sdk para usar la imagen del SDK de Cloud a fin de invocar el comando gcloud a fin de implementar la imagen en Cloud Run.
    • args: Agrega los argumentos para el comando gcloud run deploy como valores de este campo.

    En el siguiente paso de compilación, se implementa la imagen compilada con anterioridad en Cloud Run:

    # Deploy to Cloud Run
    - name: 'gcr.io/cloud-builders/gcloud'
      args: ['run', 'deploy', 'helloworld',
             '--image=us-central1-docker.pkg.dev/$PROJECT_ID/$_REPO_NAME/myimage:$SHORT_SHA',
             '--region', 'us-central1', '--platform', 'managed']
  6. Guardar registros de prueba en Cloud Storage: Puedes configurar Cloud Build para almacenar cualquier registro de prueba en Cloud Storage si especificas una ubicación de bucket existente y una ruta de acceso a los registros de prueba.

    En el siguiente paso de compilación, se almacenan los registros de prueba que guardaste en el archivo XML de JUNIT en un bucket de Cloud Storage:

    # Save test logs to Google Cloud Storage
    artifacts:
      objects:
        location: gs://$_BUCKET_NAME/
        paths:
          - ${SHORT_SHA}_test_log.xml

    En el siguiente fragmento, se muestra el archivo de configuración de compilación completo para todos los pasos descritos anteriormente:

    steps:
      # Run tests and save to file
      - name: golang
        entrypoint: /bin/bash
        args:
          - -c
          - |
            go get -u github.com/jstemmer/go-junit-report
            2>&1 go test -timeout 1m -v ./... | tee sponge.log
            /go/bin/go-junit-report -set-exit-code < sponge.log > ${SHORT_SHA}_test_log.xml
    
      # Docker Build
      - name: 'gcr.io/cloud-builders/docker'
        args: ['build', '-t',
               'us-central1-docker.pkg.dev/$PROJECT_ID/$_REPO_NAME/myimage:$SHORT_SHA', '.']
    
      # Docker push to Google Artifact Registry
      - name: 'gcr.io/cloud-builders/docker'
        args: ['push', 'us-central1-docker.pkg.dev/$PROJECT_ID/$_REPO_NAME/myimage:$SHORT_SHA']
    
      # Deploy to Cloud Run
      - name: 'gcr.io/cloud-builders/gcloud'
        args: ['run', 'deploy', 'helloworld',
               '--image=us-central1-docker.pkg.dev/$PROJECT_ID/$_REPO_NAME/myimage:$SHORT_SHA',
               '--region', 'us-central1', '--platform', 'managed']
    
    # Save test logs to Google Cloud Storage
    artifacts:
      objects:
        location: gs://$_BUCKET_NAME/
        paths:
          - ${SHORT_SHA}_test_log.xml
    # Store images in Google Artifact Registry
    images:
      - us-central1-docker.pkg.dev/$PROJECT_ID/$_REPO_NAME/myimage:$SHORT_SHA
  7. Inicia la compilación mediante la herramienta de gcloud o los activadores de compilación. Debes especificar el nombre del repositorio de Artifact Registry cuando comiences la compilación.

    Para especificar el repositorio de Artifact Registry cuando inicias la compilación mediante la herramienta de gcloud, haz lo siguiente:

    gcloud builds submit --config=cloudbuild.yaml \
        --substitutions=_REPO_NAME="REPO_NAME"
    

    Reemplaza REPO_NAME por el nombre de tu repositorio de Artifact Registry.

    Para especificar el repositorio de Artifact Registry cuando compilas con activadores de compilación, especifica el nombre de tu repositorio de Artifact Registry en el campo Variables de sustitución cuando crees el activador de compilación.

¿Qué sigue?