Aplicativo de teste SDK de conectores Copilot

O arquivo executável GraphConnectorAgentTest é um utilitário de teste para o conector personalizado. Ele não cria conexões nem adiciona dados ao índice da Microsoft. O utilitário de teste é executado no computador no qual você instalou o agente e não se conecta a recursos externos, exceto para a fonte de dados que faz parte do teste. Você pode encontrar o aplicativo de teste na pasta TestApp na pasta de instalação do agente do conector do Microsoft Graph.

Atualize os seguintes arquivos de configuração para usar este utilitário de teste:

• ConnectionInfo.json: esse arquivo contém todas as informações sobre a conexão - a ID do conector que identifica o conector personalizado para o qual essa conexão está sendo criada, a URL da fonte de dados, as credenciais para acessar a fonte de dados, o esquema associado à conexão e parâmetros extras para a conexão. Este arquivo de configuração está na pasta Config do aplicativo de teste.

• CustomConnectorPortMap.json: depois de criar o conector personalizado, adicione o mapeamento da ID do conector e a porta na qual ele está sendo executado nesse arquivo. Este arquivo está na pasta de instalação do agente do conector do Microsoft Graph.

  

  Observação

  Você pode adicionar várias IDs de conector e suas informações de porta correspondentes a esse arquivo usando o formato Id> do <Conector:<Porta>. Cada conector exclusivo deve estar em execução em uma porta diferente.

• Manifest.json: O arquivo de manifesto é necessário para identificar um conector e sua configuração ao publicar uma conexão por meio do Centro Administração Microsoft 365. Atualize este arquivo de manifesto para usá-lo para validação neste aplicativo de teste. Esse arquivo está na pasta Config do aplicativo de teste.

  Forneça os detalhes do manifesto no seguinte formato:

  {
    // 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 deve ser um GUID. Esse campo é igual a ConnectorUniqueId no arquivo de implementação do Serviço de Informações do Conector ou o GUID que você definir.
  • AuthTypes deve ser uma matriz não vazia com um ou mais dos seguintes tipos: Anonymous, Basic, Windows, OAuth2ClientCredentials.
  • additionalCrawlsSupported é opcional; Você pode definir tipos de rastreamento, além do rastreamento completo e periódico, dependendo da sua implementação e do suporte à fonte de dados. Apenas Incremental o rastreamento está disponível como uma opção no momento.

Cenários de teste

O utilitário de teste tem cinco opções:

• Teste a conectividade com o serviço do conector: verifica se o utilitário de teste pode se conectar ao conector especificado no ConnectionInfo.json pela porta especificada para essa ID do conector no CustomConnectorPortMap.json.

• Testar fluxo de criação de conexão (APIs ValidateAuthentication, ValidateCustomConfiguration, GetDataSourceSchema): valida os métodos especificados em ConnectionManagementService. Ele invoca cada um dos métodos e exibe os resultados no console.

• Validar manifesto: valida o conteúdo de manifest.json. Ele verifica se as APIs relacionadas às informações fornecidas no manifesto estão implementadas. O aplicativo de teste retorna o manifesto atualizado após a validação. Use esse manifesto validado para testes e uso adicionais.

• Testar rastreamento de fonte de dados com conexão simulada: testa os métodos em ConnectorCrawlerService. Ele invoca o rastreamento com a programação especificada no ConnectionInfo.json e imprime o status do rastreamento em andamento ou concluído pela última vez a cada minuto. Quando o primeiro rastreamento é concluído com êxito, ele exibe a mensagem de que o rastreamento foi concluído e a plataforma continua em execução para disparar rastreamentos adicionais no intervalo especificado no ConnectionInfo.json. Se você especificar uma frequência de rastreamento incremental no arquivo ConnectionInfo.json, ele disparará o rastreamento incremental após o primeiro rastreamento completo.

• Testar fluxo de publicação de conexão de ponta a ponta: valida todo o fluxo, desde a criação da conexão personalizada até o rastreamento da fonte de dados. Você será solicitado a fornecer entradas na mesma sequência do fluxo de publicação da conexão do Centro de Administração Microsoft 365. A validação ocorre em cada etapa com base em suas entradas.

Para impedir que o utilitário rastreie a fonte de dados, feche e reinicie o arquivo executável GraphConnectorAgentTest. Em seguida, você pode escolher uma opção de teste diferente ou testar novamente uma opção depois de atualizar o código do conector ou os arquivos de configuração.

Como funciona o arquivo executável GraphConnectorAgentTest?

Quando você abre o arquivo executável GraphConnectorAgentTest, ele lê o arquivo de configuração ConnectionInfo.json. Depois de selecionar uma das opções de teste, ele tentará se conectar ao conector especificado pela porta indicada no arquivo de configuração CustomConnectorPortMap. Depois de se conectar, a plataforma chama os métodos relevantes.

Ao testar o fluxo de criação da conexão ou o rastreamento da fonte de dados, especifique as credenciais para acessar a fonte de dados no arquivo de configuração ConnectionInfo.json. A plataforma lê as credenciais e as passa para o conector para acessar a fonte de dados. Desde que ninguém mais tenha acesso ao arquivo de configuração ConnectionInfo.json, as credenciais estão seguras.

Conteúdo relacionado

• Práticas recomendadas
• Solução de Problemas