senfgurke

Senfgurke

Senfgurke ist ein beispielgesteuertes Testframework für VBA. Was bedeutet das? Mit Senfgurke können Sie in natürlicher Sprache gegebene Beispiele in automatisierte Tests umwandeln, die von VBA (Visual Basic for Applications) ausgeführt werden.

• Einführung
• Aufstellen
• Funktionelles Design
• Architektur

VORSICHT! Dies ist in Arbeit. Zukünftige Versionen könnten Ihren Testautomatisierungscode von älteren Versionen beschädigen!

Einführung

Stellen Sie sich vor, jemand bittet Sie, eine neue „spezielle“ Summenfunktion für Excel zu schreiben, die dem Ergebnis den Wert 1 hinzufügt, indem er Ihnen dieses Beispiel gibt:

 Example: add +1 to sum
  Given a is 2
    And b is 3
   When sum+1 is applied to a and b
   Then the result is 6

Sie können dieses Beispiel nun zu einer Funktion hinzufügen und alles in der Datei „sum_plus_one.feature“ in einem Verzeichnis mit dem Namen „features“ speichern. Das Verzeichnis sollte sich am selben Ort befinden wie Ihre Office-Datei, die Ihren VBA-Code enthält.

Wenn Sie Senfgurke zum ersten Mal ausführen, wird Ihnen vorgeschlagen, eine neue Funktion wie diese hinzuzufügen:

 Public Sub Given_a_is_INT_C722764574FB(step_parameters As Collection)
    'Given a is 2

End Sub

Bitte nicht mit dem C722764574FB-Teil des Funktionsnamens verwechseln. Dieser Hashwert hilft Senfgurke, die Funktion mit dem ursprünglichen Schritt aus dem Beispiel abzugleichen. Jetzt liegt es an Ihnen, die Funktion mit Code zu füllen, damit Sie Ihre neue Funktion testen können, um sicherzustellen, dass sum+1 die richtigen Ergebnisse liefert.

Wenn Sie dies für jeden Schritt des Beispiels wiederholt haben und Senfgurke ausführen, erhalten Sie möglicherweise Folgendes auf der Konsole:

 Feature: sum plus one


  Rule: add one to sum results

    Example: add +1 to sum
     OK       Given a is 2
     OK       And b is 3
     OK       When sum+1 is applied to a and b
     OK       Then the result is 6

Auf diese Weise teilt Ihnen Senfgurke mit, ob Ihr Code erfolgreich war oder einen Fehler verursacht hat.

Aufstellen

Senfgurke wird als anwendungsspezifisches Add-In bereitgestellt. Auf diese Weise können Sie die zu testende Anwendung einfach vom Senfgurke-Testframework trennen. Um eine neue VBA-Anwendung zu starten, gehen Sie folgendermaßen vor:

1. Aktivieren Sie das Senfgurke-Add-In für Ihre Anwendung
2. Erstellen Sie ein neues Dokument für Ihren Code (z. B. eine neue XLM-Datei für Excel).
3. Importieren Sie das TRun-Modul aus step_definitions/TRun.bas in Ihre Anwendung
4. Fügen Sie einen Verweis auf das Senfgurke-Add-In für Ihre Anwendung in der VBA-IDE hinzu
5. Erstellen Sie ein neues Verzeichnis mit dem Namen „features“ im selben Verzeichnis Ihrer Anwendung (dem Dokument, das Ihren VBA-Code enthält).
6. Erstellen Sie Ihre erste Gherkin-Feature-Datei unter Features (fügen Sie mindestens 1 Beispiel hinzu).
7. Führen Sie TRun.test über das Direktfenster in Ihrer VBA-IDE aus
8. Fügen Sie Ihrer Anwendung eine neue Klasse „Step_“ hinzu
9. Kopieren Sie den vorgeschlagenen Code für die Schrittfunktionen aus dem Direktfenster in Ihre Step-Klasse
10. Registrieren Sie Ihre Step-Klasse, indem Sie die StepImplementations-Eigenschaft im TRun-Modul erweitern

Funktionelles Design

Die folgende Ereigniskarte erklärt, was passiert, wenn Sie Senfgurke bitten, Ihre Funktionen auszuführen.

Führen Sie einen Test durch

Tests werden normalerweise über das VBA-Konsolenfenster gestartet. Auf diese Weise können Sie Tags oder Filter (für Dateinamen) hinzufügen, um den Testlauf auf bestimmte Tags oder Feature-Dateien zu beschränken.

Feature-Dateien laden

Als Erstes sucht Senfgurke nach Feature-Dateien und lädt sie zur späteren Verarbeitung in den Speicher.

Funktionen analysieren

Da alle Funktionen im Speicher vorhanden sind, kann Senfgurke die Gherkin-Sprache einfacher in detaillierte Anweisungen für die spätere Ausführung übersetzen (analysieren). Beispiele ohne passende Tags, die beim Teststart festgelegt wurden, können beispielsweise für die spätere Ausführung ignoriert werden oder Hintergrundschritte einer Funktion werden zu jedem Beispiel (auch Szenario genannt) in dieser Funktion hinzugefügt.

Funktionen ausführen

Im nächsten Schritt geht es natürlich darum, alle detaillierten Ausführungsanweisungen aus dem vorherigen Schritt auszuführen. Dazu gehört auch die Rückgabe aller Ergebnisse der Ausführung.

Ergebnisse melden

Parallel zur Ausführung der oben genannten Funktionen werden Ergebnisse in verschiedenen Formaten gemeldet. Standard ist das ausführliche Format, das die Gherkin-Funktionen in das VBA-Konsolenfenster schreibt, indem einfach das Ausführungsergebnis zu jedem Schritt der Beispiele hinzugefügt wird.

Statistiken melden

Am Ende jedes Testlaufs fügt Senfgurke einige Statistiken hinzu, beispielsweise Dauer und Anzahl der ausgeführten Beispielschritte.

Noch etwas

Eine ausführlichere Dokumentation finden Sie in den Feature-Dateien für Senfgurke, beginnend mit dem vom Feature Indexer generierten Index.

Architektur

Das FMC-Blockdiagramm zeigt, dass der typische Aufbau aus drei Schichten besteht:

1. Das Betriebssystem stellt den Speicher für die Funktionsdateien bereit.
2. Das Senfgurke-Add-In enthält alle Funktionen, um Beispielschritte (auch Szenario-Schritte genannt) aus Feature-Dateien mit passenden Schrittfunktionen abzugleichen.
3. Die oberste Ebene wird durch die zu testende Anwendung dargestellt (typischerweise ein Office-Dokument mit VBA-Code).

Allgemeine Entscheidungen

Einige allgemeine Entscheidungen finden Sie im Architekturentscheidungsprotokoll.

Ziele

Besorgniserregende Trennungen

Die mehrschichtige Architektur soll sicherstellen, dass die von Senfgurke bereitgestellte Funktionalität von der Anwendungslogik getrennt ist.

TBC