Taragolis commented on code in PR #35530: URL: https://github.com/apache/airflow/pull/35530#discussion_r1397660023
########## tests/providers/opsgenie/typing/test_opsgenie.py: ########## @@ -0,0 +1,106 @@ +# +# 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. +from __future__ import annotations + +from copy import deepcopy +from unittest import mock + +import pytest + +from airflow.operators.empty import EmptyOperator +from airflow.providers.opsgenie.hooks.opsgenie import OpsgenieAlertHook +from airflow.providers.opsgenie.notifications.opsgenie import OpsgenieNotifier + +pytestmark = pytest.mark.db_test + + +class TestCreateAlertPayload: + _config = { + "message": "An example alert message", + "alias": "Life is too short for no alias", + "description": "Every alert needs a description", + "responders": [ + {"id": "4513b7ea-3b91-438f-b7e4-e3e54af9147c", "type": "team"}, + {"name": "NOC", "type": "team"}, + {"id": "bb4d9938-c3c2-455d-aaab-727aa701c0d8", "type": "user"}, + {"username": "trin...@opsgenie.com", "type": "user"}, + {"id": "aee8a0de-c80f-4515-a232-501c0bc9d715", "type": "escalation"}, + {"name": "Nightwatch Escalation", "type": "escalation"}, + {"id": "80564037-1984-4f38-b98e-8a1f662df552", "type": "schedule"}, + {"name": "First Responders Schedule", "type": "schedule"}, + ], + "visible_to": [ + {"id": "4513b7ea-3b91-438f-b7e4-e3e54af9147c", "type": "team"}, + {"name": "rocket_team", "type": "team"}, + {"id": "bb4d9938-c3c2-455d-aaab-727aa701c0d8", "type": "user"}, + {"username": "trin...@opsgenie.com", "type": "user"}, + ], + "actions": ["Restart", "AnExampleAction"], + "tags": ["OverwriteQuietHours", "Critical"], + "details": {"key1": "value1", "key2": "value2"}, + "entity": "An example entity", + "source": "Airflow", + "priority": "P1", + "user": "Jesse", + "note": "Write this down", + } + + expected_payload_dict = { + "message": _config["message"], + "alias": _config["alias"], + "description": _config["description"], + "responders": _config["responders"], + "visible_to": _config["visible_to"], + "actions": _config["actions"], + "tags": _config["tags"], + "details": _config["details"], + "entity": _config["entity"], + "source": _config["source"], + "priority": _config["priority"], + "user": _config["user"], + "note": _config["note"], + } + + @mock.patch.object(OpsgenieAlertHook, "get_conn") + def test_create_alert_payload_happy_path(self, mock_opsgenie_alert_hook, dag_maker): + dag_id = "test_create_alert_payload" + with dag_maker(dag_id) as dag: + EmptyOperator(task_id="task1") + + notifier = OpsgenieNotifier(payload=self._config) + notifier({"dag": dag}) + mock_opsgenie_alert_hook.return_value.create_alert.assert_called_once_with(self.expected_payload_dict) + + @mock.patch.object(OpsgenieAlertHook, "get_conn") + def test_create_alert_payload_unhappy_path(self, mock_opsgenie_alert_hook, dag_maker): + dag_id = "test_create_alert_payload" + with dag_maker(dag_id) as dag: + EmptyOperator(task_id="task1") + + config_no_message = deepcopy(self._config) + del config_no_message["message"] + + expected_payload_dict_no_message = deepcopy(self.expected_payload_dict) + del expected_payload_dict_no_message["message"] + + with pytest.raises(Exception): # should raise exception because message is a required key + notifier = OpsgenieNotifier(payload=config_no_message) + notifier({"dag": dag}) + mock_opsgenie_alert_hook.return_value.create_alert.assert_called_once_with( + expected_payload_dict_no_message + ) Review Comment: My point here that we should not tests upstream library exceptions, because it could changed in the future. -- 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. To unsubscribe, e-mail: commits-unsubscr...@airflow.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
