aws-sdk-client-mock

What is aws-sdk-client-mock?

The aws-sdk-client-mock package is a mocking library for AWS SDK v3 clients. It allows developers to mock AWS SDK v3 client methods for unit testing purposes, making it easier to test code that interacts with AWS services without making actual calls to AWS.

What are aws-sdk-client-mock's main functionalities?

Mocking AWS SDK v3 Client Methods

This feature allows you to mock methods of AWS SDK v3 clients. In the example, the S3Client's GetObjectCommand is mocked to return 'mocked data' instead of making an actual call to AWS S3.

const { mockClient } = require('aws-sdk-client-mock');
const { S3Client, GetObjectCommand } = require('@aws-sdk/client-s3');

const s3Mock = mockClient(S3Client);
s3Mock.on(GetObjectCommand).resolves({ Body: 'mocked data' });

async function getObject() {
  const client = new S3Client();
  const command = new GetObjectCommand({ Bucket: 'example-bucket', Key: 'example-key' });
  const response = await client.send(command);
  return response.Body;
}

getObject().then(data => console.log(data));

Resetting Mocks

This feature allows you to reset the mocks, which is useful for cleaning up between tests. In the example, the mock for GetObjectCommand is reset, so any subsequent calls will not use the mock.

const { mockClient } = require('aws-sdk-client-mock');
const { S3Client, GetObjectCommand } = require('@aws-sdk/client-s3');

const s3Mock = mockClient(S3Client);
s3Mock.on(GetObjectCommand).resolves({ Body: 'mocked data' });

// Reset the mock
s3Mock.reset();

async function getObject() {
  const client = new S3Client();
  const command = new GetObjectCommand({ Bucket: 'example-bucket', Key: 'example-key' });
  try {
    const response = await client.send(command);
    return response.Body;
  } catch (error) {
    console.error('Error:', error);
  }
}

getObject();

Mocking Multiple Commands

This feature allows you to mock multiple commands for a single AWS SDK v3 client. In the example, both GetObjectCommand and PutObjectCommand are mocked with different responses.

const { mockClient } = require('aws-sdk-client-mock');
const { S3Client, GetObjectCommand, PutObjectCommand } = require('@aws-sdk/client-s3');

const s3Mock = mockClient(S3Client);
s3Mock.on(GetObjectCommand).resolves({ Body: 'mocked get data' });
s3Mock.on(PutObjectCommand).resolves({ ETag: 'mocked-etag' });

async function performS3Operations() {
  const client = new S3Client();
  const getObjectCommand = new GetObjectCommand({ Bucket: 'example-bucket', Key: 'example-key' });
  const putObjectCommand = new PutObjectCommand({ Bucket: 'example-bucket', Key: 'example-key', Body: 'data' });
  const getObjectResponse = await client.send(getObjectCommand);
  const putObjectResponse = await client.send(putObjectCommand);
  return { getObjectResponse, putObjectResponse };
}

performS3Operations().then(data => console.log(data));

Other packages similar to aws-sdk-client-mock

aws-sdk-mock

aws-sdk-mock is a popular library for mocking AWS SDK v2 methods. It provides similar functionality to aws-sdk-client-mock but is designed for AWS SDK v2. It allows developers to mock AWS service methods for unit testing purposes.

mock-aws-s3

mock-aws-s3 is another library for mocking AWS S3 methods. It is designed to work with AWS SDK v2 and provides a way to mock S3 interactions for testing purposes. It is similar to aws-sdk-client-mock but focused solely on S3.

README

The README file is missing

Changelog

2.0.0-beta.2 (2022-08-21)

⚠ BREAKING CHANGES

• move Jest matchers to a separate package (#112)

Features

• support Jest asymmetric matchers (#111) (3bf23ef)

Bug Fixes

• move Jest matchers to a separate package (#112) (05a3a51)