Add cypress tests for discover 2.0 #1598

abbyhu2000 · 2024-10-22T23:07:11Z

Description

Add two test files to test on discover 2.0 functionalities.

queries
dataset navigator

Issues Resolved

[List any issues this PR will resolve]

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.

ashwin-pc

Overall i love the tests. A few coments and concerns. Let me know what you think of them

...opensearch-dashboards/opensearch-dashboards/apps/query_enhancement/dataset_navigator.spec.js

ashwin-pc · 2024-10-23T00:26:45Z

...opensearch-dashboards/opensearch-dashboards/apps/query_enhancement/dataset_navigator.spec.js

+      cy.getElementByTestId('queryEditorLanguageSelector').should(
+        'contain',
+        'SQL'
+      );


This will be flakey unless we can set this before hand right?

ashwin-pc · 2024-10-23T00:27:17Z

...opensearch-dashboards/opensearch-dashboards/apps/query_enhancement/dataset_navigator.spec.js

+      // The following steps are needed because when selecting SQL, discover loaded with data but the
+      // multi-line query editor are not loaded properly(it renders a single line query bar) unless we select SQL again
+      // This bug only exist in cypress test; can not reproduce manually
+      cy.get(`[data-test-subj="queryEditorLanguageSelector"]`).click();


Will a wait help?

...opensearch-dashboards/opensearch-dashboards/apps/query_enhancement/dataset_navigator.spec.js

ashwin-pc · 2024-10-23T00:36:23Z

...opensearch-dashboards/opensearch-dashboards/apps/query_enhancement/dataset_navigator.spec.js

+        `app/data-explorer/discover#/?_g=(filters:!(),time:(from:'2015-09-19T13:31:44.000Z',to:'2015-09-24T01:31:44.000Z'))`
+      );
+
+      cy.get(`[class~="datasetSelector__button"]`).click();


If there are index patterns, the default index pattern should be selected by default. We should not have to select it

Yea when i tried it manually, the default index pattern will be picked up by default; but somehow in the test, it wont. @ashwin-pc

I also saw this issue. I think due to double render, first select as the default index then render. So in cypress we will capture this and need to re-select it. Also saw SuperDatePicker detached from the DOM due to the same reason. We will document any issues due to render or async.

is this still the case

...tion/core-opensearch-dashboards/opensearch-dashboards/apps/query_enhancement/queries.spec.js

ashwin-pc · 2024-10-23T01:26:43Z

package.json

@@ -34,6 +34,7 @@
    "osd:ciGroup7": "echo apps/data_explorer/aaa_before.spec.js,apps/data_explorer/doc_navigation.spec.js,apps/data_explorer/doc_table.spec.js,apps/data_explorer/errors.spec.js,apps/data_explorer/field_data.spec.js,apps/data_explorer/zzz_after.spec.js",
    "osd:ciGroup8": "echo apps/data_explorer/aaa_before.spec.js,apps/data_explorer/field_visualize.spec.js,apps/data_explorer/filter_editor.spec.js,apps/data_explorer/index_pattern_with_encoded_id.spec.js,apps/data_explorer/index_pattern_without_field.spec.js,apps/data_explorer/zzz_after.spec.js",
    "osd:ciGroup9": "echo apps/data_explorer/aaa_before.spec.js,apps/data_explorer/inspector.spec.js,apps/data_explorer/large_string.spec.js,apps/data_explorer/saved_queries.spec.js,apps/data_explorer/shared_links.spec.js,apps/data_explorer/sidebar.spec.js,apps/data_explorer/source_filter.spec.js,apps/data_explorer/zzz_after.spec.js",
+    "osd:ciGroup10": "echo apps/query_enhancement/*.js",


Wont this require all the YAML settings and Advanced settings for this view to be set correctly?

what do you mean by this?

that's a good call out @ashwin-pc

@abbyhu2000 we start query enhancements with an advanced setting overridden. but doesn't mean everyone will know that.

we should:

part of a test setup is to set the query enhancements advanced setting to true.

check if we can re-use some of the MDS test setup. because right now i dont think the tests would be able to much besides things like index patterns as we move the default cluster option and i dont know if the test sets up a call to an external cluster. so you wont be able to select an index. so maybe we can set up on the ci two clusters starting up so that we can add that data soruce as an external data source. this will mean we will need to handle the situation when we start with MDS or not.

...opensearch-dashboards/opensearch-dashboards/apps/query_enhancement/dataset_navigator.spec.js

kavilla · 2024-11-04T18:59:26Z

...opensearch-dashboards/opensearch-dashboards/apps/query_enhancement/dataset_navigator.spec.js

+    it('with SQL as default language', function () {
+      cy.getElementByTestId(`datasetSelectorButton`).click();
+      cy.getElementByTestId(`datasetSelectorAdvancedButton`).click();
+      cy.get(`[title="Indexes"]`).click();


could we add data test subjects to these?

...opensearch-dashboards/opensearch-dashboards/apps/query_enhancement/dataset_navigator.spec.js

...tion/core-opensearch-dashboards/opensearch-dashboards/apps/query_enhancement/queries.spec.js

kavilla · 2024-11-04T19:17:27Z

package.json

@@ -34,6 +34,7 @@
    "osd:ciGroup7": "echo apps/data_explorer/aaa_before.spec.js,apps/data_explorer/doc_navigation.spec.js,apps/data_explorer/doc_table.spec.js,apps/data_explorer/errors.spec.js,apps/data_explorer/field_data.spec.js,apps/data_explorer/zzz_after.spec.js",
    "osd:ciGroup8": "echo apps/data_explorer/aaa_before.spec.js,apps/data_explorer/field_visualize.spec.js,apps/data_explorer/filter_editor.spec.js,apps/data_explorer/index_pattern_with_encoded_id.spec.js,apps/data_explorer/index_pattern_without_field.spec.js,apps/data_explorer/zzz_after.spec.js",
    "osd:ciGroup9": "echo apps/data_explorer/aaa_before.spec.js,apps/data_explorer/inspector.spec.js,apps/data_explorer/large_string.spec.js,apps/data_explorer/saved_queries.spec.js,apps/data_explorer/shared_links.spec.js,apps/data_explorer/sidebar.spec.js,apps/data_explorer/source_filter.spec.js,apps/data_explorer/zzz_after.spec.js",
+    "osd:ciGroup10": "echo apps/query_enhancement/*.js",


that's a good call out @ashwin-pc

@abbyhu2000 we start query enhancements with an advanced setting overridden. but doesn't mean everyone will know that.

we should:

part of a test setup is to set the query enhancements advanced setting to true.

check if we can re-use some of the MDS test setup. because right now i dont think the tests would be able to much besides things like index patterns as we move the default cluster option and i dont know if the test sets up a call to an external cluster. so you wont be able to select an index. so maybe we can set up on the ci two clusters starting up so that we can add that data soruce as an external data source. this will mean we will need to handle the situation when we start with MDS or not.

Signed-off-by: Qingyang(Abby) Hu <[email protected]>

abbyhu2000 · 2024-11-08T19:48:11Z

Passed all cypress tests: https://github.com/opensearch-project/OpenSearch-Dashboards/actions/runs/11734021937

* add reload to PPL Signed-off-by: Qingyang(Abby) Hu <[email protected]> * Add initial query enhancement tests Signed-off-by: Qingyang(Abby) Hu <[email protected]> * Add ciGroup10 Signed-off-by: Qingyang(Abby) Hu <[email protected]> * modify queries test Signed-off-by: Qingyang(Abby) Hu <[email protected]> * fix tests Signed-off-by: Qingyang(Abby) Hu <[email protected]> * fix one more test Signed-off-by: Qingyang(Abby) Hu <[email protected]> * address comments Signed-off-by: Qingyang(Abby) Hu <[email protected]> * remove deleteAll Signed-off-by: Qingyang(Abby) Hu <[email protected]> * delete data source connection Signed-off-by: Qingyang(Abby) Hu <[email protected]> --------- Signed-off-by: Qingyang(Abby) Hu <[email protected]> (cherry picked from commit c3abd79)

* add reload to PPL Signed-off-by: Qingyang(Abby) Hu <[email protected]> * Add initial query enhancement tests Signed-off-by: Qingyang(Abby) Hu <[email protected]> * Add ciGroup10 Signed-off-by: Qingyang(Abby) Hu <[email protected]> * modify queries test Signed-off-by: Qingyang(Abby) Hu <[email protected]> * fix tests Signed-off-by: Qingyang(Abby) Hu <[email protected]> * fix one more test Signed-off-by: Qingyang(Abby) Hu <[email protected]> * address comments Signed-off-by: Qingyang(Abby) Hu <[email protected]> * remove deleteAll Signed-off-by: Qingyang(Abby) Hu <[email protected]> * delete data source connection Signed-off-by: Qingyang(Abby) Hu <[email protected]> --------- Signed-off-by: Qingyang(Abby) Hu <[email protected]> (cherry picked from commit c3abd79) Co-authored-by: Qingyang(Abby) Hu <[email protected]>

abbyhu2000 requested review from tianleh, kavilla, ohltyler, CCongWang, ashwin-pc, peterzhuamazon, ananzh, prudhvigodithi, xluo-aws, Hailong-am, SuZhou-Joe, ruanyl, wanglam, raintygao, zhongnansu and yujin-emma as code owners October 22, 2024 23:07

abbyhu2000 force-pushed the discover_cypress branch from 6c0afef to b869203 Compare October 22, 2024 23:08

ashwin-pc reviewed Oct 23, 2024

View reviewed changes

ananzh reviewed Oct 24, 2024

View reviewed changes

...opensearch-dashboards/opensearch-dashboards/apps/query_enhancement/dataset_navigator.spec.js Outdated Show resolved Hide resolved

abbyhu2000 mentioned this pull request Oct 25, 2024

Add query enhancement cypress tests to Github CI opensearch-project/OpenSearch-Dashboards#8703

Merged

7 tasks

kavilla reviewed Nov 4, 2024

View reviewed changes

kavilla added backport 2.x v2.19.0 labels Nov 4, 2024

ananzh mentioned this pull request Nov 4, 2024

Add tests for query enhancement discover covering basic functions and shared links #1600

Open

1 task

abbyhu2000 force-pushed the discover_cypress branch from c0acd2c to 913990b Compare November 5, 2024 23:27

ashwin-pc mentioned this pull request Nov 6, 2024

[discover] temporarily disable recent datasets opensearch-project/OpenSearch-Dashboards#8816

Merged

7 tasks

abbyhu2000 added 4 commits November 5, 2024 22:53

add reload to PPL

150d875

Signed-off-by: Qingyang(Abby) Hu <[email protected]>

Add initial query enhancement tests

90eed61

Signed-off-by: Qingyang(Abby) Hu <[email protected]>

Add ciGroup10

20c0be6

Signed-off-by: Qingyang(Abby) Hu <[email protected]>

modify queries test

cf9d745

Signed-off-by: Qingyang(Abby) Hu <[email protected]>

abbyhu2000 added 3 commits November 5, 2024 23:17

fix tests

33400f3

Signed-off-by: Qingyang(Abby) Hu <[email protected]>

fix one more test

d9dbe42

Signed-off-by: Qingyang(Abby) Hu <[email protected]>

address comments

64a54d4

Signed-off-by: Qingyang(Abby) Hu <[email protected]>

abbyhu2000 force-pushed the discover_cypress branch from ebc5647 to 64a54d4 Compare November 6, 2024 07:17

abbyhu2000 added 2 commits November 7, 2024 13:57

remove deleteAll

c470b28

Signed-off-by: Qingyang(Abby) Hu <[email protected]>

delete data source connection

27cc912

Signed-off-by: Qingyang(Abby) Hu <[email protected]>

kavilla approved these changes Nov 8, 2024

View reviewed changes

Hailong-am approved these changes Nov 14, 2024

View reviewed changes

Hailong-am merged commit c3abd79 into opensearch-project:main Nov 14, 2024
57 of 64 checks passed

opensearch-trigger-bot bot mentioned this pull request Nov 14, 2024

[Backport 2.x] Add cypress tests for discover 2.0 #1640

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add cypress tests for discover 2.0 #1598

Add cypress tests for discover 2.0 #1598

abbyhu2000 commented Oct 22, 2024

ashwin-pc left a comment

ashwin-pc Oct 23, 2024

ashwin-pc Oct 23, 2024

ashwin-pc Oct 23, 2024

abbyhu2000 Oct 23, 2024

ananzh Oct 24, 2024

kavilla Nov 4, 2024

ananzh Nov 6, 2024

ashwin-pc Oct 23, 2024

abbyhu2000 Oct 23, 2024

kavilla Nov 4, 2024

kavilla Nov 4, 2024

kavilla Nov 4, 2024

abbyhu2000 commented Nov 8, 2024

Add cypress tests for discover 2.0 #1598

Add cypress tests for discover 2.0 #1598

Conversation

abbyhu2000 commented Oct 22, 2024

Description

Issues Resolved

Check List

ashwin-pc left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

abbyhu2000 commented Nov 8, 2024