-
-
Notifications
You must be signed in to change notification settings - Fork 4.4k
/
npm-util.js
201 lines (154 loc) · 6.52 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
/**
* @fileoverview Tests for rule fixer.
* @author Ian VanSchooten
*/
"use strict";
//------------------------------------------------------------------------------
// Requirements
//------------------------------------------------------------------------------
const assert = require("chai").assert,
childProcess = require("child_process"),
sinon = require("sinon"),
npmUtil = require("../../../lib/util/npm-util"),
log = require("../../../lib/logging"),
mockFs = require("mock-fs");
//------------------------------------------------------------------------------
// Tests
//------------------------------------------------------------------------------
describe("npmUtil", () => {
let sandbox;
beforeEach(() => {
sandbox = sinon.sandbox.create();
});
afterEach(() => {
sandbox.verifyAndRestore();
mockFs.restore();
});
describe("checkDevDeps()", () => {
let installStatus;
before(() => {
installStatus = npmUtil.checkDevDeps(["debug", "mocha", "notarealpackage", "jshint"]);
});
it("should not find a direct dependency of the project", () => {
assert.isFalse(installStatus.debug);
});
it("should find a dev dependency of the project", () => {
assert.isTrue(installStatus.mocha);
});
it("should not find non-dependencies", () => {
assert.isFalse(installStatus.notarealpackage);
});
it("should not find nested dependencies", () => {
assert.isFalse(installStatus.jshint);
});
it("should return false for a single, non-existent package", () => {
installStatus = npmUtil.checkDevDeps(["notarealpackage"]);
assert.isFalse(installStatus.notarealpackage);
});
it("should handle missing devDependencies key", () => {
mockFs({
"package.json": JSON.stringify({ private: true, dependencies: {} })
});
const fn = npmUtil.checkDevDeps.bind(null, ["some-package"]);
assert.doesNotThrow(fn);
});
it("should throw with message when parsing invalid package.json", () => {
const logInfo = sandbox.stub(log, "info");
mockFs({
"package.json": "{ \"not: \"valid json\" }"
});
const 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()", () => {
let installStatus;
before(() => {
installStatus = npmUtil.checkDeps(["debug", "mocha", "notarealpackage", "jshint"]);
});
afterEach(() => {
mockFs.restore();
});
it("should find a direct dependency of the project", () => {
assert.isTrue(installStatus.debug);
});
it("should not find a dev dependency of the project", () => {
assert.isFalse(installStatus.mocha);
});
it("should not find non-dependencies", () => {
assert.isFalse(installStatus.notarealpackage);
});
it("should not find nested dependencies", () => {
assert.isFalse(installStatus.jshint);
});
it("should return false for a single, non-existent package", () => {
installStatus = npmUtil.checkDeps(["notarealpackage"]);
assert.isFalse(installStatus.notarealpackage);
});
it("should throw if no package.json can be found", () => {
assert.throws(() => {
installStatus = npmUtil.checkDeps(["notarealpackage"], "/fakepath");
}, "Could not find a package.json file");
});
it("should handle missing dependencies key", () => {
mockFs({
"package.json": JSON.stringify({ private: true, devDependencies: {} })
});
const fn = npmUtil.checkDeps.bind(null, ["some-package"]);
assert.doesNotThrow(fn);
});
it("should throw with message when parsing invalid package.json", () => {
const logInfo = sandbox.stub(log, "info");
mockFs({
"package.json": "{ \"not: \"valid json\" }"
});
const 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.");
logInfo.restore();
});
});
describe("checkPackageJson()", () => {
after(() => {
mockFs.restore();
});
it("should return true if package.json exists", () => {
mockFs({
"package.json": "{ \"file\": \"contents\" }"
});
assert.equal(npmUtil.checkPackageJson(), true);
});
it("should return false if package.json does not exist", () => {
mockFs({});
assert.equal(npmUtil.checkPackageJson(), false);
});
});
describe("installSyncSaveDev()", () => {
it("should invoke npm to install a single desired package", () => {
const stub = sandbox.stub(childProcess, "execSync");
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", () => {
const stub = sandbox.stub(childProcess, "execSync");
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();
});
});
describe("fetchPeerDependencies()", () => {
it("should execute 'npm show --json <packageName> peerDependencies' command", () => {
const stub = sandbox.stub(childProcess, "execSync").returns("");
npmUtil.fetchPeerDependencies("desired-package");
assert(stub.calledOnce);
assert.equal(stub.firstCall.args[0], "npm show --json desired-package peerDependencies");
stub.restore();
});
});
});