n2vc/juju_watcher.py

   1 # Copyright 2020 Canonical Ltd.
   2 #
   3 # Licensed under the Apache License, Version 2.0 (the "License");
   4 # you may not use this file except in compliance with the License.
   5 # You may obtain a copy of the License at
   6 #
   7 #     http://www.apache.org/licenses/LICENSE-2.0
   8 #
   9 #     Unless required by applicable law or agreed to in writing, software
  10 #     distributed under the License is distributed on an "AS IS" BASIS,
  11 #     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12 #     See the License for the specific language governing permissions and
  13 #     limitations under the License.
  14
  15 import asyncio
  16 import time
  17 from juju.client import client
  18 from n2vc.exceptions import EntityInvalidException
  19 from n2vc.n2vc_conn import N2VCConnector
  20 from juju.model import ModelEntity, Model
  21 from juju.client.overrides import Delta
  22 from juju.status import derive_status
  23 from juju.application import Application
  24 from websockets.exceptions import ConnectionClosed
  25 import logging
  26
  27 logger = logging.getLogger("__main__")
  28
  29
  30 def status(application: Application) -> str:
  31     unit_status = []
  32     for unit in application.units:
  33         unit_status.append(unit.workload_status)
  34     return derive_status(unit_status)
  35
  36
  37 def entity_ready(entity: ModelEntity) -> bool:
  38     """
  39     Check if the entity is ready
  40
  41     :param: entity: Model entity. It can be a machine, action, or application.
  42
  43     :returns: boolean saying if the entity is ready or not
  44     """
  45     entity_type = entity.entity_type
  46     if entity_type == "machine":
  47         return entity.agent_status in ["started"]
  48     elif entity_type == "action":
  49         return entity.status in ["completed", "failed", "cancelled"]
  50     elif entity_type == "application":
  51         # Workaround for bug: https://github.com/juju/python-libjuju/issues/441
  52         return entity.status in ["active", "blocked"]
  53     else:
  54         raise EntityInvalidException("Unknown entity type: {}".format(entity_type))
  55
  56
  57 def application_ready(application: Application) -> bool:
  58     """
  59     Check if an application has a leader
  60
  61     :param: application: Application entity.
  62
  63     :returns: boolean saying if the application has a unit that is a leader.
  64     """
  65     ready_status_list = ["active", "blocked"]
  66     application_ready = application.status in ready_status_list
  67     units_ready = all(
  68         unit.workload_status in ready_status_list for unit in application.units
  69     )
  70     return application_ready and units_ready
  71
  72
  73 class JujuModelWatcher:
  74     @staticmethod
  75     async def wait_for_model(model: Model, timeout: float = 3600):
  76         """
  77         Wait for all entities in model to reach its final state.
  78
  79         :param: model:              Model to observe
  80         :param: timeout:            Timeout for the model applications to be active
  81
  82         :raises: asyncio.TimeoutError when timeout reaches
  83         """
  84
  85         if timeout is None:
  86             timeout = 3600.0
  87
  88         # Coroutine to wait until the entity reaches the final state
  89         async def wait_until_model_ready():
  90             wait_for_entity = asyncio.ensure_future(
  91                 asyncio.wait_for(
  92                     model.block_until(
  93                         lambda: all(
  94                             application_ready(application)
  95                             for application in model.applications.values()
  96                         ),
  97                     ),
  98                     timeout=timeout,
  99                 )
 100             )
 101
 102             tasks = [wait_for_entity]
 103             try:
 104                 await asyncio.wait(tasks, return_when=asyncio.FIRST_COMPLETED)
 105             finally:
 106                 # Cancel tasks
 107                 for task in tasks:
 108                     task.cancel()
 109
 110         await wait_until_model_ready()
 111         # Check model is still ready after 10 seconds
 112
 113         await asyncio.sleep(10)
 114         await wait_until_model_ready()
 115
 116     @staticmethod
 117     async def wait_for(
 118         model: Model,
 119         entity: ModelEntity,
 120         progress_timeout: float = 3600,
 121         total_timeout: float = 3600,
 122         db_dict: dict = None,
 123         n2vc: N2VCConnector = None,
 124         vca_id: str = None,
 125     ):
 126         """
 127         Wait for entity to reach its final state.
 128
 129         :param: model:              Model to observe
 130         :param: entity:             Entity object
 131         :param: progress_timeout:   Maximum time between two updates in the model
 132         :param: total_timeout:      Timeout for the entity to be active
 133         :param: db_dict:            Dictionary with data of the DB to write the updates
 134         :param: n2vc:               N2VC Connector objector
 135         :param: vca_id:             VCA ID
 136
 137         :raises: asyncio.TimeoutError when timeout reaches
 138         """
 139
 140         if progress_timeout is None:
 141             progress_timeout = 3600.0
 142         if total_timeout is None:
 143             total_timeout = 3600.0
 144
 145         entity_type = entity.entity_type
 146         if entity_type not in ["application", "action", "machine"]:
 147             raise EntityInvalidException("Unknown entity type: {}".format(entity_type))
 148
 149         # Coroutine to wait until the entity reaches the final state
 150         wait_for_entity = asyncio.ensure_future(
 151             asyncio.wait_for(
 152                 model.block_until(lambda: entity_ready(entity)),
 153                 timeout=total_timeout,
 154             )
 155         )
 156
 157         # Coroutine to watch the model for changes (and write them to DB)
 158         watcher = asyncio.ensure_future(
 159             JujuModelWatcher.model_watcher(
 160                 model,
 161                 entity_id=entity.entity_id,
 162                 entity_type=entity_type,
 163                 timeout=progress_timeout,
 164                 db_dict=db_dict,
 165                 n2vc=n2vc,
 166                 vca_id=vca_id,
 167             )
 168         )
 169
 170         tasks = [wait_for_entity, watcher]
 171         try:
 172             # Execute tasks, and stop when the first is finished
 173             # The watcher task won't never finish (unless it timeouts)
 174             await asyncio.wait(tasks, return_when=asyncio.FIRST_COMPLETED)
 175         finally:
 176             # Cancel tasks
 177             for task in tasks:
 178                 task.cancel()
 179
 180     @staticmethod
 181     async def model_watcher(
 182         model: Model,
 183         entity_id: str,
 184         entity_type: str,
 185         timeout: float,
 186         db_dict: dict = None,
 187         n2vc: N2VCConnector = None,
 188         vca_id: str = None,
 189     ):
 190         """
 191         Observes the changes related to an specific entity in a model
 192
 193         :param: model:          Model to observe
 194         :param: entity_id:      ID of the entity to be observed
 195         :param: entity_type:    Entity Type (p.e. "application", "machine, and "action")
 196         :param: timeout:        Maximum time between two updates in the model
 197         :param: db_dict:        Dictionary with data of the DB to write the updates
 198         :param: n2vc:           N2VC Connector objector
 199         :param: vca_id:         VCA ID
 200
 201         :raises: asyncio.TimeoutError when timeout reaches
 202         """
 203
 204         allwatcher = client.AllWatcherFacade.from_connection(model.connection())
 205
 206         # Genenerate array with entity types to listen
 207         entity_types = (
 208             [entity_type, "unit"]
 209             if entity_type == "application"  # TODO: Add "action" too
 210             else [entity_type]
 211         )
 212
 213         # Get time when it should timeout
 214         timeout_end = time.time() + timeout
 215
 216         try:
 217             while True:
 218                 change = await allwatcher.Next()
 219                 for delta in change.deltas:
 220                     write = False
 221                     delta_entity = None
 222
 223                     # Get delta EntityType
 224                     delta_entity = delta.entity
 225
 226                     if delta_entity in entity_types:
 227                         # Get entity id
 228                         if entity_type == "application":
 229                             id = (
 230                                 delta.data["application"]
 231                                 if delta_entity == "unit"
 232                                 else delta.data["name"]
 233                             )
 234                         else:
 235                             id = delta.data["id"]
 236
 237                         # Write if the entity id match
 238                         write = True if id == entity_id else False
 239
 240                         # Update timeout
 241                         timeout_end = time.time() + timeout
 242                         (
 243                             status,
 244                             status_message,
 245                             vca_status,
 246                         ) = JujuModelWatcher.get_status(delta)
 247
 248                         if write and n2vc is not None and db_dict:
 249                             # Write status to DB
 250                             status = n2vc.osm_status(delta_entity, status)
 251                             await n2vc.write_app_status_to_db(
 252                                 db_dict=db_dict,
 253                                 status=status,
 254                                 detailed_status=status_message,
 255                                 vca_status=vca_status,
 256                                 entity_type=delta_entity,
 257                                 vca_id=vca_id,
 258                             )
 259                 # Check if timeout
 260                 if time.time() > timeout_end:
 261                     raise asyncio.TimeoutError()
 262         except ConnectionClosed:
 263             pass
 264             # This is expected to happen when the
 265             # entity reaches its final state, because
 266             # the model connection is closed afterwards
 267
 268     @staticmethod
 269     def get_status(delta: Delta) -> (str, str, str):
 270         """
 271         Get status from delta
 272
 273         :param: delta:          Delta generated by the allwatcher
 274         :param: entity_type:    Entity Type (p.e. "application", "machine, and "action")
 275
 276         :return (status, message, vca_status)
 277         """
 278         if delta.entity == "machine":
 279             return (
 280                 delta.data["agent-status"]["current"],
 281                 delta.data["instance-status"]["message"],
 282                 delta.data["instance-status"]["current"],
 283             )
 284         elif delta.entity == "action":
 285             return (
 286                 delta.data["status"],
 287                 delta.data["status"],
 288                 delta.data["status"],
 289             )
 290         elif delta.entity == "application":
 291             return (
 292                 delta.data["status"]["current"],
 293                 delta.data["status"]["message"],
 294                 delta.data["status"]["current"],
 295             )
 296         elif delta.entity == "unit":
 297             return (
 298                 delta.data["workload-status"]["current"],
 299                 delta.data["workload-status"]["message"],
 300                 delta.data["workload-status"]["current"],
 301             )