Improvement subset for newer OpenStack versions

Author: Simca

src/openstack_cli/commands/exec.py

@@ -0,0 +1,26 @@
+#  Licensed to the Apache Software Foundation (ASF) under one or more
+#  contributor license agreements.  See the NOTICE file distributed with
+#  this work for additional information regarding copyright ownership.
+#  The ASF licenses this file to You under the Apache License, Version 2.0
+#  (the "License"); you may not use this file except in compliance with
+#  the License.  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
+from openstack_cli.core.config import Configuration
+from openstack_cli.modules.apputils.discovery import CommandMetaInfo
+
+__module__ = CommandMetaInfo("exec", "Execute command on host")
+
+
+
+
+def __init__(conf:Configuration):
+  pass
+

src/openstack_cli/commands/info.py

@@ -29,7 +29,8 @@
 __module__ = CommandMetaInfo("info", "Shows the detailed information about requested VMs")
 __args__ = __module__.arg_builder\
   .add_default_argument("search_pattern", str, "Search query", default="") \
-  .add_argument("own", bool, "Display only owned by user items", default=False)
+  .add_argument("own", bool, "Display only owned by user items", default=False) \
+  .add_argument("showid", bool, "Display instances ID", default=False)
 
 
 class WidthConst(Enum):
@@ -38,7 +39,9 @@ class WidthConst(Enum):
   max_net_len = 2
 
 
-def print_cluster(servers: Dict[str, List[OpenStackVMInfo]], vh: ValueHolder = None, ostack: OpenStack = None):
+def print_cluster(servers: Dict[str, List[OpenStackVMInfo]], vh: ValueHolder = None, ostack: OpenStack = None,
+                  showid:bool = False):
+
   __run_ico = Symbols.PLAY.green()
   __pause_ico = Symbols.PAUSE.yellow()
   __stop_ico = Symbols.STOP.red()
@@ -50,27 +53,33 @@ def print_cluster(servers: Dict[str, List[OpenStackVMInfo]], vh: ValueHolder = N
   if vh is None:
     vh = ValueHolder(3, [50, 30, 15])
 
-  to = TableOutput(
+  columns = [
     TableColumn("", 1, inv_ch=Colors.GREEN.wrap_len()),
     TableColumn("Host name", vh.get(WidthConst.max_fqdn_len)),
     TableColumn("Host IP", 16),
     TableColumn("SSH Key", vh.get(WidthConst.max_key_len)),
     TableColumn("Network name", length=vh.get(WidthConst.max_net_len))
-  )
+  ]
+  if showid:
+    columns.append(TableColumn("ID"))
 
+  to = TableOutput(*columns)
   to.print_header()
   for cluster_name, servers in servers.items():
     servers = sorted(servers, key=lambda x: x.fqdn)
     for server in servers:
-      to.print_row(
+      _row = [
         __state[server.state] if server.state in __state else __stop_ico,
         server.fqdn,
         server.ip_address if server.ip_address else "0.0.0.0",
         server.key_name,
         server.net_name
-      )
+      ]
+      if showid:
+        _row.append(server.id)
+      to.print_row(*_row)
 
-def __init__(conf: Configuration, search_pattern: str, debug: bool, own: bool):
+def __init__(conf: Configuration, search_pattern: str, debug: bool, own: bool, showid: bool):
   vh: ValueHolder = ValueHolder(3)
   def __fake_filter(s: OpenStackVMInfo):
     vh.set_if_bigger(WidthConst.max_fqdn_len, len(s.fqdn))
@@ -82,6 +91,6 @@ def __fake_filter(s: OpenStackVMInfo):
   clusters = ostack.get_server_by_cluster(search_pattern=search_pattern, sort=True, only_owned=own,
                                           filter_func=__fake_filter)
 
-  print_cluster(clusters, vh, ostack)
+  print_cluster(clusters, vh, ostack, showid=showid)
 
 

src/openstack_cli/commands/networks.py

@@ -40,7 +40,6 @@ def get_default_network(conf: Configuration, ostack: OpenStack, force: bool = Fa
 def print_networks(ostack: OpenStack, select: bool = False) -> OSNetworkItem or None:
   tbl = TableOutput(
     TableColumn("N.", 3),
-    TableColumn("ID", 36),
     TableColumn("Zone", 10),
     TableColumn("Name", 20),
     TableColumn("CIDR", 15),
@@ -61,7 +60,6 @@ def print_networks(ostack: OpenStack, select: bool = False) -> OSNetworkItem or
 
     tbl.print_row(
       str(counter),
-      net.network_id,
       ",".join(net.orig_network.availability_zones),
       net.name,
       net.cidr,

src/openstack_cli/commands/quota.py

@@ -33,6 +33,8 @@
 def get_percents(current: float, fmax: float):
   if fmax == 0:
     return 0
+  elif fmax == -1:
+    return 100
 
   return (current * 100) / fmax
 
@@ -306,11 +308,15 @@ def __init__(conf: Configuration, details: bool, show_clusters: bool, graph: boo
     c_end = Colors.RESET if prc > 80 else ""
     c_start = Colors.RED if prc > 90 else Colors.YELLOW if prc > 80 else ""
 
+    if metric.max_count < 0 :
+      c_start = ""
+      c_end = ""
+
     to.print_row(
       f"{c_start}{metric.name}{c_end}",
       f"{c_start}{metric.used}{c_end}",
-      metric.available,
-      metric.max_count,
+      "-" if metric.available < 0 else metric.available,
+      "-" if metric.max_count < 0 else metric.max_count,
       f"{get_progressbar(prc, c_start)} {c_start}{prc:.1f}%{c_end}"
     )
 

src/openstack_cli/commands/ssh.py

@@ -16,12 +16,10 @@
 import os
 import sys
 import subprocess
-from typing import Dict, List
 
 from openstack_cli.core.shell import shell
 from openstack_cli.modules.apputils.terminal.get_terminal_size import get_terminal_size
-from openstack_cli.modules.apputils.terminal import TableOutput, TableColumn, Console
-from openstack_cli.modules.openstack.objects import OpenStackVMInfo
+from openstack_cli.modules.apputils.terminal import Console
 from openstack_cli.modules.openstack import OpenStack
 from openstack_cli.core.config import Configuration
 from openstack_cli.modules.apputils.discovery import CommandMetaInfo
@@ -37,6 +35,7 @@
   .add_argument("port", int, "SSH Port", default=22)\
   .add_argument("internal", bool, "Use internal SSH Client", alias="buildin", default=False)
 
+from openstack_cli.modules.utils import host_selector
 
 IS_WIN: bool = sys.platform == "win32"
 
@@ -129,70 +128,12 @@ def _open_console(internal:bool, host: str, port: int = 22, user_name: str = "ro
 
 def __init__(conf: Configuration, name: str, node_number: int, user_name: str, use_password: bool, use_key: str,
              own: bool, port: int, internal: bool):
-  ostack = OpenStack(conf)
-  if name == "None":
-    name = ""
 
   if use_key == "None":
     use_key = None
 
-  if name and node_number == -1:
-    _name, _, _node_number = name.rpartition("-")
-
-    try:
-      node_number = int(_node_number)
-      name = _name
-    except (ValueError, TypeError):
-      pass
-
-  if "." in name:
-    name, _ = name.split(".")
-
-  search_result: Dict[str, List[OpenStackVMInfo]] = ostack.get_server_by_cluster(name, sort=True, only_owned=own)
-  to = TableOutput(
-    TableColumn("Cluster name", 40),
-    print_row_number=True
-  )
-  if len(search_result.keys()) > 1:
-    to.print_header()
-    for cluster_name in search_result.keys():
-      to.print_row(cluster_name)
-
-    selection: int = Console.ask("Choose cluster from the list", int)
-    try:
-      name = list(search_result.keys())[selection:][0]
-    except IndexError:
-      raise ValueError("Wrong selection, please select item within an provided range")
-  elif search_result:
-    name = list(search_result.keys())[0]
-  else:
-    raise ValueError(f"No matching cluster matching pattern'{name}' found")
-
-  nodes: List[OpenStackVMInfo] = search_result[name]
-  if node_number == -1:
-    if len(nodes) > 1:
-      to = TableOutput(
-        TableColumn("IP", 18),
-        TableColumn("Host name", 40),
-
-        print_row_number=True
-      )
-      to.print_header()
-      for node in nodes:
-        to.print_row(node.ip_address, node.fqdn)
-      node_number: int = Console.ask("Choose host from the list", int)
-      if node_number > len(nodes):
-        raise ValueError("Wrong selection, please select item within an provided range")
-    else:
-      node_number = 0
-  else:
-    node_number -= 1    # the node name starts for 1, while list from 0
-
-  try:
-    node: OpenStackVMInfo = nodes[node_number]
-  except IndexError:
-    raise ValueError("Unknown host name, please check the name")
-
+  ostack = OpenStack(conf)
+  node = host_selector(ostack, name, node_number, own)
   print(f"Establishing connection to {node.fqdn}({node.ip_address}) as '{user_name}' user...")
   if use_password:
     _open_console(internal, node.ip_address, port=port, user_name=user_name, password=True)

src/openstack_cli/core/config.py

@@ -204,7 +204,11 @@ def interface(self):
 
   @property
   def region(self):
-    return "RegionOne"
+    return self._storage.get_property(self._options_table, "region").value
+
+  @region.setter
+  def region(self, value):
+    self._storage.set_text_property(self._options_table, "region", value, encrypted=True)
 
   @property
   def supported_os_names(self) -> List[str]:

src/openstack_cli/core/updates/upgrade_catalog_11.py

@@ -42,6 +42,16 @@ def __call__(self, *args, **kwargs):
     osvm = OpenStack(conf)
     so = StatusOutput(additional_errors=osvm.last_errors)
 
+    """
+    Login sequence:
+    ------------------
+    - unscoped loing
+    - set project id
+    - scoped login
+    - fetch region
+    - relogin to fetch API endpoints
+    """
+
     if not conf.project.id:
       print("Fetching available projects....")
       if not osvm.login(_type=AuthRequestType.UNSCOPED):
@@ -62,7 +72,7 @@ def __call__(self, *args, **kwargs):
       for prj in projects:
         to.print_row(prj.id, prj.name, prj.enabled)
 
-      n: int = Console.ask("Select the project number to be used: ", _type=int)
+      n: int = Console.ask("Select the project number to be used", _type=int)
       conf.project = VMProject(id=projects[n].id, name=projects[n].name, domain=projects[n].domain_id)
       osvm.logout()
 
@@ -73,6 +83,26 @@ def __call__(self, *args, **kwargs):
         self.reset()
       raise RuntimeError("Unable to continue")
 
+    if not conf.region:
+      print(f"Fetching available regions for the project '{conf.project.name}'...")
+      to = TableOutput(
+        TableColumn("Id", 33),
+        TableColumn("Descriuption"),
+        print_row_number=True
+      )
+      to.print_header()
+      regions = osvm.regions
+      for region in regions:
+        to.print_row(region.id, region.description)
+
+      n: int = Console.ask("Select the region number to be used", _type=int)
+      conf.region = regions[n].id
+      osvm.logout()
+
+      if not osvm.login():
+        conf.reset()
+        raise RuntimeError("Unable to continue")
+
     if not conf.default_network:
       print("Please select default network for the VM (could be changed via 'conf network' command):")
       _net = print_networks(ostack=osvm, select=True)