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

[Smoke Tests] Dynamically retrieve the OpenSearch API specification file from repository releases #5239

Open
zelinh opened this issue Jan 15, 2025 · 2 comments
Assignees
Labels
enhancement New Enhancement test

Comments

@zelinh
Copy link
Member

zelinh commented Jan 15, 2025

Is your feature request related to a problem? Please describe

The smoke test workflow currently uses the OpenSearch API specification file to validate and test distribution bundles. At present, the specification file is fixed and stored in the OpenSearch Build repository:
OpenSearch API Specification File.

Maintaining and updating this file is challenging due to frequent updates in the opensearch-api-spec repository. The version in the opensearch-build repository can quickly become outdated, requiring manual updates to stay aligned.

Describe the solution you'd like

We could dynamically download the latest version of the API specification file directly from the GitHub release. Instead of relying on the local spec file, we can update the path here to fetch the specification file from the latest GitHub release.

spec_file = os.path.join(os.path.dirname(os.path.abspath(__file__)), "smoke_tests_spec", "opensearch-openapi.yaml")

OpenSearch API Specification - Main Latest Release.

Describe alternatives you've considered

No response

Additional context

No response

@zelinh zelinh added enhancement New Enhancement test untriaged Issues that have not yet been triaged labels Jan 15, 2025
@prudhvigodithi prudhvigodithi removed the enhancement New Enhancement label Jan 30, 2025
@prudhvigodithi
Copy link
Member

[Triage]
Agree its a good idea to download the file from the opensearch-api-specification repo releases.
@zelinh

@prudhvigodithi prudhvigodithi added enhancement New Enhancement and removed untriaged Issues that have not yet been triaged labels Jan 30, 2025
@zelinh
Copy link
Member Author

zelinh commented Jan 31, 2025

I will take care of this enhancement. As more plugins onboard to the smoke test framework, it's important to keep the API spec file in sync with the upstream repository at all times.

@zelinh zelinh self-assigned this Jan 31, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New Enhancement test
Projects
Status: 🆕 New
Development

No branches or pull requests

2 participants