Add unmodifiable_collection package.

pkg/unmodifiable_collection/test/unmodifiable_collection_test.dart

+// Copyright (c) 2013, the Dart project authors.  Please see the AUTHORS file
+// for details. All rights reserved. Use of this source code is governed by a
+// BSD-style license that can be found in the LICENSE file.
+
+import "../lib/unmodifiable_collection.dart";
+import "package:unittest/unittest.dart";
+
+// Test unmodifiable collection views.
+// The collections should pass through the operations that are allowed,
+// an throw on the ones that aren't without affecting the original.
+
+main() {
+  List list = [];
+  testUnmodifiableList(list, new UnmodifiableListView(list), "empty");
+  list = [42];
+  testUnmodifiableList(list, new UnmodifiableListView(list), "single-42");
+  list = [7];
+  testUnmodifiableList(list, new UnmodifiableListView(list), "single!42");
+  list = [1, 42, 10];
+  testUnmodifiableList(list, new UnmodifiableListView(list), "three-42");
+  list = [1, 7, 10];
+  testUnmodifiableList(list, new UnmodifiableListView(list), "three!42");
+
+  list = [];
+  testNonGrowableList(list, new NonGrowableListView(list), "empty");
+  list = [42];
+  testNonGrowableList(list, new NonGrowableListView(list), "single-42");
+  list = [7];
+  testNonGrowableList(list, new NonGrowableListView(list), "single!42");
+  list = [1, 42, 10];
+  testNonGrowableList(list, new NonGrowableListView(list), "three-42");
+  list = [1, 7, 10];
+  testNonGrowableList(list, new NonGrowableListView(list), "three!42");
+
+  Set aSet = new Set();
+  testUnmodifiableSet(aSet, new UnmodifiableSetView(aSet), "empty");
+  aSet = new Set.from([42]);
+  testUnmodifiableSet(aSet, new UnmodifiableSetView(aSet), "single-42");
+  aSet = new Set.from([7]);
+  testUnmodifiableSet(aSet, new UnmodifiableSetView(aSet), "single!42");
+  aSet = new Set.from([1, 42, 10]);
+  testUnmodifiableSet(aSet, new UnmodifiableSetView(aSet), "three-42");
+  aSet = new Set.from([1, 7, 10]);
+  testUnmodifiableSet(aSet, new UnmodifiableSetView(aSet), "three!42");
+
+  Map map = new Map();
+  testUnmodifiableMap(map, new UnmodifiableMapView(map), "empty");
+  map = new Map()..[0] = 2;
+  testUnmodifiableMap(map, new UnmodifiableMapView(map), "single-0");
+  map = new Map()..[3] = 2;
+  testUnmodifiableMap(map, new UnmodifiableMapView(map), "single!0");
+  map = new Map()..[0] = 2
+                 ..[1] = 1
+                 ..[2] = 0;
+  testUnmodifiableMap(map, new UnmodifiableMapView(map), "three-0");
+  map = new Map()..[3] = 2
+                 ..[1] = 1
+                 ..[2] = 3;
+  testUnmodifiableMap(map, new UnmodifiableMapView(map), "three!0");
+}
+
+void testUnmodifiableList(List original, List wrapped, String name) {
+  name = "unmodifiable-list-$name";
+  testIterable(original, wrapped, name);
+  testReadList(original, wrapped, name);
+  testNoWriteList(original, wrapped, name);
+  testNoChangeLengthList(original, wrapped, name);
+}
+
+void testNonGrowableList(List original, List wrapped, String name) {
+  name = "nongrowable-list-$name";
+  testIterable(original, wrapped, name);
+  testReadList(original, wrapped, name);
+  testWriteList(original, wrapped, name);
+  testNoChangeLengthList(original, wrapped, name);
+}
+
+void testUnmodifiableSet(Set original, Set wrapped, String name) {
+  name = "unmodifiable-set-$name";
+  testIterable(original, wrapped, name);
+  testReadSet(original, wrapped, name);
+  testNoChangeSet(original, wrapped, name);
+}
+
+void testUnmodifiableMap(Map original, Map wrapped, name) {
+  name = "unmodifiable-map-$name";
+  testReadMap(original, wrapped, name);
+  testNoChangeMap(original, wrapped, name);
+}
+
+void testIterable(Iterable original, Iterable wrapped, String name) {
+  test("$name - any", () {
+    expect(wrapped.any((x) => true), equals(original.any((x) => true)));
+    expect(wrapped.any((x) => false), equals(original.any((x) => false)));
+  });
+
+  test("$name - contains", () {
+    expect(wrapped.contains(0), equals(original.contains(0)));
+  });
+
+  test("$name - elementAt", () {
+    if (original.isEmpty) {
+      expect(() => wrapped.elementAt(0), throws);
+    } else {
+      expect(wrapped.elementAt(0), equals(original.elementAt(0)));
+    }
+  });
+
+  test("$name - every", () {
+    expect(wrapped.every((x) => true), equals(original.every((x) => true)));
+    expect(wrapped.every((x) => false), equals(original.every((x) => false)));
+  });
+
+  test("$name - expand", () {
+    expect(wrapped.expand((x) => [x, x]),
+           equals(original.expand((x) => [x, x])));
+  });
+
+  test("$name - first", () {
+    if (original.isEmpty) {
+      expect(() => wrapped.first, throws);
+    } else {
+      expect(wrapped.first, equals(original.first));
+    }
+  });
+
+  test("$name - firstWhere", () {
+    if (original.isEmpty) {
+      expect(() => wrapped.firstWhere((_) => true), throws);
+    } else {
+      expect(wrapped.firstWhere((_) => true),
+             equals(original.firstWhere((_) => true)));
+    }
+    expect(() => wrapped.firstWhere((_) => false), throws);
+  });
+
+  test("$name - fold", () {
+    expect(wrapped.fold(0, (x, y) => x + y),
+           equals(original.fold(0, (x, y) => x + y)));
+  });
+
+  test("$name - forEach", () {
+    int wrapCtr = 0;
+    int origCtr = 0;
+    wrapped.forEach((x) { wrapCtr += x; });
+    original.forEach((x) { origCtr += x; });
+    expect(wrapCtr, equals(origCtr));
+  });
+
+  test("$name - isEmpty", () {
+    expect(wrapped.isEmpty, equals(original.isEmpty));
+  });
+
+  test("$name - isNotEmpty", () {
+    expect(wrapped.isNotEmpty, equals(original.isNotEmpty));
+  });
+
+  test("$name - iterator", () {
+    Iterator wrapIter = wrapped.iterator;
+    Iterator origIter = original.iterator;
+    while (origIter.moveNext()) {
+      expect(wrapIter.moveNext(), equals(true));
+      expect(wrapIter.current, equals(origIter.current));
+    }
+    expect(wrapIter.moveNext(), equals(false));
+  });
+
+  test("$name - join", () {
+    expect(wrapped.join(""), equals(original.join("")));
+    expect(wrapped.join("-"), equals(original.join("-")));
+  });
+
+  test("$name - last", () {
+    if (original.isEmpty) {
+      expect(() => wrapped.last, throws);
+    } else {
+      expect(wrapped.last, equals(original.last));
+    }
+  });
+
+  test("$name - lastWhere", () {
+    if (original.isEmpty) {
+      expect(() => wrapped.lastWhere((_) => true), throws);
+    } else {
+      expect(wrapped.lastWhere((_) => true),
+             equals(original.lastWhere((_) => true)));
+    }
+    expect(() => wrapped.lastWhere((_) => false), throws);
+  });
+
+  test("$name - length", () {
+    expect(wrapped.length, equals(original.length));
+  });
+
+  test("$name - map", () {
+    expect(wrapped.map((x) => "[$x]"),
+           equals(original.map((x) => "[$x]")));
+  });
+
+  test("$name - reduce", () {
+    if (original.isEmpty) {
+      expect(() => wrapped.reduce((x, y) => x + y), throws);
+    } else {
+      expect(wrapped.reduce((x, y) => x + y),
+             equals(original.reduce((x, y) => x + y)));
+    }
+  });
+
+  test("$name - single", () {
+    if (original.length != 1) {
+      expect(() => wrapped.single, throws);
+    } else {
+      expect(wrapped.single, equals(original.single));
+    }
+  });
+
+  test("$name - singleWhere", () {
+    if (original.length != 1) {
+      expect(() => wrapped.singleWhere((_) => true), throws);
+    } else {
+      expect(wrapped.singleWhere((_) => true),
+             equals(original.singleWhere((_) => true)));
+    }
+    expect(() => wrapped.singleWhere((_) => false), throws);
+  });
+
+  test("$name - skip", () {
+    expect(wrapped.skip(0), equals(original.skip(0)));
+    expect(wrapped.skip(1), equals(original.skip(1)));
+    expect(wrapped.skip(5), equals(original.skip(5)));
+  });
+
+  test("$name - skipWhile", () {
+    expect(wrapped.skipWhile((x) => true),
+           equals(original.skipWhile((x) => true)));
+    expect(wrapped.skipWhile((x) => false),
+           equals(original.skipWhile((x) => false)));
+    expect(wrapped.skipWhile((x) => x != 42),
+           equals(original.skipWhile((x) => x != 42)));
+  });
+
+  test("$name - take", () {
+    expect(wrapped.take(0), equals(original.take(0)));
+    expect(wrapped.take(1), equals(original.take(1)));
+    expect(wrapped.take(5), equals(original.take(5)));
+  });
+
+  test("$name - takeWhile", () {
+    expect(wrapped.takeWhile((x) => true),
+           equals(original.takeWhile((x) => true)));
+    expect(wrapped.takeWhile((x) => false),
+           equals(original.takeWhile((x) => false)));
+    expect(wrapped.takeWhile((x) => x != 42),
+           equals(original.takeWhile((x) => x != 42)));
+  });
+
+  test("$name - toList", () {
+    expect(wrapped.toList(), equals(original.toList()));
+    expect(wrapped.toList(growable: false),
+           equals(original.toList(growable: false)));
+  });
+
+  test("$name - toSet", () {
+    expect(wrapped.toSet(), equals(original.toSet()));
+  });
+
+  test("$name - where", () {
+    expect(wrapped.where((x) => true),
+           equals(original.where((x) => true)));
+    expect(wrapped.where((x) => false),
+           equals(original.where((x) => false)));
+    expect(wrapped.where((x) => x != 42),
+           equals(original.where((x) => x != 42)));
+  });
+}
+
+void testReadList(List original, List wrapped, String name) {
+  test("$name - length", () {
+    expect(wrapped.length, equals(original.length));
+  });
+
+  test("$name - isEmpty", () {
+    expect(wrapped.isEmpty, equals(original.isEmpty));
+  });
+
+  test("$name - isNotEmpty", () {
+    expect(wrapped.isNotEmpty, equals(original.isNotEmpty));
+  });
+
+  test("$name - []", () {
+    if (original.isEmpty) {
+      expect(() { wrapped[0]; }, throwsRangeError);
+    } else {
+      expect(wrapped[0], equals(original[0]));
+    }
+  });
+
+  test("$name - indexOf", () {
+    expect(wrapped.indexOf(42), equals(original.indexOf(42)));
+  });
+
+  test("$name - lastIndexOf", () {
+    expect(wrapped.lastIndexOf(42), equals(original.lastIndexOf(42)));
+  });
+
+  test("$name - getRange", () {
+    int len = original.length;
+    expect(wrapped.getRange(0, len), equals(original.getRange(0, len)));
+    expect(wrapped.getRange(len ~/ 2, len),
+           equals(original.getRange(len ~/ 2, len)));
+    expect(wrapped.getRange(0, len ~/ 2),
+           equals(original.getRange(0, len ~/ 2)));
+  });
+
+  test("$name - sublist", () {
+    int len = original.length;
+    expect(wrapped.sublist(0), equals(original.sublist(0)));
+    expect(wrapped.sublist(len ~/ 2), equals(original.sublist(len ~/ 2)));
+    expect(wrapped.sublist(0, len ~/ 2),
+           equals(original.sublist(0, len ~/ 2)));
+  });
+
+  test("$name - asMap", () {
+    expect(wrapped.asMap(), equals(original.asMap()));
+  });
+}
+
+void testNoWriteList(List original, List wrapped, String name) {
+  List copy = new List.from(original);
+
+  testThrows(name, thunk) {
+    test(name, () {
+      expect(thunk, throwsUnsupportedError);
+      // No modifications happened.
+      expect(original, equals(copy));
+    });
+  }
+
+  testThrows("$name - []= throws", () { wrapped[0] = 42; });
+
+  testThrows("$name - sort throws", () { wrapped.sort(); });
+
+  testThrows("$name - fillRange throws", () {
+    wrapped.fillRange(0, wrapped.length, 42);
+  });
+
+  testThrows("$name - setRange throws", () {
+      wrapped.setRange(0, wrapped.length,
+                    new Iterable.generate(wrapped.length, (i) => i));
+  });
+
+  testThrows("$name - setAll throws", () {
+      wrapped.setAll(0, new Iterable.generate(wrapped.length, (i) => i));
+  });
+}
+
+void testWriteList(List original, List wrapped, String name) {
+  List copy = new List.from(original);
+
+  test("$name - []=", () {
+    if (original.isNotEmpty) {
+      int originalFirst = original[0];
+      wrapped[0] = originalFirst + 1;
+      expect(original[0], equals(originalFirst + 1));
+      original[0] = originalFirst;
+    } else {
+      expect(() { wrapped[0] = 42; }, throws);
+    }
+  });
+
+  test("$name - sort", () {
+    List sortCopy = new List.from(original);
+    sortCopy.sort();
+    wrapped.sort();
+    expect(original, equals(sortCopy));
+    original.setAll(0, copy);
+  });
+
+  test("$name - fillRange", () {
+    wrapped.fillRange(0, wrapped.length, 37);
+    for (int i = 0; i < original.length; i++) {
+      expect(original[i], equals(37));
+    }
+    original.setAll(0, copy);
+  });
+
+  test("$name - setRange", () {
+    List reverseList = original.reversed.toList();
+    wrapped.setRange(0, wrapped.length, reverseList);
+    expect(original, equals(reverseList));
+    original.setAll(0, copy);
+  });
+
+  test("$name - setAll", () {
+    List reverseList = original.reversed.toList();
+    wrapped.setAll(0, reverseList);
+    expect(original, equals(reverseList));
+    original.setAll(0, copy);
+  });
+}
+
+void testNoChangeLengthList(List original, List wrapped, String name) {
+  List copy = new List.from(original);
+
+  testThrows(name, thunk) {
+    test(name, () {
+      expect(thunk, throwsUnsupportedError);
+      // No modifications happened.
+      expect(original, equals(copy));
+    });
+  }
+
+  testThrows("$name - length= throws", () {
+    wrapped.length = 100;
+  });
+
+  testThrows("$name - add throws", () {
+    wrapped.add(42);
+  });
+
+  testThrows("$name - addAll throws", () {
+    wrapped.addAll([42]);
+  });
+
+  testThrows("$name - insert throws", () {
+    wrapped.insert(0, 42);
+  });
+
+  testThrows("$name - insertAll throws", () {
+    wrapped.insertAll(0, [42]);
+  });
+
+  testThrows("$name - remove throws", () {
+    wrapped.remove(42);
+  });
+
+  testThrows("$name - removeAt throws", () {
+    wrapped.removeAt(0);
+  });
+
+  testThrows("$name - removeLast throws", () {
+    wrapped.removeLast();
+  });
+
+  testThrows("$name - removeWhere throws", () {
+    wrapped.removeWhere((E element) => false);
+  });
+
+  testThrows("$name - retainWhere throws", () {
+    wrapped.retainWhere((E element) => true);
+  });
+
+  testThrows("$name - removeRange throws", () {
+    wrapped.removeRange(0, wrapped.length);
+  });
+
+  testThrows("$name - replaceRange throws", () {
+    wrapped.replaceRange(0, wrapped.length, [42]);
+  });
+
+  testThrows("$name - clear throws", () {
+    wrapped.clear();
+  });
+}
+
+void testReadSet(Set original, Set wrapped, String name) {
+  Set copy = new Set.from(original);
+
+  test("$name - containsAll", () {
+    expect(wrapped.containsAll(copy), isTrue);
+    expect(wrapped.containsAll(copy.toList()), isTrue);
+    expect(wrapped.containsAll([]), isTrue);
+    expect(wrapped.containsAll([42]), equals(original.containsAll([42])));
+  });
+
+  test("$name - intersection", () {
+    expect(wrapped.intersection(new Set()), isEmpty);
+    expect(wrapped.intersection(copy), equals(original));
+    expect(wrapped.intersection(new Set.from([42])),
+            new Set.from(original.contains(42) ? [42] : []));
+  });
+
+  test("$name - union", () {
+    expect(wrapped.union(new Set()), equals(original));
+    expect(wrapped.union(copy), equals(original));
+    expect(wrapped.union(new Set.from([42])),
+           equals(original.union(new Set.from([42]))));
+  });
+
+  test("$name - difference", () {
+    expect(wrapped.difference(new Set()), equals(original));
+    expect(wrapped.difference(copy), isEmpty);
+    expect(wrapped.difference(new Set.from([42])),
+           equals(original.difference(new Set.from([42]))));
+  });
+}
+
+void testNoChangeSet(Set original, Set wrapped, String name) {
+  Set copy = new Set.from(original);
+
+  testThrows(name, thunk) {
+    test(name, () {
+      expect(thunk, throwsUnsupportedError);
+      // No modifications happened.
+      expect(original, equals(copy));
+    });
+  }
+
+  testThrows("$name - add throws", () {
+    wrapped.add(42);
+  });
+
+  testThrows("$name - addAll throws", () {
+    wrapped.addAll([42]);
+  });
+
+  testThrows("$name - addAll empty throws", () {
+    wrapped.addAll([]);
+  });
+
+  testThrows("$name - remove throws", () {
+    wrapped.remove(42);
+  });
+
+  testThrows("$name - removeAll throws", () {
+    wrapped.removeAll([42]);
+  });
+
+  testThrows("$name - removeAll empty throws", () {
+    wrapped.removeAll([]);
+  });
+
+  testThrows("$name - retainAll throws", () {
+    wrapped.retainAll([42]);
+  });
+
+  testThrows("$name - removeWhere throws", () {
+    wrapped.removeWhere((_) => false);
+  });
+
+  testThrows("$name - retainWhere throws", () {
+    wrapped.retainWhere((_) => true);
+  });
+
+  testThrows("$name - clear throws", () {
+    wrapped.clear();
+  });
+}
+
+void testReadMap(Map original, Map wrapped, String name) {
+  test("$name length", () {
+    expect(wrapped.length, equals(original.length));
+  });
+
+  test("$name isEmpty", () {
+    expect(wrapped.isEmpty, equals(original.isEmpty));
+  });
+
+  test("$name isNotEmpty", () {
+    expect(wrapped.isNotEmpty, equals(original.isNotEmpty));
+  });
+
+  test("$name operator[]", () {
+    expect(wrapped[0], equals(original[0]));
+    expect(wrapped[999], equals(original[999]));
+  });
+
+  test("$name containsKey", () {
+    expect(wrapped.containsKey(0), equals(original.containsKey(0)));
+    expect(wrapped.containsKey(999), equals(original.containsKey(999)));
+  });
+
+  test("$name containsValue", () {
+    expect(wrapped.containsValue(0), equals(original.containsValue(0)));
+    expect(wrapped.containsValue(999), equals(original.containsValue(999)));
+  });
+
+  test("$name forEach", () {
+    int origCnt = 0;
+    int wrapCnt = 0;
+    wrapped.forEach((k, v) { wrapCnt += 1 << k + 3 * v; });
+    original.forEach((k, v) { origCnt += 1 << k + 3 * v; });
+    expect(wrapCnt, equals(origCnt));
+  });
+
+  test("$name keys", () {
+    expect(wrapped.keys, equals(original.keys));
+  });
+
+  test("$name values", () {
+    expect(wrapped.values, equals(original.values));
+  });
+}
+
+testNoChangeMap(Map original, Map wrapped, String name) {
+  Map copy = new Map.from(original);
+
+  testThrows(name, thunk) {
+    test(name, () {
+      expect(thunk, throwsUnsupportedError);
+      // No modifications happened.
+      expect(original, equals(copy));
+    });
+  }
+
+ testThrows("$name operator[]= throws", () {
+   wrapped[0] = 42;
+ });
+
+ testThrows("$name putIfAbsent throws", () {
+   wrapped.putIfAbsent(0, () => 42);
+ });
+
+ testThrows("$name addAll throws", () {
+   wrapped.addAll(new Map()..[42] = 42);
+ });
+
+ testThrows("$name addAll empty throws", () {
+   wrapped.addAll(new Map());
+ });
+
+ testThrows("$name remove throws", () {
+   wrapped.remove(0);
+ });
+
+ testThrows("$name clear throws", () {
+   wrapped.clear();
+ });
+}