Adding requirements, adding settings file for future customization

Author: rubberduckdevops

README.md

@@ -10,10 +10,7 @@ This project implements a custom HTTP backend for Terraform using FastAPI. It pr
 
 ## Requirements
 
-- Python 3.7+
-- FastAPI
-- Uvicorn (for running the FastAPI application)
-- Pydantic
+see [requirements.txt](requirements.txt)
 
 ## Installation
 
@@ -26,7 +23,7 @@ git clone [email protected]:mikelv702/simple-terraform-backend.git
 2. Install the required packages:
 
 ```bash
-pip install fastapi
+uv pip install -r requirements.txt
 ```
 
 ## Usage

helpers/local_file_handler.py

@@ -1,19 +1,33 @@
 import os
 import json
+import logging
+
+from ..settings import settings
+
+settings.configure_logging()
+logger = logging.getLogger(__name__)
 
 def save_file(json_data) -> None:
-    cwd = os.getcwd()
-    file_path = os.path.join(cwd, 'data.json')
-    with open(file_path, 'w', encoding='utf-8') as f:
-        json.dump(json_data, f, ensure_ascii=False)
+    logger.debug("Saving to disk")
+    try:
+        directory_path = os.path.join(os.getcwd(), settings.FILE_STORAGE_PATH)
+        if not os.path.exists(directory_path):
+            os.makedirs(directory_path)
+            logger.info(f"Created directory: {directory_path}")
+        file_path = os.path.join(directory_path, 'data.json')
+        logger.info(f"Saving to {file_path}")
+        with open(file_path, 'w', encoding='utf-8') as f:
+            json.dump(json_data, f, ensure_ascii=False)
+    except FileNotFoundError:
+        logger.warn(f"File not found {file_path}")
 
 def read_file():
     try:
-        cwd = os.getcwd()
-        file_path = os.path.join(cwd, 'data.json')
+        directory_path = os.path.join(os.getcwd(), settings.FILE_STORAGE_PATH)
+        file_path = os.path.join(directory_path, 'data.json')
         f = open(file_path)
         json_data = json.load(f)
         return json_data
     except FileNotFoundError: 
         print("File not found, returning empty")
-        return {}
+        return None

main.py

@@ -1,15 +1,25 @@
+import logging
 from pydantic import BaseModel, Field
 from typing import List, Dict, Any, Optional
 
 from fastapi import FastAPI, HTTPException, Response
 from fastapi.responses import JSONResponse
 
+
 from .helpers.local_file_handler import save_file, read_file
 
-app = FastAPI()
+from .settings import settings
+
+settings.configure_logging()
+logger = logging.getLogger(__name__)
 
+app = FastAPI(title=settings.APP_NAME, 
+              version=settings.APP_VERSION, 
+              debug=settings.DEBUG)
 
+# IN MEMORY LOCK FILE! DO NOT USE IN PRODUCTION
 lock_info = None
+
 class LockInfo(BaseModel):
     ID: str
     Operation: str
@@ -65,21 +75,16 @@ async def get_lock():
 
 @app.post("/tfstate")
 async def update_terraform_state(ID: str, state: TerraformState):
-    print("Update State File")
-    print(ID)
-
-
+    logging.info(f"Update state file {ID}")
     save_file(state.model_dump())
-    print(state)
+    logging.debug(state)
     return JSONResponse(content=state.model_dump())
 
 @app.get("/tfstate")
 async def get_terraform_state():
-    print("Getting State File")
-    # Here you would typically retrieve the state from your storage system
-    # For this example, we'll just return a dummy state
+    logging.info("Requesting State File")
     state_returned = read_file()
-    if len(state_returned) < 4:
+    if state_returned is None:
         dummy_state = TerraformState(
             version=4,
             terraform_version="1.0.0",
@@ -90,7 +95,5 @@ async def get_terraform_state():
         )
         return dummy_state
     else:
-        dummy_state = TerraformState(**state_returned)
-
-        print(dummy_state)
-        return JSONResponse(content=dummy_state.model_dump())
+        returned_state = TerraformState(**state_returned)
+        return JSONResponse(content=returned_state.model_dump())

requirements.txt

@@ -0,0 +1,36 @@
+annotated-types==0.7.0
+anyio==4.4.0
+certifi==2024.6.2
+click==8.1.7
+dnspython==2.6.1
+email-validator==2.2.0
+fastapi==0.111.0
+fastapi-cli==0.0.4
+h11==0.14.0
+httpcore==1.0.5
+httptools==0.6.1
+httpx==0.27.0
+idna==3.7
+jinja2==3.1.4
+markdown-it-py==3.0.0
+markupsafe==2.1.5
+mdurl==0.1.2
+orjson==3.10.5
+pydantic==2.7.4
+pydantic-core==2.18.4
+pydantic-settings==2.3.4
+pygments==2.18.0
+python-dotenv==1.0.1
+python-multipart==0.0.9
+pyyaml==6.0.1
+rich==13.7.1
+shellingham==1.5.4
+sniffio==1.3.1
+starlette==0.37.2
+typer==0.12.3
+typing-extensions==4.12.2
+ujson==5.10.0
+uvicorn==0.30.1
+uvloop==0.19.0
+watchfiles==0.22.0
+websockets==12.0

settings.py

@@ -0,0 +1,41 @@
+from pydantic import Field
+from pydantic_settings import BaseSettings
+from typing import Optional
+import logging
+
+class Settings(BaseSettings):
+    # App settings
+    APP_NAME: str = "mikelv702-terraform backend"
+    APP_VERSION: str = "0.1.0"
+    DEBUG: bool = False
+
+    # Server settings
+    HOST: str = "0.0.0.0"
+    PORT: int = 8000
+
+    # Logging settings
+    LOG_LEVEL: str = Field(default="INFO", env="LOG_LEVEL")
+    LOG_FORMAT: str = "%(asctime)s - %(name)s - %(levelname)s - %(message)s"
+
+    # Storage settings
+    STORAGE_TYPE: str = Field(default="file", 
+                              env="STORAGE_TYPE")  # Options: "file", "database"
+    FILE_STORAGE_PATH: str = Field(default="terraform_states",
+                                   env="FILE_STORAGE_PATH")
+    # TODO: Implment Database backend
+    # DATABASE_URL: Optional[str] = Field(default=None, env="DATABASE_URL")
+
+    # Lock settings
+    LOCK_TIMEOUT: int = Field(default=300, env="LOCK_TIMEOUT")
+
+    class Config:
+        env_file = ".env"
+        env_file_encoding = "utf-8"
+
+    def configure_logging(self):
+        logging.basicConfig(
+            level=getattr(logging, self.LOG_LEVEL),
+            format=self.LOG_FORMAT
+        )
+
+settings = Settings()