ataxya/CICD
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Convert to black formatting

Browse Source
This commit is contained in:
Alan Pryor
2019-08-03 12:55:38 -04:00
parent 9bdaa8f161
commit 9b136b1ffa
59 changed files with 512 additions and 476 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
app/other_api/__init__.py
View File

@@ -1,16 +1,16 @@
BASE_ROUTE = 'other_api'
BASE_ROUTE = "other_api"
def register_routes(api, app, root='api'):
def register_routes(api, app, root="api"):
from flask import Blueprint
from flask_restplus import Api
bp = Blueprint('other_api', __name__)
api = Api(bp, title='Another API with separate Swagger docs', version='0.1.0')
bp = Blueprint("other_api", __name__)
api = Api(bp, title="Another API with separate Swagger docs", version="0.1.0")
from .doodad.controller import api as doodad_api
from .whatsit.controller import api as whatsit_api
api.add_namespace(doodad_api, path=f'/doodad')
api.add_namespace(whatsit_api, path=f'/whatsit')
app.register_blueprint(bp, url_prefix=f'/{root}/{BASE_ROUTE}')
api.add_namespace(doodad_api, path=f"/doodad")
api.add_namespace(whatsit_api, path=f"/whatsit")
app.register_blueprint(bp, url_prefix=f"/{root}/{BASE_ROUTE}")

25
app/other_api/doodad/controller.py
View File

@@ -9,47 +9,48 @@ from .service import DoodadService
from .model import Doodad
from .interface import DoodadInterface
api = Namespace('Doodad', description='A modular namespace within Other API') # noqa
api = Namespace("Doodad", description="A modular namespace within Other API") # noqa
@api.route('/')
@api.route("/")
class DoodadResource(Resource):
'''Doodads'''
"""Doodads"""
@responds(schema=DoodadSchema, many=True)
def get(self) -> List[Doodad]:
'''Get all Doodads'''
"""Get all Doodads"""
return DoodadService.get_all()
@accepts(schema=DoodadSchema, api=api)
@responds(schema=DoodadSchema)
def post(self) -> Doodad:
'''Create a Single Doodad'''
"""Create a Single Doodad"""
return DoodadService.create(request.parsed_obj)
@api.route('/<int:doodadId>')
@api.param('doodadId', 'Doodad database ID')
@api.route("/<int:doodadId>")
@api.param("doodadId", "Doodad database ID")
class DoodadIdResource(Resource):
@responds(schema=DoodadSchema)
def get(self, doodadId: int) -> Doodad:
'''Get Single Doodad'''
"""Get Single Doodad"""
return DoodadService.get_by_id(doodadId)
def delete(self, doodadId: int) -> Response:
'''Delete Single Doodad'''
"""Delete Single Doodad"""
from flask import jsonify
print('doodadId = ', doodadId)
print("doodadId = ", doodadId)
id = DoodadService.delete_by_id(doodadId)
return jsonify(dict(status='Success', id=id))
return jsonify(dict(status="Success", id=id))
@accepts(schema=DoodadSchema, api=api)
@responds(schema=DoodadSchema)
def put(self, doodadId: int) -> Doodad:
'''Update Single Doodad'''
"""Update Single Doodad"""
changes: DoodadInterface = request.parsed_obj
Doodad = DoodadService.get_by_id(doodadId)

97
app/other_api/doodad/controller_test.py
View File

@@ -1,4 +1,3 @@
from unittest.mock import patch
from flask.testing import FlaskClient
@@ -10,75 +9,89 @@ from .interface import DoodadInterface
from .. import BASE_ROUTE
def make_doodad(id: int = 123, name: str = 'Test doodad',
purpose: str = 'Test purpose') -> Doodad:
return Doodad(
doodad_id=id, name=name, purpose=purpose
)
def make_doodad(
id: int = 123, name: str = "Test doodad", purpose: str = "Test purpose"
) -> Doodad:
return Doodad(doodad_id=id, name=name, purpose=purpose)
class TestDoodadResource:
@patch.object(DoodadService, 'get_all',
lambda: [make_doodad(123, name='Test Doodad 1'),
make_doodad(456, name='Test Doodad 2')])
@patch.object(
DoodadService,
"get_all",
lambda: [
make_doodad(123, name="Test Doodad 1"),
make_doodad(456, name="Test Doodad 2"),
],
)
def test_get(self, client: FlaskClient): # noqa
with client:
results = client.get(f'/api/{BASE_ROUTE}/doodad',
follow_redirects=True).get_json()
expected = DoodadSchema(many=True).dump(
[make_doodad(123, name='Test Doodad 1'),
make_doodad(456, name='Test Doodad 2')]
).data
results = client.get(
f"/api/{BASE_ROUTE}/doodad", follow_redirects=True
).get_json()
expected = (
DoodadSchema(many=True)
.dump(
[
make_doodad(123, name="Test Doodad 1"),
make_doodad(456, name="Test Doodad 2"),
]
)
.data
)
for r in results:
assert r in expected
@patch.object(DoodadService, 'create',
lambda create_request: Doodad(**create_request))
@patch.object(
DoodadService, "create", lambda create_request: Doodad(**create_request)
)
def test_post(self, client: FlaskClient): # noqa
with client:
payload = dict(name='Test doodad', purpose='Test purpose')
result = client.post(f'/api/{BASE_ROUTE}/doodad/', json=payload).get_json()
expected = DoodadSchema().dump(Doodad(
name=payload['name'],
purpose=payload['purpose'],
)).data
payload = dict(name="Test doodad", purpose="Test purpose")
result = client.post(f"/api/{BASE_ROUTE}/doodad/", json=payload).get_json()
expected = (
DoodadSchema()
.dump(Doodad(name=payload["name"], purpose=payload["purpose"]))
.data
)
assert result == expected
def fake_update(doodad: Doodad, changes: DoodadInterface) -> Doodad:
# To fake an update, just return a new object
updated_Doodad = Doodad(doodad_id=doodad.doodad_id,
name=changes['name'],
purpose=changes['purpose'])
updated_Doodad = Doodad(
doodad_id=doodad.doodad_id, name=changes["name"], purpose=changes["purpose"]
)
return updated_Doodad
class TestDoodadIdResource:
@patch.object(DoodadService, 'get_by_id',
lambda id: make_doodad(id=id))
@patch.object(DoodadService, "get_by_id", lambda id: make_doodad(id=id))
def test_get(self, client: FlaskClient): # noqa
with client:
result = client.get(f'/api/{BASE_ROUTE}/doodad/123').get_json()
result = client.get(f"/api/{BASE_ROUTE}/doodad/123").get_json()
expected = Doodad(doodad_id=123)
assert result['doodadId'] == expected.doodad_id
assert result["doodadId"] == expected.doodad_id
@patch.object(DoodadService, 'delete_by_id',
lambda id: [id])
@patch.object(DoodadService, "delete_by_id", lambda id: [id])
def test_delete(self, client: FlaskClient): # noqa
with client:
result = client.delete(f'/api/{BASE_ROUTE}/doodad/123').get_json()
expected = dict(status='Success', id=[123])
result = client.delete(f"/api/{BASE_ROUTE}/doodad/123").get_json()
expected = dict(status="Success", id=[123])
assert result == expected
@patch.object(DoodadService, 'get_by_id',
lambda id: make_doodad(id=id))
@patch.object(DoodadService, 'update', fake_update)
@patch.object(DoodadService, "get_by_id", lambda id: make_doodad(id=id))
@patch.object(DoodadService, "update", fake_update)
def test_put(self, client: FlaskClient): # noqa
with client:
result = client.put(f'/api/{BASE_ROUTE}/doodad/123',
json={'name': 'New Doodad',
'purpose': 'New purpose'}).get_json()
expected = DoodadSchema().dump(
Doodad(doodad_id=123, name='New Doodad', purpose='New purpose')).data
result = client.put(
f"/api/{BASE_ROUTE}/doodad/123",
json={"name": "New Doodad", "purpose": "New purpose"},
).get_json()
expected = (
DoodadSchema()
.dump(Doodad(doodad_id=123, name="New Doodad", purpose="New purpose"))
.data
)
assert result == expected

4
app/other_api/doodad/interface_test.py
View File

@@ -5,9 +5,7 @@ from .interface import DoodadInterface
@fixture
def interface() -> DoodadInterface:
return DoodadInterface(
doodad_id=1, name='Test doodad', purpose='Test purpose'
)
return DoodadInterface(doodad_id=1, name="Test doodad", purpose="Test purpose")
def test_DoodadInterface_create(interface: DoodadInterface):

4
app/other_api/doodad/model.py
View File

@@ -5,9 +5,9 @@ from typing import Any
class Doodad(db.Model): # type: ignore
'''A snazzy Doodad'''
"""A snazzy Doodad"""
__tablename__ = 'doodad'
__tablename__ = "doodad"
doodad_id = Column(Integer(), primary_key=True)
name = Column(String(255))

4
app/other_api/doodad/model_test.py
View File

@@ -6,9 +6,7 @@ from .model import Doodad
@fixture
def doodad() -> Doodad:
return Doodad(
doodad_id=1, name='Test doodad', purpose='Test purpose'
)
return Doodad(doodad_id=1, name="Test doodad", purpose="Test purpose")
def test_Doodad_create(doodad: Doodad):

8
app/other_api/doodad/schema.py
View File

@@ -2,8 +2,8 @@ from marshmallow import fields, Schema
class DoodadSchema(Schema):
'''Doodad schema'''
"""Doodad schema"""
doodadId = fields.Number(attribute='doodad_id')
name = fields.String(attribute='name')
purpose = fields.String(attribute='purpose')
doodadId = fields.Number(attribute="doodad_id")
name = fields.String(attribute="name")
purpose = fields.String(attribute="purpose")

12
app/other_api/doodad/schema_test.py
View File

@@ -15,13 +15,11 @@ def test_DoodadSchema_create(schema: DoodadSchema):
def test_DoodadSchema_works(schema: DoodadSchema):
params: DoodadInterface = schema.load({
'doodadId': '123',
'name': 'Test doodad',
'purpose': 'Test purpose'
}).data
params: DoodadInterface = schema.load(
{"doodadId": "123", "name": "Test doodad", "purpose": "Test purpose"}
).data
doodad = Doodad(**params)
assert doodad.doodad_id == 123
assert doodad.name == 'Test doodad'
assert doodad.purpose == 'Test purpose'
assert doodad.name == "Test doodad"
assert doodad.purpose == "Test purpose"

7
app/other_api/doodad/service.py
View File

@@ -4,7 +4,7 @@ from .model import Doodad
from .interface import DoodadInterface
class DoodadService():
class DoodadService:
@staticmethod
def get_all() -> List[Doodad]:
return Doodad.query.all()
@@ -30,10 +30,7 @@ class DoodadService():
@staticmethod
def create(new_attrs: DoodadInterface) -> Doodad:
new_doodad = Doodad(
name=new_attrs['name'],
purpose=new_attrs['purpose']
)
new_doodad = Doodad(name=new_attrs["name"], purpose=new_attrs["purpose"])
db.session.add(new_doodad)
db.session.commit()

16
app/other_api/doodad/service_test.py
View File

@@ -7,8 +7,8 @@ from .interface import DoodadInterface
def test_get_all(db: SQLAlchemy): # noqa
yin: Doodad = Doodad(doodad_id=1, name='Yin', purpose='thing 1')
yang: Doodad = Doodad(doodad_id=2, name='Yang', purpose='thing 2')
yin: Doodad = Doodad(doodad_id=1, name="Yin", purpose="thing 1")
yang: Doodad = Doodad(doodad_id=2, name="Yang", purpose="thing 2")
db.session.add(yin)
db.session.add(yang)
db.session.commit()
@@ -20,21 +20,21 @@ def test_get_all(db: SQLAlchemy): # noqa
def test_update(db: SQLAlchemy): # noqa
yin: Doodad = Doodad(doodad_id=1, name='Yin', purpose='thing 1')
yin: Doodad = Doodad(doodad_id=1, name="Yin", purpose="thing 1")
db.session.add(yin)
db.session.commit()
updates: DoodadInterface = dict(name='New Doodad name')
updates: DoodadInterface = dict(name="New Doodad name")
DoodadService.update(yin, updates)
result: Doodad = Doodad.query.get(yin.doodad_id)
assert result.name == 'New Doodad name'
assert result.name == "New Doodad name"
def test_delete_by_id(db: SQLAlchemy): # noqa
yin: Doodad = Doodad(doodad_id=1, name='Yin', purpose='thing 1')
yang: Doodad = Doodad(doodad_id=2, name='Yang', purpose='thing 2')
yin: Doodad = Doodad(doodad_id=1, name="Yin", purpose="thing 1")
yang: Doodad = Doodad(doodad_id=2, name="Yang", purpose="thing 2")
db.session.add(yin)
db.session.add(yang)
db.session.commit()
@@ -50,7 +50,7 @@ def test_delete_by_id(db: SQLAlchemy): # noqa
def test_create(db: SQLAlchemy): # noqa
yin: DoodadInterface = dict(name='Fancy new doodad', purpose='Fancy new purpose')
yin: DoodadInterface = dict(name="Fancy new doodad", purpose="Fancy new purpose")
DoodadService.create(yin)
results: List[Doodad] = Doodad.query.all()

99
app/other_api/whatsit/controller_test.py
View File

@@ -1,4 +1,3 @@
from unittest.mock import patch
from flask.testing import FlaskClient
@@ -10,75 +9,91 @@ from .interface import WhatsitInterface
from .. import BASE_ROUTE
def make_whatsit(id: int = 123, name: str = 'Test whatsit',
purpose: str = 'Test purpose') -> Whatsit:
return Whatsit(
whatsit_id=id, name=name, purpose=purpose
)
def make_whatsit(
id: int = 123, name: str = "Test whatsit", purpose: str = "Test purpose"
) -> Whatsit:
return Whatsit(whatsit_id=id, name=name, purpose=purpose)
class TestWhatsitResource:
@patch.object(WhatsitService, 'get_all',
lambda: [make_whatsit(123, name='Test Whatsit 1'),
make_whatsit(456, name='Test Whatsit 2')])
@patch.object(
WhatsitService,
"get_all",
lambda: [
make_whatsit(123, name="Test Whatsit 1"),
make_whatsit(456, name="Test Whatsit 2"),
],
)
def test_get(self, client: FlaskClient): # noqa
with client:
results = client.get(f'/api/{BASE_ROUTE}/whatsit',
follow_redirects=True).get_json()
expected = WhatsitSchema(many=True).dump(
[make_whatsit(123, name='Test Whatsit 1'),
make_whatsit(456, name='Test Whatsit 2')]
).data
results = client.get(
f"/api/{BASE_ROUTE}/whatsit", follow_redirects=True
).get_json()
expected = (
WhatsitSchema(many=True)
.dump(
[
make_whatsit(123, name="Test Whatsit 1"),
make_whatsit(456, name="Test Whatsit 2"),
]
)
.data
)
for r in results:
assert r in expected
@patch.object(WhatsitService, 'create',
lambda create_request: Whatsit(**create_request))
@patch.object(
WhatsitService, "create", lambda create_request: Whatsit(**create_request)
)
def test_post(self, client: FlaskClient): # noqa
with client:
payload = dict(name='Test whatsit', purpose='Test purpose')
result = client.post(f'/api/{BASE_ROUTE}/whatsit/', json=payload).get_json()
expected = WhatsitSchema().dump(Whatsit(
name=payload['name'],
purpose=payload['purpose'],
)).data
payload = dict(name="Test whatsit", purpose="Test purpose")
result = client.post(f"/api/{BASE_ROUTE}/whatsit/", json=payload).get_json()
expected = (
WhatsitSchema()
.dump(Whatsit(name=payload["name"], purpose=payload["purpose"]))
.data
)
assert result == expected
def fake_update(whatsit: Whatsit, changes: WhatsitInterface) -> Whatsit:
# To fake an update, just return a new object
updated_Whatsit = Whatsit(whatsit_id=whatsit.whatsit_id,
name=changes['name'],
purpose=changes['purpose'])
updated_Whatsit = Whatsit(
whatsit_id=whatsit.whatsit_id, name=changes["name"], purpose=changes["purpose"]
)
return updated_Whatsit
class TestWhatsitIdResource:
@patch.object(WhatsitService, 'get_by_id',
lambda id: make_whatsit(id=id))
@patch.object(WhatsitService, "get_by_id", lambda id: make_whatsit(id=id))
def test_get(self, client: FlaskClient): # noqa
with client:
result = client.get(f'/api/{BASE_ROUTE}/whatsit/123').get_json()
result = client.get(f"/api/{BASE_ROUTE}/whatsit/123").get_json()
expected = Whatsit(whatsit_id=123)
assert result['whatsitId'] == expected.whatsit_id
assert result["whatsitId"] == expected.whatsit_id
@patch.object(WhatsitService, 'delete_by_id',
lambda id: [id])
@patch.object(WhatsitService, "delete_by_id", lambda id: [id])
def test_delete(self, client: FlaskClient): # noqa
with client:
result = client.delete(f'/api/{BASE_ROUTE}/whatsit/123').get_json()
expected = dict(status='Success', id=[123])
result = client.delete(f"/api/{BASE_ROUTE}/whatsit/123").get_json()
expected = dict(status="Success", id=[123])
assert result == expected
@patch.object(WhatsitService, 'get_by_id',
lambda id: make_whatsit(id=id))
@patch.object(WhatsitService, 'update', fake_update)
@patch.object(WhatsitService, "get_by_id", lambda id: make_whatsit(id=id))
@patch.object(WhatsitService, "update", fake_update)
def test_put(self, client: FlaskClient): # noqa
with client:
result = client.put(f'/api/{BASE_ROUTE}/whatsit/123',
json={'name': 'New Whatsit',
'purpose': 'New purpose'}).get_json()
expected = WhatsitSchema().dump(
Whatsit(whatsit_id=123, name='New Whatsit', purpose='New purpose')).data
result = client.put(
f"/api/{BASE_ROUTE}/whatsit/123",
json={"name": "New Whatsit", "purpose": "New purpose"},
).get_json()
expected = (
WhatsitSchema()
.dump(
Whatsit(whatsit_id=123, name="New Whatsit", purpose="New purpose")
)
.data
)
assert result == expected

4
app/other_api/whatsit/interface_test.py
View File

@@ -5,9 +5,7 @@ from .interface import WhatsitInterface
@fixture
def interface() -> WhatsitInterface:
return WhatsitInterface(
whatsit_id=1, name='Test whatsit', purpose='Test purpose'
)
return WhatsitInterface(whatsit_id=1, name="Test whatsit", purpose="Test purpose")
def test_WhatsitInterface_create(interface: WhatsitInterface):

4
app/other_api/whatsit/model.py
View File

@@ -5,9 +5,9 @@ from typing import Any
class Whatsit(db.Model): # type: ignore
'''A snazzy Whatsit'''
"""A snazzy Whatsit"""
__tablename__ = 'whatsit'
__tablename__ = "whatsit"
whatsit_id = Column(Integer(), primary_key=True)
name = Column(String(255))

4
app/other_api/whatsit/model_test.py
View File

@@ -6,9 +6,7 @@ from .model import Whatsit
@fixture
def whatsit() -> Whatsit:
return Whatsit(
whatsit_id=1, name='Test whatsit', purpose='Test purpose'
)
return Whatsit(whatsit_id=1, name="Test whatsit", purpose="Test purpose")
def test_Whatsit_create(whatsit: Whatsit):

8
app/other_api/whatsit/schema.py
View File

@@ -2,8 +2,8 @@ from marshmallow import fields, Schema
class WhatsitSchema(Schema):
'''Whatsit schema'''
"""Whatsit schema"""
whatsitId = fields.Number(attribute='whatsit_id')
name = fields.String(attribute='name')
purpose = fields.String(attribute='purpose')
whatsitId = fields.Number(attribute="whatsit_id")
name = fields.String(attribute="name")
purpose = fields.String(attribute="purpose")

12
app/other_api/whatsit/schema_test.py
View File

@@ -15,13 +15,11 @@ def test_WhatsitSchema_create(schema: WhatsitSchema):
def test_WhatsitSchema_works(schema: WhatsitSchema):
params: WhatsitInterface = schema.load({
'whatsitId': '123',
'name': 'Test whatsit',
'purpose': 'Test purpose'
}).data
params: WhatsitInterface = schema.load(
{"whatsitId": "123", "name": "Test whatsit", "purpose": "Test purpose"}
).data
whatsit = Whatsit(**params)
assert whatsit.whatsit_id == 123
assert whatsit.name == 'Test whatsit'
assert whatsit.purpose == 'Test purpose'
assert whatsit.name == "Test whatsit"
assert whatsit.purpose == "Test purpose"

7
app/other_api/whatsit/service.py
View File

@@ -4,7 +4,7 @@ from .model import Whatsit
from .interface import WhatsitInterface
class WhatsitService():
class WhatsitService:
@staticmethod
def get_all() -> List[Whatsit]:
return Whatsit.query.all()
@@ -30,10 +30,7 @@ class WhatsitService():
@staticmethod
def create(new_attrs: WhatsitInterface) -> Whatsit:
new_whatsit = Whatsit(
name=new_attrs['name'],
purpose=new_attrs['purpose']
)
new_whatsit = Whatsit(name=new_attrs["name"], purpose=new_attrs["purpose"])
db.session.add(new_whatsit)
db.session.commit()

16
app/other_api/whatsit/service_test.py
View File

@@ -7,8 +7,8 @@ from .interface import WhatsitInterface
def test_get_all(db: SQLAlchemy): # noqa
yin: Whatsit = Whatsit(whatsit_id=1, name='Yin', purpose='thing 1')
yang: Whatsit = Whatsit(whatsit_id=2, name='Yang', purpose='thing 2')
yin: Whatsit = Whatsit(whatsit_id=1, name="Yin", purpose="thing 1")
yang: Whatsit = Whatsit(whatsit_id=2, name="Yang", purpose="thing 2")
db.session.add(yin)
db.session.add(yang)
db.session.commit()
@@ -20,21 +20,21 @@ def test_get_all(db: SQLAlchemy): # noqa
def test_update(db: SQLAlchemy): # noqa
yin: Whatsit = Whatsit(whatsit_id=1, name='Yin', purpose='thing 1')
yin: Whatsit = Whatsit(whatsit_id=1, name="Yin", purpose="thing 1")
db.session.add(yin)
db.session.commit()
updates: WhatsitInterface = dict(name='New Whatsit name')
updates: WhatsitInterface = dict(name="New Whatsit name")
WhatsitService.update(yin, updates)
result: Whatsit = Whatsit.query.get(yin.whatsit_id)
assert result.name == 'New Whatsit name'
assert result.name == "New Whatsit name"
def test_delete_by_id(db: SQLAlchemy): # noqa
yin: Whatsit = Whatsit(whatsit_id=1, name='Yin', purpose='thing 1')
yang: Whatsit = Whatsit(whatsit_id=2, name='Yang', purpose='thing 2')
yin: Whatsit = Whatsit(whatsit_id=1, name="Yin", purpose="thing 1")
yang: Whatsit = Whatsit(whatsit_id=2, name="Yang", purpose="thing 2")
db.session.add(yin)
db.session.add(yang)
db.session.commit()
@@ -50,7 +50,7 @@ def test_delete_by_id(db: SQLAlchemy): # noqa
def test_create(db: SQLAlchemy): # noqa
yin: WhatsitInterface = dict(name='Fancy new whatsit', purpose='Fancy new purpose')
yin: WhatsitInterface = dict(name="Fancy new whatsit", purpose="Fancy new purpose")
WhatsitService.create(yin)
results: List[Whatsit] = Whatsit.query.all()