Compila y prueba aplicaciones de Node.js

En esta página, se explica cómo usar Cloud Build para compilar y probar aplicaciones de Node.js, almacenar artefactos compilados en un repositorio de npm en Artifact Registry y generar información de procedencia de la compilación.

Cloud Build permite usar cualquier imagen de contenedor disponible a nivel público para ejecutar tareas. La imagen pública node de Docker Hub viene preinstalada con la herramienta npm. Puedes configurar Cloud Build para compilar tu proyecto Node.js con esta herramienta.

Antes de comenzar

En las instrucciones de esta página, se da por hecho que estás familiarizado con Node.js. Además, debes hacer lo siguiente:

Compila con npm

Para ejecutar tareas en la imagen node de Docker Hub, especifica la URL de la imagen en el campo name del archivo de configuración de Cloud Build. Cloud Build inicia el contenedor especificado en el campo name mediante el punto de entrada predeterminado de la imagen. Para anular el punto de entrada predeterminado y definir cómo se debe ejecutar el paso de compilación cuando se invoca, agrega un campo entrypoint en el paso de compilación. La imagen node en Docker Hub viene preinstalada con la herramienta de npm. Especifica las herramientas en el campo entrypoint para invocarlas como el punto de entrada de tu paso de compilación.

En el siguiente ejemplo de archivo de configuración de compilación, se dan las siguientes situaciones:

  • En el campo name, se especifica que Cloud Build usa la imagen node de Docker Hub para ejecutar la tarea. Cuando especificas la imagen node, puedes omitir la versión del nodo para que se establezca de forma predeterminada :latest o especificar una versión de nodo para usar una versión específica. Por ejemplo, name: node usará la versión más reciente del nodo, y name: node:12 usará node:12.

  • El campo entrypoint especifica que la herramienta de npm se usa cuando se invoca la imagen node.

     steps:
 - name: 'node'
   entrypoint: 'npm'

Configura compilaciones de Node.js

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

  2. Instala dependencias: Antes de compilar tu aplicación, debes asegurarte de que todas las dependencias del proyecto estén instaladas desde npm. Puedes instalar dependencias con el comando install dentro del paso de compilación npm. 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 de nombre. En el archivo de configuración de compilación, agrega install al campo args para invocar el comando install:

     steps:
 - name: 'node'
   entrypoint: 'npm'
   args: ['install']

  3. Agrega pruebas: Si definiste una secuencia de comandos test en package.json, puedes configurar Cloud Build para que ejecute la secuencia mediante la agregación de test al campo args:

     steps:
 - name: 'node'
   entrypoint: 'npm'
   args: ['install']
 - name: 'node'
   entrypoint: 'npm'
   args: ['test']

  4. Ejecuta comandos personalizados: Si package.json contiene comandos personalizados, puedes configurar Cloud Build para ejecutar ese comando. En el campo args, agrega run como primer argumento seguido del nombre del comando personalizado. El siguiente archivo de configuración de compilación tiene argumentos para ejecutar un comando personalizado llamado build:

     steps:
 - name: 'node'
    entrypoint: 'npm'
    args: ['install']
 - name: 'node'
    entrypoint: 'npm'
    args: ['test']
 - name: 'node'
    entrypoint: 'npm'
    args: ['run', 'build']

  5. Sube el archivo a Artifact Registry:

    Cloud Build genera información de procedencia de compilación de niveles de la cadena de suministro para artefactos de software (SLSA) para paquetes de npm independientes cuando los subes a Artifact Registry mediante el campo npmPackages en tu archivo de configuración de Cloud Build.

    En el archivo de configuración, agrega el campo npmPackages y especifica el repositorio de npm en Artifact Registry:

     artifacts:
    npmPackages:
    - repository: 'https://LOCATION-npm.pkg.dev/PROJECT-ID/REPOSITORY_NAME'
      packagePath: 'PACKAGE_PATH'

    Reemplaza los siguientes valores:

    • LOCATION: Es la ubicación de tu repositorio en Artifact Registry.
    • PROJECT_ID: Es el ID del proyecto de Google Cloud que contiene el repositorio de Artifact Registry.
    • REPOSITORY_NAME: Es el nombre de tu repositorio de npm en Artifact Registry.
    • PACKAGE_PATH: Es la ruta de acceso del directorio local que contiene el paquete de npm que deseas subir a Artifact Registry. Recomendamos usar una ruta de acceso absoluta. Tu valor de PACKAGE_PATH puede ser . para usar el directorio de trabajo actual, pero el campo no se puede omitir ni se puede dejar vacío. Este directorio debe contener un archivo package.json.

  6. Opcional: Habilita la procedencia para las compilaciones regionales

    Si usas una compilación regional, agrega el campo requestedVerifyOption a options en tu archivo de configuración de compilación. Establece el valor en VERIFIED para habilitar la generación de metadatos de origen. Si no agregas requestedVerifyOption: VERIFIED, Cloud Build solo genera la procedencia de las compilaciones globales.

    options:
  requestedVerifyOption: VERIFIED

  7. Inicia tu compilación: de forma manual o con activadores de compilación.

    Una vez que se complete la compilación, podrás ver los detalles del repositorio en Artifact Registry.

    También puedes ver los metadatos de origen de la compilación y validar la fuente para ayudar a proteger la cadena de suministro de software.

Ejecuta pruebas en varias versiones de node

En ocasiones, es necesario asegurarse de que el proyecto funcione en varias versiones de node. Puedes crear y configurar activadores de Cloud Build de modo que se den las siguientes situaciones:

  • En el archivo de configuración de compilación, especifica la versión de node como una variable de sustitución.
  • Crea un activador para cada versión de node con la que desees compilar la aplicación.
  • En cada una de las opciones de configuración del activador, usa el campo de valor de la variable de sustitución a fin de indicar la versión de node de ese activador.

En los siguientes pasos, se explica cómo especificar la versión de node mediante variables de sustitución específicas del activador:

  1. En la raíz del repositorio, agrega un archivo de configuración de compilación que especifique la versión de node como una variable de sustitución. En el siguiente ejemplo de archivo de configuración de compilación, $_NODE_VERSION es una variable de sustitución definida por el usuario:

     steps:
 - name: 'node:$_NODE_VERSION'
   entrypoint: 'npm'
   args: ['install']
 - name: 'node:$_NODE_VERSION'
   entrypoint: 'npm'
   args: ['test']

  2. Para cada versión de node que desees compilar, crea un activador de compilación mediante los siguientes pasos:

    1. Abre la página Activadores en la consola de Google Cloud:

      Abrir la página Activadores

    2. Selecciona el proyecto en el menú desplegable del selector de proyectos, que se ubica en la parte superior de la página.

    3. Haz clic en Abrir.

    4. Haz clic en Crear activador.

      En la página Crear activador, ingresa la siguiente configuración:

      1. Ingresa un nombre para el activador.

      2. Selecciona el evento del repositorio para iniciar el activador.

      3. Selecciona el repositorio que contenga el código fuente y el archivo de configuración de compilación.

      4. Especifica la regex de la rama o el nombre de la etiqueta que iniciará el activador.

      5. Configuración: Elige el archivo de configuración de compilación que creaste con anterioridad.

      6. En Substitution variables, haz clic en Agregar variable.

        1. En Variable, especifica la variable de versión node que usaste en el archivo de configuración de compilación y, en Valor, especifica la versión del node. Por ejemplo, _NODE_VERSION y 12.

    5. Haz clic en Crear para guardar el activador de compilación.

Puedes usar estos activadores para compilar tu código en la versión de node que especificaste en el activador.

¿Qué sigue?