@bedrock/kms 10.3.0 → 11.0.0

package/test/mocha/11-keystores-get-api.js

@@ -1,79 +0,0 @@
-/*!
- * Copyright (c) 2019-2022 Digital Bazaar, Inc. All rights reserved.
- */
-import {keystores} from '@bedrock/kms';
-
-describe('keystores APIs', () => {
-  const mockConfig = {
-    id: 'https://example.com/keystores/se0ea64f2a-06db-4055-93a5-c2f305cd541d',
-    kmsModule: 'ssm-v1',
-    controller: '1e65ba0c-966e-440c-bd72-e4b97caeb7f3',
-    sequence: 0,
-  };
-  before(async () => {
-    let err;
-    try {
-      await keystores.insert({config: mockConfig});
-    } catch(e) {
-      err = e;
-    }
-    assertNoError(err);
-  });
-  describe('get API', () => {
-    it('throws on missing id', async () => {
-      let err;
-      let result;
-      try {
-        result = await keystores.get();
-      } catch(e) {
-        err = e;
-      }
-      should.not.exist(result);
-      should.exist(err);
-      err.message.should.contain('id (string) is required');
-    });
-    it('throws on non-string id', async () => {
-      let err;
-      let result;
-      try {
-        result = await keystores.get({id: 0});
-      } catch(e) {
-        err = e;
-      }
-      should.not.exist(result);
-      should.exist(err);
-      err.message.should.contain('id (string) is required');
-    });
-    it('successfully gets a keystore', async () => {
-      let err;
-      let result;
-      try {
-        result = await keystores.get({id: mockConfig.id});
-      } catch(e) {
-        err = e;
-      }
-      assertNoError(err);
-      should.exist(result);
-      result.should.be.an('object');
-      // ensure the projection only return meta & config
-      Object.keys(result).should.deep.equal(['meta', 'config']);
-      result.meta.should.have.property('created');
-      result.meta.should.have.property('updated');
-      result.config.should.eql(mockConfig);
-    });
-    it('unsuccessfully gets a keystore', async () => {
-      const unknownId = 'bd9a90e3-2989-4d40-81c6-94ad0c98c56c';
-      let err;
-      let result;
-      try {
-        result = await keystores.get({id: unknownId});
-      } catch(e) {
-        err = e;
-      }
-      should.not.exist(result);
-      should.exist(err);
-      err.name.should.equal('NotFoundError');
-      err.details.keystoreId.should.equal(unknownId);
-    });
-  });
-});

package/test/mocha/12-keystores-find-api.js

@@ -1,127 +0,0 @@
-/*!
- * Copyright (c) 2019-2022 Digital Bazaar, Inc. All rights reserved.
- */
-import {keystores} from '@bedrock/kms';
-
-describe('keystores APIs', () => {
-  const mockConfigAlpha = {
-    id: 'https://example.com/keystores/8b688649-d546-4e88-9027-da434bac495a',
-    kmsModule: 'ssm-v1',
-    controller: 'caf40b44-0e66-44ef-b331-23f6ca0bb837',
-    sequence: 0,
-  };
-  // mockConfigBeta one and two have the same controller
-  const mockConfigBeta1 = {
-    id: 'https://example.com/keystores/6821b4ec-2630-4bf3-9464-39581d2c4499',
-    kmsModule: 'ssm-v1',
-    controller: '8a86d089-3a48-4096-a5a3-b874e873fb60',
-    sequence: 0,
-  };
-  const mockConfigBeta2 = {
-    id: 'https://example.com/keystores/448cf4ad-e9ff-4bd3-aa9a-b882cd01583c',
-    kmsModule: 'ssm-v1',
-    controller: '8a86d089-3a48-4096-a5a3-b874e873fb60',
-    sequence: 0,
-  };
-  before(async () => {
-    let err;
-    try {
-      await keystores.insert({config: mockConfigAlpha});
-    } catch(e) {
-      err = e;
-    }
-    assertNoError(err);
-  });
-  before(async () => {
-    let err;
-    try {
-      await keystores.insert({config: mockConfigBeta1});
-      await keystores.insert({config: mockConfigBeta2});
-    } catch(e) {
-      err = e;
-    }
-    assertNoError(err);
-  });
-  describe('find API', () => {
-    it('throws on missing controller', async () => {
-      let err;
-      let result;
-      try {
-        result = await keystores.find();
-      } catch(e) {
-        err = e;
-      }
-      should.not.exist(result);
-      should.exist(err);
-      err.message.should.contain('options.controller (string) is required');
-    });
-    it('throws on non-string controller', async () => {
-      let err;
-      let result;
-      try {
-        result = await keystores.find({controller: 1});
-      } catch(e) {
-        err = e;
-      }
-      should.not.exist(result);
-      should.exist(err);
-      err.message.should.contain('options.controller (string) is required');
-    });
-    it('successfully finds a keystore', async () => {
-      let err;
-      let results;
-      try {
-        results = await keystores.find(
-          {controller: mockConfigAlpha.controller});
-      } catch(e) {
-        err = e;
-      }
-      assertNoError(err);
-      results.should.be.an('array');
-      results.should.have.length(1);
-      const [result] = results;
-      result.should.be.an('object');
-      result.should.have.property('meta');
-      result.meta.should.have.property('created');
-      result.meta.should.have.property('updated');
-      result.should.have.property('config');
-      result.config.should.eql(mockConfigAlpha);
-    });
-    it('successfully finds multiple keystores for a controller', async () => {
-      let err;
-      let results;
-      try {
-        results = await keystores.find(
-          {controller: mockConfigBeta1.controller});
-      } catch(e) {
-        err = e;
-      }
-      assertNoError(err);
-      results.should.be.an('array');
-      results.should.have.length(2);
-      for(const result of results) {
-        result.should.be.an('object');
-        result.should.have.property('meta');
-        result.meta.should.have.property('created');
-        result.meta.should.have.property('updated');
-        result.should.have.property('config');
-      }
-      results.map(r => r.config).should.have.deep.members([
-        mockConfigBeta1, mockConfigBeta2
-      ]);
-    });
-    it('returns empty array on unknown controller', async () => {
-      const unknownController = 'bc794e06-e985-45d4-97c3-57d65d393736';
-      let err;
-      let results;
-      try {
-        results = await keystores.find({controller: unknownController});
-      } catch(e) {
-        err = e;
-      }
-      assertNoError(err);
-      results.should.be.an('array');
-      results.should.have.length(0);
-    });
-  });
-});

package/test/mocha/13-keystores-update-api.js

@@ -1,202 +0,0 @@
-/*!
- * Copyright (c) 2019-2022 Digital Bazaar, Inc. All rights reserved.
- */
-import {keystores} from '@bedrock/kms';
-import {klona} from 'klona';
-
-describe('keystores APIs', () => {
-  const mockConfigAlpha = {
-    id: 'https://example.com/keystores/b122cc8a-39be-4680-b88e-2593b1295b1b',
-    kmsModule: 'ssm-v1',
-    controller: '8a945a10-9f6a-4096-8306-c6c6825a9fe2',
-    sequence: 0,
-    referenceId: '95901c02-a4ad-4d3a-be17-0be3aafbe6f3',
-  };
-  const mockConfigBeta = {
-    id: 'https://example.com/keystores/f454ad49-90eb-4f15-aff9-13048adc84d0',
-    kmsModule: 'ssm-v1',
-    controller: '8e79ce0e-926d-457c-b520-849663e1d9de',
-    sequence: 0,
-  };
-  const mockConfigGamma = {
-    id: 'https://example.com/keystores/6be652c3-3ed6-452b-a98a-cb0ad6905f37',
-    kmsModule: 'ssm-v1',
-    controller: 'f2da13ee-50d2-46ab-865d-ee23d609edbd',
-    sequence: 0,
-  };
-  const mockConfigDelta = {
-    id: 'https://example.com/keystores/f9da6f23-6e13-42e9-88d3-5c03011ecbbf',
-    kmsModule: 'ssm-v1',
-    controller: '17e77da1-bb7e-4fe2-b4dd-1c4bba933d7c',
-    sequence: 0,
-  };
-
-  before(async () => {
-    let err;
-    try {
-      await keystores.insert({config: mockConfigAlpha});
-      await keystores.insert({config: mockConfigBeta});
-      await keystores.insert({config: mockConfigGamma});
-      await keystores.insert({config: mockConfigDelta});
-    } catch(e) {
-      err = e;
-    }
-    assertNoError(err);
-  });
-  describe('update API', () => {
-    it('throws error on missing config', async () => {
-      let err;
-      let result;
-      try {
-        result = await keystores.update();
-      } catch(e) {
-        err = e;
-      }
-      should.not.exist(result);
-      should.exist(err);
-      err.message.should.contain('config (object) is required');
-    });
-    it('successfully updates a keystore', async () => {
-      let err;
-      let result;
-      const config = klona(mockConfigAlpha);
-      config.sequence++;
-      config.controller = 'someOtherController';
-      try {
-        result = await keystores.update({config});
-      } catch(e) {
-        err = e;
-      }
-      assertNoError(err);
-      result.should.be.a('boolean');
-      result.should.be.true;
-    });
-    it('successfully updates a keystore twice', async () => {
-      let err;
-      let result;
-      const config = klona(mockConfigBeta);
-      config.sequence++;
-      config.controller = 'someOtherController';
-      try {
-        result = await keystores.update({config});
-      } catch(e) {
-        err = e;
-      }
-      assertNoError(err);
-      result.should.be.a('boolean');
-      result.should.be.true;
-
-      // update same config again
-      config.sequence++;
-      config.controller = 'someOtherController2';
-      result = undefined;
-      err = undefined;
-      try {
-        result = await keystores.update({config});
-      } catch(e) {
-        err = e;
-      }
-      assertNoError(err);
-      result.should.be.a('boolean');
-      result.should.be.true;
-    });
-    it('successfully updates a keystore and gets a fresh value', async () => {
-      const config = klona(mockConfigDelta);
-
-      // get keystore config to prime cache
-      await keystores.get({id: config.id});
-
-      // now update config
-      let err;
-      let result;
-      config.sequence++;
-      config.controller = 'someOtherController';
-      const oldDelete = keystores._KEYSTORE_CONFIG_CACHE.delete;
-      try {
-        // remove cache delete functionality to test fresh API
-        keystores._KEYSTORE_CONFIG_CACHE.delete = () => {};
-        result = await keystores.update({config});
-      } catch(e) {
-        err = e;
-      } finally {
-        keystores._KEYSTORE_CONFIG_CACHE.delete = oldDelete;
-      }
-      assertNoError(err);
-      result.should.be.a('boolean');
-      result.should.be.true;
-
-      // get keystore config, should be stale
-      const stale = await keystores.get({id: config.id});
-      stale.config.controller.should.not.equal(config.controller);
-
-      // get fresh config
-      const fresh = await keystores.get({id: config.id, fresh: true});
-      fresh.config.controller.should.equal(config.controller);
-    });
-    it('fails to updates a keystore using wrong sequence number', async () => {
-      let err;
-      let result;
-      const config = klona(mockConfigGamma);
-      config.sequence++;
-      config.controller = 'someOtherController';
-      try {
-        result = await keystores.update({config});
-      } catch(e) {
-        err = e;
-      }
-      assertNoError(err);
-      result.should.be.a('boolean');
-      result.should.be.true;
-
-      // update same config again without updating the sequence number
-      // config.sequence++;
-
-      config.controller = 'someOtherController2';
-      result = undefined;
-      err = undefined;
-      try {
-        result = await keystores.update({config});
-      } catch(e) {
-        err = e;
-      }
-      should.not.exist(result);
-      should.exist(err);
-      err.name.should.equal('InvalidStateError');
-      err.details.id.should.equal(config.id);
-      err.details.sequence.should.equal(config.sequence);
-    });
-    it('successfully updates a keystore and invalidates cache', async () => {
-      let err;
-      let result;
-      const config = klona(mockConfigBeta);
-      config.sequence = 3;
-      config.controller = 'someOtherController';
-      try {
-        result = await keystores.update({config});
-      } catch(e) {
-        err = e;
-      }
-      assertNoError(err);
-      result.should.be.a('boolean');
-      result.should.be.true;
-      const keyRecord = await keystores.get({id: config.id});
-      should.exist(keyRecord);
-      keyRecord.config.sequence.should.equal(3);
-    });
-    it('throws error on unknown keystore id', async () => {
-      let err;
-      let result;
-      const config = klona(mockConfigBeta);
-      config.sequence++;
-      config.id = 'someOtherId';
-      try {
-        result = await keystores.update({config});
-      } catch(e) {
-        err = e;
-      }
-      should.not.exist(result);
-      should.exist(err);
-      err.name.should.equal('InvalidStateError');
-    });
-  });
-});

package/test/mocha/14-keystores-getStorageUsage-api.js

@@ -1,119 +0,0 @@
-/*!
- * Copyright (c) 2019-2022 Digital Bazaar, Inc. All rights reserved.
- */
-import {keystores, defaultModuleManager as moduleManager} from '@bedrock/kms';
-
-describe('keystores APIs', () => {
-  describe('getStorageUsage API', () => {
-    it('gets storage usage for a keystore', async () => {
-      let err;
-      let result;
-      const config = {
-        id: 'https://example.com/keystores/usage-test1',
-        controller: 'usage-test',
-        kmsModule: 'ssm-v1',
-        sequence: 0,
-        meterId: 'usage-meter-1'
-      };
-      try {
-        await keystores.insert({config});
-        result = await keystores.getStorageUsage({
-          meterId: 'usage-meter-1', moduleManager
-        });
-      } catch(e) {
-        err = e;
-      }
-      assertNoError(err);
-      should.exist(result);
-      result.should.be.an('object');
-      result.should.deep.equal({storage: 1});
-    });
-    it('gets custom storage usage for a keystore', async () => {
-      let err;
-      let result;
-      const config = {
-        id: 'https://example.com/keystores/usage-test2',
-        controller: 'usage-test',
-        kmsModule: 'ssm-v1',
-        sequence: 0,
-        meterId: 'usage-meter-2'
-      };
-      try {
-        await keystores.insert({config});
-        result = await keystores.getStorageUsage({
-          meterId: 'usage-meter-2', moduleManager,
-          async aggregate({usage}) {
-            usage.storage++;
-          }
-        });
-      } catch(e) {
-        err = e;
-      }
-      assertNoError(err);
-      should.exist(result);
-      result.should.be.an('object');
-      result.should.deep.equal({storage: 2});
-    });
-    it('gets custom storage usage for a keystore when max concurrency is ' +
-      'reached', async () => {
-      let err;
-      let result;
-      // 54 is used in order to have a counters.length of 102 to ensure max
-      // concurrency of 100 (`USAGE_COUNTER_MAX_CONCURRENCY`) is reached;
-      // if this max concurrency changes, this test will need to change too
-      for(let i = 3; i < 54; i++) {
-        const config = {
-          id: `https://example.com/keystores/usage-test${i}`,
-          controller: 'usage-test',
-          kmsModule: 'ssm-v1',
-          sequence: 0,
-          meterId: `usage-meter-3`
-        };
-        await keystores.insert({config});
-      }
-      try {
-        result = await keystores.getStorageUsage({
-          meterId: 'usage-meter-3', moduleManager,
-          async aggregate({usage}) {
-            usage.storage++;
-          }
-        });
-      } catch(e) {
-        err = e;
-      }
-      assertNoError(err);
-      should.exist(result);
-      result.should.be.an('object');
-      result.should.deep.equal({storage: 102});
-    });
-    it('aborts computing metered storage', async () => {
-      let err;
-      let result;
-      const config = {
-        id: 'https://example.com/keystores/usage-test55',
-        controller: 'usage-test',
-        kmsModule: 'ssm-v1',
-        sequence: 0,
-        meterId: 'usage-meter-55'
-      };
-      try {
-        await keystores.insert({config});
-        result = await keystores.getStorageUsage({
-          signal: {
-            abort: true
-          },
-          meterId: 'usage-meter-55', moduleManager,
-          async aggregate({usage}) {
-            usage.storage++;
-          }
-        });
-      } catch(e) {
-        err = e;
-      }
-
-      should.exist(err);
-      should.not.exist(result);
-      err.name.should.equal('AbortError');
-    });
-  }); // end getStorageUsage API
-}); // end keystore APIs