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

SHOW CATALOGS documentation and integ tests #977

Conversation

vamsimanohar
Copy link
Member

@vamsimanohar vamsimanohar commented Oct 27, 2022

Signed-off-by: Vamsi Manohar reddyvam@amazon.com

Description

Covers integration tests, doc tests and documentation for #925

Issues Resolved

[List any issues this PR will resolve]

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.

@vamsimanohar vamsimanohar force-pushed the show-catalogs-integ-tests-docs branch from 3ba5730 to 86eb22d Compare October 27, 2022 07:19
task startPrometheus(type: SpawnProcessTask) {
doFirst {
download.run {
src 'https://github.com/prometheus/prometheus/releases/download/v2.39.1/prometheus-2.39.1.linux-amd64.tar.gz'
Copy link
Member Author

Choose a reason for hiding this comment

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

What is the best practice here? Should I rely on github links or S3 links.

Copy link
Collaborator

Choose a reason for hiding this comment

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

wondering how often this needs to be changed?

Copy link
Member Author

Choose a reason for hiding this comment

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

Till the next major release. I will be sticking to this version.

Copy link
Member

Choose a reason for hiding this comment

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

should this test be optional? I assume it won't work on arm64 and windows/mac

Copy link
Member Author

@vamsimanohar vamsimanohar Oct 27, 2022

Choose a reason for hiding this comment

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

I have seen derek's PR, it removed doctests and integTests for other platforms. When we fix for them we can use mac/windows binaries for them.
or we can create a separate task including tests for prometheus.

Copy link
Member

Choose a reason for hiding this comment

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

yes that's ok then, the integTest/docTests should be fixed when 2.4 is out, then this can be changed to support other platforms

Copy link
Member Author

@vamsimanohar vamsimanohar Oct 27, 2022

Choose a reason for hiding this comment

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

Created an issue for supporting mac/windows os types. #982

@vamsimanohar vamsimanohar force-pushed the show-catalogs-integ-tests-docs branch 5 times, most recently from 9981c5f to 89b65a6 Compare October 27, 2022 08:39
@codecov-commenter
Copy link

codecov-commenter commented Oct 27, 2022

Codecov Report

Merging #977 (1fe3c91) into 2.x (cacdb1b) will decrease coverage by 34.79%.
The diff coverage is n/a.

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

@@              Coverage Diff              @@
##                2.x     #977       +/-   ##
=============================================
- Coverage     97.55%   62.76%   -34.80%     
=============================================
  Files           303       10      -293     
  Lines          7815      658     -7157     
  Branches        507      119      -388     
=============================================
- Hits           7624      413     -7211     
- Misses          190      192        +2     
- Partials          1       53       +52     
Flag Coverage Δ
query-workbench 62.76% <ø> (?)
sql-engine ?

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
...arch/sql/expression/aggregation/MaxAggregator.java
...arch/sql/planner/physical/collector/Collector.java
...rg/opensearch/sql/data/model/ExprIntegerValue.java
...rch/sql/data/utils/NullsLastExprValueOrdering.java
...ensearch/sql/planner/physical/PhysicalPlanDSL.java
...search/sql/opensearch/security/SecurityAccess.java
.../org/opensearch/sql/planner/logical/LogicalAD.java
...search/sql/expression/datetime/CalendarLookup.java
...rch/sql/opensearch/setting/OpenSearchSettings.java
...n/java/org/opensearch/sql/utils/OperatorUtils.java
... and 303 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

@vamsimanohar vamsimanohar force-pushed the show-catalogs-integ-tests-docs branch 3 times, most recently from 1fe3c91 to b2bbe38 Compare October 27, 2022 08:55
@vamsimanohar vamsimanohar marked this pull request as ready for review October 27, 2022 09:13
@vamsimanohar vamsimanohar requested a review from a team as a code owner October 27, 2022 09:13
@vamsimanohar vamsimanohar linked an issue Oct 27, 2022 that may be closed by this pull request
@vamsimanohar vamsimanohar force-pushed the show-catalogs-integ-tests-docs branch from b2bbe38 to d513fc5 Compare October 27, 2022 18:12
@dai-chen dai-chen added documentation Improvements or additions to documentation PPL Piped processing language labels Oct 27, 2022
@vamsimanohar vamsimanohar added the v2.4.0 'Issues and PRs related to version v2.4.0' label Oct 27, 2022
task startPrometheus(type: SpawnProcessTask) {
doFirst {
download.run {
src 'https://github.com/prometheus/prometheus/releases/download/v2.39.1/prometheus-2.39.1.linux-amd64.tar.gz'
Copy link
Member

Choose a reason for hiding this comment

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

should this test be optional? I assume it won't work on arm64 and windows/mac

}
copy {
from "$projectDir/bin/prometheus.yml"
into "$projectDir/bin/prometheus-2.39.1.linux-amd64/prometheus"
Copy link
Member

Choose a reason for hiding this comment

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

minor issue, maybe rename prometheus-<version>.<platform>-<arch> to prometheus so the directory name is fixed? or bin/prometheus-*, not sure if * is supported

Copy link
Member Author

Choose a reason for hiding this comment

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

tar file gets unzipped into prometheus-2.39.1.linux-amd64. Need to introduce an unnecessary copy step in between to prometheus.

prometheus-2.39.1.linux-amd64 will remain for sometime. I don't have plans to change this in near term. If one changes the tar link, he can make change to folder name as well.

Copy link
Member

Choose a reason for hiding this comment

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

seems there's no easy way to do --strip-component in gradle.. this needs to change when other platforms support is added, i think it's ok to change then, maybe use a constant

docs/user/ppl/cmd/showcatalogs.rst Outdated Show resolved Hide resolved
Signed-off-by: Vamsi Manohar <reddyvam@amazon.com>
@vamsimanohar vamsimanohar force-pushed the show-catalogs-integ-tests-docs branch from d513fc5 to 69bfc64 Compare October 27, 2022 21:48
@vamsimanohar vamsimanohar merged commit b843639 into opensearch-project:2.x Oct 27, 2022
vamsimanohar added a commit to vamsimanohar/sql that referenced this pull request Oct 28, 2022
Signed-off-by: Vamsi Manohar <reddyvam@amazon.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation PPL Piped processing language v2.4.0 'Issues and PRs related to version v2.4.0'
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Implement catalog functionality
4 participants