[datadog_synthetics_global_variable] Add support for local variable extract from test (#1567)

* [Synthetics] Add support for local variable extract for global variable from test

* Update docs

* Update datadog/tests/resource_datadog_synthetics_global_variable_test.go

Co-authored-by: skarimo <[email protected]>

* [Synthetics] Fix getting required and optional value for GV

Co-authored-by: Thomas Hervé <[email protected]>
Co-authored-by: skarimo <[email protected]>

Author: 3 people

datadog/resource_datadog_synthetics_global_variable.go

@@ -81,7 +81,7 @@ func resourceDatadogSyntheticsGlobalVariable() *schema.Resource {
 						},
 						"parser": {
 							Type:     schema.TypeList,
-							Required: true,
+							Optional: true,
 							MaxItems: 1,
 							Elem: &schema.Resource{
 								Schema: map[string]*schema.Schema{
@@ -99,6 +99,11 @@ func resourceDatadogSyntheticsGlobalVariable() *schema.Resource {
 								},
 							},
 						},
+						"local_variable_name": {
+							Type:        schema.TypeString,
+							Description: "When type is `local_variable`, name of the local variable to use to extract the value.",
+							Optional:    true,
+						},
 					},
 				},
 			},
@@ -240,14 +245,20 @@ func buildSyntheticsGlobalVariableStruct(d *schema.ResourceData) *datadogV1.Synt
 				parseTestOptions.SetField(field.(string))
 			}
 
-			parser := datadogV1.SyntheticsVariableParser{}
-			parser.SetType(datadogV1.SyntheticsGlobalVariableParserType(d.Get("parse_test_options.0.parser.0.type").(string)))
+			if _, ok := d.GetOk("parse_test_options.0.parser"); ok {
+				parser := datadogV1.SyntheticsVariableParser{}
+				parser.SetType(datadogV1.SyntheticsGlobalVariableParserType(d.Get("parse_test_options.0.parser.0.type").(string)))
 
-			if value, ok := d.GetOk("parse_test_options.0.parser.0.value"); ok {
-				parser.SetValue(value.(string))
+				if value, ok := d.GetOk("parse_test_options.0.parser.0.value"); ok {
+					parser.SetValue(value.(string))
+				}
+
+				parseTestOptions.SetParser(parser)
 			}
 
-			parseTestOptions.SetParser(parser)
+			if localVariableName, ok := d.GetOk("parse_test_options.0.local_variable_name"); ok {
+				parseTestOptions.SetLocalVariableName(localVariableName.(string))
+			}
 
 			syntheticsGlobalVariable.SetParseTestOptions(parseTestOptions)
 		}
@@ -289,19 +300,28 @@ func updateSyntheticsGlobalVariableLocalState(d *schema.ResourceData, synthetics
 		localParser := make(map[string]string)
 
 		parseTestOptions := syntheticsGlobalVariable.GetParseTestOptions()
-		parser := parseTestOptions.GetParser()
-
-		if v, ok := parser.GetTypeOk(); ok {
-			localParser["type"] = string(*v)
-		}
-
-		localParser["value"] = parser.GetValue()
 
 		localParseTestOptions["type"] = parseTestOptions.GetType()
+
 		if v, ok := parseTestOptions.GetFieldOk(); ok {
 			localParseTestOptions["field"] = string(*v)
 		}
-		localParseTestOptions["parser"] = []map[string]string{localParser}
+
+		if parseTestOptions.HasParser() {
+			parser := parseTestOptions.GetParser()
+
+			localParser["type"] = string(parser.GetType())
+
+			if value, ok := parser.GetValueOk(); ok {
+				localParser["value"] = string(*value)
+			}
+
+			localParseTestOptions["parser"] = []map[string]string{localParser}
+		}
+
+		if parseTestOptions.HasLocalVariableName() {
+			localParseTestOptions["local_variable_name"] = parseTestOptions.GetLocalVariableName()
+		}
 
 		d.Set("parse_test_options", []map[string]interface{}{localParseTestOptions})
 	}

datadog/tests/cassettes/TestAccDatadogSyntheticsGlobalVariableFromTest_LocalVariable.freeze

@@ -0,0 +1 @@
+2022-09-13T20:00:51.367545+02:00

datadog/tests/cassettes/TestAccDatadogSyntheticsGlobalVariableFromTest_LocalVariable.yaml

@@ -0,0 +1,243 @@
+---
+version: 1
+interactions:
+- request:
+    body: |
+      {"config":{"assertions":[],"configVariables":[],"steps":[{"allowFailure":true,"assertions":[{"operator":"is","target":200,"type":"statusCode"}],"extractedValues":[{"field":"content-length","name":"LOCAL_VAR_EXTRACT","parser":{"type":"regex","value":".*"},"type":"http_header"}],"isCritical":false,"name":"First api step","request":{"allow_insecure":true,"body":"this is a body","follow_redirects":true,"method":"GET","timeout":30,"url":"https://www.datadoghq.com"},"retry":{"count":5,"interval":1000},"subtype":"http"}]},"locations":["aws:eu-central-1"],"message":"","name":"TF_TESTACCDATADOGSYNTHETICSGLOBALVARIABLEFROMTEST_LOCALVARIABLE_LOCAL_1663092051","options":{"follow_redirects":true,"min_location_failed":1,"monitor_options":{"renotify_interval":120},"tick_every":60},"status":"paused","subtype":"multi","tags":[],"type":"api"}
+    form: {}
+    headers:
+      Accept:
+      - application/json
+      Content-Type:
+      - application/json
+    url: https://api.datadoghq.com/api/v1/synthetics/tests/api
+    method: POST
+  response:
+    body: |
+      {"status":"paused","public_id":"9bw-vck-5p9","tags":[],"org_id":321813,"locations":["aws:eu-central-1"],"message":"","deleted_at":null,"name":"TF_TESTACCDATADOGSYNTHETICSGLOBALVARIABLEFROMTEST_LOCALVARIABLE_LOCAL_1663092051","monitor_id":86719615,"type":"api","created_at":"2022-09-13T18:00:54.595386+00:00","modified_at":"2022-09-13T18:00:54.595386+00:00","subtype":"multi","config":{"steps":[{"retry":{"count":5,"interval":1000},"name":"First api step","request":{"body":"this is a body","allow_insecure":true,"url":"https://www.datadoghq.com","follow_redirects":true,"timeout":30,"method":"GET"},"subtype":"http","allowFailure":true,"assertions":[{"operator":"is","type":"statusCode","target":200}],"isCritical":false,"id":"94v-6t6-psr","extractedValues":[{"field":"content-length","parser":{"type":"regex","value":".*"},"type":"http_header","name":"LOCAL_VAR_EXTRACT"}]}],"assertions":[],"configVariables":[]},"options":{"follow_redirects":true,"monitor_options":{"include_tags":true,"renotify_interval":120,"notify_audit":false,"new_host_delay":300,"on_missing_data":"show_no_data"},"min_location_failed":1,"tick_every":60}}
+    headers:
+      Content-Type:
+      - application/json
+    status: 200 OK
+    code: 200
+    duration: ""
+- request:
+    body: ""
+    form: {}
+    headers:
+      Accept:
+      - application/json
+    url: https://api.datadoghq.com/api/v1/synthetics/tests/api/9bw-vck-5p9
+    method: GET
+  response:
+    body: |
+      {"status":"paused","public_id":"9bw-vck-5p9","tags":[],"locations":["aws:eu-central-1"],"message":"","name":"TF_TESTACCDATADOGSYNTHETICSGLOBALVARIABLEFROMTEST_LOCALVARIABLE_LOCAL_1663092051","monitor_id":86719615,"type":"api","created_at":"2022-09-13T18:00:54.595386+00:00","creator":{"handle":"[email protected]","name":null,"email":"[email protected]"},"modified_at":"2022-09-13T18:00:54.595386+00:00","subtype":"multi","config":{"steps":[{"retry":{"count":5,"interval":1000},"name":"First api step","request":{"body":"this is a body","allow_insecure":true,"url":"https://www.datadoghq.com","follow_redirects":true,"timeout":30,"method":"GET"},"subtype":"http","allowFailure":true,"assertions":[{"operator":"is","type":"statusCode","target":200}],"isCritical":false,"id":"94v-6t6-psr","extractedValues":[{"field":"content-length","parser":{"type":"regex","value":".*"},"type":"http_header","name":"LOCAL_VAR_EXTRACT"}]}],"assertions":[],"configVariables":[]},"options":{"follow_redirects":true,"monitor_options":{"include_tags":true,"renotify_interval":120,"notify_audit":false,"new_host_delay":300,"on_missing_data":"show_no_data"},"min_location_failed":1,"tick_every":60}}
+    headers:
+      Content-Type:
+      - application/json
+    status: 200 OK
+    code: 200
+    duration: ""
+- request:
+    body: |
+      {"description":"a global variable from multistep test","name":"TF_TESTACCDATADOGSYNTHETICSGLOBALVARIABLEFROMTEST_LOCALVARIABLE_LOCAL_1663092051","parse_test_options":{"localVariableName":"LOCAL_VAR_EXTRACT","type":"local_variable"},"parse_test_public_id":"9bw-vck-5p9","tags":["foo:bar","baz"],"value":{"secure":false,"value":""}}
+    form: {}
+    headers:
+      Accept:
+      - application/json
+      Content-Type:
+      - application/json
+    url: https://api.datadoghq.com/api/v1/synthetics/variables
+    method: POST
+  response:
+    body: |
+      {"parse_test_options":{"type":"local_variable","localVariableName":"LOCAL_VAR_EXTRACT"},"parse_test_extracted_at":null,"description":"a global variable from multistep test","tags":["foo:bar","baz"],"last_error":null,"is_totp":null,"value":{"secure":false,"value":""},"parse_test_public_id":"9bw-vck-5p9","parse_test_name":null,"type":"variable","id":"819f1d49-7f73-4c05-8567-3626a453c9a3","name":"TF_TESTACCDATADOGSYNTHETICSGLOBALVARIABLEFROMTEST_LOCALVARIABLE_LOCAL_1663092051"}
+    headers:
+      Content-Type:
+      - application/json
+    status: 200 OK
+    code: 200
+    duration: ""
+- request:
+    body: ""
+    form: {}
+    headers:
+      Accept:
+      - application/json
+    url: https://api.datadoghq.com/api/v1/synthetics/variables/819f1d49-7f73-4c05-8567-3626a453c9a3
+    method: GET
+  response:
+    body: '{"parse_test_extracted_at":null,"description":"a global variable from multistep test","tags":["foo:bar","baz"],"last_error":null,"parse_test_public_id":"9bw-vck-5p9","is_totp":null,"id":"819f1d49-7f73-4c05-8567-3626a453c9a3","parse_test_options":{"type":"local_variable","localVariableName":"LOCAL_VAR_EXTRACT"},"name":"TF_TESTACCDATADOGSYNTHETICSGLOBALVARIABLEFROMTEST_LOCALVARIABLE_LOCAL_1663092051","created_at":"2022-09-13T18:00:55.115052+00:00","creator":{"handle":"[email protected]","name":null,"email":"[email protected]"},"modified_at":"2022-09-13T18:00:55.115052+00:00","value":{"secure":false,"value":""},"parse_test_name":null,"type":"variable"}'
+    headers:
+      Content-Type:
+      - application/json
+    status: 200 OK
+    code: 200
+    duration: ""
+- request:
+    body: ""
+    form: {}
+    headers:
+      Accept:
+      - application/json
+    url: https://api.datadoghq.com/api/v1/synthetics/variables/819f1d49-7f73-4c05-8567-3626a453c9a3
+    method: GET
+  response:
+    body: '{"parse_test_extracted_at":null,"description":"a global variable from multistep test","tags":["foo:bar","baz"],"last_error":null,"parse_test_public_id":"9bw-vck-5p9","is_totp":null,"id":"819f1d49-7f73-4c05-8567-3626a453c9a3","parse_test_options":{"type":"local_variable","localVariableName":"LOCAL_VAR_EXTRACT"},"name":"TF_TESTACCDATADOGSYNTHETICSGLOBALVARIABLEFROMTEST_LOCALVARIABLE_LOCAL_1663092051","created_at":"2022-09-13T18:00:55.115052+00:00","creator":{"handle":"[email protected]","name":null,"email":"[email protected]"},"modified_at":"2022-09-13T18:00:55.115052+00:00","value":{"secure":false,"value":""},"parse_test_name":null,"type":"variable"}'
+    headers:
+      Content-Type:
+      - application/json
+    status: 200 OK
+    code: 200
+    duration: ""
+- request:
+    body: ""
+    form: {}
+    headers:
+      Accept:
+      - application/json
+    url: https://api.datadoghq.com/api/v1/synthetics/variables/819f1d49-7f73-4c05-8567-3626a453c9a3
+    method: GET
+  response:
+    body: '{"parse_test_extracted_at":null,"description":"a global variable from multistep test","tags":["foo:bar","baz"],"last_error":null,"parse_test_public_id":"9bw-vck-5p9","is_totp":null,"id":"819f1d49-7f73-4c05-8567-3626a453c9a3","parse_test_options":{"type":"local_variable","localVariableName":"LOCAL_VAR_EXTRACT"},"name":"TF_TESTACCDATADOGSYNTHETICSGLOBALVARIABLEFROMTEST_LOCALVARIABLE_LOCAL_1663092051","created_at":"2022-09-13T18:00:55.115052+00:00","creator":{"handle":"[email protected]","name":null,"email":"[email protected]"},"modified_at":"2022-09-13T18:00:55.115052+00:00","value":{"secure":false,"value":""},"parse_test_name":null,"type":"variable"}'
+    headers:
+      Content-Type:
+      - application/json
+    status: 200 OK
+    code: 200
+    duration: ""
+- request:
+    body: ""
+    form: {}
+    headers:
+      Accept:
+      - application/json
+    url: https://api.datadoghq.com/api/v1/synthetics/tests/9bw-vck-5p9
+    method: GET
+  response:
+    body: |
+      {"status":"paused","public_id":"9bw-vck-5p9","tags":[],"locations":["aws:eu-central-1"],"message":"","name":"TF_TESTACCDATADOGSYNTHETICSGLOBALVARIABLEFROMTEST_LOCALVARIABLE_LOCAL_1663092051","monitor_id":86719615,"type":"api","created_at":"2022-09-13T18:00:54.595386+00:00","creator":{"handle":"[email protected]","name":null,"email":"[email protected]"},"modified_at":"2022-09-13T18:00:54.595386+00:00","subtype":"multi","config":{"steps":[{"retry":{"count":5,"interval":1000},"name":"First api step","request":{"body":"this is a body","allow_insecure":true,"url":"https://www.datadoghq.com","follow_redirects":true,"timeout":30,"method":"GET"},"subtype":"http","allowFailure":true,"assertions":[{"operator":"is","type":"statusCode","target":200}],"isCritical":false,"id":"94v-6t6-psr","extractedValues":[{"field":"content-length","parser":{"type":"regex","value":".*"},"type":"http_header","name":"LOCAL_VAR_EXTRACT"}]}],"assertions":[],"configVariables":[]},"options":{"follow_redirects":true,"monitor_options":{"include_tags":true,"renotify_interval":120,"notify_audit":false,"new_host_delay":300,"on_missing_data":"show_no_data"},"tick_every":60,"min_location_failed":1}}
+    headers:
+      Content-Type:
+      - application/json
+    status: 200 OK
+    code: 200
+    duration: ""
+- request:
+    body: ""
+    form: {}
+    headers:
+      Accept:
+      - application/json
+    url: https://api.datadoghq.com/api/v1/synthetics/tests/9bw-vck-5p9
+    method: GET
+  response:
+    body: |
+      {"status":"paused","public_id":"9bw-vck-5p9","tags":[],"locations":["aws:eu-central-1"],"message":"","name":"TF_TESTACCDATADOGSYNTHETICSGLOBALVARIABLEFROMTEST_LOCALVARIABLE_LOCAL_1663092051","monitor_id":86719615,"type":"api","created_at":"2022-09-13T18:00:54.595386+00:00","creator":{"handle":"[email protected]","name":null,"email":"[email protected]"},"modified_at":"2022-09-13T18:00:54.595386+00:00","subtype":"multi","config":{"steps":[{"retry":{"count":5,"interval":1000},"name":"First api step","request":{"body":"this is a body","allow_insecure":true,"url":"https://www.datadoghq.com","follow_redirects":true,"timeout":30,"method":"GET"},"subtype":"http","allowFailure":true,"assertions":[{"operator":"is","type":"statusCode","target":200}],"isCritical":false,"id":"94v-6t6-psr","extractedValues":[{"field":"content-length","parser":{"type":"regex","value":".*"},"type":"http_header","name":"LOCAL_VAR_EXTRACT"}]}],"assertions":[],"configVariables":[]},"options":{"follow_redirects":true,"monitor_options":{"include_tags":true,"renotify_interval":120,"notify_audit":false,"new_host_delay":300,"on_missing_data":"show_no_data"},"tick_every":60,"min_location_failed":1}}
+    headers:
+      Content-Type:
+      - application/json
+    status: 200 OK
+    code: 200
+    duration: ""
+- request:
+    body: ""
+    form: {}
+    headers:
+      Accept:
+      - application/json
+    url: https://api.datadoghq.com/api/v1/synthetics/tests/api/9bw-vck-5p9
+    method: GET
+  response:
+    body: |
+      {"status":"paused","public_id":"9bw-vck-5p9","tags":[],"locations":["aws:eu-central-1"],"message":"","name":"TF_TESTACCDATADOGSYNTHETICSGLOBALVARIABLEFROMTEST_LOCALVARIABLE_LOCAL_1663092051","monitor_id":86719615,"type":"api","created_at":"2022-09-13T18:00:54.595386+00:00","creator":{"handle":"[email protected]","name":null,"email":"[email protected]"},"modified_at":"2022-09-13T18:00:54.595386+00:00","subtype":"multi","config":{"steps":[{"retry":{"count":5,"interval":1000},"name":"First api step","request":{"body":"this is a body","allow_insecure":true,"url":"https://www.datadoghq.com","follow_redirects":true,"timeout":30,"method":"GET"},"subtype":"http","allowFailure":true,"assertions":[{"operator":"is","type":"statusCode","target":200}],"isCritical":false,"id":"94v-6t6-psr","extractedValues":[{"field":"content-length","parser":{"type":"regex","value":".*"},"type":"http_header","name":"LOCAL_VAR_EXTRACT"}]}],"assertions":[],"configVariables":[]},"options":{"follow_redirects":true,"monitor_options":{"include_tags":true,"renotify_interval":120,"notify_audit":false,"new_host_delay":300,"on_missing_data":"show_no_data"},"tick_every":60,"min_location_failed":1}}
+    headers:
+      Content-Type:
+      - application/json
+    status: 200 OK
+    code: 200
+    duration: ""
+- request:
+    body: ""
+    form: {}
+    headers:
+      Accept:
+      - application/json
+    url: https://api.datadoghq.com/api/v1/synthetics/variables/819f1d49-7f73-4c05-8567-3626a453c9a3
+    method: GET
+  response:
+    body: '{"parse_test_extracted_at":null,"description":"a global variable from multistep test","tags":["foo:bar","baz"],"last_error":null,"parse_test_public_id":"9bw-vck-5p9","is_totp":null,"id":"819f1d49-7f73-4c05-8567-3626a453c9a3","parse_test_options":{"type":"local_variable","localVariableName":"LOCAL_VAR_EXTRACT"},"name":"TF_TESTACCDATADOGSYNTHETICSGLOBALVARIABLEFROMTEST_LOCALVARIABLE_LOCAL_1663092051","created_at":"2022-09-13T18:00:55.115052+00:00","creator":{"handle":"[email protected]","name":null,"email":"[email protected]"},"modified_at":"2022-09-13T18:00:55.115052+00:00","value":{"secure":false,"value":""},"parse_test_name":null,"type":"variable"}'
+    headers:
+      Content-Type:
+      - application/json
+    status: 200 OK
+    code: 200
+    duration: ""
+- request:
+    body: ""
+    form: {}
+    headers:
+      Accept:
+      - '*/*'
+    url: https://api.datadoghq.com/api/v1/synthetics/variables/819f1d49-7f73-4c05-8567-3626a453c9a3
+    method: DELETE
+  response:
+    body: '{}'
+    headers:
+      Content-Type:
+      - application/json
+    status: 200 OK
+    code: 200
+    duration: ""
+- request:
+    body: |
+      {"public_ids":["9bw-vck-5p9"]}
+    form: {}
+    headers:
+      Accept:
+      - application/json
+      Content-Type:
+      - application/json
+    url: https://api.datadoghq.com/api/v1/synthetics/tests/delete
+    method: POST
+  response:
+    body: |
+      {"deleted_tests":[{"deleted_at":"2022-09-13T18:01:03.488705+00:00","public_id":"9bw-vck-5p9"}]}
+    headers:
+      Content-Type:
+      - application/json
+    status: 200 OK
+    code: 200
+    duration: ""
+- request:
+    body: ""
+    form: {}
+    headers:
+      Accept:
+      - application/json
+    url: https://api.datadoghq.com/api/v1/synthetics/tests/9bw-vck-5p9
+    method: GET
+  response:
+    body: '{"errors":["Synthetics test not found"]}'
+    headers:
+      Content-Type:
+      - application/json
+    status: 404 Not Found
+    code: 404
+    duration: ""
+- request:
+    body: ""
+    form: {}
+    headers:
+      Accept:
+      - application/json
+    url: https://api.datadoghq.com/api/v1/synthetics/variables/819f1d49-7f73-4c05-8567-3626a453c9a3
+    method: GET
+  response:
+    body: '{"errors": ["Synthetics global variable not found"]}'
+    headers:
+      Content-Type:
+      - application/json
+    status: 404 Not Found
+    code: 404
+    duration: ""