Refactor tests related to kid and keyid (#545)

MitMaro · ziluvatar · commit 88645427a0ad · 2018-11-02T11:05:03.000+01:00
Thie change extracts the tests related to the kid header and the keyid
option into a single file. Additonal tests were added that were missing.
diff --git a/test/header-kid.test.js b/test/header-kid.test.js
@@ -0,0 +1,97 @@
+'use strict';
+
+const jwt = require('../');
+const expect = require('chai').expect;
+const util = require('util');
+const testUtils = require('./test-utils');
+
+function signWithKeyId(keyid, payload, callback) {
+  const options = {algorithm: 'none'};
+  if (keyid !== undefined) {
+    options.keyid = keyid;
+  }
+  testUtils.signJWTHelper(payload, 'secret', options, callback);
+}
+
+describe('keyid', function() {
+  describe('`jwt.sign` "keyid" option validation', function () {
+    [
+      true,
+      false,
+      null,
+      -1,
+      0,
+      1,
+      -1.1,
+      1.1,
+      -Infinity,
+      Infinity,
+      NaN,
+      [],
+      ['foo'],
+      {},
+      {foo: 'bar'},
+    ].forEach((keyid) => {
+      it(`should error with with value ${util.inspect(keyid)}`, function (done) {
+        signWithKeyId(keyid, {}, (err) => {
+          testUtils.asyncCheck(done, () => {
+            expect(err).to.be.instanceOf(Error);
+            expect(err).to.have.property('message', '"keyid" must be a string');
+          });
+        });
+      });
+    });
+
+    // undefined needs special treatment because {} is not the same as {keyid: undefined}
+    it('should error with with value undefined', function (done) {
+      testUtils.signJWTHelper({}, undefined, {keyid: undefined, algorithm: 'none'}, (err) => {
+        testUtils.asyncCheck(done, () => {
+          expect(err).to.be.instanceOf(Error);
+          expect(err).to.have.property('message', '"keyid" must be a string');
+        });
+      });
+    });
+  });
+
+  describe('when signing a token', function () {
+    it('should not add "kid" header when "keyid" option not provided', function(done) {
+      signWithKeyId(undefined, {}, (err, token) => {
+        testUtils.asyncCheck(done, () => {
+          const decoded = jwt.decode(token, {complete: true});
+          expect(err).to.be.null;
+          expect(decoded.header).to.not.have.property('kid');
+        });
+      });
+    });
+
+    it('should add "kid" header when "keyid" option is provided and an object payload', function(done) {
+      signWithKeyId('foo', {}, (err, token) => {
+        testUtils.asyncCheck(done, () => {
+          const decoded = jwt.decode(token, {complete: true});
+          expect(err).to.be.null;
+          expect(decoded.header).to.have.property('kid', 'foo');
+        });
+      });
+    });
+
+    it('should add "kid" header when "keyid" option is provided and a Buffer payload', function(done) {
+      signWithKeyId('foo', new Buffer('a Buffer payload'), (err, token) => {
+        testUtils.asyncCheck(done, () => {
+          const decoded = jwt.decode(token, {complete: true});
+          expect(err).to.be.null;
+          expect(decoded.header).to.have.property('kid', 'foo');
+        });
+      });
+    });
+
+    it('should add "kid" header when "keyid" option is provided and a string payload', function(done) {
+      signWithKeyId('foo', 'a string payload', (err, token) => {
+        testUtils.asyncCheck(done, () => {
+          const decoded = jwt.decode(token, {complete: true});
+          expect(err).to.be.null;
+          expect(decoded.header).to.have.property('kid', 'foo');
+        });
+      });
+    });
+  });
+});
diff --git a/test/keyid.tests.js b/test/keyid.tests.js
diff --git a/test/schema.tests.js b/test/schema.tests.js
@@ -50,14 +50,6 @@ describe('schema', function() {
       }).to.throw(/"noTimestamp" must be a boolean/);
       sign({noTimestamp: true});
     });
-
-    it('should validate keyid', function () {
-      expect(function () {
-        sign({ keyid: 10 });
-      }).to.throw(/"keyid" must be a string/);
-      sign({keyid: 'foo'});
-    });
-
   });
 
   describe('sign payload registered claims', function() {
