fix typos

Author: guido tijskens

lib/oci_utils/__init__.py

@@ -23,25 +23,35 @@
 _configuration = read_configuration()
 
 oci_regions = {
-    'phx': 'phx - us-phoenix-1 (Phoenix, AZ, USA)',
-    'iad': 'iad - us-ashburn-1 (Ashburn, VA, USA)',
-    'fra': 'fra - eu-frankfurt-1 (Frankfurt, Germany)',
-    'lhr': 'lhr - uk-london-1 (London, UK)',
     'ams': 'ams - eu-amsterdam-1 (Amsterdam, The Netherlands)',
+    'arn': 'arn - eu-stockholm-1 (Stockholm, Norway)',
+    'auh': 'auh - me-abu-dhabi-1 (Abu Dhabi, United Arab Emirates)',
     'bom': 'bom - ap-mumbai-1 (Mumbai, India)',
     'cwl': 'cwl - uk-cardiff-1 (Newport, UK)',
     'dxb': 'dxb - me-dubai-1 (Duabi, UAE)',
+    'fra': 'fra - eu-frankfurt-1 (Frankfurt, Germany)',
     'gru': 'gru - sa-saopaulo-1 (Sao Paulo, Brazil)',
-    'vcp': 'vcp - sa-vinhedo-1 (Vinhedo, Brazil)',
     'hyd': 'hyd - ap-hyderabad-1 (Hyderabad, India)',
+    'iad': 'iad - us-ashburn-1 (Ashburn, VA, USA)',
     'icn': 'icn - ap-seoul-1 (Seoul, South Korea)',
-    'jed': 'jed - me-jeddah-1 (Jeddah, Saoudi Arabia)',
+    'jed': 'jed - me-jeddah-1 (Jeddah, Saudi Arabia)',
+    'jnb': 'jnb - af-johannesburg-1 (Johannesburg, South Africa)',
     'kix': 'kix - ap-osaka-1 (Osaka, Japan)',
+    'lhr': 'lhr - uk-london-1 (London, UK)',
+    'lin': 'lin - eu-milan-1 (Milan, Italy)',
+    'mct': 'mct - me-muscat-1 (Muscat, Oman)',
     'mel': 'mel - ap-melbourne-1 (Melbourne, Australia)',
+    'mrs': 'mrs - eu-marseille-1 (Marseille, France)',
+    'mtz': 'mtz - il-jerusalem-1 (Jerusalem, Israel)',
+    'nri2': 'nri2 - ap-osaka-2 (Osaka, Japan)',
     'nrt': 'nrt - ap-tokyo-1 (Tokyo, Japan)',
+    'phx': 'phx - us-phoenix-1 (Phoenix, AZ, USA)',
     'scl': 'scl - sa-santiago-1 (Santiago, Chile)',
+    'sin': 'sin - ap-singapore-1 (Singapore, Singapore)',
     'sjc': 'sjc - us-sanjose-1 (San Jose, CA, USA)',
     'syd': 'syd - ap-sydney-1 (Sydney, Australia)',
+    'vcp': 'vcp - sa-vinhedo-1 (Vinhedo, Brazil)',
+    'wga': 'wga - ap-canberra-1 (Canberra, Australia)',
     'yny': 'yny - ap-chuncheon-1 (Chuncheon, South Korea)',
     'yul': 'yul - ca-montreal-1 (Montreal, Canada)',
     'yyz': 'yyz - ca-toronto-1 (Toronto, Canada)',

lib/oci_utils/impl/oci-iscsi-config-main.py

@@ -796,7 +796,7 @@ def do_detach_volume(oci_session, iscsiadm_session, iqn, mode):
         raise Exception("Volume with IQN [%s] not found" % iqn)
     try:
         compat_info_message(compat_msg="Detaching volume",
-                            gen_msg="Detaching volume %s (%s)" % (_volume.get_display_name(),
+                            gen_msg="Detaching volume %s [%s]" % (_volume.get_display_name(),
                                                                   _volume.get_iqn()), mode=mode)
         _volume.detach()
     except Exception as e:
@@ -953,22 +953,22 @@ def _do_attach_oci_block_volume(sess, ocid, chap=False):
     Raise:
         Exception if attachment failed
     """
-    _logger.debug("Attaching volume [%s]", ocid)
+    _logger.debug('Attaching volume [%s]', ocid)
     vol = sess.get_volume(ocid)
     if vol is None:
-        raise Exception("Volume %s not found" % ocid)
+        raise Exception('Volume [%s] not found' % ocid)
 
     if vol.is_attached():
         if vol.get_instance().get_ocid() == sess.this_instance().get_ocid():
             # attached to this instance already
-            _msg = "Volume %s already attached to this instance" % ocid
+            _msg = 'Volume [%s] already attached to this instance' % ocid
         else:
-            _msg = "Volume %s already attached to instance %s (%s)" % (ocid,
+            _msg = 'Volume [%s] already attached to instance %s [%s]' % (ocid,
                                                                        vol.get_instance().get_ocid(),
                                                                        vol.get_instance().get_display_name())
         raise Exception(_msg)
 
-    _logger.info("Attaching OCI Volume to this instance.")
+    _logger.info('Attaching OCI Volume [%s] to this instance.' % ocid)
     # vol = vol.attach_to(instance_id=sess.this_instance().get_ocid(), wait=True)
     vol = vol.attach_to(instance_id=sess.this_instance().get_ocid(), use_chap=chap, wait=True)
     _logger.debug("Volume [%s] attached", ocid)
@@ -1007,10 +1007,10 @@ def get_volume_by_iqn(sess, iqn):
                     _logger.debug('Found %s', str(volume))
                     return volume
         else:
-            _logger.info('Unable to get volume ocid and display name for iqn %s, ', iqn)
+            _logger.info('Unable to get volume ocid and display name for iqn [%s], ', iqn)
     except Exception as e:
-        _logger.debug('Failed to get volume data for iqn %s: %s', iqn, str(e), stack_info=True, exc_info=True)
-        _logger.error('Failed to get volume data for iqn %s', iqn)
+        _logger.debug('Failed to get volume data for iqn [%s]: %s', iqn, str(e), stack_info=True, exc_info=True)
+        _logger.error('Failed to get volume data for iqn [%s]', iqn)
     return None
 
 
@@ -1029,7 +1029,7 @@ def _get_iqn_from_ocid(sess, ocid):
     -------
         str: the iqn.
     """
-    _logger.debug('Trying to find the iqn for volume %s', ocid)
+    _logger.debug('Trying to find the iqn for volume [%s]', ocid)
     this_compartment = sess.this_compartment()
     this_availability_domain = sess.this_availability_domain()
     all_volumes = this_compartment.all_volumes(this_availability_domain)
@@ -1057,7 +1057,7 @@ def _is_iqn_attached(sess, iqn):
     -------
         str: the ocid
     """
-    _logger.debug('Verifying if %s is attached to this instance.')
+    _logger.debug('Verifying if [%s] is attached to this instance.')
     volume_data = get_volume_by_iqn(sess, iqn)
     if volume_data is None:
         return None
@@ -1084,7 +1084,7 @@ def do_umount(mountpoint):
         subprocess.check_output(['/usr/bin/umount', mountpoint], stderr=subprocess.STDOUT)
         return True
     except subprocess.CalledProcessError as e:
-        _logger.error("Failed to unmount %s: %s", mountpoint, e.output)
+        _logger.error("Failed to unmount [%s]: %s", mountpoint, e.output)
         return False
 
 
@@ -1178,7 +1178,7 @@ def do_create_volume(sess, size, display_name, attach_it, chap_credentials, mode
         _logger.debug("Failed to create volume", exc_info=True)
         raise Exception("Failed to create volume") from e
 
-    _logger.info("Volume %s created", vol.get_display_name())
+    _logger.info("Volume [%s] created", vol.get_display_name())
 
     if not attach_it:
         return
@@ -1195,7 +1195,7 @@ def do_create_volume(sess, size, display_name, attach_it, chap_credentials, mode
         raise Exception('Cannot attach BV') from e
     #
     # attach using iscsiadm commands
-    compat_info_message(gen_msg="Attaching iSCSI device", mode=mode)
+    compat_info_message(gen_msg="Attaching iSCSI device.", mode=mode)
 
     vol_portal_ip = vol.get_portal_ip()
     vol_portal_port = vol.get_portal_port()
@@ -1209,7 +1209,7 @@ def do_create_volume(sess, size, display_name, attach_it, chap_credentials, mode
                              password=vol_password,
                              auto_startup=True)
     compat_info_message(compat_msg="iscsiadm attach Result: %s" % iscsiadm.error_message_from_code(retval),
-                        gen_msg="Volume %s is attached." % vol.get_display_name(), mode=mode)
+                        gen_msg="Volume [%s] is attached." % vol.get_display_name(), mode=mode)
     if retval == 0:
         _logger.debug('Creation successful')
         if chap_credentials:
@@ -1550,7 +1550,7 @@ def main():
         retval = 0
         if not args.yes:
             for ocid in args.ocids:
-                _logger.info("Volume : %s", ocid)
+                _logger.info("Volume : [%s]", ocid)
             # if not ask_yes_no("WARNING: the volume(s) will be destroyed.  This is irreversible.  Continue?"):
             if not _read_yn('WARNING: the volume(s) will be destroyed.  This is irreversible.  Continue?',
                             yn=True,
@@ -1589,11 +1589,11 @@ def main():
         retval = 0
         for iqn in args.iqns:
             if iqn in detached_volume_iqns:
-                _logger.error("Target %s is already detached", iqn)
+                _logger.error("Target [%s] is already detached", iqn)
                 retval = 1
                 continue
             if iqn not in iscsiadm_session or 'device' not in iscsiadm_session[iqn]:
-                _logger.error("Target %s not found", iqn)
+                _logger.error("Target [%s] not found", iqn)
                 retval = 1
                 continue
 
@@ -1625,7 +1625,8 @@ def main():
                 retval = 1
 
         if retval == 0:
-            compat_info_message(gen_msg="Updating detached volume cache file: remove %s" % iqn, mode=compat_mode)
+            # compat_info_message(gen_msg="Updating detached volume cache file: remove %s" % iqn, mode=compat_mode)
+            # compat_info_message(gen_msg="Volume [%s] successfully detached." % iqn, mode=compat_mode)
             write_cache(cache_content=detached_volume_iqns, cache_fname=__ignore_file)
 
         _logger.debug('Trigger ocid refresh')
@@ -1652,7 +1653,7 @@ def main():
             _iqn_to_use = iqn
             _save_chap_cred = False
             if iqn in iscsiadm_session:
-                _logger.info("Target %s is already attached.", iqn)
+                _logger.info("Target [%s] is already attached.", iqn)
                 continue
 
             if _iqn_to_use.startswith(oci_volume_tag):
@@ -1703,7 +1704,7 @@ def main():
                 if not this_ocid:
                     #
                     # volume is not attached to oci, giving up for now instead of letting it timeout for 90 sec
-                    _logger.error('A volume with iqn %s is not in this instance list\n '
+                    _logger.error('A volume with iqn [%s] is not in this instance list '
                                   'of attached block volumes, attach it using the ocid.', _iqn_to_use)
                     retval = 1
                     continue
@@ -1722,11 +1723,11 @@ def main():
 
                 if _iqn_to_use in iscsiadm_session:
                     _iscsi_portal_ip = iscsiadm_session[_iqn_to_use]['current_portal_ip']
-                    _logger.debug('Portal ip for %s is %s', _iqn_to_use, _iscsi_portal_ip)
+                    _logger.debug('Portal ip for [%s] is [%s]', _iqn_to_use, _iscsi_portal_ip)
                 elif pip_cand is not None:
                     _iscsi_portal_ip = pip_cand
                 else:
-                    _logger.info('Invalid argument, iqn %s not found', _iqn_to_use)
+                    _logger.info('Invalid argument, iqn [%s] not found', _iqn_to_use)
                     retval = 1
                     continue
             else:
@@ -1747,8 +1748,8 @@ def main():
                 if _iqn_to_use in detached_volume_iqns:
                     detached_volume_iqns.remove(_iqn_to_use)
             except Exception as e:
-                _logger.debug("Failed to attach target %s: %s", _iqn_to_use, str(e), exc_info=True, stack_info=True)
-                _logger.error("Failed to attach target %s: %s", _iqn_to_use, str(e))
+                _logger.debug("Failed to attach target [%s]: %s", _iqn_to_use, str(e), exc_info=True, stack_info=True)
+                _logger.error("Failed to attach target [%s]: %s", _iqn_to_use, str(e))
                 _save_chap_cred = False
                 retval = 1
                 continue
@@ -1758,10 +1759,11 @@ def main():
                 add_chap_secret(_iqn_to_use, _attachment_username, _attachment_password)
 
         if retval == 0:
+            # compat_info_message(gen_msg="Volume [%s] successfully attached." % _iqn_to_use)
             #
             # update detached volume cache
-            compat_info_message(gen_msg="Updating detached volume cache file: remove %s if necessary."
-                                        % _iqn_to_use, mode=compat_mode)
+            # compat_info_message(gen_msg="Updating detached volume cache file: remove %s if necessary."
+            #                             % _iqn_to_use, mode=compat_mode)
             write_cache(cache_content=detached_volume_iqns, cache_fname=__ignore_file)
             #
             # run ocid.refresh

lib/oci_utils/impl/oci_resources.py

@@ -595,8 +595,8 @@ def all_volumes(self):
                                                                       instance_id=self._ocid).data
         except oci_sdk.exceptions.ServiceError:
             # the user has no permission to list volumes
-            OCIInstance._logger.debug('the user has no permission to list volumes', exc_info=True)
-            # TODO : shouln't be an error ?
+            OCIInstance._logger.debug('The user has no permission to list volumes', exc_info=True, stack_info=True)
+            # TODO : shouldn't be an error ?
             return []
 
         # multiple volume attachments may exist for the same

lib/oci_utils/impl/ocid-main.py

@@ -300,6 +300,23 @@ def iscsi_func(context, func_logger):
 
     all_iqns = {}
 
+    # -------------------------------------------------------------------------------------
+    # possible change for LINUX-11440; comment out the in-between
+    # verify if user has authorisation to list volumes; if not, scan for new volumes.
+    # volumes = None
+    # if context['oci_sess'] is not None:
+    #     try:
+    #         #
+    #         # get a list of volumes attached to the instance
+    #         instance = context['oci_sess'].this_instance()
+    #         if instance is None:
+    #             func_logger.debug('Cannot get current instance.')
+    #         else:
+    #             volumes = instance.all_volumes()
+    #     except Exception as e:
+    #         func_logger.debug('User is not authorized to list all volumes.')
+    # -------------------------------------------------------------------------------------
+    #
     # volumes connected to this instance
     inst_volumes = []
     if context['oci_sess'] is not None:
@@ -321,6 +338,23 @@ def iscsi_func(context, func_logger):
                 else:
                     all_iqns[v.get_portal_ip()] = [v.get_iqn()]
             func_logger.debug('All volumes: %s', all_iqns)
+    # -------------------------------------------------------------------------------------
+    #
+    # possible change for LINUX-11440; comment out the above
+    # if bool(volumes):
+    #     for v in volumes:
+    #         vol = {'iqn': v.get_iqn(),
+    #                'ipaddr': v.get_portal_ip(),
+    #                'user': v.get_user(),
+    #                'password': v.get_password()}
+    #         inst_volumes.append(vol)
+    #         if v.get_portal_ip() in all_iqns:
+    #             all_iqns[v.get_portal_ip()].append(v.get_iqn())
+    #         else:
+    #             all_iqns[v.get_portal_ip()] = [v.get_iqn()]
+    #     func_logger.debug('All volumes: %s', all_iqns)
+    #
+    # -------------------------------------------------------------------------------------
     else:
         #
         # fall back to scanning
@@ -577,8 +611,7 @@ def start_thread(name, repeat):
         is_enabled = OCIUtilsConfiguration.get('public_ip', 'enabled')
         if is_enabled not in true_list:
             return None
-        refresh_interval = \
-            OCIUtilsConfiguration.get('public_ip', 'refresh_interval')
+        refresh_interval = OCIUtilsConfiguration.get('public_ip', 'refresh_interval')
         th = OcidThread(name=name,
                         ocidfunc=public_ip_func,
                         context={},

lib/oci_utils/iscsiadm.py

@@ -106,7 +106,7 @@ def discovery(ipaddr):
             output = subprocess.check_output(_cmd, stderr=dev_null).decode('utf-8')
         iqns = []
         for line in output.splitlines():
-            if b'iqn' not in line:
+            if 'iqn' not in line:
                 continue
             match = _DISCOVERY_PATTERN.match(line.strip())
             if match: