x-pack/solutions/observability/plugins/observability_onboarding/README.md
This plugin provides an onboarding framework for observability solutions: Logs and APM.
To run the stateful onboarding flows start Kibana as usual.
To run the serverless onboarding flows start Kibana using yarn serverless-oblt.
Kibana primarily uses Jest for unit testing. Each plugin or package defines a jest.config.js that extends a preset provided by the @kbn/test package. The following command runs all onboarding unit tests:
yarn jest --config x-pack/solutions/observability/plugins/observability_onboarding/jest.config.js
You can also run a specific test by passing the filepath as an argument, e.g.:
yarn jest --config x-pack/solutions/observability/plugins/observability_onboarding/jest.config.js x-pack/solutions/observability/plugins/observability_onboarding/public/application/header/custom_header.test.tsx
The deployment-agnostic API tests are located in x-pack/solutions/observability/test/api_integration_deployment_agnostic/apis/onboarding.
# start server
node scripts/functional_tests_server --config x-pack/solutions/observability/test/api_integration_deployment_agnostic/configs/stateful/oblt.stateful.config.ts
# run tests
node scripts/functional_test_runner --config x-pack/solutions/observability/test/api_integration_deployment_agnostic/configs/stateful/oblt.stateful.config.ts --include ./x-pack/solutions/observability/test/api_integration_deployment_agnostic/apis/onboarding/index.ts
# start server
node scripts/functional_tests_server --config x-pack/solutions/observability/test/api_integration_deployment_agnostic/configs/serverless/oblt.serverless.config.ts
# run tests
node scripts/functional_test_runner --config x-pack/solutions/observability/test/api_integration_deployment_agnostic/configs/serverless/oblt.serverless.config.ts --include ./x-pack/solutions/observability/test/api_integration_deployment_agnostic/apis/onboarding/index.ts
# start server
yarn test:ftr:server --config ./x-pack/solutions/observability/test/serverless/functional/configs/config.ts
# run tests
yarn test:ftr:runner --config ./x-pack/solutions/observability/test/serverless/functional/configs/config.ts --include ./x-pack/solutions/observability/test/serverless/functional/test_suites/onboarding/index.ts
yarn test:ftr:runner --config ./x-pack/solutions/observability/test/serverless/functional/configs/config.ts --include ./x-pack/solutions/observability/test/serverless/functional/test_suites/onboarding/index.ts/$1