Merge pull request #2 from mikelv702/1-multiple-state-files

Multiple state files

Author: rubberduckdevops

README.md

@@ -40,22 +40,15 @@ fastapi dev main.py
 ```hcl
 terraform {
   backend "http" {
-    address = "http://localhost:8000/tfstate"
-    lock_address = "http://localhost:8000/tfstate/lock"
-    unlock_address = "http://localhost:8000/tfstate/lock"
+    address = "http://localhost:8000/tfstate/${PROJECT_ID}"
+    lock_address = "http://localhost:8000/tfstate/${PROJECT_ID}/lock"
+    unlock_address = "http://localhost:8000/tfstate/${PROJECT_ID}/lock"
   }
 }
 ```
 
 3. Use Terraform as normal. The state will be stored and retrieved from your FastAPI backend.
 
-## API ENDPOINTS 
-
-- POST /tfstate: Update Terraform state
-- GET /tfstate: Retrieve Terraform state
-- LOCK /tfstate/lock: Acquire a state lock
-- UNLOCK /tfstate/lock: Release a state lock
-- GET /tfstate/lock: Retrieve current lock info
 
 ## Note
 

src/helpers/local_file_handler.py

@@ -7,10 +7,10 @@
 settings.configure_logging()
 logger = logging.getLogger(__name__)
 
-def save_file(json_data) -> None:
+def save_file(json_data, project_id) -> None:
     logger.debug("Saving to disk")
     try:
-        directory_path = os.path.join(os.getcwd(), settings.FILE_STORAGE_PATH)
+        directory_path = os.path.join(os.getcwd(), settings.FILE_STORAGE_PATH, project_id)
         if not os.path.exists(directory_path):
             os.makedirs(directory_path)
             logger.info(f"Created directory: {directory_path}")
@@ -21,13 +21,59 @@ def save_file(json_data) -> None:
     except FileNotFoundError:
         logger.warn(f"File not found {file_path}")
 
-def read_file():
+def read_file(project_id):
     try:
-        directory_path = os.path.join(os.getcwd(), settings.FILE_STORAGE_PATH)
+        directory_path = os.path.join(os.getcwd(), 
+                                      settings.FILE_STORAGE_PATH, 
+                                      project_id)
         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 None
+        return None
+    
+def save_lock_file(project_id: int, lock):
+    logger.debug("Saving lock to disk")
+    try:
+        directory_path = os.path.join(os.getcwd(), 
+                                      settings.FILE_STORAGE_PATH, 
+                                      str(project_id))
+        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, 'lock.json')
+        logger.info(f"Saving to {file_path}")
+        with open(file_path, 'w', encoding='utf-8') as f:
+            json.dump(lock, f, ensure_ascii=False)
+    except FileNotFoundError:
+        logger.warn(f"File not found {file_path}")   
+        
+def read_lock_file(project_id):
+    try:
+        directory_path = os.path.join(os.getcwd(), 
+                                      settings.FILE_STORAGE_PATH, 
+                                      str(project_id))
+        file_path = os.path.join(directory_path, 'lock.json')
+        f = open(file_path)
+        json_data = json.load(f)
+        return json_data
+    except FileNotFoundError: 
+        print("File not found, returning empty")
+        return None
+    
+def delete_lock_file(project_id):
+    try:
+        directory_path = os.path.join(os.getcwd(), 
+                                      settings.FILE_STORAGE_PATH, 
+                                      str(project_id))
+        file_path = os.path.join(directory_path, 'lock.json')
+        os.remove(file_path)
+        return True
+    except FileNotFoundError:
+        logger.warn("Lock not found")
+        return True
+    except Exception as e:
+        logger.error(f"Unable to remove lock project: {project_id}, {e}")
+        return False

src/main.py

@@ -6,7 +6,11 @@
 from fastapi.responses import JSONResponse
 
 
-from .helpers.local_file_handler import save_file, read_file
+from .helpers.local_file_handler import (save_file, 
+                                         read_file, 
+                                         read_lock_file, 
+                                         delete_lock_file, 
+                                         save_lock_file)
 
 from .settings import settings
 
@@ -45,45 +49,41 @@ class TerraformState(BaseModel):
 
     class Config:
         extra = "allow"
-@app.api_route("/tfstate/lock", methods=["LOCK"])
-async def lock_state(lock: LockInfo):
-    global lock_info
+        
+@app.api_route("/tfstate/{project_id}/lock", methods=["LOCK"])
+async def lock_state(project_id: int, lock: LockInfo):
+    lock_info = read_lock_file(project_id)
     if lock_info is None:
         lock_info = lock
+        save_lock_file(project_id, lock_info.model_dump())
         return JSONResponse(content=lock.model_dump(), status_code=200)
     else:
         return JSONResponse(
             content={"error": "State already locked", "locked_by": lock_info.dict()},
             status_code=423
         )
 
-@app.api_route("/tfstate/lock", methods=["UNLOCK"])
-async def unlock_state(lock: LockInfo):
-    global lock_info
+@app.api_route("/tfstate/{project_id}/lock", methods=["UNLOCK"])
+async def unlock_state(project_id: int, lock: LockInfo):
+    lock_info = read_lock_file(project_id)
     if lock_info is None:
         raise HTTPException(status_code=404, detail="State is not locked")
-    if lock_info.ID != lock.ID:
+    if lock_info["ID"] != lock.ID:
         raise HTTPException(status_code=403, detail="Lock ID does not match")
-    lock_info = None
+    delete_lock_file(project_id)
     return Response(status_code=200)
 
-@app.get("/tfstate/lock")
-async def get_lock():
+@app.get("/tfstate/{project_id}/lock")
+async def get_lock(project_id: int):
+    lock_info = read_lock_file(project_id)
     if lock_info is None:
         return Response(status_code=404)
     return JSONResponse(content=lock_info.model_dump(), status_code=200)
-
-@app.post("/tfstate")
-async def update_terraform_state(ID: str, state: TerraformState):
-    logging.info(f"Update state file {ID}")
-    save_file(state.model_dump())
-    logging.debug(state)
-    return JSONResponse(content=state.model_dump())
-
-@app.get("/tfstate")
-async def get_terraform_state():
-    logging.info("Requesting State File")
-    state_returned = read_file()
+    
+@app.get("/tfstate/{project_id}")
+async def get_terraform_state_project(project_id:int):
+    logging.info(f"Requesting State File for project {project_id}")
+    state_returned = read_file(str(project_id))
     if state_returned is None:
         dummy_state = TerraformState(
             version=4,
@@ -96,4 +96,11 @@ async def get_terraform_state():
         return dummy_state
     else:
         returned_state = TerraformState(**state_returned)
-        return JSONResponse(content=returned_state.model_dump())
+        return JSONResponse(content=returned_state.model_dump())
+    
+@app.post("/tfstate/{project_id}")
+async def update_terraform_state_project(project_id: int, state: TerraformState):
+    logging.info(f"Update state file for project {project_id}")
+    save_file(state.model_dump(), str(project_id))
+    logging.debug(state)
+    return JSONResponse(content=state.model_dump())