minor updates

Author: zaro0508

README.md

@@ -106,18 +106,10 @@ When running `cdk` commands, you must specify which environment's
 configuration to use.  This is done by passing a context variable to
 CDK, which loads environment-specific parameters.
 
-Create a configuration file in the config folder for each environment
+Create a configuration file in the [config folder](./config) for each environment
 (e.g., `dev.yaml`, `prod.yaml`).  Both yaml and json files are supported.
 The supported environments are dev, stage, and prod.
 
-Example (`dev.yaml`):
-
-```yaml
-VPC_CIDR: 10.254.172.0/24
-FQDN: dev.mydomain.io
-CERTIFICATE_ARN: arn:aws:acm:us-east-1:XXXXXXXXX:certificate/e8093404-7db1-4042-90d0-01eb5bde1ffc
-```
-
 To synthesize or deploy using the `prod` environment configuration:
 
 ```console

app.py

@@ -11,27 +11,27 @@
 cdk_app = cdk.App()
 env_name = cdk_app.node.try_get_context("env") or "dev"
 config = load_context_config(env_name=env_name)
-stack_name_prefix = f"app-{env_name}"
-fully_qualified_domain_name = config["FQDN"]
-environment_tags = config["TAGS"]
-app_version = "latest"
+STACK_NAME_PREFIX = f"app-{env_name}"
+FQDN = config["FQDN"]
+TAGS = config["TAGS"]
+APP_VERSION = "latest"
 
 # recursively apply tags to all stack resources
-if environment_tags:
-    for key, value in environment_tags.items():
+if TAGS:
+    for key, value in TAGS.items():
         cdk.Tags.of(cdk_app).add(key, value)
 
 network_stack = NetworkStack(
     scope=cdk_app,
-    construct_id=f"{stack_name_prefix}-network",
+    construct_id=f"{STACK_NAME_PREFIX}-network",
     vpc_cidr=config["VPC_CIDR"],
 )
 
 ecs_stack = EcsStack(
     scope=cdk_app,
-    construct_id=f"{stack_name_prefix}-ecs",
+    construct_id=f"{STACK_NAME_PREFIX}-ecs",
     vpc=network_stack.vpc,
-    namespace=fully_qualified_domain_name,
+    namespace=FQDN,
 )
 
 # From AWS docs https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect-concepts-deploy.html
@@ -40,7 +40,7 @@
 # client service is running and available the public, but a backend isn't.
 load_balancer_stack = LoadBalancerStack(
     scope=cdk_app,
-    construct_id=f"{stack_name_prefix}-load-balancer",
+    construct_id=f"{STACK_NAME_PREFIX}-load-balancer",
     vpc=network_stack.vpc,
 )
 load_balancer_stack.add_dependency(ecs_stack)
@@ -49,16 +49,16 @@
     ecs_task_cpu=256,
     ecs_task_memory=512,
     container_name="my-app",
-    # can also reference github with 'ghcr.io/sage-bionetworks/my-app:{app_version}'
-    container_location=f"nginx:{app_version}",
+    # can also reference github with 'ghcr.io/sage-bionetworks/my-app:{APP_VERSION}'
+    container_location=f"nginx:{APP_VERSION}",
     container_port=80,
     container_env_vars={
-        "APP_VERSION": f"{app_version}",
+        "APP_VERSION": f"{APP_VERSION}",
     },
 )
 app_stack = LoadBalancedServiceStack(
     scope=cdk_app,
-    construct_id=f"{stack_name_prefix}-app",
+    construct_id=f"{STACK_NAME_PREFIX}-app",
     vpc=network_stack.vpc,
     cluster=ecs_stack.cluster,
     props=app_props,

cdk.json

@@ -1,5 +1,5 @@
 {
-  "app": "python3 app.py",
+  "app": "python app.py",
   "watch": {
     "include": [
       "**"

config/dev.yaml

@@ -1,4 +1,6 @@
 VPC_CIDR: 10.254.172.0/24
 FQDN: dev.mydomain.io
-CERTIFICATE_ARN: >-
-  arn:aws:acm:us-east-1:XXXXXXXXX:certificate/e8093404-7db1-4042-90d0-01eb5bde1ffc
+
+# Optional
+# CERTIFICATE_ARN: >-
+#   arn:aws:acm:us-east-1:XXXXXXXXX:certificate/e8093404-7db1-4042-90d0-01eb5bde1ffc

config/prod.yaml

@@ -1,4 +1,6 @@
 VPC_CIDR: 10.254.174.0/24
 FQDN: prod.mydomain.io
-CERTIFICATE_ARN: >-
-  arn:aws:acm:us-east-1:XXXXXXXXX:certificate/69b3ba97-b382-4648-8f94-a250b77b4994
+
+# Optional
+# CERTIFICATE_ARN: >-
+#  arn:aws:acm:us-east-1:XXXXXXXXX:certificate/69b3ba97-b382-4648-8f94-a250b77b4994

config/stage.yaml

@@ -1,4 +1,6 @@
 VPC_CIDR: 10.254.173.0/24
 FQDN: stage.mydomain.io
-CERTIFICATE_ARN: >-
-  arn:aws:acm:us-east-1:XXXXXXXXX:certificate/69b3ba97-b382-4648-8f94-a250b77b4994
+
+# Optional
+# CERTIFICATE_ARN: >-
+#   arn:aws:acm:us-east-1:XXXXXXXXX:certificate/69b3ba97-b382-4648-8f94-a250b77b4994

src/utils.py

@@ -19,11 +19,11 @@ def load_context_config(env_name: str, config_dir: str = "config") -> Dict[str,
     """
 
     # ✅ Validate environment name
-    valid_envs = {"dev", "stage", "prod"}
-    if env_name not in valid_envs:
+    VALID_ENVS = {"dev", "stage", "prod"}
+    if env_name not in VALID_ENVS:
         raise ValueError(
             f"Invalid environment '{env_name}'. "
-            f"Must be one of: {', '.join(sorted(valid_envs))}"
+            f"Must be one of: {', '.join(sorted(VALID_ENVS))}"
         )
 
     # Define possible config paths

tests/unit/test_network_stack.py

@@ -2,15 +2,11 @@
 import aws_cdk.assertions as assertions
 
 from src.network_stack import NetworkStack
-from src.utils import load_context_config
 
 
 def test_vpc_created():
-    # Load configuration from dev environment
-    config = load_context_config(env_name="dev")
-
     app = core.App()
-    vpc_cidr = config["VPC_CIDR"]
+    vpc_cidr = "10.254.192.0/24"
     network = NetworkStack(app, "NetworkStack", vpc_cidr)
     template = assertions.Template.from_stack(network)
     template.has_resource_properties("AWS::EC2::VPC", {"CidrBlock": vpc_cidr})

tests/unit/test_service_stack.py

@@ -5,23 +5,14 @@
 from src.ecs_stack import EcsStack
 from src.service_props import ServiceProps, ServiceSecret, ContainerVolume
 from src.service_stack import ServiceStack
-from src.utils import load_context_config
 
 
 def test_service_stack_created():
-    # Load configuration from dev environment
-    config = load_context_config(env_name="dev")
-
     cdk_app = cdk.App()
-    vpc_cidr = config["VPC_CIDR"]
-    fully_qualified_domain_name = config["FQDN"]
-
+    vpc_cidr = "10.254.192.0/24"
     network_stack = NetworkStack(cdk_app, "NetworkStack", vpc_cidr=vpc_cidr)
     ecs_stack = EcsStack(
-        cdk_app,
-        "EcsStack",
-        vpc=network_stack.vpc,
-        namespace=fully_qualified_domain_name,
+        cdk_app, "EcsStack", vpc=network_stack.vpc, namespace="dev.app.io"
     )
 
     app_props = ServiceProps(