Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[On-boarding]: dashboards-assistant plugin #4322

Closed
joshuali925 opened this issue Jan 4, 2024 · 9 comments
Closed

[On-boarding]: dashboards-assistant plugin #4322

joshuali925 opened this issue Jan 4, 2024 · 9 comments

Comments

@joshuali925
Copy link
Member

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

@joshuali925 joshuali925 added on-boarding untriaged Issues that have not yet been triaged labels Jan 4, 2024
@gaiksaya gaiksaya removed the untriaged Issues that have not yet been triaged label Jan 4, 2024
@gaiksaya
Copy link
Member

gaiksaya commented Jan 4, 2024

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
Copy link
Member

gaiksaya commented Jan 12, 2024

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
Copy link
Member

bbarani commented Jan 15, 2024

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

@joshuali925
Copy link
Member Author

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

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?

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
Copy link
Member

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
Copy link
Member

ruanyl commented Jan 18, 2024

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

@raintygao
Copy link
Contributor

raintygao commented Jan 23, 2024

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
Copy link
Member

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

@peterzhuamazon
Copy link
Member

Already onboarded, thanks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

7 participants