[Cypress Test] Add and Refactor TESTID-140 sidebar spec and TESTID-46,47,49 sharing spec #9154

ananzh · 2025-01-08T02:00:05Z

Description

Refactor this PR TESTID-140: sidebar spec #9128
Clean up structures

Issues Resolved

Partially #8946
#8954
#8952
#8953

Screenshot

Changelog

test: [Cypress Test] Add and Refactor TESTID-140 sidebar spec and clean up

Check List

All tests pass
- yarn test:jest
- yarn test:jest_integration
New functionality includes testing.
New functionality has been documented.
Update CHANGELOG.md
Commits are signed per the DCO using --signoff

codecov · 2025-01-08T02:15:40Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 61.70%. Comparing base (6c83d4e) to head (88d64b5).
Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #9154      +/-   ##
==========================================
- Coverage   61.70%   61.70%   -0.01%     
==========================================
  Files        3816     3816              
  Lines       91824    91824              
  Branches    14542    14542              
==========================================
- Hits        56664    56662       -2     
- Misses      31506    31507       +1     
- Partials     3654     3655       +1

Flag	Coverage Δ
Linux_1	`28.99% <ø> (ø)`
Linux_2	`56.46% <ø> (ø)`
Linux_3	`39.18% <ø> (-0.01%)`	⬇️
Linux_4	`28.91% <ø> (ø)`
Windows_1	`29.00% <ø> (ø)`
Windows_2	`56.41% <ø> (ø)`
Windows_3	`39.18% <ø> (ø)`
Windows_4	`28.91% <ø> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

angle943 · 2025-01-22T21:49:30Z

cypress/utils/apps/query_enhancements/sidebar.js

+  cy.get('.view-line').type(query);
+  // Send query
+  cy.getElementByTestId('querySubmitButton').click();
+};


is this funciton needed? can we remove it and use this instead?

https://github.com/opensearch-project/OpenSearch-Dashboards/blob/main/cypress/utils/apps/query_enhancements/commands.js#L6

angle943 · 2025-01-22T21:50:13Z

cypress/utils/apps/query_enhancements/sidebar.js

+ */
+
+/**
+ * Returns the SideBarTestConfig for the provided dataset, datasetType, and language


Suggested change

* Returns the SideBarTestConfig for the provided dataset, datasetType, and language

* Returns the FieldDisplayFilteringTestConfig for the provided dataset, datasetType, and language

angle943 · 2025-01-22T21:50:30Z

cypress/utils/apps/query_enhancements/sidebar.js

+ * @param {string} dataset - the dataset name
+ * @param {QueryEnhancementDataset} datasetType - the type of the dataset
+ * @param {QueryEnhancementLanguageData} language - the relevant data for the query language to use
+ * @returns {SideBarTestConfig}


Suggested change

* @returns {SideBarTestConfig}

* @returns {FieldDisplayFilteringTestConfig}

angle943 · 2025-01-22T21:51:09Z

cypress/utils/apps/query_enhancements/sidebar.js

+ * @property {string} dataset - the dataset name to use
+ * @property {QueryEnhancementDataset} datasetType - the type of dataset
+ * @property {QueryEnhancementLanguage} language - the name of query language as it appears in the dashboard app
+ * @property {boolean} isFilterButtonsEnabled - whether filter button is enabled for this permutation


Suggested change

* @property {boolean} isFilterButtonsEnabled - whether filter button is enabled for this permutation

angle943 · 2025-01-22T21:53:52Z

cypress/utils/apps/query_enhancements/shared.js

 * @returns {object[]}
 */
-export const generateAllTestConfigurations = (generateTestConfigurationCallback) => {
+export const generateAllTestConfigurations = (generateTestConfigurationCallback, options = {}) => {
+  const { indexPattern = INDEX_PATTERN_WITH_TIME, index = INDEX_WITH_TIME_1 } = options;


I'm fine with this change, but looking at it's usage in this PR, it looks like the only change is:

indexPattern: 'data_logs_small_time_1*',

Can't we just change this to data_logs_small_time_*?

But irreglardless of my questions, lets keep this change (i found an issue when migrating that'll make this useful!)

Yeah I want it to be more general. So you can define what is index patten and index.

LDrago27 · 2025-01-22T21:55:45Z

...ion/core_opensearch_dashboards/opensearch_dashboards/apps/query_enhancements/sidebar.spec.js

+  config
+) => {
+  // Helper functions
+  const getDocTableHeaderByIndex = (index) =>


Do we want to move these helper functions into the sidebar.js

I am considering it. But it should be a function in table canvas which is TESTID-147. Will update when raise the PR for TESTID-147.

LDrago27 · 2025-01-22T21:56:12Z

...ion/core_opensearch_dashboards/opensearch_dashboards/apps/query_enhancements/sidebar.spec.js

+};
+
+describe('sidebar spec', () => {
+  before(() => {


We should change the before into beforeEach and consolidate the after and afterEach blocks

I will remove before. I have kept one in config which should not affect.

Issue Resolved Partially opensearch-project#8946 opensearch-project#8954 opensearch-project#8952 opensearch-project#8953 Signed-off-by: Anan <[email protected]>

ashwin-pc

Approving the PR but lets look into why we need to tear down and add data every time to OpenSearch. Seems very inefficient

ashwin-pc · 2025-01-30T01:54:09Z

...ore_opensearch_dashboards/opensearch_dashboards/apps/query_enhancements/shared_links.spec.js

+      interval: 'w',
+      filter: ['category', 'Network'],
+    };
+    beforeEach(() => {


This seems really inefficient! Why do we need to do this for every test? Our test suite will blow up!

this is for @AMoo-Miki 's future test plan design to isolate each test cases and run parallelly.

opensearch-trigger-bot · 2025-01-30T05:19:24Z

The backport to 2.x failed:

The process '/usr/bin/git' failed with exit code 128

To backport manually, run these commands in your terminal:

# Navigate to the root of your repository
cd $(git rev-parse --show-toplevel)
# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/OpenSearch-Dashboards/backport-2.x 2.x
# Navigate to the new working tree
pushd ../.worktrees/OpenSearch-Dashboards/backport-2.x
# Create a new branch
git switch --create backport/backport-9154-to-2.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 a50e0c74f5bf87903ec6b6d82c131d1fc20b4a29
# Push it to GitHub
git push --set-upstream origin backport/backport-9154-to-2.x
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/OpenSearch-Dashboards/backport-2.x

Then, create a pull request where the base branch is 2.x and the compare/head branch is backport/backport-9154-to-2.x.

opensearch-trigger-bot · 2025-01-30T05:19:25Z

The backport to 2.19 failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Navigate to the root of your repository
cd $(git rev-parse --show-toplevel)
# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/OpenSearch-Dashboards/backport-2.19 2.19
# Navigate to the new working tree
pushd ../.worktrees/OpenSearch-Dashboards/backport-2.19
# Create a new branch
git switch --create backport/backport-9154-to-2.19
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 a50e0c74f5bf87903ec6b6d82c131d1fc20b4a29
# Push it to GitHub
git push --set-upstream origin backport/backport-9154-to-2.19
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/OpenSearch-Dashboards/backport-2.19

Then, create a pull request where the base branch is 2.19 and the compare/head branch is backport/backport-9154-to-2.19.

ananzh added the discover_2.0-test Issues that are specific to the Discover 2.0 testing initiative label Jan 8, 2025

github-actions bot added the distinguished-contributor label Jan 8, 2025

opensearch-changeset-bot bot added a commit to ananzh/OpenSearch-Dashboards that referenced this pull request Jan 8, 2025

Changeset file for PR opensearch-project#9154 created/updated

f6e765b

ananzh force-pushed the refactor-testid-140 branch 2 times, most recently from bd60d37 to c6e7933 Compare January 21, 2025 20:41

angle943 reviewed Jan 22, 2025

View reviewed changes

LDrago27 reviewed Jan 22, 2025

View reviewed changes

ananzh force-pushed the refactor-testid-140 branch from c6e7933 to c42e778 Compare January 27, 2025 19:29

ananzh changed the title ~~[Cypress Test] Add and Refactor TESTID-140 sidebar spec and clean up~~ [Cypress Test] Add and Refactor TESTID-140 sidebar spec and TESTID-46,47,49 sharing spec Jan 27, 2025

opensearch-changeset-bot bot added a commit to ananzh/OpenSearch-Dashboards that referenced this pull request Jan 27, 2025

Changeset file for PR opensearch-project#9154 created/updated

2a2038a

ananzh force-pushed the refactor-testid-140 branch 2 times, most recently from 98f25c0 to 38fb073 Compare January 28, 2025 00:53

ananzh mentioned this pull request Jan 28, 2025

TESTID-140: sidebar spec #9128

Closed

7 tasks

ananzh added backport 2.x v2.19.0 labels Jan 28, 2025

ananzh mentioned this pull request Jan 28, 2025

[Cypress][TESTID-147] Add tests for table canvas in discover #9285

Open

7 tasks

ananzh force-pushed the refactor-testid-140 branch from 38fb073 to 44819bf Compare January 28, 2025 22:08

LDrago27 previously approved these changes Jan 29, 2025

View reviewed changes

ananzh dismissed LDrago27’s stale review via c5e094a January 29, 2025 23:01

ananzh force-pushed the refactor-testid-140 branch 2 times, most recently from c5e094a to c4193be Compare January 29, 2025 23:30

opensearch-changeset-bot bot added a commit to ananzh/OpenSearch-Dashboards that referenced this pull request Jan 29, 2025

Changeset file for PR opensearch-project#9154 created/updated

c58b86f

Refactor TESTID 140 and resolve TESTID 46,47,49

b1378d4

Issue Resolved Partially opensearch-project#8946 opensearch-project#8954 opensearch-project#8952 opensearch-project#8953 Signed-off-by: Anan <[email protected]>

ananzh force-pushed the refactor-testid-140 branch from c58b86f to b1378d4 Compare January 29, 2025 23:36

Changeset file for PR opensearch-project#9154 created/updated

88d64b5

ananzh added the backport 2.19 label Jan 30, 2025

LDrago27 approved these changes Jan 30, 2025

View reviewed changes

ashwin-pc approved these changes Jan 30, 2025

View reviewed changes

ananzh merged commit a50e0c7 into opensearch-project:main Jan 30, 2025
73 checks passed

opensearch-trigger-bot bot added the failed backport label Jan 30, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Cypress Test] Add and Refactor TESTID-140 sidebar spec and TESTID-46,47,49 sharing spec #9154

[Cypress Test] Add and Refactor TESTID-140 sidebar spec and TESTID-46,47,49 sharing spec #9154

ananzh commented Jan 8, 2025 •

edited

Loading

codecov bot commented Jan 8, 2025 •

edited

Loading

angle943 Jan 22, 2025

ananzh Jan 30, 2025

angle943 Jan 22, 2025

ananzh Jan 30, 2025

angle943 Jan 22, 2025

ananzh Jan 30, 2025

angle943 Jan 22, 2025

ananzh Jan 30, 2025

angle943 Jan 22, 2025

angle943 Jan 24, 2025

ananzh Jan 24, 2025

LDrago27 Jan 22, 2025

ananzh Jan 25, 2025

LDrago27 Jan 22, 2025

ananzh Jan 25, 2025

ashwin-pc left a comment

ashwin-pc Jan 30, 2025

ananzh Jan 30, 2025

opensearch-trigger-bot bot commented Jan 30, 2025

opensearch-trigger-bot bot commented Jan 30, 2025

	* Returns the SideBarTestConfig for the provided dataset, datasetType, and language
	* Returns the FieldDisplayFilteringTestConfig for the provided dataset, datasetType, and language

	* @returns {SideBarTestConfig}
	* @returns {FieldDisplayFilteringTestConfig}

[Cypress Test] Add and Refactor TESTID-140 sidebar spec and TESTID-46,47,49 sharing spec #9154

[Cypress Test] Add and Refactor TESTID-140 sidebar spec and TESTID-46,47,49 sharing spec #9154

Conversation

ananzh commented Jan 8, 2025 • edited Loading

Description

Issues Resolved

Screenshot

Changelog

Check List

codecov bot commented Jan 8, 2025 • edited Loading

Codecov Report

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

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

opensearch-trigger-bot bot commented Jan 30, 2025

opensearch-trigger-bot bot commented Jan 30, 2025

ananzh commented Jan 8, 2025 •

edited

Loading

codecov bot commented Jan 8, 2025 •

edited

Loading