Merge pull request #95 from aaronlademann-wf/move-test-utils-to-over-…

…react-test

UIP-2272 Remove test utilities that belong in over_react_test

lib/src/util/validation_util.dart

@@ -16,31 +16,56 @@ library over_react.validation_util;
 
 import 'dart:html';
 
-import 'package:over_react/src/util/pretty_print.dart';
-import 'package:over_react/src/util/react_wrappers.dart';
+import 'package:over_react/over_react.dart';
 import 'package:react/react.dart' as react;
 
 typedef void ValidationUtilWarningCallback(String message);
 
-/// Utility for logging validation errors or warning.
+/// Utility for logging validation errors or warnings.
 class ValidationUtil {
 
   static bool WARNINGS_ENABLED = true;
   static bool THROW_ON_WARNING = false;
   static int WARNING_COUNT = 0;
 
   /// Use this to log warnings to the console in dev mode only.
-  /// This is to be used in assert calls for dev help only so that it gets
-  /// compiled out for production.
+  ///
+  /// Code that produces the warnings will not be included when you compile in production mode.
   ///
   ///     assert(ValidationUtil.warn('Some warning message'));
   ///
-  /// Optionally, a component or element can be passed as the second parameter
+  /// Optionally, a component or element can be passed as [data]
   /// to provide additional information in the console.
   ///
   ///     assert(ValidationUtil.warn('Some warning message', component));
   ///
-  /// The message will be printed out to the console.
+  /// Assert that your component emits a warning using
+  /// the validation test utilities available within
+  /// `package:over_react_test/over_react_test.dart` like so:
+  ///
+  ///     group('emits a warning to the console', () {
+  ///       setUp(startRecordingValidationWarnings);
+  ///
+  ///       tearDown(stopRecordingValidationWarnings);
+  ///
+  ///       test('when <describe something that should trigger a warning>', () {
+  ///         // Do something that should trigger a warning
+  ///
+  ///         verifyValidationWarning(/* some Matcher or String */);
+  ///       });
+  ///
+  ///       test('unless <describe something that should NOT trigger a warning>', () {
+  ///         // Do something that should NOT trigger a warning
+  ///
+  ///         rejectValidationWarning(/* some Matcher or String */);
+  ///       });
+  ///     },
+  ///         // Be sure to not run these tests in JS browsers
+  ///         // like Chrome, Firefox, etc. since  the OverReact
+  ///         // ValidationUtil.warn() method will only produce a
+  ///         // console warning when compiled in "dev" mode.
+  ///         testOn: '!js'
+  ///     );
   static bool warn(String message, [dynamic data]) {
     WARNING_COUNT += 1;
 
@@ -75,6 +100,8 @@ class ValidationUtil {
   /// Callback for when warnings are logged.
   ///
   /// Useful for verifying warnings in unit tests.
+  ///
+  /// > See: [startRecordingValidationWarnings]
   static ValidationUtilWarningCallback onWarning;
 }
 

pubspec.yaml

@@ -25,7 +25,7 @@ dev_dependencies:
   coverage: "^0.7.2"
   dart_dev: "^1.7.6"
   mockito: "^0.11.0"
-  over_react_test: "^1.0.1"
+  over_react_test: "^1.1.1"
   test: "^0.12.24"
 
 transformers:

test/over_react/component/abstract_transition_test.dart

@@ -18,10 +18,10 @@ import 'dart:async';
 import 'dart:html';
 
 import 'package:over_react/over_react.dart';
+import 'package:over_react_test/over_react_test.dart';
 import 'package:test/test.dart';
 
 import '../../test_util/test_util.dart';
-import '../../wsd_test_util/validation_util_helpers.dart';
 
 /// Main entry point for AbstractTransition testing
 main() {

test/over_react/component/prop_mixins_test.dart

@@ -17,10 +17,9 @@ library prop_mixins_test;
 import 'dart:collection' show MapView;
 
 import 'package:over_react/over_react.dart';
-import 'package:over_react_test/over_react_test.dart';
 import 'package:test/test.dart';
 
-import '../../wsd_test_util/prop_utils.dart';
+import '../../test_util/prop_utils.dart';
 
 main() {
   group('ReactProps', () {
@@ -69,8 +68,7 @@ main() {
   group('AriaProps', () {
       test('cannot set / read values that are not its prop map', () {
         var instance = new AriaPropMixinsTest({});
-        expect(() {instance['notThere'];},
-            throwsA(hasToStringValue(contains('Map does not contain this key'))));
+        expect(() {instance['notThere'];}, throwsArgumentError);
       });
 
       for (var propKey in const $PropKeys(AriaPropsMixin)) {
@@ -94,7 +92,7 @@ class DomPropMixinsTest extends MapView with DomPropsMixin {
   @override
   operator [](key) {
     if (!this.containsKey(key)) {
-      throw 'Map does not contain this key: $key';
+      throw new ArgumentError('Map does not contain this key: $key');
     }
     return super[key];
   }
@@ -112,7 +110,7 @@ class SvgPropMixinsTest extends MapView with SvgPropsMixin {
   @override
   operator [](key) {
     if (!this.containsKey(key)) {
-      throw 'Map does not contain this key: $key';
+      throw new ArgumentError('Map does not contain this key: $key');
     }
     return super[key];
   }
@@ -130,7 +128,7 @@ class ReactPropMixinsTest extends MapView with ReactPropsMixin {
   @override
   operator [](key) {
     if (!this.containsKey(key)) {
-      throw 'Map does not contain this key: $key';
+      throw new ArgumentError('Map does not contain this key: $key');
     }
     return super[key];
   }
@@ -148,7 +146,7 @@ class CssClassPropMixinsTest extends MapView with CssClassPropsMixin {
   @override
   operator [](key) {
     if (!this.containsKey(key)) {
-      throw 'Map does not contain this key: $key';
+      throw new ArgumentError('Map does not contain this key: $key');
     }
     return super[key];
   }
@@ -165,7 +163,7 @@ class UbiquitousPropMixinsTest extends MapView with UbiquitousDomPropsMixin {
   @override
   operator [](key) {
     if (!this.containsKey(key)) {
-      throw 'Map does not contain this key: $key';
+      throw new ArgumentError('Map does not contain this key: $key');
     }
     return super[key];
   }
@@ -182,7 +180,7 @@ class AriaPropMixinsTest extends MapView with AriaPropsMixin {
   @override
   operator [](key) {
     if (!this.containsKey(key)) {
-      throw 'Map does not contain this key: $key';
+      throw new ArgumentError('Map does not contain this key: $key');
     }
     return super[key];
   }

test/over_react/component/resize_sensor_test.dart

@@ -20,14 +20,10 @@ import 'dart:html';
 
 import 'package:platform_detect/platform_detect.dart';
 import 'package:over_react/over_react.dart';
+import 'package:over_react_test/over_react_test.dart';
 import 'package:react/react_dom.dart' as react_dom;
 import 'package:test/test.dart';
 
-import '../../test_util/test_util.dart';
-import '../../wsd_test_util/common_component_tests.dart';
-import '../../wsd_test_util/validation_util_helpers.dart';
-import '../../wsd_test_util/zone.dart';
-
 void main() {
   group('ResizeSensor', () {
     const int defaultContainerWidth = 100;

test/over_react/component_declaration/component_base_test.dart

@@ -18,14 +18,14 @@ import 'dart:async';
 import 'dart:html';
 
 import 'package:over_react/over_react.dart' show Dom, DummyComponent, ValidationUtil;
+import 'package:over_react_test/over_react_test.dart';
 import 'package:over_react/src/component_declaration/component_base.dart';
 import 'package:over_react/src/component_declaration/component_type_checking.dart';
 import 'package:react/react_client.dart';
 import 'package:test/test.dart';
 import 'package:w_common/disposable.dart';
 
 import '../../test_util/test_util.dart';
-import '../../wsd_test_util/validation_util_helpers.dart';
 import '../shared/map_proxy_tests.dart';
 
 main() {

test/over_react/util/dom_util_test.dart

@@ -17,10 +17,10 @@ library dom_util_test;
 import 'dart:html';
 
 import 'package:over_react/over_react.dart';
+import 'package:over_react_test/over_react_test.dart';
 import 'package:test/test.dart';
 
 import '../../test_util/test_util.dart';
-import '../../wsd_test_util/validation_util_helpers.dart';
 
 /// Main entry point for DomUtil testing
 main() {

test/over_react/util/handler_chain_util_test.dart

@@ -147,8 +147,7 @@ main() {
 
                 var chained = callbackUtil.chain(a, b);
 
-                expect(() => Function.apply(chained, generateBadTypeArgs()),
-                    throwsA(const isInstanceOf<TypeError>()));
+                expect(() => Function.apply(chained, generateBadTypeArgs()), throwsA(const isInstanceOf<TypeError>()));
               }, testOn: 'dart-vm');
             }
           });
@@ -246,8 +245,7 @@ main() {
 
               var chained = callbackUtil.chainFromList(functions);
 
-              expect(() => Function.apply(chained, generateBadTypeArgs()),
-                  throwsA(const isInstanceOf<TypeError>()));
+              expect(() => Function.apply(chained, generateBadTypeArgs()), throwsA(const isInstanceOf<TypeError>()));
             }, testOn: 'dart-vm');
           }
         });

test/over_react/util/react_wrappers_test.dart

@@ -30,7 +30,6 @@ import 'package:test/test.dart';
 import '../../test_util/one_level_wrapper.dart';
 import '../../test_util/test_util.dart';
 import '../../test_util/two_level_wrapper.dart';
-import '../../wsd_test_util/test_js_component.dart';
 
 /// Main entry point for react wrappers testing
 main() {
@@ -383,21 +382,6 @@ main() {
       });
     });
 
-    group('isMounted (deprecated)', () {
-      test('returns true for a component that has been mounted', () {
-        var mountNode = new DivElement();
-        var renderedInstance = react_dom.render(Wrapper()(), mountNode);
-        expect(renderedInstance.isMounted(), isTrue);
-      });
-
-      test('returns false for a component that has been umounted', () {
-        var mountNode = new DivElement();
-        var renderedInstance = react_dom.render(Wrapper()(), mountNode);
-        react_dom.unmountComponentAtNode(mountNode);
-        expect(renderedInstance.isMounted(), isFalse);
-      });
-    });
-
     test('getInstanceKey returns the key set on a ReactElement', () {
       ReactElement instance = (Dom.div()..key = 'foo')();
       expect(getInstanceKey(instance), equals('foo'));

test/over_react/util/test_mode_test.dart

@@ -18,7 +18,7 @@ import 'package:over_react/src/component_declaration/component_base.dart' as com
 import 'package:over_react/src/util/test_mode.dart';
 import 'package:test/test.dart';
 
-/// Main entry point for enableTestMode and disabledTestMode testing
+/// Main entry point for [enableTestMode] and [disableTestMode] testing
 main() {
   test('enableTestMode and disableTestMode set UiProps.testMode as expected', () {
     disableTestMode();

test/over_react_util_test.dart

@@ -33,7 +33,6 @@ import 'over_react/util/guid_util_test.dart' as guid_util_test;
 import 'over_react/util/handler_chain_util_test.dart' as handler_chain_util_test;
 import 'over_react/util/map_util_test.dart' as map_util_test;
 import 'over_react/util/pretty_print_test.dart' as pretty_print_test;
-import 'over_react/util/prop_error_test.dart' as prop_error_test;
 import 'over_react/util/prop_key_util_test.dart' as prop_key_util_test;
 import 'over_react/util/react_wrappers_test.dart' as react_wrappers_test;
 import 'over_react/util/rem_util_test.dart' as rem_util_test;
@@ -55,7 +54,6 @@ void main() {
   handler_chain_util_test.main();
   map_util_test.main();
   pretty_print_test.main();
-  prop_error_test.main();
   prop_key_util_test.main();
   react_wrappers_test.main();
   rem_util_test.main();