shipyard/src/bin/shipyard_airflow/shipyard_airflow/plugins/deckhand_validate_site.py
Andrey Volkov 4164518502 Ensure pod logs are fetched in case of exception in any operator
This patch tries to cover some edge cases could happen during Shipyard
Airflow operator execution. All operators at the moment make
interactions with other services i.e. k8s pods. In a case of exceptions
during execution of the operator, logs will be fetched from the
appropriate pod and if the operator has "fetch_failure_details" method
(see DrydockBaseOperator) it will be called as well.

What exception could happen during an operator execution?
Besides explicitly defined in code like
DrydockClientUseFailureException, other exception e.g. KeyError or
similar may be raised. It's not clear who is a culprit in that client
side (Shipyard) or server side (Drydock, Armada, Deckhand,
Promenade). So this patch applies defensive mode and gets logs from
pods and gets additional details for any exceptional situations.

For doing that do_execute method is wrapped with try..except
in UcpBaseOperator.execute. While fetching logs from a pod
and fetching failure details it makes appropriate logging by itself
and finally reraises the original exception.

Change-Id: If1501e9a24b05edb6eb32c7b1b2d27f24f3ee063
2018-09-19 09:17:13 -07:00

76 lines
2.6 KiB
Python

# Copyright 2018 AT&T Intellectual Property. All other rights reserved.
#
# Licensed 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 logging
import os
import requests
import yaml
from airflow.plugins_manager import AirflowPlugin
from airflow.exceptions import AirflowException
try:
from deckhand_base_operator import DeckhandBaseOperator
except ImportError:
from shipyard_airflow.plugins.deckhand_base_operator import \
DeckhandBaseOperator
LOG = logging.getLogger(__name__)
class DeckhandValidateSiteDesignOperator(DeckhandBaseOperator):
"""Deckhand Validate Site Design Operator
This operator will trigger deckhand to validate the
site design YAMLs
"""
def do_execute(self):
# Retrieve Keystone Token and assign to X-Auth-Token Header
x_auth_token = {"X-Auth-Token": self.svc_token}
# Form Validation Endpoint
validation_endpoint = os.path.join(self.deckhand_svc_endpoint,
'revisions',
str(self.revision_id),
'validations')
# Retrieve Validation list
LOG.info("Retrieving validation list...")
try:
retrieved_list = yaml.safe_load(
requests.get(validation_endpoint,
headers=x_auth_token,
timeout=self.validation_read_timeout).text)
except requests.exceptions.RequestException as e:
raise AirflowException(e)
if (any([str(v.get('status', 'unspecified')).lower() == 'failure'
for v in retrieved_list.get('results', [])])):
raise AirflowException("DeckHand Site Design Validation Failed!")
else:
LOG.info("Revision %d has been successfully validated",
self.revision_id)
class DeckhandValidateSiteDesignOperatorPlugin(AirflowPlugin):
"""Creates DeckhandValidateSiteDesignOperator in Airflow."""
name = 'deckhand_validate_site_design_operator'
operators = [DeckhandValidateSiteDesignOperator]