« index

Coverage for /Users/kris/q-io/fs-mock.js : 89%

529 lines | 476 run | 53 missing | 2 partial | 117 blocks | 80 blocks run | 37 blocks missing

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

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

  var Q = require("q");
  var Boot = require("./fs-boot");
  var Common = require("./fs-common");
  var BufferStream = require("./buffer-stream");
  var Reader = require("./reader");
  var Set = require("collections/set");
  
  module.exports = MockFs;
  
  function MockFs(files, workingDirectory) {
      if (!(this instanceof MockFs)) {
          return new MockFs(files, workingDirectory);
      }
      this._root = new DirectoryNode(this, "/");
  
      function init() {
          // construct a file tree
      }
  
      Common.update(this, function () {
          return workingDirectory;
      });
  
      workingDirectory = workingDirectory || this.ROOT;
      if (files) {
          this._init(files);
      }
  }
  
  MockFs.prototype = Object.create(Boot);
  
  MockFs.prototype._init = function (files, tree) {
      tree = tree || this.ROOT;
      Object.keys(files).forEach(function (path) {
          var content = files[path];
          path = this.join(tree, path);
          var directory = this.directory(path);
          var base = this.base(path);
          var directoryNode = this._root._walk(directory, true);
          var fileNode = new FileNode(this);
          if (!(content instanceof Buffer)) {
              if (typeof content === "object") {
                  // make directory
                  this._root._walk(path, true);
                  // make content
                  this._init(content, path);
                  return;
              } else {
                  content = new Buffer(String(content), "utf-8");
              }
          }
          directoryNode._entries[base] = fileNode;
          fileNode._chunks = [content];
      }, this);
  };
  
  MockFs.prototype.list = function (path) {
      var self = this;
      return Q.fcall(function () {
          path = self.absolute(path);
          var node = self._root._walk(path)._follow(path);
          if (!node.isDirectory()) {
              new Error("Can't list non-directory: " + JSON.stringify(path));
          }
          return Object.keys(node._entries).sort();
      });
  };
  
  MockFs.prototype.open = function (path, flags, charset, options) {
      var self = this;
      return Q.fcall(function () {
          path = self.absolute(path);
          var directory = self.directory(path);
          var base = self.base(path);
          var node = self._root._walk(directory);
          if (!node.isDirectory()) {
              throw new Error("Can't find " + path + " because " + directory + " is not a directory");
          }
          if (typeof flags == "object") {
              options = flags;
              flags = options.flags;
              charset = options.charset;
          } else {
              options = options || {};
          }
          flags = flags || "r";
          var binary = flags.indexOf("b") >= 0;
          var write = flags.indexOf("w") >= 0;
          if (!binary) {
              charset = charset || "utf-8";
          }
          if (write) {
              if (!node._entries[base]) {
                  node._entries[base] = new FileNode(this);
              }
              var fileNode = node._entries[base]._follow(path);
              if (!fileNode.isFile()) {
                  throw new Error("Can't write non-file " + path);
              }
              fileNode._lastModified = new Date();
              fileNode._lastAccessed = new Date();
              return new BufferStream(fileNode._chunks, charset);
          } else { // read
              if (!node._entries[base]) {
                  throw new Error("Can't read non-existant " + path);
              }
              var fileNode = node._entries[base]._follow(path);
              if (!fileNode.isFile()) {
                  throw new Error("Can't read non-file " + path);
              }
              fileNode._lastAccessed = new Date();
              if ("begin" in options && "end" in options) {
                  return new BufferStream(
                      [
                          Reader.join(fileNode._chunks)
                          .slice(options.begin, options.end)
                      ],
                      charset
                  );
              } else {
                  return new BufferStream(fileNode._chunks, charset);
              }
          }
      });
  };
  
  MockFs.prototype.remove = function (path) {
      var self = this;
      return Q.fcall(function () {
          path = self.absolute(path);
          var directory = self.directory(path);
          var name = self.base(path);
          var node = self._root._walk(directory);
          if (!node.isDirectory()) {
              throw new Error("Can't remove file from non-directory: " + path);
          }
          if (!node._entries[name]) {
              throw new Error("Can't remove non-existant file: " + path);
          }
          if (node._entries[name].isDirectory()) {
              throw new Error("Can't remove directory. Use removeDirectory: " + path);
          }
          delete node._entries[name];
      });
  };
  
  MockFs.prototype.makeDirectory = function (path) {
      var self = this;
      return Q.fcall(function () {
          path = self.absolute(path);
          var directory = self.directory(path);
          var name = self.base(path);
          var node = self._root._walk(directory);
          if (!node.isDirectory()) {
              var error =  new Error("Can't make directory in non-directory: " + path);
              error.code = "EEXISTS";
              error.exists = true;
              throw error;
          }
          if (node._entries[name]) {
              var error = new Error("Can't make directory. Entry exists: " + path);
              error.code = "EISDIR";
              error.exists = true;
              error.isDirectory = true;
              throw error;
          }
          node._entries[name] = new DirectoryNode(self);
      });
  };
  
  MockFs.prototype.removeDirectory = function (path) {
      var self = this;
      return Q.fcall(function () {
          path = self.absolute(path);
          var directory = self.directory(path);
          var name = self.base(path);
          var node = self._root._walk(directory);
          if (!node.isDirectory()) {
              throw new Error("Can't remove directory from non-directory: " + path);
          }
          if (!node._entries[name]) {
              throw new Error("Can't remove non-existant directory: " + path);
          }
          if (!node._entries[name].isDirectory()) {
              throw new Error("Can't remove non-directory: " + path);
          }
          delete node._entries[name];
      });
  };
  
  MockFs.prototype.stat = function (path) {
      var self = this;
      return Q.fcall(function () {
          path = self.absolute(path);
          return self._root._walk(path)._follow(path);
      });
  };
  
  MockFs.prototype.statLink = function (path) {
      var self = this;
      return Q.fcall(function () {
          path = self.absolute(path);
          var node = self._root._walk(path);
          if (!node.isSymbolicLink()) {
              throw new Error("Path is not symbolic link: " + JSON.stringify(path));
          }
          return node;
      });
  };
  
  MockFs.prototype.link = function (source, target) {
      var self = this;
      return Q.fcall(function () {
          source = self.absolute(source);
          target = self.absolute(target);
          var sourceNode = self._root._walk(source)._follow(source);
          if (!sourceNode.isFile()) {
              throw new Error("Can't link non-file: " + source);
          }
          var directory = self.directory(target);
          var base = self.base(target);
          var targetNode = self._root._walk(directory)._follow(directory);
          if (!targetNode.isDirectory()) {
              throw new Error("Can't create link in non-directory: " + target);
          }
          if (targetNode._entries[base] && targetNode._entries[base].isDirectory()) {
              throw new Error("Can't overwrite existing directory with hard link: " + target);
          }
          targetNode._entries[base] = sourceNode;
      });
  };
  
  MockFs.prototype.symbolicLink = function (target, relative, type) {
      var self = this;
      return Q.fcall(function () {
          target = self.absolute(target);
          var directory = self.directory(target);
          var base = self.base(target);
          var node = self._root._walk(directory);
          if (node._entries[base] && node._entries[base].isDirectory()) {
              throw new Error("Can't overwrite existing directory with symbolic link: " + target);
          }
          node._entries[base] = new LinkNode(self, relative);
      });
  };
  
  MockFs.prototype.chown = function (path, owner) {
      var self = this;
      return Q.fcall(function () {
          path = self.absolute(path);
          self._root._walk(path)._follow(path)._owner = owner;
      });
  };
  
  MockFs.prototype.chmod = function (path, mode) {
      var self = this;
      return Q.fcall(function () {
          path = self.absolute(path);
          self._root._walk(path)._follow(path)._mode = mode;
      });
  };
  
  MockFs.prototype.move = function (source, target) {
      var self = this;
      return Q.fcall(function () {
          source = self.absolute(source);
          target = self.absolute(target);
  
          var sourceDirectory = self.directory(source);
          var sourceDirectoryNode = self._root._walk(sourceDirectory)._follow(sourceDirectory);
          var sourceName = self.base(source);
          var sourceNode = sourceDirectoryNode._entries[sourceName];
  
          if (!sourceNode) {
              var error = new Error("Can't copy non-existent file: " + source);
              error.code = "ENOENT";
              throw error;
          }
  
          sourceNode = sourceNode._follow(source);
  
          // check again after following symbolic links
          if (!sourceNode) {
              var error = new Error("Can't copy non-existent file: " + source);
              error.code = "ENOENT";
              throw error;
          }
  
          var targetDirectory = self.directory(target);
          var targetDirectoryNode = self._root._walk(targetDirectory)._follow(targetDirectory);
          var targetName = self.base(target);
          var targetNode = targetDirectoryNode._entries[targetName]; // might not exist, not followed
  
          if (targetNode) {
              targetNode = targetNode._follow(target);
          }
  
          if (targetNode && targetNode.isDirectory()) {
              var error = new Error("Can't copy over existing directory: " + target);
              error.code = "EISDIR";
              throw error;
          }
  
          // do not copy over self, even with symbolic links to confuse the issue
          if (targetNode === sourceNode) {
              return;
          }
  
          targetDirectoryNode._entries[targetName] = sourceNode;
          delete sourceDirectoryNode._entries[sourceName];
      });
  };
  
  MockFs.prototype.readLink = function (path) {
      var self = this;
      return Q.fcall(function () {
          path = self.absolute(path);
          var node = self._root._walk(path);
          if (!self.isSymbolicLink()) {
              throw new Error("Can't read non-symbolic link: " + path);
          }
          return node._link;
      });
  };
  
  MockFs.prototype.canonical = function (path) {
      var self = this;
      return Q.fcall(function () {
          path = self.absolute(path);
          return self._root._canonical(path);
      });
  };
  
  MockFs.mock = mock;
  function mock(fs, root) {
      return Q.when(fs.listTree(root), function (list) {
          var tree = {};
          return Q.all(list.map(function (path) {
              var actual = fs.join(root, path);
              var relative = fs.relativeFromDirectory(root, actual);
              return Q.when(fs.stat(actual), function (stat) {
                  if (stat.isFile()) {
                      return Q.when(fs.read(path, "rb"), function (content) {
                          tree[relative] = content;
                      });
                  }
              });
          })).then(function () {
              return MockFs(tree);
          });
      });
  }
  
  function Node(fs) {
      if (!fs)
          throw new Error("FS required argument");
      this._fs = fs;
      this._accessed = this._modified = new Date();
      this._mode = parseInt("0644", 8);
      this._owner = null;
  }
  
  Node.prototype._walk = function (path, make, via) {
      var parts = this._fs.split(path);
      if (this._fs.isAbsolute(path)) {
          parts.shift();
          return this._fs._root._walkParts(parts, make, this._fs.ROOT);
      } else {
          return this._walkParts(parts, make, via || this._fs.ROOT);
      }
  };
  
  Node.prototype._walkParts = function (parts, make, via) {
      if (parts.length === 0) {
          return this;
      } else {
          var part = parts.shift();
          if (part === "") {
              return this._walkParts(parts, make, this._fs.join(via, part));
          } else {
              throw new Error("Can't find " + JSON.stringify(this._fs.resolve(part, this._fs.join(parts))) + " via " + JSON.stringify(via));
          }
      }
  };
  
  Node.prototype._canonical = function (path) {
      if (!this._fs.isAbsolute(path)) {
          throw new Error("Path must be absolute for _canonical: " + path);
      }
      var parts = this._fs.split(path);
      parts.shift();
      var via = this._fs.ROOT;
      return via + this._fs._root._canonicalParts(parts, via);
  };
  
  Node.prototype._canonicalParts = function (parts, via) {
      if (parts.length === 0) {
          return via;
      }
      return this._fs.join(via, this._fs.join(parts));
  };
  
  Node.prototype._follow = function () {
      return this;
  };
  
  Node.prototype._touch = function () {
      this._modified = new Date();
  };
  
  var stats = [
      "isDirectory",
      "isFile",
      "isBlockDevice",
      "isCharacterDevice",
      "isSymbolicLink",
      "isFIFO",
      "isSocket"
  ];
  
  stats.forEach(function (name) {
      Node.prototype[name] = function () {
          return false;
      };
  });
  
  Node.prototype.lastAccessed = function () {
      return this._accessed;
  };
  
  Node.prototype.lastModified = function () {
      return this._modified;
  };
  
  function FileNode(fs) {
      Node.call(this, fs);
      this._chunks = [];
  }
  
  FileNode.prototype = Object.create(Node.prototype);
  
  FileNode.prototype.isFile = function () {
      return true;
  };
  
  function DirectoryNode(fs) {
      Node.call(this, fs);
      this._entries = Object.create(null);
      this._mode = parseInt("0755", 8);
  }
  
  DirectoryNode.prototype = Object.create(Node.prototype);
  
  DirectoryNode.prototype.isDirectory = function () {
      return true;
  };
  
  DirectoryNode.prototype._walkParts = function (parts, make, via) {
      via = via || this._fs.ROOT;
      if (parts.length === 0) {
          return this;
      }
      var part = parts.shift();
      if (part === "") {
          return this._walkParts(parts, make, this._fs.join(via, part));
      }
      if (!this._entries[part]) {
          if (make) {
              this._entries[part] = new DirectoryNode(this._fs);
          } else {
              throw new Error("Can't find " + JSON.stringify(this._fs.join(parts)) + " via " + JSON.stringify(via));
          }
      }
      return this._entries[part]._walkParts(parts, make, this._fs.join(via, part));
  };
  
  DirectoryNode.prototype._canonicalParts = function (parts, via) {
      if (parts.length === 0) {
          return via;
      }
      var part = parts.shift();
      if (part === "") {
          return via;
      }
      if (via === this._fs.ROOT) {
          via = "";
      }
      if (!this._entries[part]) {
          return this._fs.join(via, part, this._fs.join(parts));
      }
      return this._entries[part]._canonicalParts(
          parts,
          this._fs.join(via, part)
      );
  };
  
  function LinkNode(fs, link) {
      Node.call(this, fs);
      this._link = link;
  }
  
  LinkNode.prototype = Object.create(Node.prototype);
  
  LinkNode.prototype.isSymbolicLink = function () {
      return true;
  };
  
  LinkNode.prototype._follow = function (via, memo) {
      memo = memo || Set();
      if (memo.has(this)) {
          var error = new Error("Can't follow symbolic link cycle at " + JSON.stringify(via));
          error.code = "ELOOP";
          throw error;
      }
      memo.add(this);
      var link = this._fs.join(via, "..", this._link);
      return this._walk(link, null, "<link>")._follow(link, memo);
  };
  
  LinkNode.prototype._canonicalParts = function (parts, via) {
      return this._fs.relativeFromDirectory(this._fs.ROOT,
          this._fs._root._canonical(
              this._fs.absolute(this._fs.join(via, "..", this._link))
          )
      );
  };
  
  // cycle breaking
  var FS = require("./fs");
« index | cover.io