def test_api_key_not_set(self, m): hook = OpsgenieAlertHook() m.post(self.opsgenie_alert_endpoint, status_code=202, json=self._mock_success_response_body) with self.assertRaises(AirflowException): hook.execute(payload=self._payload)
def test_payload_set(self, m): hook = OpsgenieAlertHook(opsgenie_conn_id=self.conn_id) m.post(self.opsgenie_alert_endpoint, status_code=202, json=self._mock_success_response_body) resp = hook.execute(payload=self._payload) self.assertEqual(json.loads(resp.request.body), self._payload)
def test_api_key_set(self, m): hook = OpsgenieAlertHook(opsgenie_conn_id=self.conn_id) m.post(self.opsgenie_alert_endpoint, status_code=202, json=self._mock_success_response_body) resp = hook.execute(payload=self._payload) self.assertEqual(resp.request.headers.get('Authorization'), 'GenieKey eb243592-faa2-4ba2-a551q-1afdf565c889')
def test_call_with_success(self, m): hook = OpsgenieAlertHook(opsgenie_conn_id=self.conn_id) m.post(self.opsgenie_alert_endpoint, status_code=202, json=self._mock_success_response_body) resp = hook.execute(payload=self._payload) self.assertEqual(resp.status_code, 202) self.assertEqual(resp.json(), self._mock_success_response_body)
class OpsgenieAlertOperator(BaseOperator): """ This operator allows you to post alerts to Opsgenie. Accepts a connection that has an Opsgenie API key as the connection's password. This operator sets the domain to conn_id.host, and if not set will default to ``https://api.opsgenie.com``. Each Opsgenie API key can be pre-configured to a team integration. You can override these defaults in this operator. :param opsgenie_conn_id: The name of the Opsgenie connection to use :type opsgenie_conn_id: str :param message: The Message of the Opsgenie alert (templated) :type message: str :param alias: Client-defined identifier of the alert (templated) :type alias: str :param description: Description field of the alert (templated) :type description: str :param responders: Teams, users, escalations and schedules that the alert will be routed to send notifications. :type responders: list[dict] :param visible_to: Teams and users that the alert will become visible to without sending any notification. :type visible_to: list[dict] :param actions: Custom actions that will be available for the alert. :type actions: list[str] :param tags: Tags of the alert. :type tags: list[str] :param details: Map of key-value pairs to use as custom properties of the alert. :type details: dict :param entity: Entity field of the alert that is generally used to specify which domain alert is related to. (templated) :type entity: str :param source: Source field of the alert. Default value is IP address of the incoming request. :type source: str :param priority: Priority level of the alert. Default value is P3. (templated) :type priority: str :param user: Display name of the request owner. :type user: str :param note: Additional note that will be added while creating the alert. (templated) :type note: str """ template_fields = ('message', 'alias', 'description', 'entity', 'priority', 'note') # pylint: disable=too-many-arguments @apply_defaults def __init__(self, *, message, opsgenie_conn_id='opsgenie_default', alias=None, description=None, responders=None, visible_to=None, actions=None, tags=None, details=None, entity=None, source=None, priority=None, user=None, note=None, **kwargs): super().__init__(**kwargs) self.message = message self.opsgenie_conn_id = opsgenie_conn_id self.alias = alias self.description = description self.responders = responders self.visible_to = visible_to self.actions = actions self.tags = tags self.details = details self.entity = entity self.source = source self.priority = priority self.user = user self.note = note self.hook = None def _build_opsgenie_payload(self): """ Construct the Opsgenie JSON payload. All relevant parameters are combined here to a valid Opsgenie JSON payload. :return: Opsgenie payload (dict) to send """ payload = {} for key in [ "message", "alias", "description", "responders", "visible_to", "actions", "tags", "details", "entity", "source", "priority", "user", "note" ]: val = getattr(self, key) if val: payload[key] = val return payload def execute(self, context): """ Call the OpsgenieAlertHook to post message """ self.hook = OpsgenieAlertHook(self.opsgenie_conn_id) self.hook.execute(self._build_opsgenie_payload())