[MA-669] Add support for /v1/downtime/cancel/by_scope. (#488)

* [MA-669] Add support for `/v1/downtime/cancel/by_scope`.

* Add back the `show_all_parser` for `datadog/dogshell/downtime.py`.

* [MA-669] Add tests for the `cancel_downtime_by_scope` functionality.

* [MA-669] Verify downtime is still `disabled=False` if not canceled.

datadog/api/downtimes.py

@@ -1,10 +1,23 @@
 from datadog.api.resources import GetableAPIResource, CreateableAPIResource,\
-    UpdatableAPIResource, ListableAPIResource, DeletableAPIResource
+    UpdatableAPIResource, ListableAPIResource, DeletableAPIResource, \
+    ActionAPIResource
 
 
 class Downtime(GetableAPIResource, CreateableAPIResource, UpdatableAPIResource,
-               ListableAPIResource, DeletableAPIResource):
+               ListableAPIResource, DeletableAPIResource, ActionAPIResource):
     """
     A wrapper around Monitor Downtiming HTTP API.
     """
     _resource_name = 'downtime'
+
+    @classmethod
+    def cancel_downtime_by_scope(cls, **body):
+        """
+        Cancels all downtimes matching the scope.
+
+        :param scope: scope to cancel downtimes by
+        :type scope: string
+
+        :returns: Dictionary representing the API's JSON response
+        """
+        return super(Downtime, cls)._trigger_class_action('POST', 'cancel/by_scope', **body)

datadog/dogshell/downtime.py

@@ -53,6 +53,10 @@ def setup_parser(cls, subparsers):
         delete_parser.add_argument('downtime_id', help="downtime to delete")
         delete_parser.set_defaults(func=cls._cancel_downtime)
 
+        cancel_parser = verb_parsers.add_parser('cancel_by_scope', help="Cancel all downtimes with a given scope")
+        cancel_parser.add_argument('scope', help="The scope of the downtimes to cancel")
+        cancel_parser.set_defaults(func=cls._cancel_downtime_by_scope)
+
     @classmethod
     def _schedule_downtime(cls, args):
         api._timeout = args.timeout
@@ -110,3 +114,13 @@ def _show_all_downtime(cls, args):
             print(pretty_json(res))
         else:
             print(json.dumps(res))
+
+    @classmethod
+    def _cancel_downtime_by_scope(cls, args):
+        api._timeout = args.timeout
+        format = args.format
+        res = api.Downtime.cancel_downtime_by_scope(scope=args.scope)
+        if format == 'pretty':
+            print(pretty_json(res))
+        else:
+            print(json.dumps(res))

tests/integration/api/test_api.py

@@ -649,6 +649,52 @@ def test_downtime(self):
             "Downtime", downtime["id"], retry_condition=lambda r: r["disabled"] is False
         )
 
+    def test_downtime_cancel_by_scope(self):
+        scope_one = "test:integration_one"
+        scope_two = "test:integration_two"
+        start = int(time.time())
+
+        # Create downtime with scope_one
+        end = start + 1000
+        downtime_one = dog.Downtime.create(scope=scope_one, start=start, end=end)
+        assert downtime_one["scope"] == [scope_one]
+        assert downtime_one["disabled"] is False
+
+        # Create downtime with scope_one
+        end = int(time.time()) + 60000
+        downtime_two = dog.Downtime.create(scope=scope_one, start=start, end=end)
+        assert downtime_two["scope"] == [scope_one]
+        assert downtime_two["disabled"] is False
+
+        end = int(time.time()) + 120000
+        downtime_three = dog.Downtime.create(scope=scope_two, start=start, end=end)
+        assert downtime_three["scope"] == [scope_two]
+        assert downtime_three["disabled"] is False
+
+        downtimes_with_scope_one = [downtime_one, downtime_two]
+        downtimes_with_scope_two = [downtime_three]
+
+        # Cancel downtimes with scope `scope_one`
+        dog.Downtime.cancel_downtime_by_scope(scope=scope_one)
+
+        # Verify only the downtimes with scope `scope_one` were canceled
+        for downtime in downtimes_with_scope_one:
+            get_with_retry(
+                "Downtime", downtime["id"], retry_condition=lambda r: r["disabled"] is False
+            )
+        for downtime in downtimes_with_scope_two:
+            d = get_with_retry("Downtime", downtime["id"])
+            assert d["disabled"] is False
+
+        # Cancel downtimes with scope `scope_two`
+        dog.Downtime.cancel_downtime_by_scope(scope=scope_two)
+
+        # Verify downtimes with scope `scope_two` were canceled
+        for downtime in downtimes_with_scope_two:
+            get_with_retry(
+                "Downtime", downtime["id"], retry_condition=lambda r: r["disabled"] is False
+            )
+
     def test_service_check(self):
         assert dog.ServiceCheck.check(
             check="check_pg",

tests/integration/dogshell/test_dogshell.py

@@ -535,6 +535,24 @@ def test_downtime_schedule(self):
         assert out["scope"][0] == scope
         assert out["disabled"] is True
 
+    def test_downtime_cancel_by_scope(self):
+        # Schedule a downtime
+        scope = "env:staging"
+        out, _, _ = self.dogshell(["downtime", "post", scope, str(int(time.time()))])
+        out = json.loads(out)
+        assert out["scope"][0] == scope
+        assert out["disabled"] is False
+        downtime_id = str(out["id"])
+
+        # Cancel the downtime by scope
+        self.dogshell(["downtime", "cancel_by_scope", scope])
+
+        # Get downtime and check if it is cancelled
+        out, _, _ = self.dogshell(["downtime", "show", downtime_id])
+        out = json.loads(out)
+        assert out["scope"][0] == scope
+        assert out["disabled"] is True
+
     def test_service_check(self):
         out, _, _ = self.dogshell(["service_check", "check", "check_pg", "host0", "1"])
         out = json.loads(out)