fs-mock

fs-mock

Mock for fs module

Installation

$ npm install fs-mock

Usage

This module does not change original fs module in any way.

If you want to pass this module into other module, you will have to use for example rewire package.

var FS = require('fs-mock');
var fs = new FS({
	'var': {},											// empty directory
	'var/www/index.php': '',							// empty file in /var/www, so directory var is now not empty
	'home/david/documents/school/projects': {},
	'home': {
		'david': {},
		'john': {
			'password.txt': 'my super password'			// file
		}
	}
});

var myPassword = fs.readFileSync('/home/john/password.txt', {encoding: 'utf8'});		// my super password

If you write some path like this: home/david/documents/school/projects, it will be automatically expanded and all its parent directories will be also added to mocked file system.

Supported functions

There are also all *Sync methods.

Calling unsupported methods will throw an exception.

Fs object:

• fs.rename(): yes
• fs.ftruncate(): yes
• fs.truncate(): yes
• fs.chown(): yes
• fs.fchown(): yes
• fs.lchown(): yes
• fs.chmod(): yes
• fs.fchmod(): yes
• fs.lchmod(): yes
• fs.stat(): yes
• fs.lstat(): yes
• fs.fstat(): yes
• fs.link(): yes
• fs.symlink(): yes (type argument is ignored)
• fs.readlink(): yes
• fs.realpath(): yes
• fs.unlink(): yes
• fs.rmdir(): yes
• fs.mkdir(): yes
• fs.readdir(): yes
• fs.close(): yes
• fs.open(): yes
• fs.utimes(): yes
• fs.futimes(): yes
• fs.write(): yes
• fs.read(): yes
• fs.readFile(): yes
• fs.writeFile(): yes
• fs.appendFile(): yes
• fs.watchFile(): no (use fs.watch())
• fs.unwatchFile(): no (use fs.watch())
• fs.watch(): yes (persistent option is ignored)
• fs.exists(): yes
• fs.createReadStream(): yes
• fs.createWriteStream(): yes

Stats object:

• dev: no
• ino: no
• mode: yes
• nlink: no
• uid: yes
• gid: yes
• rdev: no
• size: yes
• blksize: yes
• blocks: yes
• atime: yes
• mtime: yes
• ctime: yes
• isFile(): yes
• isDirectory(): yes
• isBlockDevice(): no
• isCharacterDevice(): no
• isSymbolicLink(): yes
• isFIFO(): no
• isSocket(): no

Tests

$ npm test

Changelog

• 1.0.1

  • Bug with root directories and readdir method

• 1.0.0

  • First version