-
Notifications
You must be signed in to change notification settings - Fork 15
/
virtualenv.js
311 lines (252 loc) · 10.3 KB
/
virtualenv.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
var fs = require("fs");
var path = require("path");
var childProcess = require("child_process");
var crypto = require("crypto");
var tar = require("tar");
var zlib = require("zlib");
var glob = require("glob");
var rimraf = require("rimraf");
var request = require("request");
var semver = require("semver");
var pypi = require("./pypi");
var VERSION = require("../package.json").version;
function VirtualEnv(packagePath) {
// Details come directly from the given package.json
// TODO: autodetect packagePath (when null) based on previous stack frame
var package = require(packagePath);
package.virtualenv = package.virtualenv || {};
this._version = package.virtualenv.version || "*";
this._createFlags = package.virtualenv.flags || [];
this._python = package.virtualenv.python || "python";
// Read requirements from requirements.txt if it exists.
this._requirements = path.join(path.dirname(packagePath), "requirements.txt");
if (!fs.existsSync(this._requirements)) {
throw new Error("missing requirements.txt in " + path.dirname(packagePath));
}
// Figure out our paths.
this._virtualenvHome = path.join(path.dirname(packagePath), ".node-virtualenv");
this._virtualenvMetaHome = path.join(this._virtualenvHome, ".node-virtualenv.json");
this._virtualenvSourcesHome = path.join(this._virtualenvHome, ".node-virtualenv-sources");
// Hash the current virtualenv state to determine if a reinstall is actually
// Reinstallation should happen only when one of the following changes:
// 1. Version changes in node-virtualenv (VERSION)
// 2. Virtualenv config changes (package.virtualenv)
// 3. Postinstall script changes (package.scripts.postinstall)
// 4. Dependencies change (requirements.txt)
// Therefore the hash contains all three of these factors.
// TODO: intelligently pip install -U when only the pip dependencies changed
var md5 = crypto.createHash("md5");
md5.update([
VERSION,
JSON.stringify(package.virtualenv),
JSON.stringify(package.scripts ? package.scripts.postinstall : ""),
fs.readFileSync(this._requirements)
].join(""));
this._expectedHash = md5.digest("hex");
// Allow installation progress to be logged on alternative
// streams, but default to to stdout and stderr.
this._stdout = process.stdout;
this._stderr = process.stderr;
}
VirtualEnv.prototype.install = function install(callback) {
// Helper for starting the installation from the pip step.
function continueFromPip(version) {
this._pip(function(err) {
if (err) return callback(err);
// Write the current hash from the package since this installation
// was successful.
this._setMeta("currentHash", this._expectedHash);
this._setMeta("currentVersion", version);
callback();
}.bind(this));
}
continueFromPip = continueFromPip.bind(this);
// Skip install if it isn't necessary.
if (this._virtualenvIsUnchanged()) {
return continueFromPip(this._getMeta("currentVersion"))
}
// Find the correct download URL on pypi.
this._find(function(err, version, url) {
if (err) return callback(err);
// Create helpers that allow us to pick up the installation process
// at any stage.
function continueFromCreate() {
this._create(version, function(err) {
if (err) return callback(err);
continueFromPip(version);
}.bind(this));
}
continueFromCreate = continueFromCreate.bind(this);
// Skip download and virtualenv creation if all we need are pip updates.
if (this._virtualenvOnlyNeedsPipUpdates(version)) {
continueFromPip(version);
// Skip download if we already have the correct virtualenv source.
} else if (this._virtualenvSourceIsReady(version)) {
continueFromCreate();
// Otherwise do the download first.
} else {
this._download(url, function(err) {
if (err) return callback(err);
continueFromCreate();
}.bind(this));
}
}.bind(this));
}
VirtualEnv.prototype.spawn = function spawn(command, args, options) {
var pathToVirtualenvCommand = path.join(this._virtualenvHome, "bin", command);
return childProcess.spawn(pathToVirtualenvCommand, args, options);
}
VirtualEnv.prototype.spawnPython = function spawnPython(args, options) {
var pathToPython = path.join(this._virtualenvHome, "bin", "python");
return childProcess.spawn(pathToPython, args, options);
}
VirtualEnv.prototype.spawn32bitOSXPython = function spawn32bitOSXPython(args, options) {
var pathToPython = path.join(this._virtualenvHome, "bin", "python");
return childProcess.spawn("arch", ["-i386"].concat([pathToPython]).concat(args), options);
}
VirtualEnv.prototype._reportProgress = function _reportProgress(action, target) {
this._stdout.write(action + " " + target + "\n");
}
VirtualEnv.prototype._find = function _find(callback) {
// Find the available versions of virtualenv.
var targetVersion = this._version;
var client = new pypi.Client();
this._reportProgress("Finding", "virtualenv " + targetVersion);
client.getPackageReleases("virtualenv", function(versions) {
if (!versions || !versions.length) return callback(new Error("virtualenv not found on pypi"));
// Find the latest valid version.
var latestValidVersion;
versions.sort(function(a, b) {
return semver.lt(a, b);
}).some(function(version) {
if (semver.satisfies(version, targetVersion)) {
latestValidVersion = version;
return true;
}
});
if (!latestValidVersion) return callback(new Error("virtualenv " + targetVersion + " not found"));
// Figure out the tarball URL for this version.
client.getReleaseUrls("virtualenv", latestValidVersion, function(urls) {
if (!urls || !urls.length) return callback(new Error("unable to find URL for virtualenv " + latestValidVersion));
var tarballUrl;
urls.some(function(url) {
if (/\.tar\.gz$/.test(url.url)) {
tarballUrl = url.url;
return true;
}
});
if (!tarballUrl) return callback(new Error("unable to find a tarball for virtualenv " + latestValidVersion));
callback(null, latestValidVersion, tarballUrl);
// Propagate pypi error callback.
}, function(err) {
callback(new Error("unable to retrieve release URLs for virtualenv " + latestValidVersion));
});
// Propagate pypi error callback.
}, function(err) {
callback(new Error("unable to retrieve version information for virtualenv"));
});
}
VirtualEnv.prototype._download = function _download(url, callback) {
// Remove the previous copy of our virtualenv download if there was one.
try {
rimraf.sync(this._virtualenvSourcesHome);
} catch(err) {
return callback(err);
}
// Stream the download through unzipping to the final destination.
var downloadStream = request(url);
var gunzipStream = zlib.createGunzip();
var untarStream = tar.Extract({path: this._virtualenvSourcesHome});
var finalStream = downloadStream.pipe(gunzipStream).pipe(untarStream);
// Call the callback with either error or success when this is finished.
finalStream.on("error", function(err) {
if (callback) callback(err);
callback = null;
});
finalStream.on("end", function() {
if (callback) callback();
callback = null;
});
// Emit helpful events to track progress.
this._reportProgress("Downloading", url);
downloadStream.on("end", function() {
this._reportProgress("Unzipping", url);
}.bind(this));
}
VirtualEnv.prototype._create = function _create(version, callback) {
// Remove the old virtualenv if necessary. Always leave the sources
// directory intact though, so additional downloading can be avoided.
this._reportProgress("Creating", this._virtualenvHome);
try {
var oldFiles = glob.sync(path.join(this._virtualenvHome, "*"), {dot: true});
oldFiles.forEach(function(file) {
if (file !== this._virtualenvSourcesHome) {
this._reportProgress("Cleaning", file);
rimraf.sync(file);
}
}.bind(this));
} catch(err) {
return callback(err);
}
// Create new virtualenv in ".node-virtualenv"
var sourcePath = this._getPathToSourceForVersion(version);
var createProc = childProcess.spawn(this._python,
["virtualenv.py"].concat(this._createFlags).concat([this._virtualenvHome]),
{cwd: sourcePath}
);
createProc.stderr.pipe(this._stderr);
createProc.stdout.pipe(this._stdout);
createProc.on("exit", function(code) {
if (code) return callback(new Error("Error while creating virtualenv: exit " + code));
callback();
}.bind(this));
}
VirtualEnv.prototype._pip = function _pip(callback) {
// Install Python dependencies into the virtualenv created in the create step.
this._reportProgress("Installing", this._virtualenvHome);
var pipProc = childProcess.spawn("bin/pip",
["install", "-r", this._requirements],
{cwd: this._virtualenvHome}
);
pipProc.stderr.pipe(this._stderr);
pipProc.stdout.pipe(this._stdout);
pipProc.on("exit", function(code) {
if (code) return callback(new Error("Error while installing dependencies in virtualenv: exit " + code));
callback();
}.bind(this));
}
VirtualEnv.prototype._getMeta = function _getMeta(key, defaultValue) {
try {
return JSON.parse(fs.readFileSync(this._virtualenvMetaHome))[key];
} catch(err) {
return defaultValue;
}
}
VirtualEnv.prototype._setMeta = function _setMeta(key, value) {
var meta = {};
try {
meta = JSON.parse(fs.readFileSync(this._virtualenvMetaHome));
} catch(err) {
meta = {};
}
meta[key] = value;
fs.writeFileSync(this._virtualenvMetaHome, JSON.stringify(meta));
}
VirtualEnv.prototype._getPathToSourceForVersion = function _getPathToSourceForVersion(version) {
return path.join(this._virtualenvSourcesHome, "virtualenv-" + version)
}
VirtualEnv.prototype._virtualenvIsUnchanged = function _virtualenvIsUnchanged() {
return this._getMeta("currentHash") === this._expectedHash;
}
VirtualEnv.prototype._virtualenvSourceIsReady = function _virtualenvSourceIsReady(version) {
return fs.existsSync(path.join(
this._getPathToSourceForVersion(version),
"virtualenv.py"
));
}
VirtualEnv.prototype._virtualenvOnlyNeedsPipUpdates = function _virtualenvOnlyNeedsPipUpdates(version) {
return this._getMeta("currentVersion") === version;
}
module.exports = function virtualenv(packagePath, options) {
return new VirtualEnv(packagePath, options);
}