Node.js 的 require 好用的代價,是依賴在模組載入的那一刻就被綁死了。這讓「測試時換掉某個依賴」變得棘手。本文說明問題的成因,並給出一個以內建模組 vm 實作的可行解法。
想用依賴注入把程式寫鬆一點,動機很正當:關注點分離、容易測試。但在 Node 裡有個特殊的障礙——模組往往直接依賴系統 API,例如 fs:
var fs = require('fs');
module.exports = {
// 直接用 fs 做些事
};
當你想在測試中驗證「這個模組是怎麼使用 fs 的」,就會發現無從下手:require 有快取,同一個模組只會被載入一次;也沒有現成的參數可以塞入假的 fs。相比 RequireJS 這類 AMD 載入器能攔截載入過程,Node 的機制把這扇門關得比較緊。
Node 提供了 vm 模組,可以在全新的上下文中執行一段程式碼。既然我們能自己定義那個上下文的內容,也就能自己決定 require 長什麼樣子。以下是一個可作為單元測試輔助工具的模組載入器:
var vm = require('vm');
var fs = require('fs');
var path = require('path');
/**
* 單元測試輔助工具:
* - 載入模組並替換其依賴
* - 可存取模組的私有狀態
*
* @param {string} filePath 欲載入模組的絕對路徑
* @param {Object=} mocks 被模擬的依賴對照表
*/
exports.loadModule = function (filePath, mocks) {
mocks = mocks || {};
// 讓模組內的相對路徑 require 能被正確解析
var resolveModule = function (module) {
if (module.charAt(0) !== '.') return module;
return path.resolve(path.dirname(filePath), module);
};
var exports = {};
var context = {
require: function (name) {
return mocks[name] || require(resolveModule(name));
},
console: console,
exports: exports,
module: { exports: exports }
};
vm.runInNewContext(fs.readFileSync(filePath), context);
return context;
};
兩個參數各有分工。filePath 指定要測試的模組位置;mocks 是一個對照表,鍵名對應程式碼中 require 的字串,值則是準備好的假物件。
本質上,我們是在另一個「上下文」裡重建了 require、exports、module 這些平時由 Node 提供的全域變數。新的 require 做的事很單純:先看這個名字有沒有被模擬,有的話就回傳假物件,沒有就退回真正的 require。這樣一來,模組裡原本的 require('fs') 拿到的就是我們準備的替代品。
以下用 Jasmine 語法示範,替換 fs 來觀察模組的內部行為:
describe('someModule', function () {
var loadModule = require('module-loader').loadModule;
var module, fsMock;
beforeEach(function () {
fsMock = {
// 在這裡定義 fs 的假實作
};
// 用假的 fs 取代真的 fs 來載入模組
module = loadModule('./web-server.js', { fs: fsMock });
});
it('should work', function () {
// 斷言這裡可以利用我們完全掌控的 fs
});
});
重點是 beforeEach 那幾行:我們建立一個假物件,透過 loadModule 把它綁到測試目標上。之後測試就能自由決定 fs 回傳什麼、記錄哪些呼叫,不必真的碰觸檔案系統。
它有效,但不是沒有成本。用 vm 讀檔並重新執行,比單純 require 慢;模組內的相對路徑要自己處理(範例中的 resolveModule 就是為此而生);除錯堆疊也會因為換了語境而變得不如原本直觀。
因此在今天的專案中,若測試隔離是主要目標,通常會優先考慮 proxyquire、mock-require 這類專門的模擬函式庫,或乾脆把外部依賴當參數傳進建構子,從設計上打開注入點。vm 這條路仍然值得知道——它展示了「上下文即介面」的可能性,在需要讀取模組私有狀態、或要在沙箱中執行不受信任程式碼時,是少數能派上用場的工具。