Update quota command

Magnifiec graph option, which alows to see top consumers with ease

Author: Simca

src/openstack_cli/commands/quota.py

@@ -13,18 +13,20 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-from typing import Dict
+from typing import Dict, List
 
 from openstack_cli.modules.apputils.terminal import TableOutput, TableColumn, TableColumnPosition
+from openstack_cli.modules.apputils.terminal.get_terminal_size import get_terminal_size
 
 from openstack_cli.modules.apputils.terminal.colors import Colors
 from openstack_cli.core.config import Configuration
 from openstack_cli.modules.apputils.discovery import CommandMetaInfo
-from openstack_cli.modules.openstack import OpenStack, OpenStackQuotas, OpenStackQuotaType, OpenStackVMInfo
+from openstack_cli.modules.openstack import OpenStack, OpenStackQuotas, OpenStackQuotaType, OpenStackUsers
 
 __module__ = CommandMetaInfo("quota", item_help="Show the allowed resource limits for the project")
 __args__ = __module__.arg_builder\
   .add_argument("details", bool, "Show detailed resource consumption", default=False)\
+  .add_argument("graph", bool, "Show Graphical statistic per-user", default=False)\
   .add_argument("show_clusters", bool, "Show user instances on details page", alias="show-clusters", default=False)
 
 
@@ -35,44 +37,202 @@ def get_percents(current: float, fmax: float):
   return (current * 100) / fmax
 
 
-def get_progressbar(percents, color=""):
-  width = 30
+def get_plain_progress(percents, color:str = "", width: int = 30):
   f = int(round((percents * width) / 100))
   nf = int(width - f)
   if color:
-    return f"[{color}{'#' * f}{' '* nf}{Colors.RESET}]"
+    return f"{color}{'#' * f}{' '* nf}{Colors.RESET}"
   else:
-    return f"[{'#' * f}{' '* nf}]"
+    return f"{'#' * f}{' '* nf}"
+
+def get_progressbar(percents, color:str = "", width: int = 30):
+  return f"[{get_plain_progress(percents, color, width)}]"
+
+
+def display_graph(_t: OpenStackQuotaType, metrics: Dict[str, Dict[OpenStackQuotaType, int]], users: OpenStackUsers,
+                  quotas: OpenStackQuotas):
+  """
+  Interface example:
+
+  QuotaType Graph
+  ----------------
+
+  nnnnnn                           |
+  xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx | ##################################                                  XXX XX / 10.94%
+                                   |
+  mmmmmmmmmmm                      |
+  xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx | ################################################################### XXX XX / 25.00%
+                                   |
+  xxxxxxxx                         |
+  xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx | ##                                                                    X XX /  1.00%
+                                                                                                          |    |  |      |
+                                                                                                             6   3    7
+  """
+
+  screen_max_width, _ = get_terminal_size()
+  column12_del: str = " | "
+  column23_del: str = " "
+  column1_max_width: int = max(
+    len(next(iter(metrics.keys()))),
+    max([len(user) for id in metrics.keys() if (user:=users.get_user(id))])
+  )
+  column3_max_width: int = 16
+  column2_max_width: int = screen_max_width - column1_max_width - column3_max_width - len(column12_del) - len(column23_del)
+
+  max_metric_value: int = max([m for v in  metrics.values() if (m:=v[_t])])
+
+  row_frmt_str: str = f"{{:<{column1_max_width}}}{column12_del}{{:<{column2_max_width}}}{column23_del}{{:>{column3_max_width}}}"
+
+  print(f"{_t.name} Graph")
+  print(f"{'-'*len(_t.name)}---------\n")
+
+  _color = Colors.WHITE
+  for user_id, user_metric in metrics.items():
+    user_name = users.get_user(user_id)
+    percents = get_percents(user_metric[_t], max_metric_value)
+    actual_percents = get_percents(user_metric[_t], quotas.get_quota(_t)[0])
+    progress_bar = get_plain_progress(percents, "", column2_max_width)
+
+    if _t ==OpenStackQuotaType.RAM_MB:
+      user_metric_str = f"{int(user_metric[_t]/1024):>4} GB"
+    else:
+      user_metric_str = user_metric[_t]
+
+    metric_title = f"{user_metric_str:<6}/{actual_percents:6.2f}%"
+
+    _col1_filler = " " * (column1_max_width - len(user_name))
+    print(row_frmt_str.format(f"{_color}{user_name}{_col1_filler}{Colors.RESET}", "", ""))
+    print(row_frmt_str.format(f"{_color}{user_id}{Colors.RESET}", progress_bar, metric_title))
+
+    _color = Colors.WHITE if _color == Colors.BRIGHT_WHITE else Colors.BRIGHT_WHITE
+
+  print("\n")
+
+
+def display_combined_graph(metrics: Dict[str, Dict[OpenStackQuotaType, int]], users: OpenStackUsers,
+                           quotas: OpenStackQuotas):
+  """
+  Interface example:
+
+  QuotaType Graph
+  ----------------
+
+  nnnnnn                           | #############################################                       XXX XX / 10.94%
+  xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx | ##################################                                  XXX XX / 10.94%
+                                   | ######################################                              XXX XX / 10.94%
+                                   |
+  mmmmmmmmmmm                      | ##########                                                          XXX XX / 25.00%
+  xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx | ################################################################### XXX XX / 25.00%
+                                   | #########################                                           XXX XX / 25.00%
+                                   |
+  xxxxxxxx                         | #####                                                               XXX XX / 25.00%
+  xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx | ##                                                                    X XX /  1.00%
+                                   | #                                                                   |    |  |      |
+                                                                                                            6   3    7
+  """
+  _combined_quotas: List[OpenStackQuotaType] = [
+    OpenStackQuotaType.INSTANCES,
+    OpenStackQuotaType.CPU_CORES,
+    OpenStackQuotaType.RAM_MB
+  ]
+  _colors: Colors = [
+    Colors.WHITE,
+    Colors.YELLOW,
+    Colors.CYAN
+  ]
+  _quota_colors = {
+    _combined_quotas[i]: _colors[i].value for i in range(0, len(_combined_quotas))
+  }
+
+  screen_max_width, _ = get_terminal_size()
+  column12_del: str = " | "
+  column23_del: str = " "
+  column1_max_width: int = max(
+    len(next(iter(metrics.keys()))),
+    max([len(user) for id in metrics.keys() if (user:=users.get_user(id))])
+  )
+  column3_max_width: int = 16
+  column2_max_width: int = screen_max_width - column1_max_width - column3_max_width - len(column12_del) - len(column23_del)
 
-def _show_details(conf: Configuration, ostack: OpenStack, quotas: OpenStackQuotas, show_clusters: bool):
-   project_cpu_max, project_cpu_current = quotas.get_quota(OpenStackQuotaType.CPU_CORES)
-   project_mem_max, project_mem_current = quotas.get_quota(OpenStackQuotaType.RAM_MB)
-   project_instances_max, project_instances_current = quotas.get_quota(OpenStackQuotaType.INSTANCES)
+  max_metric_value: Dict[OpenStackQuotaType, int] = {
+    q: max([m for v in  metrics.values() if (m:=v[q])]) for q in _combined_quotas
+  }
 
-   servers = ostack.servers
+  row_frmt_str: str = f"{{:<{column1_max_width}}}{column12_del}{{:<{column2_max_width}}}{column23_del}{{:>{column3_max_width}}}"
+
+
+  caption_title = ", ".join([f"{_quota_colors[quota]}{quota.name}{Colors.RESET}" for quota in _combined_quotas])
+  print(f"{caption_title} Graph")
+  print(f"{'-'*len(caption_title)}---------\n")
+
+  for user_id, user_metric in metrics.items():
+    columns = [users.get_user(user_id), user_id, ""]
+    _combined = {_combined_quotas[i]: columns[i] for i in range(0, len(_combined_quotas))}
+    progress_bar: Dict[OpenStackQuotaType, str] = {}
+    metric_title: Dict[OpenStackQuotaType, str] = {}
+
+    for _t in _combined_quotas:
+      percents = get_percents(user_metric[_t], max_metric_value[_t])
+      actual_percents = get_percents(user_metric[_t], quotas.get_quota(_t)[0])
+      user_metric_str = f"{int(user_metric[_t]/1024):>4} GB" if _t == OpenStackQuotaType.RAM_MB else user_metric[_t]
+
+      progress_bar[_t] = get_plain_progress(percents, "", column2_max_width)
+      metric_title[_t] = f"{user_metric_str:<6}/{actual_percents:6.2f}%"
+
+    for _t in _combined_quotas:
+      print(row_frmt_str.format(
+        _combined[_t],
+        f"{_quota_colors[_t]}{progress_bar[_t]}{Colors.RESET}",
+        metric_title[_t]
+      ))
 
-   resources = {}
+    print(row_frmt_str.format("", "", ""))
 
-   for server in ostack.servers.items:
-     if server.owner_id not in resources:
-       resources[server.owner_id] = {
-         "clusters": {},
-         OpenStackQuotaType.CPU_CORES: 0,
-         OpenStackQuotaType.RAM_MB: 0,
-         OpenStackQuotaType.INSTANCES: 0
-       }
 
-     record = resources[server.owner_id]
+  print("\n")
 
-     record[OpenStackQuotaType.CPU_CORES] += server.flavor.vcpus
-     record[OpenStackQuotaType.INSTANCES] += 1
-     record[OpenStackQuotaType.RAM_MB] += server.flavor.raw.ram
-     if server.cluster_name not in record["clusters"]:
-       record["clusters"][server.cluster_name] = 0
+def _get_per_user_stats(ostack: OpenStack) -> Dict[str, Dict[OpenStackQuotaType, int]]:
+  resources = {}
 
-     record["clusters"][server.cluster_name] += 1
+  for server in ostack.servers.items:
+    if server.owner_id not in resources:
+      resources[server.owner_id] = {
+        "clusters": {},
+        OpenStackQuotaType.CPU_CORES: 0,
+        OpenStackQuotaType.RAM_MB: 0,
+        OpenStackQuotaType.INSTANCES: 0
+      }
 
-     resources[server.owner_id] = record
+    record = resources[server.owner_id]
+
+    record[OpenStackQuotaType.CPU_CORES] += server.flavor.vcpus
+    record[OpenStackQuotaType.INSTANCES] += 1
+    record[OpenStackQuotaType.RAM_MB] += server.flavor.raw.ram
+    if server.cluster_name not in record["clusters"]:
+      record["clusters"][server.cluster_name] = 0
+
+    record["clusters"][server.cluster_name] += 1
+    resources[server.owner_id] = record
+
+  return resources
+
+def _show_graph(ostack: OpenStack, quotas: OpenStackQuotas):
+  users = ostack.users
+  resources = _get_per_user_stats(ostack)
+
+  display_combined_graph(resources, users, quotas)
+
+  # display_graph(OpenStackQuotaType.INSTANCES, resources, users, quotas)
+  # display_graph(OpenStackQuotaType.CPU_CORES, resources, users, quotas)
+  # display_graph(OpenStackQuotaType.RAM_MB, resources, users, quotas)
+
+def _show_details(conf: Configuration, ostack: OpenStack, quotas: OpenStackQuotas, show_clusters: bool):
+   project_cpu_max, project_cpu_current = quotas.get_quota(OpenStackQuotaType.CPU_CORES)
+   project_mem_max, project_mem_current = quotas.get_quota(OpenStackQuotaType.RAM_MB)
+   project_instances_max, project_instances_current = quotas.get_quota(OpenStackQuotaType.INSTANCES)
+   users = ostack.users
+   servers = ostack.servers
+   resources = _get_per_user_stats(ostack)
 
    padding = " " * 5
    print("Per-User statistic: ")
@@ -125,7 +285,7 @@ def _show_details(conf: Configuration, ostack: OpenStack, quotas: OpenStackQuota
    print()
 
 
-def __init__(conf: Configuration, details: bool, show_clusters: bool):
+def __init__(conf: Configuration, details: bool, show_clusters: bool, graph: bool):
   stack = OpenStack(conf)
   limits = stack.quotas
 
@@ -156,7 +316,10 @@ def __init__(conf: Configuration, details: bool, show_clusters: bool):
 
   print()
   print("* Used/Avl.    - raw metric")
+  print()
 
-  if details:
+  if graph:
+    _show_graph(stack, limits)
+  elif details:
     print("Calculating per-user statistic....")
     _show_details(conf, stack, limits, show_clusters)

src/openstack_cli/commands/up.py

@@ -92,7 +92,7 @@ def __filter(vm: OpenStackVMInfo) -> bool:
       _pass = conf.default_vm_password if not password else password
 
       print(f"   |Image flavor to use: {img_flavor.name}")
-      print(f"   |Image to use      : {image.alias}")
+      print(f"   |Image to use       : {image.alias}")
       print(f"   |Key to use         : {_key.name}")
       print(f"   |Hosts to add       : {', '.join(name)}")
   else:

src/openstack_cli/modules/openstack/objects.py

@@ -316,11 +316,11 @@ def available(self):
 class OpenStackQuotas(object):
   def __init__(self):
     # Max, Used, Available
-    self.__metrics: Dict[OpenStackQuotaType, Tuple[int or float, int or float]] = {}
+    self.__metrics: Dict[OpenStackQuotaType, Tuple[Union[int,float], Union[int,float]]] = {}
     self.__max_metric_length = 0
 
   def add(self, metric_name: OpenStackQuotaType, max_count: int or float, used: int or float):
-    self.__metrics[metric_name] = (max_count, used)
+    self.__metrics[metric_name] = max_count, used,
     if self.__max_metric_length < len(metric_name.value):
       self.__max_metric_length = len(metric_name.value)
 
@@ -390,6 +390,9 @@ def get_user(self, user_id: str) -> Optional[str]:
 
     return self.__users_db[user_id]
 
+  def exists(self, user_id: str) -> bool:
+    return user_id in self.__users_db
+
 class OSImageInfo(object):
   def __init__(self, name: str, ver: str, orig: DiskImageInfo):
     self.__name = name.strip()