extract tenant-dialog helper & improve forecaster list test robustness by kaituo · Pull Request #1823 · opensearch-project/opensearch-dashboards-functional-test

kaituo · 2025-08-07T03:04:31Z

Description

This PR:

Create cy.handleTenantDialog custom command to handle the optional "Select your tenant" pop-up.
Refactor forecaster_list_spec.js and createForecaster helper to leverage the new command, reducing duplicate code.
Introduce explicit waits (cy.contains('Loading OpenSearch Dashboards').should('not.exist'), cy.wait(500)) and additional cy.log statements to handle cases where the home page loads slowly, improving stability and aiding debugging.
Replace thrown error during action-menu retries with a cy.log to enable fallback logic in future enhancements.
Implement fallback logic to use "Stop forecasting" when the "Cancel forecast" modal
does not appear, covering both Initializing and Running forecast states.

Issues Resolved

opensearch-project/anomaly-detection-dashboards-plugin#1072

Check List

Commits are signed per the DCO using --signoff

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

This PR: * Create `cy.handleTenantDialog` custom command to handle the optional **"Select your tenant"** pop-up. * Refactor `forecaster_list_spec.js` and `createForecaster` helper to leverage the new command, reducing duplicate code. * Introduce explicit waits (`cy.contains('Loading OpenSearch Dashboards').should('not.exist')`, `cy.wait(500)`) and additional `cy.log` statements to handle cases where the home page loads slowly, improving stability and aiding debugging. * Replace thrown error during action-menu retries with a `cy.log` to enable fallback logic in future enhancements. * Implement fallback logic to use **"Stop forecasting"** when the **"Cancel forecast"** modal does not appear, covering both *Initializing* and *Running* forecast states. Signed-off-by: Kaituo Li <kaituo@amazon.com>

amitgalitz · 2025-08-07T17:01:39Z

-      }
-    });
+    // tenant dialog can appear at any time, so we need to handle it between each clicks
+    cy.handleTenantDialog();


we can't wait for it to show up and then confirm and it shouldn't show up again?

We can do it. Since I cannot reproduce the issue locally, should I commit the change you suggested, wait for another test run in jenkis, and check if things get fixed?

I am good with either, just seems like it can be more deterministic, locally if it passes with my suggestions thats also a good sign

Discussed with Amit offline, he is ok keep things as it is.

Signed-off-by: Kaituo Li <kaituo@amazon.com>

#1823) * extract tenant-dialog helper & improve forecaster list test robustness This PR: * Create `cy.handleTenantDialog` custom command to handle the optional **"Select your tenant"** pop-up. * Refactor `forecaster_list_spec.js` and `createForecaster` helper to leverage the new command, reducing duplicate code. * Introduce explicit waits (`cy.contains('Loading OpenSearch Dashboards').should('not.exist')`, `cy.wait(500)`) and additional `cy.log` statements to handle cases where the home page loads slowly, improving stability and aiding debugging. * Replace thrown error during action-menu retries with a `cy.log` to enable fallback logic in future enhancements. * Implement fallback logic to use **"Stop forecasting"** when the **"Cancel forecast"** modal does not appear, covering both *Initializing* and *Running* forecast states. Signed-off-by: Kaituo Li <kaituo@amazon.com> * check if deleted detector matches of of known existing one Signed-off-by: Kaituo Li <kaituo@amazon.com> --------- Signed-off-by: Kaituo Li <kaituo@amazon.com> Co-authored-by: yuboluo <yubonluo@amazon.com> (cherry picked from commit 5397438)

#1823) (#1832) * extract tenant-dialog helper & improve forecaster list test robustness This PR: * Create `cy.handleTenantDialog` custom command to handle the optional **"Select your tenant"** pop-up. * Refactor `forecaster_list_spec.js` and `createForecaster` helper to leverage the new command, reducing duplicate code. * Introduce explicit waits (`cy.contains('Loading OpenSearch Dashboards').should('not.exist')`, `cy.wait(500)`) and additional `cy.log` statements to handle cases where the home page loads slowly, improving stability and aiding debugging. * Replace thrown error during action-menu retries with a `cy.log` to enable fallback logic in future enhancements. * Implement fallback logic to use **"Stop forecasting"** when the **"Cancel forecast"** modal does not appear, covering both *Initializing* and *Running* forecast states. * check if deleted detector matches of of known existing one --------- (cherry picked from commit 5397438) Signed-off-by: Kaituo Li <kaituo@amazon.com> Co-authored-by: Kaituo Li <kaituo@amazon.com> Co-authored-by: yuboluo <yubonluo@amazon.com>

opensearch-project#1823) * extract tenant-dialog helper & improve forecaster list test robustness This PR: * Create `cy.handleTenantDialog` custom command to handle the optional **"Select your tenant"** pop-up. * Refactor `forecaster_list_spec.js` and `createForecaster` helper to leverage the new command, reducing duplicate code. * Introduce explicit waits (`cy.contains('Loading OpenSearch Dashboards').should('not.exist')`, `cy.wait(500)`) and additional `cy.log` statements to handle cases where the home page loads slowly, improving stability and aiding debugging. * Replace thrown error during action-menu retries with a `cy.log` to enable fallback logic in future enhancements. * Implement fallback logic to use **"Stop forecasting"** when the **"Cancel forecast"** modal does not appear, covering both *Initializing* and *Running* forecast states. Signed-off-by: Kaituo Li <kaituo@amazon.com> * check if deleted detector matches of of known existing one Signed-off-by: Kaituo Li <kaituo@amazon.com> --------- Signed-off-by: Kaituo Li <kaituo@amazon.com> Co-authored-by: yuboluo <yubonluo@amazon.com>

* extract tenant-dialog helper & improve forecaster list test robustness (#1823) * extract tenant-dialog helper & improve forecaster list test robustness This PR: * Create `cy.handleTenantDialog` custom command to handle the optional **"Select your tenant"** pop-up. * Refactor `forecaster_list_spec.js` and `createForecaster` helper to leverage the new command, reducing duplicate code. * Introduce explicit waits (`cy.contains('Loading OpenSearch Dashboards').should('not.exist')`, `cy.wait(500)`) and additional `cy.log` statements to handle cases where the home page loads slowly, improving stability and aiding debugging. * Replace thrown error during action-menu retries with a `cy.log` to enable fallback logic in future enhancements. * Implement fallback logic to use **"Stop forecasting"** when the **"Cancel forecast"** modal does not appear, covering both *Initializing* and *Running* forecast states. Signed-off-by: Kaituo Li <kaituo@amazon.com> * check if deleted detector matches of of known existing one Signed-off-by: Kaituo Li <kaituo@amazon.com> --------- Signed-off-by: Kaituo Li <kaituo@amazon.com> Co-authored-by: yuboluo <yubonluo@amazon.com> * test: improve resilience in forecast tests - In `daily_forecaster_spec.js`, after clicking the “Start test” button, wait for the “Initializing test” message before verifying “Test complete” to ensure previous messages have cleared and avoid race conditions. - In `forecaster_list_spec.js`: • Preemptively set the tenant to “global” via localStorage within `onBeforeLoad` when visiting `/`—this avoids the non-deterministic “Select your tenant” popup. • Removed multiple scattered calls to `cy.handleTenantDialog()`, relying on tenant pre-setting instead. • Increased UI rendering wait from 500 ms to 2000 ms for menu visibility. - In `forecaster_list_spec_mock.js`: • Applied the same “global” tenant override on page load to avoid the popup. - In `commands.js`: • Added `typeInEuiCombo(testSubj, value)` Cypress command to reliably enter text into EUI combo boxes by clicking the wrapper, typing into the actual input, and asserting the resulting pill—this reduces flakiness compared to typing directly in the wrapper. • Updated `createForecaster()` to use `typeInEuiCombo` for both `indicesFilter` and `timestampFilter`. Signed-off-by: Kaituo Li <kaituo@amazon.com> --------- Signed-off-by: Kaituo Li <kaituo@amazon.com> Co-authored-by: yuboluo <yubonluo@amazon.com>

kaituo requested review from CCongWang, Hailong-am, SuZhou-Joe, ananzh, ashwin-pc, kavilla, ohltyler, peterzhuamazon, prudhvigodithi, raintygao, ruanyl, tianleh, wanglam, xluo-aws, yubonluo, yujin-emma and zhongnansu as code owners August 7, 2025 03:04

kaituo changed the title ~~test~~ extract tenant-dialog helper & improve forecaster list test robustness Aug 7, 2025

amitgalitz reviewed Aug 7, 2025

View reviewed changes

amitgalitz approved these changes Aug 7, 2025

View reviewed changes

ohltyler approved these changes Aug 7, 2025

View reviewed changes

kaituo force-pushed the forecasterList branch 2 times, most recently from 4917e9f to cd673b0 Compare August 7, 2025 22:56

check if deleted detector matches of of known existing one

0880e65

Signed-off-by: Kaituo Li <kaituo@amazon.com>

kaituo force-pushed the forecasterList branch from cd673b0 to 0880e65 Compare August 8, 2025 01:19

yubonluo added backport 3.1 backport 3.2 labels Aug 8, 2025

Merge branch 'main' into forecasterList

c20b110

yubonluo approved these changes Aug 8, 2025

View reviewed changes

yubonluo merged commit 5397438 into opensearch-project:main Aug 8, 2025
49 checks passed

opensearch-trigger-bot Bot mentioned this pull request Aug 8, 2025

[Backport 3.1] extract tenant-dialog helper & improve forecaster list test robustness #1831

Closed

opensearch-trigger-bot Bot mentioned this pull request Aug 8, 2025

[Backport 3.2] extract tenant-dialog helper & improve forecaster list test robustness #1832

Merged

kaituo mentioned this pull request Aug 10, 2025

[backport to 3.1] test: improve resilience in forecast tests #1836

Merged

1 task

Navigation Menu

Uh oh!

extract tenant-dialog helper & improve forecaster list test robustness - #1823

extract tenant-dialog helper & improve forecaster list test robustness#1823
yubonluo merged 3 commits into
opensearch-project:mainfrom
kaituo:forecasterList

kaituo commented Aug 7, 2025 •

edited

Loading

Uh oh!

amitgalitz Aug 7, 2025

Uh oh!

kaituo Aug 7, 2025

Uh oh!

amitgalitz Aug 7, 2025

Uh oh!

kaituo Aug 7, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Uh oh!

Conversation

kaituo commented Aug 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Issues Resolved

Check List

Uh oh!

amitgalitz Aug 7, 2025

Choose a reason for hiding this comment

Uh oh!

kaituo Aug 7, 2025

Choose a reason for hiding this comment

Uh oh!

amitgalitz Aug 7, 2025

Choose a reason for hiding this comment

Uh oh!

kaituo Aug 7, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

kaituo commented Aug 7, 2025 •

edited

Loading