Merge pull request #1708 from khansaad/bulk-validations-test

Add Bulk validations test

Author: chandrams

tests/scripts/helpers/utils.py

@@ -122,6 +122,7 @@
 DELETE_PERF_PROFILE_MISSING_NAME_ERROR = "Performance profile name is required."
 DELETE_PERF_PROFILE_NON_EXISTENT_NAME_ERROR = "Not Found: performance_profile does not exist: %s"
 DELETE_PERF_PROFILE_EXPERIMENT_ASSOCIATION_ERROR = "Performance Profile '%s' cannot be deleted as it is currently associated with %d experiment."
+DATASOURCE_NOT_SERVICEABLE = "Datasource is not serviceable."
 
 
 # Kruize Recommendations Notification codes
@@ -223,7 +224,6 @@
 
 NAMESPACE_EXPERIMENT_TYPE = "namespace"
 CONTAINER_EXPERIMENT_TYPE = "container"
-PERF_PROFILE_NAME = "resource-optimization-openshift"
 
 # version,experiment_name,cluster_name,performance_profile,mode,target_cluster,type,name,namespace,container_image_name,container_name,measurement_duration,threshold
 create_exp_test_data = {
@@ -1898,7 +1898,7 @@ def validate_accelerator_recommendations_for_container(recommendations_json):
 def validate_job_status(job_id, base_url, caplog):
     # Common keys expected in both responses
     common_keys = {
-        "status", "total_experiments", "processed_experiments", "job_id", "job_start_time", "job_end_time"
+        "status", "total_experiments", "processed_experiments", "job_id", "job_start_time"
     }
 
     # Extra keys expected when verbose=true

tests/scripts/local_monitoring_tests/Local_monitoring_tests.md

@@ -152,6 +152,11 @@ Here are the test scenarios:
   - Sample JSON Payload: Verifies the API correctly processes a structured payload and generates a job_id.
 - Verify the response of the GET job status API for the generated job_id.
   - Tests both verbose=false and verbose=true GET requests for comprehensive verification.
+- Validate bulk API response by passing a valid and multiple invalid time range values.
+  - Job_id will be generated in case of the valid scenario
+  - Corresponding error message will be sent back in case of invalid scenario with Response code 400.
+- Validate bulk API response by passing an invalid datasource name in the input JSON.
+  - Error message will be sent back with the response code 400
 
 ## Prerequisites for running the tests:
 - Minikube setup or access to Openshift cluster

tests/scripts/local_monitoring_tests/rest_apis/test_bulkAPI.py

@@ -35,28 +35,23 @@
 logging.basicConfig(level=logging.INFO, format='%(asctime)s - %(levelname)s - %(message)s')
 logger = logging.getLogger(__name__)
 
+# Base valid payload generator
+def base_payload():
+    return {
+        "filter": {
+            "exclude": {"namespace": [], "workload": [], "containers": [], "labels": {}},
+            "include": {"namespace": [], "workload": [], "containers": [], "labels": {}}
+        },
+        "metadata_profile": "cluster-metadata-local-monitoring",
+        "measurement_duration": "15mins",
+        "time_range": {}
+    }
 
 @pytest.mark.test_bulk_api_ros
 @pytest.mark.sanity
 @pytest.mark.parametrize("bulk_request_payload, expected_job_id_present", [
     ({}, True),  # Test with an empty payload to check if a job_id is created.
-    ({
-         "filter": {
-             "exclude": {
-                 "namespace": [],
-                 "workload": [],
-                 "containers": [],
-                 "labels": {}
-             },
-             "include": {
-                 "namespace": [],
-                 "workload": [],
-                 "containers": [],
-                 "labels": {}
-             }
-         },
-         "time_range": {}
-     }, True)  # Test with a sample payload with some JSON content
+    (base_payload(),True)  # Test with a sample payload with some JSON content
 ])
 def test_bulk_post_request(cluster_type, bulk_request_payload, expected_job_id_present, caplog):
     form_kruize_url(cluster_type)
@@ -104,3 +99,125 @@ def test_bulk_post_request(cluster_type, bulk_request_payload, expected_job_id_p
         if job_id_present:
             validate_job_status(response.json()["job_id"], URL, caplog)
 
+
+@pytest.mark.test_bulk_api_ros
+@pytest.mark.parametrize("start, end, expected_error", [
+    ("2025-01-01T12:00:00Z", "2025-01-02T12:00:00Z", "Valid"),               # Valid scenario
+    ("", "", "Invalid date format. Must follow ISO 8601 format (YYYY-MM-DDTHH:mm:ss.sssZ) for the jobId:"), # empty
+    ("2024-01-01 10:00:00", "2024-01-01T12:00:00Z", "Invalid date format. Must follow ISO 8601 format (YYYY-MM-DDTHH:mm:ss.sssZ) for the jobId:"),  # bad format
+    ("2025-01-02T12:00:00Z", "2025-01-01T12:00:00Z", "Start time should be before end time for the jobId:"),  # start > end
+    ])
+def test_bulk_api_time_range_validation(cluster_type, start, end, expected_error, caplog):
+    """
+    Validates all negative time-range scenarios for Bulk API.
+    """
+    form_kruize_url(cluster_type)
+    URL = get_kruize_url()
+    payload = base_payload()
+
+    payload["time_range"]["start"] = start
+    payload["time_range"]["end"] = end
+
+    delete_and_create_metric_profile()
+
+    # list and validate default metric profile
+    metric_profile_input_json_file = metric_profile_dir / 'resource_optimization_local_monitoring.json'
+    json_data = json.load(open(metric_profile_input_json_file))
+    metric_profile_name = json_data['metadata']['name']
+
+    response = list_metric_profiles(name=metric_profile_name, logging=False)
+    metric_profile_json = response.json()
+
+    assert response.status_code == SUCCESS_200_STATUS_CODE
+
+    errorMsg = validate_list_metric_profiles_json(metric_profile_json, list_metric_profiles_schema)
+    assert errorMsg == ""
+
+    delete_and_create_metadata_profile()
+
+    # list and validate default metadata profile
+    metadata_profile_input_json_file = metadata_profile_dir / 'bulk_cluster_metadata_local_monitoring.json'
+    json_data = json.load(open(metadata_profile_input_json_file))
+    metadata_profile_name = json_data['metadata']['name']
+
+    response = list_metadata_profiles(name=metadata_profile_name, logging=False)
+    metadata_profile_json = response.json()
+
+    assert response.status_code == SUCCESS_200_STATUS_CODE
+
+    errorMsg = validate_list_metadata_profiles_json(metadata_profile_json, list_metadata_profiles_schema)
+    assert errorMsg == ""
+    if expected_error == "Valid":
+        expected_job_id_present = True
+        with caplog.at_level(logging.INFO):
+            # Log request payload and curl command for POST request
+            response = post_bulk_api(payload, logging)
+
+            # Check if job_id is present in the response
+            job_id_present = "job_id" in response.json() and isinstance(response.json()["job_id"], str)
+            assert job_id_present == expected_job_id_present, f"Expected job_id presence to be {expected_job_id_present} but was {job_id_present}"
+
+            # If a job_id is generated, run the GET request test
+            if job_id_present:
+                validate_job_status(response.json()["job_id"], URL, caplog)
+    else:
+        response = post_bulk_api(payload, logging)
+        print("Response:", response.json())
+        assert response.status_code == ERROR_STATUS_CODE
+        assert expected_error in response.json()["message"]
+
+
+@pytest.mark.test_bulk_api_ros
+def test_bulk_validate_datasource_missing(cluster_type):
+    job_id = "job-missing-ds"
+    ds_name = "ds-missing-test"
+    form_kruize_url(cluster_type)
+    URL = get_kruize_url()
+
+    delete_and_create_metric_profile()
+
+    # list and validate default metric profile
+    metric_profile_input_json_file = metric_profile_dir / 'resource_optimization_local_monitoring.json'
+    json_data = json.load(open(metric_profile_input_json_file))
+    metric_profile_name = json_data['metadata']['name']
+
+    response = list_metric_profiles(name=metric_profile_name, logging=False)
+    metric_profile_json = response.json()
+
+    assert response.status_code == SUCCESS_200_STATUS_CODE
+
+    errorMsg = validate_list_metric_profiles_json(metric_profile_json, list_metric_profiles_schema)
+    assert errorMsg == ""
+
+    delete_and_create_metadata_profile()
+
+    # list and validate default metadata profile
+    metadata_profile_input_json_file = metadata_profile_dir / 'bulk_cluster_metadata_local_monitoring.json'
+    json_data = json.load(open(metadata_profile_input_json_file))
+    metadata_profile_name = json_data['metadata']['name']
+
+    response = list_metadata_profiles(name=metadata_profile_name, logging=False)
+    metadata_profile_json = response.json()
+
+    assert response.status_code == SUCCESS_200_STATUS_CODE
+
+    errorMsg = validate_list_metadata_profiles_json(metadata_profile_json, list_metadata_profiles_schema)
+    assert errorMsg == ""
+
+    # verify list does not contain it
+    items = list_datasources().json()
+    print("Items:", items)
+    datasources = items.get("datasources", [])
+    assert all(ds.get("name") != ds_name for ds in datasources), \
+        f"Datasource with name '{ds_name}' already exists"
+
+    # Build payload referencing the missing datasource
+    payload = base_payload()
+    payload["datasource"] = ds_name
+    payload["time_range"]["start"] = "2025-01-01T00:00:00Z"
+    payload["time_range"]["end"] = "2025-01-02T02:00:00Z"
+
+    response = post_bulk_api(payload, logging)
+    print("Response:", response.json())
+    assert response.status_code == ERROR_STATUS_CODE
+    assert DATASOURCE_NOT_SERVICEABLE in response.json()["message"]