如何解决如何使用 sinon 存根 aws s3 上传
如何在 Node.js 中存根 S3 上传?
我用的是摩卡和诗浓。我有一个文件,它导出一个包含上传方法的类实例。它看起来像这样:
// storage.ts
import * as AWS from 'aws-sdk';
import archiver from 'archiver';
import retry from 'bluebird-retry';
export class Storage {
private readonly s3: AWS.S3 = new AWS.S3({
endpoint: MINIO_ENDPOINT,accessKeyId: AWS_ACCESS_KEY_ID,secretAccessKey: AWS_SECRET_ACCESS_KEY,s3ForcePathStyle: true,signatureversion: 'v4',});
private readonly uploadBucket: string = UPLOAD_BUCKET;
private readonly downloadBucket: string = DOWNLOAD_BUCKET;
public async upload(localPath: string,s3Key: string,onProgress: (progress: number) => void): Promise<void> {
await retry(async () => { // Be careful,it will influence stub.
const stat = fse.statSync(localPath);
let readable: stream.Readable;
let archive: archiver.Archiver | undefined;
if (stat.isFile()) {
readable = fse.createReadStream(localPath);
} else {
archive = archiver('zip',{ zlib: { level: 0 } }).directory(localPath,false);
readable = archive;
}
const request = this.s3.upload({ Bucket: this.uploadBucket,Key: s3Key,Body: readable });
request.on('httpUploadProgress',({ loaded }) => {
onProgress(loaded);
});
if (archive) {
archive.finalize().catch(console.error);
}
await request.promise().catch((err) => {
fse.removeSync(localPath);
throw err;
});
},{ max_tries: UPLOAD_RETRY_TIMES,throw_original: true });
}
}
export const storage = new Storage();
import { storage } from './storage';
import * as AWS from 'aws-sdk';
import sinon from 'sinon';
describe('Storage',() => {
let sandBox: sinon.SinonSandBox;
before(() => {
sandBox = sinon.createSandBox();
});
afterEach(() => {
sandBox.restore();
});
it('upload',async () => {
const s3Stub = sandBox.stub(AWS.S3.prototype,'upload'); // something wrong
await storage.upload(
'./package.json','s3Key',uploadBytes => { return uploadBytes; });
expect(s3Stub).to.have.callCount(1);
s3Stub.restore();
});
});
Error: Timeout of 2000ms exceeded. For async tests and hooks,ensure "done()" is called; if returning a Promise,ensure it resolves.
我该怎么办?
谢谢大家。
解决方法
在您的 esModuleInterop: true
文件中启用 tsconfig.json
配置并将 import * as AWS from 'aws-sdk'
更改为 import AWS from 'aws-sdk'
。
由于 new Storage()
语句会在您导入 this 模块时立即执行,因此您应该在存根 ./storage.ts
类之后导入 AWS.S3
模块。
附言我删除了与问题无关的代码
例如
storage.ts
:
import AWS from 'aws-sdk';
const UPLOAD_BUCKET = 'UPLOAD_BUCKET';
const MINIO_ENDPOINT = 'MINIO_ENDPOINT';
const AWS_ACCESS_KEY_ID = 'AWS_ACCESS_KEY_ID';
const AWS_SECRET_ACCESS_KEY = 'AWS_SECRET_ACCESS_KEY';
export class Storage {
private readonly s3: AWS.S3 = new AWS.S3({
endpoint: MINIO_ENDPOINT,accessKeyId: AWS_ACCESS_KEY_ID,secretAccessKey: AWS_SECRET_ACCESS_KEY,s3ForcePathStyle: true,signatureVersion: 'v4',});
private readonly uploadBucket: string = UPLOAD_BUCKET;
public async upload(localPath: string,s3Key: string,onProgress: (progress: number) => void): Promise<void> {
const request = this.s3.upload({ Bucket: this.uploadBucket,Key: s3Key,Body: '123' });
}
}
export const storage = new Storage();
storage.test.ts
:
import AWS from 'aws-sdk';
import sinon from 'sinon';
describe('68431461',() => {
let sandbox: sinon.SinonSandbox;
before(() => {
sandbox = sinon.createSandbox();
});
afterEach(() => {
sandbox.restore();
});
it('should pass',async () => {
const s3InstanceStub = { upload: sandbox.stub() };
const s3Stub = sandbox.stub(AWS,'S3').callsFake(() => s3InstanceStub);
const { storage } = await import('./storage');
const onProgressStub = sandbox.stub();
await storage.upload('./package.json','s3Key',onProgressStub);
sinon.assert.calledOnce(s3Stub);
sinon.assert.calledOnce(s3InstanceStub.upload);
});
});
测试结果:
68431461
✓ should pass (796ms)
1 passing (810ms)
------------|---------|----------|---------|---------|-------------------
File | % Stmts | % Branch | % Funcs | % Lines | Uncovered Line #s
------------|---------|----------|---------|---------|-------------------
All files | 100 | 100 | 100 | 100 |
storage.ts | 100 | 100 | 100 | 100 |
------------|---------|----------|---------|---------|-------------------
版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。