Fix improper restriction of XMl External Entity Reference, by using lxml
[osm/MON.git] / osm_mon / dashboarder / dashboarder.py
1 # -*- coding: utf-8 -*-
2
3 # Copyright 2021 Whitestack, LLC
4 # *************************************************************
5
6 # This file is part of OSM Monitoring module
7 # All Rights Reserved to Whitestack, LLC
8
9 # Licensed under the Apache License, Version 2.0 (the "License"); you may
10 # not use this file except in compliance with the License. You may obtain
11 # a copy of the License at
12
13 # http://www.apache.org/licenses/LICENSE-2.0
14
15 # Unless required by applicable law or agreed to in writing, software
16 # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
17 # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
18 # License for the specific language governing permissions and limitations
19 # under the License.
20 # For those usages not covered by the Apache License, Version 2.0 please
21 # contact: fbravo@whitestack.com or glavado@whitestack.com
22 ##
23
24 import logging
25 import time
26 import socket
27 import asyncio
28 from urllib.parse import urlparse
29
30 from osm_mon.dashboarder.service import DashboarderService
31 from osm_mon.core.config import Config
32 from osm_mon.core.message_bus_client import MessageBusClient
33
34 log = logging.getLogger(__name__)
35
36
37 class Dashboarder:
38 def __init__(self, config: Config):
39 self.conf = config
40 self.service = DashboarderService(config)
41 self.msg_bus = MessageBusClient(config)
42
43 # run consumer for grafana user management
44 def run(self):
45 asyncio.run(self.start())
46
47 async def start(self, wait_time=5):
48 topics = ["users", "project"]
49 while True:
50 try:
51 await self.msg_bus.aioread(topics, self._user_msg)
52 break
53 except Exception as e:
54 # Failed to subscribe to kafka topics
55 log.error("Error when subscribing to topic(s) %s", str(topics))
56 log.exception("Exception %s", str(e))
57 # Wait for some time for kaka to stabilize and then reattempt to subscribe again
58 time.sleep(wait_time)
59 log.info("Retrying to subscribe the kafka topic(s) %s", str(topics))
60
61 async def _user_msg(self, topic, key, values):
62 log.debug(
63 "Message from kafka bus received: topic: %s and values: %s and key: %s",
64 topic,
65 values,
66 key,
67 )
68 try:
69 if topic == "users" and key == "created":
70 log.debug("Received message from kafka for creating user")
71 if values.get("username"):
72 user = values["username"]
73 else:
74 user = values["changes"]["username"]
75 self.service.create_grafana_user(user)
76 # user-created and mapping is done with osm cli
77 if values.get("changes"):
78 # user-project-role mapping is included in change
79 if values["changes"].get("project_role_mappings"):
80 user_id = values["_id"]
81 project_data = values["changes"]["project_role_mappings"]
82 project_list = values["changes"].get("projects")
83 self.service.create_grafana_team_member(
84 project_data, user_id, project_list
85 )
86 elif values.get("project_role_mappings"):
87 # for fresh project-role-mapping
88 user_id = values.get("_id")
89 project_data = values["project_role_mappings"]
90 if user_id:
91 self.service.create_grafana_team_member(project_data, user_id)
92 else:
93 # for keystone we will get username
94 self.service.create_grafana_team_member(
95 project_data, user=values["username"]
96 )
97 elif topic == "users" and key == "deleted":
98 log.debug("Received message from kafka for deleting user")
99 user = values["username"]
100 self.service.delete_grafana_user(user)
101 elif topic == "users" and key == "edited":
102 log.debug("Received message from kafka for associating user to team")
103 user_id = values["_id"]
104 if values["changes"].get("remove_project_role_mappings") and not values[
105 "changes"
106 ].get("add_project_role_mappings"):
107 # Removing user-project role mapping
108 self.service.remove_grafana_team_members(
109 user_id, values["changes"].get("remove_project_role_mappings")
110 )
111 else:
112 # Changing user project role mapping
113 if values["changes"].get("project_role_mappings"):
114 project_data = values["changes"]["project_role_mappings"]
115 else:
116 project_data = values["changes"]["add_project_role_mappings"]
117 self.service.create_grafana_team_member(project_data, user_id)
118 elif topic == "project" and key == "created":
119 log.debug("Received message from kafka for creating team")
120 team_name = values["name"]
121 self.service.create_grafana_team(team_name)
122 elif topic == "project" and key == "deleted":
123 log.debug("Received message from kafka for deleting team")
124 project_name = values["name"]
125 self.service.delete_grafana_team(project_name)
126 elif topic == "project" and key == "edited":
127 log.debug("Received message from kafka for team name update")
128 project_old_name = values["original"]["name"]
129 project_new_name = values["changes"]["name"]
130 self.service.update_grafana_team(project_new_name, project_old_name)
131 except Exception:
132 log.exception("Exception processing message: ")
133
134 def dashboard_forever(self):
135 log.debug("dashboard_forever")
136 grafana_parsed_uri = urlparse(self.conf.get("grafana", "url"))
137 while True:
138 try:
139 socket.gethostbyname(grafana_parsed_uri.hostname)
140 log.debug("Dashboard backend is running")
141 except socket.error:
142 log.debug("Dashboard backend is not available")
143 time.sleep(int(self.conf.get("dashboarder", "interval")))
144 continue
145 try:
146 self.grafana_cleanup()
147 self.create_dashboards()
148 time.sleep(int(self.conf.get("dashboarder", "interval")))
149 except Exception:
150 log.exception("Error creating dashboards")
151
152 def create_dashboards(self):
153 self.service.create_dashboards()
154 log.debug("Dashboarder Service > create_dashboards called!")
155
156 def grafana_cleanup(self):
157 # Cleaning up non existing users from grafana
158 self.service.delete_non_existing_users()
159 # TODO
160 # Cleanup of teams from grafana
161 log.debug("Deleted non existing users from dashbaorder service")