Merge pull request #70 from snowflake-app/lint-and-test

Author: recrsn

.github/workflows/ci.yaml

@@ -0,0 +1,24 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python 3.8
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.8
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip pipenv
+          pipenv install --deploy --system --dev
+      - name: Lint
+        run: |
+          make lint lint-tests

Makefile

@@ -0,0 +1,10 @@
+test: lint lint-tests
+	pytest tests -v
+
+lint-tests:
+	mypy tests
+	pylint --disable=duplicate-code tests
+
+lint:
+	mypy snowflake
+	pylint snowflake

Pipfile

@@ -5,6 +5,9 @@ verify_ssl = true
 
 [dev-packages]
 pytest = "*"
+mypy = "*"
+pylint = "*"
+pylint-flask-sqlalchemy = "*"
 
 [packages]
 flask = "*"

Pipfile.lock

@@ -0,0 +1,2 @@
+[mypy]
+ignore_missing_imports=true

mypy.ini

@@ -0,0 +1,39 @@
+[MASTER]
+
+fail-under = 10.0
+ignore = CVS
+
+;jobs=0
+persistent = yes
+suggestion-mode = yes
+;
+
+load-plugins =
+    pylint_flask_sqlalchemy
+
+disable =
+    missing-module-docstring,
+    missing-class-docstring,
+    missing-function-docstring,
+    too-few-public-methods
+
+output-format = colorized
+
+[DESIGN]
+max-parents = 15
+
+[VARIABLES]
+init-import = no
+
+[FORMAT]
+expected-line-ending-format = LF
+ignore-long-lines = ^\s*(# )?<?https?://\S+>?$
+indent-after-paren = 4
+indent-string = '    '
+max-line-length = 100
+max-module-lines = 1000
+single-line-class-stmt = no
+single-line-if-stmt = no
+
+[BASIC]
+good-names = e,i,j,k,q,ex,id

pylintrc

@@ -1 +1,3 @@
 from .app import app
+
+__all__ = ['app']

snowflake/__init__.py

@@ -1 +1,3 @@
-from .one_on_one import *
+from .one_on_one import can_view_one_on_one, can_delete_one_on_one
+
+__all__ = ['can_view_one_on_one', 'can_delete_one_on_one']

snowflake/acl/__init__.py

@@ -3,7 +3,8 @@
 from flask import Flask, url_for
 
 from . import filters, settings, logger
-from .controllers import api, login, register, profile, index, one_on_one, appreciation, logout, notifications
+from .controllers import api, login, register, profile, index, one_on_one, appreciation, logout, \
+    notifications
 from .db import db
 from .marshmallow import marshmallow
 from .redis import redis
@@ -46,20 +47,17 @@
 @app.context_processor
 def setup():
     def entrypoint(file: str):
-        with open(app.static_folder + "/assets/manifest.json") as f:
-            manifest = json.load(f)
+        with open(f"{app.static_folder}/assets/manifest.json") as manifest_file:
+            manifest = json.load(manifest_file)
             chunk = manifest[file]
 
             if app.debug:
                 return 'http://localhost:8080/' + chunk
-            else:
-                return url_for('static', filename='assets/' + chunk)
+
+            return url_for('static', filename='assets/' + chunk)
 
     def choose_plural(size, singular, plural):
-        if size != 1:
-            return plural
-        else:
-            return singular
+        return plural if size != 1 else singular
 
     return {
         'entrypoint': entrypoint,

snowflake/app.py

@@ -3,3 +3,11 @@
 from . import one_on_ones
 from . import token
 from . import users
+
+__all__ = [
+    'healthcheck',
+    'notifications',
+    'one_on_ones',
+    'token',
+    'users',
+]