github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-24 09:48:58 -04:00
Code Issues Projects Releases Packages Wiki Activity

Fix deprecations API tests (#215484)

Browse source 
## Summary

Addresses https://github.com/elastic/kibana/issues/215216

---------

Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
This commit is contained in:
Gerard Soldevila 2025-03-24 17:49:42 +01:00 • committed by GitHub
parent 2c98a2244f
commit 18a138bb2c
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 46 additions and 43 deletions
Download patch file Download diff file Expand all files Collapse all files

89
x-pack/test/upgrade_assistant_integration/upgrade_assistant/api_deprecations.ts
View file

@ -8,13 +8,13 @@
import expect from '@kbn/expect';
import { expect as expectExpect } from 'expect';
import { setTimeout as setTimeoutAsync } from 'timers/promises';
import { UsageCountersSavedObject } from '@kbn/usage-collection-plugin/server';
import _ from 'lodash';
import type { UsageCountersSavedObjectAttributes } from '@kbn/usage-collection-plugin/server';
import type {
ApiDeprecationDetails,
DomainDeprecationDetails,
} from '@kbn/core-deprecations-common';
import { FtrProviderContext } from '../../common/ftr_provider_context';
import { USAGE_COUNTERS_SAVED_OBJECT_INDEX } from '@kbn/core-saved-objects-server';
import type { FtrProviderContext } from '../../common/ftr_provider_context';
const getApiDeprecations = (allDeprecations: DomainDeprecationDetails[]) => {
return (
@ -34,12 +34,24 @@ export default function ({ getService }: FtrProviderContext) {
const retry = getService('retry');
const es = getService('es');
// FLAKY: https://github.com/elastic/kibana/issues/215216
describe.skip('Kibana API Deprecations', function () {
const getDeprecationsCounters = async () => {
const should = ['total', 'resolved', 'marked_as_resolved'].map((type) => ({
match: { 'usage-counter.counterType': `deprecated_api_call:${type}` },
}));
const { hits } = await es.search<{ 'usage-counter': UsageCountersSavedObjectAttributes }>({
index: USAGE_COUNTERS_SAVED_OBJECT_INDEX,
query: { bool: { should } },
});
return hits.hits.map((hit) => hit._source!['usage-counter']);
};
describe('Kibana API Deprecations', function () {
// bail on first error in this suite since cases sequentially depend on each other
this.bail(true);
before(async () => {
before(async function cleanupSoIndices() {
// await kibanaServer.savedObjects.cleanStandardList();
await esArchiver.emptyKibanaIndex();
});
@ -152,21 +164,29 @@ export default function ({ getService }: FtrProviderContext) {
});
it('keeps track of all counters via saved objects and core usage counters', async () => {
const should = ['total', 'resolved', 'marked_as_resolved'].map((type) => ({
match: { 'usage-counter.counterType': `deprecated_api_call:${type}` },
}));
const { hits } = await es.search<{ 'usage-counter': UsageCountersSavedObject }>({
index: '.kibana_usage_counters',
query: { bool: { should } },
// sleep a little until the usage counter is synced into ES
await setTimeoutAsync(3000);
await retry.tryForTime(15 * 1000, async () => {
const actualUsageCounters = await getDeprecationsCounters();
// Kibana might introduce more deprecation counters behind the scenes, so we must make sure our expected ones are there
expectedSuiteUsageCounters.forEach((expectedCounter) => {
expectExpect(actualUsageCounters).toContainEqual(expectedCounter);
});
});
expect(hits.hits.length).to.equal(4);
const counters = hits.hits.map((hit) => hit._source!['usage-counter']).sort();
expectExpect(_.sortBy(counters, 'counterType')).toEqual(expectedSuiteUsageCounters);
});
it('Does not increment internal origin calls', async () => {
const expectedTestUsageCounters = [
...expectedSuiteUsageCounters,
{
domainId: 'core',
counterName: '2023-10-31|get|/api/routing_example/d/versioned_route',
counterType: 'deprecated_api_call:total',
source: 'server',
count: 1,
},
];
await supertest
.get(`/api/routing_example/d/removed_route?elasticInternalOrigin=true`)
.expect(200);
@ -178,31 +198,13 @@ export default function ({ getService }: FtrProviderContext) {
// sleep a little until the usage counter is synced into ES
await setTimeoutAsync(3000);
await retry.tryForTime(15 * 1000, async () => {
const should = ['total', 'resolved', 'marked_as_resolved'].map((type) => ({
match: { 'usage-counter.counterType': `deprecated_api_call:${type}` },
}));
const { hits } = await es.search<{ 'usage-counter': UsageCountersSavedObject }>({
index: '.kibana_usage_counters',
query: { bool: { should } },
const actualUsageCounters = await getDeprecationsCounters();
expectedTestUsageCounters.forEach((expectedCounter) => {
expectExpect(actualUsageCounters).toContainEqual(expectedCounter);
});
expect(hits.hits.length).to.equal(5);
const counters = hits.hits.map((hit) => hit._source!['usage-counter']).sort();
expectExpect(_.sortBy(counters, 'counterType')).toEqual(
[
...expectedSuiteUsageCounters,
{
domainId: 'core',
counterName: '2023-10-31|get|/api/routing_example/d/versioned_route',
counterType: 'deprecated_api_call:total',
source: 'server',
count: 1,
},
].sort()
);
});
});
it('Readiness status excludes critical deprecations based on Kibana API usage', async () => {
/** Throw in another critical deprecation... */
await supertest.get(`/api/routing_example/d/removed_route`).expect(200);
@ -223,14 +225,15 @@ export default function ({ getService }: FtrProviderContext) {
// There are critical deprecations for Kibana API usage, but we do not
// surface them in readiness status
expect(body.readyForUpgrade).to.be(false);
expect(body.details?.length > 0).to.be(true);
expect(/Kibana/gi.test(body.details)).to.be(false);
expectExpect(body).toEqual({
readyForUpgrade: true,
details: 'All deprecation warnings have been resolved.',
});
});
});
}
const expectedSuiteUsageCounters = [
const expectedSuiteUsageCounters: UsageCountersSavedObjectAttributes[] = [
{
domainId: 'core',
counterName: 'unversioned|get|/api/routing_example/d/removed_route',