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.

Sign up for GitHub

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

Jump to bottom

Added a framework for end-to-end tests #1022

Merged
merged 2 commits into from
Jan 29, 2025
Merged

Added a framework for end-to-end tests #1022

merged 2 commits into from
Jan 29, 2025

Conversation

normanj-bitquill
Copy link
Contributor

  • Only contains sample queries, not a full suite. All tests make use of the integration test docker cluster.
  • Can run the tests with "sbt e2etest/test"

Description

Adds a testing framework for end-to-end tests. The integration test docker cluster is used for the tests. Tests can run against Spark or OpenSearch (using the async query API).

To run the end-to-end tests:

sbt e2dtest/test

Related Issues

#647

Check List

  • Updated documentation (docs/ppl-lang/README.md)
  • Implemented unit tests
  • Implemented tests for combination with other commands
  • New added source code should include a copyright header
  • 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.

@normanj-bitquill
Added a framework for end-to-end tests
dcbc338 
* Only contains sample queries, not a full suite. All tests make use of the integration test
docker cluster.
* Can run the tests with "sbt e2etest/test"

Signed-off-by: Norman Jordan <[email protected]>
YANG-DB
YANG-DB requested changes Jan 28, 2025
View reviewed changes
Copy link
Member

@YANG-DB YANG-DB left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great - I would add more details about the docker-compose services including each service responsibilities and how the sequence of call if operated by the different E2E use cases ...

e2e-test/README.md
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks great
I'm missing some detailed review and call diagram sequence of how the E2E operates for each case:

  • SQL Queries for Spark Master
  • PPL Queries for Spark Master
  • SQL Queries for OpenSearch Async API
  • PPL Queries for OpenSearch Async API

What are the functions of each docker-compose service and which sequence the call each other

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added some documentation with diagrams to explain how these queries are executed.

@YANG-DB
Copy link
Member

YANG-DB commented Jan 28, 2025

@normanj-bitquill
It would also be nice to have a doc showing how to call PPL / SQL queries via the dashboard's workbench

@normanj-bitquill
Added documentation for integ-test cluster
4d8b86f 
* Documented how queries are processed in the integ-test cluster
* Documented how to use the Query Workbench with the integ-test cluster
* Removed the shading of Jackson libraries (fixes opensearch-project#973)

Signed-off-by: Norman Jordan <[email protected]>
@normanj-bitquill
Copy link
Contributor Author

@normanj-bitquill It would also be nice to have a doc showing how to call PPL / SQL queries via the dashboard's workbench

@YANG-DB I added some documentation about how to use the query workbench.

@normanj-bitquill
Copy link
Contributor Author

@YANG-DB This now includes a fix for #973

I disabled shading the Jackson libraries. Saving a dataset in Spark to CSV or JSON requires use of Jackson libraries. If this part of the PR is controversial, I can probably switch to Parquet, but it will add some complexity for comparing to expected results.

@YANG-DB YANG-DB merged commit 98579e1 into opensearch-project:main Jan 29, 2025
4 checks passed
@normanj-bitquill normanj-bitquill mentioned this pull request Feb 3, 2025
Open
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@YANG-DB YANG-DB YANG-DB approved these changes

@dai-chen dai-chen Awaiting requested review from dai-chen dai-chen is a code owner

@mengweieric mengweieric Awaiting requested review from mengweieric mengweieric is a code owner

@penghuo penghuo Awaiting requested review from penghuo penghuo is a code owner

@seankao-az seankao-az Awaiting requested review from seankao-az seankao-az is a code owner

@anirudha anirudha Awaiting requested review from anirudha anirudha is a code owner

@kaituo kaituo Awaiting requested review from kaituo kaituo is a code owner

@noCharger noCharger Awaiting requested review from noCharger noCharger is a code owner

@LantaoJin LantaoJin Awaiting requested review from LantaoJin LantaoJin is a code owner

@ykmr1224 ykmr1224 Awaiting requested review from ykmr1224 ykmr1224 is a code owner

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@normanj-bitquill @YANG-DB