Wie kann ich die stub node.js built-in fs während der Prüfung?

Ich mag mit rewire for stubbing out-verlangen (...) - Anweisungen

- Modul Unter test

module-a.js

var fs = require('fs')
function findFile(path, callback) {
  fs.readdir(path, function(err, files) {
     //Do something.
  })
}

Test-Code

module-a-test.js

var rewire = require('rewire')
var moduleA = rewire('./moduleA')
//stub out fs
var fsStub = {
  readdir: function(path, callback) {
     console.log('fs.readdir stub called')
     callback(null, [])
  }
}
moduleA.__set__('fs', fsStub)
//call moduleA which now has a fs stubbed out
moduleA()

Alternative (obwohl ich denke, dass Noah ' s Vorschlag von rewire ist besser):

Schreiben Sie ein wrapper um require namens requireStubbable oder so. Setzen Sie diese in einem Modul, welches Sie konfigurieren einmal, in test-setup-code. Da Knoten caches Ergebnis benötigen, Wann immer Sie benötigen, die requireStubbable Modul wieder, würden Sie erhalten die gleiche Funktion konfiguriert. Könntest du Sie so konfigurieren, dass eine beliebige Anzahl von Modulen wäre durch Stubs ersetzt werden, alles andere wäre bestanden unverändert weiter.

Jedes Modul, das Sie wollen, um zu unterstützen die Weitergabe in stubs müssen die requireStubbable Funktion statt der regulären require obwohl. Die rewire-Modul nicht haben, der Nachteil, und stattdessen gibt die Kontrolle an den aufrufenden code.

Hinzugefügt 26. April

Ich habe noch nie gemerkt, aber da das Objekt (genauer: Objekt-Referenz) zurückgegeben require("fs") zwischengespeichert ist, können Sie einfach tun:

const fs = require("fs")
fs.readFile = function (filename, cb) {
  cb(null, new Buffer("fake contents"));
};
//etc

Wenn Sie diesen code überall fs.readFile zeigen, um die oben genannten Funktion überall.
Dies funktioniert für die Lunte aus jedem Modul ist eine Reine Ansammlung von Funktionen (wie die meisten built-in-Module). Die Fälle, bei denen es nicht funktioniert, wenn das Modul gibt eine einzige Funktion. Für diese, etwas wie rewire notwendig wäre.

Hier ist, wie ich denke, dieses:

Die Art und Weise Sie es tun, ist die offensichtliche erste Schritt, aber es saugt zu müssen, passieren diese Dinge überall— Anrufer Ihre Funktionen sollten sich nicht darauf, dass Sie möchten, um zu testen mit mocks. Sie wollen nicht einfach nur überschreiben oder monkey-patch die Globale Module in den globalen namespace für deinen test. Und die normale dependency injection-Modell ist ziemlich ausführlich in Javascript, da es keine class-lokal.

Also um das ganze Modul, ich habe getan, wie (function(fs, net, http) { … })(fs, net, http);

Dann in dem Modul, wenn es eine Klasse mit Konstruktor, machen die verhöhnt optional zusätzliche Parameter an den Konstruktor (oder die möglichen Eigenschaften eines einzelnen mocks Objekt-parameter oder sowas) und Ihr test geht in die verhöhnt. Ihr Konstruktor überschreibt den tatsächlichen node-Module innerhalb des Moduls im lokalen Bereich.

Abwechselnd, wenn das Modul nur statische Funktionen; haben eine solche Funktion initialisiert die verhöhnt, Sie können überprüfen, dass die Funktion nicht aufgerufen wird, in Ihrer prod code.

Verwenden memfs in-memory-Dateisystem.

Hier eine version, die funktioniert mit dem fs.verspricht api:

const fsMock = sinon.mock(fs.promises);
fsMock.expects('readFile').withArgs('test.json').returns(Promise.resolve(Buffer.from('{}')));

const val = await fs.promises.readFile('test.json');

expect(val.toString()).toEqual('{}');
fsMock.verify();