From 7cc3b38d1c5021164feabbdbddf1197e84d4ecf2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dominique=20J=C3=A4ggi?= Date: Tue, 28 Nov 2023 11:34:47 +0100 Subject: [PATCH] chore: modularize tests --- packages/spacecat-shared-dynamo/package.json | 2 +- .../spacecat-shared-dynamo/test/index.test.js | 175 +++--------------- .../test/modules/getItem.test.js | 73 ++++++++ .../test/modules/putItem.test.js | 56 ++++++ .../test/modules/query.test.js | 60 ++++++ .../test/modules/removeItem.test.js | 73 ++++++++ 6 files changed, 289 insertions(+), 150 deletions(-) create mode 100644 packages/spacecat-shared-dynamo/test/modules/getItem.test.js create mode 100644 packages/spacecat-shared-dynamo/test/modules/putItem.test.js create mode 100644 packages/spacecat-shared-dynamo/test/modules/query.test.js create mode 100644 packages/spacecat-shared-dynamo/test/modules/removeItem.test.js diff --git a/packages/spacecat-shared-dynamo/package.json b/packages/spacecat-shared-dynamo/package.json index d2c463c9..520ec762 100644 --- a/packages/spacecat-shared-dynamo/package.json +++ b/packages/spacecat-shared-dynamo/package.json @@ -13,7 +13,7 @@ "mocha": { "reporter": "mocha-multi-reporters", "reporter-options": "configFile=.mocha-multi.json", - "spec": "test/*.test.js" + "spec": "test/**/*.test.js" }, "repository": { "type": "git", diff --git a/packages/spacecat-shared-dynamo/test/index.test.js b/packages/spacecat-shared-dynamo/test/index.test.js index e16f38ff..6999524b 100644 --- a/packages/spacecat-shared-dynamo/test/index.test.js +++ b/packages/spacecat-shared-dynamo/test/index.test.js @@ -11,169 +11,46 @@ */ /* eslint-env mocha */ -/* eslint-disable no-unused-expressions */ - import { expect } from 'chai'; +import { DynamoDB } from '@aws-sdk/client-dynamodb'; +import { DynamoDBDocumentClient } from '@aws-sdk/lib-dynamodb'; import { createClient } from '../src/index.js'; -describe('DynamoDB Client', () => { - let dynamoDbClient; - let mockDocClient; +describe('createClient', () => { + let dbClient; + let docClient; beforeEach(() => { - mockDocClient = { - query: async (params) => { - // Check if LastEvaluatedKey is provided and simulate pagination - if (params.ExclusiveStartKey === 'key2') { - return { Items: ['item3'], LastEvaluatedKey: undefined }; - } else { - return { Items: ['item1', 'item2'], LastEvaluatedKey: 'key2' }; - } - }, - get: async () => ({ Item: {} }), - put: async () => ({}), - delete: async () => ({}), - }; - - dynamoDbClient = createClient(console, undefined, mockDocClient); - }); - - it('queries items from the database', async () => { - const result = await dynamoDbClient.query({ TableName: 'TestTable' }); - expect(result).to.be.an('array'); - }); - - it('queries items from the database with pagination', async () => { - const result = await dynamoDbClient.query({ TableName: 'TestTable' }); - expect(result).to.have.lengthOf(3); - expect(result).to.deep.equal(['item1', 'item2', 'item3']); - }); - - it('gets an item from the database', async () => { - const key = { partitionKey: 'testPartitionKey' }; - const result = await dynamoDbClient.getItem('TestTable', key); - expect(result).to.be.an('object'); - }); - - it('gets an item from the database with sort key', async () => { - const key = { partitionKey: 'testPartitionKey', sortKey: 'testSortKey' }; - const result = await dynamoDbClient.getItem('TestTable', key); - expect(result).to.be.an('object'); - }); - - it('throws an error for getItem with invalid tableName', async () => { - const key = { partitionKey: 'testPartitionKey' }; - try { - await dynamoDbClient.getItem('', key); - expect.fail('getItem did not throw with empty tableName'); - } catch (error) { - expect(error.message).to.equal('Invalid tableName: must be a non-empty string.'); - } - }); - - it('throws an error for getItem with invalid key', async () => { - try { - await dynamoDbClient.getItem('TestTable', null); - expect.fail('getItem did not throw with invalid key'); - } catch (error) { - expect(error.message).to.equal('Invalid key: must be an object with a partitionKey.'); - } + dbClient = new DynamoDB(); + docClient = DynamoDBDocumentClient.from(dbClient); }); - it('puts an item into the database', async () => { - const result = await dynamoDbClient.putItem('TestTable', { someKey: 'someValue' }); - expect(result).to.deep.equal({ message: 'Item inserted/updated successfully.' }); + it('should create a DynamoDB client with query method', () => { + const client = createClient(console, dbClient, docClient); + expect(client).to.have.property('query'); + expect(client.query).to.be.a('function'); }); - it('throws an error for putItem with invalid tableName', async () => { - try { - await dynamoDbClient.putItem('', { someKey: 'someValue' }); - expect.fail('putItem did not throw with empty tableName'); - } catch (error) { - expect(error.message).to.equal('Invalid tableName: must be a non-empty string.'); - } + it('should create a DynamoDB client with getItem method', () => { + const client = createClient(console, dbClient, docClient); + expect(client).to.have.property('getItem'); + expect(client.getItem).to.be.a('function'); }); - it('removes an item from the database', async () => { - const key = { partitionKey: 'testPartitionKey' }; - const result = await dynamoDbClient.removeItem('TestTable', key); - expect(result).to.deep.equal({ message: 'Item removed successfully.' }); + it('should create a DynamoDB client with putItem method', () => { + const client = createClient(console, dbClient, docClient); + expect(client).to.have.property('putItem'); + expect(client.putItem).to.be.a('function'); }); - it('removes an item from the database with sort key', async () => { - const key = { partitionKey: 'testPartitionKey', sortKey: 'testSortKey' }; - const result = await dynamoDbClient.removeItem('TestTable', key); - expect(result).to.deep.equal({ message: 'Item removed successfully.' }); + it('should create a DynamoDB client with removeItem method', () => { + const client = createClient(console, dbClient, docClient); + expect(client).to.have.property('removeItem'); + expect(client.removeItem).to.be.a('function'); }); - it('throws an error for removeItem with invalid tableName', async () => { - const key = { partitionKey: 'testPartitionKey' }; - try { - await dynamoDbClient.removeItem('', key); - expect.fail('removeItem did not throw with empty tableName'); - } catch (error) { - expect(error.message).to.equal('Invalid tableName: must be a non-empty string.'); - } - }); - - it('throws an error for removeItem with invalid key', async () => { - try { - await dynamoDbClient.removeItem('TestTable', null); - expect.fail('removeItem did not throw with invalid key'); - } catch (error) { - expect(error.message).to.equal('Invalid key: must be an object with a partitionKey.'); - } - }); - - it('handles errors in query', async () => { - mockDocClient.query = async () => { - throw new Error('Query failed'); - }; - - try { - await dynamoDbClient.query({ TableName: 'TestTable' }); - expect.fail('queryDb did not throw as expected'); - } catch (error) { - expect(error.message).to.equal('Query failed'); - } - }); - - it('handles errors in getItem', async () => { - mockDocClient.get = async () => { - throw new Error('Get failed'); - }; - - try { - await dynamoDbClient.getItem('TestTable', { partitionKey: 'testPartitionKey' }); - expect.fail('getItem did not throw as expected'); - } catch (error) { - expect(error.message).to.equal('Get failed'); - } - }); - - it('handles errors in putItem', async () => { - mockDocClient.put = async () => { - throw new Error('Put failed'); - }; - - try { - await dynamoDbClient.putItem('TestTable', { someKey: 'someValue' }); - expect.fail('putItem did not throw as expected'); - } catch (error) { - expect(error.message).to.equal('Put failed'); - } - }); - - it('handles errors in removeItem', async () => { - mockDocClient.delete = async () => { - throw new Error('Remove failed'); - }; - - try { - await dynamoDbClient.removeItem('TestTable', { partitionKey: 'testPartitionKey' }); - expect.fail('removeItem did not throw as expected'); - } catch (error) { - expect(error.message).to.equal('Remove failed'); - } + it('should use default parameters if none are provided', () => { + const client = createClient(); + expect(client).to.have.all.keys('query', 'getItem', 'putItem', 'removeItem'); }); }); diff --git a/packages/spacecat-shared-dynamo/test/modules/getItem.test.js b/packages/spacecat-shared-dynamo/test/modules/getItem.test.js new file mode 100644 index 00000000..16fdbd28 --- /dev/null +++ b/packages/spacecat-shared-dynamo/test/modules/getItem.test.js @@ -0,0 +1,73 @@ +/* + * Copyright 2023 Adobe. All rights reserved. + * This file is licensed to you under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. You may obtain a copy + * of the License at http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software distributed under + * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS + * OF ANY KIND, either express or implied. See the License for the specific language + * governing permissions and limitations under the License. + */ + +/* eslint-env mocha */ + +import { expect } from 'chai'; +import { createClient } from '../../src/index.js'; + +describe('getItem', () => { + let dynamoDbClient; + let mockDocClient; + + beforeEach(() => { + mockDocClient = { + get: async () => ({ Item: {} }), + }; + + dynamoDbClient = createClient(console, undefined, mockDocClient); + }); + + it('gets an item from the database', async () => { + const key = { partitionKey: 'testPartitionKey' }; + const result = await dynamoDbClient.getItem('TestTable', key); + expect(result).to.be.an('object'); + }); + + it('gets an item from the database with sort key', async () => { + const key = { partitionKey: 'testPartitionKey', sortKey: 'testSortKey' }; + const result = await dynamoDbClient.getItem('TestTable', key); + expect(result).to.be.an('object'); + }); + + it('throws an error for getItem with invalid tableName', async () => { + const key = { partitionKey: 'testPartitionKey' }; + try { + await dynamoDbClient.getItem('', key); + expect.fail('getItem did not throw with empty tableName'); + } catch (error) { + expect(error.message).to.equal('Invalid tableName: must be a non-empty string.'); + } + }); + + it('throws an error for getItem with invalid key', async () => { + try { + await dynamoDbClient.getItem('TestTable', null); + expect.fail('getItem did not throw with invalid key'); + } catch (error) { + expect(error.message).to.equal('Invalid key: must be an object with a partitionKey.'); + } + }); + + it('handles errors in getItem', async () => { + mockDocClient.get = async () => { + throw new Error('Get failed'); + }; + + try { + await dynamoDbClient.getItem('TestTable', { partitionKey: 'testPartitionKey' }); + expect.fail('getItem did not throw as expected'); + } catch (error) { + expect(error.message).to.equal('Get failed'); + } + }); +}); diff --git a/packages/spacecat-shared-dynamo/test/modules/putItem.test.js b/packages/spacecat-shared-dynamo/test/modules/putItem.test.js new file mode 100644 index 00000000..2c32df75 --- /dev/null +++ b/packages/spacecat-shared-dynamo/test/modules/putItem.test.js @@ -0,0 +1,56 @@ +/* + * Copyright 2023 Adobe. All rights reserved. + * This file is licensed to you under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. You may obtain a copy + * of the License at http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software distributed under + * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS + * OF ANY KIND, either express or implied. See the License for the specific language + * governing permissions and limitations under the License. + */ + +/* eslint-env mocha */ + +import { expect } from 'chai'; +import { createClient } from '../../src/index.js'; + +describe('putItem', () => { + let dynamoDbClient; + let mockDocClient; + + beforeEach(() => { + mockDocClient = { + put: async () => ({}), + }; + + dynamoDbClient = createClient(console, undefined, mockDocClient); + }); + + it('puts an item into the database', async () => { + const result = await dynamoDbClient.putItem('TestTable', { someKey: 'someValue' }); + expect(result).to.deep.equal({ message: 'Item inserted/updated successfully.' }); + }); + + it('throws an error for putItem with invalid tableName', async () => { + try { + await dynamoDbClient.putItem('', { someKey: 'someValue' }); + expect.fail('putItem did not throw with empty tableName'); + } catch (error) { + expect(error.message).to.equal('Invalid tableName: must be a non-empty string.'); + } + }); + + it('handles errors in putItem', async () => { + mockDocClient.put = async () => { + throw new Error('Put failed'); + }; + + try { + await dynamoDbClient.putItem('TestTable', { someKey: 'someValue' }); + expect.fail('putItem did not throw as expected'); + } catch (error) { + expect(error.message).to.equal('Put failed'); + } + }); +}); diff --git a/packages/spacecat-shared-dynamo/test/modules/query.test.js b/packages/spacecat-shared-dynamo/test/modules/query.test.js new file mode 100644 index 00000000..3424f47d --- /dev/null +++ b/packages/spacecat-shared-dynamo/test/modules/query.test.js @@ -0,0 +1,60 @@ +/* + * Copyright 2023 Adobe. All rights reserved. + * This file is licensed to you under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. You may obtain a copy + * of the License at http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software distributed under + * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS + * OF ANY KIND, either express or implied. See the License for the specific language + * governing permissions and limitations under the License. + */ + +/* eslint-env mocha */ + +import { expect } from 'chai'; +import { createClient } from '../../src/index.js'; + +describe('query', () => { + let dynamoDbClient; + let mockDocClient; + + beforeEach(() => { + mockDocClient = { + query: async (params) => { + // Check if LastEvaluatedKey is provided and simulate pagination + if (params.ExclusiveStartKey === 'key2') { + return { Items: ['item3'], LastEvaluatedKey: undefined }; + } else { + return { Items: ['item1', 'item2'], LastEvaluatedKey: 'key2' }; + } + }, + }; + + dynamoDbClient = createClient(console, undefined, mockDocClient); + }); + + it('queries items from the database', async () => { + const result = await dynamoDbClient.query({ TableName: 'TestTable' }); + expect(result).to.be.an('array'); + }); + + it('queries items from the database with pagination', async () => { + const result = await dynamoDbClient.query({ TableName: 'TestTable' }); + expect(result).to.have.lengthOf(3); + expect(result).to.deep.equal(['item1', 'item2', 'item3']); + }); + + it('handles errors in query', async () => { + mockDocClient.query = async () => { + throw new Error('Query failed'); + }; + + try { + await dynamoDbClient.query({ TableName: 'TestTable' }); + expect.fail('queryDb did not throw as expected'); + } catch (error) { + expect(error.message).to.equal('Query failed'); + } + }); +}); diff --git a/packages/spacecat-shared-dynamo/test/modules/removeItem.test.js b/packages/spacecat-shared-dynamo/test/modules/removeItem.test.js new file mode 100644 index 00000000..f1c772f7 --- /dev/null +++ b/packages/spacecat-shared-dynamo/test/modules/removeItem.test.js @@ -0,0 +1,73 @@ +/* + * Copyright 2023 Adobe. All rights reserved. + * This file is licensed to you under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. You may obtain a copy + * of the License at http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software distributed under + * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS + * OF ANY KIND, either express or implied. See the License for the specific language + * governing permissions and limitations under the License. + */ + +/* eslint-env mocha */ + +import { expect } from 'chai'; +import { createClient } from '../../src/index.js'; + +describe('removeItem', () => { + let dynamoDbClient; + let mockDocClient; + + beforeEach(() => { + mockDocClient = { + delete: async () => ({}), + }; + + dynamoDbClient = createClient(console, undefined, mockDocClient); + }); + + it('removes an item from the database', async () => { + const key = { partitionKey: 'testPartitionKey' }; + const result = await dynamoDbClient.removeItem('TestTable', key); + expect(result).to.deep.equal({ message: 'Item removed successfully.' }); + }); + + it('removes an item from the database with sort key', async () => { + const key = { partitionKey: 'testPartitionKey', sortKey: 'testSortKey' }; + const result = await dynamoDbClient.removeItem('TestTable', key); + expect(result).to.deep.equal({ message: 'Item removed successfully.' }); + }); + + it('throws an error for removeItem with invalid tableName', async () => { + const key = { partitionKey: 'testPartitionKey' }; + try { + await dynamoDbClient.removeItem('', key); + expect.fail('removeItem did not throw with empty tableName'); + } catch (error) { + expect(error.message).to.equal('Invalid tableName: must be a non-empty string.'); + } + }); + + it('throws an error for removeItem with invalid key', async () => { + try { + await dynamoDbClient.removeItem('TestTable', null); + expect.fail('removeItem did not throw with invalid key'); + } catch (error) { + expect(error.message).to.equal('Invalid key: must be an object with a partitionKey.'); + } + }); + + it('handles errors in removeItem', async () => { + mockDocClient.delete = async () => { + throw new Error('Remove failed'); + }; + + try { + await dynamoDbClient.removeItem('TestTable', { partitionKey: 'testPartitionKey' }); + expect.fail('removeItem did not throw as expected'); + } catch (error) { + expect(error.message).to.equal('Remove failed'); + } + }); +});