Format tests

Author: Grimpy101

tests/integration/base.py

@@ -1,4 +1,3 @@
-import typing
 import unittest
 
 import flask
@@ -16,21 +15,18 @@
 
 
 def setUpModule() -> None:
-    # type: () -> None
     _create_db()
     connection = _get_connection(DB_HOST, DB_USER, DB_NAME)
     _init_schema(connection)
     connection.commit()
 
 
-def tearDownModule():
-    # type: () -> None
+def tearDownModule() -> None:
     _destory_db()
 
 
 class TestWithDatabase(unittest.TestCase):
-    def setUp(self):
-        # type: () -> None
+    def setUp(self) -> None:
         self.app = flask.Flask('test_app')
         self.app.config.update({
             'PHPBB3': {
@@ -50,30 +46,26 @@ def setUp(self):
 
         # From these lines devil is born
         @self.app.route('/')
-        def index():
-            # type: () -> typing.Any
+        def index() -> str:
             return flask.render_template_string(
                 '{{ session.user_id}},{{ session.username }}'
             )
 
         @self.app.route('/data')
-        def data():
-            # type: () -> typing.Any
+        def data() -> str:
             return flask.render_template_string(
                 '{{ session.custom_var}}'
             )
 
         @self.app.route('/data/<package>')
-        def set_data(package):
-            # type: (str) -> typing.Any
+        def set_data(package: str) -> str:
             flask.session['custom_var'] = package
             return flask.render_template_string(
                 'Done :o'
             )
 
         @self.app.route('/priv_test')
-        def test_privileges():
-            # type: () -> typing.Any
+        def test_privileges() -> str:
             return flask.render_template_string(
                 "{{ session.has_privilege('m_edit') }},"
                 "{{ session.has_privilege('m_delete') }},"
@@ -84,32 +76,33 @@ def test_privileges():
         self.ctx.push()
 
         # Init connection
-        self.connection = self.phpbb3._backend._db
-        self.cursor = self.connection.cursor()\
-            # type: psycopg2.extensions.cursor
+        self.connection: psycopg2.extensions.connection =\
+            self.phpbb3._backend._db
+        self.cursor: psycopg2.extensions.cursor = self.connection.cursor()
 
         # Setup client
         self.client = self.app.test_client()
 
-    def tearDown(self):
-        # type: () -> None
+    def tearDown(self) -> None:
         self.connection.rollback()
         self.cursor.close()
 
         self.ctx.pop()
 
 
-def _create_user(cursor):
-    # type: (psycopg2.extensions.cursor) -> None
+def _create_user(cursor: psycopg2.extensions.cursor) -> None:
     cursor.execute(
         "insert into"
         " phpbb_users (user_id, username, username_clean)"
         " values (2, 'test', 'test')"
     )
 
 
-def _create_session(cursor, session_id, user_id):
-    # type: (psycopg2.extensions.cursor, str, int) -> None
+def _create_session(
+    cursor: psycopg2.extensions.cursor,
+    session_id: str,
+    user_id: int
+) -> None:
     cursor.execute(
         "insert into"
         " phpbb_sessions (session_id, session_user_id)"
@@ -120,8 +113,11 @@ def _create_session(cursor, session_id, user_id):
     )
 
 
-def _create_privilege(cursor, privilege_id, privilege):
-    # type: (psycopg2.extensions.cursor, int, str) -> None
+def _create_privilege(
+    cursor: psycopg2.extensions.cursor,
+    privilege_id: int,
+    privilege: str
+) -> None:
     cursor.execute(
         "insert into"
         " phpbb_acl_options (auth_option_id, auth_option, is_global)"
@@ -132,8 +128,10 @@ def _create_privilege(cursor, privilege_id, privilege):
     )
 
 
-def _grant_privilege(cursor, user_id):
-    # type: (psycopg2.extensions.cursor, int) -> None
+def _grant_privilege(
+    cursor: psycopg2.extensions.cursor,
+    user_id: int
+) -> None:
     # Cryptic value to  allow only m_edit permission
     permission_set = 'HRA0HS'
     cursor.execute(
@@ -147,12 +145,11 @@ def _grant_privilege(cursor, user_id):
     )
 
 
-def _create_db():
-    # type: () -> None
+def _create_db() -> None:
     connection = _get_connection(DB_HOST, DB_ROOT_USER, DB_ROOT_USER)
     connection.set_isolation_level(0)
 
-    cursor = connection.cursor()  # type: psycopg2.extensions.cursor
+    cursor = connection.cursor()
     cursor.execute('create user {user}'.format(user=DB_USER))
     cursor.execute('create database {db_name} owner {user};'.format(
             user=DB_USER,
@@ -163,21 +160,19 @@ def _create_db():
     connection.close()
 
 
-def _init_schema(connection):
-    # type: (psycopg2.extensions.connection) -> None
+def _init_schema(connection: psycopg2.extensions.connection) -> None:
     with open('./tests/fixtures/postgres/schema.sql', 'r') as f:
         schema_sql = f.read()
-    cursor_schema = connection.cursor()  # type: psycopg2.extensions.cursor
+    cursor_schema = connection.cursor()
     cursor_schema.execute(schema_sql)
     cursor_schema.close()
 
 
-def _destory_db():
-    # type: () -> None
+def _destory_db() -> None:
     connection = _get_connection(DB_HOST, DB_ROOT_USER, DB_ROOT_USER)
     connection.set_isolation_level(0)
 
-    cursor = connection.cursor()  # type: psycopg2.extensions.cursor
+    cursor = connection.cursor()
     cursor.execute('drop database {db_name};'.format(
             db_name=DB_NAME,
         )
@@ -187,8 +182,11 @@ def _destory_db():
     connection.close()
 
 
-def _get_connection(host, user, database):
-    # type: (str, str, str) -> psycopg2.extensions.connection
+def _get_connection(
+    host: str,
+    user: str,
+    database: str
+) -> psycopg2.extensions.connection:
     connection_string = (
         'dbname={db_name}'
         ' user={user}'

tests/integration/test_extension.py

@@ -1,5 +1,7 @@
 from unittest import mock
 
+from flask_phpbb3 import PhpBB3
+
 from . import base
 
 setUpModule = base.setUpModule
@@ -8,37 +10,41 @@
 
 class TestExtension(base.TestWithDatabase):
     @mock.patch('flask_phpbb3.backends.psycopg2.Psycopg2Backend.close')
-    def test_teardown(self, mocked_close):
-        # type: (mock.Mock) -> None
+    def test_teardown(self, mocked_close: mock.Mock) -> None:
         self.ctx.pop()
         mocked_close.assert_called()
         self.ctx.push()
 
 
 class TestGetUser(base.TestWithDatabase):
-    def test_anonymous_user(self):
-        # type: () -> None
-        anonymous_user = self.app.phpbb3.get_user(user_id=1)
-        self.assertEqual(anonymous_user['username'], 'Anonymous')
-        self.assertEqual(anonymous_user['user_id'], 1)
-
-    def test_user(self):
-        # type: () -> None
+    def test_anonymous_user(self) -> None:
+        phpbb3: PhpBB3 = getattr(self.app, 'phpbb3')
+        anonymous_user = phpbb3.get_user(user_id=1)
+
+        self.assertIsNotNone(anonymous_user)
+        if anonymous_user is not None:
+            self.assertEqual(anonymous_user['username'], 'Anonymous')
+            self.assertEqual(anonymous_user['user_id'], 1)
+
+    def test_user(self) -> None:
         base._create_user(self.cursor)
 
-        user = self.app.phpbb3.get_user(user_id=2)
-        self.assertEqual(user['username'], 'test')
-        self.assertEqual(user['user_id'], 2)
+        phpbb3: PhpBB3 = getattr(self.app, 'phpbb3')
+        user = phpbb3.get_user(user_id=2)
+
+        self.assertIsNotNone(user)
+        if user is not None:
+            self.assertEqual(user['username'], 'test')
+            self.assertEqual(user['user_id'], 2)
 
-    def test_unknown_user(self):
-        # type: () -> None
-        unknown_user = self.app.phpbb3.get_user(user_id=2)
+    def test_unknown_user(self) -> None:
+        phpbb3: PhpBB3 = getattr(self.app, 'phpbb3')
+        unknown_user = phpbb3.get_user(user_id=2)
         self.assertEqual(unknown_user, None)
 
 
 class TestFetch(base.TestWithDatabase):
-    def test_paging(self):
-        # type: () -> None
+    def test_paging(self) -> None:
         base._create_privilege(self.cursor, 1, 'm_edit')
         base._create_privilege(self.cursor, 2, 'm_delete')
         base._create_privilege(self.cursor, 3, 'm_some_random')
@@ -64,30 +70,27 @@ def test_paging(self):
         }]), (3, [])]
 
         for skip in range(0, 4):
-            privilege = self.app.phpbb3.fetch_acl_options(skip=skip, limit=1)
+            phpbb3: PhpBB3 = getattr(self.app, 'phpbb3')
+            privilege = phpbb3.fetch_acl_options(skip=skip, limit=1)
             self.assertEqual((skip, privilege), expected_privileges[skip])
 
 
 class TestSession(base.TestWithDatabase):
-    def setUp(self):
-        # type: () -> None
+    def setUp(self) -> None:
         super(TestSession, self).setUp()
         self.session_id = '123'
 
-    def test_anonymous(self):
-        # type: () -> None
+    def test_anonymous(self) -> None:
         data = self.client.get('/').get_data().decode('utf-8')
         self.assertEqual(data, '1,Anonymous')
 
-    def test_invalid_session(self):
-        # type: () -> None
+    def test_invalid_session(self) -> None:
         base._create_user(self.cursor)
 
         data = self.client.get('/?sid=123').get_data().decode('utf-8')
         self.assertEqual(data, '1,Anonymous')
 
-    def test_user_by_args(self):
-        # type: () -> None
+    def test_user_by_args(self) -> None:
         base._create_user(self.cursor)
         base._create_session(self.cursor, self.session_id, 2)
 
@@ -96,22 +99,28 @@ def test_user_by_args(self):
             .decode('utf-8')
         self.assertEqual(data, '2,test')
 
-    def test_user_by_cookie(self):
-        # type: () -> None
+    def test_user_by_cookie(self) -> None:
         base._create_user(self.cursor)
         base._create_session(self.cursor, self.session_id, 2)
 
-        self.client.set_cookie('phpbb3_sid', self.session_id, domain='127.0.0.1')
+        self.client.set_cookie(
+            'phpbb3_sid',
+            self.session_id,
+            domain='127.0.0.1'
+        )
         data = self.client.get('/').get_data().decode('utf-8')
         self.assertEqual(data, '2,test')
         self.client.delete_cookie('phpbb3_sid', domain='127.0.0.1')
 
-    def test_storage(self):
-        # type: () -> None
+    def test_storage(self) -> None:
         base._create_user(self.cursor)
         base._create_session(self.cursor, self.session_id, 2)
 
-        self.client.set_cookie('phpbb3_sid', self.session_id, domain='127.0.0.1')
+        self.client.set_cookie(
+            'phpbb3_sid',
+            self.session_id,
+            domain='127.0.0.1'
+        )
         data = self.client.get('/data').get_data().decode('utf-8')
         self.assertEqual(data, '')
 
@@ -120,8 +129,7 @@ def test_storage(self):
         data = self.client.get('/data').get_data().decode('utf-8')
         self.assertEqual(data, 'something')
 
-    def test_storage_invalid_id(self):
-        # type: () -> None
+    def test_storage_invalid_id(self) -> None:
         data = self.client.get('/data').get_data().decode('utf-8')
         self.assertEqual(data, '')
 
@@ -130,8 +138,7 @@ def test_storage_invalid_id(self):
         data = self.client.get('/data').get_data().decode('utf-8')
         self.assertEqual(data, '')
 
-    def test_privilege(self):
-        # type: () -> None
+    def test_privilege(self) -> None:
         base._create_user(self.cursor)
         base._create_session(self.cursor, self.session_id, 2)
         base._create_privilege(self.cursor, 1, 'm_edit')
@@ -141,7 +148,11 @@ def test_privilege(self):
         self.assertEqual(data, 'False,False,False')
 
         # We do a login via phpbb3 :P
-        self.client.set_cookie('phpbb3_sid', self.session_id, domain='127.0.0.1')
+        self.client.set_cookie(
+            'phpbb3_sid',
+            self.session_id,
+            domain='127.0.0.1'
+        )
 
         data = self.client.get('/priv_test').get_data().decode('utf-8')
         self.assertEqual(data, 'True,False,True')