Implements environment route tests

.github/workflows/pylint.yml

@@ -21,4 +21,4 @@ jobs:
  pip install -r requirements.txt
  - name: Analysing the code with pylint
  run: |
- pylint -d C0200,C0301,C0114,R0903,C0115,W0246,R0914,C0209,E1121,C0103,C2801,R0801,E1101,E0401,E0611,R0911,C0116,W0212,W0719,W0601,W1203,W0123,W0511 $(git ls-files '*.py')
+ pylint -d C0200,C0301,C0114,R0903,C0115,W0246,R0914,C0209,E1121,C0103,C2801,R0801,E1101,E0401,E0611,R0911,C0116,W0212,W0719,W0601,W1203,W0123,W0511,W0621 $(git ls-files '*.py')

Makefile

@@ -1,13 +1,23 @@
-black:
-	black ./lib
+format: black flake8 pylint ruff
 
-lint: flake8 pylint
+black:
+	black ./lib || true
+	black ./tests || true
 
 flake8:
-	flake8 --ignore E501,E402,F401,W503 ./lib
+	flake8 --ignore E501,E402,F401,W503,C0414 ./lib || true
+	flake8 --ignore E501,E402,F401,W503,C0414 ./tests || true
 
 pylint:
-	pylint --extension-pkg-whitelist='pydantic' ./lib/*
+	pylint --extension-pkg-whitelist='pydantic' ./lib || true
+	pylint --extension-pkg-whitelist='pydantic' --disable=E0401,W0621 ./tests || true
+
+ruff:
+	ruff check --fix ./lib || true
+	ruff check --fix ./tests || true
+
+test:
+	python3 -m pytest .
 
 dev:
 	python3 -m uvicorn lib:app --reload --port 3000
@@ -19,3 +29,5 @@ clean:
 
 build:
 	docker build -t infinity-api . --no-cache
+
+.PHONY: black flake8 pylint test dev clean build ruff format

README.md

@@ -10,9 +10,10 @@
 - Install dependencies `python3 -m pip install -r requirements.txt`
 
 ## Development
-- black ./lib
-- pylint --extension-pkg-whitelist='pydantic' ./lib/*
-- flake8 --ignore E501,E402,F401,W503 ./lib
+- make format
+- make test
+- make clean
+- make build
 
 ## Starting the server
 - Setup MONGODB_CONNECTION_STRING:

lib/__init__.py

@@ -25,4 +25,6 @@ def parse_error(error):
  return f"{exc_type}: {exc_obj}"
 
 
-from lib.api import app # pylint: disable=wrong-import-position,cyclic-import
+from lib.api import ( # pylint: disable=wrong-import-position,cyclic-import,useless-import-alias
+ app as app,
+)

lib/controllers/environment.py

@@ -27,26 +27,16 @@ class EnvController:
  - CRUD operations over models.Env on the database
  """
 
- def __init__(self, env: Env):
- self._env = env
-
- @property
- def env(self) -> Env:
- return self._env
-
- @env.setter
- def env(self, env: Env):
- self._env = env
-
- async def create_env(self) -> Union[EnvCreated, HTTPException]:
+ @staticmethod
+ async def create_env(env: Env) -> Union[EnvCreated, HTTPException]:
  """
  Create a env in the database.
 
  Returns:
  views.EnvCreated
  """
  try:
- async with EnvRepository(self.env) as env_repo:
+ async with EnvRepository(env) as env_repo:
  await env_repo.create_env()
  except PyMongoError as e:
  logger.error(
@@ -157,8 +147,9 @@ async def get_rocketpy_env_binary(
  f"Call to controllers.environment.get_rocketpy_env_binary completed for Env {env_id}"
  )
 
+ @staticmethod
  async def update_env_by_id(
-self, env_id: str
+ env_id: str, env: Env
  ) -> Union[EnvUpdated, HTTPException]:
  """
  Update a models.Env in the database.
@@ -173,7 +164,7 @@ async def update_env_by_id(
  HTTP 404 Not Found: If the env is not found in the database.
  """
  try:
- async with EnvRepository(self.env) as env_repo:
+ async with EnvRepository(env) as env_repo:
  await env_repo.update_env_by_id(env_id)
  except PyMongoError as e:
  logger.error(

lib/routes/environment.py

@@ -36,7 +36,7 @@ async def create_env(env: Env) -> EnvCreated:
  ``` models.Env JSON ```
  """
  with tracer.start_as_current_span("create_env"):
- return await EnvController(env).create_env()
+ return await EnvController.create_env(env)
 
 
 @router.get("/{env_id}")
@@ -63,11 +63,11 @@ async def update_env(env_id: str, env: Env) -> EnvUpdated:
  ```
  """
  with tracer.start_as_current_span("update_env"):
- return await EnvController(env).update_env_by_id(env_id)
+ return await EnvController.update_env_by_id(env_id, env)
 
 
 @router.get(
- "/rocketpy/{env_id}",
+ "/{env_id}/rocketpy",
  responses={
  203: {
  "description": "Binary file download",
@@ -118,4 +118,4 @@ async def delete_env(env_id: str) -> EnvDeleted:
  ``` env_id: str ```
  """
  with tracer.start_as_current_span("delete_env"):
- return await EnvController(env_id).delete_env_by_id(env_id)
+ return await EnvController.delete_env_by_id(env_id)

pyproject.toml

@@ -1,15 +1,7 @@
-[build-system]
-requires = ["setuptools", "setuptools_scm"]
-build-backend = "setuptools.build_meta"
-
-[tool.setuptools.dynamic]
-dependencies = {file = ["requirements.txt"]}
-
 [project]
 name = "Infinity-API"
-version = "2.2.0"
+version = "2.3.0"
 description = "RESTFULL open API for rocketpy"
-dynamic = ["dependencies"]
 requires-python = ">=3.12"
 authors = [
  {name = "Gabriel Barberini", email = "gabrielbarberinirc@gmail.com"}
@@ -21,7 +13,7 @@ maintainers = [
 readme = "README.md"
 keywords = ["rocketpy", "API", "simulation", "rocket", "flight"]
 classifiers = [
- "Development Status :: Alpha",
+ "Development Status :: Production",
  "Programming Language :: Python"
 ]
 
@@ -52,3 +44,14 @@ disable = """
  raise-missing-from,
  too-many-instance-attributes,
 """
+
+[tool.ruff]
+line-length = 79
+target-version = "py312"
+
+[tool.ruff.lint]
+select = ["E", "F", "N", "Q"]
+ignore = ["N815", "E501", "Q000", "E402"]
+fixable = [
+ "F401",
+]

requirements-dev.txt

@@ -0,0 +1,3 @@
+flake8
+pylint
+ruff