Adds API spec coverage report. #179
Conversation
dblock
requested review from
harshavamsi,
pgtgrly,
sachetalva,
nhtruong,
Xtansia and
VachaShah
as code owners
|
@nhtruong @reta thanks for the review! I plan to get opensearch-project/OpenSearch#11876 in, move contents of opensearch-project/OpenSearch#11843 into a new plugin (https://github.com/dblock/opensearch-api), publish that to Maven once 2.12 is released, and then use it from here. Stay tuned. |
dblock
force-pushed
the
api-coverage
branch
10 times, most recently
from
5d20e72 to
8d261a9
Compare
|
Update:
|
dblock
force-pushed
the
api-coverage
branch
4 times, most recently
from
8c62937 to
eec5455
Compare
Signed-off-by: dblock <[email protected]>
dblock
force-pushed
the
api-coverage
branch
7 times, most recently
from
175817a to
09e64cb
Compare
Signed-off-by: dblock <[email protected]>
Looks like https://github.com/OpenAPITools/openapi-diff supports YAML and https://kislyuk.github.io/yq/ can replace |
.github/workflows/coverage.yml
Outdated
| - name: Install API Plugin | ||
| run: | | ||
| wget https://github.com/dblock/opensearch-api/releases/download/v${{ env.OPENSEARCH_VERSION }}/opensearch-api-${{ env.OPENSEARCH_VERSION }}.0.zip | ||
| echo "FROM opensearchproject/opensearch:${{ env.OPENSEARCH_VERSION }}" >> Dockerfile | ||
| echo "ADD ./opensearch-api-${{ env.OPENSEARCH_VERSION }}.0.zip /tmp/" >> Dockerfile | ||
| echo "RUN /usr/share/opensearch/bin/opensearch-plugin install --batch file:/tmp/opensearch-api-${{ env.OPENSEARCH_VERSION }}.0.zip" >> Dockerfile | ||
| cat Dockerfile |
There was a problem hiding this comment.
Is there a particular reason to build up the Dockerfile in the workflow rather than committing it and using a build arg to pass in the opensearch version?
Also you could remove the wget and just have opensearch-plugin do the download:
ARG OPENSEARCH_VERSION=2.12.0
FROM opensearchproject/opensearch:${OPENSEARCH_VERSION}
ARG OPENSEARCH_VERSION
RUN /usr/share/opensearch/bin/opensearch-plugin \
install \
--batch \
https://github.com/dblock/opensearch-api/releases/download/v${OPENSEARCH_VERSION}/opensearch-api-${OPENSEARCH_VERSION}.0.zip
.github/workflows/coverage.yml
Outdated
| # - uses: mshick/add-pr-comment@v2 | ||
| # with: | ||
| # message: | | ||
| # API specs implemented for ${{ steps.coverage.outputs.current }}/${{ steps.coverage.outputs.total }} (${{ steps.math.outputs.percent }}%) APIs. |
There was a problem hiding this comment.
Should this be uncommented or removed?
There was a problem hiding this comment.
The workflow needs permissions which are declared as part of this workflow for this to work. I'll delete it for now.
# - uses: mshick/add-pr-comment@v2
# with:
# message: |
# API specs implemented for ${{ steps.coverage.outputs.current }}/${{ steps.coverage.outputs.total }} (${{ steps.math.outputs.percent }}%) APIs.
| run: | | ||
| docker build . --tag opensearch-with-api-plugin | ||
| docker run -d -p 9200:9200 -p 9600:9600 -e "discovery.type=single-node" -e OPENSEARCH_INITIAL_ADMIN_PASSWORD="${{ env.OPENSEARCH_INITIAL_ADMIN_PASSWORD }}" opensearch-with-api-plugin | ||
| sleep 15 |
There was a problem hiding this comment.
This sleep feels prone to causing spurious errors, but probably good enough for now
There was a problem hiding this comment.
If you have a better way to wait for service I can change it.
Signed-off-by: dblock <[email protected]>
|
@Xtansia Thanks for a thorough review. Took all your suggestions, much simpler now. |
…#3976) ### Description Coming from opensearch-project/opensearch-api-specification#179 which flags a couple of false positives because of mismatched trailing slash. ### Check List - [x] New functionality includes testing - [x] New functionality has been documented - [x] 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](https://github.com/opensearch-project/OpenSearch/blob/main/CONTRIBUTING.md#developer-certificate-of-origin). Signed-off-by: dblock <[email protected]>
Description
This report uses the API plugin from https://github.com/dblock/opensearch-api and a tool to show the difference between OpenSearch 2.12 APIs and the OpenAPI spec checked into this repo.
See output in https://github.com/opensearch-project/opensearch-api-specification/actions/runs/8104297882/job/22150630111.
The commented action code can be enabled after this is merged, otherwise it fails with a permissions error.
Issues Resolved
Part of #168.
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.