From 8c7b059f9a995c39db0336bee0588c8cafaf9cd4 Mon Sep 17 00:00:00 2001 From: Qingping Hou <qph@scribd.com> Date: Thu, 8 Aug 2019 11:49:49 -0700 Subject: [PATCH] [Docs] add missing instructions for python client tests --- CONTRIBUTING.md | 7 +++++++ docs/contributing.md | 7 +++++++ 2 files changed, 14 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 657560a7458..c2a138c02e7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -93,6 +93,13 @@ To test the templates, please perform the following: To start the CI tests, you can run `mvn verify -Psamples` (assuming you've all the required tools installed to run tests for different languages) or you can leverage http://travis-ci.org to run the CI tests by adding your own openapi-generator repository. +Note, you need to have a petstore API running locally in order to pass all tests in `PythonPetstoreClientTests`: + + ```bash +docker pull swaggerapi/petstore +docker run -d -e SWAGGER_HOST=http://petstore.swagger.io -e SWAGGER_BASE_PATH=/v2 -p 80:8080 swaggerapi/petstore +``` + ### Tips - Smaller changes are easier to review - [Optional] For bug fixes, provide a OpenAPI Spec to repeat the issue so that the reviewer can use it to confirm the fix diff --git a/docs/contributing.md b/docs/contributing.md index 1544d4b197f..18e25765810 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -97,6 +97,13 @@ To test the templates, please perform the following: To start the CI tests, you can run `mvn verify -Psamples` (assuming you've all the required tools installed to run tests for different languages) or you can leverage http://travis-ci.org to run the CI tests by adding your own openapi-generator repository. +Note, you need to have a petstore API running locally in order to pass all tests in `PythonPetstoreClientTests`: + + ```bash +docker pull swaggerapi/petstore +docker run -d -e SWAGGER_HOST=http://petstore.swagger.io -e SWAGGER_BASE_PATH=/v2 -p 80:8080 swaggerapi/petstore +``` + ### Tips - Smaller changes are easier to review - [Optional] For bug fixes, provide a OpenAPI Spec to repeat the issue so that the reviewer can use it to confirm the fix -- GitLab