feat: DTOSS-10749 setup wiremock server (#1620)

MacMur85 · web-flow · commit 11d777334162 · 2025-09-16T14:38:20.000Z
feat: wiremock container app, cont app environemnt, compose file, dockerfile
diff --git a/application/CohortManager/compose.deps.yaml b/application/CohortManager/compose.deps.yaml
@@ -72,16 +72,6 @@ services:
       - SYS_PTRACE
     restart: "no"
 
-  wiremock:
-    container_name: wiremock
-    networks: [cohman-network]
-    image: wiremock/wiremock
-    ports:
-      - "8080:8080"
-    volumes:
-      - ./Set-up/wiremock/mappings:/home/wiremock/mappings
-    command: --verbose --root-dir /home/wiremock
-
 networks:
   cohman-network:
     name: cohman-network
diff --git a/application/CohortManager/compose.wiremock.yaml b/application/CohortManager/compose.wiremock.yaml
@@ -0,0 +1,18 @@
+name: cohort-manager-pipeline
+services:
+
+  wiremock:
+    container_name: wiremock
+    networks: [cohman-network]
+    build:
+      context: ./src/Functions/
+      dockerfile: Shared/Wiremock/Dockerfile
+    ports:
+      - "8080:8080"
+    volumes:
+      - ./src/Functions/Shared/Wiremock/mappings:/home/wiremock/mappings
+    command: --verbose --root-dir /home/wiremock
+
+networks:
+  cohman-network:
+    external: true
diff --git a/application/CohortManager/compose.yaml b/application/CohortManager/compose.yaml
@@ -5,3 +5,4 @@ include:
   - compose.core.yaml
   - compose.cohort-distribution.yaml
   - compose.pipeline.yaml
+  - compose.wiremock.yaml
diff --git a/application/CohortManager/src/Functions/Shared/Wiremock/Dockerfile b/application/CohortManager/src/Functions/Shared/Wiremock/Dockerfile
@@ -0,0 +1,9 @@
+# Use the official WireMock image as the base
+FROM wiremock/wiremock:latest
+
+# Copy the JSON mapping files into the container
+# WireMock automatically loads mappings from the /home/wiremock/mappings directory
+COPY /Shared/Wiremock/mappings /home/wiremock/mappings
+
+# Use a default, non-root built in Wiremock user
+USER wiremock
diff --git a/application/CohortManager/src/Functions/Shared/Wiremock/mappings/servicenow_authentication.json b/application/CohortManager/src/Functions/Shared/Wiremock/mappings/servicenow_authentication.json
diff --git a/application/CohortManager/src/Functions/Shared/Wiremock/mappings/servicenow_resolution.json b/application/CohortManager/src/Functions/Shared/Wiremock/mappings/servicenow_resolution.json
diff --git a/application/CohortManager/src/Functions/Shared/Wiremock/mappings/servicenow_update.json b/application/CohortManager/src/Functions/Shared/Wiremock/mappings/servicenow_update.json
diff --git a/infrastructure/tf-core/container_app.tf b/infrastructure/tf-core/container_app.tf
@@ -0,0 +1,73 @@
+
+module "container-app" {
+  for_each = local.container_apps_map
+
+  source = "../../../dtos-devops-templates/infrastructure/modules/container-app"
+
+  providers = {
+    azurerm     = azurerm
+    azurerm.hub = azurerm.hub
+  }
+
+  name                = "ca-${lower(each.key)}"
+  resource_group_name = azurerm_resource_group.core[each.value.region].name
+  location            = each.value.region
+
+  container_app_environment_id = module.container-app-environment["${each.value.container_app_environment_key}-${each.value.region}"].id
+  user_assigned_identity_ids   = each.value.add_user_assigned_identity ? [module.user_assigned_managed_identity_sql["${each.key}"].id] : []
+
+  acr_login_server           = data.azurerm_container_registry.acr.login_server
+  acr_managed_identity_id    = each.value.container_registry_use_mi ? data.azurerm_user_assigned_identity.acr_mi.id : null
+  docker_image               = "${data.azurerm_container_registry.acr.login_server}/${each.value.docker_image}:${each.value.docker_env_tag != "" ? each.value.docker_env_tag : var.docker_image_tag}"
+
+  environment_variables = each.value.env_vars != null ? each.value.env_vars : {}
+
+  is_tcp_app = each.value.is_tcp_app
+  is_web_app = each.value.is_web_app
+  port       = each.value.port
+
+  infra_key_vault_rg   = each.value.infra_key_vault_rg
+  infra_key_vault_name = each.value.infra_key_vault_name
+
+  depends_on = [
+    module.azure_sql_server
+  ]
+}
+
+locals {
+  # There are multiple App Service Plans and possibly multiple regions.
+  # We cannot nest for loops inside a map, so first iterate all permutations of both as a list of objects...
+  container_apps_object_list = flatten([
+    for region in keys(var.regions) : [
+      for container_app, config in var.container_apps.apps : merge(
+        {
+          region        = region            # 1st iterator
+          container_app = container_app # 2nd iterator
+        },
+        config, # the rest of the key/value pairs for a specific container_app
+        {
+          env_vars = merge(
+            # Add environment variables defined specifically for this container app :
+            config.env_vars_static,
+
+            # Add in the database connection string if the name of the variable is provided:
+            config.add_user_assigned_identity != null && length(config.db_connection_string_name) > 0 ? {
+              (config.db_connection_string_name) = "Server=tcp:${module.regions_config[region].names.sql-server}.database.windows.net,1433;Initial Catalog=${var.sqlserver.dbs.cohman.db_name_suffix};Encrypt=True;TrustServerCertificate=False;Connection Timeout=30;Authentication='Active Directory Managed Identity';User ID=${module.user_assigned_managed_identity_sql["${container_app}-${region}"].client_id};"
+            } : {},
+
+            # Add in the MANAGED_IDENTITY_CLIENT_ID environment variable if using a user assigned managed identity:
+            config.add_user_assigned_identity != false ? {
+              "MANAGED_IDENTITY_CLIENT_ID" = "${module.user_assigned_managed_identity_sql["${container_app}-${region}"].client_id}",
+              "TARGET_SUBSCRIPTION_ID"     = var.TARGET_SUBSCRIPTION_ID
+            } : {}
+          )
+        }
+      )
+    ]
+  ])
+
+  # ...then project the list of objects into a map with unique keys (combining the iterators), for consumption by a for_each meta argument
+  container_apps_map = {
+    for object in local.container_apps_object_list : "${object.container_app}-${object.region}" => object
+  }
+}
diff --git a/infrastructure/tf-core/environments/development.tfvars b/infrastructure/tf-core/environments/development.tfvars
@@ -56,6 +56,13 @@ regions = {
         service_delegation_name    = "Microsoft.App/environments"
         service_delegation_actions = ["Microsoft.Network/virtualNetworks/subnets/join/action"]
       }
+      container-app-default = {
+        cidr_newbits               = 7
+        cidr_offset                = 7
+        delegation_name            = "Microsoft.App/environments"
+        service_delegation_name    = "Microsoft.App/environments"
+        service_delegation_actions = ["Microsoft.Network/virtualNetworks/subnets/join/action"]
+      }
     }
   }
 }
@@ -237,6 +244,9 @@ container_app_environments = {
     db-management = {
       zone_redundancy_enabled = false
     }
+    default = {
+      zone_redundancy_enabled = false
+    }
   }
 }
 
@@ -253,6 +263,22 @@ container_app_jobs = {
   }
 }
 
+container_apps = {
+  apps = {
+    wiremock = {
+      container_app_environment_key = "default"
+      docker_image                  = "cohort-manager-wiremock"
+      container_registry_use_mi     = true
+      add_user_assigned_identity    = false
+      is_tcp_app                    = false
+      is_web_app                    = true
+      port                          = 8080
+      infra_key_vault_rg            = null
+      infra_key_vault_name          = null
+    }
+  }
+}
+
 diagnostic_settings = {
   metric_enabled = true
 }
diff --git a/infrastructure/tf-core/variables.tf b/infrastructure/tf-core/variables.tf
@@ -189,7 +189,14 @@ variable "container_apps" {
       docker_env_tag                = optional(string, "")
       docker_image                  = optional(string)
       is_web_app                    = optional(bool, false)
+      is_tcp_app                    = optional(bool, false)
       container_registry_use_mi     = optional(bool, false)
+      db_connection_string_name     = optional(string, "")
+      add_user_assigned_identity    = optional(bool, false)
+      port                          = optional(number, 8080)
+      infra_key_vault_name          = optional(string, "")
+      infra_key_vault_rg            = optional(string, "")
+      env_vars_static               = optional(map(string), {})
     })), {})
   })
 }
diff --git a/scripts/config/devcontainer/post-build-cfg.sh b/scripts/config/devcontainer/post-build-cfg.sh
@@ -35,6 +35,10 @@ echo '. "$HOME/.asdf/completions/asdf.bash"' >> "$BASHRC_FILE"
 echo "🔒 Configuring Git safe directory..."
 git config --global --add safe.directory "$PWD"
 
+# --- Install Azure CLI ---
+echo "⚙️ Installing Azure CLI..."
+curl -sL https://aka.ms/InstallAzureCLIDeb | sudo bash
+
 # --- Project Setup ---
 echo "⚙️ Running project-specific configuration..."
 make config

Original file line number	Diff line number	Diff line change
`@@ -56,6 +56,13 @@ regions = {`
`56`	`56`	`service_delegation_name = "Microsoft.App/environments"`
`57`	`57`	`service_delegation_actions = ["Microsoft.Network/virtualNetworks/subnets/join/action"]`
`58`	`58`	`}`
	`59`	`+ container-app-default = {`
	`60`	`+ cidr_newbits = 7`
	`61`	`+ cidr_offset = 7`
	`62`	`+ delegation_name = "Microsoft.App/environments"`
	`63`	`+ service_delegation_name = "Microsoft.App/environments"`
	`64`	`+ service_delegation_actions = ["Microsoft.Network/virtualNetworks/subnets/join/action"]`
	`65`	`+ }`
`59`	`66`	`}`
`60`	`67`	`}`
`61`	`68`	`}`
`@@ -237,6 +244,9 @@ container_app_environments = {`
`237`	`244`	`db-management = {`
`238`	`245`	`zone_redundancy_enabled = false`
`239`	`246`	`}`
	`247`	`+ default = {`
	`248`	`+ zone_redundancy_enabled = false`
	`249`	`+ }`
`240`	`250`	`}`
`241`	`251`	`}`
`242`	`252`
`@@ -253,6 +263,22 @@ container_app_jobs = {`
`253`	`263`	`}`
`254`	`264`	`}`
`255`	`265`
	`266`	`+container_apps = {`
	`267`	`+ apps = {`
	`268`	`+ wiremock = {`
	`269`	`+ container_app_environment_key = "default"`
	`270`	`+ docker_image = "cohort-manager-wiremock"`
	`271`	`+ container_registry_use_mi = true`
	`272`	`+ add_user_assigned_identity = false`
	`273`	`+ is_tcp_app = false`
	`274`	`+ is_web_app = true`
	`275`	`+ port = 8080`
	`276`	`+ infra_key_vault_rg = null`
	`277`	`+ infra_key_vault_name = null`
	`278`	`+ }`
	`279`	`+ }`
	`280`	`+}`
	`281`	`+`
`256`	`282`	`diagnostic_settings = {`
`257`	`283`	`metric_enabled = true`
`258`	`284`	`}`