fix #137

Author: silkentrance

package.json

@@ -25,14 +25,15 @@
     "os-tmpdir": "~1.0.2"
   },
   "devDependencies": {
-    "vows": "~0.7.0"
+    "vows": "~0.7.0",
+    "mocha": "~3.4.2"
   },
   "main": "lib/tmp.js",
   "files": [
     "lib/"
   ],
   "scripts": {
-    "test": "vows test/*-test.js",
+    "test": "vows test/legacy/*-test.js && mocha",
     "doc": "jsdoc -c .jsdoc.json"
   }
 }

test/dir-sync-test.js

@@ -1,15 +1,12 @@
 /* eslint-disable no-octal */
 
 var
-  vows   = require('vows'),
   assert = require('assert'),
 
   path       = require('path'),
   fs         = require('fs'),
   existsSync = fs.existsSync || path.existsSync,
-
-  tmp    = require('../lib/tmp.js'),
-  Test   = require('./base.js');
+  tmp    = require('../lib/tmp.js');
 
 
 function _testDir(mode) {
@@ -23,98 +20,124 @@ function _testDir(mode) {
   };
 }
 
-vows.describe('Synchronous directory creation').addBatch({
-  'when using without parameters': {
-    topic: function () {
-      return tmp.dirSync();
-    },
 
-    'should return with a name': Test.assertNameSync,
-    'should be a directory': _testDir(040700),
-    'should have the default prefix': Test.testPrefixSync('tmp-')
-  },
+function assertName(name, expected) {
+  assert.ok(typeof name == 'string');
+  assert.ok(name.length > 0, 'an empty string is not a valid name');
+  if (expected) {
+    assert.equal(path.basename(name), expected, 'should be the expected name');
+  }
+}
 
-  'when using with prefix': {
-    topic: function () {
-      return tmp.dirSync({ prefix: 'something' });
-    },
 
-    'should return with a name': Test.assertNameSync,
-    'should be a directory': _testDir(040700),
-    'should have the provided prefix': Test.testPrefixSync('something')
-  },
+function assertStat(stat, mode) {
+  // getuid() and getgid() do not exist on Windows.
+  if (process.getuid) {
+    assert.equal(stat.uid, process.getuid(), 'should have the same UID');
+  }
+  if (process.getgid) {
+    // FIXME does not always work as expected
+    assert.equal(stat.gid, process.getgid(), 'should have the same GUID');
+  }
+  // mode values do not work properly on Windows. Ignore “group” and
+  // “other” bits then. Ignore execute bit on that platform because it
+  // doesn’t exist—even for directories.
+  if (process.platform == 'win32') {
+    assert.equal(stat.mode & 0666600, mode & 0666600);
+  } else {
+    assert.equal(stat.mode, mode);
+  }
+}
 
-  'when using with postfix': {
-    topic: function () {
-      return tmp.dirSync({ postfix: '.txt' });
-    },
 
-    'should return with a name': Test.assertNameSync,
-    'should be a directory': _testDir(040700),
-    'should have the provided postfix': Test.testPostfixSync('.txt')
-  },
+function assertPrefix(name, prefix) {
+  assert.equal(path.basename(name).slice(0, prefix.length), prefix, 'should have the provided prefix');
+}
 
-  'when using template': {
-    topic: function () {
-      return tmp.dirSync({ template: path.join(tmp.tmpdir, 'clike-XXXXXX-postfix') });
-    },
 
-    'should return with a name': Test.assertNameSync,
-    'should be a directory': _testDir(040700),
-    'should have the provided prefix': Test.testPrefixSync('clike-'),
-    'should have the provided postfix': Test.testPostfixSync('-postfix')
-  },
+function assertPostfix(name, postfix) {
+  assert.equal(name.slice(name.length - postfix.length, name.length), postfix, 'should have the provided postfix');
+}
 
-  'when using name': {
-    topic: function () {
-      return tmp.dirSync({ name: 'using-name' });
-    },
 
-    'should return with a name': Test.assertNameSync,
-    'should have the provided name': Test.testNameSync(path.join(tmp.tmpdir, 'using-name')),
-    'should be a directory': function (result) {
-      _testDir(040700)(result);
-      result.removeCallback();
-      assert.ok(!existsSync(result.name), 'Directory should be removed');
-    }
-  },
 
-  'when using multiple options': {
-    topic: function () {
-      return tmp.dirSync({ prefix: 'foo', postfix: 'bar', mode: 0750 });
-    },
+function _prepareInbandTests(testOpts, opts) {
+  var opts = opts || {};
+  var testOpts = testOpts || {};
 
-    'should return with a name': Test.assertNameSync,
-    'should be a directory': _testDir(040750),
-    'should have the provided prefix': Test.testPrefixSync('foo'),
-    'should have the provided postfix': Test.testPostfixSync('bar')
-  },
+  return function () {
+    var result = null;
 
-  'when using multiple options and mode': {
-    topic: function () {
-      return tmp.dirSync({ prefix: 'complicated', postfix: 'options', mode: 0755 });
-    },
+    before(function () {
+      result = tmp.dirSync(opts);
+    });
 
-    'should return with a name': Test.assertNameSync,
-    'should be a directory': _testDir(040755),
-    'should have the provided prefix': Test.testPrefixSync('complicated'),
-    'should have the provided postfix': Test.testPostfixSync('options')
-  },
+    it('should return a proper result', function () {
+      assert.ok(result != undefined);
+      assert.ok(result.name != undefined);
+      assert.ok(result.fd == undefined);
+      assert.ok(typeof result.removeCallback == 'function');
+    });
 
-  'no tries': {
-    topic: function () {
-      try {
-        return tmp.dirSync({ tries: -1 });
-      }
-      catch (e) {
-        return e;
-      }
-    },
+    it('temporary directory should exist', function () {
+      var stat = fs.statSync(result.name);
+      assert.ok(stat.isDirectory());
+    });
+
+    it('temporary directory should have the expected stats and mode', function () {
+      var stat = fs.statSync(result.name);
+      assertStat(stat, testOpts.mode || opts.mode);
+    });
 
-    'should return with an error': function (topic) {
-      assert.instanceOf(topic, Error);
+    if (opts.prefix || opts.testPrefix) {
+      it('should have the expected prefix', function () {
+        assertPrefix(result.name, testOpts.prefix || opts.prefix);
+      });
     }
-  },
+
+    if (opts.postfix || opts.testPostfix) {
+      it('should have the expected postfix', function () {
+        assertPostfix(result.name, testOpts.postfix || opts.postfix);
+      });
+    }
+
+    it('should have a valid name', function () {
+      assertName(result.name, opts.name);
+    });
+
+    it('should have a working removeCallback', function () {
+      result.removeCallback();
+      assert.ok(!existsSync(result.name));
+    });
+  };
+}
+
+
+describe('tmp', function () {
+  describe('#dirSync()', function () {
+    describe('without any parameters', _prepareInbandTests({mode: 040700, prefix: 'tmp-'}));
+    describe('with prefix', _prepareInbandTests({mode: 040700}, {prefix: 'something'}));
+    describe('with postfix', _prepareInbandTests({mode: 040700}, {postfix: '.txt'}));
+    describe('with template', _prepareInbandTests({mode: 040700, prefix: 'clike-', postfix: '.txt'}, {template: 'clike-XXXXXX-postfix'}));
+    describe('with name', _prepareInbandTests({mode: 040700}, {name: 'using-name'}));
+    describe('with mode', _prepareInbandTests(null, {mode: 0755}));
+    describe('with multiple options', _prepareInbandTests(null, {prefix: 'foo', postfix: 'bar', mode: 0750}));
+    describe('with invalid tries', function () {
+      it('should result in an error', function () {
+        try {
+          tmp.dirSync({tries: -1});
+          assert.fail('should have failed');
+        } catch (e) {
+          assert.ok(e instanceof Error);
+        }
+      });
+    });
+  });
+});
+
+
+/*
+vows.describe('Synchronous directory creation').addBatch({
 
   'keep testing': {
     topic: function () {
@@ -217,16 +240,5 @@ vows.describe('Synchronous directory creation').addBatch({
       fs.rmdirSync(name);
     }
   },
-
-  'remove callback': {
-    topic: function () {
-      return tmp.dirSync();
-    },
-
-    'should return with a name': Test.assertNameSync,
-    'removeCallback should remove directory': function (result) {
-      result.removeCallback();
-      assert.ok(!existsSync(result.name), 'Directory should be removed');
-    }
-  }
 }).exportTo(module);
+*/

test/base.js renamed to test/legacy/base.js

@@ -2,7 +2,7 @@ var
   assert = require('assert'),
   path   = require('path'),
   spawn   = require('child_process').spawn,
-  tmp    = require('../lib/tmp');
+  tmp    = require('../../lib/tmp');
 
 // make sure that we do not test spam the global tmp
 tmp.TMP_DIR = './tmp';