feat: add unit testing (#40)

Author: luke-taylor

.github/workflows/unit.yml

@@ -0,0 +1,45 @@
+---
+name: unit test
+
+on:
+  pull_request:
+    types: ['opened', 'reopened', 'synchronize']
+  merge_group:
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  id-token: write
+
+jobs:
+  testunit:
+    runs-on: [ self-hosted, 1ES.Pool=terraform-azurerm-avm-ptn-vnetgateway ]
+    env:
+      TF_IN_AUTOMATION: 1
+      TF_VAR_enable_telemetry: false
+    steps:
+      - uses: actions/checkout@9bb56186c3b09b4f86b1c65136769dd318469633 #v4.1.2
+      - name: Run Unit Tests
+        shell: bash
+        run: |
+          set -e
+          az login --identity --username $MSI_ID > /dev/null
+          export ARM_SUBSCRIPTION_ID=$(az login --identity --username $MSI_ID | jq -r '.[0] | .id')
+          export ARM_TENANT_ID=$(az login --identity --username $MSI_ID | jq -r '.[0] | .tenantId')
+          export ARM_CLIENT_ID=$(az identity list | jq -r --arg MSI_ID "$MSI_ID" '.[] | select(.principalId == $MSI_ID) | .clientId')
+          docker run --rm \
+            -v $(pwd):/src \
+            -v /var/run/docker.sock:/var/run/docker.sock \
+            -w /src \
+            --network=host \
+            -e TF_IN_AUTOMATION \
+            -e TF_VAR_enable_telemetry \
+            -e MSI_ID \
+            -e ARM_SUBSCRIPTION_ID \
+            -e ARM_TENANT_ID \
+            -e ARM_CLIENT_ID \
+            -e ARM_USE_MSI=true \
+            mcr.microsoft.com/azterraform:latest \
+            sh -c "terraform init && terraform test -verbose"
+
+

.gitignore

@@ -86,7 +86,3 @@ terraform.rc
 avm.tflint.merged.hcl
 avm.tflint_example.merged.hcl
 *.md.tmp
-
-# ignore tftest whilst developing 
-**.tftest.*
-**/tests/vnet-with-subnet/**

tests/.gitkeep

@@ -0,0 +1,20 @@
+provider "azurerm" {
+  features {}
+}
+
+run "examples_default" {
+  command = plan
+
+  module {
+    source = "./examples/default"
+  }
+}
+
+run "examples_vnet_with_subnet" {
+  command = plan
+
+  module {
+    source = "./examples/vnet-with-subnet"
+  }
+}
+

tests/examples.tftest.hcl

@@ -0,0 +1,74 @@
+provider "azurerm" {
+  features {}
+}
+
+variables {
+  location              = "uksouth"
+  name                  = "vgw-test"
+  subnet_address_prefix = "10.0.0.0/24"
+  enable_telemetry      = false
+  virtual_network_id = join("/", [
+    "",
+    "subscriptions",
+    "00000000-0000-0000-0000-000000000000",
+    "resourceGroups",
+    "rg-test",
+    "providers",
+    "Microsoft.Network",
+    "virtualNetworks",
+    "vnet-test"
+  ])
+}
+
+run "expressroute" {
+  command = plan
+
+  variables {
+    sku  = "HighPerformance"
+    type = "ExpressRoute"
+
+    ip_configurations = {
+      ip_config_0 = {
+        public_ip = {
+          allocation_method = "Static"
+          sku               = "Standard"
+        }
+      }
+    }
+    express_route_circuits = {
+      erc = {
+        id = join("/", [
+          "",
+          "subscriptions",
+          "00000000-0000-0000-0000-000000000000",
+          "resourceGroups",
+          "rg-erc-test",
+          "providers",
+          "Microsoft.Network",
+          "expressRouteCircuits",
+          "erc-test"
+        ])
+        connection = {
+          express_route_gateway_bypass = true
+          authorization_key            = "ABDNDBEHF"
+          name                         = "conn-test"
+          routing_weight               = 10
+        }
+        peering = {
+          peering_type        = "AzurePrivatePeering"
+          vlan_id             = 100
+          resource_group_name = "rg-test"
+        }
+      }
+    }
+  }
+}
+
+
+run "expressroute_route_table_creation" {
+  command = plan
+
+  variables {
+    route_table_creation_enabled = true
+  }
+}

tests/expressroute.tftest.hcl

@@ -0,0 +1,102 @@
+provider "azurerm" {
+  features {}
+}
+
+variables {
+  location              = "uksouth"
+  name                  = "vgw-test"
+  subnet_address_prefix = "10.0.0.0/24"
+  sku                   = "VpnGw1AZ"
+  type                  = "Vpn"
+  enable_telemetry      = false
+  virtual_network_id = join("/", [
+    "",
+    "subscriptions",
+    "00000000-0000-0000-0000-000000000000",
+    "resourceGroups",
+    "rg-test", "providers",
+    "Microsoft.Network",
+    "virtualNetworks",
+    "vnet-test"
+  ])
+}
+
+run "vpn_active_active" {
+  command = plan
+
+  variables {
+    vpn_active_active_enabled = true
+  }
+}
+
+run "vpn_active_active_custom_ip_config" {
+  command = plan
+
+  variables {
+    vpn_active_active_enabled = true
+    ip_configurations = {
+      ip_config_0 = {
+        public_ip = {
+          allocation_method = "Static"
+          sku               = "Standard"
+        }
+      }
+      ip_config_2 = {
+        public_ip = {
+          allocation_method = "Static"
+          sku               = "Standard"
+        }
+      }
+    }
+  }
+}
+
+run "vpn_active_active_custom_ip_config_fail" {
+  command = plan
+
+  variables {
+    vpn_active_active_enabled = true
+    ip_configurations = {
+      ip_config_0 = {
+        public_ip = {
+          allocation_method = "Static"
+          sku               = "Standard"
+        }
+      }
+    }
+  }
+
+  expect_failures = [
+    azurerm_virtual_network_gateway.vgw
+  ]
+}
+
+run "vpn_local_network_gateway" {
+  command = plan
+
+  variables {
+    ip_configurations = {
+      ip_config_0 = {
+        public_ip = {
+          allocation_method = "Static"
+          sku               = "Standard"
+        }
+      }
+    }
+    local_network_gateways = {
+      lgn-1 = {
+        name            = "lgn-test"
+        gateway_address = "0.0.0.0"
+        bgp_settings = {
+          asn                 = 65515
+          bgp_peering_address = "0.0.0.0"
+        }
+        connection = {
+          name = "conn-test"
+          type = "IPsec"
+
+        }
+      }
+    }
+  }
+}