Kapitel 4. Validierungsregeln in Excel-Dateien

Eine Excel-Datei wird nach Tabellenblättern (Sheets) mit festgelegten Namen durchsucht:

Alle drei Tabellenblätter haben einen festgelegten Aufbau, der in den nachfolgenden Abschnitten beschrieben wird. In allen drei Tabellenblättern bewirkt ein Stern '*' in der ersten Spalte, dass die Zeile als Kommentar gilt.

Die Reihenfolge der Spalten darf nicht geändert werden. Zusätzliche, individuelle Spalten hinter den festgelegten Spalten sind erlaubt. Zusätzliche Tabellenblätter in der Excel-Datei stören ebenfalls nicht.

Ein Tabellenblatt darf Leerzeilen enthalten. Falls ein Blatt aber zu viele leere Zeilen hat, kann es passieren, dass die letzten Zeilen mit Daten nicht mehr ausgelesen werden. Deshalb sollten leere Zeilen nicht verwendet werden. Setzen Sie in Spalte 1 einen Stern, dann gilt die Zeile als nicht-leer und bereitet keine technischen Probleme.

Zusätzlich zu der Angabe von Seiten, ist es fast immer notwendig, Tests lediglich auf Ausschnitte einzelner Seiten zu beschränken. So macht ein Vergleich zweier Dokumente mit dem Text der vollen Seiten häufig keinen Sinn, weil sich die Dokumente in ihrem Datum unterscheiden. Deshalb erwartet PDFUnit, dass jeder Test in Excel einen Seitenausschnitt referenziert. Alle Seitenausschnitte werden in dem Sheet 'regions' definiert.

Ein Seitenausschnitt wird durch 4 Werte beschrieben: die x/y-Koordinaten der linken oberen Ecke und die Breite und Höhe des Ausschnitts. Alle Werte sind Millimeter-Angaben. Die Werte dürfen zwar Nachkommastellen haben, jedoch werden die Nachkommastellen auf die nächste Ganzzahl gerundet. Das nächste Bild zeigt ein Beispiele für Ausschnitte:

Wie zu erkennen ist, enthält das Tabellenblatt neben den 4 Werten für die Ausschnitte noch die Spalte mit der Überschrift id. Jeder Ausschnitt muss eine eindeutige ID besitzen. Diese ID wird von den Testfalldeklarationen in den Tabellenblättern 'check' und 'compare' referenziert.

Das Tabellenblatt 'check' dient zur Erfassung aller Informationen, die für Testfälle benötigt werden, die sich auf Einzeldokumente beziehen, also nicht für Testfälle, bei denen zwei Dokumente miteinander verglichen werden. Das sind:

Ein Testfall bezieht sich häufig auf bestimmte Seiten eines Dokumentes. Deshalb können die gewünschten Seiten spezifiziert werden. Die folgende Liste zeigt alle verfügbaren Beispiele:

Zwei Seitenzahlen müssen durch ein Leerzeichen getrennt werden. Das Komma ist optional, es dient lediglich der besseren Lesbarkeit.

Die Spalte 'constraint' dient dazu, festzulegen, welche Prüfungen durchgeführt werden sollen, ob beispielsweise ein bestimmter Text in einem Bereich enthalten sein soll ('must contain') oder ob dieser Text gerade nicht in dem Bereich enthalten sein darf ('must not contain'). Die folgende Liste zeigt die mögliche Werte der Spalte 'constraint' im Tabellenblatt 'check' für Textvergleiche:

Wichtig: die Spalte 'constraint' darf nicht leer sein. In einem solchen Fall bringt das System eine Fehlermeldung.

Im Tabellenblatt 'compare' sind in der Spalte 'constraint' andere Werte erlaubt. Sie werden weiter unten erläutert.

Weiterhin kann die Spalte 'constraint' im Tabellenblatt 'check' auch Schlüsselwörter für Tests auf Unterschriften und Bilder enthalten:

Textvergleiche können an Leerzeichen und Zeilenumbrüchen scheitern. Schon bei einem Wechsel der Schriftart können andere Zeilenumbrüche entstehen. Um Tests davon unabhängig zu machen, kann PDFUnit auf dreierlei Arten mit Whitespaces umgehen:

Fehlerhafte Whitespace-Werte führen zu einer Fehlermeldung. Die Spalte 'whitespace' darf aber leer gelassen werden. In dem Falle gilt 'normalize' als Voreinstellung.

Beim Vergleich zweier PDF-Dokumente spielen Whitespaces nicht immer eine Rolle, beispielsweise beim Vergleich von Lesezeichen (Bookmarks). In den Fälle wird eine vorhandene Angabe der Whitespace-Behandlung ignoriert.

Wenn eine Prüfung gegen einen Erwartungswert stattfindet, muss es eine Spalte geben, die diesen Wert aufnimmt. Diese Spalte heißt 'expected value'.

Der Inhalt der Spalte 'expected value' wird als Regulärer Ausdruck interpretiert, wenn die Spalte 'constraint' die Werte 'must match' oder 'must not match' enthält. Informationen über reguläre Ausdrücke gibt es im Internet unter anderem bei selfhtml.

Der Inhalt der Spalte 'expected value' wird in eine Ganzzahl umgewandelt, wenn die Spalte 'constraint' den Text 'has number of images' enthält.

In den Excel-Dateien können auch individuelle Fehlermeldung hinterlegt werden, die im Fehlerfalle zusätzlich zu den Standardmeldungen von PDFUnit ausgegeben werden. Eine solche Fehlermeldung kann Platzhalter für Laufzeitinformationen enthalten. Das folgende Bild zeigt mehrere Beispiele:

Wie aus dem Bild ersichtlich ist, werden Platzhalter im Text in geschweifte Klammern eingefasst. Folgende Platzhalter können benutzt werden:

Die Platzhalter können an beliebiger Stelle im Text eingebaut werden. Die Werte des aktuellen Tests für die Platzhalter werden zur Laufzeit in Hochkommata eingefasst. Insofern müssen solche Hochkommata im Meldungstext nicht berücksichtigt werden.

Mit Excel-Validierungsregeln können auch vergleichende Tests durchgeführt werden. Dabei wird das aktuelle PDF-Dokument gegen eine Vorlage verglichen.

Vergleichendes Testen hat zur Folge, dass in der Excel-Datei keine Angabe mehr über einen erwarteten Text gemacht werden muss. Somit entfällt im Tabellenblatt 'compare' die Spalte 'expected value'. Es verbleiben diese:

Die Bedeutungen der Spalten ändert sich nicht, sie sind in den vorhergehenden Abschnitten beschrieben. Lediglich die erlaubten Werte für die Spalte 'constraint', also die Angabe, wie ein Test ausgeführt werden soll, hat sich geändert. Für Vergleiche sind folgende Constraint-Typen erlaubt:

Ein Test, Lesezeichen eines PDF-Dokumentes mit einer Vorlage zu vergleichen, sieht folgendermaßen aus:

PDFUnit sucht die PDF-Dokumente für einen Vergleichs im Unterverzeichnis mit dem Namen 'reference' direkt unterhalb des Verzeichnisses der gerade im Test befindlichen PDF-Datei. Dort wird eine Datei mit dem gleichen Namen, wie die aktuelle Test-PDF-Datei geladen.

Eine Validierung eines PDF-Dokumentes gegen einer Excel-Datei endet nicht mit dem ersten erkannten Fehler. Alle Regeln werden durchlaufen. Für jede Regelverletzung wird eine Fehlermeldung erzeugt.