Add configuration for tox, poetry and mypy

.github/CONTRIBUTING.md

@@ -0,0 +1,34 @@
+<!-- TODO, write more about tox and poetry later -->
+
+# What you need.
+
+Install tox as mentioned [here](https://tox.wiki/en/latest/installation.html)
+
+Then install poetry as detailed [here](https://python-poetry.org/docs/#installation)
+
+
+
+## Adding a dependency
+Warning, never use pip to add a dependency. Nasty things are gonna
+happen if you ignore that advice.
+
+```
+$ poetry add yourdep yourdep2 ...
+```
+
+The command may take time due to dependency resolution sometimes, but
+if it exceeds 5 minutes it is abnormal. Usually it should be done before you notice.
+
+## Spawning a shell in the environment
+
+```
+$ poetry shell
+```
+
+You can learn more at https://python-poetry.org/docs/cli/
+
+## Running tests
+
+```
+$ tox r
+```

.github/workflows/tox.yml

@@ -18,10 +18,9 @@ jobs:
  uses: actions/setup-python@v4
  with:
  python-version: '3.x'
- - name: Install dependencies
+ - name: Install Tox
  run: |
- python -m pip install --upgrade pip
- pip install -r requirements.txt
+ python -m pip install tox
  - name: Run the tox environment
  run: |
  tox

OVERVIEW.md

@@ -13,7 +13,7 @@ Rough functionality:
  - clear (NEW)
   - Stops all running containers associated with the team
 - CTF
- - (id) -> Get CTF info 
+ - (id) -> Get CTF info
  - start
   - Check if team has already completed it
   - Only if no container is assigned to the team before

poetry.toml

@@ -0,0 +1,2 @@
+[virtualenvs]
+in-project = true

pyproject.toml

@@ -0,0 +1,59 @@
+[tool.poetry]
+name = "pwncore"
+version = "0.1.0"
+description = "The backend for an advanced CTF platform"
+authors = ["LUGVITC"]
+license = "GNU GENERAL PUBLIC LICENSE"
+readme = "README.md"
+
+[[tool.poetry.packages]]
+include = "pwncore"
+from = "src"
+
+# Format to add new packages to the wheel
+# [[tool.poetry.packages]]
+# include = "new_package_or_maybe_script?"
+# from = "src"
+
+[tool.poetry.dependencies]
+python = "^3.11"
+fastapi = "^0.104.1"
+uvicorn = "^0.24.0"
+
+[tool.poetry.group.dev.dependencies]
+mypy = "^1.6.1"
+httpx = "^0.25.1"
+pytest = "^7.4.3"
+flake8 = "^6.1.0"
+black = "^23.10.1"
+flake8-bugbear = "^23.9.16"
+
+[tool.mypy]
+python_version = 3.11
+warn_return_any = true
+warn_unreachable = true
+warn_redundant_casts = true
+warn_unused_ignores = true
+warn_unused_configs = true
+check_untyped_defs = true
+show_column_numbers = true
+show_error_codes = true
+
+enable_error_code = [
+ "ignore-without-code",
+ "truthy-bool",
+ "truthy-iterable",
+ "redundant-expr",
+ "no-any-unimported",
+ "redundant-self",
+ "type-arg"
+]
+
+pretty = true
+
+# For per file / package config
+# [[tool.mypy.overrides]]
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"

src/pwncore/__init__.py

@@ -0,0 +1,10 @@
+from fastapi import FastAPI
+
+import pwncore.docs as docs
+import pwncore.routes as routes
+
+app = FastAPI(
+ title="Pwncore", openapi_tags=docs.tags_metadata, description=docs.description
+)
+
+app.include_router(routes.router)

src/pwncore/__main__.py

@@ -0,0 +1,4 @@
+from pwncore import app # noqa
+
+# I do not trust my self to call uvicorn from here for debugging and
+# not use that in production

src/pwncore/config.py

@@ -0,0 +1,22 @@
+from __future__ import annotations
+
+import typing as t
+
+__all__ = (
+ "Config",
+ "BaseConfig",
+)
+
+
+class Config(t.Protocol):
+ development: bool
+
+
+class BaseConfig(Config):
+ __slots__ = ("development",)
+
+ def __init__(self, development: bool) -> None:
+ self.development = development
+
+
+DEV_CONFIG: t.Final[BaseConfig] = BaseConfig(True)

src/pwncore/docs.py

@@ -0,0 +1,5 @@
+from pwncore.routes import ctf, team
+
+tags_metadata = [ctf.metadata, team.metadata]
+
+description = "Example description to be edited from /docs.py"

routes/__init__.py → src/pwncore/routes/__init__.py

@@ -3,17 +3,14 @@
 from . import ctf, team
 
 # Main router (all routes go under /api)
-router = APIRouter(
- prefix="/api"
-)
+router = APIRouter(prefix="/api")
 
 # Include all the subroutes
 router.include_router(ctf.router)
 router.include_router(team.router)
 
-# Miscellaneous routes
-
 
+# Miscellaneous routes
 @router.get("/asd")
 async def a():
  return {"ASD": "asd"}

routes/ctf/__init__.py → src/pwncore/routes/ctf/__init__.py

@@ -1,26 +1,25 @@
+from __future__ import annotations
+
+from fastapi import APIRouter
+
 # Metadata at the top for instant accessibility
 metadata = {
  "name": "ctf",
- "description": "Operations related to CTF, except create and delete (those are under admin)"
+ "description": "Operations related to CTF, except"
+ "create and delete (those are under admin)",
 }
 
-from fastapi import APIRouter
-
-router = APIRouter(
- prefix="/ctf",
- tags=["ctf"]
-)
-
-from . import start
+router = APIRouter(prefix="/ctf", tags=["ctf"])
 
 # Routes that do not need a separate submodule for themselves
 
+
 @router.get("/list")
 async def ctf_list():
  # Get list of ctfs
  return [
  {"name": "Password Juggling", "ctf_id": 2243},
- {"name": "hexane", "ctf_id": 2242}
+ {"name": "hexane", "ctf_id": 2242},
  ]
 
 

routes/ctf/start.py → src/pwncore/routes/ctf/start.py

@@ -1,18 +1,20 @@
-# Both work, but routes.ctf is more clear to indicate that the router is from ctf
-# from . import router
-from routes.ctf import router
+from __future__ import annotations
+
+from pwncore.routes.ctf import router
 
 
 @router.get("/start/{ctf_id}")
-async def start_the_docker_container(ctf_id: int): # The function name is inferred for the summary
+async def start_the_docker_container(
+ ctf_id: int,
+): # The function name is inferred for the summary
  # This is a regular single-line comment.
  # Will not be displayed in the documentation.
- '''
+ """
  This is a multi-line comment, and will be displayed
  in the documentation when the route is expanded.
 
  The cool thing is that Markdown works here!
  # See, Markdown works!
  _Pretty_ **cool** right?
- '''
+ """
  return {"status": "CTF started"}

routes/team.py → src/pwncore/routes/team.py

@@ -1,15 +1,11 @@
-# Metadata at the top for instant accessibility
-metadata = {
- "name": "team",
- "description": "Operations with teams"
-}
+from __future__ import annotations
 
 from fastapi import APIRouter
 
-router = APIRouter(
- prefix="/team",
- tags=["team"]
-)
+# Metadata at the top for instant accessibility
+metadata = {"name": "team", "description": "Operations with teams"}
+
+router = APIRouter(prefix="/team", tags=["team"])
 
 
 @router.get("/list")

src/pwncore/types.py

@@ -0,0 +1,2 @@
+"""Only for type aliases and nothing else.
+"""

tests/test_login.py

@@ -1,6 +1,7 @@
 from fastapi.testclient import TestClient
 
-from app import app
+from pwncore import app
+
 client = TestClient(app)
 
 

tox.ini

@@ -1,13 +1,50 @@
+[flake8]
+max-line-length = 80
+select = C,E,F,W,B,B950
+extend-ignore = E203, E501, E704
+
 [tox]
 # TODO: Lock down on one python version to test against
-envlist = test_env
-skipsdist = true
+# DONE?
+envlist =
+ py31{1,2}
+ type
+ lint
+
 
 [testenv]
+description = run api tests
 deps =
- fastapi
- httpx
- pytest
+ fastapi
+ httpx
+ pytest
 commands = pytest
 
+[testenv:type]
+base_python = py311
+description = run type checking
+skip_install = true
+deps =
+ mypy
+commands = mypy tests/ src/ {posargs}
+
+[testenv:black]
+decription = Use black to format the code
+skip_install = true
+deps =
+ black
+commands = black src/ tests/
+
+[testenv:lint]
+decription = Lint with flake8
+skip_install = true
+deps =
+ flake8
+ flake8-bugbear
+commands = flake8 src/ tests/
+
+[testenv:debug]
+description = check if the package runs after any configuration changes, not for debugging dev changes
+commands = uvicorn pwncore:app
+
 # TODO: Add linting