Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[datadog_synthetics] Add support for xpath assertions #1632

Merged
merged 4 commits into from
Nov 9, 2022
Merged

[datadog_synthetics] Add support for xpath assertions #1632

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f13a3fc
Update go client
romainberger Nov 8, 2022
2cc15df
[Synthetics] Add support for xpath assertions
romainberger Oct 13, 2022
8a58ad5
Update docs
romainberger Nov 8, 2022
e397469
fmt test example
skarimo Nov 9, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
117 changes: 107 additions & 10 deletions datadog/resource_datadog_synthetics_test_.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -412,6 +412,31 @@ func syntheticsAPIAssertion() *schema.Schema {
},
},
},
"targetxpath": {
Description: "Expected structure if `operator` is `validatesXPath`. Exactly one nested block is allowed with the structure below.",
Type: schema.TypeList,
Optional: true,
MaxItems: 1,
Elem: &schema.Resource{
Schema: map[string]*schema.Schema{
"operator": {
Description: "The specific operator to use on the path.",
Type: schema.TypeString,
Required: true,
},
"xpath": {
Description: "The xpath to assert.",
Type: schema.TypeString,
Required: true,
},
"targetvalue": {
Description: "Expected matching value.",
Type: schema.TypeString,
Required: true,
},
},
},
},
},
},
}
Expand Down Expand Up @@ -1622,6 +1647,7 @@ func buildAssertions(attr []interface{}) []datadogV1.SyntheticsAssertion {
if v, ok := targetMap["jsonpath"]; ok {
subTarget.SetJsonPath(v.(string))
}

operator, ok := targetMap["operator"]
if ok {
subTarget.SetOperator(operator.(string))
Expand All @@ -1634,7 +1660,9 @@ func buildAssertions(attr []interface{}) []datadogV1.SyntheticsAssertion {
if match, _ := regexp.MatchString("{{\\s*([^{}]*?)\\s*}}", v.(string)); match {
subTarget.SetTargetValue(v)
} else {
setFloatTargetValue(subTarget, v.(string))
if floatValue, err := strconv.ParseFloat(v.(string), 64); err == nil {
subTarget.SetTargetValue(floatValue)
}
}
default:
subTarget.SetTargetValue(v)
Expand All @@ -1643,9 +1671,46 @@ func buildAssertions(attr []interface{}) []datadogV1.SyntheticsAssertion {
assertionJSONPathTarget.SetTarget(*subTarget)
}
if _, ok := assertionMap["target"]; ok {
log.Printf("[WARN] target shouldn't be specified for validateJSONPath operator, only targetjsonpath")
log.Printf("[WARN] target shouldn't be specified for validatesJSONPath operator, only targetjsonpath")
}
assertions = append(assertions, datadogV1.SyntheticsAssertionJSONPathTargetAsSyntheticsAssertion(assertionJSONPathTarget))
} else if assertionOperator == string(datadogV1.SYNTHETICSASSERTIONXPATHOPERATOR_VALIDATES_X_PATH) {
assertionXPathTarget := datadogV1.NewSyntheticsAssertionXPathTarget(datadogV1.SyntheticsAssertionXPathOperator(assertionOperator), datadogV1.SyntheticsAssertionType(assertionType))
if v, ok := assertionMap["property"].(string); ok && len(v) > 0 {
assertionXPathTarget.SetProperty(v)
}
if v, ok := assertionMap["targetxpath"].([]interface{}); ok && len(v) > 0 {
subTarget := datadogV1.NewSyntheticsAssertionXPathTargetTarget()
targetMap := v[0].(map[string]interface{})
if v, ok := targetMap["xpath"]; ok {
subTarget.SetXPath(v.(string))
}
operator, ok := targetMap["operator"]
if ok {
subTarget.SetOperator(operator.(string))
}
if v, ok := targetMap["targetvalue"]; ok {
switch datadogV1.SyntheticsAssertionOperator(operator.(string)) {
case
datadogV1.SYNTHETICSASSERTIONOPERATOR_LESS_THAN,
datadogV1.SYNTHETICSASSERTIONOPERATOR_MORE_THAN:
if match, _ := regexp.MatchString("{{\\s*([^{}]*?)\\s*}}", v.(string)); match {
subTarget.SetTargetValue(v)
} else {
if floatValue, err := strconv.ParseFloat(v.(string), 64); err == nil {
subTarget.SetTargetValue(floatValue)
}
}
default:
subTarget.SetTargetValue(v)
}
}
assertionXPathTarget.SetTarget(*subTarget)
}
if _, ok := assertionMap["target"]; ok {
log.Printf("[WARN] target shouldn't be specified for validateXPath operator, only targetxpath")
}
assertions = append(assertions, datadogV1.SyntheticsAssertionXPathTargetAsSyntheticsAssertion(assertionXPathTarget))
} else {
assertionTarget := datadogV1.NewSyntheticsAssertionTargetWithDefaults()
assertionTarget.SetOperator(datadogV1.SyntheticsAssertionOperator(assertionOperator))
Expand All @@ -1665,7 +1730,10 @@ func buildAssertions(attr []interface{}) []datadogV1.SyntheticsAssertion {
}
}
if v, ok := assertionMap["targetjsonpath"].([]interface{}); ok && len(v) > 0 {
log.Printf("[WARN] targetjsonpath shouldn't be specified for non-validateJSONPath operator, only target")
log.Printf("[WARN] targetjsonpath shouldn't be specified for non-validatesJSONPath operator, only target")
}
if v, ok := assertionMap["targetxpath"].([]interface{}); ok && len(v) > 0 {
log.Printf("[WARN] targetxpath shouldn't be specified for non-validatesXPath operator, only target")
}
assertions = append(assertions, datadogV1.SyntheticsAssertionTargetAsSyntheticsAssertion(assertionTarget))
}
Expand Down Expand Up @@ -2138,6 +2206,37 @@ func buildLocalAssertions(actualAssertions []datadogV1.SyntheticsAssertion) (loc
if v, ok := assertionTarget.GetTypeOk(); ok {
localAssertion["type"] = string(*v)
}
} else if assertion.SyntheticsAssertionXPathTarget != nil {
assertionTarget := assertion.SyntheticsAssertionXPathTarget
if v, ok := assertionTarget.GetOperatorOk(); ok {
localAssertion["operator"] = string(*v)
}
if assertionTarget.HasProperty() {
localAssertion["property"] = assertionTarget.GetProperty()
}
if target, ok := assertionTarget.GetTargetOk(); ok {
localTarget := make(map[string]string)
if v, ok := target.GetXPathOk(); ok {
localTarget["xpath"] = string(*v)
}
if v, ok := target.GetOperatorOk(); ok {
localTarget["operator"] = string(*v)
}
if v, ok := target.GetTargetValueOk(); ok {
val := (*v).(interface{})
if vAsString, ok := val.(string); ok {
localTarget["targetvalue"] = vAsString
} else if vAsFloat, ok := val.(float64); ok {
localTarget["targetvalue"] = strconv.FormatFloat(vAsFloat, 'f', -1, 64)
} else {
return localAssertions, fmt.Errorf("unrecognized targetvalue type %v", v)
}
}
localAssertion["targetxpath"] = []map[string]string{localTarget}
}
if v, ok := assertionTarget.GetTypeOk(); ok {
localAssertion["type"] = string(*v)
}
}
localAssertions[i] = localAssertion
}
Expand Down Expand Up @@ -2845,17 +2944,15 @@ func convertToString(i interface{}) string {
}
}

func setFloatTargetValue(subTarget *datadogV1.SyntheticsAssertionJSONPathTargetTarget, value string) {
if floatValue, err := strconv.ParseFloat(value, 64); err == nil {
subTarget.SetTargetValue(floatValue)
}
}

func validateSyntheticsAssertionOperator(val interface{}, key string) (warns []string, errs []error) {
_, err := datadogV1.NewSyntheticsAssertionOperatorFromValue(val.(string))
if err != nil {
_, err2 := datadogV1.NewSyntheticsAssertionJSONPathOperatorFromValue(val.(string))
if err2 != nil {
_, err3 := datadogV1.NewSyntheticsAssertionXPathOperatorFromValue(val.(string))

if err2 == nil || err3 == nil {
return
} else {
errs = append(errs, err, err2)
}
}
Expand Down
2 changes: 1 addition & 1 deletion datadog/tests/cassettes/TestAccDatadogSyntheticsAPITest_BasicNewAssertionsOptions.freeze
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
2022-09-06T21:35:48.291246+02:00
2022-11-08T15:54:37.715516+01:00
Loading