Bearbeiten von „Datei helper test.dart“

= Link =
* [[Projekt dgrep]]

= Zielsetzung =
Die Datei helper_test.dart enthält die Unittests der [[Datei helper.dart]].

Für jede Funktion aus helper.dart existiert mindestens ein Test.

= Import =
<pre>
import 'dart:io';
import 'package:dgrep/helper.dart';
import 'package:test/test.dart';
import 'package:args/args.dart';
import 'package:path/path.dart' as path;
</pre>
* <code>import 'package:dgrep/helper.dart';</code> Damit kennt der Parser die Definitionen aus helper.dart.
* Die anderen Importe betreffen das interne Paket <code>dart:io</code> und die externen Pakete <code>args</code>, <code>test</code> und <code>path</code>.
* <code>import 'package:path/path.dart' as path;</code> 
** Es gibt folgendes Problem: die Pakete test und path enthalten jeweils eine Funktion <code>equals()</code>.
** Zur Auflösung des Konflikts wird der Zugriffsname <code>path</code> (hinter '''as''') definiert, das bedeutet dass alle Zugriffen auf Namen aus dem Paket mit einem <code>path.</code> erfolgen müssen, beispielsweise <code>path.join()</code>.
** Der Zugriffsname könnte auch <code>blabla</code> heißen, per Konvention wird aber der Paketname verwendet.

= Die Tests =
<pre>void main() {
 group('argument handling', () {
    test('testIntArguments', () {
      final parser = ArgParser();
      parser.addOption('count');
      parser.addOption('positive-number');
      parser.addFlag('recursive');
      final result = parser
          .parse(['--positive-number', '33', '--recursive', '--count=nix']);
      var message;
      expect(
          testIntArguments(
              result, ['positive-number'], (error) => message = error),
          true);
      expect(
          testIntArguments(
              result, ['positive-number', 'count'], (error) => message = error),
          false);
      expect(message, contains('count is not an integer: nix'));
    });
    test('testRegExpArguments', () {
... 
    });
  });
  test('regExpEscape', () {
    expect(regExpEscape('()[]{}?*+-|^\$\\.&~# '), equals('\\(\\)\\[\\]\\{\\}\\?\\*\\+\\-\\|\\^\\\$\\\\\\.\\&\\~\\#\\ '));
    expect(regExpEscape('abc.123'), equals(r'abc\.123'));
    expect(regExpEscape(''), equals(r''));
    expect(regExpEscape(null), isNull);
  });
  ...
}
</pre>
* <code>group('argument handling', () {</code> Es wird eine Gruppe definiert, die laut Beschreibung die Argumentbehandlung testet, das sind zwei Funktionen <code>testIntArguments()</code> und <code>testRegExpArguments()</code>.
* <code>final parser = ArgParser();</code> Damit beginnt die Vorbereitung auf den Test: ein <code>ArgParser</code>-Objekt wird instantiiert.
* Es werden drei Optionen eingetragen, eines davon ist ein Flag (Boolsche Option).
* <code>result = parser.parse(['--positive-number', '33', '--recursive', '--count=nix']);</code>
** Der Parser untersucht die übergebene Argumentliste auf Optionen.
** Das Ergebnis ist ein Objekt vom Typ <code>ArgResults</code>, das als Parameter für die zu testenden Funktionen <code>testIntArguments()</code> und <code>testRegExpArguments()</code> gebraucht wird.
* Damit ist die Vorbereitung eines "vernünftigen" Tests fertig.
* Die Funktion <code>expect()</code> hat als ersten Parameter den zu testenden Wert, als zweiten den erwarteten Wert.
** Wir testen den Aufruf von <code>testIntArguments()</code> und erwarten den Wert <code>true</code>, da die Option "--positive-number" korrekt benutzt wurde.
** Im zweiten Aufruf wird mit dem Parameter <code>count</code> eine Option getestet, die mit dem String <code>nix</code> falsch vewendet wurde, wir erwarten also als Funktionsergebnis von <code>testIntArguments</code> den Wert <code>false</code>.
* Der dritte Parameter von  <code>testIntArguments()</code> ist eine Callbackfunktion, die eine Fehlermeldung als Parameter übergeben bekommt. In unserem Test speichern wir diese Meldung in der lokalen Variablen <code>message</code>.
* <code>expect(message, contains('excluded: error in regular expression'));</code>
** Hier wird die obige Variable auf die korrekte Fehlermeldung untersucht.
* Nach der Gruppe folgen Tests, die keine Gruppe haben. Das ist korrekt.
* Der erste Test außerhalb der Gruppe hat die Beschreibung 'regExpEscape'.
* Zuerst werden alle Metazeichen auf einmal getestet, ob alle mit dem vorausgehenden Gegenstrich markiert werden.
* Danach folgt der Test von einem gängigen Beispiel mit und ohne Metazeichen.
* Es folgen zwei Tests mit Grenzbereichen, dem Leerstring als Parameter und der <code>null</code>.
* Es folgen Tests nach dem gleichen Schema.
Der Test von <code>isBinary()</code> ist deshalb interessant, weil hier erst mal Daten für den Test erstellt werden müssen: Wie schreibe ich binäre Daten in eine Datei?
<pre>test('isBinary', () {
  final base = path.join(Directory.systemTemp.path, 'helper');
  final file1 = path.join(base, 'notBinary.01');
  writeString(file1, string: 'abc\r\n\t\f');
  expect(isBinary(file1), isFalse);
  final file2 = File(path.join(base, 'binary.02'));
  final handle1 = file2.openSync(mode: FileMode.write);
  handle1.writeByteSync(0);
  handle1.writeByteSync(33);
  handle1.closeSync();
  expect(isBinary(file2.path), isTrue);
  final file3 = File(path.join(base, 'binary.02'));
  final handle2 = file3.openSync(mode: FileMode.write);
  for (var no = 1; no < 32; no++) {
    handle2.writeByteSync(no);
  }
  handle2.closeSync();
  expect(isBinary(file3.path), isTrue);
});
</pre>
* <code>final base = path.join(Directory.systemTemp.path, 'helper');</code> Damit der Test plattformunabhängig ist, also unter Linux und Windows funktioniert, fragen wir mit <code>Directory.systemTemp.path</code> den Namen des temporären Verzeichnisses ab, unter Linux ist das '/tmp', unter Windows c:\temp oder ähnliches.
* <code>final file1 = path.join(base, 'notBinary.01');</code> mit der Funktion <code>join</code> aus dem Paket <code>path</code> setzen wir plattformunabhängig einen Dateinamen aus Verzeichnis und Namen zusammen.
* <code>writeString(file1, string: 'abc\r\n\t\f');</code> schreibt einen normalen Text in eine Datei (siehe [[Datei helper.dart]]).
* <code>expect(isBinary(file1), isFalse);</code> Eine normale Textdatei ist nicht binär, wir erwarten als Ergebnis also <code>false</code>.
* <code>final handle1 = file2.openSync(mode: FileMode.write);</code> Damit öffnen wir eine Datei zum Schreiben.
* <code>handle1.writeByteSync(0);</code> Wir schreiben das Byte <code>0</code> in die Datei, danach noch ein weiteres Byte mit der Nummer 33 (das ist das Ausrufezeichen).
* <code>handle1.closeSync();</code> Wer eine Datei öffnet, muss sie auch schließen, sonst werden Resourcen nicht freigegeben.
* Jetzt habe wir eine binäre Datei, die wir testen können. <code>expect(isBinary(file2.path), isTrue);</code>
* Nach unserer Definition liegt auch dann eine Binärdatei vor, wenn mehr als 25% der Zeichen Kontrollzeichen sind.
* <code>for (var no = 1; no < 32; no++)</code> Mit dieser Schleife schreiben wir 30 Zeichen, die meisten Kontrollzeichen, in die zweite Datei.