add bin/delete_whitelist_rule

Author: Jonathan Visser

bin/delete_whitelist_rule

@@ -0,0 +1 @@
+command

hypernode_api_python/client.py

@@ -624,6 +624,29 @@ def add_whitelist_rule(self, app_name, data):
             "POST", HYPERNODE_API_WHITELIST_ENDPOINT.format(app_name), data=data
         )
 
+    def delete_whitelist_rule(self, app_name, data):
+        """
+        Remove a whitelist rule for the specified app. See get_whitelist_rules
+        for the currently configured whitelist rules. On success the response
+        will have status_code 204 and no content.
+        Example:
+        >    client.delete_whitelist_rule(
+        >        'yourhypernodeappname',
+        >        data={'ip': '1.2.3.4', 'type': 'database'}
+        >    ).status_code
+        >    204
+
+        :param str app_name: The name of the Hypernode to remove the whitelist
+        rule for
+        :param dict data: Data describing the whitelist rule to remove. An
+        example could be: {'ip': '1.2.3.4', 'type': 'database'}. The type can
+        be one of 'waf', 'database' or 'ftp'.
+        :return obj response: The request response object
+        """
+        return self.requests(
+            "DELETE", HYPERNODE_API_WHITELIST_ENDPOINT.format(app_name), data=data
+        )
+
     def get_current_product_for_app(self, app_name):
         """
         Retrieve information about the product the specified App is currently on.

hypernode_api_python/commands.py

@@ -541,6 +541,44 @@ def add_whitelist_rule(args=None):
     print_response(client.add_whitelist_rule(app_name, data=data))
 
 
+def delete_whitelist_rule(args=None):
+    parser = ArgumentParser(
+        description="""
+Remove a WAF whitelist rule for the Hypernode.
+
+Example:
+$ ./bin/delete_whitelist_rule 1.2.3.4 --type database
+Whitelist rule '1.2.3.4' (database) has been removed.
+""",
+        formatter_class=RawTextHelpFormatter,
+    )
+    parser.add_argument(
+        "ip",
+        help="The whitelisted IP address to remove. See ./bin/get_whitelist_rules",
+    )
+    parser.add_argument(
+        "--type",
+        help="The type of the whitelist rule to remove",
+        choices=["waf", "database", "ftp"],
+        default="database",
+    )
+    args = parser.parse_args(args=args)
+    client = get_client()
+    app_name = get_app_name()
+    data = {"ip": args.ip, "type": args.type}
+    try:
+        client.delete_whitelist_rule(app_name, data=data)
+        print("Whitelist rule '{}' ({}) has been removed.".format(args.ip, args.type))
+        exit(EX_OK)
+    except Exception as e:
+        print(
+            "Whitelist rule '{}' ({}) failed to be removed: {}".format(
+                args.ip, args.type, e
+            )
+        )
+        exit(EX_UNAVAILABLE)
+
+
 def get_current_product_for_app(args=None):
     parser = ArgumentParser(
         description="""

tests/client/test_delete_whitelist_rule.py

@@ -0,0 +1,36 @@
+from unittest import TestCase
+from unittest.mock import Mock
+
+from hypernode_api_python.client import (
+    HYPERNODE_API_WHITELIST_ENDPOINT,
+    HypernodeAPIPython,
+)
+
+
+class TestDeleteWhitelistRule(TestCase):
+    def setUp(self):
+        self.client = HypernodeAPIPython(token="my_token")
+        self.mock_request = Mock()
+        self.client.requests = self.mock_request
+        self.app_name = "my_app"
+
+    def test_whitelist_endpoint_is_correct(self):
+        self.assertEqual("/v2/whitelist/{}/", HYPERNODE_API_WHITELIST_ENDPOINT)
+
+    def test_calls_delete_whitelist_rule_endpoint_properly(self):
+        data = {"ip": "1.2.3.4", "type": "database"}
+        self.client.delete_whitelist_rule(self.app_name, data)
+
+        self.mock_request.assert_called_once_with(
+            "DELETE", f"/v2/whitelist/{self.app_name}/", data=data
+        )
+
+    def test_returns_delete_whitelist_rule_response(self):
+        response = Mock()
+        response.status_code = 204
+        self.mock_request.return_value = response
+
+        self.assertEqual(
+            self.client.delete_whitelist_rule(self.app_name, {"ip": "1.2.3.4"}),
+            self.mock_request.return_value,
+        )

tests/commands/test_delete_whitelist_rule.py

@@ -0,0 +1,59 @@
+from hypernode_api_python.commands import delete_whitelist_rule
+from tests.testcase import TestCase
+
+
+class TestDeleteWhitelistRule(TestCase):
+    def setUp(self):
+        self.print_response = self.set_up_patch(
+            "hypernode_api_python.commands.print_response"
+        )
+        self.get_client = self.set_up_patch("hypernode_api_python.commands.get_client")
+        self.client = self.get_client.return_value
+        self.get_app_name = self.set_up_patch(
+            "hypernode_api_python.commands.get_app_name"
+        )
+        self.get_app_name.return_value = "myappname"
+
+    def test_delete_whitelist_rule_gets_client(self):
+        with self.assertRaises(SystemExit):
+            delete_whitelist_rule(["1.2.3.4"])
+
+        self.get_client.assert_called_once_with()
+
+    def test_delete_whitelist_rule_gets_app_name(self):
+        with self.assertRaises(SystemExit):
+            delete_whitelist_rule(["1.2.3.4"])
+
+        self.get_app_name.assert_called_once_with()
+
+    def test_delete_whitelist_rule_deletes_whitelist_rule_with_default_type(self):
+        with self.assertRaises(SystemExit):
+            delete_whitelist_rule(["1.2.3.4"])
+
+        expected_data = {"ip": "1.2.3.4", "type": "database"}
+        self.client.delete_whitelist_rule.assert_called_once_with(
+            "myappname", data=expected_data
+        )
+
+    def test_delete_whitelist_rule_deletes_whitelist_rule_with_specified_type(self):
+        with self.assertRaises(SystemExit):
+            delete_whitelist_rule(["1.2.3.4", "--type", "waf"])
+
+        expected_data = {"ip": "1.2.3.4", "type": "waf"}
+        self.client.delete_whitelist_rule.assert_called_once_with(
+            "myappname", data=expected_data
+        )
+
+    def test_delete_whitelist_rule_exits_zero_on_success(self):
+        with self.assertRaises(SystemExit) as cm:
+            delete_whitelist_rule(["1.2.3.4"])
+
+        self.assertEqual(cm.exception.code, 0)
+
+    def test_delete_whitelist_rule_exits_nonzero_when_delete_fails(self):
+        self.client.delete_whitelist_rule.side_effect = RuntimeError("some error")
+
+        with self.assertRaises(SystemExit) as cm:
+            delete_whitelist_rule(["1.2.3.4"])
+
+        self.assertNotEqual(cm.exception.code, 0)