xapp_orchestrater/dev/xapp_onboarder/xapp_onboarder/api/endpoints/health_check_ep.py

   1 ###############################################################################
   2 #   Copyright (c) 2020 AT&T Intellectual Property.                             #
   3 #                                                                              #
   4 #   Licensed under the Apache License, Version 2.0 (the "License");            #
   5 #   you may not use this file except in compliance with the License.           #
   6 #   You may obtain a copy of the License at                                    #
   7 #                                                                              #
   8 #       http://www.apache.org/licenses/LICENSE-2.0                             #
   9 #                                                                              #
  10 #   Unless required by applicable law or agreed to in writing, software        #
  11 #   distributed under the License is distributed on an "AS IS" BASIS,          #
  12 #   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.   #
  13 #   See the License for the specific language governing permissions and        #
  14 #   limitations under the License.                                             #
  15 ################################################################################
  16
  17 import logging
  18
  19 from flask_restx import Resource
  20 from xapp_onboarder.api.api_reference import api
  21 from xapp_onboarder.api.models.response_models import status_message_model, error_message_model, response
  22 from xapp_onboarder.repo_manager.repo_manager import repo_manager
  23
  24 log = logging.getLogger(__name__)
  25 ns = api.namespace('health', description='health check')
  26
  27
  28 @ns.route('')
  29 class HealthCheck(Resource):
  30
  31     @api.response(200, 'Health check OK', status_message_model)
  32     @api.response(500, 'xApp onboarder is not ready', error_message_model)
  33     def get(self):
  34         """
  35         Returns the health condition of the xApp onboarder
  36         """
  37         if not repo_manager.is_repo_ready():
  38             response_message = response( model= error_message_model, status_code = 500,
  39                                          error_source = "xapp_onboarder",
  40                                          error_message = "Cannot connect to local helm repo.",
  41                                          status = "Service not ready.")
  42             return response_message.get_return()
  43         return response(model = status_message_model, status_code = 200, status= "OK").get_return()