add template helpers for timestamps

Author: nkzou

.generator/src/generator/templates/function_mappings.j2

@@ -54,9 +54,19 @@ pub fn collect_function_calls(world: &mut DatadogWorld) {
 fn test_{{version}}_{{ operation['operationId'] | snake_case }}(world: &mut DatadogWorld, _parameters: &HashMap<String, Value>) {
     let api = world.api_instances.{{version}}_{{ apiName }}.as_ref().expect("api instance not found");
     {%- if operationParams|length > 0 -%}
+    {%- for parameter in operationParams %}
+    {%- if parameter[1].required %}
+    let {{ parameter[0] | variable_name }} = serde_json::from_value(_parameters.get("{{ parameter[0] }}").unwrap().clone()).unwrap();
+    {%- else %}
+    let {{ parameter[0] | variable_name }} = match _parameters.get("{{ parameter[0] }}").is_some() {
+        true => serde_json::from_value(_parameters.get("{{ parameter[0] }}").unwrap().clone()).unwrap(),
+        false => None,
+    };
+    {%- endif %}
+    {%- endfor %}
     let params = datadog{{ version.upper() }}::api::{{ apiName }}::{{ operation['operationId'] }}Params {
         {%- for param in operationParams %}
-        {{ param[0] | variable_name }}: serde_json::from_value(_parameters.get("{{ param[0] }}").unwrap().clone()).unwrap(),
+        {{ param[0] | variable_name }},
         {%- endfor %}
     };
     let response = match block_on(api.{{ operation['operationId'] | snake_case}}_with_http_info(params)) {

tests/scenarios/features/v2/fastly_integration.feature

@@ -243,4 +243,4 @@ Feature: Fastly Integration
     And request contains "service_id" parameter from "REPLACE.ME"
     And body with value {"data": {"attributes": {"tags": ["myTag", "myTag2:myValue"]}, "id": "abc123", "type": "fastly-services"}}
     When the request is sent
-    Then the response status is 200 OK
+    Then the response status is 200 OK

tests/scenarios/features/v2/given.json

@@ -306,6 +306,18 @@
     "tag": "Roles",
     "operationId": "ListPermissions"
   },
+  {
+    "parameters": [
+      {
+        "name": "body",
+        "value": "{\n    \"data\": {\n        \"attributes\": {\n            \"description\": \"Sample powerpack\",\n            \"group_widget\": {\n                \"definition\": {\n                    \"layout_type\": \"ordered\",\n                    \"show_title\": true,\n                    \"title\": \"Sample Powerpack\",\n                    \"type\": \"group\",\n                    \"widgets\": [\n                        {\n                            \"definition\": {\n                                \"content\": \"test\",\n                                \"type\": \"note\"\n                            }\n                        }\n                    ]\n                },\n                \"layout\": {\n                    \"height\": 3,\n                    \"width\": 12,\n                    \"x\": 0,\n                    \"y\": 0\n                },\n                \"live_span\": \"1h\"\n            },\n            \"name\": \"{{ unique }}\",\n            \"tags\": [\n                \"tag:sample\"\n            ],\n            \"template_variables\": [\n                {\n                    \"defaults\": [\n                        \"*\"\n                    ],\n                    \"name\": \"sample\"\n                }\n            ]\n        },\n        \"type\": \"powerpack\"\n    }\n}"
+      }
+    ],
+    "step": "there is a valid \"powerpack\" in the system",
+    "key": "powerpack",
+    "tag": "Powerpack",
+    "operationId": "CreatePowerpack"
+  },
   {
     "parameters": [
       {

tests/scenarios/features/v2/undo.json

@@ -104,6 +104,12 @@
       "type": "idempotent"
     }
   },
+  "GetApmRetentionFilter": {
+    "tag": "APM Retention Filters",
+    "undo": {
+      "type": "safe"
+    }
+  },
   "UpdateApmRetentionFilter": {
     "tag": "APM Retention Filters",
     "undo": {
@@ -225,6 +231,18 @@
       "type": "safe"
     }
   },
+  "ListContainerImages": {
+    "tag": "Container Images",
+    "undo": {
+      "type": "safe"
+    }
+  },
+  "ListContainers": {
+    "tag": "Containers",
+    "undo": {
+      "type": "safe"
+    }
+  },
   "ListCurrentUserApplicationKeys": {
     "tag": "Key Management",
     "undo": {
@@ -1005,18 +1023,55 @@
       "type": "safe"
     }
   },
-  "GetFinding": {
+  "MuteFindings": {
     "tag": "Security Monitoring",
     "undo": {
       "type": "safe"
     }
   },
-  "UpdateFinding": {
+  "GetFinding": {
     "tag": "Security Monitoring",
     "undo": {
       "type": "safe"
     }
   },
+  "ListPowerpacks": {
+    "tag": "Powerpack",
+    "undo": {
+      "type": "safe"
+    }
+  },
+  "CreatePowerpack": {
+    "tag": "Powerpack",
+    "undo": {
+      "operationId": "DeletePowerpack",
+      "parameters": [
+        {
+          "name": "powerpack_id",
+          "source": "data.id"
+        }
+      ],
+      "type": "unsafe"
+    }
+  },
+  "DeletePowerpack": {
+    "tag": "Powerpack",
+    "undo": {
+      "type": "idempotent"
+    }
+  },
+  "GetPowerpack": {
+    "tag": "Powerpack",
+    "undo": {
+      "type": "safe"
+    }
+  },
+  "UpdatePowerpack": {
+    "tag": "Powerpack",
+    "undo": {
+      "type": "idempotent"
+    }
+  },
   "ListProcesses": {
     "tag": "Processes",
     "undo": {

tests/scenarios/fixtures.rs

@@ -1,14 +1,14 @@
 use crate::scenarios::function_mappings::{
     collect_function_calls, initialize_api_instance, ApiInstances,
 };
-use chrono::DateTime;
+use chrono::{DateTime, Duration};
 use cucumber::{
     event::ScenarioFinished,
     gherkin::{Feature, Rule, Scenario},
     given, then, when, World,
 };
 use datadog_api_client::datadog::configuration::Configuration;
-use handlebars::Handlebars;
+use handlebars::{Context, Handlebars, Helper, Output, RenderContext, RenderError};
 use log::debug;
 use regex::Regex;
 use reqwest_middleware::ClientBuilder;
@@ -20,6 +20,7 @@ use std::{
     env,
     fs::{create_dir_all, read_to_string, File},
     io::BufReader,
+    ops::Add,
     path::PathBuf,
     time::SystemTime,
 };
@@ -39,7 +40,7 @@ struct UndoOperation {
     parameters: HashMap<String, Value>,
 }
 
-#[derive(Debug, Default, World)]
+#[derive(Default, World)]
 pub struct DatadogWorld {
     pub api_version: i32,
     pub config: Configuration,
@@ -54,6 +55,14 @@ pub struct DatadogWorld {
     undo_operations: Vec<UndoOperation>,
 }
 
+// Workaround to suppress cucumber's debug output - the DatadogWorld
+// struct debug output is overly verbose and not useful
+impl std::fmt::Debug for DatadogWorld {
+    fn fmt(&self, _: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+        Ok(())
+    }
+}
+
 pub async fn before_scenario(
     feature: &Feature,
     _rule: Option<&Rule>,
@@ -144,7 +153,7 @@ pub async fn before_scenario(
             //         res.headers.remove_entry("content-security-policy");
             //     });
             // vcr_client_builder.with(middleware).build()
-            panic!("sdk's shouldn't be recording, that's the spec repo's job.");
+            panic!("Use the cassette transform in datadog-api-spec instead. This recording mode is only here for completeness.");
         }
         _ => {
             frozen_time = DateTime::parse_from_rfc3339(
@@ -387,9 +396,79 @@ fn lookup(path: &String, object: &Value) -> Option<Value> {
     return object.pointer(&json_pointer).cloned();
 }
 
+fn relative_time_helper(h: &Helper, c: &Context) -> DateTime<chrono::Utc> {
+    // get parameter from helper or throw an error
+    let v = h.param(0).unwrap().render();
+    let time_helper_re = Regex::new(r"now(?: *([+-]) *(\d+)([smhdMy]))?").unwrap();
+    let caps = time_helper_re
+        .captures(&v)
+        .expect("failed to parse timeISO template function");
+    let time = chrono::DateTime::from_timestamp(c.data().get("now").unwrap().as_i64().unwrap(), 0)
+        .unwrap();
+    if caps.get(1).is_some() {
+        let diff = str::parse::<i64>(
+            &(caps.get(1).unwrap().as_str().to_string() + caps.get(2).unwrap().as_str()),
+        )
+        .unwrap();
+        match caps.get(3).unwrap().as_str() {
+            "s" => time.add(Duration::seconds(diff)),
+            "m" => time.add(Duration::minutes(diff)),
+            "h" => time.add(Duration::hours(diff)),
+            "d" => time.add(Duration::days(diff)),
+            "M" => time.add(Duration::weeks(diff * 4)),
+            "y" => time.add(Duration::weeks(diff * 52)),
+            _ => panic!("invalid time unit"),
+        }
+    } else {
+        time
+    }
+}
+
+fn timeISO_helper(
+    h: &Helper,
+    _: &Handlebars,
+    c: &Context,
+    _: &mut RenderContext,
+    out: &mut dyn Output,
+) -> Result<(), RenderError> {
+    write!(out, "{}", relative_time_helper(h, c).to_rfc3339())?;
+    Ok(())
+}
+
+fn timestamp_helper(
+    h: &Helper,
+    _: &Handlebars,
+    c: &Context,
+    _: &mut RenderContext,
+    out: &mut dyn Output,
+) -> Result<(), RenderError> {
+    write!(
+        out,
+        "{}",
+        relative_time_helper(h, c)
+            .signed_duration_since(DateTime::UNIX_EPOCH)
+            .num_seconds()
+    )?;
+    Ok(())
+}
+
 fn template(string: String, fixtures: &Value) -> String {
-    Handlebars::new()
-        .render_template(string.as_str(), &fixtures)
+    let time_helper_re = Regex::new(r"(?:timestamp|timeISO)\([^{}]*\)").unwrap();
+    let helper_parsed_string = time_helper_re
+        .replace_all(&string, |caps: &regex::Captures| {
+            caps.get(0)
+                .unwrap()
+                .as_str()
+                .replace('(', " ")
+                .replace(')', "")
+        })
+        .to_string();
+
+    let mut handlebars = Handlebars::new();
+    handlebars.register_helper("timeISO", Box::new(timeISO_helper));
+    handlebars.register_helper("timestamp", Box::new(timestamp_helper));
+    handlebars
+        .render_template(helper_parsed_string.as_str(), &fixtures)
         .expect("failed to apply template")
 }