cherry-pick the fix for lp bug 2021550 to yoga branch (#848)

* Allow users to disable wsgi socket rotation (#801)

The lp bug 1863232 introduced a new configuration option called
WSGISocketRotation which allows users to disable socket rotation on the apache
side. This patch will also allow setting this option on the charm side.

Other gerrit review links:
horizon: https://review.opendev.org/c/openstack/charm-openstack-dashboard/+/886373
cinder: https://review.opendev.org/c/openstack/charm-cinder/+/886356
keystone: https://review.opendev.org/c/openstack/charm-keystone/+/886377
ncc: https://review.opendev.org/c/openstack/charm-nova-cloud-controller/+/885836

Partial-Bug: 2021550
(cherry picked from commit 996f241)
Signed-off-by: zhhuabj <joshua.zhang@canonical.com>

* Rename wsgi-rotation to wsgi-socket-rotation

Commit 996f241 added support for new config option
'wsgi-rotation' but that name should have been
'wsgi-socket-rotation' in order to have a 1:1 relation
with the apache config it changes. The following patches
that implement this config are currently blocked until
this lands so that they can be synced before merge:

 * https://review.opendev.org/c/openstack/charm-ceilometer/+/887793
 * https://review.opendev.org/c/openstack/charm-cinder/+/886356
 * https://review.opendev.org/c/openstack/charm-glance/+/886376
 * https://review.opendev.org/c/openstack/charm-keystone/+/886377
 * https://review.opendev.org/c/openstack/charm-nova-cloud-controller/+/885836
 * https://review.opendev.org/c/openstack/charm-openstack-dashboard/+/886373

Related-Bug: #2021550
(cherry picked from commit 1a90eb0)
Signed-off-by: zhhuabj <joshua.zhang@canonical.com>

---------

Signed-off-by: zhhuabj <joshua.zhang@canonical.com>
Co-authored-by: Edward Hope-Morley <edward.hope-morley@canonical.com>

charmhelpers/contrib/openstack/context.py

@@ -1665,6 +1665,9 @@ def __init__(self, name=None, script=None, admin_script=None,
 
     def __call__(self):
         total_processes = _calculate_workers()
+        enable_wsgi_socket_rotation = config('wsgi-socket-rotation')
+        if enable_wsgi_socket_rotation is None:
+            enable_wsgi_socket_rotation = True
         ctxt = {
             "service_name": self.service_name,
             "user": self.user,
@@ -1678,6 +1681,7 @@ def __call__(self):
             "public_processes": int(math.ceil(self.public_process_weight *
                                               total_processes)),
             "threads": 1,
+            "wsgi_socket_rotation": enable_wsgi_socket_rotation,
         }
         return ctxt
 

charmhelpers/contrib/openstack/templates/wsgi-openstack-api.conf

@@ -12,6 +12,12 @@ Listen {{ admin_port }}
 Listen {{ public_port }}
 {% endif -%}
 
+{% if wsgi_socket_rotation -%}
+WSGISocketRotation On
+{% else -%}
+WSGISocketRotation Off
+{% endif -%}
+
 {% if port -%}
 <VirtualHost *:{{ port }}>
     WSGIDaemonProcess {{ service_name }} processes={{ processes }} threads={{ threads }} user={{ user }} group={{ group }} \

tests/contrib/openstack/test_os_contexts.py

@@ -3288,7 +3288,9 @@ def test_loglevel_context_unset(self):
     @patch.object(context, '_calculate_workers')
     def test_wsgi_worker_config_context(self,
                                         _calculate_workers):
-        self.config.return_value = 2  # worker-multiplier=2
+        self.config.side_effect = fake_config({
+            'worker-multiplier': 2, 'non-defined-wsgi-socket-rotation': True
+        })
         _calculate_workers.return_value = 8
         service_name = 'service-name'
         script = '/usr/bin/script'
@@ -3305,13 +3307,16 @@ def test_wsgi_worker_config_context(self,
             "admin_processes": 2,
             "public_processes": 6,
             "threads": 1,
+            "wsgi_socket_rotation": True,
         }
         self.assertEqual(expect, ctxt())
 
     @patch.object(context, '_calculate_workers')
     def test_wsgi_worker_config_context_user_and_group(self,
                                                        _calculate_workers):
-        self.config.return_value = 1
+        self.config.side_effect = fake_config({
+            'worker-multiplier': 1, 'wsgi-socket-rotation': False
+        })
         _calculate_workers.return_value = 1
         service_name = 'service-name'
         script = '/usr/bin/script'
@@ -3332,6 +3337,7 @@ def test_wsgi_worker_config_context_user_and_group(self,
             "admin_processes": 1,
             "public_processes": 1,
             "threads": 1,
+            "wsgi_socket_rotation": False,
         }
         self.assertEqual(expect, ctxt())