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

[Fleet] Add fetch package unit tests (#134768)

Browse source 
* move getPathParts tests into describe block

* move archive tests to archive folder

* fetchFindLatestPackageOrUndefined tests

* fetchFindLatestPackageOrThrow test

* move generic tests to util fn

* fix spelling
This commit is contained in:
Mark Hopkin 2022-06-20 20:37:55 +01:00 • committed by GitHub
parent 52f15aa46d
commit 7cbd0bf15d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 185 additions and 72 deletions
Download patch file Download diff file Expand all files Collapse all files

89
x-pack/plugins/fleet/server/services/epm/archive/index.test.ts Normal file
View file

@ -0,0 +1,89 @@
/*
* 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 type { AssetParts } from '../../../types';
import { getBufferExtractor, getPathParts, untarBuffer, unzipBuffer } from '.';
describe('getPathParts', () => {
const testPaths = [
{
path: 'foo-1.1.0/service/type/file.yml',
assetParts: {
dataset: undefined,
file: 'file.yml',
path: 'foo-1.1.0/service/type/file.yml',
pkgkey: 'foo-1.1.0',
service: 'service',
type: 'type',
},
},
{
path: 'iptables-1.0.4/kibana/visualization/683402b0-1f29-11e9-8ec4-cf5d91a864b3-ecs.json',
assetParts: {
dataset: undefined,
file: '683402b0-1f29-11e9-8ec4-cf5d91a864b3-ecs.json',
path: 'iptables-1.0.4/kibana/visualization/683402b0-1f29-11e9-8ec4-cf5d91a864b3-ecs.json',
pkgkey: 'iptables-1.0.4',
service: 'kibana',
type: 'visualization',
},
},
{
path: 'coredns-1.0.1/data_stream/stats/fields/coredns.stats.yml',
assetParts: {
dataset: 'stats',
file: 'coredns.stats.yml',
path: 'coredns-1.0.1/data_stream/stats/fields/coredns.stats.yml',
pkgkey: 'coredns-1.0.1',
service: '',
type: 'fields',
},
},
];
test('testPathParts', () => {
for (const value of testPaths) {
expect(getPathParts(value.path)).toStrictEqual(value.assetParts as AssetParts);
}
});
});
describe('getBufferExtractor called with { archivePath }', () => {
it('returns unzipBuffer if `archivePath` ends in .zip', () => {
const extractor = getBufferExtractor({ archivePath: '.zip' });
expect(extractor).toBe(unzipBuffer);
});
it('returns untarBuffer if `archivePath` ends in .gz', () => {
const extractor = getBufferExtractor({ archivePath: '.gz' });
expect(extractor).toBe(untarBuffer);
const extractor2 = getBufferExtractor({ archivePath: '.tar.gz' });
expect(extractor2).toBe(untarBuffer);
});
it('returns `undefined` if `archivePath` ends in anything else', () => {
const extractor = getBufferExtractor({ archivePath: '.xyz' });
expect(extractor).toEqual(undefined);
});
});
describe('getBufferExtractor called with { contentType }', () => {
it('returns unzipBuffer if `contentType` is `application/zip`', () => {
const extractor = getBufferExtractor({ contentType: 'application/zip' });
expect(extractor).toBe(unzipBuffer);
});
it('returns untarBuffer if `contentType` is `application/gzip`', () => {
const extractor = getBufferExtractor({ contentType: 'application/gzip' });
expect(extractor).toBe(untarBuffer);
});
it('returns `undefined` if `contentType` ends in anything else', () => {
const extractor = getBufferExtractor({ contentType: '.xyz' });
expect(extractor).toEqual(undefined);
});
});

168
x-pack/plugins/fleet/server/services/epm/registry/index.test.ts
View file

@ -5,54 +5,35 @@
* 2.0.
*/
import type { AssetParts } from '../../../types';
import { getBufferExtractor, getPathParts, untarBuffer, unzipBuffer } from '../archive';
import { loggingSystemMock } from '@kbn/core-logging-server-mocks';
import { splitPkgKey } from '.';
import { PackageNotFoundError } from '../../../errors';
const testPaths = [
{
path: 'foo-1.1.0/service/type/file.yml',
assetParts: {
dataset: undefined,
file: 'file.yml',
path: 'foo-1.1.0/service/type/file.yml',
pkgkey: 'foo-1.1.0',
service: 'service',
type: 'type',
},
import { splitPkgKey, fetchFindLatestPackageOrUndefined, fetchFindLatestPackageOrThrow } from '.';
const mockLoggerFactory = loggingSystemMock.create();
const mockLogger = mockLoggerFactory.get('mock logger');
const mockGetBundledPackageByName = jest.fn();
const mockFetchUrl = jest.fn();
jest.mock('../..', () => ({
appContextService: {
getLogger: () => mockLogger,
getKibanaBranch: () => 'main',
getKibanaVersion: () => '99.0.0',
getConfig: () => ({}),
},
{
path: 'iptables-1.0.4/kibana/visualization/683402b0-1f29-11e9-8ec4-cf5d91a864b3-ecs.json',
assetParts: {
dataset: undefined,
file: '683402b0-1f29-11e9-8ec4-cf5d91a864b3-ecs.json',
path: 'iptables-1.0.4/kibana/visualization/683402b0-1f29-11e9-8ec4-cf5d91a864b3-ecs.json',
pkgkey: 'iptables-1.0.4',
service: 'kibana',
type: 'visualization',
},
},
{
path: 'coredns-1.0.1/data_stream/stats/fields/coredns.stats.yml',
assetParts: {
dataset: 'stats',
file: 'coredns.stats.yml',
path: 'coredns-1.0.1/data_stream/stats/fields/coredns.stats.yml',
pkgkey: 'coredns-1.0.1',
service: '',
type: 'fields',
},
},
];
}));
test('testPathParts', () => {
for (const value of testPaths) {
expect(getPathParts(value.path)).toStrictEqual(value.assetParts as AssetParts);
}
});
jest.mock('./requests', () => ({
fetchUrl: (url: string) => mockFetchUrl(url),
}));
describe('splitPkgKey tests', () => {
jest.mock('../packages/bundled_packages', () => ({
getBundledPackageByName: (name: string) => mockGetBundledPackageByName(name),
}));
describe('splitPkgKey', () => {
it('throws an error if there is nothing before the delimiter', () => {
expect(() => {
splitPkgKey('-0.0.1-dev1');
@ -84,38 +65,81 @@ describe('splitPkgKey tests', () => {
});
});
describe('getBufferExtractor called with { archivePath }', () => {
it('returns unzipBuffer if `archivePath` ends in .zip', () => {
const extractor = getBufferExtractor({ archivePath: '.zip' });
expect(extractor).toBe(unzipBuffer);
describe('fetch package', () => {
afterEach(() => {
mockFetchUrl.mockReset();
mockGetBundledPackageByName.mockReset();
});
it('returns untarBuffer if `archivePath` ends in .gz', () => {
const extractor = getBufferExtractor({ archivePath: '.gz' });
expect(extractor).toBe(untarBuffer);
const extractor2 = getBufferExtractor({ archivePath: '.tar.gz' });
expect(extractor2).toBe(untarBuffer);
type FetchFn = typeof fetchFindLatestPackageOrThrow | typeof fetchFindLatestPackageOrUndefined;
const performGenericFetchTests = (fetchMethodToTest: FetchFn) => {
it('Should return registry package if bundled package is older version', async () => {
const bundledPackage = { name: 'testpkg', version: '1.0.0' };
const registryPackage = { name: 'testpkg', version: '1.0.1' };
mockFetchUrl.mockResolvedValue(JSON.stringify([registryPackage]));
mockGetBundledPackageByName.mockResolvedValue(bundledPackage);
const result = await fetchMethodToTest('testpkg');
expect(result).toEqual(registryPackage);
});
it('Should return bundled package if bundled package is newer version', async () => {
const bundledPackage = { name: 'testpkg', version: '1.0.1' };
const registryPackage = { name: 'testpkg', version: '1.0.0' };
mockFetchUrl.mockResolvedValue(JSON.stringify([registryPackage]));
mockGetBundledPackageByName.mockResolvedValue(bundledPackage);
const result = await fetchMethodToTest('testpkg');
expect(result).toEqual(bundledPackage);
});
it('Should return bundled package if there is no registry package', async () => {
const bundledPackage = { name: 'testpkg', version: '1.0.1' };
mockFetchUrl.mockResolvedValue(JSON.stringify([]));
mockGetBundledPackageByName.mockResolvedValue(bundledPackage);
const result = await fetchMethodToTest('testpkg');
expect(result).toEqual(bundledPackage);
});
it('Should fall back to bundled package if there is an error getting from the registry', async () => {
const bundledPackage = { name: 'testpkg', version: '1.0.1' };
mockFetchUrl.mockRejectedValue(new Error('Registry error'));
mockGetBundledPackageByName.mockResolvedValue(bundledPackage);
const result = await fetchMethodToTest('testpkg');
expect(result).toEqual(bundledPackage);
});
};
describe('fetchFindLatestPackageOrUndefined', () => {
performGenericFetchTests(fetchFindLatestPackageOrUndefined);
it('Should return undefined if there is a registry error and no bundled package', async () => {
const bundledPackage = null;
mockFetchUrl.mockRejectedValue(new Error('Registry error'));
mockGetBundledPackageByName.mockResolvedValue(bundledPackage);
const result = await fetchFindLatestPackageOrUndefined('testpkg');
expect(result).toEqual(undefined);
});
});
it('returns `undefined` if `archivePath` ends in anything else', () => {
const extractor = getBufferExtractor({ archivePath: '.xyz' });
expect(extractor).toEqual(undefined);
});
});
describe('getBufferExtractor called with { contentType }', () => {
it('returns unzipBuffer if `contentType` is `application/zip`', () => {
const extractor = getBufferExtractor({ contentType: 'application/zip' });
expect(extractor).toBe(unzipBuffer);
});
it('returns untarBuffer if `contentType` is `application/gzip`', () => {
const extractor = getBufferExtractor({ contentType: 'application/gzip' });
expect(extractor).toBe(untarBuffer);
});
it('returns `undefined` if `contentType` ends in anything else', () => {
const extractor = getBufferExtractor({ contentType: '.xyz' });
expect(extractor).toEqual(undefined);
describe('fetchFindLatestPackageOrThrow', () => {
performGenericFetchTests(fetchFindLatestPackageOrThrow);
it('Should return undefined if there is a registry error and no bundled package', async () => {
const bundledPackage = null;
mockFetchUrl.mockRejectedValue(new Error('Registry error'));
mockGetBundledPackageByName.mockResolvedValue(bundledPackage);
expect(() => fetchFindLatestPackageOrThrow('testpkg')).rejects.toBeInstanceOf(
PackageNotFoundError
);
});
});
});