graceful cleanup closes #8

Author: raszi

README.md

@@ -130,6 +130,17 @@ tmp.tmpName({ template: '/tmp/tmp-XXXXXX' }, function _tempNameGenerated(err, pa
 });
 ```
 
+## Graceful cleanup
+
+One may want to cleanup the temporary files even when an uncaught exception
+occurs. To enforce this, you can call the `setGracefulCleanup()` method:
+
+```javascript
+var tmp = require('tmp');
+
+tmp.setGracefulCleanup();
+```
+
 ## Options
 
 All options are optional :)

lib/tmp.js

@@ -213,6 +213,13 @@ function _garbageCollector() {
   }
 }
 
+function _gracefulCleanup() {
+  process.on('uncaughtException', function (err) {
+    _garbageCollector();
+    throw err;
+  });
+}
+
 // adding to the exit listener
 process.addListener('exit', _garbageCollector);
 
@@ -221,3 +228,4 @@ module.exports.tmpdir = _TMP;
 module.exports.dir = _createTmpDir;
 module.exports.file = _createTmpFile;
 module.exports.tmpName = _getTmpName;
+module.exports.setGracefulCleanup = _gracefulCleanup;

test/base.js

@@ -1,49 +1,60 @@
 var
   assert = require('assert'),
   path   = require('path'),
-  spawn  = require('child_process').spawn;
+  exec   = require('child_process').exec;
+
+function _spawnTest(passError, testFile, params, cb) {
+  var
+    filename,
+    command = [ 'node', path.join(__dirname, testFile) ].concat(params).join(' ');
+
+  exec(command, function _execDone(err, stdout, stderr) {
+    if (passError) {
+      if (err) {
+        return cb(err);
+      } else if (stderr.length > 0) {
+        return cb(stderr.toString());
+      }
+    }
+
+    return cb(null, stdout.toString());
+  });
+}
 
 function _testStat(stat, mode) {
-  assert.equal(stat.uid, process.getuid(), 'Should have the same UID');
-  assert.equal(stat.gid, process.getgid(), 'Should have the same GUID');
+  assert.equal(stat.uid, process.getuid(), 'should have the same UID');
+  assert.equal(stat.gid, process.getgid(), 'should have the same GUID');
   assert.equal(stat.mode, mode);
 }
 
 function _testPrefix(prefix) {
   return function _testPrefixGenerated(err, name, fd) {
-    assert.equal(path.basename(name).slice(0, prefix.length), prefix, 'Should have the provided prefix');
+    assert.equal(path.basename(name).slice(0, prefix.length), prefix, 'should have the provided prefix');
   };
 }
 
 function _testPostfix(postfix) {
   return function _testPostfixGenerated(err, name, fd) {
-    assert.equal(name.slice(name.length - postfix.length, name.length), postfix, 'Should have the provided postfix');
+    assert.equal(name.slice(name.length - postfix.length, name.length), postfix, 'should have the provided postfix');
   };
 }
 
 function _testKeep(type, keep, cb) {
-  var
-    filename,
-    cbCalled,
-    keepTest = spawn('node', [ path.join(__dirname, 'keep.js'), type, keep ]);
-
-  keepTest.stdout.on('data', function (data) {
-    filename = data.toString().replace(/\n/, "");
-  });
-  keepTest.stderr.on('data', function (data) {
-    cbCalled = true;
-    cb(new Error(data.toString()));
-  });
-  keepTest.on('exit', function _exited(code) {
-    if (cbCalled) return;
+  _spawnTest(true, 'keep.js', [ type, keep ], cb);
+}
 
-    if (code !== 0) return cb(new Error('Exited with error code: ' + code));
+function _testGraceful(type, graceful, cb) {
+  _spawnTest(false, 'graceful.js', [ type, graceful ], cb);
+}
 
-    cb(null, filename);
-  });
+function _assertName(err, name) {
+  assert.isString(name);
 }
 
+
 module.exports.testStat = _testStat;
 module.exports.testPrefix = _testPrefix;
 module.exports.testPostfix = _testPostfix;
 module.exports.testKeep = _testKeep;
+module.exports.testGraceful = _testGraceful;
+module.exports.assertName = _assertName;

test/dir-test.js

@@ -12,23 +12,21 @@ var
 
 function _testDir(mode) {
   return function _testDirGenerated(err, name) {
-    assert.ok(existsSync(name), 'Should exist');
+    assert.ok(existsSync(name), 'should exist');
 
     var stat = fs.statSync(name);
-    assert.ok(stat.isDirectory(), 'Should be a directory');
+    assert.ok(stat.isDirectory(), 'should be a directory');
 
     Test.testStat(stat, mode);
   };
 }
 
-
 vows.describe('Directory creation').addBatch({
   'when using without parameters': {
     topic: function () {
       tmp.dir(this.callback);
     },
 
-    'should not return with error': assert.isNull,
     'should be a directory': _testDir(040700),
     'should have the default prefix': Test.testPrefix('tmp-')
   },
@@ -38,7 +36,8 @@ vows.describe('Directory creation').addBatch({
       tmp.dir({ prefix: 'something' }, this.callback);
     },
 
-    'should not return with error': assert.isNull,
+    'should not return with an error': assert.isNull,
+    'should return with a name': Test.assertName,
     'should be a directory': _testDir(040700),
     'should have the provided prefix': Test.testPrefix('something')
   },
@@ -48,10 +47,10 @@ vows.describe('Directory creation').addBatch({
       tmp.dir({ postfix: '.txt' }, this.callback);
     },
 
-    'should not return with error': assert.isNull,
+    'should not return with an error': assert.isNull,
+    'should return with a name': Test.assertName,
     'should be a directory': _testDir(040700),
     'should have the provided postfix': Test.testPostfix('.txt')
-
   },
 
   'when using template': {
@@ -60,6 +59,7 @@ vows.describe('Directory creation').addBatch({
     },
 
     'should not return with error': assert.isNull,
+    'should return with a name': Test.assertName,
     'should be a file': _testDir(040700),
     'should have the provided prefix': Test.testPrefix('clike-'),
     'should have the provided postfix': Test.testPostfix('-postfix')
@@ -70,7 +70,8 @@ vows.describe('Directory creation').addBatch({
       tmp.dir({ prefix: 'foo', postfix: 'bar', mode: 0750 }, this.callback);
     },
 
-    'should not return with error': assert.isNull,
+    'should not return with an error': assert.isNull,
+    'should return with a name': Test.assertName,
     'should be a directory': _testDir(040750),
     'should have the provided prefix': Test.testPrefix('foo'),
     'should have the provided postfix': Test.testPostfix('bar')
@@ -81,7 +82,8 @@ vows.describe('Directory creation').addBatch({
       tmp.dir({ prefix: 'complicated', postfix: 'options', mode: 0755 }, this.callback);
     },
 
-    'should not return with error': assert.isNull,
+    'should not return with an error': assert.isNull,
+    'should return with a name': Test.assertName,
     'should be a directory': _testDir(040755),
     'should have the provided prefix': Test.testPrefix('complicated'),
     'should have the provided postfix': Test.testPostfix('options')
@@ -92,17 +94,16 @@ vows.describe('Directory creation').addBatch({
       tmp.dir({ tries: -1 }, this.callback);
     },
 
-    'should not be created': function (err, name) {
-      assert.isObject(err);
-    }
+    'should return with an error': assert.isObject
   },
 
   'keep testing': {
     topic: function () {
       Test.testKeep('dir', '1', this.callback);
     },
 
-    'should not return with error': assert.isNull,
+    'should not return with an error': assert.isNull,
+    'should return with a name': Test.assertName,
     'should be a dir': function(err, name) {
       _testDir(040700)(err, name);
       fs.rmdirSync(name);
@@ -115,8 +116,34 @@ vows.describe('Directory creation').addBatch({
     },
 
     'should not return with error': assert.isNull,
+    'should return with a name': Test.assertName,
+    'should not exist': function(err, name) {
+      assert.ok(!existsSync(name), "Directory should be removed");
+    }
+  },
+
+  'non graceful testing': {
+    topic: function () {
+      Test.testGraceful('dir', '0', this.callback);
+    },
+
+    'should not return with error': assert.isNull,
+    'should return with a name': Test.assertName,
+    'should be a dir': function(err, name) {
+      _testDir(040700)(err, name);
+      fs.rmdirSync(name);
+    }
+  },
+
+  'graceful testing': {
+    topic: function () {
+      Test.testGraceful('dir', '1', this.callback);
+    },
+
+    'should not return with an error': assert.isNull,
+    'should return with a name': Test.assertName,
     'should not exist': function(err, name) {
       assert.ok(!existsSync(name), "Directory should be removed");
     }
   }
-}).export(module);
+}).exportTo(module);

test/file-test.js

@@ -12,11 +12,11 @@ var
 
 function _testFile(mode, fdTest) {
   return function _testFileGenerated(err, name, fd) {
-    assert.ok(existsSync(name), 'Should exist');
+    assert.ok(existsSync(name), 'should exist');
 
     var stat = fs.statSync(name);
-    assert.equal(stat.size, 0, 'Should have zero size');
-    assert.ok(stat.isFile(), 'Should be a file');
+    assert.equal(stat.size, 0, 'should have zero size');
+    assert.ok(stat.isFile(), 'should be a file');
 
     Test.testStat(stat, mode);
 
@@ -26,8 +26,8 @@ function _testFile(mode, fdTest) {
       assert.deepEqual(fstat, stat, 'fstat results should be the same');
 
       var data = new Buffer('something');
-      assert.equal(fs.writeSync(fd, data, 0, data.length, 0), data.length, 'Should be writable');
-      assert.ok(!fs.closeSync(fd), 'Should not return with error');
+      assert.equal(fs.writeSync(fd, data, 0, data.length, 0), data.length, 'should be writable');
+      assert.ok(!fs.closeSync(fd), 'should not return with error');
     }
   };
 }
@@ -38,7 +38,8 @@ vows.describe('File creation').addBatch({
       tmp.file(this.callback);
     },
 
-    'should not return with error': assert.isNull,
+    'should not return with an error': assert.isNull,
+    'should return with a name': Test.assertName,
     'should be a file': _testFile(0100600, true),
     'should have the default prefix': Test.testPrefix('tmp-'),
     'should have the default postfix': Test.testPostfix('.tmp')
@@ -49,7 +50,8 @@ vows.describe('File creation').addBatch({
       tmp.file({ prefix: 'something' }, this.callback);
     },
 
-    'should not return with error': assert.isNull,
+    'should not return with an error': assert.isNull,
+    'should return with a name': Test.assertName,
     'should be a file': _testFile(0100600, true),
     'should have the provided prefix': Test.testPrefix('something')
   },
@@ -59,7 +61,8 @@ vows.describe('File creation').addBatch({
       tmp.file({ postfix: '.txt' }, this.callback);
     },
 
-    'should not return with error': assert.isNull,
+    'should not return with an error': assert.isNull,
+    'should return with a name': Test.assertName,
     'should be a file': _testFile(0100600, true),
     'should have the provided postfix': Test.testPostfix('.txt')
 
@@ -70,7 +73,8 @@ vows.describe('File creation').addBatch({
       tmp.file({ template: path.join(tmp.tmpdir, 'clike-XXXXXX-postfix') }, this.callback);
     },
 
-    'should not return with error': assert.isNull,
+    'should not return with an error': assert.isNull,
+    'should return with a name': Test.assertName,
     'should be a file': _testFile(0100600, true),
     'should have the provided prefix': Test.testPrefix('clike-'),
     'should have the provided postfix': Test.testPostfix('-postfix')
@@ -81,7 +85,8 @@ vows.describe('File creation').addBatch({
       tmp.file({ prefix: 'foo', postfix: 'bar', mode: 0640 }, this.callback);
     },
 
-    'should not return with error': assert.isNull,
+    'should not return with an error': assert.isNull,
+    'should return with a name': Test.assertName,
     'should be a file': _testFile(0100640, true),
     'should have the provided prefix': Test.testPrefix('foo'),
     'should have the provided postfix': Test.testPostfix('bar')
@@ -92,7 +97,8 @@ vows.describe('File creation').addBatch({
       tmp.file({ prefix: 'complicated', postfix: 'options', mode: 0644 }, this.callback);
     },
 
-    'should not return with error': assert.isNull,
+    'should not return with an error': assert.isNull,
+    'should return with a name': Test.assertName,
     'should be a file': _testFile(0100644, true),
     'should have the provided prefix': Test.testPrefix('complicated'),
     'should have the provided postfix': Test.testPostfix('options')
@@ -103,17 +109,16 @@ vows.describe('File creation').addBatch({
       tmp.file({ tries: -1 }, this.callback);
     },
 
-    'should not be created': function (err, name) {
-      assert.isObject(err);
-    }
+    'should not be created': assert.isObject
   },
 
   'keep testing': {
     topic: function () {
       Test.testKeep('file', '1', this.callback);
     },
 
-    'should not return with error': assert.isNull,
+    'should not return with an error': assert.isNull,
+    'should return with a name': Test.assertName,
     'should be a file': function(err, name) {
       _testFile(0100600, false)(err, name, null);
       fs.unlinkSync(name);
@@ -125,10 +130,36 @@ vows.describe('File creation').addBatch({
       Test.testKeep('file', '0', this.callback);
     },
 
+    'should not return with an error': assert.isNull,
+    'should return with a name': Test.assertName,
+    'should not exist': function(err, name) {
+      assert.ok(!existsSync(name), "File should be removed");
+    }
+  },
+
+  'non graceful testing': {
+    topic: function () {
+      Test.testGraceful('file', '0', this.callback);
+    },
+
     'should not return with error': assert.isNull,
+    'should return with a name': Test.assertName,
+    'should be a file': function(err, name) {
+      _testFile(0100600, false)(err, name, null);
+      fs.unlinkSync(name);
+    }
+  },
+
+  'graceful testing': {
+    topic: function () {
+      Test.testGraceful('file', '1', this.callback);
+    },
+
+    'should not return with an error': assert.isNull,
+    'should return with a name': Test.assertName,
     'should not exist': function(err, name) {
       assert.ok(!existsSync(name), "File should be removed");
     }
   }
 
-}).export(module);
+}).exportTo(module);