Add tests for notify_end monitor options (#1452)

Co-authored-by: ci.datadog-api-spec <[email protected]>

Author: api-clients-generation-pipeline[bot]

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.4",
-            "regenerated": "2023-05-05 15:02:39.419381",
-            "spec_repo_commit": "380840ff"
+            "regenerated": "2023-05-05 20:21:45.661672",
+            "spec_repo_commit": "70465187"
         },
         "v2": {
             "apigentools_version": "1.6.4",
-            "regenerated": "2023-05-05 15:02:39.431715",
-            "spec_repo_commit": "380840ff"
+            "regenerated": "2023-05-05 20:21:45.676846",
+            "spec_repo_commit": "70465187"
         }
     }
 }

examples/v1/downtimes/CreateDowntime.py

@@ -8,6 +8,10 @@
 from datadog_api_client.v1.api.downtimes_api import DowntimesApi
 from datadog_api_client.v1.model.downtime import Downtime
 from datadog_api_client.v1.model.downtime_recurrence import DowntimeRecurrence
+from datadog_api_client.v1.model.notify_end_state import NotifyEndState
+from datadog_api_client.v1.model.notify_end_states import NotifyEndStates
+from datadog_api_client.v1.model.notify_end_type import NotifyEndType
+from datadog_api_client.v1.model.notify_end_types import NotifyEndTypes
 
 body = Downtime(
     message="Example-Downtime",
@@ -28,6 +32,19 @@
         ],
         until_date=int((datetime.now() + relativedelta(days=21)).timestamp()),
     ),
+    notify_end_states=NotifyEndStates(
+        [
+            NotifyEndState.ALERT,
+            NotifyEndState.NO_DATA,
+            NotifyEndState.WARN,
+        ]
+    ),
+    notify_end_types=NotifyEndTypes(
+        [
+            NotifyEndType.CANCELED,
+            NotifyEndType.EXPIRED,
+        ]
+    ),
 )
 
 configuration = Configuration()

examples/v1/downtimes/UpdateDowntime.py

@@ -6,13 +6,30 @@
 from datadog_api_client import ApiClient, Configuration
 from datadog_api_client.v1.api.downtimes_api import DowntimesApi
 from datadog_api_client.v1.model.downtime import Downtime
+from datadog_api_client.v1.model.notify_end_state import NotifyEndState
+from datadog_api_client.v1.model.notify_end_states import NotifyEndStates
+from datadog_api_client.v1.model.notify_end_type import NotifyEndType
+from datadog_api_client.v1.model.notify_end_types import NotifyEndTypes
 
 # there is a valid "downtime" in the system
 DOWNTIME_ID = environ["DOWNTIME_ID"]
 
 body = Downtime(
     message="Example-Downtime-updated",
     mute_first_recovery_notification=True,
+    notify_end_states=NotifyEndStates(
+        [
+            NotifyEndState.ALERT,
+            NotifyEndState.NO_DATA,
+            NotifyEndState.WARN,
+        ]
+    ),
+    notify_end_types=NotifyEndTypes(
+        [
+            NotifyEndType.CANCELED,
+            NotifyEndType.EXPIRED,
+        ]
+    ),
 )
 
 configuration = Configuration()

tests/v1/cassettes/test_scenarios/test_schedule_a_downtime_returns_ok_response.frozen

@@ -1 +1 @@
-2022-05-12T09:49:59.145Z
+2023-05-05T17:14:34.652Z

tests/v1/cassettes/test_scenarios/test_schedule_a_downtime_returns_ok_response.yaml

@@ -1,6 +1,7 @@
 interactions:
 - request:
-    body: '{"message":"Test-Schedule_a_downtime_returns_OK_response-1652348999","recurrence":{"period":1,"type":"weeks","until_date":1654163399,"week_days":["Mon","Tue","Wed","Thu","Fri"]},"scope":["test:testscheduleadowntimereturnsokresponse1652348999"],"start":1652348999,"timezone":"Etc/UTC"}'
+    body: '{"message":"Test-Schedule_a_downtime_returns_OK_response-1683306874","notify_end_states":["alert","no
+      data","warn"],"notify_end_types":["canceled","expired"],"recurrence":{"period":1,"type":"weeks","until_date":1685121274,"week_days":["Mon","Tue","Wed","Thu","Fri"]},"scope":["test:testscheduleadowntimereturnsokresponse1683306874"],"start":1683306874,"timezone":"Etc/UTC"}'
     headers:
       accept:
       - application/json
@@ -10,7 +11,10 @@ interactions:
     uri: https://api.datadoghq.com/api/v1/downtime
   response:
     body:
-      string: '{"recurrence":{"until_date":1654163399,"until_occurrences":null,"week_days":["Mon","Tue","Wed","Thu","Fri"],"type":"weeks","period":1},"end":null,"monitor_tags":["*"],"child_id":null,"canceled":null,"monitor_id":null,"mute_first_recovery_notification":false,"created":1652348999,"org_id":321813,"modified":1652348999,"disabled":false,"start":1652348999,"creator_id":1445416,"parent_id":null,"timezone":"Etc/UTC","active":true,"scope":["test:testscheduleadowntimereturnsokresponse1652348999"],"message":"Test-Schedule_a_downtime_returns_OK_response-1652348999","downtime_type":2,"id":1944162282,"updater_id":null}'
+      string: '{"id":2893677175,"monitor_id":null,"org_id":321813,"start":1683306874,"end":null,"canceled":null,"created":1683306874,"modified":1683306874,"message":"Test-Schedule_a_downtime_returns_OK_response-1683306874","active":true,"disabled":false,"recurrence":{"type":"weeks","period":1,"week_days":["Mon","Tue","Wed","Thu","Fri"],"until_occurrences":null,"until_date":1685121274},"timezone":"Etc/UTC","parent_id":null,"child_id":null,"creator_id":1445416,"updater_id":null,"downtime_type":2,"status":"active","monitor_tags":["*"],"mute_first_recovery_notification":false,"notify_end_types":["canceled","expired"],"notify_end_states":["alert","no
+        data","warn"],"uuid":"4ebe21fc-eb68-11ed-a070-da7ad0900002","scope":["test:testscheduleadowntimereturnsokresponse1683306874"]}
+
+        '
     headers:
       content-type:
       - application/json
@@ -23,11 +27,13 @@ interactions:
       accept:
       - '*/*'
     method: DELETE
-    uri: https://api.datadoghq.com/api/v1/downtime/1944162282
+    uri: https://api.datadoghq.com/api/v1/downtime/2893677175
   response:
     body:
       string: ''
-    headers: {}
+    headers:
+      content-type:
+      - text/html; charset=utf-8
     status:
       code: 204
       message: No Content

tests/v1/cassettes/test_scenarios/test_update_a_downtime_returns_ok_response.frozen

@@ -1 +1 @@
-2022-05-12T09:50:03.922Z
+2023-05-05T17:13:01.274Z

tests/v1/cassettes/test_scenarios/test_update_a_downtime_returns_ok_response.yaml

@@ -1,6 +1,6 @@
 interactions:
 - request:
-    body: '{"message":"Test-Update_a_downtime_returns_OK_response-1652349003","recurrence":{"period":1,"type":"weeks","until_date":1654163403,"week_days":["Mon","Tue","Wed","Thu","Fri"]},"scope":["test:testupdateadowntimereturnsokresponse1652349003"],"start":1652349003,"timezone":"Etc/UTC"}'
+    body: '{"message":"Test-Update_a_downtime_returns_OK_response-1683306781","recurrence":{"period":1,"type":"weeks","until_date":1685121181,"week_days":["Mon","Tue","Wed","Thu","Fri"]},"scope":["test:testupdateadowntimereturnsokresponse1683306781"],"start":1683306781,"timezone":"Etc/UTC"}'
     headers:
       accept:
       - application/json
@@ -10,25 +10,32 @@ interactions:
     uri: https://api.datadoghq.com/api/v1/downtime
   response:
     body:
-      string: '{"recurrence":{"until_date":1654163403,"until_occurrences":null,"week_days":["Mon","Tue","Wed","Thu","Fri"],"type":"weeks","period":1},"end":null,"monitor_tags":["*"],"child_id":null,"canceled":null,"monitor_id":null,"mute_first_recovery_notification":false,"created":1652349004,"org_id":321813,"modified":1652349004,"disabled":false,"start":1652349003,"creator_id":1445416,"parent_id":null,"timezone":"Etc/UTC","active":true,"scope":["test:testupdateadowntimereturnsokresponse1652349003"],"message":"Test-Update_a_downtime_returns_OK_response-1652349003","downtime_type":2,"id":1944162328,"updater_id":null}'
+      string: '{"id":2893673146,"monitor_id":null,"org_id":321813,"start":1683306781,"end":null,"canceled":null,"created":1683306781,"modified":1683306781,"message":"Test-Update_a_downtime_returns_OK_response-1683306781","active":true,"disabled":false,"recurrence":{"type":"weeks","period":1,"week_days":["Mon","Tue","Wed","Thu","Fri"],"until_occurrences":null,"until_date":1685121181},"timezone":"Etc/UTC","parent_id":null,"child_id":null,"creator_id":1445416,"updater_id":null,"downtime_type":2,"status":"active","monitor_tags":["*"],"mute_first_recovery_notification":false,"notify_end_types":["expired"],"notify_end_states":["alert","no
+        data","warn"],"uuid":"171537cc-eb68-11ed-8a83-da7ad0900002","scope":["test:testupdateadowntimereturnsokresponse1683306781"]}
+
+        '
     headers:
       content-type:
       - application/json
     status:
       code: 200
       message: OK
 - request:
-    body: '{"message":"Test-Update_a_downtime_returns_OK_response-1652349003-updated","mute_first_recovery_notification":true}'
+    body: '{"message":"Test-Update_a_downtime_returns_OK_response-1683306781-updated","mute_first_recovery_notification":true,"notify_end_states":["alert","no
+      data","warn"],"notify_end_types":["canceled","expired"]}'
     headers:
       accept:
       - application/json
       content-type:
       - application/json
     method: PUT
-    uri: https://api.datadoghq.com/api/v1/downtime/1944162328
+    uri: https://api.datadoghq.com/api/v1/downtime/2893673146
   response:
     body:
-      string: '{"recurrence":{"until_date":1654163403,"until_occurrences":null,"week_days":["Mon","Tue","Wed","Thu","Fri"],"type":"weeks","period":1},"end":null,"monitor_tags":["*"],"child_id":null,"canceled":null,"monitor_id":null,"mute_first_recovery_notification":true,"created":1652349004,"org_id":321813,"modified":1652349004,"disabled":false,"start":1652349003,"creator_id":1445416,"parent_id":null,"timezone":"Etc/UTC","active":true,"scope":["test:testupdateadowntimereturnsokresponse1652349003"],"message":"Test-Update_a_downtime_returns_OK_response-1652349003-updated","downtime_type":2,"id":1944162328,"updater_id":1445416}'
+      string: '{"id":2893673146,"monitor_id":null,"org_id":321813,"start":1683306781,"end":null,"canceled":null,"created":1683306781,"modified":1683306781,"message":"Test-Update_a_downtime_returns_OK_response-1683306781-updated","active":true,"disabled":false,"recurrence":{"type":"weeks","period":1,"week_days":["Mon","Tue","Wed","Thu","Fri"],"until_occurrences":null,"until_date":1685121181},"timezone":"Etc/UTC","parent_id":null,"child_id":null,"creator_id":1445416,"updater_id":1445416,"downtime_type":2,"status":"active","monitor_tags":["*"],"mute_first_recovery_notification":true,"notify_end_types":["canceled","expired"],"notify_end_states":["alert","no
+        data","warn"],"uuid":null,"scope":["test:testupdateadowntimereturnsokresponse1683306781"]}
+
+        '
     headers:
       content-type:
       - application/json
@@ -41,11 +48,13 @@ interactions:
       accept:
       - '*/*'
     method: DELETE
-    uri: https://api.datadoghq.com/api/v1/downtime/1944162328
+    uri: https://api.datadoghq.com/api/v1/downtime/2893673146
   response:
     body:
       string: ''
-    headers: {}
+    headers:
+      content-type:
+      - text/html; charset=utf-8
     status:
       code: 204
       message: No Content

tests/v1/features/downtimes.feature

@@ -115,11 +115,13 @@ Feature: Downtimes
   @team:DataDog/monitor-app
   Scenario: Schedule a downtime returns "OK" response
     Given new "CreateDowntime" request
-    And body with value {"message": "{{ unique }}", "start": {{ timestamp("now") }}, "timezone": "Etc/UTC", "scope": ["test:{{ unique_lower_alnum }}"], "recurrence": {"type": "weeks", "period": 1, "week_days": ["Mon", "Tue", "Wed", "Thu", "Fri"], "until_date": {{ timestamp("now + 21d")}} }}
+    And body with value {"message": "{{ unique }}", "start": {{ timestamp("now") }}, "timezone": "Etc/UTC", "scope": ["test:{{ unique_lower_alnum }}"], "recurrence": {"type": "weeks", "period": 1, "week_days": ["Mon", "Tue", "Wed", "Thu", "Fri"], "until_date": {{ timestamp("now + 21d")}} }, "notify_end_states": ["alert", "no data", "warn"], "notify_end_types": ["canceled", "expired"]}
     When the request is sent
     Then the response status is 200 OK
     And the response "message" is equal to "{{ unique }}"
     And the response "active" is equal to true
+    And the response "notify_end_states" array contains value "alert"
+    And the response "notify_end_types" array contains value "canceled"
 
   @team:DataDog/monitor-app
   Scenario: Schedule a downtime until date
@@ -192,7 +194,9 @@ Feature: Downtimes
     Given there is a valid "downtime" in the system
     And new "UpdateDowntime" request
     And request contains "downtime_id" parameter from "downtime.id"
-    And body with value {"message": "{{ unique}}-updated", "mute_first_recovery_notification": true}
+    And body with value {"message": "{{ unique}}-updated", "mute_first_recovery_notification": true, "notify_end_states": ["alert", "no data", "warn"], "notify_end_types": ["canceled", "expired"]}
     When the request is sent
     Then the response status is 200 OK
     And the response "message" is equal to "{{ unique }}-updated"
+    And the response "notify_end_states" array contains value "alert"
+    And the response "notify_end_types" array contains value "canceled"