github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-23 17:28:26 -04:00
Code Issues Projects Releases Packages Wiki Activity

[8.0] [Snapshot & Restore] Fix repository types on Cloud (#125656) (#125835)

Browse source 
* [Snapshot & Restore] Fix repository types on Cloud (#125656)

* [Snapshot & Restore] Fix repository types on Cloud

* [Snapshot & Restore] Move repo types tests into `on-prem` describe block

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
(cherry picked from commit 37dfc22c1a)

# Conflicts:
#	x-pack/plugins/snapshot_restore/server/routes/api/repositories.test.ts
#	x-pack/plugins/snapshot_restore/server/routes/api/repositories.ts

* [Snapshot & Restore] Fix linting issue
This commit is contained in:
Yulia Čech 2022-02-17 13:26:34 +01:00 • committed by GitHub
parent 6cd8f8374e
commit ade71c13ca
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 82 additions and 26 deletions
Download patch file Download diff file Expand all files Collapse all files

9
x-pack/plugins/snapshot_restore/common/constants.ts
View file

@ -35,12 +35,15 @@ export enum REPOSITORY_TYPES {
}
// Deliberately do not include `source` as a default repository since we treat it as a flag
export const DEFAULT_REPOSITORY_TYPES: RepositoryType[] = [
export const ON_PREM_REPOSITORY_TYPES: RepositoryType[] = [
REPOSITORY_TYPES.fs,
REPOSITORY_TYPES.url,
];
export const MODULE_REPOSITORY_TYPES: RepositoryType[] = [
REPOSITORY_TYPES.azure,
REPOSITORY_TYPES.gcs,
REPOSITORY_TYPES.s3,
REPOSITORY_TYPES.fs,
REPOSITORY_TYPES.url,
];
export const PLUGIN_REPOSITORY_TYPES: RepositoryType[] = [REPOSITORY_TYPES.hdfs];

51
x-pack/plugins/snapshot_restore/server/routes/api/repositories.test.ts
View file

@ -5,7 +5,11 @@
* 2.0.
*/
import { DEFAULT_REPOSITORY_TYPES, REPOSITORY_PLUGINS_MAP } from '../../../common/constants';
import {
ON_PREM_REPOSITORY_TYPES,
MODULE_REPOSITORY_TYPES,
REPOSITORY_PLUGINS_MAP,
} from '../../../common';
import { addBasePath } from '../helpers';
import { registerRepositoriesRoutes } from './repositories';
import { RouterMock, routeDependencies, RequestMock } from '../../test/helpers';
@ -253,32 +257,39 @@ describe('[Snapshot and Restore API Routes] Repositories', () => {
path: addBasePath('repository_types'),
};
it('should return default types if no repository plugins returned from ES', async () => {
catPluginsFn.mockResolvedValue({ body: {} });
// TODO add Cloud specific tests for repo types
describe('on prem', () => {
it('returns module types and on-prem types if no repository plugins returned from ES', async () => {
catPluginsFn.mockResolvedValue({ body: {} });
const expectedResponse = [...DEFAULT_REPOSITORY_TYPES];
await expect(router.runRequest(mockRequest)).resolves.toEqual({ body: expectedResponse });
});
const expectedResponse = [...MODULE_REPOSITORY_TYPES, ...ON_PREM_REPOSITORY_TYPES];
await expect(router.runRequest(mockRequest)).resolves.toEqual({ body: expectedResponse });
});
it('should return default types with any repository plugins returned from ES', async () => {
const pluginNames = Object.keys(REPOSITORY_PLUGINS_MAP);
const pluginTypes = Object.entries(REPOSITORY_PLUGINS_MAP).map(([key, value]) => value);
it('returns module types and on-prem types with any repository plugins returned from ES', async () => {
const pluginNames = Object.keys(REPOSITORY_PLUGINS_MAP);
const pluginTypes = Object.entries(REPOSITORY_PLUGINS_MAP).map(([key, value]) => value);
const mockEsResponse = [...pluginNames.map((key) => ({ component: key }))];
catPluginsFn.mockResolvedValue({ body: mockEsResponse });
const mockEsResponse = [...pluginNames.map((key) => ({ component: key }))];
catPluginsFn.mockResolvedValue({ body: mockEsResponse });
const expectedResponse = [...DEFAULT_REPOSITORY_TYPES, ...pluginTypes];
await expect(router.runRequest(mockRequest)).resolves.toEqual({ body: expectedResponse });
});
const expectedResponse = [
...MODULE_REPOSITORY_TYPES,
...ON_PREM_REPOSITORY_TYPES,
...pluginTypes,
];
await expect(router.runRequest(mockRequest)).resolves.toEqual({ body: expectedResponse });
});
it('should not return non-repository plugins returned from ES', async () => {
const pluginNames = ['foo-plugin', 'bar-plugin'];
const mockEsResponse = [...pluginNames.map((key) => ({ component: key }))];
catPluginsFn.mockResolvedValue({ body: mockEsResponse });
it(`doesn't return non-repository plugins returned from ES`, async () => {
const pluginNames = ['foo-plugin', 'bar-plugin'];
const mockEsResponse = [...pluginNames.map((key) => ({ component: key }))];
catPluginsFn.mockResolvedValue({ body: mockEsResponse });
const expectedResponse = [...DEFAULT_REPOSITORY_TYPES];
const expectedResponse = [...MODULE_REPOSITORY_TYPES, ...ON_PREM_REPOSITORY_TYPES];
await expect(router.runRequest(mockRequest)).resolves.toEqual({ body: expectedResponse });
await expect(router.runRequest(mockRequest)).resolves.toEqual({ body: expectedResponse });
});
});
it('should throw if ES error', async () => {

13
x-pack/plugins/snapshot_restore/server/routes/api/repositories.ts
View file

@ -11,7 +11,11 @@ import type {
SnapshotRepositorySettings,
} from '@elastic/elasticsearch/lib/api/typesWithBodyKey';
import { DEFAULT_REPOSITORY_TYPES, REPOSITORY_PLUGINS_MAP } from '../../../common/constants';
import {
ON_PREM_REPOSITORY_TYPES,
REPOSITORY_PLUGINS_MAP,
MODULE_REPOSITORY_TYPES,
} from '../../../common';
import { Repository, RepositoryType } from '../../../common/types';
import { RouteDependencies } from '../../types';
import { addBasePath } from '../helpers';
@ -158,8 +162,11 @@ export function registerRepositoriesRoutes({
{ path: addBasePath('repository_types'), validate: false },
license.guardApiRoute(async (ctx, req, res) => {
const { client: clusterClient } = ctx.core.elasticsearch;
// In ECE/ESS, do not enable the default types
const types: RepositoryType[] = isCloudEnabled ? [] : [...DEFAULT_REPOSITORY_TYPES];
// module repo types are available everywhere out of the box
// on-prem repo types are not available on Cloud
const types: RepositoryType[] = isCloudEnabled
? [...MODULE_REPOSITORY_TYPES]
: [...MODULE_REPOSITORY_TYPES, ...ON_PREM_REPOSITORY_TYPES];
try {
// Call with internal user so that the requesting user does not need `monitoring` cluster

1
x-pack/test/api_integration/apis/management/snapshot_restore/index.ts
View file

@ -11,5 +11,6 @@ export default function ({ loadTestFile }: FtrProviderContext) {
describe('Snapshot and Restore', () => {
loadTestFile(require.resolve('./policies'));
loadTestFile(require.resolve('./snapshots'));
loadTestFile(require.resolve('./repositories'));
});
}

34
x-pack/test/api_integration/apis/management/snapshot_restore/repositories.ts Normal file
View file

@ -0,0 +1,34 @@
/*
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
* or more contributor license agreements. Licensed under the Elastic License
* 2.0; you may not use this file except in compliance with the Elastic License
* 2.0.
*/
import expect from '@kbn/expect';
import { FtrProviderContext } from '../../../ftr_provider_context';
const API_BASE_PATH = '/api/snapshot_restore';
export default function ({ getService }: FtrProviderContext) {
const supertest = getService('supertest');
const deployment = getService('deployment');
describe('snapshot repositories', function () {
describe('repository types', () => {
it('returns a list of default repository types', async () => {
const { body } = await supertest.get(`${API_BASE_PATH}/repository_types`).expect(200);
const isCloud = await deployment.isCloud();
if (isCloud) {
// on Cloud there are only module repo types
expect(body).to.eql(['azure', 'gcs', 's3']);
} else {
// on prem there are module repo types and file system and url repo types
expect(body).to.eql(['azure', 'gcs', 's3', 'fs', 'url']);
}
});
});
});
}