Freigeben über

Microsoft Graph Connectors SDK-Testanwendung

  • Artikel

Die ausführbare GraphConnectorAgentTest-Datei ist ein Testhilfsprogramm für den benutzerdefinierten Connector. Es werden keine Verbindungen erstellt oder dem Microsoft-Index Daten hinzugefügt. Das Testhilfsprogramm wird auf dem Computer ausgeführt, auf dem Sie den Agent installiert haben, und stellt mit Ausnahme der Datenquelle, die Teil des Tests ist, keine Verbindung mit externen Ressourcen her. Sie finden die Testanwendung im Ordner TestApp im Installationsordner des Microsoft Graph-Connector-Agents.

Aktualisieren Sie die folgenden Konfigurationsdateien, um dieses Testhilfsprogramm zu verwenden:

  • ConnectionInfo.json: Diese Datei enthält alle Informationen zur Verbindung– die Connector-ID, die den benutzerdefinierten Connector identifiziert, für den diese Verbindung erstellt wird, die Datenquellen-URL, Anmeldeinformationen für den Zugriff auf die Datenquelle, das der Verbindung zugeordnete Schema und zusätzliche Parameter für die Verbindung. Diese Konfigurationsdatei befindet sich im Ordner Config der Testanwendung.

  • CustomConnectorPortMap.json: Nachdem Sie den benutzerdefinierten Connector erstellt haben, fügen Sie der Datei die Zuordnung der Connector-ID und des Ports hinzu, auf dem er ausgeführt wird. Diese Datei befindet sich im Installationsordner des Microsoft Graph-Connector-Agents.

    Screenshot der Portzuordnung in der CustomConnectorPortMap.json-Datei.

    Hinweis

    Sie können dieser Datei mehrere Connector-IDs und die entsprechenden Portinformationen hinzufügen, indem Sie das <Connector-ID>:<Port-Format> verwenden. Jeder eindeutige Connector sollte an einem anderen Port ausgeführt werden.

  • Manifest.json: Die Manifestdatei ist erforderlich, um einen Connector und seine Konfiguration zu identifizieren, während eine Verbindung über das Microsoft 365 Admin Center veröffentlicht wird. Aktualisieren Sie diese Manifestdatei, um sie für die Überprüfung in dieser Testanwendung zu verwenden. Diese Datei befindet sich im Ordner Config der Testanwendung.

    Geben Sie die Manifestdetails im folgenden Format an:

    {
  // 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 sollte eine GUID sein. Dieses Feld ist identisch mit ConnectorUniqueId in der Implementierungsdatei des Connector Info Service oder der GUID, die Sie definieren.
    • AuthTypes muss ein nicht leeres Array mit einem oder mehreren der folgenden Typen sein: Anonymous, Basic, Windows, OAuth2ClientCredentials.
    • additionalCrawlsSupported ist optional. Sie können zusätzlich zur vollständigen und regelmäßigen vollständigen Durchforstung auch Durchforstungstypen definieren, je nach Implementierung und Datenquellenunterstützung. Derzeit ist nur Incremental die Durchforstung als Option verfügbar.

Testszenarien

Das Testhilfsprogramm verfügt über fünf Optionen:

  • Testen der Konnektivität mit dem Connectordienst: Überprüft, ob das Testhilfsprogramm eine Verbindung mit dem in ConnectionInfo.json angegebenen Connector über den port herstellen kann, der für diese Connector-ID in CustomConnectorPortMap.json angegeben wurde.

Screenshot der Ausgabe des Testhilfsprogramms mit dem ersten abgeschlossenen Testszenario

  • Testen des Verbindungserstellungsflows (ValidateAuthentication, ValidateCustomConfiguration, GetDataSourceSchema-APIs): Überprüft die in ConnectionManagementService angegebenen Methoden. Es ruft jede der Methoden auf und zeigt die Ergebnisse in der Konsole an.

Screenshot der Ausgabe des Testhilfsprogramms mit dem zweiten abgeschlossenen Testszenario

  • Manifest überprüfen: Überprüft den Inhalt von manifest.json. Es überprüft, ob die APIs im Zusammenhang mit den im Manifest bereitgestellten Informationen implementiert sind. Die Testanwendung gibt das aktualisierte Manifest nach der Überprüfung zurück. Verwenden Sie dieses überprüfte Manifest für weitere Tests und die Verwendung.

Screenshot der Ausgabe des Testhilfsprogramms mit abgeschlossenen dritten Testszenarios

  • Testen der Datenquellendurchforstung mit simulierter Verbindung: Testet die Methoden in ConnectorCrawlerService. Es ruft die Durchforstung mit dem in ConnectionInfo.json angegebenen Zeitplan auf und gibt jede Minute die status der laufenden oder letzten abgeschlossenen Durchforstung aus. Wenn die erste Durchforstung erfolgreich abgeschlossen wurde, wird die Meldung angezeigt, dass die Durchforstung abgeschlossen wurde, und die Plattform wird weiterhin ausgeführt, um zusätzliche Durchforstungen in dem in ConnectionInfo.json angegebenen Intervall auszulösen. Wenn Sie in der ConnectionInfo.json Datei eine inkrementelle Durchforstungshäufigkeit angeben, wird die inkrementelle Durchforstung nach der ersten vollständigen Durchforstung ausgelöst.

Screenshot der Ausgabe des Testhilfsprogramms mit dem vierten abgeschlossenen Testszenario

  • Testen des End-to-End-Verbindungsveröffentlichungsflows: Überprüft den gesamten Flow vom Erstellen der benutzerdefinierten Verbindung bis zum Durchforsten der Datenquelle. Sie werden aufgefordert, Eingaben in der gleichen Reihenfolge wie den Microsoft 365 Admin Center-Verbindungsveröffentlichungsflow zu geben. Die Überprüfung erfolgt bei jedem Schritt basierend auf Ihren Eingaben.

Screenshot der Ausgabe des Testhilfsprogramms mit dem fünften abgeschlossenen Testszenario

Um zu verhindern, dass das Hilfsprogramm die Datenquelle durchforstet, schließen Sie die ausführbare GraphConnectorAgentTest-Datei, und starten Sie sie neu. Sie können dann eine andere Testoption auswählen oder eine Option erneut testen, nachdem Sie den Connectorcode oder die Konfigurationsdateien aktualisiert haben.

Wie funktioniert die ausführbare GraphConnectorAgentTest-Datei?

Wenn Sie die ausführbare GraphConnectorAgentTest-Datei öffnen, liest sie die ConnectionInfo.json Konfigurationsdatei. Nachdem Sie eine der Testoptionen ausgewählt haben, wird versucht, über den in der CustomConnectorPortMap-Konfigurationsdatei angegebenen Port eine Verbindung mit dem angegebenen Connector herzustellen. Nachdem die Verbindung hergestellt wurde, ruft die Plattform die relevanten Methoden auf.

Wenn Sie den Verbindungserstellungsflow oder die Datenquellendurchforstung testen, geben Sie die Anmeldeinformationen für den Zugriff auf die Datenquelle in der ConnectionInfo.json Konfigurationsdatei an. Die Plattform liest die Anmeldeinformationen und übergibt sie an den Connector, um auf die Datenquelle zuzugreifen. Solange niemand anderes Zugriff auf die ConnectionInfo.json Konfigurationsdatei hat, sind die Anmeldeinformationen sicher.

Verwandte Inhalte