installers/charm/osm-ro/src/legacy_interfaces.py

   1 #!/usr/bin/env python3
   2 # Copyright 2022 Canonical Ltd.
   3 #
   4 # Licensed under the Apache License, Version 2.0 (the "License"); you may
   5 # not use this file except in compliance with the License. You may obtain
   6 # 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, WITHOUT
  12 # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
  13 # License for the specific language governing permissions and limitations
  14 # under the License.
  15 #
  16 # For those usages not covered by the Apache License, Version 2.0 please
  17 # contact: legal@canonical.com
  18 #
  19 # To get in touch with the maintainers, please contact:
  20 # osm-charmers@lists.launchpad.net
  21 #
  22 # flake8: noqa
  23
  24 import ops
  25
  26
  27 class BaseRelationClient(ops.framework.Object):
  28     """Requires side of a Kafka Endpoint"""
  29
  30     def __init__(
  31         self,
  32         charm: ops.charm.CharmBase,
  33         relation_name: str,
  34         mandatory_fields: list = [],
  35     ):
  36         super().__init__(charm, relation_name)
  37         self.relation_name = relation_name
  38         self.mandatory_fields = mandatory_fields
  39         self._update_relation()
  40
  41     def get_data_from_unit(self, key: str):
  42         if not self.relation:
  43             # This update relation doesn't seem to be needed, but I added it because apparently
  44             # the data is empty in the unit tests.
  45             # In reality, the constructor is called in every hook.
  46             # In the unit tests when doing an update_relation_data, apparently it is not called.
  47             self._update_relation()
  48         if self.relation:
  49             for unit in self.relation.units:
  50                 data = self.relation.data[unit].get(key)
  51                 if data:
  52                     return data
  53
  54     def get_data_from_app(self, key: str):
  55         if not self.relation or self.relation.app not in self.relation.data:
  56             # This update relation doesn't seem to be needed, but I added it because apparently
  57             # the data is empty in the unit tests.
  58             # In reality, the constructor is called in every hook.
  59             # In the unit tests when doing an update_relation_data, apparently it is not called.
  60             self._update_relation()
  61         if self.relation and self.relation.app in self.relation.data:
  62             data = self.relation.data[self.relation.app].get(key)
  63             if data:
  64                 return data
  65
  66     def is_missing_data_in_unit(self):
  67         return not all([self.get_data_from_unit(field) for field in self.mandatory_fields])
  68
  69     def is_missing_data_in_app(self):
  70         return not all([self.get_data_from_app(field) for field in self.mandatory_fields])
  71
  72     def _update_relation(self):
  73         self.relation = self.framework.model.get_relation(self.relation_name)
  74
  75
  76 class MongoClient(BaseRelationClient):
  77     """Requires side of a Mongo Endpoint"""
  78
  79     mandatory_fields_mapping = {
  80         "reactive": ["connection_string"],
  81         "ops": ["replica_set_uri", "replica_set_name"],
  82     }
  83
  84     def __init__(self, charm: ops.charm.CharmBase, relation_name: str):
  85         super().__init__(charm, relation_name, mandatory_fields=[])
  86
  87     @property
  88     def connection_string(self):
  89         if self.is_opts():
  90             replica_set_uri = self.get_data_from_unit("replica_set_uri")
  91             replica_set_name = self.get_data_from_unit("replica_set_name")
  92             return f"{replica_set_uri}?replicaSet={replica_set_name}"
  93         else:
  94             return self.get_data_from_unit("connection_string")
  95
  96     def is_opts(self):
  97         return not self.is_missing_data_in_unit_ops()
  98
  99     def is_missing_data_in_unit(self):
 100         return self.is_missing_data_in_unit_ops() and self.is_missing_data_in_unit_reactive()
 101
 102     def is_missing_data_in_unit_ops(self):
 103         return not all(
 104             [self.get_data_from_unit(field) for field in self.mandatory_fields_mapping["ops"]]
 105         )
 106
 107     def is_missing_data_in_unit_reactive(self):
 108         return not all(
 109             [self.get_data_from_unit(field) for field in self.mandatory_fields_mapping["reactive"]]
 110         )