Add support for running pub for plugins

pkg/analysis_server/test/src/plugin/plugin_manager_test.dart

 // Copyright (c) 2017, 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:async';
 import 'dart:io' as io;
 
 import 'package:analysis_server/src/plugin/notification_manager.dart';
 import 'package:analysis_server/src/plugin/plugin_manager.dart';
 import 'package:analyzer/context/context_root.dart';
+import 'package:analyzer/file_system/file_system.dart';
 import 'package:analyzer/file_system/memory_file_system.dart';
 import 'package:analyzer/file_system/physical_file_system.dart';
 import 'package:analyzer/instrumentation/instrumentation.dart';
 import 'package:analyzer_plugin/channel/channel.dart';
 import 'package:analyzer_plugin/protocol/protocol.dart';
 import 'package:analyzer_plugin/protocol/protocol_common.dart';
 import 'package:analyzer_plugin/protocol/protocol_generated.dart'
     hide ContextRoot;
 import 'package:path/path.dart' as path;
 import 'package:test/test.dart';
@@ skipping 183 matching lines @@
     io.Directory pkg1Dir = io.Directory.systemTemp.createTempSync('pkg1');
     String pkgPath = pkg1Dir.resolveSymbolicLinksSync();
     await withPlugin(test: (String pluginPath) async {
       ContextRoot contextRoot = new ContextRoot(pkgPath, []);
       await manager.addPluginToContextRoot(contextRoot, pluginPath);
       await manager.stopAll();
     });
     pkg1Dir.deleteSync(recursive: true);
   }
 
+  @failingTest
+  test_addPluginToContextRoot_pubspec() async {
+    // We can't successfully run pub until after the analyzer_plugin package has
+    // been published.
+    io.Directory pkg1Dir = io.Directory.systemTemp.createTempSync('pkg1');
+    String pkgPath = pkg1Dir.resolveSymbolicLinksSync();
+    await withPubspecPlugin(test: (String pluginPath) async {
+      ContextRoot contextRoot = new ContextRoot(pkgPath, []);
+      await manager.addPluginToContextRoot(contextRoot, pluginPath);
+      String packagesPath =
+          resourceProvider.pathContext.join(pluginPath, '.packages');
+      File packagesFile = resourceProvider.getFile(packagesPath);
+      bool exists = packagesFile.exists;
+      await manager.stopAll();
+      expect(exists, isTrue, reason: '.packages file was not created');
+    });
+    pkg1Dir.deleteSync(recursive: true);
+  }
+
   test_broadcastRequest_many() async {
     io.Directory pkg1Dir = io.Directory.systemTemp.createTempSync('pkg1');
     String pkgPath = pkg1Dir.resolveSymbolicLinksSync();
     await withPlugin(
         pluginName: 'plugin1',
         test: (String plugin1Path) async {
           await withPlugin(
               pluginName: 'plugin2',
               test: (String plugin2Path) async {
                 ContextRoot contextRoot = new ContextRoot(pkgPath, []);
@@ skipping 348 matching lines @@
       //
       // Run the actual test code.
       //
       await test(pluginPath);
     } finally {
       tempDirectory.deleteSync(recursive: true);
     }
   }
 
   /**
+   * Create a directory structure representing a plugin on disk, run the given
+   * [test] function, and then remove the directory. The directory will have the
+   * following structure:
+   * ```
+   * pluginDirectory
+   *   pubspec.yaml
+   *   bin
+   *     plugin.dart
+   * ```
+   * The name of the plugin directory will be the [pluginName], if one is
+   * provided (in order to allow more than one plugin to be created by a single
+   * test). The 'plugin.dart' file will contain the given [content], or default
+   * content that implements a minimal plugin if the contents are not given. The
+   * [test] function will be passed the path of the directory that was created.
+   */
+  Future<Null> withPubspecPlugin(
+      {String content,
+      String pluginName,
+      Future<Null> test(String pluginPath)}) async {
+    io.Directory tempDirectory =
+        io.Directory.systemTemp.createTempSync(pluginName ?? 'test_plugin');
+    try {
+      String pluginPath = tempDirectory.resolveSymbolicLinksSync();
+      //
+      // Create a pubspec.yaml file.
+      //
+      io.File pubspecFile = new io.File(path.join(pluginPath, 'pubspec.yaml'));
+      pubspecFile.writeAsStringSync(_getPubspecFileContent());
+      //
+      // Create the 'bin' directory.
+      //
+      String binPath = path.join(pluginPath, 'bin');
+      new io.Directory(binPath).createSync();
+      //
+      // Create the 'plugin.dart' file.
+      //
+      io.File pluginFile = new io.File(path.join(binPath, 'plugin.dart'));
+      pluginFile.writeAsStringSync(content ?? _defaultPluginContent());
+      //
+      // Run the actual test code.
+      //
+      await test(pluginPath);
+    } finally {
+      tempDirectory.deleteSync(recursive: true);
+    }
+  }
+
+  /**
    * Convert the [sdkPackageMap] into a plugin-specific map by applying the
    * given relative path [delta] to each line.
    */
   String _convertPackageMap(String sdkDirPath, List<String> sdkPackageMap) {
     StringBuffer buffer = new StringBuffer();
     for (String line in sdkPackageMap) {
       if (!line.startsWith('#')) {
         int index = line.indexOf(':');
         String packageName = line.substring(0, index + 1);
         String relativePath = line.substring(index + 1);
@@ skipping 54 matching lines @@
     if (_packagesFileContent == null) {
       io.File sdkPackagesFile = new io.File(_sdkPackagesPath());
       List<String> sdkPackageMap = sdkPackagesFile.readAsLinesSync();
       _packagesFileContent =
           _convertPackageMap(path.dirname(sdkPackagesFile.path), sdkPackageMap);
     }
     return _packagesFileContent;
   }
 
   /**
+   * Return the content to be used for the 'pubspec.yaml' file.
+   */
+  String _getPubspecFileContent() {
+    return '''
+name: 'test'
+dependencies:
+  analyzer: any
+  analyzer_plugin: any
+''';
+  }
+
+  /**
    * Return the path to the '.packages' file in the root of the SDK checkout.
    */
   String _sdkPackagesPath() {
     String packagesPath = io.Platform.script.toFilePath();
     while (packagesPath.isNotEmpty &&
         path.basename(packagesPath) != 'analysis_server') {
       packagesPath = path.dirname(packagesPath);
     }
     packagesPath = path.dirname(packagesPath);
     packagesPath = path.dirname(packagesPath);
@@ skipping 41 matching lines @@
   }
 
   @override
   void sendRequest(Request request) {
     sentRequests.add(request);
     if (request.method == 'plugin.shutdown') {
       session.handleOnDone();
     }
   }
 }