[On-boarding]: dashboards-assistant plugin

[joshuali925]

What is the name of your plugin?

dashboards-assistant

What is the link to your GitHub repo?

https://github.com/opensearch-project/dashboards-assistant/

Targeted release version

2.12.0

What type of the plugin are we on-boarding?

OpenSearch-dashboards plugin

Did you read the on-boarding document

yes

Does this plugin has all the necessary automated tests?

no IT yet. BWC not required

Have you completed the required reviews including Security reviews, UX reviews?

yes

Have you on-boarded automated security scanning for the GitHub repo associated with this plugin?

yes

Additional context

No response

[gaiksaya]

Hi @joshuali925 ,

Were you able to build the distribution using this new plugin? Steps are mentioned in the on-boarding document.
Pending tasks before closing this issue:

1. On-board to 2.12.0 manifest
2. On-board to test workflow by adding integration tests

Thanks!

[gaiksaya]

Hi,

In order to release this plugin as a part of the distribution, please make sure to onboard to distribution test workflow. See details here: https://github.com/opensearch-project/opensearch-build/wiki/Testing-the-Distribution
Please note that this is a requirement and can be a blocker if the criteria is not met.

Thanks!

[bbarani]

@joshuali925 This plugin will not be included in to distribution build if it doesn't contain the test workflows. CC: @prudhvigodithi

[joshuali925]

thanks for the notice. I assume test workflow for dashboards plugins means cypress integration tests in the functional test repo?

The onboarding doc section for testing seems only covered opensearch but not dashboards. please correct me if i'm wrong, thanks

opensearch-build/ONBOARDING.md

Line 40 in 31cc1ef

2. For integration testing, the `test-workflow` runs integration tests available in the plugin repository. You will need to add `integ-test` config for your plugin in opensearch-1.3.0-test.yml, [example](https://github.com/opensearch-project/opensearch-build/blob/opensearch-1.3.0/manifests/1.3.0/opensearch-1.3.0-test.yml).

I believe for dashboards we moved to functional-test repo, the integration tests shouldn't be in the plugin directory?

opensearch-build/ONBOARDING.md

Line 46 in 31cc1ef

3. For backward compatibility testing, the `test-workflow` runs backward compatibility tests available in the plugin repository, (see [reference](https://github.com/opensearch-project/anomaly-detection/blob/d9a122d05282f7efc1e24c61d64f18dec0fd47af/build.gradle#L428)). Like integration test, it has a set of configurable options defined in opensearch-1.3.0-test.yml, [example](https://github.com/opensearch-project/opensearch-build/blob/opensearch-1.3.0/manifests/1.3.0/opensearch-1.3.0-test.yml).

Are there backwards compatibility tests for dashboards?

---

@ruanyl @SuZhou-Joe Does your team have bandwidth to add integration tests for dashboards-assistant to functional test repo?

[gaiksaya]

Hi @joshuali925 ,

Right! For dashboard plugins functional-test is the right place. We will add more details to the boarding document. The test workflow in this repository will run tests from functional test repo for all dashboards plugins under the hood.

[ruanyl]

@joshuali925 We will working on adding and setting up functional tests in https://github.com/opensearch-project/opensearch-dashboards-functional-test

[raintygao]

The PR opensearch-project/opensearch-dashboards-functional-test#1002 and opensearch-project/opensearch-dashboards-functional-test#1005 to setup assistant test in FT repo has been merged. I have created a PR #4363 to on board assistant to 2.12.0 manifest and test workflow. Please take a look.

[prudhvigodithi]

Thanks, I have merged the PR #4363 and update the release issue as well #4115.

[peterzhuamazon]

Already onboarded, thanks.