test coverage badge Feature/test pytest coverage

.github/workflows/lint-and-test.yaml

@@ -44,6 +44,29 @@ jobs:
           uv run mypy --config-file=pyproject.toml yet_another_calendar
 
       - name: Run tests
+        working-directory: backend
         run: |
-          cd backend
-          YET_ANOTHER_CALENDAR_TUTOR_SECRET_KEY='test' uv run pytest --cov-fail-under=80 --cov=yet_another_calendar/web yet_another_calendar/tests/*
+            YET_ANOTHER_CALENDAR_TUTOR_SECRET_KEY='test' \
+            uv run pytest --junitxml=../pytest.xml \
+              --cov-report=term-missing:skip-covered \
+              --cov-fail-under=80 \
+              --cov=yet_another_calendar/web \
+              yet_another_calendar/tests/* | tee ../pytest-coverage.txt
+
+      - name: Pytest coverage comment
+        id: coverage
+        uses: MishaKav/pytest-coverage-comment@main
+        with:
+          pytest-coverage-path: ./pytest-coverage.txt
+          junitxml-path: ./pytest.xml
+          coverage-path-prefix: backend/
+
+      # - name: Update README
+      #   run: |
+      #     sed -i '/<!-- Pytest Coverage Comment:Begin -->/,/<!-- Pytest Coverage Comment:End -->/c\<!-- Pytest Coverage Comment:Begin -->\n${{ steps.coverage.outputs.coverageHtml }}\n<!-- Pytest Coverage Comment:End -->' ./backend/README.md
+
+      # - name: Commit changes
+      #   uses: stefanzweifel/git-auto-commit-action@v5
+      #   with:
+      #     commit_message: 'docs: update coverage badge'
+      #     file_pattern: backend/README.md

.gitignore

@@ -1,3 +1,6 @@
+pytest-coverage.txt
+pytest.xml
+
 .idea
 .version 
 

.vscode/launch.json

@@ -10,14 +10,15 @@
             "request": "launch",
             "module": "pytest",
             "console": "integratedTerminal",
+            "cwd": "${workspaceFolder}/backend",
             "args": [
-                "backend/yet_another_calendar/tests/"
-            ],
+                "yet_another_calendar/tests/test_lms.py"
+            ]
         },
         {
             "name": "Python debug backend (docker)",
             "request": "attach",
-            "type": "python",
+            "type": "debugpy",
             "pathMappings": [
                 {
                     "localRoot": "${workspaceFolder}/backend",

.vscode/settings.json

@@ -0,0 +1,14 @@
+{
+    "python.testing.pytestArgs": [
+        "./backend/yet_another_calendar/tests/"
+    ],
+    "python.testing.unittestEnabled": false,
+    "python.testing.pytestEnabled": true,
+
+    "ruff.configuration": "./backend/pyproject.toml",
+    "ruff.nativeServer": "on",
+
+    "mypy.dmypyExecutable": "${workspaceFolder}/backend/.venv/bin/dmypy",
+    "mypy.mypyExecutable": "${workspaceFolder}/backend/.venv/bin/mypy",
+    "mypy.configFile": "backend/pyproject.toml",
+}

backend/README.md

@@ -5,6 +5,7 @@
 [![Checked with mypy](https://www.mypy-lang.org/static/mypy_badge.svg)](https://mypy-lang.org/)
 [![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)
 
+
 [![Redis](https://img.shields.io/badge/redis-%23DD0031.svg?style=for-the-badge&logo=redis&logoColor=white&style=flat)](https://redis.io/)
 [![Docker](https://img.shields.io/badge/docker-%230db7ed.svg?style=for-the-badge&logo=docker&logoColor=white&style=flat)](https://www.docker.com/)
 [![FastAPI](https://img.shields.io/badge/FastAPI-005571?style=for-the-badge&logo=fastapi&style=flat)](https://fastapi.tiangolo.com/)

backend/generate_password_hash.py

@@ -20,34 +20,34 @@ def generate_password_hash(password: str | None = None) -> str:
     if password is None:
         password = getpass.getpass("Enter tutor password: ")
         confirm_password = getpass.getpass("Confirm password: ")
-        
+
         if password != confirm_password:
             logger.info("Passwords don't match. Please try again.")
             return generate_password_hash()
-    
+
     if len(password) < 8:
         logger.info("Password must be at least 8 characters long. Please try again.")
         if password is None:
             return generate_password_hash()
         else:
             sys.exit(1)
-    
+
     # Generate salt and hash
     salt = bcrypt.gensalt()
     password_hash = bcrypt.hashpw(password.encode('utf-8'), salt)
-    
+
     return password_hash.decode('utf-8')
 
 
 if __name__ == "__main__":
     password_arg = sys.argv[1] if len(sys.argv) > 1 else None
     hash_value = generate_password_hash(password_arg)
-    
+
     # Verify the hash works
     if password_arg:
         verification_result = bcrypt.checkpw(password_arg.encode('utf-8'), hash_value.encode('utf-8'))
         logger.info(f"Hash verification: {verification_result}")
-    
+
     logger.info("\n" + "="*50)
     logger.info("Generated password hash:")
     logger.info(hash_value)
@@ -57,4 +57,4 @@ def generate_password_hash(password: str | None = None) -> str:
     logger.info("\nFor Docker Compose (escape $ characters):")
     docker_hash = hash_value.replace("$", "$$")
     logger.info(f"YET_ANOTHER_CALENDAR_TUTOR_PASSWORD_HASH={docker_hash}")
-    logger.info("="*50)
+    logger.info("="*50)

backend/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "yet_another_calendar"
-version = "2.0.0"
+version = "2.1.0"
 description = ""
 authors = [
     { name = "Ivan Popov", email = "ma1n.py@yandex.ru" },
@@ -14,6 +14,7 @@ dependencies = [
     "environs>=14.1.1",
     "fastapi>=0.115.11",
     "fastapi-cache2>=0.2.2",
+    "flake8-import-conventions>=0.1.0",
     "httpx[http2]==0.27.2",
     "icalendar>=6.1.1",
     "loguru>=0.7.3",
@@ -36,7 +37,8 @@ dependencies = [
 dev = [
     "black>=25.1.0",
     "fakeredis>=2.27.0",
-    "mypy>=1.15.0",
+    "flake8-async>=25.7.1",
+    "mypy>=1.18.2",
     "pytest>=8.3.5",
     "pytest-asyncio>=0.25.3",
     "pytest-cov>=6.0.0",
@@ -72,14 +74,15 @@ env = [
     "YET_ANOTHER_CALENDAR_DB_BASE=yet_another_calendar_test",
 ]
 
-[ruff]
+[tool.ruff]
 target-version = "py311"
 
 lint.select = [
     "A", # prevent using keywords that clobber python builtins
     "N", # pep8-naming
     "B", # bugbear: security warnings
-    "E", # pycodestyle
+    "E", # pycodestyle errors
+    "W", # pycodestyle warnings
     "F", # pyflakes
     "ISC", # implicit string concatenation
     "UP", # alert you when better syntax is available in your python version
@@ -91,7 +94,15 @@ lint.select = [
     "COM", # flake8-logging
     "ASYNC", # flake8-async
     "ANN", # flake8-annotations
+    "C4", # flake8-comprehensions
+    "EXE", # flake8-executable
+    "FIX", # flake8-fixme
+    "ICN", # flake8-import-conventions
+    "PIE", # flake8-pie
+
     "PL", # Pylint
+    "PLE", # pylint errors
+
 ]
 lint.ignore = [
     "ANN401",
@@ -102,14 +113,14 @@ lint.ignore = [
 line-length = 119
 exclude = [
     ".venv/",
-    "yet_another_calendar/tests/*",
+    "*/tests/*",
 ]
 
-[ruff.lint.pydocstyle]
+[tool.ruff.lint.pydocstyle]
 convention = "pep257"
 ignore-decorators = ["typing.overload"]
 
-[ruff.lint.pylint]
+[tool.ruff.lint.pylint]
 allow-magic-value-types = ["int", "str", "float", "bytes"]
 
 [fastapi-template.options]