Merge pull request #14 from cmu-delphi/SD-27

Sd 27 tests

Author: BrainIsDead

.flake8

@@ -0,0 +1,79 @@
+name: Django Tests
+on: [pull_request, push]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    env:
+      MYSQL_ROOT_PASSWORD: mysql_root_password
+      MYSQL_DATABASE: mysql_database
+      MYSQL_USER: mysql_user
+      MYSQL_PASSWORD: mysql_password
+      MYSQL_HOST: 127.0.0.1
+      MYSQL_PORT: 3306
+
+    services:
+      mysql:
+        image: mysql:latest
+        env:
+          MYSQL_ROOT_PASSWORD: ${{ env.MYSQL_ROOT_PASSWORD }}
+          MYSQL_DATABASE: ${{ env.MYSQL_DATABASE }}
+          MYSQL_USER: ${{ env.MYSQL_USER }}
+          MYSQL_PASSWORD: ${{ env.MYSQL_PASSWORD }}
+        ports:
+          - 3306:3306
+        options: >-
+          --health-cmd="mysqladmin ping"
+          --health-interval=10s
+          --health-timeout=5s
+          --health-retries=3
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: "3.10"
+
+      - name: Install dependencies
+        run: |
+          python3 -m pip install --upgrade pip
+          sudo apt-get update -y
+          sudo apt-get install mysql-client -y
+          sudo apt-get install graphviz graphviz-dev -y
+          pip install pipenv
+          pipenv requirements > requirements.txt
+          pip install -r requirements.txt
+
+      - name: Make migrations
+        env:
+          MYSQL_ROOT_PASSWORD: ${{ env.MYSQL_ROOT_PASSWORD }}
+          MYSQL_DATABASE: ${{ env.MYSQL_DATABASE }}
+          MYSQL_USER: ${{ env.MYSQL_USER }}
+          MYSQL_PASSWORD: ${{ env.MYSQL_PASSWORD }}
+          MYSQL_HOST: 127.0.0.1
+          MYSQL_PORT: ${{ env.MYSQL_PORT }}
+
+        run: |
+          mysql -u root -p"${{ env.MYSQL_ROOT_PASSWORD }}" -e "GRANT ALL PRIVILEGES ON *.* TO '${{ env.MYSQL_USER }}'@'%';"
+          python3 ./src/manage.py migrate
+
+      - name: Run linters
+        run: |
+          pip install flake8
+          flake8 .
+
+      - name: Run tests
+        env:
+          MYSQL_ROOT_PASSWORD: ${{ env.MYSQL_ROOT_PASSWORD }}
+          MYSQL_DATABASE: ${{ env.MYSQL_DATABASE }}
+          MYSQL_USER: ${{ env.MYSQL_USER }}
+          MYSQL_PASSWORD: ${{ env.MYSQL_PASSWORD }}
+          MYSQL_HOST: ${{ env.MYSQL_HOST }}
+          MYSQL_PORT: ${{ env.MYSQL_PORT }}
+
+        run: |
+          python3 ./src/manage.py test

.github/workflows/tests.yaml

@@ -22,6 +22,11 @@ linkpreview = "*"
 django-redis = "*"
 mysqlclient = "*"
 django-import-export = "*"
+coverage = "*"
+django-coverage-plugin = "*"
+django-extensions-models = "*"
+mypy = "*"
+django-stubs = "*"
 
 [dev-packages]
 flake8 = "*"

.isort.cfg

@@ -34,6 +34,36 @@ $ python manage.py test
 $ python manage.py runserver
 ```
 
+load fixtures
+```sh
+$ python manage.py loaddata .\fixtures\available_geography.json
+$ python manage.py loaddata .\fixtures\pathogens.json
+$ python manage.py loaddata .\fixtures\signal_categories.json
+$ python manage.py loaddata .\fixtures\signal_types.json
+```
+
+if you need test coverage
+
+```sh
+$ coverage erase
+$ coverage python manage.py test
+$ coverage report
+```
+
+you can also get test coverage with one command
+```sh
+$ coverage erase && coverage run manage.py test && coverage report
+```
+
+sort imports
+```sh
+$  isort .
+```
+check flake
+```sh
+$  flake8 --show-source
+```
+
 ### To run via docker
 
 Install `Docker` and `docker-compose`

Pipfile

@@ -0,0 +1,32 @@
+[isort]
+multi_line_output=3
+force_grid_wrap = 3
+include_trailing_comma=True
+line_length=158
+
+[flake8]
+max-line-length = 158
+max-complexity = 10
+exclude =
+    .git,
+    __pycache__,
+    .env,
+    venv,
+    */migrations
+
+[mypy]
+mypy_path = src/
+files = src
+warn_return_any = True
+warn_unused_configs = True
+warn_redundant_casts = True
+warn_unused_ignores = True
+check_untyped_defs = True
+show_error_codes = True
+strict_optional = True
+ignore_missing_imports = True
+plugins =
+    mypy_django_plugin.main
+
+[mypy.plugins.django-stubs]
+django_settings_module = signal_documentation.settings

Pipfile.lock

@@ -0,0 +1,30 @@
+[run]
+plugins = django_coverage_plugin
+source = .
+branch = True
+omit =
+    *__init__*
+    *asgi.py*
+    *wsgi.py*
+    *apps.py
+    *manage.py
+    *__init__.py
+    *admin.py
+    *forms.py
+    *filters.py
+    *urls.py
+    *settings.py
+    *templates/*
+    templates/*
+    */manage.py
+    */resources.py
+    */tests/*
+    */assets/*
+    */staticfiles/*
+    */migrations/*
+
+[html]
+directory = htmlcov
+
+[report]
+fail_under = 90

README.md

@@ -1,3 +1,5 @@
+from typing import Literal
+
 from django.contrib import admin
 
 from base.models import Link
@@ -8,4 +10,4 @@ class LinkAdmin(admin.ModelAdmin):
     """
     Admin interface for managing link objects.
     """
-    list_display = ('url', 'link_type')
+    list_display: tuple[Literal['url'], Literal['link_type']] = ('url', 'link_type')