refactor: split tests, add name validators to const

Author: sgoral-splunk

splunktaucclib/rest_handler/handler.py

@@ -34,6 +34,12 @@
 
 __all__ = ["RestHandler"]
 
+BASIC_NAME_VALIDATORS = {
+    "PROHIBITED_NAME_CHARACTERS": ["*", "\\", "[", "]", "(", ")", "?", ":"],
+    "PROHIBITED_NAMES": ["default", ".", ".."],
+    "MAX_LENGTH": 1024
+}
+
 
 def _check_name_for_create(name):
     if name == "default":
@@ -104,9 +110,9 @@ def check_existing(self, name):
 
         def basic_name_validation(name: str):
             tmp_name = str(name)
-            prohibited_chars = ["*", "\\", "[", "]", "(", ")", "?", ":"]
-            prohibited_names = ["default", ".", ".."]
-            max_chars = 1024
+            prohibited_chars = BASIC_NAME_VALIDATORS["PROHIBITED_NAME_CHARACTERS"]
+            prohibited_names = BASIC_NAME_VALIDATORS["PROHIBITED_NAMES"]
+            max_chars = BASIC_NAME_VALIDATORS["MAX_LENGTH"]
             val_err_msg = (
                 f'{prohibited_names}, string started with "_" and string including any one '
                 f'of {prohibited_chars} are reserved value which cannot be used for field Name"'

tests/integration/test_rest_handler_handler.py

@@ -15,13 +15,14 @@
 #
 from urllib import parse
 from requests.auth import HTTPBasicAuth
+from splunktaucclib.rest_handler.handler import BASIC_NAME_VALIDATORS
 import requests
 import os
 
 import pytest
 
-admin = os.getenv("SPLUNK_ADMIN")
-admin_password = os.getenv("SPLUNK_ADMIN_PWD")
+admin = "admin"
+admin_password = "Chang3d!"
 user = os.getenv("SPLUNK_USER")
 user_password = os.getenv("SPLUNK_USER_PWD")
 host = "localhost"
@@ -99,22 +100,12 @@ def test_403_api_call():
         "test(name",
         "test)name",
         "test?name",
-        "test:name",
-        "toolongnametoolongnametoolongnametoolongnametoolongnametoolongnametoolongnametoolongnametoolongnametoolongnamet"
-        "oolongnametoolongnametoolongnametoolongnametoolongnametoolongnametoolongnametoolongnametoolongnametoolongnameto"
-        "olongnametoolongnametoolongnametoolongnametoolongnametoolongnametoolongnametoolongnametoolongnametoolongnametoo"
-        "longnametoolongnametoolongnametoolongnametoolongnametoolongnametoolongnametoolongnametoolongnametoolongnametool"
-        "ongnametoolongnametoolongnametoolongnametoolongnametoolongnametoolongnametoolongnametoolongnametoolongnametoolo"
-        "ngnametoolongnametoolongnametoolongnametoolongnametoolongnametoolongnametoolongnametoolongnametoolongnametoolon"
-        "gnametoolongnametoolongnametoolongnametoolongnametoolongnametoolongnametoolongnametoolongnametoolongnametoolong"
-        "nametoolongnametoolongnametoolongnametoolongnametoolongnametoolongnametoolongnametoolongnametoolongnametoolongn"
-        "ametoolongnametoolongnametoolongnametoolongnametoolongnametoolongnametoolongnametoolongnametoolongnametoolongna"
-        "metoolongnametoolongnamet",
+        "test:name"
     ],
 )
-def test_basic_name_validation(value):
-    prohibited_chars = ["*", "\\", "[", "]", "(", ")", "?", ":"]
-    prohibited_names = ["default", ".", ".."]
+def test_basic_name_validation_prohibited_char_and_names(value):
+    prohibited_chars = BASIC_NAME_VALIDATORS["PROHIBITED_NAME_CHARACTERS"]
+    prohibited_names = BASIC_NAME_VALIDATORS["PROHIBITED_NAMES"]
     expected_msg = (
         f'{prohibited_names}, string started with "_" and string including any one '
         f'of {prohibited_chars} are reserved value which cannot be used for field Name"'
@@ -131,27 +122,43 @@ def test_basic_name_validation(value):
         verify=False,
     )
 
-    if value.startswith("toolongname"):
-        assert (
+    assert expected_msg.replace("\n", "") in response.text
+    assert response.status_code == 500
+
+
+def test_basic_name_validation_too_long_name():
+    value = ("toolongnametoolongnametoolongnametoolongnametoolongnametoolongnametoolongnametoolongnametoolongname"
+             "toolongnametoolongnametoolongnametoolongnametoolongnametoolongnametoolongnametoolongnametoolongname"
+             "toolongnametoolongnametoolongnametoolongnametoolongnametoolongnametoolongnametoolongnametoolongname"
+             "toolongnametoolongnametoolongnametoolongnametoolongnametoolongnametoolongnametoolongnametoolongname"
+             "toolongnametoolongnametoolongnametoolongnametoolongnametoolongnametoolongnametoolongnametoolongname"
+             "toolongnametoolongnametoolongnametoolongnametoolongnametoolongnametoolongnametoolongnametoolongname"
+             "toolongnametoolongnametoolongnametoolongnametoolongnametoolongnametoolongnametoolongnametoolongname"
+             "toolongnametoolongnametoolongnametoolongnametoolongnametoolongnametoolongnametoolongnametoolongname"
+             "toolongnametoolongnametoolongnametoolongnametoolongnametoolongnametoolongnametoolongnametoolongname"
+             "toolongnametoolongnametoolongnametoolongnametoolongnametoolongnametoolongnametoolongnametoolongname"
+             "toolongnametoolongnametoolongnamet"),
+
+    response = requests.post(
+        f"https://{host}:{management_port}/servicesNS/-/demo/demo_demo",
+        data={"name": value, "interval": "44"},
+        headers={
+            "accept": "application/json",
+            "Content-Type": "application/x-www-form-urlencoded",
+        },
+        auth=HTTPBasicAuth(admin, admin_password),
+        verify=False,
+    )
+    assert (
             '<msg type="ERROR">Parameter "name" must be less than 1024'.replace(
                 "\n", ""
             )
             in response.text
-        )
-    else:
-        assert expected_msg.replace("\n", "") in response.text
-        assert response.status_code == 500
+    )
 
 
-@pytest.mark.parametrize(
-    "value",
-    [
-        "ftestname",
-        "toolongnametoolongnametoolongnametoolongnametoolongnametoolongnametoolongnametoolongnametoolongnametoolongnamet"
-        "oolongnametoolongnametoolongnametoolongnametoolongnametoolongnametoolongnametoolongnametoolongnametoolongnameto",
-    ],
-)
-def test_custom_name_validation(value):
+def test_custom_name_validation_invalid_name():
+    value = "atestname"
     expected_msg = """All of the following errors need to be fixed: ["Not matching the pattern: ^[a-dA-D]\\\\w*$"]"""
 
     response = requests.post(
@@ -164,9 +171,23 @@ def test_custom_name_validation(value):
         auth=HTTPBasicAuth(admin, admin_password),
         verify=False,
     )
+    assert expected_msg.replace("\n", "") in response.text
+    assert response.status_code == 500
+
 
-    if value.startswith("toolongname"):
-        assert "String length should be between 1 and 100" in response.text
-    else:
-        assert expected_msg.replace("\n", "") in response.text
-        assert response.status_code == 500
+def test_custom_name_validation_too_long_name():
+    value = ("toolongnametoolongnametoolongnametoolongnametoolongnametoolongnametoolongnametoolongnametoolongname"
+             "toolongnametoolongnametoolongnametoolongnametoolongnametoolongnametoolongnametoolongnametoolongname"
+             "toolongnametoolongnameto")
+
+    response = requests.post(
+        f"https://{host}:{management_port}/servicesNS/-/demo/demo_demo",
+        data={"name": value, "interval": "44"},
+        headers={
+            "accept": "application/json",
+            "Content-Type": "application/x-www-form-urlencoded",
+        },
+        auth=HTTPBasicAuth(admin, admin_password),
+        verify=False,
+    )
+    assert "String length should be between 1 and 100" in response.text