JasonD28 commented on a change in pull request #10605: URL: https://github.com/apache/incubator-superset/pull/10605#discussion_r480271293
########## File path: superset/tasks/alerts/validator.py ########## @@ -0,0 +1,112 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +import enum +import json +from typing import Callable + +import numpy as np + +from superset.exceptions import SupersetException +from superset.models.alerts import SQLObserver + + +class AlertValidatorType(enum.Enum): + not_null = "not null" + operator = "operator" + + @classmethod + def valid_type(cls, validator_type: str) -> bool: + return any(val_type.value == validator_type for val_type in cls) + + +def check_validator(validator_type: str, config: str) -> None: + if not AlertValidatorType.valid_type(validator_type): + raise SupersetException( + f"Error: {validator_type} is not a valid validator type." + ) + + config_dict = json.loads(config) + + if validator_type == AlertValidatorType.operator.value: + valid_operators = ["<", "<=", ">", ">=", "==", "!="] + + if not (config_dict.get("op") and config_dict.get("threshold")): + raise SupersetException( + "Error: Operator Validator needs specified operator and threshold " + 'values. Add "op" and "threshold" to config.' + ) + + if not config_dict["op"] in valid_operators: + raise SupersetException( + 'Error: Invalid operator type. Recheck "op" value in the config.' + ) + + if not isinstance(config_dict["threshold"], (int, float)): + raise SupersetException( + 'Error: Invalid threshold value. Recheck "threshold" value ' + "in the config." + ) + + +def not_null_validator( + observer: SQLObserver, validator_config: str # pylint: disable=unused-argument +) -> bool: + """Returns True if a SQLObserver's recent observation is not NULL""" + + observation = observer.get_observations(1)[0] + if observation.error_msg or observation.value in (0, None, np.nan): + return False + return True + + +def operator_validator( # pylint: disable=too-many-return-statements + observer: SQLObserver, validator_config: str +) -> bool: + """ + Returns True if a SQLObserver's recent observation is greater than or equal to + the value given in the validator config + """ + + observation = observer.get_observations(1)[0] + if observation.value is not None: + operator = json.loads(validator_config)["op"] + threshold = json.loads(validator_config)["threshold"] + if operator == ">=" and observation.value >= threshold: + return True + if operator == ">" and observation.value > threshold: + return True + if operator == "<=" and observation.value <= threshold: + return True + if operator == "<" and observation.value < threshold: + return True + if operator == "==" and observation.value == threshold: + return True + if operator == "!=" and observation.value != threshold: + return True + + return False + + +def get_validator_function(validator_type: str) -> Callable[[SQLObserver, str], bool]: + """Returns a validation function based on validator_type""" + + alert_validators = { + AlertValidatorType.not_null.value: not_null_validator, + AlertValidatorType.operator.value: operator_validator, + } + + return alert_validators[validator_type.lower()] Review comment: .value is only used for creating the dictionary with the possible validator types as keys, here I'm just using the validator_type argument to retrieve the function from the dictionary ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
