OLD | NEW |
| (Empty) |
1 // Copyright (c) 2014, the Dart project authors. Please see the AUTHORS file | |
2 // for details. All rights reserved. Use of this source code is governed by a | |
3 // BSD-style license that can be found in the LICENSE file. | |
4 | |
5 import 'dart:async'; | |
6 import 'dart:convert'; | |
7 | |
8 import 'package:path/path.dart' as p; | |
9 import 'package:pub/src/io.dart'; | |
10 import 'package:pub/src/utils.dart'; | |
11 import 'package:pub_semver/pub_semver.dart'; | |
12 import 'package:scheduled_test/scheduled_test.dart'; | |
13 import 'package:yaml/yaml.dart'; | |
14 | |
15 import 'descriptor.dart' as d; | |
16 import 'test_pub.dart'; | |
17 | |
18 /// The [d.DirectoryDescriptor] describing the server layout of `/api/packages` | |
19 /// on the test server. | |
20 /// | |
21 /// This contains metadata for packages that are being served via | |
22 /// [servePackages]. It's `null` if [servePackages] has not yet been called for | |
23 /// this test. | |
24 d.DirectoryDescriptor _servedApiPackageDir; | |
25 | |
26 /// The [d.DirectoryDescriptor] describing the server layout of `/packages` on | |
27 /// the test server. | |
28 /// | |
29 /// This contains the tarballs for packages that are being served via | |
30 /// [servePackages]. It's `null` if [servePackages] has not yet been called for | |
31 /// this test. | |
32 d.DirectoryDescriptor _servedPackageDir; | |
33 | |
34 /// The current [PackageServerBuilder] that a user uses to specify which package | |
35 /// to serve. | |
36 /// | |
37 /// This is preserved over multiple calls to [servePackages] within the same | |
38 /// test so that additional packages can be added. | |
39 PackageServerBuilder _builder; | |
40 | |
41 /// Creates an HTTP server that replicates the structure of pub.dartlang.org. | |
42 /// | |
43 /// Calls [callback] with a [PackageServerBuilder] that's used to specify | |
44 /// which packages to serve. | |
45 /// | |
46 /// If [replace] is false, subsequent calls to [servePackages] will add to the | |
47 /// set of packages that are being served. Previous packages will continue to be | |
48 /// served. Otherwise, the previous packages will no longer be served. | |
49 void servePackages(void callback(PackageServerBuilder builder), | |
50 {bool replace: false}) { | |
51 if (_servedPackageDir == null) { | |
52 _builder = new PackageServerBuilder(); | |
53 _servedApiPackageDir = d.dir('packages', []); | |
54 _servedPackageDir = d.dir('packages', []); | |
55 serve([ | |
56 d.dir('api', [_servedApiPackageDir]), | |
57 _servedPackageDir | |
58 ]); | |
59 | |
60 currentSchedule.onComplete.schedule(() { | |
61 _builder = null; | |
62 _servedApiPackageDir = null; | |
63 _servedPackageDir = null; | |
64 }, 'cleaning up served packages'); | |
65 } | |
66 | |
67 schedule(() { | |
68 if (replace) _builder = new PackageServerBuilder(); | |
69 callback(_builder); | |
70 return _builder._await().then((resolvedPubspecs) { | |
71 _servedApiPackageDir.contents.clear(); | |
72 _servedPackageDir.contents.clear(); | |
73 _builder._packages.forEach((name, versions) { | |
74 _servedApiPackageDir.contents.addAll([ | |
75 d.file('$name', JSON.encode({ | |
76 'name': name, | |
77 'uploaders': ['nweiz@google.com'], | |
78 'versions': versions.map((version) => | |
79 packageVersionApiMap(version.pubspec)).toList() | |
80 })), | |
81 d.dir(name, [ | |
82 d.dir('versions', versions.map((version) { | |
83 return d.file(version.version.toString(), JSON.encode( | |
84 packageVersionApiMap(version.pubspec, full: true))); | |
85 })) | |
86 ]) | |
87 ]); | |
88 | |
89 _servedPackageDir.contents.add(d.dir(name, [ | |
90 d.dir('versions', versions.map((version) => | |
91 d.tar('${version.version}.tar.gz', version.contents))) | |
92 ])); | |
93 }); | |
94 }); | |
95 }, 'initializing the package server'); | |
96 } | |
97 | |
98 /// Like [servePackages], but instead creates an empty server with no packages | |
99 /// registered. | |
100 /// | |
101 /// This will always replace a previous server. | |
102 void serveNoPackages() => servePackages((_) {}, replace: true); | |
103 | |
104 /// A shortcut for [servePackages] that serves the version of barback used by | |
105 /// pub. | |
106 void serveBarback() { | |
107 servePackages((builder) { | |
108 builder.serveRealPackage('barback'); | |
109 }); | |
110 } | |
111 | |
112 /// A builder for specifying which packages should be served by [servePackages]. | |
113 class PackageServerBuilder { | |
114 /// A map from package names to a list of concrete packages to serve. | |
115 final _packages = new Map<String, List<_ServedPackage>>(); | |
116 | |
117 /// A group of futures from [serve] calls. | |
118 /// | |
119 /// This should be accessed by calling [_awair]. | |
120 var _futures = new FutureGroup(); | |
121 | |
122 /// Specifies that a package named [name] with [version] should be served. | |
123 /// | |
124 /// If [deps] is passed, it's used as the "dependencies" field of the pubspec. | |
125 /// If [pubspec] is passed, it's used as the rest of the pubspec. Either of | |
126 /// these may recursively contain Futures. | |
127 /// | |
128 /// If [contents] is passed, it's used as the contents of the package. By | |
129 /// default, a package just contains a dummy lib directory. | |
130 void serve(String name, String version, {Map deps, Map pubspec, | |
131 Iterable<d.Descriptor> contents}) { | |
132 _futures.add(Future.wait([ | |
133 awaitObject(deps), | |
134 awaitObject(pubspec) | |
135 ]).then((pair) { | |
136 var resolvedDeps = pair.first; | |
137 var resolvedPubspec = pair.last; | |
138 | |
139 var pubspecFields = { | |
140 "name": name, | |
141 "version": version | |
142 }; | |
143 if (resolvedPubspec != null) pubspecFields.addAll(resolvedPubspec); | |
144 if (resolvedDeps != null) pubspecFields["dependencies"] = resolvedDeps; | |
145 | |
146 if (contents == null) contents = [d.libDir(name, "$name $version")]; | |
147 contents = [d.file("pubspec.yaml", yaml(pubspecFields))] | |
148 ..addAll(contents); | |
149 | |
150 var packages = _packages.putIfAbsent(name, () => []); | |
151 packages.add(new _ServedPackage(pubspecFields, contents)); | |
152 })); | |
153 } | |
154 | |
155 /// Serves the versions of [package] and all its dependencies that are | |
156 /// currently depended on by pub. | |
157 void serveRealPackage(String package) { | |
158 _addPackage(name) { | |
159 if (_packages.containsKey(name)) return; | |
160 _packages[name] = []; | |
161 | |
162 var root = packagePath(name); | |
163 var pubspec = new Map.from(loadYaml( | |
164 readTextFile(p.join(root, 'pubspec.yaml')))); | |
165 | |
166 // Remove any SDK constraints since we don't have a valid SDK version | |
167 // while testing. | |
168 pubspec.remove('environment'); | |
169 | |
170 _packages[name].add(new _ServedPackage(pubspec, [ | |
171 d.file('pubspec.yaml', yaml(pubspec)), | |
172 new d.DirectoryDescriptor.fromFilesystem('lib', p.join(root, 'lib')) | |
173 ])); | |
174 | |
175 if (pubspec.containsKey('dependencies')) { | |
176 pubspec['dependencies'].keys.forEach(_addPackage); | |
177 } | |
178 } | |
179 | |
180 _addPackage(package); | |
181 } | |
182 | |
183 /// Returns a Future that completes once all the [serve] calls have been fully | |
184 /// processed. | |
185 Future _await() { | |
186 if (_futures.futures.isEmpty) return new Future.value(); | |
187 return _futures.future.then((_) { | |
188 _futures = new FutureGroup(); | |
189 }); | |
190 } | |
191 } | |
192 | |
193 /// A package that's intended to be served. | |
194 class _ServedPackage { | |
195 final Map pubspec; | |
196 final List<d.Descriptor> contents; | |
197 | |
198 Version get version => new Version.parse(pubspec['version']); | |
199 | |
200 _ServedPackage(this.pubspec, this.contents); | |
201 } | |
OLD | NEW |