web-test

This module allows you to setup Azure classic Web Tests and Azure standard Web Tests.

Azure classic Web Tests are cheaper but do not support headers. If headers are set within a test, an Azure standard Web Tests will be created. For the rest of the time Azure classic Web Tests will be created.

Example usage

This module needs at least an application_insights and a urls object as an input :

locals {
    urls = {
        # This test will used all default values
        "example-using-default" = {
            url                       = "https://my-api.fr/simple/example"
        },        
        # This test will override all default value with custom one
        "exhaustif-example" = {
            url                       = "https://my-api.fr/exhaustif/example"
            method                    = "GET"
            frequency                 = 300
            timeout                   = 30
            geo_locations             = ["us-va-ash-azr", "emea-fr-pra-edge"]
            expected_http_status_code = 200
            retry_enabled             = true
            description               = "Getting some resource on my api"
            parse_dependent_requests  = true
            match_content             = "OK"
            headers                   = {
                foo = "bar"
            }
        }
    }
}

module "web_test" {
  source               = "git::https://poweruptech@dev.azure.com/poweruptech/mainplatform/_git/tf-modules//web-ping?ref=<TAG_VERSION>"
  application_insights = data.azurerm_application_insights.example
  urls                 = local.urls
  default_frequency    = 900 # 15 minutes
  default_description               = "My app test"
  default_expected_http_status_code = 200
  default_geo_locations = [
    "us-va-ash-azr",     # East US
    "us-ca-sjc-azr",     # West US
    "apac-sg-sin-azr",   # Southeast Asia
    "latam-br-gru-edge", # Brazil South
    "emea-fr-pra-edge"   # France Central
  ]
  default_method                   = "GET"
  default_parse_dependent_requests = true
  default_retry_enabled            = true
  default_timeout                  = 30  
  tags = { "environement" = "prod" }
}

Tags

When a WebTest is created, Azure will automatically appends a hidden-link tag to the resource. You should also add this tag to your code or terraform will conflict agains Azure to remove/apply that tag at every run :

tags = merge(local.tags, { "hidden-link:/subscriptions/${var.subscription_id}/resourceGroups/${azurerm_application_insights.example.resource_group_name}/providers/Microsoft.Insights/components/${azurerm_application_insights.example.name}" = "Resource" })

As of yet this is not something that can be taken care of at module level (see this issue).

Requirements

Name	Version
terraform	>= 1.3.0
azurerm	~> 3.6

Providers

Name	Version
azurerm	~> 3.6

Resources

Name	Type
azurerm_application_insights_web_test.web_test	resource
azurerm_application_insights_standard_web_test.standard_web_test	resource

Inputs

Name	Description	Type	Default	Required
application_insights	(Required) The Application Insights component on which the WebTests operate.	any	n/a	yes
default_description	(Optional) Default purpose/user defined descriptive test for those WebTests. Default is empty	string	"HTTP <METHOD> on <URL>. HTTP <EXPECTED_HTTP_STATUS_CODE> is expected"	no
default_expected_http_status_code	(Optional) Default expected HTTP status code those WebTests should return. Default is 200	number	200	no
default_frequency	(Optional) Default interval in seconds between test runs for those WebTests. Valid options are 300, 600 and 900. Defaults to 300	number	300	no
default_geo_locations	(Optional) A default list of where to physically run the tests from to give global coverage for accessibility of your application. Default to East US, West US, Southeast Asia, Brazil South and France Central	list(string)	[ "us-va-ash-azr", "us-ca-sjc-azr", "apac-sg-sin-azr", "latam-br-gru-edge", "emea-fr-pra-edge" ]	no
default_method	(Optional) Default HTTP method those WebTests will use.	string	"GET"	no
default_parse_dependent_requests	(Optional) The test requests images, scripts, style files, and other files that are part of the webpage under test. Default is true	bool	true	no
default_retry_enabled	(Optional) Allow for retries should those WebTests fail. Default is true	bool	true	no
default_timeout	(Optional) Default interval in seconds until those WebTests will timeout and fail. Valid options are 30, 60, 90 and 120. Default is 30	number	30	no
tags	(Optional) A mapping of tags to assign to the resource.	map(any)	{}	no
urls	(Required) Map of object that must at least contain an url parameter. Every default configuration can be overridden here	map(object({ url = string method = optional(string) frequency = optional(number) timeout = optional(number) geo_locations = optional(list(string)) expected_http_status_code = optional(number) retry_enabled = optional(bool) description = optional(string) headers = optional(map(string)) parse_dependent_requests = optional(bool) match_content = optional(string) } ))	n/a	yes

Outputs

No outputs.

Geo location

You can use the following population tags for the geo-location attribute when you deploy an availability URL ping test :

Display name	Population name
Australia East	emea-au-syd-edge
Brazil South	latam-br-gru-edge
Central US	us-fl-mia-edge
East Asia	apac-hk-hkn-azr
East US	us-va-ash-azr
France South (Formerly France Central)	emea-ch-zrh-edge
France Central	emea-fr-pra-edge
Japan East	apac-jp-kaw-edge
North Europe	emea-gb-db3-azr
North Central US	us-il-ch1-azr
South Central US	us-tx-sn1-azr
Southeast Asia	apac-sg-sin-azr
UK West	emea-se-sto-edge
West Europe	emea-nl-ams-azr
West US	us-ca-sjc-azr
UK South	emea-ru-msa-edge

Source : https://learn.microsoft.com/en-us/azure/azure-monitor/app/availability-standard-tests#azure