From 6dd5e20c2e8458e9e6951470dce46647cd1ca586 Mon Sep 17 00:00:00 2001
From: Fabio Oliveira <fabioaurelio1269@gmail.com>
Date: Tue, 20 Jul 2021 11:27:42 -0300
Subject: [PATCH] NetApp SolidFire: Fix RecursionError accessing undefined
 attributes

A RecursionError exception can occur in the SolidFire driver when
accessing a Driver class attribute that does not exist in both
SolidFireDriver and SolidFireISCSI classes.

The SolidFireDriver class (the driver's entry point) implements
__getattr__ so that a call to a missing attribute is redirected to
its complementary class SolidFireISCSI. The problem is that
SolidFireISCSI class was also implemented in the same way, looking
for attributes in SolidFireDriver in case it doesn't provide a
definition. So a call to an attribute that does not exist in both
classes leads to a class trying to find the attribute in the other,
in an endless loop situation.

Applications such as OSProfiler may hit this scenario by inspecting
the SolidFire driver class instance at  driver's initialization and
causing its failure.

This patch fixes the issue by removing __getattr__ implementation
from SolidFireISCSI, allowing the driver to return
NotImplementedError exception correctly.

Change-Id: Ic611b2abf11b94f9a21353df426cda19c09bf085
Closes-Bug: 1934459
---
 cinder/volume/drivers/solidfire.py            | 25 ++++++++-----------
 ...r-infinite-recursion-ec3d4794c89b2f83.yaml |  7 ++++++
 2 files changed, 17 insertions(+), 15 deletions(-)
 create mode 100644 releasenotes/notes/netapp-solidfire-fix-osprofiler-infinite-recursion-ec3d4794c89b2f83.yaml

diff --git a/cinder/volume/drivers/solidfire.py b/cinder/volume/drivers/solidfire.py
index 5087379689c..43e27de8c50 100644
--- a/cinder/volume/drivers/solidfire.py
+++ b/cinder/volume/drivers/solidfire.py
@@ -286,9 +286,11 @@ class SolidFireDriver(san.SanISCSIDriver):
                    xDBConnectionLoss, xNoHandler, xSnapshotFailed,
                    xRecvTimeout, xDBNoSuchPath, xPermissionDenied to the
                    retryable exception list
+          2.2.5  - Fix bug #1934459 SolidFire Driver gets into an infinite
+                   recursion on startup while OS Profiler is enabled
     """
 
-    VERSION = '2.2.4'
+    VERSION = '2.2.5'
 
     SUPPORTS_ACTIVE_ACTIVE = True
 
@@ -2879,15 +2881,8 @@ class SolidFireISCSI(iscsi_driver.SanISCSITarget):
         super(SolidFireISCSI, self).__init__(*args, **kwargs)
         self.sf_driver = kwargs.get('solidfire_driver')
 
-    def __getattr__(self, attr):
-        if hasattr(self.sf_driver, attr):
-            return getattr(self.sf_driver, attr)
-        else:
-            msg = _('Attribute: %s not found.') % attr
-            raise NotImplementedError(msg)
-
     def _do_iscsi_export(self, volume):
-        sfaccount = self._get_sfaccount(volume['project_id'])
+        sfaccount = self.sf_driver._get_sfaccount(volume['project_id'])
         model_update = {}
         model_update['provider_auth'] = ('CHAP %s %s'
                                          % (sfaccount['username'],
@@ -2925,8 +2920,8 @@ class SolidFireISCSI(iscsi_driver.SanISCSITarget):
 
             # safe_create_vag may opt to reuse vs create a vag, so we need to
             # add our vol_id.
-            vag_id = self._safe_create_vag(iqn, vol_id)
-            self._add_volume_to_vag(vol_id, iqn, vag_id)
+            vag_id = self.sf_driver._safe_create_vag(iqn, vol_id)
+            self.sf_driver._add_volume_to_vag(vol_id, iqn, vag_id)
 
         # Continue along with default behavior
         return super(SolidFireISCSI, self).initialize_connection(volume,
@@ -2944,7 +2939,7 @@ class SolidFireISCSI(iscsi_driver.SanISCSITarget):
 
             if properties:
                 iqn = properties['initiator']
-                vag = self._get_vags_by_name(iqn)
+                vag = self.sf_driver._get_vags_by_name(iqn)
 
                 if vag and not volume['multiattach']:
                     # Multiattach causes problems with removing volumes from
@@ -2954,11 +2949,11 @@ class SolidFireISCSI(iscsi_driver.SanISCSITarget):
                     vag = vag[0]
                     vag_id = vag['volumeAccessGroupID']
                     if [vol_id] == vag['volumes']:
-                        self._remove_vag(vag_id)
+                        self.sf_driver._remove_vag(vag_id)
                     elif vol_id in vag['volumes']:
-                        self._remove_volume_from_vag(vol_id, vag_id)
+                        self.sf_driver._remove_volume_from_vag(vol_id, vag_id)
             else:
-                self._remove_volume_from_vags(vol_id)
+                self.sf_driver._remove_volume_from_vags(vol_id)
 
         return super(SolidFireISCSI, self).terminate_connection(volume,
                                                                 properties,
diff --git a/releasenotes/notes/netapp-solidfire-fix-osprofiler-infinite-recursion-ec3d4794c89b2f83.yaml b/releasenotes/notes/netapp-solidfire-fix-osprofiler-infinite-recursion-ec3d4794c89b2f83.yaml
new file mode 100644
index 00000000000..ae42d07a2fc
--- /dev/null
+++ b/releasenotes/notes/netapp-solidfire-fix-osprofiler-infinite-recursion-ec3d4794c89b2f83.yaml
@@ -0,0 +1,7 @@
+---
+fixes:
+  - |
+    NetApp SolidFire driver `bug #1934459
+    <https://bugs.launchpad.net/cinder/+bug/1934459>`_:
+    Fixed backend initialization failing with RecursionError error when
+    OSProfiler is enabled.