Open victorgsp opened 2 years ago
thomaux
commented
2 years ago Hi @victorgsp, if I'm not mistaken the mock lib will still perform parameter validation. You're getting this error because the environment variable Environment.RAW_DATA_BUCKET_NAME is likely not set in your tests
victorgsp
commented
2 years ago Hi @victorgsp, if I'm not mistaken the mock lib will still perform parameter validation. You're getting this error because the environment variable
Environment.RAW_DATA_BUCKET_NAMEis likely not set in your tests
Hi @thomaux, thanks for the answer. Following your explanation, I put the code below in my test suite:
beforeAll(() => {
process.env = Object.assign(process.env, {
RAW_DATA_BUCKET_NAME: "notexistbucketname",
});
});Now I received the following error:
NoSuchBucket: The specified bucket does not exist
Apparently, my test is using the real aws-sdk instead of the mock.
thomaux
commented
2 years ago @victorgsp it does seem like that yes. Is the full code publicly available so I could have a look? If not, could you maybe share the full files for the source and test?
The mock needs to be set before the AWS service is created, from your code snippet that does seem to happen, so I'm unsure where it's going wrong at the moment
victorgsp
commented
2 years ago @victorgsp it does seem like that yes. Is the full code publicly available so I could have a look? If not, could you maybe share the full files for the source and test?
The mock needs to be set before the AWS service is created, from your code snippet that does seem to happen, so I'm unsure where it's going wrong at the moment
It's not a public repository, but the files are with following content:
S3Provider.ts
import * as AWS from "aws-sdk";
import { Environment } from "../../../core/commons/constants/environment";
class S3Provider {
public async getS3ObjectList() {
const s3 = new AWS.S3();
const params: AWS.S3.ListObjectsV2Request = {
Bucket: Environment.RAW_DATA_BUCKET_NAME,
};
const list: AWS.S3.ListObjectsV2Output = await s3
.listObjectsV2(params)
.promise();
return list;
}
}
export { S3Provider };
S3Provider.spec.ts
import * as AWS from "aws-sdk";
import * as AWSMock from "aws-sdk-mock";
import { ListObjectsV2Output } from "aws-sdk/clients/s3";
import { S3Provider } from "../S3Provider";
const output: ListObjectsV2Output = {
Contents: [
{
Key: "PACKAGE_NAME|2|2011-10-05T14:48:00.000Z|email@teste.com/",
},
{
Key: "PACKAGE_NAME|2|2011-10-05T14:48:00.000Z|email@teste.com/File1.txt",
},
{
Key: "PACKAGE_NAME|2|2011-10-05T14:48:00.000Z|email@teste.com/File2.txt",
},
],
};
describe("RawDataFileProvider", () => {
beforeAll(() => {
process.env = Object.assign(process.env, {
RAW_DATA_BUCKET_NAME: "notexistbucketname",
});
});
it("should return the correct RawDataPackages", async () => {
AWSMock.restore();
AWSMock.setSDKInstance(AWS);
AWSMock.mock("S3", "listObjectsV2", output);
const provider = new S3Provider();
const result = await provider.getS3ObjectList();
expect(result).toEqual({
packages: [
{
numberOfFiles: 2,
packageName: "PACKAGE_NAME",
uploadDate: new Date("2011-10-05T14:48:00.000Z"),
userEmail: "email@teste.com",
updateCompleted: false,
files: [
{
name: "PACKAGE_NAME|2|2011-10-05T14:48:00.000Z|email@teste.com/File1.txt",
isUploadedFile: false,
},
{
name: "PACKAGE_NAME|2|2011-10-05T14:48:00.000Z|email@teste.com/File2.txt",
isUploadedFile: false,
},
],
},
],
});
});
});
Hmm strange, it works when I copy both those files locally, with the following configuration:
package.json
{
"name": "sandbox",
"version": "1.0.0",
"description": "",
"main": "index.js",
"scripts": {
"test": "jest"
},
"author": "",
"license": "ISC",
"devDependencies": {
"@types/jest": "^27.4.0",
"aws-sdk-mock": "^5.6.2",
"jest": "^27.4.7",
"ts-jest": "^27.1.3",
"typescript": "^4.5.5"
}
}jest.config.js
module.exports = {
collectCoverage: false,
preset: 'ts-jest',
testEnvironment: 'node',
testRegex: '(.*spec.ts)$',
transform: {
'.ts': 'ts-jest',
},
verbose: true,
};Running npm test results in this output:
FAIL ./S3Provider.spec.ts (6.204 s)
RawDataFileProvider
✕ should return the correct RawDataPackages (17 ms)
● RawDataFileProvider › should return the correct RawDataPackages
expect(received).toEqual(expected) // deep equality
- Expected - 13
+ Received + 5
Object {
- "packages": Array [
+ "Contents": Array [
Object {
- "files": Array [
+ "Key": "PACKAGE_NAME|2|2011-10-05T14:48:00.000Z|email@teste.com/",
+ },
Object {
- "isUploadedFile": false,
- "name": "PACKAGE_NAME|2|2011-10-05T14:48:00.000Z|email@teste.com/File1.txt",
+ "Key": "PACKAGE_NAME|2|2011-10-05T14:48:00.000Z|email@teste.com/File1.txt",
},
Object {
- "isUploadedFile": false,
- "name": "PACKAGE_NAME|2|2011-10-05T14:48:00.000Z|email@teste.com/File2.txt",
- },
- ],
- "numberOfFiles": 2,
- "packageName": "PACKAGE_NAME",
- "updateCompleted": false,
- "uploadDate": 2011-10-05T14:48:00.000Z,
- "userEmail": "email@teste.com",
+ "Key": "PACKAGE_NAME|2|2011-10-05T14:48:00.000Z|email@teste.com/File2.txt",
},
],
}
34 | const result = await provider.getS3ObjectList();
35 |
> 36 | expect(result).toEqual({
| ^
37 | packages: [
38 | {
39 | numberOfFiles: 2,
at S3Provider.spec.ts:36:24
at fulfilled (S3Provider.spec.ts:5:58)
Test Suites: 1 failed, 1 total
Tests: 1 failed, 1 total
Snapshots: 0 total
Time: 6.266 s
Ran all test suites.
npm ERR! Test failed. See above for more details.
Hi guys, i'm not able to mock s3 with typescript
packages version:
my code
my test
Error:
UriParameterError: Expected uri parameter to have length >= 1, but found "" for params.Bucket
`