add bin/add_whitelist_rule

Author: Jonathan Visser

bin/add_whitelist_rule

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

hypernode_api_python/client.py

@@ -594,6 +594,36 @@ def get_whitelist_rules(self, app_name, filter_data=None):
             "GET", HYPERNODE_API_WHITELIST_ENDPOINT.format(app_name), filter_data
         )
 
+    def add_whitelist_rule(self, app_name, data):
+        """
+        Add a whitelist rule for the specified app. See get_whitelist_options
+        for the available options.
+        Example:
+        >    client.add_whitelist_rule(
+        >        'yourhypernodeappname',
+        >        data={'ip': '1.2.3.4', 'type': 'database', 'description': 'my description'}
+        >    ).json()
+        >    {
+        >        'id': 1234,
+        >        'created': '2024-05-25T13:39:48Z',
+        >        'domainname': 'yourhypernodeappname.hypernode.io',
+        >        'ip': '1.2.3.4',
+        >        'type': 'database',
+        >        'description': 'my description'
+        >    }
+
+        :param str app_name: The name of the Hypernode to add the whitelist
+        rule for
+        :param dict data: Data describing the whitelist rule to add. An
+        example could be: {'ip': '1.2.3.4', 'type': 'database'}. The type can
+        be one of 'waf', 'database' or 'ftp', and optionally a 'description'
+        can be specified.
+        :return obj response: The request response object
+        """
+        return self.requests(
+            "POST", 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

@@ -501,6 +501,46 @@ def get_whitelist_rules(args=None):
     print_response(client.get_whitelist_rules(app_name))
 
 
+def add_whitelist_rule(args=None):
+    parser = ArgumentParser(
+        description="""
+Add a WAF whitelist rule for the Hypernode.
+
+Example:
+$ ./bin/add_whitelist_rule 1.2.3.4 --type database --description "my description"
+{
+  "id": 1234,
+  "created": "2024-05-25T13:39:48Z",
+  "domainname": "yourhypernodeappname.hypernode.io",
+  "ip": "1.2.3.4",
+  "type": "database",
+  "description": "my description"
+}
+""",
+        formatter_class=RawTextHelpFormatter,
+    )
+    parser.add_argument(
+        "ip",
+        help="The IP address to whitelist",
+    )
+    parser.add_argument(
+        "--type",
+        help="The type of whitelist rule to add",
+        choices=["waf", "database", "ftp"],
+        default="database",
+    )
+    parser.add_argument(
+        "--description",
+        help="An optional description for the whitelist rule",
+        default="",
+    )
+    args = parser.parse_args(args=args)
+    client = get_client()
+    app_name = get_app_name()
+    data = {"ip": args.ip, "type": args.type, "description": args.description}
+    print_response(client.add_whitelist_rule(app_name, data=data))
+
+
 def get_current_product_for_app(args=None):
     parser = ArgumentParser(
         description="""

tests/client/test_add_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 TestAddWhitelistRule(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_add_whitelist_rule_endpoint_properly(self):
+        data = {"ip": "1.2.3.4", "type": "database", "description": "my description"}
+        self.client.add_whitelist_rule(self.app_name, data)
+
+        self.mock_request.assert_called_once_with(
+            "POST", f"/v2/whitelist/{self.app_name}/", data=data
+        )
+
+    def test_returns_add_whitelist_rule_response(self):
+        response = Mock()
+        response.status_code = 200
+        self.mock_request.return_value = response
+
+        self.assertEqual(
+            self.client.add_whitelist_rule(self.app_name, {"ip": "1.2.3.4"}),
+            self.mock_request.return_value,
+        )

tests/commands/test_add_whitelist_rule.py

@@ -0,0 +1,54 @@
+from hypernode_api_python.commands import add_whitelist_rule
+from tests.testcase import TestCase
+
+
+class TestAddWhitelistRule(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_add_whitelist_rule_gets_client(self):
+        add_whitelist_rule(["1.2.3.4"])
+
+        self.get_client.assert_called_once_with()
+
+    def test_add_whitelist_rule_gets_app_name(self):
+        add_whitelist_rule(["1.2.3.4"])
+
+        self.get_app_name.assert_called_once_with()
+
+    def test_add_whitelist_rule_adds_whitelist_rule_with_default_type(self):
+        add_whitelist_rule(["1.2.3.4"])
+
+        expected_data = {"ip": "1.2.3.4", "type": "database", "description": ""}
+        self.client.add_whitelist_rule.assert_called_once_with(
+            "myappname", data=expected_data
+        )
+
+    def test_add_whitelist_rule_adds_whitelist_rule_with_specified_arguments(self):
+        add_whitelist_rule(
+            ["1.2.3.4", "--type", "waf", "--description", "my description"]
+        )
+
+        expected_data = {
+            "ip": "1.2.3.4",
+            "type": "waf",
+            "description": "my description",
+        }
+        self.client.add_whitelist_rule.assert_called_once_with(
+            "myappname", data=expected_data
+        )
+
+    def test_add_whitelist_rule_prints_response(self):
+        add_whitelist_rule(["1.2.3.4"])
+
+        self.print_response.assert_called_once_with(
+            self.client.add_whitelist_rule.return_value
+        )