Support resources in "pub run" and "pub global run".

Closes pub#22

[email protected]

Review URL: https://codereview.chromium.org//1277773002 .

Author: nex3

lib/src/command.dart

@@ -6,7 +6,6 @@ library pub.command;
 
 import 'package:args/args.dart';
 import 'package:args/command_runner.dart';
-import 'package:path/path.dart' as path;
 
 import 'entrypoint.dart';
 import 'log.dart' as log;

lib/src/executable.dart

@@ -9,7 +9,6 @@ import 'dart:io';
 
 import 'package:barback/barback.dart';
 import 'package:path/path.dart' as p;
-import 'package:stack_trace/stack_trace.dart';
 
 import 'barback/asset_environment.dart';
 import 'entrypoint.dart';
@@ -114,8 +113,6 @@ Future<int> runExecutable(Entrypoint entrypoint, String package,
   // it knows where to load the packages. If it's a dependency's executable, for
   // example, it may not have the right packages directory itself.
   if (executableUrl.scheme == 'file' || executableUrl.scheme == '') {
-    // TODO(nweiz): use a .packages file once sdk#23369 is fixed.
-
     // We use an absolute path here not because the VM insists but because it's
     // helpful for the subprocess to be able to spawn Dart with
     // Platform.executableArguments and have that work regardless of the working
@@ -210,12 +207,22 @@ Future<Uri> _executableUrl(Entrypoint entrypoint, String package, String path,
 ///
 /// This doesn't do any validation of the snapshot's SDK version.
 Future<int> runSnapshot(String path, Iterable<String> args, {recompile(),
-    bool checked: false}) async {
-  var vmArgs = [path]..addAll(args);
-
+    String packagesFile, bool checked: false}) async {
   // TODO(nweiz): pass a flag to silence the "Wrong full snapshot version"
   // message when issue 20784 is fixed.
-  if (checked) vmArgs.insert(0, "--checked");
+  var vmArgs = [];
+  if (checked) vmArgs.add("--checked");
+
+  if (packagesFile != null) {
+    // We use an absolute path here not because the VM insists but because it's
+    // helpful for the subprocess to be able to spawn Dart with
+    // Platform.executableArguments and have that work regardless of the working
+    // directory.
+    vmArgs.add("--packages=${p.toUri(p.absolute(packagesFile))}");
+  }
+
+  vmArgs.add(path);
+  vmArgs.addAll(args);
 
   // We need to split stdin so that we can send the same input both to the
   // first and second process, if we start more than one.
@@ -269,7 +276,10 @@ void _forwardSignals(Process process) {
 /// Runs the executable snapshot at [snapshotPath].
 Future<int> _runCachedExecutable(Entrypoint entrypoint, String snapshotPath,
     List<String> args, {bool checked: false}) {
-  return runSnapshot(snapshotPath, args, checked: checked, recompile: () {
+  return runSnapshot(snapshotPath, args,
+      packagesFile: entrypoint.packagesFile,
+      checked: checked,
+      recompile: () {
     log.fine("Precompiled executable is out of date.");
     return entrypoint.precompileExecutables();
   });

lib/src/global_packages.dart

@@ -5,7 +5,6 @@
 library pub.global_packages;
 
 import 'dart:async';
-import 'dart:convert';
 import 'dart:io';
 
 import 'package:path/path.dart' as p;
@@ -20,6 +19,7 @@ import 'io.dart';
 import 'lock_file.dart';
 import 'log.dart' as log;
 import 'package.dart';
+import 'package_locations.dart';
 import 'pubspec.dart';
 import 'sdk.dart' as sdk;
 import 'solver/version_solver.dart';
@@ -177,6 +177,7 @@ class GlobalPackages {
         .loadPackageGraph(result);
     var snapshots = await _precompileExecutables(graph.entrypoint, dep.name);
     _writeLockFile(dep.name, lockFile);
+    writePackagesMap(graph, _getPackagesFilePath(dep.name));
 
     _updateBinStubs(graph.packages[dep.name], executables,
         overwriteBinStubs: overwriteBinStubs, snapshots: snapshots);
@@ -354,7 +355,10 @@ class GlobalPackages {
     }
 
     var snapshotPath = p.join(binDir, '$executable.dart.snapshot');
-    return exe.runSnapshot(snapshotPath, args, checked: checked, recompile: () {
+    return exe.runSnapshot(snapshotPath, args,
+        checked: checked,
+        packagesFile: _getPackagesFilePath(package),
+        recompile: () {
       log.fine("$package:$executable is out of date and needs to be "
           "recompiled.");
       return find(package)
@@ -368,6 +372,11 @@ class GlobalPackages {
   String _getLockFilePath(String name) =>
       p.join(_directory, name, "pubspec.lock");
 
+  /// Gets the path to the .packages file for an activated cached package with
+  /// [name].
+  String _getPackagesFilePath(String name) =>
+      p.join(_directory, name, ".packages");
+
   /// Shows the user a formatted list of globally activated packages.
   void listActivePackages() {
     if (!dirExists(_directory)) return;

lib/src/package_locations.dart

@@ -6,25 +6,23 @@
 // TODO(lrn): Also move packages/ directory management to this library.
 library pub.package_locations;
 
-import 'dart:async';
-
 import 'package:package_config/packages_file.dart' as packages_file;
 import 'package:path/path.dart' as p;
 
 import 'package_graph.dart';
 import 'io.dart';
-import 'log.dart' as log;
 import 'utils.dart' show ordered;
 
 /// Creates a `.packages` file with the locations of the packages in [graph].
 ///
-/// The file is written in the root directory of the entrypoint of [graph].
+/// The file is written to [path], which defaults to the root directory of the
+/// entrypoint of [graph].
 ///
 /// If the file already exists, it is deleted before the new content is written.
-void writePackagesMap(PackageGraph graph) {
-  var packagesFilePath = graph.entrypoint.root.path(".packages");
+void writePackagesMap(PackageGraph graph, [String path]) {
+  path ??= graph.entrypoint.root.path(".packages");
   var content = _createPackagesMap(graph);
-  writeTextFile(packagesFilePath, content);
+  writeTextFile(path, content);
 }
 
 /// Template for header text put into `.packages` file.
@@ -46,7 +44,14 @@ String _createPackagesMap(PackageGraph packageGraph) {
   var packages = packageGraph.packages;
   var uriMap = {};
   for (var packageName in ordered(packages.keys)) {
-    var location = packages[packageName].path("lib");
+    var package = packages[packageName];
+
+    // This indicates an in-memory package, which is presumably a fake
+    // entrypoint we created for something like "pub global activate". We don't
+    // need to import from it anyway, so we can just not add it to the map.
+    if (package.dir == null) continue;
+
+    var location = package.path("lib");
     uriMap[packageName] = p.toUri(location);
   }
 

test/global/run/resource_test.dart

@@ -0,0 +1,108 @@
+// Copyright (c) 2014, 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 '../../descriptor.dart' as d;
+import '../../test_pub.dart';
+
+main() {
+  integration('the spawned application can load its own resource', () {
+    servePackages((builder) {
+      builder.serve("foo", "1.0.0", contents: [
+        d.dir("lib", [
+          d.file("resource.txt", "hello!")
+        ]),
+        d.dir("bin", [
+          d.file("script.dart", """
+main() async {
+  var resource = new Resource("package:foo/resource.txt");
+
+  // TODO(nweiz): Enable this when sdk#23990 is fixed.
+  // print(resource.uri);
+
+  print(await resource.readAsString());
+}
+""")
+        ])
+      ]);
+    });
+
+    schedulePub(args: ["global", "activate", "foo"]);
+
+    var pub = pubRun(global: true, args: ["foo:script"]);
+
+    // TODO(nweiz): Enable this when sdk#23990 is fixed.
+    // pub.stdout.expect(p.toUri(p.join(sandboxDir, "myapp/lib/resource.txt")));
+
+    pub.stdout.expect("hello!");
+    pub.shouldExit(0);
+  });
+
+  integration("the spawned application can load a dependency's resource", () {
+    servePackages((builder) {
+      builder.serve("bar", "1.0.0", contents: [
+        d.dir("lib", [
+          d.file("resource.txt", "hello!")
+        ])
+      ]);
+
+      builder.serve("foo", "1.0.0", deps: {
+        "bar": "any"
+      }, contents: [
+        d.dir("bin", [
+          d.file("script.dart", """
+main() async {
+  var resource = new Resource("package:bar/resource.txt");
+
+  // TODO(nweiz): Enable this when sdk#23990 is fixed.
+  // print(resource.uri);
+
+  print(await resource.readAsString());
+}
+""")
+        ])
+      ]);
+    });
+
+    schedulePub(args: ["global", "activate", "foo"]);
+
+    var pub = pubRun(global: true, args: ["foo:script"]);
+
+    // TODO(nweiz): Enable this when sdk#23990 is fixed.
+    // pub.stdout.expect(p.toUri(p.join(sandboxDir, "myapp/lib/resource.txt")));
+
+    pub.stdout.expect("hello!");
+    pub.shouldExit(0);
+  });
+
+  integration('a mutable application can load its own resource', () {
+    d.dir("foo", [
+      d.libPubspec("foo", "1.0.0"),
+      d.dir("lib", [
+        d.file("resource.txt", "hello!")
+      ]),
+      d.dir("bin", [
+        d.file("script.dart", """
+main() async {
+  var resource = new Resource("package:foo/resource.txt");
+
+  // TODO(nweiz): Enable this when sdk#23990 is fixed.
+  // print(resource.uri);
+
+  print(await resource.readAsString());
+}
+""")
+      ])
+    ]).create();
+
+    schedulePub(args: ["global", "activate", "--source", "path", "../foo"]);
+
+    var pub = pubRun(global: true, args: ["foo:script"]);
+
+    // TODO(nweiz): Enable this when sdk#23990 is fixed.
+    // pub.stdout.expect(p.toUri(p.join(sandboxDir, "myapp/lib/resource.txt")));
+
+    pub.stdout.expect("hello!");
+    pub.shouldExit(0);
+  });
+}