From 066baf3c1675ff000a0ee2efc5433ec5276d52f7 Mon Sep 17 00:00:00 2001 From: Scott Williams Date: Wed, 27 Apr 2016 22:02:48 +0100 Subject: [PATCH] Update comments in generated unit test stubs --- .../main/resources/python/api_test.mustache | 15 +++++- .../main/resources/python/model_test.mustache | 15 ++++-- samples/client/petstore/python/README.md | 2 +- .../petstore/python/tests/test_animal.py | 15 ++++-- .../python/tests/test_api_response.py | 15 ++++-- .../client/petstore/python/tests/test_cat.py | 15 ++++-- .../petstore/python/tests/test_category.py | 15 ++++-- .../client/petstore/python/tests/test_dog.py | 15 ++++-- .../petstore/python/tests/test_fake_api.py | 13 ++++- .../petstore/python/tests/test_format_test.py | 15 ++++-- .../python/tests/test_model_200_response.py | 15 ++++-- .../python/tests/test_model_return.py | 15 ++++-- .../client/petstore/python/tests/test_name.py | 15 ++++-- .../petstore/python/tests/test_order.py | 15 ++++-- .../client/petstore/python/tests/test_pet.py | 15 ++++-- .../petstore/python/tests/test_pet_api.py | 48 ++++++++++++++++++- .../python/tests/test_special_model_name.py | 15 ++++-- .../petstore/python/tests/test_store_api.py | 28 ++++++++++- .../client/petstore/python/tests/test_tag.py | 15 ++++-- .../client/petstore/python/tests/test_user.py | 15 ++++-- .../petstore/python/tests/test_user_api.py | 48 ++++++++++++++++++- 21 files changed, 297 insertions(+), 82 deletions(-) diff --git a/modules/swagger-codegen/src/main/resources/python/api_test.mustache b/modules/swagger-codegen/src/main/resources/python/api_test.mustache index 78bd2062443..5f0b0ab6ecb 100644 --- a/modules/swagger-codegen/src/main/resources/python/api_test.mustache +++ b/modules/swagger-codegen/src/main/resources/python/api_test.mustache @@ -25,9 +25,12 @@ import sys import unittest import swagger_client +from swagger_client.rest import ApiException from swagger_client.apis.{{classVarName}} import {{classname}} -class {{#operations}}{{classname}}Test(unittest.TestCase): + +class {{#operations}}Test{{classname}}(unittest.TestCase): + """ {{classname}} unit test stubs """ def setUp(self): self.api = swagger_client.apis.{{classVarName}}.{{classname}}() @@ -37,7 +40,15 @@ class {{#operations}}{{classname}}Test(unittest.TestCase): {{#operation}} def test_{{operationId}}(self): + """ + Test case for {{{operationId}}} + + {{{summary}}} + """ pass {{/operation}} -{{/operations}} \ No newline at end of file +{{/operations}} + +if __name__ == '__main__': + unittest.main() \ No newline at end of file diff --git a/modules/swagger-codegen/src/main/resources/python/model_test.mustache b/modules/swagger-codegen/src/main/resources/python/model_test.mustache index af4601de696..c00a10a9b51 100644 --- a/modules/swagger-codegen/src/main/resources/python/model_test.mustache +++ b/modules/swagger-codegen/src/main/resources/python/model_test.mustache @@ -27,10 +27,12 @@ import unittest {{#models}} {{#model}} import swagger_client +from swagger_client.rest import ApiException from swagger_client.models.{{classFilename}} import {{classname}} -class {{classname}}Test(unittest.TestCase): +class Test{{classname}}(unittest.TestCase): + """ {{classname}} unit test stubs """ def setUp(self): pass @@ -38,11 +40,14 @@ class {{classname}}Test(unittest.TestCase): def tearDown(self): pass - """ - Test {{classname}} - """ def test{{classname}}(self): - self.model = swagger_client.models.{{classFilename}}.{{classname}}() + """ + Test {{classname}} + """ + model = swagger_client.models.{{classFilename}}.{{classname}}() {{/model}} {{/models}} + +if __name__ == '__main__': + unittest.main() \ No newline at end of file diff --git a/samples/client/petstore/python/README.md b/samples/client/petstore/python/README.md index d29b88be8d5..df5514aac39 100644 --- a/samples/client/petstore/python/README.md +++ b/samples/client/petstore/python/README.md @@ -5,7 +5,7 @@ This Python package is automatically generated by the [Swagger Codegen](https:// - API version: 1.0.0 - Package version: 1.0.0 -- Build date: 2016-04-27T20:52:27.297+01:00 +- Build date: 2016-04-27T22:01:43.565+01:00 - Build package: class io.swagger.codegen.languages.PythonClientCodegen ## Requirements. diff --git a/samples/client/petstore/python/tests/test_animal.py b/samples/client/petstore/python/tests/test_animal.py index 337bbec0f1b..279ed1850dd 100644 --- a/samples/client/petstore/python/tests/test_animal.py +++ b/samples/client/petstore/python/tests/test_animal.py @@ -25,10 +25,12 @@ import sys import unittest import swagger_client +from swagger_client.rest import ApiException from swagger_client.models.animal import Animal -class AnimalTest(unittest.TestCase): +class TestAnimal(unittest.TestCase): + """ Animal unit test stubs """ def setUp(self): pass @@ -36,9 +38,12 @@ class AnimalTest(unittest.TestCase): def tearDown(self): pass - """ - Test Animal - """ def testAnimal(self): - self.model = swagger_client.models.animal.Animal() + """ + Test Animal + """ + model = swagger_client.models.animal.Animal() + +if __name__ == '__main__': + unittest.main() \ No newline at end of file diff --git a/samples/client/petstore/python/tests/test_api_response.py b/samples/client/petstore/python/tests/test_api_response.py index d81daae1e9a..be73dbf373d 100644 --- a/samples/client/petstore/python/tests/test_api_response.py +++ b/samples/client/petstore/python/tests/test_api_response.py @@ -25,10 +25,12 @@ import sys import unittest import swagger_client +from swagger_client.rest import ApiException from swagger_client.models.api_response import ApiResponse -class ApiResponseTest(unittest.TestCase): +class TestApiResponse(unittest.TestCase): + """ ApiResponse unit test stubs """ def setUp(self): pass @@ -36,9 +38,12 @@ class ApiResponseTest(unittest.TestCase): def tearDown(self): pass - """ - Test ApiResponse - """ def testApiResponse(self): - self.model = swagger_client.models.api_response.ApiResponse() + """ + Test ApiResponse + """ + model = swagger_client.models.api_response.ApiResponse() + +if __name__ == '__main__': + unittest.main() \ No newline at end of file diff --git a/samples/client/petstore/python/tests/test_cat.py b/samples/client/petstore/python/tests/test_cat.py index f72e4fd3209..728a824fa5b 100644 --- a/samples/client/petstore/python/tests/test_cat.py +++ b/samples/client/petstore/python/tests/test_cat.py @@ -25,10 +25,12 @@ import sys import unittest import swagger_client +from swagger_client.rest import ApiException from swagger_client.models.cat import Cat -class CatTest(unittest.TestCase): +class TestCat(unittest.TestCase): + """ Cat unit test stubs """ def setUp(self): pass @@ -36,9 +38,12 @@ class CatTest(unittest.TestCase): def tearDown(self): pass - """ - Test Cat - """ def testCat(self): - self.model = swagger_client.models.cat.Cat() + """ + Test Cat + """ + model = swagger_client.models.cat.Cat() + +if __name__ == '__main__': + unittest.main() \ No newline at end of file diff --git a/samples/client/petstore/python/tests/test_category.py b/samples/client/petstore/python/tests/test_category.py index 1f7b1bda4d6..793fbdf41b0 100644 --- a/samples/client/petstore/python/tests/test_category.py +++ b/samples/client/petstore/python/tests/test_category.py @@ -25,10 +25,12 @@ import sys import unittest import swagger_client +from swagger_client.rest import ApiException from swagger_client.models.category import Category -class CategoryTest(unittest.TestCase): +class TestCategory(unittest.TestCase): + """ Category unit test stubs """ def setUp(self): pass @@ -36,9 +38,12 @@ class CategoryTest(unittest.TestCase): def tearDown(self): pass - """ - Test Category - """ def testCategory(self): - self.model = swagger_client.models.category.Category() + """ + Test Category + """ + model = swagger_client.models.category.Category() + +if __name__ == '__main__': + unittest.main() \ No newline at end of file diff --git a/samples/client/petstore/python/tests/test_dog.py b/samples/client/petstore/python/tests/test_dog.py index d2b5b38048b..044dc5be51f 100644 --- a/samples/client/petstore/python/tests/test_dog.py +++ b/samples/client/petstore/python/tests/test_dog.py @@ -25,10 +25,12 @@ import sys import unittest import swagger_client +from swagger_client.rest import ApiException from swagger_client.models.dog import Dog -class DogTest(unittest.TestCase): +class TestDog(unittest.TestCase): + """ Dog unit test stubs """ def setUp(self): pass @@ -36,9 +38,12 @@ class DogTest(unittest.TestCase): def tearDown(self): pass - """ - Test Dog - """ def testDog(self): - self.model = swagger_client.models.dog.Dog() + """ + Test Dog + """ + model = swagger_client.models.dog.Dog() + +if __name__ == '__main__': + unittest.main() \ No newline at end of file diff --git a/samples/client/petstore/python/tests/test_fake_api.py b/samples/client/petstore/python/tests/test_fake_api.py index a529e2c9b97..29b71bdf81a 100644 --- a/samples/client/petstore/python/tests/test_fake_api.py +++ b/samples/client/petstore/python/tests/test_fake_api.py @@ -25,9 +25,12 @@ import sys import unittest import swagger_client +from swagger_client.rest import ApiException from swagger_client.apis.fake_api import FakeApi -class FakeApiTest(unittest.TestCase): + +class TestFakeApi(unittest.TestCase): + """ FakeApi unit test stubs """ def setUp(self): self.api = swagger_client.apis.fake_api.FakeApi() @@ -36,5 +39,13 @@ class FakeApiTest(unittest.TestCase): pass def test_test_endpoint_parameters(self): + """ + Test case for test_endpoint_parameters + + Fake endpoint for testing various parameters + """ pass + +if __name__ == '__main__': + unittest.main() \ No newline at end of file diff --git a/samples/client/petstore/python/tests/test_format_test.py b/samples/client/petstore/python/tests/test_format_test.py index 07aeac49b9a..11101ad52da 100644 --- a/samples/client/petstore/python/tests/test_format_test.py +++ b/samples/client/petstore/python/tests/test_format_test.py @@ -25,10 +25,12 @@ import sys import unittest import swagger_client +from swagger_client.rest import ApiException from swagger_client.models.format_test import FormatTest -class FormatTestTest(unittest.TestCase): +class TestFormatTest(unittest.TestCase): + """ FormatTest unit test stubs """ def setUp(self): pass @@ -36,9 +38,12 @@ class FormatTestTest(unittest.TestCase): def tearDown(self): pass - """ - Test FormatTest - """ def testFormatTest(self): - self.model = swagger_client.models.format_test.FormatTest() + """ + Test FormatTest + """ + model = swagger_client.models.format_test.FormatTest() + +if __name__ == '__main__': + unittest.main() \ No newline at end of file diff --git a/samples/client/petstore/python/tests/test_model_200_response.py b/samples/client/petstore/python/tests/test_model_200_response.py index cdae133c22b..8328d2b9757 100644 --- a/samples/client/petstore/python/tests/test_model_200_response.py +++ b/samples/client/petstore/python/tests/test_model_200_response.py @@ -25,10 +25,12 @@ import sys import unittest import swagger_client +from swagger_client.rest import ApiException from swagger_client.models.model_200_response import Model200Response -class Model200ResponseTest(unittest.TestCase): +class TestModel200Response(unittest.TestCase): + """ Model200Response unit test stubs """ def setUp(self): pass @@ -36,9 +38,12 @@ class Model200ResponseTest(unittest.TestCase): def tearDown(self): pass - """ - Test Model200Response - """ def testModel200Response(self): - self.model = swagger_client.models.model_200_response.Model200Response() + """ + Test Model200Response + """ + model = swagger_client.models.model_200_response.Model200Response() + +if __name__ == '__main__': + unittest.main() \ No newline at end of file diff --git a/samples/client/petstore/python/tests/test_model_return.py b/samples/client/petstore/python/tests/test_model_return.py index 60bda8fd99e..4ff3f38b2eb 100644 --- a/samples/client/petstore/python/tests/test_model_return.py +++ b/samples/client/petstore/python/tests/test_model_return.py @@ -25,10 +25,12 @@ import sys import unittest import swagger_client +from swagger_client.rest import ApiException from swagger_client.models.model_return import ModelReturn -class ModelReturnTest(unittest.TestCase): +class TestModelReturn(unittest.TestCase): + """ ModelReturn unit test stubs """ def setUp(self): pass @@ -36,9 +38,12 @@ class ModelReturnTest(unittest.TestCase): def tearDown(self): pass - """ - Test ModelReturn - """ def testModelReturn(self): - self.model = swagger_client.models.model_return.ModelReturn() + """ + Test ModelReturn + """ + model = swagger_client.models.model_return.ModelReturn() + +if __name__ == '__main__': + unittest.main() \ No newline at end of file diff --git a/samples/client/petstore/python/tests/test_name.py b/samples/client/petstore/python/tests/test_name.py index 2e409620e48..c3b27897eb1 100644 --- a/samples/client/petstore/python/tests/test_name.py +++ b/samples/client/petstore/python/tests/test_name.py @@ -25,10 +25,12 @@ import sys import unittest import swagger_client +from swagger_client.rest import ApiException from swagger_client.models.name import Name -class NameTest(unittest.TestCase): +class TestName(unittest.TestCase): + """ Name unit test stubs """ def setUp(self): pass @@ -36,9 +38,12 @@ class NameTest(unittest.TestCase): def tearDown(self): pass - """ - Test Name - """ def testName(self): - self.model = swagger_client.models.name.Name() + """ + Test Name + """ + model = swagger_client.models.name.Name() + +if __name__ == '__main__': + unittest.main() \ No newline at end of file diff --git a/samples/client/petstore/python/tests/test_order.py b/samples/client/petstore/python/tests/test_order.py index 4a956567d1c..23beefe346c 100644 --- a/samples/client/petstore/python/tests/test_order.py +++ b/samples/client/petstore/python/tests/test_order.py @@ -25,10 +25,12 @@ import sys import unittest import swagger_client +from swagger_client.rest import ApiException from swagger_client.models.order import Order -class OrderTest(unittest.TestCase): +class TestOrder(unittest.TestCase): + """ Order unit test stubs """ def setUp(self): pass @@ -36,9 +38,12 @@ class OrderTest(unittest.TestCase): def tearDown(self): pass - """ - Test Order - """ def testOrder(self): - self.model = swagger_client.models.order.Order() + """ + Test Order + """ + model = swagger_client.models.order.Order() + +if __name__ == '__main__': + unittest.main() \ No newline at end of file diff --git a/samples/client/petstore/python/tests/test_pet.py b/samples/client/petstore/python/tests/test_pet.py index e44ce644c88..471b7b4f67c 100644 --- a/samples/client/petstore/python/tests/test_pet.py +++ b/samples/client/petstore/python/tests/test_pet.py @@ -25,10 +25,12 @@ import sys import unittest import swagger_client +from swagger_client.rest import ApiException from swagger_client.models.pet import Pet -class PetTest(unittest.TestCase): +class TestPet(unittest.TestCase): + """ Pet unit test stubs """ def setUp(self): pass @@ -36,9 +38,12 @@ class PetTest(unittest.TestCase): def tearDown(self): pass - """ - Test Pet - """ def testPet(self): - self.model = swagger_client.models.pet.Pet() + """ + Test Pet + """ + model = swagger_client.models.pet.Pet() + +if __name__ == '__main__': + unittest.main() \ No newline at end of file diff --git a/samples/client/petstore/python/tests/test_pet_api.py b/samples/client/petstore/python/tests/test_pet_api.py index e56fa6461ad..81ee6c76e9c 100644 --- a/samples/client/petstore/python/tests/test_pet_api.py +++ b/samples/client/petstore/python/tests/test_pet_api.py @@ -25,9 +25,12 @@ import sys import unittest import swagger_client +from swagger_client.rest import ApiException from swagger_client.apis.pet_api import PetApi -class PetApiTest(unittest.TestCase): + +class TestPetApi(unittest.TestCase): + """ PetApi unit test stubs """ def setUp(self): self.api = swagger_client.apis.pet_api.PetApi() @@ -36,26 +39,69 @@ class PetApiTest(unittest.TestCase): pass def test_add_pet(self): + """ + Test case for add_pet + + Add a new pet to the store + """ pass def test_delete_pet(self): + """ + Test case for delete_pet + + Deletes a pet + """ pass def test_find_pets_by_status(self): + """ + Test case for find_pets_by_status + + Finds Pets by status + """ pass def test_find_pets_by_tags(self): + """ + Test case for find_pets_by_tags + + Finds Pets by tags + """ pass def test_get_pet_by_id(self): + """ + Test case for get_pet_by_id + + Find pet by ID + """ pass def test_update_pet(self): + """ + Test case for update_pet + + Update an existing pet + """ pass def test_update_pet_with_form(self): + """ + Test case for update_pet_with_form + + Updates a pet in the store with form data + """ pass def test_upload_file(self): + """ + Test case for upload_file + + uploads an image + """ pass + +if __name__ == '__main__': + unittest.main() \ No newline at end of file diff --git a/samples/client/petstore/python/tests/test_special_model_name.py b/samples/client/petstore/python/tests/test_special_model_name.py index 1dd49228ead..17c12655031 100644 --- a/samples/client/petstore/python/tests/test_special_model_name.py +++ b/samples/client/petstore/python/tests/test_special_model_name.py @@ -25,10 +25,12 @@ import sys import unittest import swagger_client +from swagger_client.rest import ApiException from swagger_client.models.special_model_name import SpecialModelName -class SpecialModelNameTest(unittest.TestCase): +class TestSpecialModelName(unittest.TestCase): + """ SpecialModelName unit test stubs """ def setUp(self): pass @@ -36,9 +38,12 @@ class SpecialModelNameTest(unittest.TestCase): def tearDown(self): pass - """ - Test SpecialModelName - """ def testSpecialModelName(self): - self.model = swagger_client.models.special_model_name.SpecialModelName() + """ + Test SpecialModelName + """ + model = swagger_client.models.special_model_name.SpecialModelName() + +if __name__ == '__main__': + unittest.main() \ No newline at end of file diff --git a/samples/client/petstore/python/tests/test_store_api.py b/samples/client/petstore/python/tests/test_store_api.py index c22a3dc7134..e8dc0a64b1c 100644 --- a/samples/client/petstore/python/tests/test_store_api.py +++ b/samples/client/petstore/python/tests/test_store_api.py @@ -25,9 +25,12 @@ import sys import unittest import swagger_client +from swagger_client.rest import ApiException from swagger_client.apis.store_api import StoreApi -class StoreApiTest(unittest.TestCase): + +class TestStoreApi(unittest.TestCase): + """ StoreApi unit test stubs """ def setUp(self): self.api = swagger_client.apis.store_api.StoreApi() @@ -36,14 +39,37 @@ class StoreApiTest(unittest.TestCase): pass def test_delete_order(self): + """ + Test case for delete_order + + Delete purchase order by ID + """ pass def test_get_inventory(self): + """ + Test case for get_inventory + + Returns pet inventories by status + """ pass def test_get_order_by_id(self): + """ + Test case for get_order_by_id + + Find purchase order by ID + """ pass def test_place_order(self): + """ + Test case for place_order + + Place an order for a pet + """ pass + +if __name__ == '__main__': + unittest.main() \ No newline at end of file diff --git a/samples/client/petstore/python/tests/test_tag.py b/samples/client/petstore/python/tests/test_tag.py index e3b74cf0962..35b51e4d7d2 100644 --- a/samples/client/petstore/python/tests/test_tag.py +++ b/samples/client/petstore/python/tests/test_tag.py @@ -25,10 +25,12 @@ import sys import unittest import swagger_client +from swagger_client.rest import ApiException from swagger_client.models.tag import Tag -class TagTest(unittest.TestCase): +class TestTag(unittest.TestCase): + """ Tag unit test stubs """ def setUp(self): pass @@ -36,9 +38,12 @@ class TagTest(unittest.TestCase): def tearDown(self): pass - """ - Test Tag - """ def testTag(self): - self.model = swagger_client.models.tag.Tag() + """ + Test Tag + """ + model = swagger_client.models.tag.Tag() + +if __name__ == '__main__': + unittest.main() \ No newline at end of file diff --git a/samples/client/petstore/python/tests/test_user.py b/samples/client/petstore/python/tests/test_user.py index 9fe3a9cb5ec..1aad154cbf8 100644 --- a/samples/client/petstore/python/tests/test_user.py +++ b/samples/client/petstore/python/tests/test_user.py @@ -25,10 +25,12 @@ import sys import unittest import swagger_client +from swagger_client.rest import ApiException from swagger_client.models.user import User -class UserTest(unittest.TestCase): +class TestUser(unittest.TestCase): + """ User unit test stubs """ def setUp(self): pass @@ -36,9 +38,12 @@ class UserTest(unittest.TestCase): def tearDown(self): pass - """ - Test User - """ def testUser(self): - self.model = swagger_client.models.user.User() + """ + Test User + """ + model = swagger_client.models.user.User() + +if __name__ == '__main__': + unittest.main() \ No newline at end of file diff --git a/samples/client/petstore/python/tests/test_user_api.py b/samples/client/petstore/python/tests/test_user_api.py index 1d8b2f1fbd2..0205fe7383a 100644 --- a/samples/client/petstore/python/tests/test_user_api.py +++ b/samples/client/petstore/python/tests/test_user_api.py @@ -25,9 +25,12 @@ import sys import unittest import swagger_client +from swagger_client.rest import ApiException from swagger_client.apis.user_api import UserApi -class UserApiTest(unittest.TestCase): + +class TestUserApi(unittest.TestCase): + """ UserApi unit test stubs """ def setUp(self): self.api = swagger_client.apis.user_api.UserApi() @@ -36,26 +39,69 @@ class UserApiTest(unittest.TestCase): pass def test_create_user(self): + """ + Test case for create_user + + Create user + """ pass def test_create_users_with_array_input(self): + """ + Test case for create_users_with_array_input + + Creates list of users with given input array + """ pass def test_create_users_with_list_input(self): + """ + Test case for create_users_with_list_input + + Creates list of users with given input array + """ pass def test_delete_user(self): + """ + Test case for delete_user + + Delete user + """ pass def test_get_user_by_name(self): + """ + Test case for get_user_by_name + + Get user by user name + """ pass def test_login_user(self): + """ + Test case for login_user + + Logs user into the system + """ pass def test_logout_user(self): + """ + Test case for logout_user + + Logs out current logged in user session + """ pass def test_update_user(self): + """ + Test case for update_user + + Updated user + """ pass + +if __name__ == '__main__': + unittest.main() \ No newline at end of file