[Enterprise Search] Set up basic scaffolding for Cypress tests in Kibana #108560

cee-chen · 2021-08-13T16:10:10Z

Fix

This PR is #108309 but with Typescript configuration causing issues in master fixed 🤞

The issue appears to be that I hadn't specified an outDir config to a gitignored folder such as target, and as such compiled .d.ts and .map files were getting generated and then tracked in git on every yarn kbn bootstrap.

I've run yarn kbn clean and yarn kbn bootstrap locally and all my type checks are still working for me, but I'll also be asking other fellow Enterprise Search devs to test this locally and confirm that their bootstrap on this branch works without unexpected issues.

Original PR description

Summary

Why is Enterprise Search choosing to write E2E tests in Cypress over Kibana's FTR?

We already have an existing suite of Cypress E2E tests/commands/helpers for our standalone UI, meaning we don't have to rewrite as much / start from scratch
We have a slight preference to Cypress's API/command syntax
These tests will not be run on the normal per-PR kibana CI jobs - instead, they'll likely be run either nightly or possibly only when specific files change, so we're deviating away from Kibana norms in any case

What this PR does:

Creates 3 separate Cypress test suites (App Search, Workplace Search, and Enterprise Search Overview) for each separate plugin so that products can be tested individually as well as have their own custom settings
Sets up Cypress for Kibana's Typescript configurations (see https://docs.cypress.io/guides/tooling/typescript-support) now that our Cypress tests are no longer .js files
Sets up very basic "Hello world" tests for App Search and Workplace Search
Sets up tests locally only: you should be able to run sh cypress.sh run overview from the enterprise_search plugin folder and have all tests pass

What this PR does NOT do:

Create a fully-fleshed out set of happy path E2E tests for either AS or WS
Hook this up to any kind of CI - I did some brief exploration with Kibana FTR config, but @tarekziade or @brianseeders will be able to determine better how whether to continue using the functional test server vs. dockerized images
Figure out how to handle basic vs platinum tests (I'm hoping we can use Kibana's license management UI to upgrade vs downgrade from trials)

As always, I recommend following along by commit.

Screencaps

cypress.mp4

QA

Setup
- Have Elasticsearch running localhost:9200
- Have Enterprise Search running on localhost:3002
- In kibana.dev.yml, set csp.strict: false and csp.warnLegacyBrowsers: false
- Have Kibana running with --no-base-path and on localhost:5601
Confirm sh cypress.sh run overview passes
Confirm sh cypress.sh run as passes
Confirm sh cypress.sh run ws passes

Checklist

Documentation was added for features that require explanation or tutorials

- Required if we're going to have several different Cypress suites (one for each plugin/product essentially) in order for global cy.() commands and it()/describe() to register as expected @see https://docs.cypress.io/guides/tooling/typescript-support#Clashing-types-with-Jest

NOTE: Unlike ent-search, shared/ will *not* have its own set of tests - rather, shared/cypress is a resource/set of helpers for other test suites to extend/import/etc.

- For happy path testing, we _likely_ shouldn't need more than these tests going forward - If we ever want to add an error connecting test however, this is likely where it should go (or alternatively, use Kibana's FTR with Enterprise Search host set but not spun up)

- placeholder/hello world test only

…nst Kibana functional server

scottybollinger

LGTM 🎉

byronhulcher

Code is good and I couldn't get the files to appear again.

cee-chen · 2021-08-16T15:57:09Z

@elasticmachine merge upstream

cee-chen · 2021-08-16T16:04:08Z

Heya @spalger! I was recommended by @mistic to wait for your review before merging. Would super appreciate your OK/or if you see any issues with the current tsconfig setup for Cypress. Thanks!

spalger

LGTM, but one nit

src/dev/typescript/projects.ts

kibanamachine · 2021-08-16T20:30:44Z

💚 Build Succeeded

Metrics [docs]

✅ unchanged

History

💚 Build #145779 succeeded 8b66f26
💔 Build #145294 failed 3f5685b27033d13848b0751cdea4da348aa2b080
💚 Build #145304 succeeded a9d8447

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

…ana (elastic#108560) * Set up tsconfigs - Required if we're going to have several different Cypress suites (one for each plugin/product essentially) in order for global cy.() commands and it()/describe() to register as expected @see https://docs.cypress.io/guides/tooling/typescript-support#Clashing-types-with-Jest * Set up shared commands and routes NOTE: Unlike ent-search, shared/ will *not* have its own set of tests - rather, shared/cypress is a resource/set of helpers for other test suites to extend/import/etc. * Create basic Enterprise Search Overview E2E tests - For happy path testing, we _likely_ shouldn't need more than these tests going forward - If we ever want to add an error connecting test however, this is likely where it should go (or alternatively, use Kibana's FTR with Enterprise Search host set but not spun up) * Set up App Search Cypress test scaffolding - placeholder/hello world test only * Set up Workplace Search Cypress test scaffolding - placeholder/hello world test only * Add helper script and update README * Add config setup & documentation for potentially running Cypress against Kibana functional server * PR feedback: Fix typescript project names Co-authored-by: Kibana Machine <[email protected]>

kibanamachine · 2021-08-16T20:33:19Z

💚 Backport successful

Status	Branch	Result
✅	7.x

This backport PR will be merged automatically after passing CI.

…ana (#108560) (#108779) * Set up tsconfigs - Required if we're going to have several different Cypress suites (one for each plugin/product essentially) in order for global cy.() commands and it()/describe() to register as expected @see https://docs.cypress.io/guides/tooling/typescript-support#Clashing-types-with-Jest * Set up shared commands and routes NOTE: Unlike ent-search, shared/ will *not* have its own set of tests - rather, shared/cypress is a resource/set of helpers for other test suites to extend/import/etc. * Create basic Enterprise Search Overview E2E tests - For happy path testing, we _likely_ shouldn't need more than these tests going forward - If we ever want to add an error connecting test however, this is likely where it should go (or alternatively, use Kibana's FTR with Enterprise Search host set but not spun up) * Set up App Search Cypress test scaffolding - placeholder/hello world test only * Set up Workplace Search Cypress test scaffolding - placeholder/hello world test only * Add helper script and update README * Add config setup & documentation for potentially running Cypress against Kibana functional server * PR feedback: Fix typescript project names Co-authored-by: Kibana Machine <[email protected]> Co-authored-by: Constance <[email protected]>

cee-chen added 2 commits August 13, 2021 09:03

Set up shared commands and routes

ab0097f

NOTE: Unlike ent-search, shared/ will *not* have its own set of tests - rather, shared/cypress is a resource/set of helpers for other test suites to extend/import/etc.

cee-chen added release_note:skip Skip the PR/issue when compiling release notes auto-backport Deprecated - use backport:version if exact versions are needed v7.15.0 labels Aug 13, 2021

cee-chen marked this pull request as ready for review August 13, 2021 16:20

cee-chen requested review from a team August 13, 2021 16:20

cee-chen requested a review from a team as a code owner August 13, 2021 16:20

cee-chen requested a review from a team August 13, 2021 16:20

cee-chen mentioned this pull request Aug 13, 2021

[Enterprise Search] Set up basic scaffolding for Cypress tests in Kibana #108309

Merged

4 tasks

cee-chen added 5 commits August 13, 2021 09:30

Set up App Search Cypress test scaffolding

766e485

- placeholder/hello world test only

Set up Workplace Search Cypress test scaffolding

1f96e29

- placeholder/hello world test only

Add helper script and update README

8f0ad08

Add config setup & documentation for potentially running Cypress agai…

a9d8447

…nst Kibana functional server

cee-chen force-pushed the ent-search-cypress branch from 3f5685b to a9d8447 Compare August 13, 2021 16:30

scottybollinger approved these changes Aug 13, 2021

View reviewed changes

byronhulcher approved these changes Aug 13, 2021

View reviewed changes

Merge branch 'master' into ent-search-cypress

8b66f26

cee-chen requested a review from spalger August 16, 2021 15:58

spalger approved these changes Aug 16, 2021

View reviewed changes

src/dev/typescript/projects.ts Outdated Show resolved Hide resolved

PR feedback: Fix typescript project names

a6a4594

cee-chen enabled auto-merge (squash) August 16, 2021 18:13

cee-chen merged commit 3ffd6af into elastic:master Aug 16, 2021

cee-chen deleted the ent-search-cypress branch August 16, 2021 20:30

kibanamachine mentioned this pull request Aug 16, 2021

[7.x] [Enterprise Search] Set up basic scaffolding for Cypress tests in Kibana (#108560) #108779

Merged

cee-chen mentioned this pull request Aug 16, 2021

[Enterprise Search] Set up cypress-axe tests #108465

Merged

4 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Enterprise Search] Set up basic scaffolding for Cypress tests in Kibana #108560

[Enterprise Search] Set up basic scaffolding for Cypress tests in Kibana #108560

cee-chen commented Aug 13, 2021 •

edited

Loading

scottybollinger left a comment

byronhulcher left a comment

cee-chen commented Aug 16, 2021

cee-chen commented Aug 16, 2021

spalger left a comment

kibanamachine commented Aug 16, 2021

kibanamachine commented Aug 16, 2021

[Enterprise Search] Set up basic scaffolding for Cypress tests in Kibana #108560

[Enterprise Search] Set up basic scaffolding for Cypress tests in Kibana #108560

Conversation

cee-chen commented Aug 13, 2021 • edited Loading

Fix

Original PR description

Summary

Screencaps

QA

Checklist

scottybollinger left a comment

Choose a reason for hiding this comment

byronhulcher left a comment

Choose a reason for hiding this comment

cee-chen commented Aug 16, 2021

cee-chen commented Aug 16, 2021

spalger left a comment

Choose a reason for hiding this comment

kibanamachine commented Aug 16, 2021

💚 Build Succeeded

Metrics [docs]

History

kibanamachine commented Aug 16, 2021

💚 Backport successful

cee-chen commented Aug 13, 2021 •

edited

Loading