Support tag configuration.

lib/src/backend/metadata.dart

 // Copyright (c) 2015, 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 'dart:collection';
 
 import 'package:collection/collection.dart';
 
 import '../frontend/skip.dart';
 import '../frontend/timeout.dart';
@@ skipping 24 matching lines @@
 
   /// The user-defined tags attached to the test or suite.
   final Set<String> tags;
 
   /// Platform-specific metadata.
   ///
   /// Each key identifies a platform, and its value identifies the specific
   /// metadata for that platform. These can be applied by calling [forPlatform].
   final Map<PlatformSelector, Metadata> onPlatform;
 
+  /// Metadata that applies only when specific tags are applied.
+  ///
+  /// Tag-specific metadata is applied when merging this with other metadata.
+  /// Note that unlike [onPlatform], the base metadata takes precedence over any
+  /// tag-specific metadata.
+  ///
+  /// This is guaranteed not to have any keys that appear in [tags]; those are
+  /// resolved when the metadata is constructed.
+  final Map<String, Metadata> forTag;
+
   /// Parses a user-provided map into the value for [onPlatform].
   static Map<PlatformSelector, Metadata> _parseOnPlatform(
       Map<String, dynamic> onPlatform) {
     if (onPlatform == null) return {};
 
     var result = {};
     onPlatform.forEach((platform, metadata) {
       if (metadata is Timeout || metadata is Skip) {
         metadata = [metadata];
       } else if (metadata is! List) {
@@ skipping 45 matching lines @@
     if (tags.any((tag) => tag is! String)) {
       throw new ArgumentError.value(tags, "tags", "must contain only Strings.");
     }
 
     return new Set.from(tags);
   }
 
   /// Creates new Metadata.
   ///
   /// [testOn] defaults to [PlatformSelector.all].
-  Metadata({PlatformSelector testOn, Timeout timeout, bool skip: false,
-          this.verboseTrace: false, this.skipReason,
-          Map<PlatformSelector, Metadata> onPlatform, Iterable<String> tags})
+  ///
+  /// If [forTag] contains metadata for any tags in [tags], that metadata is
+  /// included inline in the returned value. The values directly passed to the
+  /// constructor take precedence over tag-specific metadata.
+  factory Metadata({PlatformSelector testOn, Timeout timeout, bool skip: false,
+          bool verboseTrace: false, String skipReason, Iterable<String> tags,
+          Map<PlatformSelector, Metadata> onPlatform,
+          Map<String, Metadata> forTag}) {
+    // If there's no tag-specific metadata, or if none of it applies, just
+    // return the metadata as-is.
+    if (forTag == null || tags == null || !tags.any(forTag.containsKey)) {
+      return new Metadata._(
+          testOn: testOn,
+          timeout: timeout,
+          skip: skip,
+          verboseTrace: verboseTrace,
+          skipReason: skipReason,
+          tags: tags,
+          onPlatform: onPlatform,
+          forTag: forTag);
+    }
+
+    // Otherwise, resolve the tag-specific components. Doing this eagerly means
+    // we only have to resolve suite- or group-level tags once, rather than
+    // doing it for every test individually.
+    forTag = new Map.from(forTag);
+    var merged = tags.fold(new Metadata._(), (merged, tag) {
+      var tagMetadata = forTag.remove(tag);
+      return tagMetadata == null ? merged : merged.merge(tagMetadata);
+    });
+
+    return merged.merge(new Metadata._(
+        testOn: testOn,
+        timeout: timeout,
+        skip: skip,
+        verboseTrace: verboseTrace,
+        skipReason: skipReason,
+        tags: tags,
+        onPlatform: onPlatform,
+        forTag: forTag));
+  }
+
+  /// Creates new Metadata.
+  ///
+  /// Unlike [new Metadata], this assumes [forTag] is already resolved.
+  Metadata._({PlatformSelector testOn, Timeout timeout, bool skip: false,
+          this.verboseTrace: false, this.skipReason, Iterable<String> tags,
+          Map<PlatformSelector, Metadata> onPlatform,
+          Map<String, Metadata> forTag})
       : testOn = testOn == null ? PlatformSelector.all : testOn,
         timeout = timeout == null ? const Timeout.factor(1) : timeout,
         skip = skip,
+        tags = tags == null
+            ? new Set()
+            : new UnmodifiableSetView(tags.toSet()),

[kevmoo, 2016/02/12 18:29:30]

put the null check inside this ctor – so even the empty case is read-only?

[nweiz, 2016/02/16 23:36:31]

Done.

         onPlatform = onPlatform == null
             ? const {}
             : new UnmodifiableMapView(onPlatform),
-        tags = tags == null
-            ? new Set()
-            : new UnmodifiableSetView(tags.toSet()) {
+        forTag = forTag == null
+            ? const {}
+            : new UnmodifiableMapView(forTag) {
     _validateTags();
   }
 
   /// Creates a new Metadata, but with fields parsed from caller-friendly values
   /// where applicable.
   ///
   /// Throws a [FormatException] if any field is invalid.
   Metadata.parse({String testOn, Timeout timeout, skip,
           this.verboseTrace: false, Map<String, dynamic> onPlatform,
           tags})
       : testOn = testOn == null
             ? PlatformSelector.all
             : new PlatformSelector.parse(testOn),
         timeout = timeout == null ? const Timeout.factor(1) : timeout,
         skip = skip != null && skip != false,
         skipReason = skip is String ? skip : null,
         onPlatform = _parseOnPlatform(onPlatform),
-        tags = _parseTags(tags) {
+        tags = _parseTags(tags),
+        forTag = const {} {
     if (skip != null && skip is! String && skip is! bool) {
       throw new ArgumentError(
           '"skip" must be a String or a bool, was "$skip".');
     }
 
     _validateTags();
   }
 
   /// Deserializes the result of [Metadata.serialize] into a new [Metadata].
   Metadata.deserialize(serialized)
       : testOn = serialized['testOn'] == null
             ? PlatformSelector.all
             : new PlatformSelector.parse(serialized['testOn']),
         timeout = _deserializeTimeout(serialized['timeout']),
         skip = serialized['skip'],
         skipReason = serialized['skipReason'],
         verboseTrace = serialized['verboseTrace'],
         tags = new Set.from(serialized['tags']),
         onPlatform = new Map.fromIterable(serialized['onPlatform'],
             key: (pair) => new PlatformSelector.parse(pair.first),
-            value: (pair) => new Metadata.deserialize(pair.last));
+            value: (pair) => new Metadata.deserialize(pair.last)),
+        forTag = mapMap(serialized['forTag'],
+            value: (_, nested) => new Metadata.deserialize(nested));
 
   /// Deserializes timeout from the format returned by [_serializeTimeout].
   static _deserializeTimeout(serialized) {
     if (serialized == 'none') return Timeout.none;
     var scaleFactor = serialized['scaleFactor'];
     if (scaleFactor != null) return new Timeout.factor(scaleFactor);
     return new Timeout(
         new Duration(microseconds: serialized['duration']));
   }
 
   /// Throws an [ArgumentError] if any tags in [tags] aren't hyphenated
   /// identifiers.
   void _validateTags() {
     var invalidTags = tags
         .where((tag) => !tag.contains(anchoredHyphenatedIdentifier))
         .map((tag) => '"$tag"')
         .toList();
 
     if (invalidTags.isEmpty) return;
 
     throw new ArgumentError(
         "Invalid ${pluralize('tag', invalidTags.length)} "
           "${toSentence(invalidTags)}. Tags must be (optionally hyphenated) "
           "Dart identifiers.");
   }
 
   /// Return a new [Metadata] that merges [this] with [other].
   ///
-  /// If the two [Metadata]s have conflicting properties, [other] wins.
+  /// If the two [Metadata]s have conflicting properties, [other] wins. If
+  /// either has a [forTag] metadata for one of the other's tags, that metadata
+  /// is merged as well.
   Metadata merge(Metadata other) =>
       new Metadata(
           testOn: testOn.intersect(other.testOn),
           timeout: timeout.merge(other.timeout),
           skip: skip || other.skip,
+          skipReason: other.skipReason == null ? skipReason : other.skipReason,
           verboseTrace: verboseTrace || other.verboseTrace,
-          skipReason: other.skipReason == null ? skipReason : other.skipReason,
-          onPlatform: mergeMaps(onPlatform, other.onPlatform),
-          tags: tags.union(other.tags));
+          tags: tags.union(other.tags),
+          onPlatform: mergeMaps(onPlatform, other.onPlatform,
+              value: (metadata1, metadata2) => metadata1.merge(metadata2)),
+          forTag: mergeMaps(forTag, other.forTag,
+              value: (metadata1, metadata2) => metadata1.merge(metadata2)));
 
   /// Returns a copy of [this] with the given fields changed.
   Metadata change({PlatformSelector testOn, Timeout timeout, bool skip,
       bool verboseTrace, String skipReason,
       Map<PlatformSelector, Metadata> onPlatform}) {
     if (testOn == null) testOn = this.testOn;
     if (timeout == null) timeout = this.timeout;
     if (skip == null) skip = this.skip;
     if (verboseTrace == null) verboseTrace = this.verboseTrace;
     if (skipReason == null) skipReason = this.skipReason;
@@ skipping 24 matching lines @@
     onPlatform.forEach((key, value) {
       serializedOnPlatform.add([key.toString(), value.serialize()]);
     });
 
     return {
       'testOn': testOn == PlatformSelector.all ? null : testOn.toString(),
       'timeout': _serializeTimeout(timeout),
       'skip': skip,
       'skipReason': skipReason,
       'verboseTrace': verboseTrace,
+      'tags': tags.toList(),
       'onPlatform': serializedOnPlatform,
-      'tags': tags.toList()
+      'forTag': mapMap(forTag, value: (_, metadata) => metadata.serialize())
     };
   }
 
   /// Serializes timeout into a JSON-safe object.
   _serializeTimeout(Timeout timeout) {
     if (timeout == Timeout.none) return 'none';
     return {
       'duration': timeout.duration == null
           ? null
           : timeout.duration.inMicroseconds,
       'scaleFactor': timeout.scaleFactor
     };
   }
 }