Enforce test coverage, tolerate gaps, and begin to remove them (#175)

* Enforce 100% code coverage

* Enable test coverage verification for test helper

Some code paths which are intended to improve error reports for test
failures. They are not expected to be used when all tests are passing.

Tolerate coverage gaps for these specific code paths.

* Improve coverage for `Airtable` interface

.gitignore

@@ -1 +1,3 @@
 node_modules
+/.nyc_output/
+/coverage/

lib/airtable_error.js

@@ -1,3 +1,4 @@
+// istanbul ignore file
 'use strict';
 
 function AirtableError(error, message, statusCode) {

lib/base.js

@@ -1,3 +1,4 @@
+// istanbul ignore file
 'use strict';
 
 var forEach = require('lodash/forEach');

lib/callback_to_promise.js

@@ -1,3 +1,4 @@
+// istanbul ignore file
 'use strict';
 
 var Promise = require('./promise');

lib/deprecate.js

@@ -1,3 +1,4 @@
+// istanbul ignore file
 'use strict';
 
 var didWarnForDeprecation = {};

lib/http_headers.js

@@ -1,3 +1,4 @@
+// istanbul ignore file
 var forEach = require('lodash/forEach');
 
 var isBrowser = typeof window !== 'undefined';

lib/object_to_query_param_string.js

@@ -1,3 +1,4 @@
+// istanbul ignore file
 'use strict';
 
 var isArray = require('lodash/isArray');

lib/promise.js

@@ -1,3 +1,4 @@
+// istanbul ignore file
 /* global Promise */
 var polyfill = require('es6-promise');
 

lib/query.js

@@ -1,3 +1,4 @@
+// istanbul ignore file
 'use strict';
 
 var isPlainObject = require('lodash/isPlainObject');

lib/record.js

@@ -1,3 +1,4 @@
+// istanbul ignore file
 'use strict';
 
 var assign = require('lodash/assign');

lib/run_action.js

@@ -1,3 +1,4 @@
+// istanbul ignore file
 'use strict';
 
 var exponentialBackoffWithJitter = require('./exponential_backoff_with_jitter');

lib/table.js

@@ -1,3 +1,4 @@
+// istanbul ignore file
 'use strict';
 
 var isArray = require('lodash/isArray');

lib/typecheck.js

@@ -1,3 +1,4 @@
+// istanbul ignore file
 'use strict';
 
 var includes = require('lodash/includes');

package.json

@@ -6,10 +6,12 @@
   "repository": "git://github.com/airtable/airtable.js.git",
   "private": false,
   "scripts": {
+    "coverage": "jest --env node --coverage",
     "pretest": "npm run lint",
     "lint": "eslint .",
     "format": "prettier --write '**/*.js'",
-    "test": "jest --env node"
+    "test": "npm run coverage && npm run test-unit",
+    "test-unit": "jest --env node"
   },
   "dependencies": {
     "es6-promise": "4.2.8",
@@ -29,6 +31,16 @@
     "/build/airtable.browser.js",
     "/lib/"
   ],
+  "jest": {
+    "coverageThreshold": {
+      "global": {
+        "branches": 100,
+        "functions": 100,
+        "lines": 100,
+        "statements": 100
+      }
+    }
+  },
   "devDependencies": {
     "body-parser": "^1.19.0",
     "envify": "^4.1.0",

test/airtable.test.js

@@ -10,4 +10,73 @@ describe('Airtable', function() {
             expect(value).not.toEqual('keyXyz');
         });
     });
+
+    it('recognizes API key as a property of the constructor', function() {
+        try {
+            Airtable.apiKey = 'keyAbc';
+            new Airtable({});
+            new Airtable();
+        } finally {
+            delete Airtable.apiKey;
+        }
+    });
+
+    it('recognizes API key as an environment variable', function() {
+        try {
+            process.env.AIRTABLE_API_KEY = 'keyDef';
+            new Airtable({});
+            new Airtable();
+        } finally {
+            delete process.env.AIRTABLE_API_KEY;
+        }
+    });
+
+    it('throws when API key is not provided', function() {
+        expect(function() {
+            new Airtable({});
+        }).toThrow();
+
+        expect(function() {
+            new Airtable();
+        }).toThrow();
+    });
+
+    describe('configure static method', function() {
+        it('sets the apiKey', function() {
+            Airtable.configure({apiKey: 'keyGhi'});
+
+            try {
+                expect(Airtable.apiKey).toEqual('keyGhi');
+            } finally {
+                delete Airtable.apiKey;
+            }
+        });
+    });
+
+    describe('base static method', function() {
+        it('throws in the absense of an API key', function() {
+            expect(function() {
+                Airtable.base('abaseid');
+            });
+        });
+
+        it('returns a Base instance configured with the given ID', function() {
+            try {
+                Airtable.apiKey = 'keyJkl';
+                var base = Airtable.base('abaseid');
+
+                expect(base.getId()).toBe('abaseid');
+            } finally {
+                delete Airtable.apiKey;
+            }
+        });
+    });
+
+    describe('base instance method', function() {
+        it('returns a Base instance configured with the given ID', function() {
+            var base = new Airtable({apiKey: 'keyMno'}).base('anotherbaseid');
+
+            expect(base.getId()).toBe('anotherbaseid');
+        });
+    });
 });

test/test_helpers.js

@@ -111,6 +111,7 @@ function getMockEnvironmentAsync(options) {
         res.json({error: 'NOT_FOUND'});
     });
 
+    // istanbul ignore next
     // eslint-disable-next-line no-unused-vars
     app.use(function(err, req, res, next) {
         console.error(err);
@@ -134,6 +135,7 @@ function getMockEnvironmentAsync(options) {
             }
 
             testServer.listen(testServerPort, function(err) {
+                // istanbul ignore if
                 if (err) {
                     reject(err);
                 } else {
@@ -156,6 +158,7 @@ function _checkParamsMiddleware(req, res, next) {
         req.get('authorization') === 'Bearer key123' &&
         req.params.baseId === 'app123' &&
         req.params.tableIdOrName === 'Table';
+    // istanbul ignore else
     if (areParamsValid) {
         next();
     } else {