@terreno/test 57.18.0 → 57.20.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +2074 -0
- package/README.md +6 -0
- package/dist/assertions/expectAPIError.d.ts +18 -0
- package/dist/assertions/expectAPIError.js +33 -0
- package/dist/assertions/strictResponseProperties.d.ts +14 -0
- package/dist/assertions/strictResponseProperties.js +37 -0
- package/dist/cache/mongoTestCache.js +2 -2
- package/dist/cli/collectFiles.d.ts +38 -0
- package/dist/cli/collectFiles.js +73 -0
- package/dist/cli/testHygiene.d.ts +134 -0
- package/dist/cli/testHygiene.js +357 -0
- package/dist/cli/testHygieneCli.d.ts +2 -0
- package/dist/cli/testHygieneCli.js +5 -0
- package/dist/cli/testHygieneRules.d.ts +58 -0
- package/dist/cli/testHygieneRules.js +517 -0
- package/dist/cli/testShard.d.ts +155 -0
- package/dist/cli/testShard.js +377 -0
- package/dist/cli/testShardCli.d.ts +2 -0
- package/dist/cli/testShardCli.js +5 -0
- package/dist/expo/authTokenStorage.d.ts +76 -0
- package/dist/expo/authTokenStorage.js +160 -0
- package/dist/expo/expoModuleMocks.d.ts +24 -0
- package/dist/expo/expoModuleMocks.js +456 -0
- package/dist/expo/libraryModuleMocks.d.ts +17 -0
- package/dist/expo/libraryModuleMocks.js +347 -0
- package/dist/expo/mockHelpers.d.ts +39 -0
- package/dist/expo/mockHelpers.js +45 -0
- package/dist/expo/mockModuleAliases.d.ts +50 -0
- package/dist/expo/mockModuleAliases.js +174 -0
- package/dist/expo/reactNativeMock.d.ts +39 -0
- package/dist/expo/reactNativeMock.js +421 -0
- package/dist/expo/registerExpoTestEnvironment.d.ts +69 -0
- package/dist/expo/registerExpoTestEnvironment.js +165 -0
- package/dist/expo/renderWithTerreno.d.ts +47 -0
- package/dist/expo/renderWithTerreno.js +47 -0
- package/dist/http/authWithToken.d.ts +20 -0
- package/dist/http/authWithToken.js +30 -0
- package/dist/index.d.ts +14 -1
- package/dist/index.js +33 -1
- package/dist/logging/silenceLogs.js +0 -2
- package/dist/mocks/aiSdk.d.ts +77 -0
- package/dist/mocks/aiSdk.js +102 -0
- package/dist/mocks/cloudTasks.d.ts +91 -0
- package/dist/mocks/cloudTasks.js +197 -0
- package/dist/mocks/expoPush.d.ts +53 -0
- package/dist/mocks/expoPush.js +57 -0
- package/dist/mocks/gcs.d.ts +101 -0
- package/dist/mocks/gcs.js +162 -0
- package/dist/mocks/googleAuth.d.ts +69 -0
- package/dist/mocks/googleAuth.js +55 -0
- package/dist/mocks/mockGroup.d.ts +11 -0
- package/dist/mocks/mockGroup.js +21 -0
- package/dist/mocks/notifiers.d.ts +21 -0
- package/dist/mocks/notifiers.js +26 -0
- package/dist/mocks/sendgrid.d.ts +22 -0
- package/dist/mocks/sendgrid.js +32 -0
- package/dist/mocks/twilio.d.ts +72 -0
- package/dist/mocks/twilio.js +64 -0
- package/dist/preload/registerBackendPreload.js +4 -1
- package/dist/time/freezeTime.d.ts +16 -0
- package/dist/time/freezeTime.js +49 -0
- package/dist/transaction/testTransaction.d.ts +43 -6
- package/dist/transaction/testTransaction.js +371 -92
- package/dist/utils/waitUntil.d.ts +22 -0
- package/dist/utils/waitUntil.js +34 -0
- package/package.json +53 -8
- package/src/assertions/expectAPIError.ts +51 -0
- package/src/assertions/strictResponseProperties.ts +42 -0
- package/src/cache/mongoTestCache.ts +2 -2
- package/src/cli/collectFiles.ts +115 -0
- package/src/cli/testHygiene.ts +539 -0
- package/src/cli/testHygieneCli.ts +4 -0
- package/src/cli/testHygieneRules.ts +719 -0
- package/src/cli/testShard.ts +532 -0
- package/src/cli/testShardCli.ts +4 -0
- package/src/expo/authTokenStorage.ts +198 -0
- package/src/expo/expoModuleMocks.ts +503 -0
- package/src/expo/libraryModuleMocks.ts +411 -0
- package/src/expo/mockHelpers.ts +73 -0
- package/src/expo/mockModuleAliases.ts +252 -0
- package/src/expo/reactNativeMock.ts +534 -0
- package/src/expo/registerExpoTestEnvironment.ts +262 -0
- package/src/expo/renderWithTerreno.ts +79 -0
- package/src/http/authWithToken.ts +38 -0
- package/src/index.ts +82 -1
- package/src/logging/silenceLogs.ts +0 -2
- package/src/mocks/aiSdk.ts +199 -0
- package/src/mocks/cloudTasks.ts +323 -0
- package/src/mocks/expoPush.ts +134 -0
- package/src/mocks/gcs.ts +305 -0
- package/src/mocks/googleAuth.ts +136 -0
- package/src/mocks/mockGroup.ts +32 -0
- package/src/mocks/notifiers.ts +36 -0
- package/src/mocks/sendgrid.ts +57 -0
- package/src/mocks/twilio.ts +143 -0
- package/src/preload/registerBackendPreload.ts +4 -1
- package/src/time/freezeTime.ts +61 -0
- package/src/transaction/testTransaction.ts +456 -124
- package/src/utils/waitUntil.ts +47 -0
- package/biome.jsonc +0 -20
- package/bunfig.toml +0 -16
- package/src/cache/mongoTestCache.test.ts +0 -103
- package/src/env/setTerrenoTestEnv.test.ts +0 -26
- package/src/http/authAsUser.test.ts +0 -40
- package/src/http/getBaseServer.test.ts +0 -45
- package/src/logging/setupEnvironment.test.ts +0 -24
- package/src/logging/silenceLogs.test.ts +0 -52
- package/src/logging/testLogger.test.ts +0 -58
- package/src/mocks/sentryBun.test.ts +0 -230
- package/src/mongo/connection.test.ts +0 -43
- package/src/mongo/mongoServer.test.ts +0 -99
- package/src/preload/registerBackendPreload.test.ts +0 -10
- package/src/transaction/testTransaction.test.ts +0 -64
- package/src/utils/helpers.test.ts +0 -46
- package/tsconfig.json +0 -18
package/src/mocks/gcs.ts
ADDED
|
@@ -0,0 +1,305 @@
|
|
|
1
|
+
import {type Mock, mock} from "bun:test";
|
|
2
|
+
import {Readable, Writable} from "node:stream";
|
|
3
|
+
import {DateTime} from "luxon";
|
|
4
|
+
|
|
5
|
+
import {createMockGroup} from "./mockGroup";
|
|
6
|
+
|
|
7
|
+
export type GcsObjectMetadata = Record<string, unknown>;
|
|
8
|
+
|
|
9
|
+
export interface GcsStoredObject {
|
|
10
|
+
contents: Buffer;
|
|
11
|
+
metadata: GcsObjectMetadata;
|
|
12
|
+
}
|
|
13
|
+
|
|
14
|
+
export interface GcsSaveOptions {
|
|
15
|
+
contentType?: string;
|
|
16
|
+
metadata?: GcsObjectMetadata;
|
|
17
|
+
[key: string]: unknown;
|
|
18
|
+
}
|
|
19
|
+
|
|
20
|
+
export interface GcsGetFilesQuery {
|
|
21
|
+
delimiter?: string;
|
|
22
|
+
prefix?: string;
|
|
23
|
+
[key: string]: unknown;
|
|
24
|
+
}
|
|
25
|
+
|
|
26
|
+
/** A file handle from `bucket.file(name)`. Its methods are the shared `fileMocks`. */
|
|
27
|
+
export interface GcsMockFile {
|
|
28
|
+
bucket: GcsMockBucket;
|
|
29
|
+
createReadStream: GcsFileMocks["createReadStream"];
|
|
30
|
+
createWriteStream: GcsFileMocks["createWriteStream"];
|
|
31
|
+
delete: GcsFileMocks["delete"];
|
|
32
|
+
download: GcsFileMocks["download"];
|
|
33
|
+
exists: GcsFileMocks["exists"];
|
|
34
|
+
getMetadata: GcsFileMocks["getMetadata"];
|
|
35
|
+
getSignedUrl: GcsFileMocks["getSignedUrl"];
|
|
36
|
+
/** Current stored metadata, or `{}` when the object does not exist. */
|
|
37
|
+
readonly metadata: GcsObjectMetadata;
|
|
38
|
+
name: string;
|
|
39
|
+
publicUrl: () => string;
|
|
40
|
+
save: GcsFileMocks["save"];
|
|
41
|
+
setMetadata: GcsFileMocks["setMetadata"];
|
|
42
|
+
}
|
|
43
|
+
|
|
44
|
+
export interface GcsMockBucket {
|
|
45
|
+
deleteFiles: GcsMock["deleteFiles"];
|
|
46
|
+
file: GcsMock["file"];
|
|
47
|
+
getFiles: GcsMock["getFiles"];
|
|
48
|
+
name: string;
|
|
49
|
+
}
|
|
50
|
+
|
|
51
|
+
/**
|
|
52
|
+
* Shared across every file handle; each call runs with `this` bound to the file. Assert with
|
|
53
|
+
* `fileMocks.save.mock.contexts[0].name` or `gcs.file.mock.calls` when the path matters.
|
|
54
|
+
*/
|
|
55
|
+
export interface GcsFileMocks {
|
|
56
|
+
createReadStream: Mock<(this: GcsMockFile) => Readable>;
|
|
57
|
+
createWriteStream: Mock<(this: GcsMockFile, options?: GcsSaveOptions) => Writable>;
|
|
58
|
+
delete: Mock<(this: GcsMockFile, options?: {ignoreNotFound?: boolean}) => Promise<[unknown]>>;
|
|
59
|
+
download: Mock<(this: GcsMockFile) => Promise<[Buffer]>>;
|
|
60
|
+
exists: Mock<(this: GcsMockFile) => Promise<[boolean]>>;
|
|
61
|
+
getMetadata: Mock<(this: GcsMockFile) => Promise<[GcsObjectMetadata]>>;
|
|
62
|
+
getSignedUrl: Mock<(this: GcsMockFile, config?: Record<string, unknown>) => Promise<[string]>>;
|
|
63
|
+
save: Mock<
|
|
64
|
+
(this: GcsMockFile, data: string | Uint8Array, options?: GcsSaveOptions) => Promise<void>
|
|
65
|
+
>;
|
|
66
|
+
setMetadata: Mock<
|
|
67
|
+
(this: GcsMockFile, metadata: GcsObjectMetadata) => Promise<[GcsObjectMetadata]>
|
|
68
|
+
>;
|
|
69
|
+
}
|
|
70
|
+
|
|
71
|
+
export interface GcsMock {
|
|
72
|
+
/** `new Storage(options)` — every instance is the shared `storage`. */
|
|
73
|
+
Storage: Mock<(options?: Record<string, unknown>) => {bucket: GcsMock["bucket"]}>;
|
|
74
|
+
storage: {bucket: GcsMock["bucket"]};
|
|
75
|
+
/** `storage.bucket(name)`. */
|
|
76
|
+
bucket: Mock<(name: string) => GcsMockBucket>;
|
|
77
|
+
/** `bucket.file(name)` — `this` is the bucket. */
|
|
78
|
+
file: Mock<(this: GcsMockBucket, name: string) => GcsMockFile>;
|
|
79
|
+
/** `bucket.getFiles(query)` — resolves `[files, null, {prefixes}]` like the real API. */
|
|
80
|
+
getFiles: Mock<
|
|
81
|
+
(
|
|
82
|
+
this: GcsMockBucket,
|
|
83
|
+
query?: GcsGetFilesQuery
|
|
84
|
+
) => Promise<[GcsMockFile[], null, {prefixes: string[]}]>
|
|
85
|
+
>;
|
|
86
|
+
/** `bucket.deleteFiles({prefix})`. */
|
|
87
|
+
deleteFiles: Mock<(this: GcsMockBucket, query?: {prefix?: string}) => Promise<void>>;
|
|
88
|
+
fileMocks: GcsFileMocks;
|
|
89
|
+
/** Reads an object from the in-memory store. */
|
|
90
|
+
getObject: (params: {bucket: string; name: string}) => GcsStoredObject | undefined;
|
|
91
|
+
/** Every stored object key as `bucket/name`, sorted. */
|
|
92
|
+
listObjects: () => string[];
|
|
93
|
+
/** Seeds an object without going through the mocks (no calls are recorded). */
|
|
94
|
+
putObject: (params: {
|
|
95
|
+
bucket: string;
|
|
96
|
+
contentType?: string;
|
|
97
|
+
contents: string | Uint8Array;
|
|
98
|
+
name: string;
|
|
99
|
+
}) => void;
|
|
100
|
+
/** Clears calls, overrides, and the in-memory store. */
|
|
101
|
+
reset: () => void;
|
|
102
|
+
}
|
|
103
|
+
|
|
104
|
+
const objectKey = (bucket: string, name: string): string => `${bucket}/${name}`;
|
|
105
|
+
|
|
106
|
+
const notFoundError = (bucket: string, name: string): Error & {code: number} =>
|
|
107
|
+
Object.assign(new Error(`No such object: ${bucket}/${name}`), {code: 404});
|
|
108
|
+
|
|
109
|
+
const toBuffer = (data: string | Uint8Array): Buffer =>
|
|
110
|
+
typeof data === "string" ? Buffer.from(data) : Buffer.from(data);
|
|
111
|
+
|
|
112
|
+
/**
|
|
113
|
+
* Registers `mock.module("@google-cloud/storage", ...)` backed by an in-memory object store, so
|
|
114
|
+
* uploads can be downloaded, listed, streamed, and deleted again. Missing objects reject with a
|
|
115
|
+
* `code: 404` error the way GCS does. `@google-cloud/storage` does not need to be installed.
|
|
116
|
+
*/
|
|
117
|
+
export const registerGcsMock = (): GcsMock => {
|
|
118
|
+
const group = createMockGroup();
|
|
119
|
+
const objects = new Map<string, GcsStoredObject>();
|
|
120
|
+
|
|
121
|
+
const store = ({
|
|
122
|
+
bucket,
|
|
123
|
+
contents,
|
|
124
|
+
name,
|
|
125
|
+
options,
|
|
126
|
+
}: {
|
|
127
|
+
bucket: string;
|
|
128
|
+
contents: Buffer;
|
|
129
|
+
name: string;
|
|
130
|
+
options?: GcsSaveOptions;
|
|
131
|
+
}): void => {
|
|
132
|
+
const contentType = options?.contentType ?? options?.metadata?.contentType;
|
|
133
|
+
objects.set(objectKey(bucket, name), {
|
|
134
|
+
contents,
|
|
135
|
+
metadata: {
|
|
136
|
+
...(options?.metadata ?? {}),
|
|
137
|
+
bucket,
|
|
138
|
+
contentType,
|
|
139
|
+
name,
|
|
140
|
+
size: String(contents.length),
|
|
141
|
+
updated: DateTime.utc().toISO(),
|
|
142
|
+
},
|
|
143
|
+
});
|
|
144
|
+
};
|
|
145
|
+
|
|
146
|
+
const requireObject = (file: GcsMockFile): GcsStoredObject => {
|
|
147
|
+
const stored = objects.get(objectKey(file.bucket.name, file.name));
|
|
148
|
+
if (!stored) {
|
|
149
|
+
throw notFoundError(file.bucket.name, file.name);
|
|
150
|
+
}
|
|
151
|
+
return stored;
|
|
152
|
+
};
|
|
153
|
+
|
|
154
|
+
const fileMocks: GcsFileMocks = {
|
|
155
|
+
createReadStream: group.fn(function (this: GcsMockFile): Readable {
|
|
156
|
+
const stored = objects.get(objectKey(this.bucket.name, this.name));
|
|
157
|
+
if (!stored) {
|
|
158
|
+
const error = notFoundError(this.bucket.name, this.name);
|
|
159
|
+
return new Readable({
|
|
160
|
+
read(): void {
|
|
161
|
+
this.destroy(error);
|
|
162
|
+
},
|
|
163
|
+
});
|
|
164
|
+
}
|
|
165
|
+
return Readable.from([stored.contents]);
|
|
166
|
+
}),
|
|
167
|
+
createWriteStream: group.fn(function (this: GcsMockFile, options?: GcsSaveOptions): Writable {
|
|
168
|
+
const chunks: Buffer[] = [];
|
|
169
|
+
return new Writable({
|
|
170
|
+
final: (callback): void => {
|
|
171
|
+
store({
|
|
172
|
+
bucket: this.bucket.name,
|
|
173
|
+
contents: Buffer.concat(chunks),
|
|
174
|
+
name: this.name,
|
|
175
|
+
options,
|
|
176
|
+
});
|
|
177
|
+
callback();
|
|
178
|
+
},
|
|
179
|
+
write: (chunkData: Buffer | string, _encoding, callback): void => {
|
|
180
|
+
chunks.push(toBuffer(chunkData));
|
|
181
|
+
callback();
|
|
182
|
+
},
|
|
183
|
+
});
|
|
184
|
+
}),
|
|
185
|
+
delete: group.fn(async function (
|
|
186
|
+
this: GcsMockFile,
|
|
187
|
+
options?: {ignoreNotFound?: boolean}
|
|
188
|
+
): Promise<[unknown]> {
|
|
189
|
+
const deleted = objects.delete(objectKey(this.bucket.name, this.name));
|
|
190
|
+
if (!deleted && !options?.ignoreNotFound) {
|
|
191
|
+
throw notFoundError(this.bucket.name, this.name);
|
|
192
|
+
}
|
|
193
|
+
return [{}];
|
|
194
|
+
}),
|
|
195
|
+
download: group.fn(async function (this: GcsMockFile): Promise<[Buffer]> {
|
|
196
|
+
return [Buffer.from(requireObject(this).contents)];
|
|
197
|
+
}),
|
|
198
|
+
exists: group.fn(async function (this: GcsMockFile): Promise<[boolean]> {
|
|
199
|
+
return [objects.has(objectKey(this.bucket.name, this.name))];
|
|
200
|
+
}),
|
|
201
|
+
getMetadata: group.fn(async function (this: GcsMockFile): Promise<[GcsObjectMetadata]> {
|
|
202
|
+
return [{...requireObject(this).metadata}];
|
|
203
|
+
}),
|
|
204
|
+
getSignedUrl: group.fn(async function (
|
|
205
|
+
this: GcsMockFile,
|
|
206
|
+
_config?: Record<string, unknown>
|
|
207
|
+
): Promise<[string]> {
|
|
208
|
+
return [
|
|
209
|
+
`https://storage.googleapis.com/${this.bucket.name}/${encodeURI(this.name)}?X-Goog-Signature=mock`,
|
|
210
|
+
];
|
|
211
|
+
}),
|
|
212
|
+
save: group.fn(async function (
|
|
213
|
+
this: GcsMockFile,
|
|
214
|
+
data: string | Uint8Array,
|
|
215
|
+
options?: GcsSaveOptions
|
|
216
|
+
): Promise<void> {
|
|
217
|
+
store({bucket: this.bucket.name, contents: toBuffer(data), name: this.name, options});
|
|
218
|
+
}),
|
|
219
|
+
setMetadata: group.fn(async function (
|
|
220
|
+
this: GcsMockFile,
|
|
221
|
+
metadata: GcsObjectMetadata
|
|
222
|
+
): Promise<[GcsObjectMetadata]> {
|
|
223
|
+
const stored = requireObject(this);
|
|
224
|
+
stored.metadata = {...stored.metadata, ...metadata};
|
|
225
|
+
return [{...stored.metadata}];
|
|
226
|
+
}),
|
|
227
|
+
};
|
|
228
|
+
|
|
229
|
+
const createFile = (bucket: GcsMockBucket, name: string): GcsMockFile => ({
|
|
230
|
+
bucket,
|
|
231
|
+
...fileMocks,
|
|
232
|
+
get metadata(): GcsObjectMetadata {
|
|
233
|
+
return objects.get(objectKey(bucket.name, name))?.metadata ?? {};
|
|
234
|
+
},
|
|
235
|
+
name,
|
|
236
|
+
publicUrl: (): string => `https://storage.googleapis.com/${bucket.name}/${encodeURI(name)}`,
|
|
237
|
+
});
|
|
238
|
+
|
|
239
|
+
const namesInBucket = (bucketName: string, prefix: string): string[] =>
|
|
240
|
+
[...objects.keys()]
|
|
241
|
+
.filter((key) => key.startsWith(`${bucketName}/${prefix}`))
|
|
242
|
+
.map((key) => key.slice(bucketName.length + 1))
|
|
243
|
+
.sort();
|
|
244
|
+
|
|
245
|
+
const file = group.fn(function (this: GcsMockBucket, name: string): GcsMockFile {
|
|
246
|
+
return createFile(this, name);
|
|
247
|
+
});
|
|
248
|
+
|
|
249
|
+
const getFiles = group.fn(async function (
|
|
250
|
+
this: GcsMockBucket,
|
|
251
|
+
query?: GcsGetFilesQuery
|
|
252
|
+
): Promise<[GcsMockFile[], null, {prefixes: string[]}]> {
|
|
253
|
+
const prefix = query?.prefix ?? "";
|
|
254
|
+
const delimiter = query?.delimiter;
|
|
255
|
+
const files: GcsMockFile[] = [];
|
|
256
|
+
const prefixes = new Set<string>();
|
|
257
|
+
for (const name of namesInBucket(this.name, prefix)) {
|
|
258
|
+
const rest = name.slice(prefix.length);
|
|
259
|
+
const delimiterIndex = delimiter ? rest.indexOf(delimiter) : -1;
|
|
260
|
+
if (delimiter && delimiterIndex >= 0) {
|
|
261
|
+
prefixes.add(`${prefix}${rest.slice(0, delimiterIndex + delimiter.length)}`);
|
|
262
|
+
continue;
|
|
263
|
+
}
|
|
264
|
+
files.push(createFile(this, name));
|
|
265
|
+
}
|
|
266
|
+
return [files, null, {prefixes: [...prefixes]}];
|
|
267
|
+
});
|
|
268
|
+
|
|
269
|
+
const deleteFiles = group.fn(async function (
|
|
270
|
+
this: GcsMockBucket,
|
|
271
|
+
query?: {prefix?: string}
|
|
272
|
+
): Promise<void> {
|
|
273
|
+
for (const name of namesInBucket(this.name, query?.prefix ?? "")) {
|
|
274
|
+
objects.delete(objectKey(this.name, name));
|
|
275
|
+
}
|
|
276
|
+
});
|
|
277
|
+
|
|
278
|
+
const bucket = group.fn((name: string): GcsMockBucket => ({deleteFiles, file, getFiles, name}));
|
|
279
|
+
const storage = {bucket};
|
|
280
|
+
const Storage = group.fn((_options?: Record<string, unknown>) => storage);
|
|
281
|
+
|
|
282
|
+
const reset = (): void => {
|
|
283
|
+
group.reset();
|
|
284
|
+
objects.clear();
|
|
285
|
+
};
|
|
286
|
+
|
|
287
|
+
mock.module("@google-cloud/storage", () => ({default: {Storage}, Storage}));
|
|
288
|
+
|
|
289
|
+
return {
|
|
290
|
+
bucket,
|
|
291
|
+
deleteFiles,
|
|
292
|
+
file,
|
|
293
|
+
fileMocks,
|
|
294
|
+
getFiles,
|
|
295
|
+
getObject: ({bucket: bucketName, name}): GcsStoredObject | undefined =>
|
|
296
|
+
objects.get(objectKey(bucketName, name)),
|
|
297
|
+
listObjects: (): string[] => [...objects.keys()].sort(),
|
|
298
|
+
putObject: ({bucket: bucketName, contentType, contents, name}): void => {
|
|
299
|
+
store({bucket: bucketName, contents: toBuffer(contents), name, options: {contentType}});
|
|
300
|
+
},
|
|
301
|
+
reset,
|
|
302
|
+
Storage,
|
|
303
|
+
storage,
|
|
304
|
+
};
|
|
305
|
+
};
|
|
@@ -0,0 +1,136 @@
|
|
|
1
|
+
import {type Mock, mock} from "bun:test";
|
|
2
|
+
|
|
3
|
+
import {createMockGroup} from "./mockGroup";
|
|
4
|
+
|
|
5
|
+
export interface GoogleAuthMockRequestOptions {
|
|
6
|
+
data?: unknown;
|
|
7
|
+
method?: string;
|
|
8
|
+
url: string;
|
|
9
|
+
[key: string]: unknown;
|
|
10
|
+
}
|
|
11
|
+
|
|
12
|
+
export interface GoogleAuthMockResponse {
|
|
13
|
+
data: unknown;
|
|
14
|
+
headers: Record<string, string>;
|
|
15
|
+
status: number;
|
|
16
|
+
}
|
|
17
|
+
|
|
18
|
+
export interface GoogleAuthMockClient {
|
|
19
|
+
getAccessToken: GoogleAuthMock["getAccessToken"];
|
|
20
|
+
getRequestHeaders: GoogleAuthMock["getRequestHeaders"];
|
|
21
|
+
request: GoogleAuthMock["request"];
|
|
22
|
+
}
|
|
23
|
+
|
|
24
|
+
export interface GoogleAuthMockIdTokenPayload {
|
|
25
|
+
aud?: string;
|
|
26
|
+
email?: string;
|
|
27
|
+
email_verified?: boolean;
|
|
28
|
+
[key: string]: unknown;
|
|
29
|
+
}
|
|
30
|
+
|
|
31
|
+
export interface GoogleAuthMockTicket {
|
|
32
|
+
getPayload: () => GoogleAuthMockIdTokenPayload;
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
export interface RegisterGoogleAuthMockOptions {
|
|
36
|
+
/** Token `getAccessToken()` returns. Default `"mock-access-token"`. */
|
|
37
|
+
accessToken?: string;
|
|
38
|
+
/** Claims every verified ID token carries (merged with `aud`). Default: a verified email. */
|
|
39
|
+
idTokenPayload?: GoogleAuthMockIdTokenPayload;
|
|
40
|
+
/** Project id `getProjectId()` returns. Default `"mock-project"`. */
|
|
41
|
+
projectId?: string;
|
|
42
|
+
}
|
|
43
|
+
|
|
44
|
+
export interface GoogleAuthMock {
|
|
45
|
+
/** `new GoogleAuth(options)` — every instance shares `getClient`, `getAccessToken`, `request`. */
|
|
46
|
+
GoogleAuth: Mock<
|
|
47
|
+
(options?: Record<string, unknown>) => {
|
|
48
|
+
getAccessToken: GoogleAuthMock["getAccessToken"];
|
|
49
|
+
getClient: GoogleAuthMock["getClient"];
|
|
50
|
+
getProjectId: GoogleAuthMock["getProjectId"];
|
|
51
|
+
request: GoogleAuthMock["request"];
|
|
52
|
+
}
|
|
53
|
+
>;
|
|
54
|
+
/** `new OAuth2Client(...)` — every instance shares `verifyIdToken`. */
|
|
55
|
+
OAuth2Client: Mock<(...args: unknown[]) => {verifyIdToken: GoogleAuthMock["verifyIdToken"]}>;
|
|
56
|
+
client: GoogleAuthMockClient;
|
|
57
|
+
getAccessToken: Mock<() => Promise<{token: string}>>;
|
|
58
|
+
getClient: Mock<() => Promise<GoogleAuthMockClient>>;
|
|
59
|
+
getProjectId: Mock<() => Promise<string>>;
|
|
60
|
+
getRequestHeaders: Mock<() => Promise<Record<string, string>>>;
|
|
61
|
+
/** Authorized request — resolves `{data: {}, status: 200}`. Override per test. */
|
|
62
|
+
request: Mock<(options: GoogleAuthMockRequestOptions) => Promise<GoogleAuthMockResponse>>;
|
|
63
|
+
/** Accepts any token; the ticket's payload is `idTokenPayload` plus the requested audience. */
|
|
64
|
+
verifyIdToken: Mock<
|
|
65
|
+
(options: {audience?: string | string[]; idToken: string}) => Promise<GoogleAuthMockTicket>
|
|
66
|
+
>;
|
|
67
|
+
/** Clears calls and overrides. */
|
|
68
|
+
reset: () => void;
|
|
69
|
+
}
|
|
70
|
+
|
|
71
|
+
/**
|
|
72
|
+
* Registers `mock.module("google-auth-library", ...)` covering what Terreno calls: `GoogleAuth`
|
|
73
|
+
* (`getClient().request` / `getAccessToken`, used by Vertex model discovery and the Cloud Tasks
|
|
74
|
+
* REST client) and `OAuth2Client.verifyIdToken` (Cloud Tasks OIDC execute auth).
|
|
75
|
+
*/
|
|
76
|
+
export const registerGoogleAuthMock = (
|
|
77
|
+
options: RegisterGoogleAuthMockOptions = {}
|
|
78
|
+
): GoogleAuthMock => {
|
|
79
|
+
const accessToken = options.accessToken ?? "mock-access-token";
|
|
80
|
+
const idTokenPayload = options.idTokenPayload ?? {
|
|
81
|
+
email: "mock-service-account@mock-project.iam.gserviceaccount.com",
|
|
82
|
+
email_verified: true,
|
|
83
|
+
};
|
|
84
|
+
const projectId = options.projectId ?? "mock-project";
|
|
85
|
+
const group = createMockGroup();
|
|
86
|
+
|
|
87
|
+
const getAccessToken = group.fn(async (): Promise<{token: string}> => ({token: accessToken}));
|
|
88
|
+
const getRequestHeaders = group.fn(
|
|
89
|
+
async (): Promise<Record<string, string>> => ({Authorization: `Bearer ${accessToken}`})
|
|
90
|
+
);
|
|
91
|
+
const request = group.fn(
|
|
92
|
+
async (_options: GoogleAuthMockRequestOptions): Promise<GoogleAuthMockResponse> => ({
|
|
93
|
+
data: {},
|
|
94
|
+
headers: {},
|
|
95
|
+
status: 200,
|
|
96
|
+
})
|
|
97
|
+
);
|
|
98
|
+
const client: GoogleAuthMockClient = {getAccessToken, getRequestHeaders, request};
|
|
99
|
+
const getClient = group.fn(async (): Promise<GoogleAuthMockClient> => client);
|
|
100
|
+
const getProjectId = group.fn(async (): Promise<string> => projectId);
|
|
101
|
+
const GoogleAuth = group.fn((_options?: Record<string, unknown>) => ({
|
|
102
|
+
getAccessToken,
|
|
103
|
+
getClient,
|
|
104
|
+
getProjectId,
|
|
105
|
+
request,
|
|
106
|
+
}));
|
|
107
|
+
|
|
108
|
+
const verifyIdToken = group.fn(
|
|
109
|
+
async ({
|
|
110
|
+
audience,
|
|
111
|
+
}: {
|
|
112
|
+
audience?: string | string[];
|
|
113
|
+
idToken: string;
|
|
114
|
+
}): Promise<GoogleAuthMockTicket> => {
|
|
115
|
+
const aud = Array.isArray(audience) ? audience[0] : audience;
|
|
116
|
+
return {getPayload: (): GoogleAuthMockIdTokenPayload => ({...idTokenPayload, aud})};
|
|
117
|
+
}
|
|
118
|
+
);
|
|
119
|
+
const OAuth2Client = group.fn((..._args: unknown[]) => ({verifyIdToken}));
|
|
120
|
+
|
|
121
|
+
const moduleExports = {GoogleAuth, OAuth2Client};
|
|
122
|
+
mock.module("google-auth-library", () => ({...moduleExports, default: moduleExports}));
|
|
123
|
+
|
|
124
|
+
return {
|
|
125
|
+
client,
|
|
126
|
+
GoogleAuth,
|
|
127
|
+
getAccessToken,
|
|
128
|
+
getClient,
|
|
129
|
+
getProjectId,
|
|
130
|
+
getRequestHeaders,
|
|
131
|
+
OAuth2Client,
|
|
132
|
+
request,
|
|
133
|
+
reset: group.reset,
|
|
134
|
+
verifyIdToken,
|
|
135
|
+
};
|
|
136
|
+
};
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
import {type Mock, mock} from "bun:test";
|
|
2
|
+
|
|
3
|
+
// Any function: `never[]` parameters accept every signature, and the type is assignable to
|
|
4
|
+
// Bun's `Mock<T>` constraint.
|
|
5
|
+
type AnyFunction = (...args: never[]) => unknown;
|
|
6
|
+
|
|
7
|
+
export interface MockGroup {
|
|
8
|
+
/** Creates a mock whose default behavior `reset()` restores. */
|
|
9
|
+
fn: <T extends AnyFunction>(implementation: T) => Mock<T>;
|
|
10
|
+
/** Clears every mock's calls and restores its default implementation. */
|
|
11
|
+
reset: () => void;
|
|
12
|
+
}
|
|
13
|
+
|
|
14
|
+
/** Tracks a set of SDK mocks so one call resets calls, one-off overrides, and implementations. */
|
|
15
|
+
export const createMockGroup = (): MockGroup => {
|
|
16
|
+
const entries: Array<{implementation: AnyFunction; mockFn: Mock<AnyFunction>}> = [];
|
|
17
|
+
|
|
18
|
+
const fn = <T extends AnyFunction>(implementation: T): Mock<T> => {
|
|
19
|
+
const mockFn = mock(implementation);
|
|
20
|
+
entries.push({implementation, mockFn: mockFn as unknown as Mock<AnyFunction>});
|
|
21
|
+
return mockFn;
|
|
22
|
+
};
|
|
23
|
+
|
|
24
|
+
const reset = (): void => {
|
|
25
|
+
for (const {implementation, mockFn} of entries) {
|
|
26
|
+
mockFn.mockReset();
|
|
27
|
+
mockFn.mockImplementation(implementation);
|
|
28
|
+
}
|
|
29
|
+
};
|
|
30
|
+
|
|
31
|
+
return {fn, reset};
|
|
32
|
+
};
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
import {type Mock, mock} from "bun:test";
|
|
2
|
+
|
|
3
|
+
import {createMockGroup} from "./mockGroup";
|
|
4
|
+
|
|
5
|
+
type NotifierMock = Mock<(...args: unknown[]) => Promise<void>>;
|
|
6
|
+
|
|
7
|
+
export interface TerrenoNotifierMocks {
|
|
8
|
+
sendToGoogleChat: NotifierMock;
|
|
9
|
+
sendToSlack: NotifierMock;
|
|
10
|
+
sendToZoom: NotifierMock;
|
|
11
|
+
/** Clears calls and overrides; the notifiers resolve `undefined` again. */
|
|
12
|
+
reset: () => void;
|
|
13
|
+
}
|
|
14
|
+
|
|
15
|
+
/**
|
|
16
|
+
* Re-registers `@terreno/api` with its real exports plus mocked `sendToSlack`, `sendToZoom`,
|
|
17
|
+
* and `sendToGoogleChat`, so app code that imports them sends nothing and tests can assert the
|
|
18
|
+
* calls. Call it in a preload before app modules load.
|
|
19
|
+
*
|
|
20
|
+
* Only importers of the `@terreno/api` package see the mocks: code inside `@terreno/api` that
|
|
21
|
+
* calls the notifiers through its own modules (for example `wrapScript`) still uses the real
|
|
22
|
+
* ones, which no-op without webhook env vars. `@terreno/api` must be installed; it is loaded at
|
|
23
|
+
* runtime because `@terreno/api` depends on this package.
|
|
24
|
+
*/
|
|
25
|
+
export const registerTerrenoNotifierMocks = (): TerrenoNotifierMocks => {
|
|
26
|
+
const group = createMockGroup();
|
|
27
|
+
const sendToGoogleChat = group.fn(async (..._args: unknown[]): Promise<void> => {});
|
|
28
|
+
const sendToSlack = group.fn(async (..._args: unknown[]): Promise<void> => {});
|
|
29
|
+
const sendToZoom = group.fn(async (..._args: unknown[]): Promise<void> => {});
|
|
30
|
+
|
|
31
|
+
// Runtime-only so @terreno/test compiles without @terreno/api (which depends on it).
|
|
32
|
+
const actual = require("@terreno/api") as Record<string, unknown>;
|
|
33
|
+
mock.module("@terreno/api", () => ({...actual, sendToGoogleChat, sendToSlack, sendToZoom}));
|
|
34
|
+
|
|
35
|
+
return {reset: group.reset, sendToGoogleChat, sendToSlack, sendToZoom};
|
|
36
|
+
};
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
import {type Mock, mock} from "bun:test";
|
|
2
|
+
|
|
3
|
+
import {createMockGroup} from "./mockGroup";
|
|
4
|
+
|
|
5
|
+
export interface SendGridMockResponse {
|
|
6
|
+
body: unknown;
|
|
7
|
+
headers: Record<string, string>;
|
|
8
|
+
statusCode: number;
|
|
9
|
+
}
|
|
10
|
+
|
|
11
|
+
export type SendGridMockSendResult = [SendGridMockResponse, Record<string, never>];
|
|
12
|
+
|
|
13
|
+
export interface SendGridMock {
|
|
14
|
+
/** `send(data)` resolves `[{statusCode: 202, headers: {"x-message-id": ...}}, {}]`. */
|
|
15
|
+
send: Mock<(data: unknown, isMultiple?: boolean) => Promise<SendGridMockSendResult>>;
|
|
16
|
+
setApiKey: Mock<(apiKey: string) => void>;
|
|
17
|
+
/** Every message passed to `send`, flattened when `send` gets an array. */
|
|
18
|
+
getSentMessages: () => Record<string, unknown>[];
|
|
19
|
+
/** Clears calls, overrides, and the message-id counter. */
|
|
20
|
+
reset: () => void;
|
|
21
|
+
}
|
|
22
|
+
|
|
23
|
+
/**
|
|
24
|
+
* Registers `mock.module("@sendgrid/mail", ...)` with both the CommonJS shape (`send` /
|
|
25
|
+
* `setApiKey` on the module, what `require` returns) and a `default` export (what
|
|
26
|
+
* `import sgMail from "@sendgrid/mail"` reads). `@sendgrid/mail` does not need to be installed.
|
|
27
|
+
*/
|
|
28
|
+
export const registerSendGridMock = (): SendGridMock => {
|
|
29
|
+
const group = createMockGroup();
|
|
30
|
+
let messageCount = 0;
|
|
31
|
+
|
|
32
|
+
const send = group.fn(async (_data: unknown, _isMultiple?: boolean) => {
|
|
33
|
+
messageCount += 1;
|
|
34
|
+
const result: SendGridMockSendResult = [
|
|
35
|
+
{body: "", headers: {"x-message-id": `mock-sendgrid-${messageCount}`}, statusCode: 202},
|
|
36
|
+
{},
|
|
37
|
+
];
|
|
38
|
+
return result;
|
|
39
|
+
});
|
|
40
|
+
const setApiKey = group.fn((_apiKey: string): void => {});
|
|
41
|
+
|
|
42
|
+
const getSentMessages = (): Record<string, unknown>[] =>
|
|
43
|
+
send.mock.calls.flatMap(([data]) => (Array.isArray(data) ? data : [data])) as Record<
|
|
44
|
+
string,
|
|
45
|
+
unknown
|
|
46
|
+
>[];
|
|
47
|
+
|
|
48
|
+
const reset = (): void => {
|
|
49
|
+
group.reset();
|
|
50
|
+
messageCount = 0;
|
|
51
|
+
};
|
|
52
|
+
|
|
53
|
+
const mailService = {send, setApiKey};
|
|
54
|
+
mock.module("@sendgrid/mail", () => ({...mailService, default: mailService}));
|
|
55
|
+
|
|
56
|
+
return {getSentMessages, reset, send, setApiKey};
|
|
57
|
+
};
|