2db76660ce
This PR encourages type safe usage of the Alerting framework by replacing the current default Params/State/InstanceState/InstanceContext types (which are `AlertTypeParams`/`AlertTypeState`/etc.) with `never`. This means that code can continue to omit the specific types for these fields, as long as they aren't referenced. Once an alert developer wishes to actually reference the parameters (or state/context), then they have to specify the type. This PR also changed the typing of the `AlertTypeParams` and `AlertTypeState` from `Record<string, any>` to `Record<string, unknown>`, to ensure that where these catch-all types are used they will at least enforce `unknown` rather than `any`. This change broke some usage in both @elastic/kibana-alerting-services plugins, but also other plugins in the Stack/Solutions. I tried to fix these where I could, but some of these require new types and refactoring in other teams' code, which I decided is best done by the team who own and maintain that code - I've added explicit `TODO` comments in all of these places, describing the required fix. This PR also introduced a Generics based typing for the `Alert` type so that the `params` field can be typed as something other than `AlertTypeParams`. |
||
|---|---|---|
| .. | ||
| .storybook | ||
| common | ||
| cypress | ||
| public | ||
| scripts | ||
| server | ||
| .gitattributes | ||
| jest.config.js | ||
| kibana.json | ||
| package.json | ||
| README.md | ||
Security Solution
Welcome to the Kibana Security Solution plugin! This README will go over getting started with development and testing.
Development
Tests
The endpoint specific tests leverage the ingest manager to install the endpoint package. Before the api integration and functional tests are run the ingest manager is initialized. This initialization process includes reaching out to a package registry service to install the endpoint package. The endpoint tests support three different ways to run the tests given the constraint on an available package registry.
- Using Docker
- Running your own local package registry
- Using the default external package registry
These scenarios will be outlined the sections below.
Endpoint API Integration Tests Location
The endpoint api integration tests are located here
Endpoint Functional Tests Location
The endpoint functional tests are located here
Using Docker
To run the tests using the recommended docker image version you must have docker installed. The testing infrastructure
will stand up a docker container using the image defined here
Make sure you're in the Kibana root directory.
Endpoint API Integration Tests
In one terminal, run:
FLEET_PACKAGE_REGISTRY_PORT=12345 yarn test:ftr:server --config x-pack/test/security_solution_endpoint_api_int/config.ts
In another terminal, run:
FLEET_PACKAGE_REGISTRY_PORT=12345 yarn test:ftr:runner --config x-pack/test/security_solution_endpoint_api_int/config.ts
Endpoint Functional Tests
In one terminal, run:
FLEET_PACKAGE_REGISTRY_PORT=12345 yarn test:ftr:server --config x-pack/test/security_solution_endpoint/config.ts
In another terminal, run:
FLEET_PACKAGE_REGISTRY_PORT=12345 yarn test:ftr:runner --config x-pack/test/security_solution_endpoint/config.ts
Running your own package registry
If you are doing endpoint package development it will be useful to run your own package registry to serve the latest package you're building. To do this use the following commands:
Make sure you're in the Kibana root directory.
Endpoint API Integration Tests
In one terminal, run:
PACKAGE_REGISTRY_URL_OVERRIDE=<url to your package registry like http://localhost:8080> yarn test:ftr:server --config x-pack/test/security_solution_endpoint_api_int/config.ts
In another terminal, run:
PACKAGE_REGISTRY_URL_OVERRIDE=<url to your package registry like http://localhost:8080> yarn test:ftr:runner --config x-pack/test/security_solution_endpoint_api_int/config.ts
Endpoint Functional Tests
In one terminal, run:
PACKAGE_REGISTRY_URL_OVERRIDE=<url to your package registry like http://localhost:8080> yarn test:ftr:server --config x-pack/test/security_solution_endpoint/config.ts
In another terminal, run:
PACKAGE_REGISTRY_URL_OVERRIDE=<url to your package registry like http://localhost:8080> yarn test:ftr:runner --config x-pack/test/security_solution_endpoint/config.ts
Using the default public registry
If you don't have docker installed and don't want to run your own registry, you can run the tests using the ingest manager's default public package registry. The actual package registry used is here
Make sure you're in the Kibana root directory.
Endpoint API Integration Tests
In one terminal, run:
yarn test:ftr:server --config x-pack/test/security_solution_endpoint_api_int/config.ts
In another terminal, run:
yarn test:ftr:runner --config x-pack/test/security_solution_endpoint_api_int/config.ts
Endpoint Functional Tests
In one terminal, run:
yarn test:ftr:server --config x-pack/test/security_solution_endpoint/config.ts
In another terminal, run:
yarn test:ftr:runner --config x-pack/test/security_solution_endpoint/config.ts