forked from aws/aws-sdk-js-v3
-
Notifications
You must be signed in to change notification settings - Fork 0
/
flexibleChecksumsMiddleware.spec.ts
210 lines (186 loc) · 8.68 KB
/
flexibleChecksumsMiddleware.spec.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
import { HttpRequest } from "@aws-sdk/protocol-http";
import { BuildHandlerArguments } from "@aws-sdk/types";
import { PreviouslyResolved } from "./configuration";
import { ChecksumAlgorithm } from "./constants";
import { flexibleChecksumsMiddleware } from "./flexibleChecksumsMiddleware";
import { getChecksumAlgorithmForRequest } from "./getChecksumAlgorithmForRequest";
import { getChecksumLocationName } from "./getChecksumLocationName";
import { hasHeader } from "./hasHeader";
import { isStreaming } from "./isStreaming";
import { selectChecksumAlgorithmFunction } from "./selectChecksumAlgorithmFunction";
import { stringHasher } from "./stringHasher";
import { validateChecksumFromResponse } from "./validateChecksumFromResponse";
jest.mock("@aws-sdk/protocol-http");
jest.mock("./getChecksumAlgorithmForRequest");
jest.mock("./getChecksumLocationName");
jest.mock("./hasHeader");
jest.mock("./isStreaming");
jest.mock("./selectChecksumAlgorithmFunction");
jest.mock("./stringHasher");
jest.mock("./validateChecksumFromResponse");
describe(flexibleChecksumsMiddleware.name, () => {
const mockNext = jest.fn();
const mockChecksum = "mockChecksum";
const mockChecksumAlgorithmFunction = jest.fn();
const mockChecksumLocationName = "mock-checksum-location-name";
const mockInput = {};
const mockConfig = {} as PreviouslyResolved;
const mockMiddlewareConfig = { input: mockInput, requestChecksumRequired: false };
const mockBody = { body: "mockRequestBody" };
const mockHeaders = { "content-length": 100 };
const mockRequest = { body: mockBody, headers: mockHeaders };
const mockArgs = { request: mockRequest } as BuildHandlerArguments<any>;
const mockResult = { response: { body: "mockResponsebody" } };
beforeEach(() => {
mockNext.mockResolvedValueOnce(mockResult);
const { isInstance } = HttpRequest;
(isInstance as unknown as jest.Mock).mockReturnValue(true);
(getChecksumAlgorithmForRequest as jest.Mock).mockReturnValue(ChecksumAlgorithm.MD5);
(getChecksumLocationName as jest.Mock).mockReturnValue(mockChecksumLocationName);
(hasHeader as jest.Mock).mockReturnValue(true);
(isStreaming as jest.Mock).mockReturnValue(false);
(selectChecksumAlgorithmFunction as jest.Mock).mockReturnValue(mockChecksumAlgorithmFunction);
});
afterEach(() => {
expect(mockNext).toHaveBeenCalledTimes(1);
jest.clearAllMocks();
});
describe("skips", () => {
it("if not an instance of HttpRequest", async () => {
const { isInstance } = HttpRequest;
(isInstance as unknown as jest.Mock).mockReturnValue(false);
const handler = flexibleChecksumsMiddleware(mockConfig, mockMiddlewareConfig)(mockNext, {});
await handler(mockArgs);
expect(getChecksumAlgorithmForRequest).not.toHaveBeenCalled();
});
describe("request checksum", () => {
afterEach(() => {
expect(getChecksumAlgorithmForRequest).toHaveBeenCalledTimes(1);
});
it("if checksumAlgorithm is not defined", async () => {
(getChecksumAlgorithmForRequest as jest.Mock).mockReturnValue(undefined);
const handler = flexibleChecksumsMiddleware(mockConfig, mockMiddlewareConfig)(mockNext, {});
await handler(mockArgs);
expect(getChecksumLocationName).not.toHaveBeenCalled();
expect(mockNext).toHaveBeenCalledWith(mockArgs);
expect(selectChecksumAlgorithmFunction).not.toHaveBeenCalled();
});
it("if header is already present", async () => {
const handler = flexibleChecksumsMiddleware(mockConfig, mockMiddlewareConfig)(mockNext, {});
const mockHeadersWithChecksumHeader = { ...mockHeaders, [mockChecksumLocationName]: "mockHeaderValue" };
const mockArgsWithChecksumHeader = {
...mockArgs,
request: { ...mockRequest, headers: mockHeadersWithChecksumHeader },
};
await handler(mockArgsWithChecksumHeader);
expect(getChecksumLocationName).toHaveBeenCalledWith(ChecksumAlgorithm.MD5);
expect(selectChecksumAlgorithmFunction).toHaveBeenCalledWith(ChecksumAlgorithm.MD5, mockConfig);
expect(mockNext).toHaveBeenCalledWith(mockArgsWithChecksumHeader);
expect(hasHeader).toHaveBeenCalledWith(mockChecksumLocationName, mockHeadersWithChecksumHeader);
});
});
describe("response validation", () => {
it("if requestValidationModeMember is not defined", async () => {
const handler = flexibleChecksumsMiddleware(mockConfig, mockMiddlewareConfig)(mockNext, {});
await handler(mockArgs);
expect(validateChecksumFromResponse).not.toHaveBeenCalled();
});
it("if requestValidationModeMember is not set to 'ENABLED' in input", async () => {
const mockRequestValidationModeMember = "mockRequestValidationModeMember";
const handler = flexibleChecksumsMiddleware(mockConfig, {
...mockMiddlewareConfig,
requestValidationModeMember: mockRequestValidationModeMember,
})(mockNext, {});
await handler(mockArgs);
expect(validateChecksumFromResponse).not.toHaveBeenCalled();
});
});
});
describe("adds checksum in the request header", () => {
afterEach(() => {
expect(getChecksumAlgorithmForRequest).toHaveBeenCalledTimes(1);
expect(getChecksumLocationName).toHaveBeenCalledTimes(1);
expect(selectChecksumAlgorithmFunction).toHaveBeenCalledTimes(1);
});
it("for streaming body", async () => {
(isStreaming as jest.Mock).mockReturnValue(true);
const mockUpdatedBody = { body: "mockUpdatedBody" };
const mockBase64Encoder = jest.fn();
const mockStreamHasher = jest.fn();
const mockBodyLengthChecker = jest.fn();
const mockGetAwsChunkedEncodingStream = jest.fn().mockReturnValue(mockUpdatedBody);
const handler = flexibleChecksumsMiddleware(
{
...mockConfig,
base64Encoder: mockBase64Encoder,
bodyLengthChecker: mockBodyLengthChecker,
getAwsChunkedEncodingStream: mockGetAwsChunkedEncodingStream,
streamHasher: mockStreamHasher,
},
mockMiddlewareConfig
)(mockNext, {});
await handler(mockArgs);
expect(mockNext).toHaveBeenCalledWith({
...mockArgs,
request: {
...mockRequest,
headers: {
...mockHeaders,
"content-length": undefined,
"content-encoding": "aws-chunked",
"transfer-encoding": "chunked",
"x-amz-decoded-content-length": mockHeaders["content-length"],
"x-amz-content-sha256": "STREAMING-UNSIGNED-PAYLOAD-TRAILER",
"x-amz-trailer": mockChecksumLocationName,
},
body: mockUpdatedBody,
},
});
expect(mockGetAwsChunkedEncodingStream).toHaveBeenCalledWith(mockRequest.body, {
base64Encoder: mockBase64Encoder,
bodyLengthChecker: mockBodyLengthChecker,
checksumLocationName: mockChecksumLocationName,
checksumAlgorithmFn: mockChecksumAlgorithmFunction,
streamHasher: mockStreamHasher,
});
});
it("for non-streaming body", async () => {
const mockRawChecksum = Buffer.from(mockChecksum);
const mockBase64Encoder = jest.fn().mockReturnValue(mockChecksum);
(stringHasher as jest.Mock).mockResolvedValue(mockRawChecksum);
(hasHeader as jest.Mock).mockReturnValue(false);
const handler = flexibleChecksumsMiddleware(
{ ...mockConfig, base64Encoder: mockBase64Encoder },
mockMiddlewareConfig
)(mockNext, {});
await handler(mockArgs);
expect(hasHeader).toHaveBeenCalledTimes(1);
expect(mockNext).toHaveBeenCalledWith({
...mockArgs,
request: {
...mockRequest,
headers: { ...mockHeaders, [mockChecksumLocationName]: mockChecksum },
},
});
expect(hasHeader).toHaveBeenCalledWith(mockChecksumLocationName, mockHeaders);
expect(stringHasher).toHaveBeenCalledWith(mockChecksumAlgorithmFunction, mockRequest.body);
expect(mockBase64Encoder).toHaveBeenCalledWith(mockRawChecksum);
});
});
it("validates checksum from the response header", async () => {
const mockRequestValidationModeMember = "mockRequestValidationModeMember";
const mockInput = { [mockRequestValidationModeMember]: "ENABLED" };
const mockResponseAlgorithms = ["ALGO1", "ALGO2"];
const handler = flexibleChecksumsMiddleware(mockConfig, {
...mockMiddlewareConfig,
input: mockInput,
requestValidationModeMember: mockRequestValidationModeMember,
responseAlgorithms: mockResponseAlgorithms,
})(mockNext, {});
await handler(mockArgs);
expect(validateChecksumFromResponse).toHaveBeenCalledWith(mockResult.response, {
config: mockConfig,
responseAlgorithms: mockResponseAlgorithms,
});
});
});