jest-aws-client-mock
Version:
Jest mock for AWS SDK v3 Clients
109 lines • 12.6 kB
JavaScript
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.AwsMock = exports.mockClient = void 0;
/**
* Mocks an aws sdk client.
*/
const mockClient = (client) => {
const instance = isInstance(client) ? client : client.prototype;
const send = jest.spyOn(instance, 'send');
return new AwsMock(send);
};
exports.mockClient = mockClient;
class AwsMock {
constructor(send) {
this._isMockFunction = true;
this.send = send;
this.send.mockImplementation(() => undefined); // default
}
/**
* Does everything that `mockFn.mockClear()` does, and also removes any mocked return values or implementations.
*/
mockReset() {
this.send.mockReset();
return this;
}
/**
* Does everything that `mockFn.mockReset()` does, and also restores the original (non-mocked) implementation.
*/
mockRestore() {
this.send.mockRestore();
}
/**
* Resets all information stored in the mockFn.mock.calls and mockFn.mock.instances arrays.
*/
mockClear() {
this.send.mockClear();
return this;
}
get mock() {
return this.send.mock;
}
/**
* Sets the name of the mock.
*/
mockName(name) {
this.send.mockName(name);
return this;
}
/**
* Returns the mock name string set by calling mockFn.mockName(value).
*/
getMockName() {
return this.send.getMockName();
}
/**
* Simple sugar function for: mockFn.mockImplementation(() => Promise.resolve(value));
*/
mockResolvedValue(value) {
this.send.mockResolvedValue(value);
return this;
}
/**
* Simple sugar function for: mockFn.mockImplementationOnce(() => Promise.resolve(value));
*/
mockResolvedValueOnce(value) {
this.send.mockResolvedValueOnce(value);
return this;
}
/**
* Simple sugar function for: mockFn.mockImplementation(() => Promise.reject(value));
*/
mockRejectedValue(error) {
if (typeof error === 'string') {
error = new Error(error);
}
this.send.mockRejectedValue(error);
return this;
}
/**
* Simple sugar function for: mockFn.mockImplementationOnce(() => Promise.reject(value));
*/
mockRejectedValueOnce(error) {
if (typeof error === 'string') {
error = new Error(error);
}
this.send.mockRejectedValueOnce(error);
return this;
}
/**
* Accepts a function that should be used as the implementation of the mock. The mock itself will still record all calls that go into and instances that come from itself – the only difference is that the implementation will also be executed when the mock is called.
*/
// eslint-disable-next-line max-len
mockImplementation(fn) {
this.send.mockImplementation(fn);
return this;
}
/**
* Accepts a function that will be used as an implementation of the mock for one call to the mocked function. Can be chained so that multiple function calls produce different results.
*/
// eslint-disable-next-line max-len
mockImplementationOnce(fn) {
this.send.mockImplementationOnce(fn);
return this;
}
}
exports.AwsMock = AwsMock;
// eslint-disable-next-line max-len
const isInstance = (client) => client.send !== undefined;
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"mock-client.js","sourceRoot":"","sources":["../src/mock-client.ts"],"names":[],"mappings":";;;AAEA;;GAEG;AACI,MAAM,UAAU,GAAG,CAAwD,MAAyD,EAAE,EAAE;IAC7I,MAAM,QAAQ,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC;IAEhE,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IAE1C,OAAO,IAAI,OAAO,CAAkB,IAAI,CAAC,CAAC;AAC5C,CAAC,CAAC;AANW,QAAA,UAAU,cAMrB;AAKF,MAAa,OAAO;IAKlB,YAAY,IAAkC;QAJ9C,oBAAe,GAAG,IAAI,CAAC;QAKrB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC,UAAU;IAC3D,CAAC;IAED;;OAEG;IACI,SAAS;QACd,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;QACtB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACI,WAAW;QAChB,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;IAC1B,CAAC;IAED;;OAEG;IACI,SAAS;QACd,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;QACtB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;IACxB,CAAC;IAED;;OAEG;IACI,QAAQ,CAAC,IAAY;QAC1B,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACzB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACI,WAAW;QAChB,OAAO,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;IACjC,CAAC;IAED;;OAEG;IACI,iBAAiB,CAAC,KAA6B;QACpD,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,KAAY,CAAC,CAAC;QAC1C,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACI,qBAAqB,CAAC,KAA6B;QACxD,IAAI,CAAC,IAAI,CAAC,qBAAqB,CAAC,KAAY,CAAC,CAAC;QAC9C,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACI,iBAAiB,CAAC,KAAgC;QACvD,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;YAC7B,KAAK,GAAG,IAAI,KAAK,CAAC,KAAK,CAAC,CAAC;SAC1B;QACD,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC;QACnC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACI,qBAAqB,CAAC,KAAgC;QAC3D,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;YAC7B,KAAK,GAAG,IAAI,KAAK,CAAC,KAAK,CAAC,CAAC;SAC1B;QACD,IAAI,CAAC,IAAI,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC;QACvC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACH,mCAAmC;IAC5B,kBAAkB,CAAC,EAAoJ;QAC5K,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC,EAAS,CAAC,CAAC;QACxC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACH,mCAAmC;IAC5B,sBAAsB,CAAC,EAAqI;QACjK,IAAI,CAAC,IAAI,CAAC,sBAAsB,CAAC,EAAS,CAAC,CAAC;QAC5C,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AA3GD,0BA2GC;AAED,mCAAmC;AACnC,MAAM,UAAU,GAAG,CAAwC,MAAoC,EAAqB,EAAE,CAAE,MAAkB,CAAC,IAAI,KAAK,SAAS,CAAC","sourcesContent":["import type { Client, MetadataBearer, Command, SdkError } from '@aws-sdk/types';\n\n/**\n * Mocks an aws sdk client.\n */\nexport const mockClient = <TInput extends object, TOutput extends MetadataBearer>(client: InstanceOrClassType<Client<TInput, TOutput, any>>) => {\n  const instance = isInstance(client) ? client : client.prototype;\n\n  const send = jest.spyOn(instance, 'send');\n\n  return new AwsMock<TInput, TOutput>(send);\n};\n\n// eslint-disable-next-line max-len\nexport type AwsClientMock<TClient extends Client<any, any, any>> = TClient extends Client<infer TInput, infer TOutput, any> ? AwsMock<TInput, TOutput> : never;\n\nexport class AwsMock<TInput extends object, TOutput extends MetadataBearer> {\n  _isMockFunction = true;\n\n  private send: SpyInstance<TInput, TOutput>;\n\n  constructor(send: SpyInstance<TInput, TOutput>) {\n    this.send = send;\n    this.send.mockImplementation(() => undefined); // default\n  }\n\n  /**\n   * Does everything that `mockFn.mockClear()` does, and also removes any mocked return values or implementations.\n   */\n  public mockReset() {\n    this.send.mockReset();\n    return this;\n  }\n\n  /**\n   * Does everything that `mockFn.mockReset()` does, and also restores the original (non-mocked) implementation.\n   */\n  public mockRestore() {\n    this.send.mockRestore();\n  }\n\n  /**\n   * Resets all information stored in the mockFn.mock.calls and mockFn.mock.instances arrays.\n   */\n  public mockClear() {\n    this.send.mockClear();\n    return this;\n  }\n\n  public get mock() {\n    return this.send.mock;\n  }\n\n  /**\n   * Sets the name of the mock.\n   */\n  public mockName(name: string) {\n    this.send.mockName(name);\n    return this;\n  }\n\n  /**\n   * Returns the mock name string set by calling mockFn.mockName(value).\n   */\n  public getMockName() {\n    return this.send.getMockName();\n  }\n\n  /**\n   * Simple sugar function for: mockFn.mockImplementation(() => Promise.resolve(value));\n   */\n  public mockResolvedValue(value: CommandOutput<TOutput>) {\n    this.send.mockResolvedValue(value as any);\n    return this;\n  }\n\n  /**\n   * Simple sugar function for: mockFn.mockImplementationOnce(() => Promise.resolve(value));\n   */\n  public mockResolvedValueOnce(value: CommandOutput<TOutput>) {\n    this.send.mockResolvedValueOnce(value as any);\n    return this;\n  }\n\n  /**\n   * Simple sugar function for: mockFn.mockImplementation(() => Promise.reject(value));\n   */\n  public mockRejectedValue(error: string | Error | SdkError) {\n    if (typeof error === 'string') {\n      error = new Error(error);\n    }\n    this.send.mockRejectedValue(error);\n    return this;\n  }\n\n  /**\n   * Simple sugar function for: mockFn.mockImplementationOnce(() => Promise.reject(value));\n   */\n  public mockRejectedValueOnce(error: string | Error | SdkError) {\n    if (typeof error === 'string') {\n      error = new Error(error);\n    }\n    this.send.mockRejectedValueOnce(error);\n    return this;\n  }\n\n  /**\n   * Accepts a function that should be used as the implementation of the mock. The mock itself will still record all calls that go into and instances that come from itself – the only difference is that the implementation will also be executed when the mock is called.\n   */\n  // eslint-disable-next-line max-len\n  public mockImplementation(fn?: ((command: Command<TInput, TInput, TOutput, TOutput, any>, options?: any, cb?: Callback<TOutput>) => void | CommandOutput<TOutput>) | undefined) {\n    this.send.mockImplementation(fn as any);\n    return this;\n  }\n\n  /**\n   * Accepts a function that will be used as an implementation of the mock for one call to the mocked function. Can be chained so that multiple function calls produce different results.\n   */\n  // eslint-disable-next-line max-len\n  public mockImplementationOnce(fn: (command: Command<TInput, TInput, TOutput, TOutput, any>, options?: any, cb?: Callback<TOutput>) => void | CommandOutput<TOutput>) {\n    this.send.mockImplementationOnce(fn as any);\n    return this;\n  }\n}\n\n// eslint-disable-next-line max-len\nconst isInstance = <TClient extends Client<any, any, any>>(client: InstanceOrClassType<TClient>): client is TClient => (client as TClient).send !== undefined;\n\ntype ClassType<T> = {\n  prototype: T;\n};\n\ntype InstanceOrClassType<T> = T | ClassType<T>;\n\ntype Callback<T> = (err: any, data?: T | undefined) => void\n\ntype CommandOutput<T> = Partial<T> | Promise<Partial<T>>;\n\n// eslint-disable-next-line max-len\ntype SpyInstance<TInput extends object, TOutput extends MetadataBearer> = jest.SpyInstance<void | Promise<TOutput>, [command: Command<TInput, TInput, TOutput, TOutput, any>, options?: any, cb?: Callback<TOutput>]>\n"]}