Beneficios de Usar la Configuración de Conexión a Bases de Datos en la Nube
Antes de la introducción de la funcionalidad de configuración de conexión a bases de datos en la nube, ejecutar un escenario de prueba con operaciones de bases de datos a través de CLI requería completar varios pasos engorrosos:
- Proceso de Exportación Manual: Localice la entrada de exportación de la configuración de conexión a la base de datos en la interfaz del producto y expórtela como un archivo
- Gestión de Archivos: Transfiera el archivo de configuración de conexión a la base de datos exportado a la máquina de ejecución de CLI
- Configuración de Ruta: Copie la ruta del archivo en la máquina
- Modificación de Comando: Actualice las opciones de línea de comandos con los valores de ruta reales, por ejemplo:
apidog run --access-token $APIDOG_ACCESS_TOKEN -t 123456 -e 123456 -n 1 -r html,cli --database-connection /Users/xxx/yyy/database-connections.json
Este proceso implicaba numerosas tareas preparatorias, y cualquier cambio en la configuración de la conexión a la base de datos requería repetir todos estos pasos. La experiencia general del usuario era ineficiente y tediosa.
Con la configuración de conexión a bases de datos en la nube, puede eliminar por completo la necesidad de exportar archivos de configuración, transferirlos a máquinas de ejecución de CLI y especificar manualmente valores de opciones en las líneas de comando. Simplemente establezca los valores reales para las variables en la configuración de conexión a la base de datos en la nube para que se ejecute correctamente, mejorando significativamente la experiencia del usuario.
Método 1: Uso de Valores Locales + Configuración de Conexión a Bases de Datos en la Nube
Cuando todas las conexiones a la base de datos en sus escenarios de prueba utilizan configuraciones guardadas en la nube, la opción de exportación de la configuración de conexión a la base de datos no aparecerá (ya que ya no es necesaria). Durante la ejecución de CLI, el sistema puede recuperar directamente las variables requeridas de la configuración de conexión a la base de datos en la nube y encontrar los valores de variables reales de acuerdo con las reglas de reemplazo de variables para establecer conexiones.
Implementación Paso a Paso:
Configurar Variables de Entorno: En la gestión de entornos, establezca los valores reales de conexión a la base de datos en los valores locales de las variables correspondientes para cada entorno que necesite utilizar.
Asegurar Configuración Basada en Variables: Asegúrese de que su configuración de conexión a la base de datos utilice variables por completo (excepto para los puertos), asegurando que se guarde como una conexión a la base de datos en la nube.
Verificar Configuración del Escenario de Prueba: Confirme que todos los escenarios de prueba que desea ejecutar a través de CLI utilicen "configuración de conexión a bases de datos en la nube" (es decir, configuraciones guardadas con variables).
Exportar Valores Locales: Navegue a la página de CI/CD, seleccione "Exportar valores locales para usar" bajo Variables de Entorno/Globales, luego haga clic en el botón de exportar.
Revisar y Modificar Archivo de Exportación: En el archivo exportado, verá los valores de las variables de entorno utilizados por la configuración de conexión a la base de datos. Puede modificar manualmente estos valores en el archivo si es necesario. Coloque el archivo en la máquina CLI y copie la ruta del archivo.
Configurar Comando de CI/CD: En la página de CI/CD, inserte su Token de Acceso, copie el comando y pegue la ruta real del archivo de variables en el valor de la opción:
apidog run --access-token $APIDOG_ACCESS_TOKEN -t 123456 -e 123456 -n 1 -r html,cli --variables /Users/xxx/yyy/pptest_variables.json
Ejecutar y Verificar: Ejecute el comando CLI anterior. La conexión a la base de datos debería funcionar correctamente y ejecutarse con éxito.
Revisar Resultados: Si la impresión de resultados está configurada, puede ver los detalles de ejecución de la conexión a la base de datos en los detalles del informe cargado.
Consideraciones Importantes:
⚠️ Nota de Seguridad: Los valores locales aún utilizan almacenamiento de archivos local para las configuraciones reales de conexión a la base de datos para garantizar la seguridad de los datos. Si necesita cambiar las configuraciones de conexión, modifique manualmente los valores de las variables correspondientes en este archivo.
⚠️ Advertencia sobre Valores Remotos: Si bien el uso de valores remotos para las variables de configuración de conexión a la base de datos puede evitar las operaciones adicionales de exportar archivos de valores locales y agregar opciones de línea de comandos adicionales (y permite la modificación directa de valores remotos en el cliente Apidog), este enfoque plantea riesgos de seguridad de datos y ❌ no se recomienda.
⚠️ Uso de Texto Plano: Si utiliza texto plano completa o parcialmente (excepto para los campos de puerto) en su configuración de conexión, aún necesitará exportar archivos de configuración y usarlos a través de --database-connection en los comandos. Este patrón de uso ❌ no se recomienda.
Método 2: Uso de Variables Vault + Configuración de Conexión a Bases de Datos en la Nube
Si está utilizando valores remotos de variables de entorno + variables Vault para mantener conexiones a bases de datos en la nube, y desea utilizar estas conexiones guardadas en la nube en CLI, siga estos pasos:
Implementación Paso a Paso:
Configurar Variables Vault: En la gestión de entornos, establezca las variables Vault de conexión a la base de datos en los valores remotos de las variables correspondientes, manteniendo los valores locales después de los valores remotos. Configure esto para cada entorno que necesite utilizar.
Asegurar Configuración Basada en Variables: Asegúrese de que su configuración de conexión a la base de datos utilice variables por completo (excepto para los puertos), asegurando que se guarde como una conexión a la base de datos en la nube.
Verificar Configuración del Escenario de Prueba: Confirme que todos los escenarios de prueba que desea ejecutar a través de CLI utilicen "configuración de conexión a bases de datos en la nube" (es decir, configuraciones guardadas con variables).
Configurar Ajustes de CI/CD: Navegue a la página de CI/CD, seleccione "Usar valores remotos" bajo Variables de Entorno/Globales, configure según su situación real, luego copie el comando CLI.
Establecer Variables Vault: En la máquina donde necesita ejecutar CLI, en su pipeline o terminal, primero ingrese export APIDOG_VAULT_KEY=VALUE para usar realmente las variables Vault. Separe múltiples variables Vault con espacios.
Sintaxis Específica del Sistema Operativo:
| Linux y MacOS | Windows |
|---|---|
Establecer Variables: Use export, separe las variables con espaciosexport APIDOG_VAULT_KEY1=VALUE1 APIDOG_VAULT_KEY2=VALUE2 APIDOG_VAULT_KEY3=VALUE3 |
Establecer Variables: Use set, separe las variables con &set APIDOG_VAULT_KEY1=VALUE1&APIDOG_VAULT_KEY2=VALUE2&APIDOG_VAULT_KEY3=VALUE3 |
Consultar Variables: Use echo $VARIABLE_NAMEecho $APIDOG_VAULT_KEY1 |
Consultar Variables: Use echo %VARIABLE_NAME%echo %APIDOG_VAULT_KEY1% |
Ejecutar Comando CLI: Ejecute su comando CLI para iniciar la ejecución.
Verificar Resultados: Al finalizar, podrá ver los resultados de la conexión a la base de datos en el informe, confirmando la conexión exitosa a la base de datos y la ejecución de la operación.
Revisar Detalles de Ejecución: Si la impresión de resultados está configurada, puede ver los detalles de ejecución de la conexión a la base de datos en los detalles del informe cargado.
Recordatorios Críticos:
⚠️ Requisito Pre-ejecución: Antes de ejecutar comandos CLI que contengan variables Vault para conexiones a bases de datos, siempre use export/set para ingresar los valores reales de las variables Vault. De lo contrario, las conexiones a la base de datos fallarán debido a la imposibilidad de recuperar las configuraciones reales.
⚠️ Alcance Temporal de la Variable: Los valores reales de las variables Vault ingresados a través de export/set son efectivos solo para la ejecución actual, funcionando como variables temporales. Deberá volver a ingresarlos usando este método para ejecuciones posteriores.
Conclusión
La configuración de conexión a bases de datos en la nube agiliza significativamente el flujo de trabajo de prueba de CLI al eliminar la gestión manual de archivos y reducir la complejidad de la configuración. Ya sea utilizando valores locales o variables Vault, este enfoque proporciona una solución más segura, eficiente y mantenible para ejecutar escenarios de prueba conectados a bases de datos en entornos de CI/CD.
Elija el método que mejor se adapte a sus requisitos de seguridad y preferencias operativas:
- Valores Locales: Mejor para escenarios que requieren máxima seguridad de datos con control de archivos local
- Variables Vault: Ideal para pipelines de CI/CD automatizados con gestión centralizada de secretos
Ambos enfoques garantizan que sus conexiones a la base de datos permanezcan seguras, al tiempo que proporcionan la flexibilidad y eficiencia necesarias para los flujos de trabajo de prueba modernos.