[Enhancement/Fix] Refactor datasources cypress tests

[RyanL1997]

Description

Fix the existing datasources tests, and extend the UI test cases.

Check List

• New functionality includes testing.
  • All tests pass, including unit test, integration test and doctest
• New functionality has been documented.
  • New functionality has javadoc added
  • New functionality has user manual doc added
• 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.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (b42aa2c) 52.92% compared to head (dc8b19a) 51.31%.
Report is 1 commits behind head on main.

❗ Current head dc8b19a differs from pull request most recent head b2ccbe6. Consider uploading reports for the commit b2ccbe6 to get more accurate results

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1323      +/-   ##
==========================================
- Coverage   52.92%   51.31%   -1.62%     
==========================================
  Files         302      303       +1     
  Lines       10587    10586       -1     
  Branches     2777     2778       +1     
==========================================
- Hits         5603     5432     -171     
- Misses       4939     5108     +169     
- Partials       45       46       +1     

Flag	Coverage Δ
dashboards-observability	51.31% <ø> (-1.62%)	⬇️

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.

[RyanL1997]

Hi folks, I just left some notes for better understanding of the changes I made.

[RyanL1997]

This security config should be disabled by default because:

• Current testing workflow is fully without security
• I was checking our commands setup, and I saw that we have overwritten the request command based on this config:

  • source code:

    Cypress.Commands.overwrite('visit', (originalFn, url, options) => {
      // Add the basic auth header when security enabled in the OpenSearch cluster
      // https://github.com/cypress-io/cypress/issues/1288
      if (Cypress.env('security_enabled')) {
        if (options) {
          options.auth = ADMIN_AUTH;
        } else {
          options = { auth: ADMIN_AUTH };
        }
        // Add query parameters - select the default OpenSearch Dashboards tenant
        options.qs = { security_tenant: 'private' };
        return originalFn(url, options);
      } else {
        return originalFn(url, options);
      }
    });

  • when this config enabled, every single call of the request will be assembled with this security_tenant=private option. This is kinda impact the assertion we are having for now. For example, the expected url should not contain the above tenant option.

[RyanL1997]

This is a cypress update comment, and we should remove this.

[RyanL1997]

I added this dashboards configuration because the current cypress framework is having trouble determine among localhost, 127.0.0.1, and ::.

This is a known issue for cypress + node version 18+: cypress-io/cypress#25397 (comment)

[RyanL1997]

The test results are green: https://github.com/opensearch-project/dashboards-observability/actions/runs/7402757656/job/20141286353?pr=1323#step:22:50 (cc: @mengweieric , @ps48 )

[RyanL1997]

Here is the reproduce of linting error on my local:

Oops! Something went wrong! :(

ESLint: 6.8.0.

No files matching the pattern ".cypress/integration/datasources_test/datasources.spec.js" were found.
Please check for typing mistakes in the pattern.

Since we are just fetch the diff of files. In this PR the original name of test file got changed from datasources.spec.js into datasources_basic_ui.spec.js , but the current fetch diff step in the workflow of lint considers the deletion of datasources.spec.js as one of the changes, so we get this "... file is not found" error.

[RyanL1997]

Newly changed lint file set is like this: https://github.com/opensearch-project/dashboards-observability/actions/runs/7481679764/job/20363744276?pr=1323#step:10:23