-
Notifications
You must be signed in to change notification settings - Fork 8.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[Obs AI Assistant] Serverless API integration tests (#192219)
Tests for serverless - copies over and modifies all tests from stateful to work in serverless. ~~deployment agnostic tests do not yet support enterprise license for stateful, so are tests don't yet qualify as being deployment agnostic~~. Given how difficult it is to see differences from the stateful tests, I've added PR comments where I've changed something that might be of interest. - changes to `createObservabilityAIAssistantApiClient` to use supertest without basic auth and accept headers for serverless and use roles - removes creating persisted users when tests start and [use roles](https://github.com/elastic/kibana/blob/main/x-pack/test_serverless/README.md#roles-based-testing) within tests. its not possible to create custom users with the serverless test framework at the moment. See #192711 Skipped tests - knowledge base tests #192886 - any test suite that uses the LLM proxy has been skipped on MKI #192751 - all tests that depend on the config.modelId skipped in MKI #192757 TODO: - [x] move over remaining tests - [x] test in MKI environment before merging - [x] create issues for skipped tests - [ ] this will not run on MKI (after merging) unless we ping the appex-qa team to add it to the pipeline. this is due to creating a separate config. ask appex-qa team to add our config. Followup / related issues to be tracked in a newly created issue: - [ ] #192757 - [ ] #192886 - [ ] #192751 - [ ] #192701 - [ ] #192497 - [ ] #192711 - [ ] #192718 - [ ] serverless functional tests - [ ] inquire with ml-ui-team to have the ability to delete system indices which we do after uninstalling tiny elser with .ml indices
- Loading branch information
Showing
24 changed files
with
3,014 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Validating CODEOWNERS rules …
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
77 changes: 77 additions & 0 deletions
77
...erless/api_integration/test_suites/observability/ai_assistant/common/action_connectors.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,77 @@ | ||
| /* | ||
| * 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 { ToolingLog } from '@kbn/tooling-log'; | ||
| import type { | ||
| InternalRequestHeader, | ||
| RoleCredentials, | ||
| SupertestWithoutAuthProviderType, | ||
| } from '../../../../../shared/services'; | ||
|
|
||
| export async function deleteActionConnector({ | ||
| supertest, | ||
| connectorId, | ||
| log, | ||
| roleAuthc, | ||
| internalReqHeader, | ||
| }: { | ||
| supertest: SupertestWithoutAuthProviderType; | ||
| connectorId: string; | ||
| log: ToolingLog; | ||
| roleAuthc: RoleCredentials; | ||
| internalReqHeader: InternalRequestHeader; | ||
| }) { | ||
| try { | ||
| await supertest | ||
| .delete(`/api/actions/connector/${connectorId}`) | ||
| .set(roleAuthc.apiKeyHeader) | ||
| .set(internalReqHeader) | ||
| .expect(204); | ||
| } catch (e) { | ||
| log.error(`Failed to delete action connector with id ${connectorId} due to: ${e}`); | ||
| throw e; | ||
| } | ||
| } | ||
|
|
||
| export async function createProxyActionConnector({ | ||
| log, | ||
| supertest, | ||
| port, | ||
| roleAuthc, | ||
| internalReqHeader, | ||
| }: { | ||
| log: ToolingLog; | ||
| supertest: SupertestWithoutAuthProviderType; | ||
| port: number; | ||
| roleAuthc: RoleCredentials; | ||
| internalReqHeader: InternalRequestHeader; | ||
| }) { | ||
| try { | ||
| const res = await supertest | ||
| .post('/api/actions/connector') | ||
| .set(roleAuthc.apiKeyHeader) | ||
| .set(internalReqHeader) | ||
| .send({ | ||
| name: 'OpenAI Proxy', | ||
| connector_type_id: '.gen-ai', | ||
| config: { | ||
| apiProvider: 'OpenAI', | ||
| apiUrl: `http://localhost:${port}`, | ||
| }, | ||
| secrets: { | ||
| apiKey: 'my-api-key', | ||
| }, | ||
| }) | ||
| .expect(200); | ||
|
|
||
| const connectorId = res.body.id as string; | ||
| return connectorId; | ||
| } catch (e) { | ||
| log.error(`Failed to create action connector due to: ${e}`); | ||
| throw e; | ||
| } | ||
| } |
18 changes: 18 additions & 0 deletions
18
...ess/api_integration/test_suites/observability/ai_assistant/common/ftr_provider_context.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| /* | ||
| * 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 { GenericFtrProviderContext } from '@kbn/test'; | ||
| import { InheritedServices, InheritedFtrProviderContext } from '../../../../services'; | ||
| import { ObservabilityAIAssistantApiClient } from './observability_ai_assistant_api_client'; | ||
|
|
||
| export type ObservabilityAIAssistantServices = InheritedServices & { | ||
| observabilityAIAssistantAPIClient: ( | ||
| context: InheritedFtrProviderContext | ||
| ) => Promise<ObservabilityAIAssistantApiClient>; | ||
| }; | ||
|
|
||
| export type FtrProviderContext = GenericFtrProviderContext<ObservabilityAIAssistantServices, {}>; |
191 changes: 191 additions & 0 deletions
191
...on/test_suites/observability/ai_assistant/common/observability_ai_assistant_api_client.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,191 @@ | ||
| /* | ||
| * 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 { | ||
| APIReturnType, | ||
| ObservabilityAIAssistantAPIClientRequestParamsOf, | ||
| ObservabilityAIAssistantAPIEndpoint, | ||
| } from '@kbn/observability-ai-assistant-plugin/public'; | ||
| import { formatRequest } from '@kbn/server-route-repository'; | ||
| import supertest from 'supertest'; | ||
| import { Subtract } from 'utility-types'; | ||
| import { format } from 'url'; | ||
| import { Config } from '@kbn/test'; | ||
| import { InheritedFtrProviderContext } from '../../../../services'; | ||
| import type { InternalRequestHeader, RoleCredentials } from '../../../../../shared/services'; | ||
|
|
||
| export function getObservabilityAIAssistantApiClient({ | ||
| svlSharedConfig, | ||
| }: { | ||
| svlSharedConfig: Config; | ||
| }) { | ||
| const kibanaServer = svlSharedConfig.get('servers.kibana'); | ||
| const cAuthorities = svlSharedConfig.get('servers.kibana.certificateAuthorities'); | ||
|
|
||
| const url = format({ | ||
| ...kibanaServer, | ||
| auth: false, // don't use auth in serverless | ||
| }); | ||
|
|
||
| return createObservabilityAIAssistantApiClient(supertest.agent(url, { ca: cAuthorities })); | ||
| } | ||
|
|
||
| type ObservabilityAIAssistantApiClientKey = 'slsUser'; | ||
| export type ObservabilityAIAssistantApiClient = Record< | ||
| ObservabilityAIAssistantApiClientKey, | ||
| Awaited<ReturnType<typeof getObservabilityAIAssistantApiClient>> | ||
| >; | ||
| export function createObservabilityAIAssistantApiClient(st: supertest.Agent) { | ||
| return <TEndpoint extends ObservabilityAIAssistantAPIEndpoint>( | ||
| options: { | ||
| type?: 'form-data'; | ||
| endpoint: TEndpoint; | ||
| roleAuthc: RoleCredentials; | ||
| internalReqHeader: InternalRequestHeader; | ||
| } & ObservabilityAIAssistantAPIClientRequestParamsOf<TEndpoint> & { | ||
| params?: { query?: { _inspect?: boolean } }; | ||
| } | ||
| ): SupertestReturnType<TEndpoint> => { | ||
| const { endpoint, type, roleAuthc, internalReqHeader } = options; | ||
|
|
||
| const params = 'params' in options ? (options.params as Record<string, any>) : {}; | ||
|
|
||
| const { method, pathname, version } = formatRequest(endpoint, params.path); | ||
| const url = format({ pathname, query: params?.query }); | ||
|
|
||
| const headers: Record<string, string> = { ...internalReqHeader, ...roleAuthc.apiKeyHeader }; | ||
|
|
||
| if (version) { | ||
| headers['Elastic-Api-Version'] = version; | ||
| } | ||
|
|
||
| let res: supertest.Test; | ||
| if (type === 'form-data') { | ||
| const fields: Array<[string, any]> = Object.entries(params.body); | ||
| const formDataRequest = st[method](url) | ||
| .set(headers) | ||
| .set('Content-type', 'multipart/form-data'); | ||
| for (const field of fields) { | ||
| void formDataRequest.field(field[0], field[1]); | ||
| } | ||
|
|
||
| res = formDataRequest; | ||
| } else if (params.body) { | ||
| res = st[method](url).send(params.body).set(headers); | ||
| } else { | ||
| res = st[method](url).set(headers); | ||
| } | ||
|
|
||
| return res as unknown as SupertestReturnType<TEndpoint>; | ||
| }; | ||
| } | ||
|
|
||
| export type ObservabilityAIAssistantAPIClient = ReturnType< | ||
| typeof createObservabilityAIAssistantApiClient | ||
| >; | ||
|
|
||
| type WithoutPromise<T extends Promise<any>> = Subtract<T, Promise<any>>; | ||
|
|
||
| // this is a little intense, but without it, method overrides are lost | ||
| // e.g., { | ||
| // end(one:string) | ||
| // end(one:string, two:string) | ||
| // } | ||
| // would lose the first signature. This keeps up to eight signatures. | ||
| type OverloadedParameters<T> = T extends { | ||
| (...args: infer A1): any; | ||
| (...args: infer A2): any; | ||
| (...args: infer A3): any; | ||
| (...args: infer A4): any; | ||
| (...args: infer A5): any; | ||
| (...args: infer A6): any; | ||
| (...args: infer A7): any; | ||
| (...args: infer A8): any; | ||
| } | ||
| ? A1 | A2 | A3 | A4 | A5 | A6 | A7 | A8 | ||
| : T extends { | ||
| (...args: infer A1): any; | ||
| (...args: infer A2): any; | ||
| (...args: infer A3): any; | ||
| (...args: infer A4): any; | ||
| (...args: infer A5): any; | ||
| (...args: infer A6): any; | ||
| (...args: infer A7): any; | ||
| } | ||
| ? A1 | A2 | A3 | A4 | A5 | A6 | A7 | ||
| : T extends { | ||
| (...args: infer A1): any; | ||
| (...args: infer A2): any; | ||
| (...args: infer A3): any; | ||
| (...args: infer A4): any; | ||
| (...args: infer A5): any; | ||
| (...args: infer A6): any; | ||
| } | ||
| ? A1 | A2 | A3 | A4 | A5 | A6 | ||
| : T extends { | ||
| (...args: infer A1): any; | ||
| (...args: infer A2): any; | ||
| (...args: infer A3): any; | ||
| (...args: infer A4): any; | ||
| (...args: infer A5): any; | ||
| } | ||
| ? A1 | A2 | A3 | A4 | A5 | ||
| : T extends { | ||
| (...args: infer A1): any; | ||
| (...args: infer A2): any; | ||
| (...args: infer A3): any; | ||
| (...args: infer A4): any; | ||
| } | ||
| ? A1 | A2 | A3 | A4 | ||
| : T extends { | ||
| (...args: infer A1): any; | ||
| (...args: infer A2): any; | ||
| (...args: infer A3): any; | ||
| } | ||
| ? A1 | A2 | A3 | ||
| : T extends { | ||
| (...args: infer A1): any; | ||
| (...args: infer A2): any; | ||
| } | ||
| ? A1 | A2 | ||
| : T extends (...args: infer A) => any | ||
| ? A | ||
| : any; | ||
|
|
||
| type OverrideReturnType<T extends (...args: any[]) => any, TNextReturnType> = ( | ||
| ...args: OverloadedParameters<T> | ||
| ) => WithoutPromise<ReturnType<T>> & TNextReturnType; | ||
|
|
||
| type OverwriteThisMethods<T extends Record<string, any>, TNextReturnType> = TNextReturnType & { | ||
| [key in keyof T]: T[key] extends (...args: infer TArgs) => infer TReturnType | ||
| ? TReturnType extends Promise<any> | ||
| ? OverrideReturnType<T[key], TNextReturnType> | ||
| : (...args: TArgs) => TReturnType | ||
| : T[key]; | ||
| }; | ||
|
|
||
| export type SupertestReturnType<TEndpoint extends ObservabilityAIAssistantAPIEndpoint> = | ||
| OverwriteThisMethods< | ||
| WithoutPromise<supertest.Test>, | ||
| Promise<{ | ||
| text: string; | ||
| status: number; | ||
| body: APIReturnType<TEndpoint>; | ||
| }> | ||
| >; | ||
|
|
||
| export async function getObservabilityAIAssistantApiClientService({ | ||
| getService, | ||
| }: InheritedFtrProviderContext): Promise<ObservabilityAIAssistantApiClient> { | ||
| const svlSharedConfig = getService('config'); | ||
| // defaults to elastic_admin user when used without auth | ||
| return { | ||
| slsUser: await getObservabilityAIAssistantApiClient({ | ||
| svlSharedConfig, | ||
| }), | ||
| }; | ||
| } |
Oops, something went wrong.