/
npm-util.js
210 lines (164 loc) · 6.86 KB
/
npm-util.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
/**
* @fileoverview Tests for rule fixer.
* @author Ian VanSchooten
*/
"use strict";
//------------------------------------------------------------------------------
// Requirements
//------------------------------------------------------------------------------
var assert = require("chai").assert,
fs = require("fs"),
shell = require("shelljs"),
sinon = require("sinon"),
npmUtil = require("../../../lib/util/npm-util"),
log = require("../../../lib/logging"),
mockFs = require("mock-fs");
//------------------------------------------------------------------------------
// Tests
//------------------------------------------------------------------------------
describe("npmUtil", function() {
var sandbox;
beforeEach(function() {
sandbox = sinon.sandbox.create();
});
afterEach(function() {
sandbox.verifyAndRestore();
});
describe("checkDevDeps()", function() {
var installStatus;
before(function() {
installStatus = npmUtil.checkDevDeps(["debug", "mocha", "notarealpackage", "jshint"]);
});
it("should not find a direct dependency of the project", function() {
assert.isFalse(installStatus.debug);
});
it("should find a dev dependency of the project", function() {
assert.isTrue(installStatus.mocha);
});
it("should not find non-dependencies", function() {
assert.isFalse(installStatus.notarealpackage);
});
it("should not find nested dependencies", function() {
assert.isFalse(installStatus.jshint);
});
it("should return false for a single, non-existent package", function() {
installStatus = npmUtil.checkDevDeps(["notarealpackage"]);
assert.isFalse(installStatus.notarealpackage);
});
it("should handle missing devDependencies key", function() {
sandbox.stub(fs, "existsSync", function() {
return true;
});
sandbox.stub(fs, "readFileSync", function() {
return JSON.stringify({
private: true,
dependencies: {}
});
});
var fn = npmUtil.checkDevDeps.bind(null, ["some-package"]);
assert.doesNotThrow(fn);
});
it("should throw with message when parsing invalid package.json", function() {
var logInfo = sandbox.stub(log, "info");
sandbox.stub(fs, "existsSync", function() {
return true;
});
sandbox.stub(fs, "readFileSync", function() {
return "{ \"not: \"valid json\" }";
});
var fn = npmUtil.checkDevDeps.bind(null, ["some-package"]);
assert.throws(fn, "SyntaxError: Unexpected token v");
assert(logInfo.calledOnce);
assert.equal(logInfo.firstCall.args[0], "Could not read package.json file. Please check that the file contains valid JSON.");
});
});
describe("checkDeps()", function() {
var installStatus;
before(function() {
installStatus = npmUtil.checkDeps(["debug", "mocha", "notarealpackage", "jshint"]);
});
it("should find a direct dependency of the project", function() {
assert.isTrue(installStatus.debug);
});
it("should not find a dev dependency of the project", function() {
assert.isFalse(installStatus.mocha);
});
it("should not find non-dependencies", function() {
assert.isFalse(installStatus.notarealpackage);
});
it("should not find nested dependencies", function() {
assert.isFalse(installStatus.jshint);
});
it("should return false for a single, non-existent package", function() {
installStatus = npmUtil.checkDeps(["notarealpackage"]);
assert.isFalse(installStatus.notarealpackage);
});
it("should throw if no package.json can be found", function() {
assert.throws(function() {
installStatus = npmUtil.checkDeps(["notarealpackage"], "/fakepath");
}, "Could not find a package.json file");
});
it("should handle missing dependencies key", function() {
sandbox.stub(fs, "existsSync", function() {
return true;
});
sandbox.stub(fs, "readFileSync", function() {
return JSON.stringify({
private: true,
devDependencies: {}
});
});
var fn = npmUtil.checkDeps.bind(null, ["some-package"]);
assert.doesNotThrow(fn);
fs.existsSync.restore();
fs.readFileSync.restore();
});
it("should throw with message when parsing invalid package.json", function() {
var logInfo = sandbox.stub(log, "info");
sandbox.stub(fs, "existsSync", function() {
return true;
});
sandbox.stub(fs, "readFileSync", function() {
return "{ \"not: \"valid json\" }";
});
var fn = npmUtil.checkDevDeps.bind(null, ["some-package"]);
assert.throws(fn, "SyntaxError: Unexpected token v");
assert(logInfo.calledOnce);
assert.equal(logInfo.firstCall.args[0], "Could not read package.json file. Please check that the file contains valid JSON.");
fs.existsSync.restore();
fs.readFileSync.restore();
logInfo.restore();
});
});
describe("checkPackageJson()", function() {
after(function() {
mockFs.restore();
});
it("should return true if package.json exists", function() {
mockFs({
"package.json": "{ \"file\": \"contents\" }"
});
assert.equal(npmUtil.checkPackageJson(), true);
});
it("should return false if package.json does not exist", function() {
mockFs({});
assert.equal(npmUtil.checkPackageJson(), false);
});
});
describe("installSyncSaveDev()", function() {
it("should invoke npm to install a single desired package", function() {
var stub = sandbox.stub(shell, "exec");
npmUtil.installSyncSaveDev("desired-package");
assert(stub.calledOnce);
assert.equal(stub.firstCall.args[0], "npm i --save-dev desired-package");
stub.restore();
});
it("should accept an array of packages to install", function() {
var stub = sandbox.stub(shell, "exec");
npmUtil.installSyncSaveDev(["first-package", "second-package"]);
assert(stub.calledOnce);
assert.equal(stub.firstCall.args[0], "npm i --save-dev first-package second-package");
stub.restore();
});
});
});