Microsoft Graph 连接器 SDK 测试应用程序

GraphConnectorAgentTest 可执行文件是自定义连接器的测试实用工具。 它不会创建连接或将数据添加到 Microsoft 索引中。 测试实用工具在安装了代理的计算机上运行，并且不会连接到外部资源，但作为测试一部分的数据源除外。 可以在 Microsoft Graph 连接器代理安装文件夹中的 TestApp 文件夹中找到测试应用程序。

更新以下配置文件以使用此测试实用工具：

• ConnectionInfo.json：此文件包含有关连接的所有信息 - 标识要为其创建此连接的自定义连接器的连接器 ID、数据源 URL、用于访问数据源的凭据、与连接关联的架构以及连接的额外参数。 此配置文件位于测试应用程序的 Config 文件夹中。

• CustomConnectorPortMap.json：创建自定义连接器后，将连接器 ID 及其上运行的端口的映射添加到此文件。 此文件位于 Microsoft Graph 连接器代理安装文件夹中。

  

  注意

  可以使用连接器 ID>：<端口>格式将多个连接器 ID 及其相应的端口信息添加到此文件<。 每个唯一的连接器都应在不同的端口上运行。

• Manifest.json：需要清单文件，以便在通过 Microsoft 365 管理 中心发布连接时标识连接器及其配置。 更新此清单文件，使其用于此测试应用程序中的验证。 此文件位于测试应用程序的 Config 文件夹中。

  按以下格式提供清单详细信息：

  {
    // 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 应为 GUID。 此字段与连接器信息服务实现文件或定义的 GUID 中的 ConnectorUniqueId 相同。
  • AuthTypes 必须是具有以下一种或多种类型的非空数组：Anonymous、、Basic、WindowsOAuth2ClientCredentials。
  • additionalCrawlsSupported 是可选的;除了完全爬网和定期完全爬网之外，还可以定义爬网类型，具体取决于实现和数据源支持。 目前只有 Incremental 爬网作为选项可用。

测试方案

测试实用工具有五个选项：

• 测试与连接器服务的连接：验证测试实用工具是否可以通过 CustomConnectorPortMap.json 中为连接器 ID 指定的端口连接到 ConnectionInfo.json 中指定的连接器。

• 测试连接创建流 (ValidateAuthentication、ValidateCustomConfiguration、GetDataSourceSchema API) ：验证 ConnectionManagementService 中指定的方法。 它会调用每个方法并在控制台上显示结果。

• 验证清单：验证manifest.json的内容。 它检查是否实现了与清单中提供的信息相关的 API。 测试应用程序在验证后返回更新的清单。 使用此验证清单进行进一步测试和使用。

• 使用模拟连接测试数据源爬网：测试 ConnectorCrawlerService 中的方法。 它使用 ConnectionInfo.json 中指定的计划调用爬网，并每隔一分钟打印正在进行的或上次完成的爬网的状态。 第一次爬网成功完成后，会显示爬网已完成的消息，并且平台会继续运行，以在 ConnectionInfo.json 中指定的时间间隔触发其他爬网。 如果在 ConnectionInfo.json 文件中指定增量爬网频率，则会在第一次完全爬网后触发增量爬网。

• 测试端到端连接发布流：验证从创建自定义连接到爬网数据源的整个流。 系统将提示你以与Microsoft 365 管理中心连接发布流相同的顺序提供输入。 根据输入在每个步骤进行验证。

若要阻止实用工具对数据源进行爬网，请关闭并重启 GraphConnectorAgentTest 可执行文件。 然后，可以选择其他测试选项，或者在更新连接器代码或配置文件后重新测试一个选项。

GraphConnectorAgentTest 可执行文件如何工作？

打开 GraphConnectorAgentTest 可执行文件时，它会读取ConnectionInfo.json配置文件。 选择其中一个测试选项后，它将尝试通过 CustomConnectorPortMap 配置文件中指示的端口连接到指定的连接器。 连接后，平台将调用相关方法。

测试连接创建流或数据源爬网时，请在ConnectionInfo.json配置文件中指定用于访问数据源的凭据。 平台读取凭据并将其传递给连接器以访问数据源。 只要没有其他人有权访问ConnectionInfo.json配置文件，凭据就是安全的。

相关内容

• 最佳做法
• 疑难解答