def test_tag_keys_dynamic_field_validation_success(self):
"""Test that tag keys are validated as fields."""
tag_keys = ["valid_tag"]
query_params = {"filter": {"valid_tag": "value"}}
serializer = GCPQueryParamSerializer(data=query_params,
tag_keys=tag_keys)
self.assertTrue(serializer.is_valid())
def test_valid_delta_costs(self):
"""Test successful handling of valid delta for cost requests."""
query_params = {"delta": "cost"}
req = Mock(path="/api/cost-management/v1/reports/gcp/costs/")
serializer = GCPQueryParamSerializer(data=query_params,
context={"request": req})
self.assertTrue(serializer.is_valid())
def test_tag_keys_dynamic_field_validation_failure(self):
"""Test that invalid tag keys are not valid fields."""
tag_keys = ["valid_tag"]
query_params = {"filter": {"bad_tag": "value"}}
serializer = GCPQueryParamSerializer(data=query_params, tag_keys=tag_keys)
with self.assertRaises(serializers.ValidationError):
serializer.is_valid(raise_exception=True)
def test_invalid_delta_costs(self):
"""Test failure while handling invalid delta for cost requests."""
query_params = {"delta": "cost_bad"}
req = Mock(path="/api/cost-management/v1/reports/gcp/costs/")
serializer = GCPQueryParamSerializer(data=query_params,
context={"request": req})
with self.assertRaises(serializers.ValidationError):
serializer.is_valid(raise_exception=True)
def test_order_by_service_with_groupby(self):
"""Test that order_by[service] works with a matching group-by."""
query_params = {
"group_by": {
"service": "asc"
},
"order_by": {
"service": "asc"
}
}
serializer = GCPQueryParamSerializer(data=query_params)
self.assertTrue(serializer.is_valid())
def test_query_params_invalid_order_by_usage(self):
"""Test parse of charge query params for invalid fields."""
# Charge can't order by request or usage
query_params = {
"group_by": {"subscription_guid": [FAKE.uuid4()]},
"order_by": {"usage": "asc"},
"filter": {"resolution": "daily", "time_scope_value": "-10", "time_scope_units": "day"},
"invalid": "param",
}
serializer = GCPQueryParamSerializer(data=query_params)
with self.assertRaises(serializers.ValidationError):
serializer.is_valid(raise_exception=True)
def test_valid_deltas(self):
"""Test successful handling of valid delta for cost requests."""
valid_delta_map = {
"/api/cost-management/v1/reports/gcp/costs/": ["cost", "cost_total"],
"/api/cost-management/v1/reports/gcp/instance-types/": ["usage"],
"/api/cost-management/v1/reports/gcp/storage/": ["usage"],
}
for url, delta_list in valid_delta_map.items():
req = Mock(path=url)
for valid_delta in delta_list:
query_params = {"delta": valid_delta}
serializer = GCPQueryParamSerializer(data=query_params, context={"request": req})
self.assertTrue(serializer.is_valid())
def test_parse_query_params_success(self):
"""Test parse of a query params successfully."""
query_params = {
"group_by": {"project": [FAKE.word()]},
"filter": {
"resolution": "daily",
"time_scope_value": "-10",
"time_scope_units": "day",
"account": [FAKE.uuid4()],
},
}
serializer = GCPQueryParamSerializer(data=query_params)
self.assertTrue(serializer.is_valid())
def test_invalid_deltas(self):
"""Test failure while handling invalid delta for gcp endpoints."""
bad_delta_map = {
"/api/cost-management/v1/reports/gcp/costs/": ["usage", "bad_delta"],
"/api/cost-management/v1/reports/gcp/instance-types/": ["cost", "cost_total", "bad_delta"],
"/api/cost-management/v1/reports/gcp/storage/": ["cost", "cost_total", "bad_delta"],
}
for url, delta_list in bad_delta_map.items():
req = Mock(path=url)
for bad_delta in delta_list:
query_params = {"delta": bad_delta}
serializer = GCPQueryParamSerializer(data=query_params, context={"request": req})
with self.assertRaises(serializers.ValidationError):
serializer.is_valid(raise_exception=True)
def test_query_params_invalid_nested_fields(self):
"""Test parse of query params for invalid nested_fields."""
query_params = {
"group_by": {"invalid": ["invalid"]},
"filter": {
"resolution": "daily",
"time_scope_value": "-10",
"time_scope_units": "day",
"subscription_guid": [FAKE.uuid4()],
},
}
serializer = GCPQueryParamSerializer(data=query_params)
with self.assertRaises(serializers.ValidationError):
serializer.is_valid(raise_exception=True)
def test_query_params_invalid_fields(self):
"""Test parse of query params for invalid fields."""
query_params = {
"group_by": {"account": [FAKE.word()]},
"filter": {
"resolution": "daily",
"time_scope_value": "-10",
"time_scope_units": "day",
"resource_location": [FAKE.word()],
},
"invalid": "param",
}
serializer = GCPQueryParamSerializer(data=query_params)
with self.assertRaises(serializers.ValidationError):
serializer.is_valid(raise_exception=True)
def test_order_by_service_without_groupby(self):
"""Test that order_by[service_name] fails without a matching group-by."""
query_params = {"order_by": {"service_name": "asc"}}
serializer = GCPQueryParamSerializer(data=query_params)
with self.assertRaises(serializers.ValidationError):
serializer.is_valid(raise_exception=True)
def test_parse_units_failure(self):
"""Test failure while parsing units query params."""
query_params = {"units": "bites"}
serializer = GCPQueryParamSerializer(data=query_params)
with self.assertRaises(serializers.ValidationError):
serializer.is_valid(raise_exception=True)
def test_parse_units(self):
"""Test pass while parsing units query params."""
query_params = {"units": "bytes"}
serializer = GCPQueryParamSerializer(data=query_params)
self.assertTrue(serializer.is_valid())