Do not allow tools to run in compare_output_test (#1853)

* Do not allow tools to run in compare_output_test

* Update dev docs

Author: jcollins-g

lib/src/dartdoc_options.dart

@@ -1286,6 +1286,7 @@ class DartdocOptionContext {
 
   // All values defined in createDartdocOptions should be exposed here.
   bool get addCrossdart => optionSet['addCrossdart'].valueAt(context);
+  bool get allowTools => optionSet['allowTools'].valueAt(context);
   double get ambiguousReexportScorerMinConfidence =>
       optionSet['ambiguousReexportScorerMinConfidence'].valueAt(context);
   bool get autoIncludeDependencies =>
@@ -1347,6 +1348,9 @@ Future<List<DartdocOption>> createDartdocOptions() async {
     new DartdocOptionArgOnly<bool>('addCrossdart', false,
         help: 'Add Crossdart links to the source code pieces.',
         negatable: true),
+    new DartdocOptionArgOnly<bool>('allowTools', true,
+        help: 'Execute user-defined tools to fill in @tool directives.',
+        negatable: true),
     new DartdocOptionArgFile<double>(
         'ambiguousReexportScorerMinConfidence', 0.1,
         help: 'Minimum scorer confidence to suppress warning on ambiguous '

lib/src/model.dart

@@ -3988,38 +3988,42 @@ abstract class ModelElement extends Canonicalization
   /// ## Content to send to tool.
   /// 2018-09-18T21:15+00:00
   Future<String> _evaluateTools(String rawDocs) async {
-    var runner = new ToolRunner(config.tools, (String message) async {
-      warn(PackageWarning.toolError, message: message);
-    });
-    int invocationIndex = 0;
-    return await _replaceAllMappedAsync(rawDocs, basicToolRegExp,
-        (basicMatch) async {
-      List<String> args = _splitUpQuotedArgs(basicMatch[1]).toList();
-      // Tool name must come first.
-      if (args.isEmpty) {
-        warn(PackageWarning.toolError,
-            message: 'Must specify a tool to execute for the @tool directive.');
-        return Future.value('');
-      }
-      // Count the number of invocations of tools in this dartdoc block,
-      // so that tools can differentiate different blocks from each other.
-      invocationIndex++;
-      return await runner.run(args,
-          content: basicMatch[2],
-          environment: {
-            'SOURCE_LINE': lineAndColumn?.item1?.toString(),
-            'SOURCE_COLUMN': lineAndColumn?.item2?.toString(),
-            'SOURCE_PATH': (sourceFileName == null ||
-                    package?.packagePath == null)
-                ? null
-                : pathLib.relative(sourceFileName, from: package.packagePath),
-            'PACKAGE_PATH': package?.packagePath,
-            'PACKAGE_NAME': package?.name,
-            'LIBRARY_NAME': library?.fullyQualifiedName,
-            'ELEMENT_NAME': fullyQualifiedNameWithoutLibrary,
-            'INVOCATION_INDEX': invocationIndex.toString(),
-          }..removeWhere((key, value) => value == null));
-    }).whenComplete(runner.dispose);
+    if (config.allowTools) {
+      var runner = new ToolRunner(config.tools, (String message) async {
+        warn(PackageWarning.toolError, message: message);
+      });
+      int invocationIndex = 0;
+      return await _replaceAllMappedAsync(rawDocs, basicToolRegExp,
+              (basicMatch) async {
+            List<String> args = _splitUpQuotedArgs(basicMatch[1]).toList();
+            // Tool name must come first.
+            if (args.isEmpty) {
+              warn(PackageWarning.toolError,
+                  message: 'Must specify a tool to execute for the @tool directive.');
+              return Future.value('');
+            }
+            // Count the number of invocations of tools in this dartdoc block,
+            // so that tools can differentiate different blocks from each other.
+            invocationIndex++;
+            return await runner.run(args,
+                content: basicMatch[2],
+                environment: {
+                  'SOURCE_LINE': lineAndColumn?.item1?.toString(),
+                  'SOURCE_COLUMN': lineAndColumn?.item2?.toString(),
+                  'SOURCE_PATH': (sourceFileName == null ||
+                      package?.packagePath == null)
+                      ? null
+                      : pathLib.relative(sourceFileName, from: package.packagePath),
+                  'PACKAGE_PATH': package?.packagePath,
+                  'PACKAGE_NAME': package?.name,
+                  'LIBRARY_NAME': library?.fullyQualifiedName,
+                  'ELEMENT_NAME': fullyQualifiedNameWithoutLibrary,
+                  'INVOCATION_INDEX': invocationIndex.toString(),
+                }..removeWhere((key, value) => value == null));
+          }).whenComplete(runner.dispose);
+    } else {
+      return rawDocs;
+    }
   }
 
   /// Replace &#123;@animation ...&#125; in API comments with some HTML to manage an

test/compare_output_test.dart

@@ -89,6 +89,7 @@ void main() {
       var args = <String>[
         '--enable-asserts',
         dartdocBin,
+        '--no-allow-tools',
         '--auto-include-dependencies',
         '--example-path-prefix',
         'examples',