Merge "Add config paramater pipeline_check to enable/disable pipeline check"

etc/proxy-server.conf-sample

@@ -71,6 +71,11 @@ use = egg:swift3#swift3
 # Specify a host name of your Swift cluster.  This enables virtual-hosted style
 # requests.
 # storage_domain =
+#
+# Enable pipeline order check for SLO, s3token, authtoken, keystoneauth
+# If the order is incorrect, it raises a except to stop proxy.
+# pipeline_check = True
+#
 
 [filter:catch_errors]
 use = egg:swift#catch_errors

swift3/cfg.py

@@ -58,4 +58,5 @@ CONF = Config({
     'max_multi_delete_objects': 1000,
     's3_acl': False,
     'storage_domain': '',
+    'pipeline_check': True,
 })

swift3/middleware.py

@@ -120,7 +120,8 @@ class Swift3Middleware(object):
         pipeline = str(PipelineWrapper(ctx)).split(' ')
 
         # Add compatible with 3rd party middleware.
-        if check_filter_order(pipeline, ['swift3', 'proxy-server']):
+        if check_filter_order(pipeline,
+                              ['swift3', 'proxy-server']):
 
             auth_pipeline = pipeline[pipeline.index('swift3') + 1:
                                      pipeline.index('proxy-server')]
@@ -136,7 +137,8 @@ class Swift3Middleware(object):
                 LOGGER.debug('Use tempauth middleware.')
                 return
             elif 'keystoneauth' in auth_pipeline:
-                if check_filter_order(auth_pipeline, ['s3token',
+                if check_filter_order(auth_pipeline,
+                                      ['s3token',
                                        'authtoken',
                                        'keystoneauth']):
                     LOGGER.debug('Use keystone middleware.')
@@ -146,6 +148,7 @@ class Swift3Middleware(object):
                 LOGGER.debug('Use third party(unknown) auth middleware.')
                 return
 
+        if conf.pipeline_check:
             raise ValueError('Invalid proxy pipeline: %s' % pipeline)
 
 

swift3/test/unit/test_middleware.py

@@ -320,6 +320,7 @@ class TestSwift3Middleware(Swift3TestCase):
                     patch("swift3.middleware.PipelineWrapper"),
                     patch("swift3.middleware.loadcontext")) as \
                 (conf, pipeline, _):
+            conf.pipeline_check = True
             conf.__file__ = ''
 
             pipeline.return_value = 'swift3 tempauth proxy-server'
@@ -345,6 +346,28 @@ class TestSwift3Middleware(Swift3TestCase):
             with self.assertRaises(ValueError):
                 self.swift3.check_pipeline(conf)
 
+            # Disable pipeline check
+            conf.pipeline_check = False
+            pipeline.return_value = 'swift3 tempauth proxy-server'
+            self.swift3.check_pipeline(conf)
+
+            pipeline.return_value = 'swift3 s3token authtoken keystoneauth ' \
+                'proxy-server'
+            self.swift3.check_pipeline(conf)
+
+            pipeline.return_value = 'swift3 swauth proxy-server'
+            self.swift3.check_pipeline(conf)
+
+            pipeline.return_value = 'swift3 authtoken s3token keystoneauth ' \
+                'proxy-server'
+            self.swift3.check_pipeline(conf)
+
+            pipeline.return_value = 'swift3 proxy-server'
+            self.swift3.check_pipeline(conf)
+
+            pipeline.return_value = 'proxy-server'
+            self.swift3.check_pipeline(conf)
+
 
 if __name__ == '__main__':
     unittest.main()