Skip to content

Commit e86ca4b

Browse files
[8.x] Migrate onboarding Cypress tests to Scout (#205482) (#211388)
# Backport This will backport the following commits from `main` to `8.x`: - [Migrate onboarding Cypress tests to Scout (#205482)](#205482) <!--- Backport version: 9.6.4 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sorenlouv/backport) <!--BACKPORT [{"author":{"name":"Mykola Harmash","email":"[email protected]"},"sourceCommit":{"committedDate":"2025-01-10T08:44:29Z","message":"Migrate onboarding Cypress tests to Scout (#205482)\n\nThis change converts Cypress tests for the custom logs flow into\r\nPlaywright using [the Scout\r\nwrapper](https://github.com/elastic/kibana/tree/main/packages/kbn-scout).\r\n\r\n> [!NOTE]\r\n> As Scout package is still being developed, the PR pipeline configured\r\nto runs Playwright tests only when code in certain plugins have been\r\nchanged and not on every PR.\r\n\r\n### How to run tests locally\r\n\r\nStart the Scout server\r\n```bash\r\nnode scripts/scout.js start-server --stateful\r\n```\r\n\r\nIn a separate terminal run the tests\r\n```bash\r\nnpx playwright test --config x-pack/solutions/observability/plugins/observability_onboarding/ui_tests/playwright.config.ts\r\n```\r\n\r\nPlaywright runs browsers in a headless mode by default, user `--headed`\r\noption if needed","sha":"6ed214a69f75a69305cbb06515bdb5e9e75ac3ae","branchLabelMapping":{"^v9.0.0$":"main","^v8.18.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","backport:skip","v9.0.0","ci:project-deploy-observability"],"title":"Migrate onboarding Cypress tests to Scout","number":205482,"url":"https://github.com/elastic/kibana/pull/205482","mergeCommit":{"message":"Migrate onboarding Cypress tests to Scout (#205482)\n\nThis change converts Cypress tests for the custom logs flow into\r\nPlaywright using [the Scout\r\nwrapper](https://github.com/elastic/kibana/tree/main/packages/kbn-scout).\r\n\r\n> [!NOTE]\r\n> As Scout package is still being developed, the PR pipeline configured\r\nto runs Playwright tests only when code in certain plugins have been\r\nchanged and not on every PR.\r\n\r\n### How to run tests locally\r\n\r\nStart the Scout server\r\n```bash\r\nnode scripts/scout.js start-server --stateful\r\n```\r\n\r\nIn a separate terminal run the tests\r\n```bash\r\nnpx playwright test --config x-pack/solutions/observability/plugins/observability_onboarding/ui_tests/playwright.config.ts\r\n```\r\n\r\nPlaywright runs browsers in a headless mode by default, user `--headed`\r\noption if needed","sha":"6ed214a69f75a69305cbb06515bdb5e9e75ac3ae"}},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","branchLabelMappingKey":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/205482","number":205482,"mergeCommit":{"message":"Migrate onboarding Cypress tests to Scout (#205482)\n\nThis change converts Cypress tests for the custom logs flow into\r\nPlaywright using [the Scout\r\nwrapper](https://github.com/elastic/kibana/tree/main/packages/kbn-scout).\r\n\r\n> [!NOTE]\r\n> As Scout package is still being developed, the PR pipeline configured\r\nto runs Playwright tests only when code in certain plugins have been\r\nchanged and not on every PR.\r\n\r\n### How to run tests locally\r\n\r\nStart the Scout server\r\n```bash\r\nnode scripts/scout.js start-server --stateful\r\n```\r\n\r\nIn a separate terminal run the tests\r\n```bash\r\nnpx playwright test --config x-pack/solutions/observability/plugins/observability_onboarding/ui_tests/playwright.config.ts\r\n```\r\n\r\nPlaywright runs browsers in a headless mode by default, user `--headed`\r\noption if needed","sha":"6ed214a69f75a69305cbb06515bdb5e9e75ac3ae"}}]}] BACKPORT--> --------- Co-authored-by: kibanamachine <[email protected]>
1 parent 7f23710 commit e86ca4b

File tree

34 files changed

+1270
-2036
lines changed

34 files changed

+1270
-2036
lines changed

.buildkite/pipelines/pull_request/scout_ui_tests.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ steps:
22
- command: .buildkite/scripts/steps/functional/scout_ui_tests.sh
33
label: 'Scout UI Tests'
44
agents:
5-
machineType: n2-standard-4
5+
machineType: n2-standard-8
66
preemptible: true
77
depends_on:
88
- build
@@ -11,7 +11,7 @@ steps:
1111
- linting
1212
- linting_with_types
1313
- check_types
14-
timeout_in_minutes: 30
14+
timeout_in_minutes: 60
1515
retry:
1616
automatic:
1717
- exit_status: '-1'

.buildkite/scripts/pipelines/pull_request/pipeline.ts

Lines changed: 1 addition & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -109,18 +109,6 @@ const getPipeline = (filename: string, removeSteps = true) => {
109109
pipeline.push(getPipeline('.buildkite/pipelines/pull_request/inventory_cypress.yml'));
110110
}
111111

112-
if (
113-
(await doAnyChangesMatch([
114-
/^x-pack\/solutions\/observability\/plugins\/observability_onboarding/,
115-
/^x-pack\/platform\/plugins\/shared\/fleet/,
116-
])) ||
117-
GITHUB_PR_LABELS.includes('ci:all-cypress-suites')
118-
) {
119-
pipeline.push(
120-
getPipeline('.buildkite/pipelines/pull_request/observability_onboarding_cypress.yml')
121-
);
122-
}
123-
124112
if (
125113
(await doAnyChangesMatch([/^x-pack\/solutions\/observability\/plugins\/profiling/])) ||
126114
GITHUB_PR_LABELS.includes('ci:all-cypress-suites')
@@ -405,6 +393,7 @@ const getPipeline = (filename: string, removeSteps = true) => {
405393
if (
406394
(await doAnyChangesMatch([
407395
/^x-pack\/platform\/plugins\/private\/discover_enhanced\/ui_tests/,
396+
/^x-pack\/solutions\/observability\/plugins\/observability_onboarding/,
408397
/^packages\/kbn-scout/,
409398
])) ||
410399
GITHUB_PR_LABELS.includes('ci:scout-ui-tests')

.buildkite/scripts/steps/functional/scout_ui_tests.sh

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,4 +31,10 @@ for run_mode in "--stateful"; do
3131
run_tests "Maps" "x-pack/platform/plugins/shared/maps/ui_tests/playwright.config.ts" "$run_mode"
3232
done
3333

34-
exit $EXIT_CODE
34+
# Observability Onboarding
35+
for run_mode in "--stateful"; do
36+
run_tests "Observability Onboarding" "x-pack/solutions/observability/plugins/observability_onboarding/ui_tests/playwright.config.ts" "$run_mode"
37+
done
38+
39+
40+
exit $EXIT_CODE

.github/CODEOWNERS

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -684,7 +684,6 @@ x-pack/solutions/observability/packages/alerting_test_data @elastic/obs-ux-manag
684684
x-pack/test/cases_api_integration/common/plugins/observability @elastic/response-ops
685685
x-pack/solutions/observability/packages/get_padded_alert_time_range_util @elastic/obs-ux-management-team
686686
x-pack/solutions/observability/plugins/observability_logs_explorer @elastic/obs-ux-logs-team
687-
x-pack/solutions/observability/plugins/observability_onboarding/e2e @elastic/obs-ux-logs-team
688687
x-pack/solutions/observability/plugins/observability_onboarding @elastic/obs-ux-logs-team
689688
x-pack/solutions/observability/plugins/observability @elastic/obs-ux-management-team
690689
x-pack/solutions/observability/plugins/observability_shared @elastic/observability-ui

package.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1473,7 +1473,6 @@
14731473
"@kbn/manifest": "link:packages/kbn-manifest",
14741474
"@kbn/mock-idp-plugin": "link:packages/kbn-mock-idp-plugin",
14751475
"@kbn/mock-idp-utils": "link:packages/kbn-mock-idp-utils",
1476-
"@kbn/observability-onboarding-e2e": "link:x-pack/solutions/observability/plugins/observability_onboarding/e2e",
14771476
"@kbn/observability-synthetics-test-data": "link:x-pack/solutions/observability/packages/synthetics_test_data",
14781477
"@kbn/openapi-bundler": "link:packages/kbn-openapi-bundler",
14791478
"@kbn/openapi-generator": "link:packages/kbn-openapi-generator",

tsconfig.base.json

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1362,8 +1362,6 @@
13621362
"@kbn/observability-get-padded-alert-time-range-util/*": ["x-pack/solutions/observability/packages/get_padded_alert_time_range_util/*"],
13631363
"@kbn/observability-logs-explorer-plugin": ["x-pack/solutions/observability/plugins/observability_logs_explorer"],
13641364
"@kbn/observability-logs-explorer-plugin/*": ["x-pack/solutions/observability/plugins/observability_logs_explorer/*"],
1365-
"@kbn/observability-onboarding-e2e": ["x-pack/solutions/observability/plugins/observability_onboarding/e2e"],
1366-
"@kbn/observability-onboarding-e2e/*": ["x-pack/solutions/observability/plugins/observability_onboarding/e2e/*"],
13671365
"@kbn/observability-onboarding-plugin": ["x-pack/solutions/observability/plugins/observability_onboarding"],
13681366
"@kbn/observability-onboarding-plugin/*": ["x-pack/solutions/observability/plugins/observability_onboarding/*"],
13691367
"@kbn/observability-plugin": ["x-pack/solutions/observability/plugins/observability"],

x-pack/solutions/observability/plugins/observability_onboarding/e2e/README.md

Lines changed: 0 additions & 51 deletions
This file was deleted.

x-pack/solutions/observability/plugins/observability_onboarding/e2e/cypress.config.ts

Lines changed: 0 additions & 32 deletions
This file was deleted.

x-pack/solutions/observability/plugins/observability_onboarding/e2e/cypress/e2e/home.cy.ts

Lines changed: 0 additions & 36 deletions
This file was deleted.

0 commit comments

Comments
 (0)