Merge branch 'devdev' into feature/golony/add-dep

Author: golony6449

.github/workflows/pull-request-merge-precondition.yml

@@ -3,6 +3,10 @@ name: Pull Request Merge Precondition
 on:
   pull_request:
 
+permissions:
+  contents: read
+  pull-requests: write
+
 jobs:
   build:
     runs-on: ubuntu-latest
@@ -11,7 +15,11 @@ jobs:
         python-version: [3.8]
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
+        with:
+          persist-credentials: true # otherwise, the token used is the GITHUB_TOKEN, instead of your personal token
+          fetch-depth: 0 # otherwise, you will failed to push refs to dest repo
+
       - uses: psf/black@stable
         with:
           options: "--check --verbose --exclude migrations"
@@ -20,3 +28,19 @@ jobs:
         with:
           configuration: "--check-only --diff --profile black"
           requirementsFiles: "requirements.txt"
+
+      - name: install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements-dev.txt
+          pip install pytest-cov
+
+      - name: run pytest
+        run: |
+          pytest --junitxml=pytest.xml --cov-report=term-missing:skip-covered --cov=pyconkr ./ | tee pytest-coverage.txt
+
+      #- name: Pytest coverage comment
+      #  uses: MishaKav/pytest-coverage-comment@main
+      #  with:
+      #    pytest-coverage-path: ./pytest-coverage.txt
+      #    junitxml-path: ./pytest.xml

.gitignore

@@ -1,2 +1,160 @@
-/.idea
-/db.sqlite3
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/

README.md

@@ -10,3 +10,11 @@
   * mac
     * brew install mysql-client
 * pip install -r requirements.txt
+
+## how to run localtesting ( sqlite3 based )
+```
+# to setup pytest and requirements
+pip install -r requirements-dev.txt
+# run test
+pytest
+```

conftest.py

@@ -0,0 +1,10 @@
+import pytest
+
+
+# TODO
+# https://djangostars.com/blog/django-pytest-testing/#header17
+@pytest.fixture
+def api_client():
+    from rest_framework.test import APIClient
+
+    return APIClient()

manage.py

@@ -0,0 +1,21 @@
+import os
+
+from pyconkr.settings import *
+
+DEBUG = True
+
+ALLOWED_HOSTS += [
+    "*",
+]
+
+
+# RDS
+DATABASES = {"default": {"ENGINE": "django.db.backends.sqlite3", "NAME": ":memory:"}}
+
+# django-storages: TODO fix to in memory?
+del MEDIA_ROOT
+DEFAULT_FILE_STORAGE = "storages.backends.s3boto3.S3Boto3Storage"
+STATICFILES_STORAGE = "storages.backends.s3boto3.S3StaticStorage"
+AWS_S3_ACCESS_KEY_ID = os.getenv("AWS_S3_ACCESS_KEY_ID")
+AWS_S3_SECRET_ACCESS_KEY = os.getenv("AWS_S3_SECRET_ACCESS_KEY")
+AWS_STORAGE_BUCKET_NAME = "pyconkr-api-v2-static-dev"

pyconkr/settings-localtest.py

@@ -0,0 +1,5 @@
+[pytest]
+DJANGO_SETTINGS_MODULE = pyconkr.settings-localtest
+# -- recommended but optional:
+python_files = tests.py test_*.py *_tests.py
+addopts = --no-migrations

pytest.ini

@@ -0,0 +1,5 @@
+-r requirements.txt
+black
+isort
+pytest
+pytest-django

requirements-dev.txt

@@ -1,3 +1,26 @@
-from django.test import TestCase
+import pytest
+from django.contrib.auth import get_user_model
+
+from sponsor.models import SponsorLevel
+
+pytestmark = pytest.mark.django_db
+
+UserModel = get_user_model()
+
+
+@pytest.mark.django_db
+class TestSponsorLevelModel:
+    pytestmark = pytest.mark.django_db
+
+    def test_sponsor_level_creation_success(self):
+        assert SponsorLevel.objects.count() == 0
+        SponsorLevel.objects.create(
+            name="test",
+            desc="test desc",
+            visible=True,
+            limit=1,
+        )
+        assert SponsorLevel.objects.count() != 0
+
 
 # Create your tests here.