forked from elastic/kibana
-
Notifications
You must be signed in to change notification settings - Fork 0
/
copy_to_spaces.test.ts
316 lines (285 loc) · 9.59 KB
/
copy_to_spaces.test.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
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
/*
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
* or more contributor license agreements. Licensed under the Elastic License;
* you may not use this file except in compliance with the Elastic License.
*/
import { Readable } from 'stream';
import {
SavedObjectsImportResponse,
SavedObjectsImportOptions,
SavedObjectsExportOptions,
SavedObjectsImportSuccess,
} from 'src/core/server';
import {
coreMock,
httpServerMock,
savedObjectsTypeRegistryMock,
savedObjectsClientMock,
} from 'src/core/server/mocks';
import { copySavedObjectsToSpacesFactory } from './copy_to_spaces';
jest.mock('../../../../../../src/core/server', () => {
return {
...(jest.requireActual('../../../../../../src/core/server') as Record<string, unknown>),
exportSavedObjectsToStream: jest.fn(),
importSavedObjectsFromStream: jest.fn(),
};
});
import {
exportSavedObjectsToStream,
importSavedObjectsFromStream,
} from '../../../../../../src/core/server';
interface SetupOpts {
objects: Array<{ type: string; id: string; attributes: Record<string, any> }>;
exportSavedObjectsToStreamImpl?: (opts: SavedObjectsExportOptions) => Promise<Readable>;
importSavedObjectsFromStreamImpl?: (
opts: SavedObjectsImportOptions
) => Promise<SavedObjectsImportResponse>;
}
const EXPORT_LIMIT = 1000;
const expectStreamToContainObjects = async (
stream: Readable,
expectedObjects: SetupOpts['objects']
) => {
const objectsToResolve: unknown[] = await new Promise((resolve, reject) => {
const objects: SetupOpts['objects'] = [];
stream.on('data', (chunk) => {
objects.push(chunk);
});
stream.on('end', () => resolve(objects));
stream.on('error', (err) => reject(err));
});
// Ensure the Readable stream passed to `resolveImportErrors` contains all of the expected objects.
// Verifies functionality for `readStreamToCompletion` and `createReadableStreamFromArray`
expect(objectsToResolve).toEqual(expectedObjects);
};
describe('copySavedObjectsToSpaces', () => {
const mockExportResults = [
{ type: 'dashboard', id: 'my-dashboard', attributes: {} },
{ type: 'visualization', id: 'my-viz', attributes: {} },
{ type: 'index-pattern', id: 'my-index-pattern', attributes: {} },
{ type: 'globaltype', id: 'my-globaltype', attributes: {} },
];
const setup = (setupOpts: SetupOpts) => {
const coreStart = coreMock.createStart();
const savedObjectsClient = savedObjectsClientMock.create();
const typeRegistry = savedObjectsTypeRegistryMock.create();
coreStart.savedObjects.getScopedClient.mockReturnValue(savedObjectsClient);
coreStart.savedObjects.getTypeRegistry.mockReturnValue(typeRegistry);
typeRegistry.getImportableAndExportableTypes.mockReturnValue([
// don't need to include all types, just need a positive case (agnostic) and a negative case (non-agnostic)
{
name: 'dashboard',
namespaceType: 'single',
hidden: false,
mappings: { properties: {} },
},
{
name: 'globaltype',
namespaceType: 'agnostic',
hidden: false,
mappings: { properties: {} },
},
]);
typeRegistry.isNamespaceAgnostic.mockImplementation((type: string) =>
typeRegistry
.getImportableAndExportableTypes()
.some((t) => t.name === type && t.namespaceType === 'agnostic')
);
(exportSavedObjectsToStream as jest.Mock).mockImplementation(
async (opts: SavedObjectsExportOptions) => {
return (
setupOpts.exportSavedObjectsToStreamImpl?.(opts) ??
new Readable({
objectMode: true,
read() {
setupOpts.objects.forEach((o) => this.push(o));
this.push(null);
},
})
);
}
);
(importSavedObjectsFromStream as jest.Mock).mockImplementation(
async (opts: SavedObjectsImportOptions) => {
const defaultImpl = async () => {
// namespace-agnostic types should be filtered out before import
const filteredObjects = setupOpts.objects.filter(({ type }) => type !== 'globaltype');
await expectStreamToContainObjects(opts.readStream, filteredObjects);
const response: SavedObjectsImportResponse = {
success: true,
successCount: filteredObjects.length,
successResults: [
('Some success(es) occurred!' as unknown) as SavedObjectsImportSuccess,
],
};
return Promise.resolve(response);
};
return setupOpts.importSavedObjectsFromStreamImpl?.(opts) ?? defaultImpl();
}
);
return {
savedObjects: coreStart.savedObjects,
savedObjectsClient,
typeRegistry,
};
};
it('uses the Saved Objects Service to perform an export followed by a series of imports', async () => {
const { savedObjects, savedObjectsClient, typeRegistry } = setup({
objects: mockExportResults,
});
const request = httpServerMock.createKibanaRequest();
const copySavedObjectsToSpaces = copySavedObjectsToSpacesFactory(
savedObjects,
() => EXPORT_LIMIT,
request
);
const namespace = 'sourceSpace';
const objects = [{ type: 'dashboard', id: 'my-dashboard' }];
const result = await copySavedObjectsToSpaces(namespace, ['destination1', 'destination2'], {
includeReferences: true,
overwrite: true,
objects,
createNewCopies: false,
});
expect(result).toMatchInlineSnapshot(`
Object {
"destination1": Object {
"errors": undefined,
"success": true,
"successCount": 3,
"successResults": Array [
"Some success(es) occurred!",
],
},
"destination2": Object {
"errors": undefined,
"success": true,
"successCount": 3,
"successResults": Array [
"Some success(es) occurred!",
],
},
}
`);
expect(exportSavedObjectsToStream).toHaveBeenCalledWith({
excludeExportDetails: true,
exportSizeLimit: EXPORT_LIMIT,
includeReferencesDeep: true,
namespace,
objects,
savedObjectsClient,
});
const importOptions = {
createNewCopies: false,
objectLimit: EXPORT_LIMIT,
overwrite: true,
readStream: expect.any(Readable),
savedObjectsClient,
typeRegistry,
};
expect(importSavedObjectsFromStream).toHaveBeenNthCalledWith(1, {
...importOptions,
namespace: 'destination1',
});
expect(importSavedObjectsFromStream).toHaveBeenNthCalledWith(2, {
...importOptions,
namespace: 'destination2',
});
});
it(`doesn't stop copy if some spaces fail`, async () => {
const { savedObjects } = setup({
objects: mockExportResults,
importSavedObjectsFromStreamImpl: async (opts) => {
if (opts.namespace === 'failure-space') {
throw new Error(`Some error occurred!`);
}
// namespace-agnostic types should be filtered out before import
const filteredObjects = mockExportResults.filter(({ type }) => type !== 'globaltype');
await expectStreamToContainObjects(opts.readStream, filteredObjects);
return Promise.resolve({
success: true,
successCount: filteredObjects.length,
successResults: [('Some success(es) occurred!' as unknown) as SavedObjectsImportSuccess],
});
},
});
const request = httpServerMock.createKibanaRequest();
const copySavedObjectsToSpaces = copySavedObjectsToSpacesFactory(
savedObjects,
() => EXPORT_LIMIT,
request
);
const result = await copySavedObjectsToSpaces(
'sourceSpace',
['failure-space', 'non-existent-space', 'marketing'],
{
includeReferences: true,
overwrite: true,
objects: [{ type: 'dashboard', id: 'my-dashboard' }],
createNewCopies: false,
}
);
expect(result).toMatchInlineSnapshot(`
Object {
"failure-space": Object {
"errors": Array [
[Error: Some error occurred!],
],
"success": false,
"successCount": 0,
},
"marketing": Object {
"errors": undefined,
"success": true,
"successCount": 3,
"successResults": Array [
"Some success(es) occurred!",
],
},
"non-existent-space": Object {
"errors": undefined,
"success": true,
"successCount": 3,
"successResults": Array [
"Some success(es) occurred!",
],
},
}
`);
});
it(`handles stream read errors`, async () => {
const { savedObjects } = setup({
objects: mockExportResults,
exportSavedObjectsToStreamImpl: (_opts) => {
return Promise.resolve(
new Readable({
objectMode: true,
read() {
this.destroy(new Error('Something went wrong while reading this stream'));
},
})
);
},
});
const request = httpServerMock.createKibanaRequest();
const copySavedObjectsToSpaces = copySavedObjectsToSpacesFactory(
savedObjects,
() => EXPORT_LIMIT,
request
);
await expect(
copySavedObjectsToSpaces(
'sourceSpace',
['failure-space', 'non-existent-space', 'marketing'],
{
includeReferences: true,
overwrite: true,
objects: [{ type: 'dashboard', id: 'my-dashboard' }],
createNewCopies: false,
}
)
).rejects.toThrowErrorMatchingInlineSnapshot(
`"Something went wrong while reading this stream"`
);
});
});