rename get_pipeline -> get_pipeline_views

evanpurkhiser · evanpurkhiser · commit bf734e7065fb · 2017-12-05T16:54:06.000-08:00
Also adds a method specifically for this
diff --git a/src/sentry/utils/pipeline.py b/src/sentry/utils/pipeline.py
@@ -12,10 +12,10 @@ class PipelineProvider(object):
     views that the Pipeline will traverse through.
     """
 
-    def get_pipeline(self):
+    def get_pipeline_views(self):
         """
         Returns a list of instantiated views which implement the PipelineView
-        class. Each view will be dispatched in order.
+        interface. Each view will be dispatched in order.
         >>> return [OAuthInitView(), OAuthCallbackView()]
         """
         raise NotImplementedError
@@ -32,7 +32,7 @@ def set_config(self, config):
 class PipelineView(BaseView):
     """
     A class implementing the PipelineView may be used in a PipleineProviders
-    get_pipeline list.
+    get_pipeline_views list.
     """
 
     def dispatch(self, request, pipeline):
@@ -144,14 +144,24 @@ def __init__(self, request, organization, provider_key, provider_model=None, con
         self.config = config
         self.provider.set_config(config)
 
-        self.pipeline = self.provider.get_pipeline()
+        self.pipeline = self.get_pipeline_views()
 
         # we serialize the pipeline to be ['fqn.PipelineView', ...] which
         # allows us to determine if the pipeline has changed during the auth
         # flow or if the user is somehow circumventing a chunk of it
         pipe_ids = ['{}.{}'.format(type(v).__module__, type(v).__name__) for v in self.pipeline]
         self.signature = md5_text(*pipe_ids).hexdigest()
 
+    def get_pipeline_views(self):
+        """
+        Retrieve the pipeline views from the provider.
+
+        You may wish to override this method to provide views that all
+        providers should inherit, or customize the provider method called to
+        retrieve the views.
+        """
+        return self.provider.get_pipeline_views()
+
     def is_valid(self):
         return self.state.is_valid() and self.state.signature == self.signature
 
diff --git a/tests/sentry/utils/test_pipeline.py b/tests/sentry/utils/test_pipeline.py
@@ -16,7 +16,7 @@ class DummyProvider(PipelineProvider):
     key = 'dummy'
     pipeline = [PipelineStep(), PipelineStep()]
 
-    def get_pipeline(self):
+    def get_pipeline_views(self):
         return self.pipeline
 
 
