better fake_api test according to new feature and naming rule

example/fake_api/bottle_api.py

@@ -51,6 +51,24 @@ class BottleController(object):
         }
 
     @hapic.with_api_doc()
+    @hapic.output_body(UserSchema(
+        many=True,
+        only=('id', 'username', 'display_name', 'company')
+    ))
+    def get_users2(self):
+        """
+        Obtain users list.
+        """
+        return [
+            {
+                'id': 4,
+                'username': 'some_user',
+                'display_name': 'Damien Accorsi',
+                'company': 'Algoo',
+            }
+        ]
+
+    @hapic.with_api_doc()
     @hapic.input_path(UserPathSchema())
     @hapic.output_body(UserSchema())
     def get_user(self, id, hapic_data: HapicData):
@@ -99,6 +117,7 @@ class BottleController(object):
     def bind(self, app:bottle.Bottle):
         app.route('/about', callback=self.about)
         app.route('/users', callback=self.get_users)
+        app.route('/users2', callback=self.get_users2)
         app.route('/users/<id>', callback=self.get_user)
         app.route('/users/', callback=self.add_user,  method='POST')
         app.route('/users/<id>', callback=self.del_user, method='DELETE')

example/fake_api/flask_api.py

@@ -49,6 +49,24 @@ class FlaskController(object):
         }
 
     @hapic.with_api_doc()
+    @hapic.output_body(UserSchema(
+        many=True,
+        only=('id', 'username', 'display_name', 'company')
+    ))
+    def get_users2(self):
+        """
+        Obtain users list.
+        """
+        return [
+            {
+                'id': 4,
+                'username': 'some_user',
+                'display_name': 'Damien Accorsi',
+                'company': 'Algoo',
+            }
+        ]
+
+    @hapic.with_api_doc()
     @hapic.input_path(UserPathSchema())
     @hapic.output_body(UserSchema())
     def get_user(self, id, hapic_data: HapicData):
@@ -104,6 +122,8 @@ class FlaskController(object):
                          view_func=self.about)
         app.add_url_rule('/users',
                          view_func=self.get_users)
+        app.add_url_rule('/users2',
+                         view_func=self.get_users2)
         app.add_url_rule('/users/<id>',
                          view_func=self.get_user)
         app.add_url_rule('/users/',
@@ -113,6 +133,7 @@ class FlaskController(object):
                          view_func=self.del_user,
                          methods=['DELETE'])
 
+
 if __name__ == "__main__":
     app = flask.Flask(__name__)
     controllers = FlaskController()

example/fake_api/pyramid_api.py

@@ -49,6 +49,24 @@ class PyramidController(object):
         }
 
     @hapic.with_api_doc()
+    @hapic.output_body(UserSchema(
+        many=True,
+        only=('id', 'username', 'display_name', 'company')
+    ))
+    def get_users2(self, context, request):
+        """
+        Obtain users list.
+        """
+        return [
+            {
+                'id': 4,
+                'username': 'some_user',
+                'display_name': 'Damien Accorsi',
+                'company': 'Algoo',
+            }
+        ]
+
+    @hapic.with_api_doc()
     @hapic.input_path(UserPathSchema())
     @hapic.output_body(UserSchema())
     def get_user(self, context, request, hapic_data: HapicData):
@@ -101,6 +119,9 @@ class PyramidController(object):
         configurator.add_route('get_users', '/users', request_method='GET')  # nopep8
         configurator.add_view(self.get_users, route_name='get_users', renderer='json')  # nopep8
 
+        configurator.add_route('get_users2', '/users2', request_method='GET')  # nopep8
+        configurator.add_view(self.get_users2, route_name='get_users2', renderer='json')  # nopep8
+
         configurator.add_route('get_user', '/users/{id}', request_method='GET')  # nopep8
         configurator.add_view(self.get_user, route_name='get_user', renderer='json')  # nopep8
 

tests/func/fake_api/common.py

@@ -1,4 +1,6 @@
 from collections import OrderedDict
+
+
 SWAGGER_DOC_API = {
  'definitions': {
      'AboutResponseSchema': {'properties': {
@@ -13,7 +15,7 @@ SWAGGER_DOC_API = {
                                         'minimum': 0,
                                         'type': 'integer'},
                             'items': {
-                                'items': {'$ref': '#/definitions/UserSchema'},
+                                'items': {'$ref': '#/definitions/UserSchema_without_email_address_first_name_last_name'},
                                 'type': 'array'},
                             'pagination': {'$ref': '#/definitions/PaginationSchema'}},
                          'required': ['item_nb'],
@@ -41,10 +43,27 @@ SWAGGER_DOC_API = {
                                  'id',
                                  'last_name',
                                  'username'],
-                    'type': 'object'}},
- 'info': {'description': 'just an example of hapic API',
-          'title': 'Fake API',
-          'version': '1.0.0'},
+                    'type': 'object'},
+    'UserSchema_without_id': {
+        'properties': {
+            'username': {'type': 'string'},
+            'display_name': {'type': 'string'},
+            'company': {'type': 'string'},
+            'last_name': {'type': 'string'},
+            'email_address': {'format': 'email', 'type': 'string'},
+            'first_name': {'type': 'string'}},
+        'required': ['company', 'display_name', 'email_address', 'first_name',
+                     'last_name', 'username'], 'type': 'object'},
+    'UserSchema_without_email_address_first_name_last_name': {
+        'properties': {
+            'username': {'type': 'string'},
+            'id': {'format': 'int32', 'type': 'integer'},
+            'company': {'type': 'string'},
+            'display_name': {'type': 'string'}},
+        'required': ['company', 'display_name', 'id', 'username'], 'type': 'object'
+    },
+    },
+ 'info': {'description': 'just an example of hapic API', 'title': 'Fake API', 'version': '1.0.0'},
  'parameters': {},
  'paths': OrderedDict(
      [('/about', {
@@ -83,10 +102,20 @@ SWAGGER_DOC_API = {
              'description': 'Add new user',
              'parameters': [{'in': 'body',
                              'name': 'body',
-                             'schema': {'$ref': '#/definitions/UserSchema'}}],
+                             'schema': {'$ref': '#/definitions/UserSchema_without_id'}}],
              'responses': {200: {
                  'description': '200',
-                 'schema': {'$ref': '#/definitions/UserSchema'}}}}})]),
+                 'schema': {'$ref': '#/definitions/UserSchema'}}}}}),
+      ( '/users2', {
+          'get': {
+              'description': 'Obtain users list.',
+              'responses': {200: {
+                  'description': '200',
+                  'schema': {'type': 'array',
+                             'items': {'$ref': '#/definitions/UserSchema_without_email_address_first_name_last_name'}
+                             }
+          }}}}
+        )]),
  'swagger': '2.0',
  'tags': []
 }

tests/func/fake_api/test_fake_api.py

@@ -1,25 +1,68 @@
+import pytest
+from flask import Flask
+from pyramid.config import Configurator
 from webtest import TestApp
 from bottle import Bottle
 
+from example.fake_api.flask_api import FlaskController
+from example.fake_api.pyramid_api import PyramidController
 from hapic.ext.bottle import BottleContext
 from example.fake_api.bottle_api import BottleController
+from hapic.ext.flask import FlaskContext
+from hapic.ext.pyramid import PyramidContext
 from tests.func.fake_api.common import SWAGGER_DOC_API
-from example.fake_api.bottle_api import hapic
 
 
-def test_func_bottle_fake_api():
+def get_bottle_context():
+    from example.fake_api.bottle_api import hapic as h
     bottle_app = Bottle()
+    h.reset_context()
+    h.set_context(BottleContext(bottle_app))
     controllers = BottleController()
     controllers.bind(bottle_app)
+    return {
+        'hapic': h,
+        'app': bottle_app,
+    }
+
+
+def get_flask_context():
+    from example.fake_api.flask_api import hapic as h
+    flask_app = Flask(__name__)
+    controllers = FlaskController()
+    controllers.bind(flask_app)
+    h.reset_context()
+    h.set_context(FlaskContext(flask_app))
+    return {
+        'hapic': h,
+        'app': flask_app,
+    }
+
+
+def get_pyramid_context():
+    from example.fake_api.pyramid_api import hapic as h
+    configurator = Configurator(autocommit=True)
+    controllers = PyramidController()
+    controllers.bind(configurator)
+    h.reset_context()
+    h.set_context(PyramidContext(configurator))
+    pyramid_app = configurator.make_wsgi_app()
+    return {
+        'hapic': h,
+        'app': pyramid_app,
+    }
 
-    hapic.set_context(BottleContext(bottle_app))
-    app = TestApp(bottle_app)
-    doc = hapic.generate_doc(
-        title='Fake API',
-        description='just an example of hapic API'
-    )
 
-    assert doc == SWAGGER_DOC_API
+@pytest.mark.parametrize('context',
+                         [
+                             get_bottle_context(),
+                             get_flask_context(),
+                             get_pyramid_context()
+                         ])
+def test_func__test_fake_api_endpoints_ok__all_framework(context):
+    hapic = context['hapic']
+    app = context['app']
+    app = TestApp(app)
     resp = app.get('/about')
     assert resp.status_int == 200
     assert resp.json == {'datetime': '2017-12-07T10:55:08.488996+00:00',
@@ -44,6 +87,17 @@ def test_func_bottle_fake_api():
         'item_nb': 1,
     }
 
+    resp = app.get('/users2')
+    assert resp.status_int == 200
+    assert resp.json == [
+        {
+           'username': 'some_user',
+           'id': 4,
+           'display_name': 'Damien Accorsi',
+           'company': 'Algoo'
+        }
+    ]
+
     resp = app.get('/users/1')
     assert resp.status_int == 200
     assert resp.json == {
@@ -93,3 +147,46 @@ def test_func_bottle_fake_api():
     resp = app.delete('/users/1', status='*')
     assert resp.status_int == 204
 
+
+@pytest.mark.parametrize('context',
+                         [
+                             get_bottle_context(),
+                             get_flask_context(),
+                             get_pyramid_context()
+                         ])
+def test_func__test_fake_api_doc_ok__all_framework(context):
+    hapic = context['hapic']
+    app = context['app']
+    app = TestApp(app)
+    doc = hapic.generate_doc(
+        title='Fake API',
+        description='just an example of hapic API'
+    )
+
+    assert doc['info'] == SWAGGER_DOC_API['info']
+    assert doc['tags'] == SWAGGER_DOC_API['tags']
+    assert doc['swagger'] == SWAGGER_DOC_API['swagger']
+    assert doc['parameters'] == SWAGGER_DOC_API['parameters']
+    assert doc['paths']['/about'] == SWAGGER_DOC_API['paths']['/about']
+    assert doc['paths']['/users'] == SWAGGER_DOC_API['paths']['/users']
+    assert doc['paths']['/users/{id}'] == SWAGGER_DOC_API['paths']['/users/{id}']
+    assert doc['paths']['/users/'] == SWAGGER_DOC_API['paths']['/users/']
+    assert doc['paths']['/users2'] == SWAGGER_DOC_API['paths']['/users2']
+
+    assert doc['definitions']['AboutResponseSchema'] == \
+           SWAGGER_DOC_API['definitions']['AboutResponseSchema']
+    assert doc['definitions']['ListsUserSchema'] == \
+           SWAGGER_DOC_API['definitions']['ListsUserSchema']
+    assert doc['definitions']['NoContentSchema'] == \
+           SWAGGER_DOC_API['definitions']['NoContentSchema']
+    assert doc['definitions']['PaginationSchema'] == \
+           SWAGGER_DOC_API['definitions']['PaginationSchema']
+    assert doc['definitions']['UserSchema'] == \
+           SWAGGER_DOC_API['definitions']['UserSchema']
+    assert doc['definitions']['UserSchema'] == \
+           SWAGGER_DOC_API['definitions']['UserSchema']
+
+    assert doc['definitions']['UserSchema_without_id'] == \
+           SWAGGER_DOC_API['definitions']['UserSchema_without_id']
+    assert doc['definitions']['UserSchema_without_email_address_first_name_last_name'] == \
+           SWAGGER_DOC_API['definitions']['UserSchema_without_email_address_first_name_last_name']