installers/charm/pol/src/charm.py

   1 #!/usr/bin/env python3
   2 # Copyright 2021 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
  23 # pylint: disable=E0213
  24
  25
  26 import logging
  27 import re
  28 from typing import NoReturn, Optional
  29
  30 from ops.main import main
  31 from opslib.osm.charm import CharmedOsmBase, RelationsMissing
  32 from opslib.osm.interfaces.kafka import KafkaClient
  33 from opslib.osm.interfaces.mongo import MongoClient
  34 from opslib.osm.interfaces.mysql import MysqlClient
  35 from opslib.osm.pod import (
  36     ContainerV3Builder,
  37     PodSpecV3Builder,
  38 )
  39 from opslib.osm.validator import ModelValidator, validator
  40
  41
  42 logger = logging.getLogger(__name__)
  43
  44 PORT = 9999
  45 DEFAULT_MYSQL_DATABASE = "pol"
  46
  47
  48 class ConfigModel(ModelValidator):
  49     log_level: str
  50     mongodb_uri: Optional[str]
  51     mysql_uri: Optional[str]
  52
  53     @validator("log_level")
  54     def validate_log_level(cls, v):
  55         if v not in {"INFO", "DEBUG"}:
  56             raise ValueError("value must be INFO or DEBUG")
  57         return v
  58
  59     @validator("mongoddb_uri")
  60     def validate_mongodb_uri(cls, v):
  61         if v and not v.startswith("mongodb://"):
  62             raise ValueError("mongodb_uri is not properly formed")
  63         return v
  64
  65     @validator("mysql_uri")
  66     def validate_mysql_uri(cls, v):
  67         pattern = re.compile("^mysql:\/\/.*:.*@.*:\d+\/.*$")  # noqa: W605
  68         if v and not pattern.search(v):
  69             raise ValueError("mysql_uri is not properly formed")
  70         return v
  71
  72
  73 class PolCharm(CharmedOsmBase):
  74     def __init__(self, *args) -> NoReturn:
  75         super().__init__(*args, oci_image="image")
  76
  77         self.kafka_client = KafkaClient(self, "kafka")
  78         self.framework.observe(self.on["kafka"].relation_changed, self.configure_pod)
  79         self.framework.observe(self.on["kafka"].relation_broken, self.configure_pod)
  80
  81         self.mongodb_client = MongoClient(self, "mongodb")
  82         self.framework.observe(self.on["mongodb"].relation_changed, self.configure_pod)
  83         self.framework.observe(self.on["mongodb"].relation_broken, self.configure_pod)
  84
  85         self.mysql_client = MysqlClient(self, "mysql")
  86         self.framework.observe(self.on["mysql"].relation_changed, self.configure_pod)
  87         self.framework.observe(self.on["mysql"].relation_broken, self.configure_pod)
  88
  89     def _check_missing_dependencies(self, config: ConfigModel):
  90         missing_relations = []
  91
  92         if self.kafka_client.is_missing_data_in_unit():
  93             missing_relations.append("kafka")
  94         if not config.mongodb_uri and self.mongodb_client.is_missing_data_in_unit():
  95             missing_relations.append("mongodb")
  96         if not config.mysql_uri and self.mysql_client.is_missing_data_in_unit():
  97             missing_relations.append("mysql")
  98         if missing_relations:
  99             raise RelationsMissing(missing_relations)
 100
 101     def build_pod_spec(self, image_info):
 102         # Validate config
 103         config = ConfigModel(**dict(self.config))
 104
 105         if config.mongodb_uri and not self.mongodb_client.is_missing_data_in_unit():
 106             raise Exception("Mongodb data cannot be provided via config and relation")
 107         if config.mysql_uri and not self.mysql_client.is_missing_data_in_unit():
 108             raise Exception("Mysql data cannot be provided via config and relation")
 109
 110         # Check relations
 111         self._check_missing_dependencies(config)
 112
 113         # Create Builder for the PodSpec
 114         pod_spec_builder = PodSpecV3Builder()
 115
 116         # Build Container
 117         container_builder = ContainerV3Builder(self.app.name, image_info)
 118         container_builder.add_port(name=self.app.name, port=PORT)
 119         container_builder.add_envs(
 120             {
 121                 # General configuration
 122                 "ALLOW_ANONYMOUS_LOGIN": "yes",
 123                 "OSMPOL_GLOBAL_LOGLEVEL": config.log_level,
 124                 # Kafka configuration
 125                 "OSMPOL_MESSAGE_DRIVER": "kafka",
 126                 "OSMPOL_MESSAGE_HOST": self.kafka_client.host,
 127                 "OSMPOL_MESSAGE_PORT": self.kafka_client.port,
 128                 # Database configuration
 129                 "OSMPOL_DATABASE_DRIVER": "mongo",
 130                 "OSMPOL_DATABASE_URI": config.mongodb_uri
 131                 or self.mongodb_client.connection_string,
 132                 "OSMPOL_SQL_DATABASE_URI": config.mysql_uri
 133                 or self.mysql_client.get_root_uri(DEFAULT_MYSQL_DATABASE),
 134             }
 135         )
 136         container = container_builder.build()
 137
 138         # Add container to pod spec
 139         pod_spec_builder.add_container(container)
 140
 141         return pod_spec_builder.build()
 142
 143
 144 if __name__ == "__main__":
 145     main(PolCharm)