Tidy up tests (#294)

* Tidy up tests

* Add nyc coverage tool
* Remove `env-test`: it's a single line for the cost of a module
* Set NODE_ENV in custom set up file
* Stub console for each test individually globally
* Plus: a `sinon.restore()` in global afterEach prevents cross test leaks
* Add most basic test for `Tldr` class, just to trigger coverage
* Remove surplus mocha args:
	* It always looks in test dir
	* `mocha.opts` provides a more consistent approach
* Ignore coverage files now created by nyc

* Add `'use strict'`

* Fix missing semi

* Use `.mocharc.js` instead of `mocha.opts`

* fix package lock to use main npm registry

Co-authored-by: Jason <[email protected]>

Author: OiYouYeahYou

.gitignore

@@ -2,3 +2,5 @@ node_modules
 .DS_Store
 npm-debug.log
 .idea
+coverage/
+.nyc_output

.mocharc.js

@@ -0,0 +1,4 @@
+module.exports = {
+  recursive: true,
+  file:['./test/mocha.js'],
+};

package-lock.json

@@ -41,11 +41,12 @@
   "scripts": {
     "start": "node ./bin/tldr",
     "example": "node ./bin/tldr tar",
-    "test": "mocha test --require=env-test",
-    "test:quiet": "npm test --reporter=dot",
+    "test": "mocha",
+    "test:quiet": "mocha --reporter=dot",
     "lint": "eslint lib test bin/tldr",
-    "watch": "mocha test --require=env-test --reporter=min --watch --growl",
+    "watch": "mocha --reporter=min --watch --growl",
     "test:functional": "bash test/functional-test.sh",
+    "test:coverage": "nyc mocha",
     "test:all": "npm run lint && npm test && npm run test:functional"
   },
   "dependencies": {
@@ -62,10 +63,10 @@
     "request": "^2.88.0"
   },
   "devDependencies": {
-    "env-test": "^1.0.0",
     "eslint": "^5.16.0",
     "husky": "^2.4.1",
     "mocha": "^6.2.3",
+    "nyc": "^15.0.1",
     "should": "^13.2.3",
     "sinon": "^7.3.2"
   },

package.json

@@ -0,0 +1,13 @@
+'use strict';
+
+process.env.NODE_ENV = 'test';
+
+const sinon = require('sinon');
+
+beforeEach(() => {
+  sinon.stub(console);
+});
+
+afterEach(() => {
+  sinon.restore();
+});

test/mocha.js

@@ -100,12 +100,11 @@ describe('Render', () => {
       'theme': 'bad'
     };
 
-    let spy = sinon.spy(console, 'error');
     let text = render.toANSI({
       name: 'tar',
       description: 'archive utility',
     }, config);
     should.not.exist(text);
-    spy.getCall(0).args[0].should.equal('invalid theme: bad');
+    console.error.getCall(0).args[0].should.equal('invalid theme: bad');
   });
 });

test/mocha.opts

@@ -156,7 +156,6 @@ let restoreStubs = (stubs) => {
 describe('Search', () => {
   it('should create index', function(done) {
     let stubs = [];
-    sinon.stub(console, 'log').returns();
     stubs.push(sinon.stub(utils, 'glob').callsFake(fakes.utils.glob));
     stubs.push(sinon.stub(fs, 'readFile').callsFake(fakes.fs.readFile));
     stubs.push(sinon.stub(fs, 'writeFile').callsFake(fakes.fs.writeFile));
@@ -165,19 +164,16 @@ describe('Search', () => {
       Object.keys(data.invertedIndex).length.should.equal(56); // eslint-disable-line
       data.invertedIndex['roxi'][0].should.equal('/path/to/file-11.md');
       testData.corpus = data;
-      console.log.restore();
       done();
     }).catch((error) => {
       should.not.exist(error);
-      console.log.restore();
       done(error);
     }).then(() => {
       restoreStubs(stubs);
     });
   });
   it('should perform searches', function(done) {
     let stubs = [];
-    sinon.stub(console, 'log').returns();
     stubs.push(sinon.stub(fs, 'readFile').callsFake(fakes.fs.readFile));
     stubs.push(sinon.stub(fs, 'writeFile').callsFake(fakes.fs.writeFile));
     stubs.push(sinon.stub(index, 'getShortIndex').callsFake(fakes.index.getShortIndex));
@@ -194,13 +190,11 @@ describe('Search', () => {
       return search.getResults('Joe and Roxie').then((data) => {
         data.length.should.equal(8); // eslint-disable-line
         data[1].file.should.equal('/path/to/file-16.md');
-        console.log.restore();
         done();
         return Promise.resolve();
       });
     }).catch((error) => {
       should.not.exist(error);
-      console.log.restore();
       done(error);
     }).then(() => {
       restoreStubs(stubs);

test/render.spec.js

@@ -0,0 +1,10 @@
+'use strict';
+
+const TLDR = require('../lib/tldr');
+
+describe('TLDR class', () => {
+  it('should construct', () => {
+    const tldr = new TLDR({ cache: 'some-random-string' });
+    tldr.should.exist;
+  });
+});