Aplicación de prueba del SDK de conectores de Microsoft Graph

El archivo ejecutable GraphConnectorAgentTest es una utilidad de prueba para el conector personalizado. No crea conexiones ni agrega datos al índice de Microsoft. La utilidad de prueba se ejecuta en el equipo donde instaló el agente y no se conecta a recursos externos, excepto al origen de datos que forma parte de la prueba. Puede encontrar la aplicación de prueba en la carpeta TestApp de la carpeta de instalación del agente del conector de Microsoft Graph.

Actualice los siguientes archivos de configuración para usar esta utilidad de prueba:

  • ConnectionInfo.json: este archivo contiene toda la información sobre la conexión: el identificador del conector que identifica el conector personalizado para el que se crea esta conexión, la dirección URL del origen de datos, las credenciales para acceder al origen de datos, el esquema asociado a la conexión y parámetros adicionales para la conexión. Este archivo de configuración se encuentra en la carpeta Config de la aplicación de prueba.

  • CustomConnectorPortMap.json: después de crear el conector personalizado, agregue la asignación del identificador del conector y el puerto en el que se ejecuta a este archivo. Este archivo se encuentra en la carpeta de instalación del agente del conector de Microsoft Graph.

    Captura de pantalla de la asignación de puertos en el archivo CustomConnectorPortMap.json.

    Nota:

    Puede agregar varios identificadores de conector y su información de puerto correspondiente a este archivo mediante el formato Id>:<Port> del <conector. Cada conector único debe ejecutarse en un puerto diferente.

  • Manifest.json: el archivo de manifiesto es necesario para identificar un conector y su configuración al publicar una conexión a través del Centro de Administración de Microsoft 365. Actualice este archivo de manifiesto para usarlo para la validación en esta aplicación de prueba. Este archivo se encuentra en la carpeta Config de la aplicación de prueba.

    Proporcione los detalles del manifiesto en el formato siguiente:

    {
      // This is the unique connector ID/provider ID.
      "connectorId": "<ConnectorGuid>",
    
      // This is a list of all supported auth types. Remove the ones that the connector does not support.
      "authTypes": [ "Windows", "Basic", "Anonymous", "OAuth2ClientCredentials" ],
    
      // The list of additional crawl types that the connector supports in addition to full and periodic full crawl. This is an optional field.
      "additionalCrawlsSupported": [ "Incremental" ]
    }
    
    
    • connectorId debe ser un GUID. Este campo es el mismo que ConnectorUniqueId en el archivo de implementación de Connector Info Service o el GUID que defina.
    • AuthTypes debe ser una matriz no vacía con uno o varios de los tipos siguientes: Anonymous, Basic, Windows, OAuth2ClientCredentials.
    • additionalCrawlsSupported es opcional; puede definir tipos de rastreo además del rastreo completo y periódico, en función de la implementación y la compatibilidad con el origen de datos. Actualmente, solo Incremental el rastreo está disponible como una opción.

Escenarios de prueba

La utilidad de prueba tiene cinco opciones:

  • Conectividad de prueba con el servicio del conector: comprueba que la utilidad de prueba puede conectarse al conector especificado en ConnectionInfo.json a través del puerto especificado para ese identificador de conector en CustomConnectorPortMap.json.

Captura de pantalla de la salida de la utilidad de prueba que muestra el primer escenario de prueba completado

  • Test connection creation flow (ValidateAuthentication, ValidateCustomConfiguration, GetDataSourceSchema API): valida los métodos especificados en ConnectionManagementService. Invoca cada uno de los métodos y muestra los resultados en la consola.

Captura de pantalla de la salida de la utilidad de prueba que muestra el segundo escenario de prueba completado

  • Validar manifiesto: valida el contenido de manifest.json. Comprueba si se implementan las API relacionadas con la información proporcionada en el manifiesto. La aplicación de prueba devuelve el manifiesto actualizado después de la validación. Use este manifiesto validado para pruebas y uso adicionales.

Captura de pantalla de la salida de la utilidad de prueba que muestra el tercer escenario de prueba completado

  • Prueba del rastreo del origen de datos con conexión simulada: prueba los métodos de ConnectorCrawlerService. Invoca el rastreo con la programación especificada en ConnectionInfo.json e imprime el estado del rastreo en curso o completado por última vez cada minuto. Cuando el primer rastreo finaliza correctamente, muestra el mensaje de que el rastreo se ha completado y la plataforma sigue ejecutándose para desencadenar rastreos adicionales en el intervalo especificado en ConnectionInfo.json. Si especifica una frecuencia de rastreo incremental en el archivo ConnectionInfo.json, desencadena el rastreo incremental después del primer rastreo completo.

Captura de pantalla de la salida de la utilidad de prueba que muestra el cuarto escenario de prueba completado

  • Probar el flujo de publicación de conexión de un extremo a otro: valida todo el flujo desde la creación de la conexión personalizada hasta el rastreo del origen de datos. Se le pedirá que proporcione entradas en la misma secuencia que el flujo de publicación de conexión del Centro de Administración de Microsoft 365. La validación se produce en cada paso en función de las entradas.

Captura de pantalla de la salida de la utilidad de prueba que muestra el quinto escenario de prueba completado

Para impedir que la utilidad rastree el origen de datos, cierre y reinicie el archivo ejecutable GraphConnectorAgentTest. A continuación, puede elegir una opción de prueba diferente o volver a probar una opción después de actualizar el código del conector o los archivos de configuración.

¿Cómo funciona el archivo ejecutable GraphConnectorAgentTest?

Al abrir el archivo ejecutable GraphConnectorAgentTest, se lee el archivo de configuración de ConnectionInfo.json. Después de seleccionar una de las opciones de prueba, intentará conectarse al conector especificado a través del puerto indicado en el archivo de configuración CustomConnectorPortMap. Una vez que se conecta, la plataforma llama a los métodos pertinentes.

Al probar el flujo de creación de conexiones o el rastreo del origen de datos, especifique las credenciales para acceder al origen de datos en el archivo de configuración de ConnectionInfo.json. La plataforma lee las credenciales y las pasa al conector para acceder al origen de datos. Siempre que nadie más tenga acceso al archivo de configuración ConnectionInfo.json, las credenciales son seguras.