add environments to api (#23)

Author: mwirikia

README.md

@@ -262,6 +262,14 @@ Send JSON in this format:
         "main": [],
         "others": ["List of strings"]
       },
+      "environments": {
+        "dev": "Boolean",
+        "int": "Boolean",
+        "uat": "Boolean",
+        "preprod": "Boolean",
+        "prod": "Boolean",
+        "postprod": "Boolean",
+      },
       "infrastructure": {
         "main": [],
         "others": ["List of strings"]
@@ -417,6 +425,14 @@ Send JSON in this format:
         "main": [],
         "others": ["List of strings"]
       },
+      "environments": {
+        "dev": "Boolean",
+        "int": "Boolean",
+        "uat": "Boolean",
+        "preprod": "Boolean",
+        "prod": "Boolean",
+        "postprod": "Boolean",
+      },
       "infrastructure": {
         "main": [],
         "others": ["List of strings"]
@@ -475,7 +491,7 @@ Send JSON in this format:
         }
   }
 ```
-Edits a project by checking if the languages, database, frameworks, cicd, infrastructure, or source control are missing from the `array_data.json` bucket. If any are missing, they are added.
+Edits a project by checking if the languages, database, frameworks, cicd, environments, infrastructure, publishing or source control are missing from the `array_data.json` bucket. If any are missing, they are added.
 
 
 ## Authorization with Cognito and API Gateway

aws_lambda_script/app/api_models.py

@@ -159,6 +159,19 @@ def get_project_model():
                     },
                 )
             ),
+            "environments": fields.Nested(
+                ns.model(
+                    "environments",
+                    {
+                        "dev": fields.Boolean(required=False, description="Development environment status"),
+                        "int": fields.Boolean(required=False, description="Integration environment status"),        
+                        "uat": fields.Boolean(required=False, description="User Acceptance Testing environment status"),
+                        "preprod": fields.Boolean(required=False, description="Pre-production or staging environment status"),
+                        "prod": fields.Boolean(required=False, description="Production environment status"),
+                        "postprod": fields.Boolean(required=False, description="Post-production environment status")
+                    }
+                )
+            ),
             "infrastructure": fields.Nested(
                 ns.model(
                     "Infrastructure",

aws_lambda_script/app/resources.py

@@ -30,7 +30,7 @@
 required_param = {"Authorization": "ID Token required"}
 
 # Set logger for AWS cloudwatch to return just errors
-logging.basicConfig(level=logging.DEBUG)
+logging.basicConfig(level=logging.INFO)
 logger = logging.getLogger(__name__)
 
 
@@ -250,6 +250,7 @@ def get(self):
             "database": ["architecture", "database"],
             "frameworks": ["architecture", "frameworks"],
             "cicd": ["architecture", "CICD"],
+            "environments": ["architecture", "environments"],
             "infrastructure": ["architecture", "infrastructure"],
             "publishing": ["architecture", "publishing"],
         }
@@ -386,6 +387,14 @@ def post(self):
                 {"email": owner_email, "roles": ["Editor"], "grade": ""}
             )
 
+        # Validate environments
+        environments = new_project.get("architecture", {}).get("environments", {})
+        if not isinstance(environments, dict):
+            abort(400, description="Invalid environments data: Must be a dictionary")
+        for key in ["dev", "int", "uat", "preprod", "prod", "postprod"]:
+            if key not in environments or not isinstance(environments[key], bool):
+                abort(400, description=f"Invalid environments data: '{key}' must be a boolean")
+        
         data = read_data("new_project_data.json")
 
         # Check if project with same name exists and has any matching user emails
@@ -477,6 +486,15 @@ def put(self, project_name):
             logger.error("Missing JSON data")
             abort(406, description="Missing JSON data")
 
+         # Validate environments
+        environments = updated_project.get("architecture", {}).get("environments", {})
+        if not isinstance(environments, dict):
+            abort(400, description="Invalid environments data: Must be a dictionary")
+        for key in ["dev", "int", "uat", "preprod", "prod", "postprod"]:
+            if key not in environments or not isinstance(environments[key], bool):
+                abort(400, description=f"Invalid environments data: '{key}' must be a boolean")
+
+
         # Ensure the email is set to owner_email
 
         data = read_data("new_project_data.json")
@@ -663,4 +681,4 @@ def exchange_code_for_tokens(code):
         raise Exception(f"Error: {response.status_code}, {response.json()}")
 
     # Return the parsed JSON response
-    return response.json()
+    return response.json()

aws_lambda_script/main.py

@@ -5,7 +5,7 @@
 app = create_app()
 
 logger = logging.getLogger()
-logger.setLevel(logging.DEBUG)
+logger.setLevel(logging.INFO)
 
 def lambda_handler(event, context):
     """

docs/endpoints/filter.md

@@ -28,6 +28,7 @@ Requires a valid Cognito ID token in the Authorization header.
 | `database` | string | Database types to filter by (comma-separated) | False |
 | `frameworks` | string | Frameworks to filter by (comma-separated) | False |
 | `cicd` | string | CI/CD tools to filter by (comma-separated) | False |
+| `environments` | dict | List of environments that project are deployed | False |
 | `infrastructure` | string | Infrastructure tools to filter by (comma-separated) | False |
 | `publishing` | string | Publishing target to filter by (comma-separated) | False |
 | `return` | string | Sections to return in response (user, details, developed, source_control, architecture) | False |

docs/endpoints/project.md

@@ -135,6 +135,14 @@ Requires a valid Cognito ID token in the Authorization header.
         "string"
       ]
     },
+    "environments": {
+      "dev": "Boolean",
+      "int": "Boolean",
+      "uat": "Boolean",
+      "preprod": "Boolean",
+      "prod": "Boolean",
+      "postprod": "Boolean",
+    },
     "infrastructure": {
       "main": [
         "string"

docs/endpoints/projects.md

@@ -122,6 +122,14 @@ Requires a valid Cognito ID token in the Authorization header.
         "string"
       ]
     },
+    "environments": {
+      "dev": "Boolean",
+      "int": "Boolean",
+      "uat": "Boolean",
+      "preprod": "Boolean",
+      "prod": "Boolean",
+      "postprod": "Boolean",
+    },
     "infrastructure": {
       "main": [
         "string"

testing/test_api.py

@@ -133,6 +133,7 @@ def test_post_and_get_project_with_timestamp(
             "languages": {"main": ["Python"], "others": ["JavaScript", "Java"]},
             "frameworks": {"main": [], "others": ["Flask"]},
             "cicd": {"main": [], "others": ["Github Actions"]},
+            "environments": { "dev": True, "int": False, "uat": False, "preprod": True, "prod": True, "postprod": False },
             "infrastructure": {"main": [], "others": ["Jenkins"]},
             "publishing": {"main": [], "others": ["Pypi"]},
         },