Merge pull request #26 from platformsh/routes-utils

Add useful route filtering utilities

Author: Crell

Pipfile.lock

@@ -284,6 +284,54 @@ def routes(self):
             )
         return self._routesDef
 
+    def get_primary_route(self):
+        """Returns the primary route.
+
+        The primary route is the one marked primary in `routes.yaml`, or else
+        the first non-direct route in that file if none are marked.
+
+        Returns:
+            The route definition. The generated URL of the route is added as a "url" key.
+
+        """
+        for (url, route) in self.routes().items():
+            if route["primary"]:
+                return route
+        raise KeyError("No primary route found. This isn't supposed to happen.")
+
+    def get_upstream_routes(self, app_name=None):
+        """Returns just those routes that point to a valid upstream.
+
+        The method is similar to routes(), but filters out redirect routes that are rarely
+        useful for app configuration. If desired it can also filter to just those routes
+        whose upstream is a given application name. To retrieve routes that point to the
+        current application where the code is being run, use:
+
+        routes = config.get_upstream_routes(config._applicationName)
+
+        Args:
+            app_name (string|None):
+                The name of the upstream app on which to filter, if any.
+
+        Returns:
+            A dictionary of route definitions.
+
+        """
+        if app_name:
+            # On Dedicated, the upstream name sometimes is `app:http` instead of just `app`.
+            # If no name is specified then don't bother checking.
+            return {
+                url: route
+                for url, route in self.routes().items()
+                if route["type"] == "upstream" and app_name == route["upstream"].split(":")[0]
+            }
+        else:
+            return {
+                url: route
+                for url, route in self.routes().items()
+                if route["type"] == "upstream"
+            }
+
     def get_route(self, route_id):
         """Get route definition by route ID.
 

platformshconfig/config.py

@@ -12,7 +12,7 @@
 
 cwd = os.path.abspath(os.path.dirname(__file__))
 
-VERSION = "2.2.3"
+VERSION = "2.2.4"
 
 with open('README.md', 'r', encoding='utf-8') as f:
     __readme__ = f.read()

setup.py

@@ -117,6 +117,44 @@ def test_get_non_existent_route_throws_exception(self):
         with self.assertRaises(KeyError):
             config.get_route('missing')
 
+    def test_primary_route_returns_correct_route(self):
+
+        config = Config(self.mockEnvironmentDeploy)
+        route = config.get_primary_route()
+
+        self.assertEqual("https://www.{default}/", route["original_url"])
+
+    def test_upstream_routes(self):
+
+        config = Config(self.mockEnvironmentDeploy)
+        routes = config.get_upstream_routes()
+
+        self.assertEqual(len(routes), 3)
+        self.assertTrue("https://www.master-7rqtwti-gcpjkefjk4wc2.us-2.platformsh.site/" in routes)
+        self.assertEqual("https://www.{default}/", routes["https://www.master-7rqtwti-gcpjkefjk4wc2.us-2.platformsh.site/"]["original_url"])
+
+    def test_upstream_routes_for_app(self):
+
+        config = Config(self.mockEnvironmentDeploy)
+        routes = config.get_upstream_routes("app")
+
+        self.assertEqual(len(routes), 2)
+        self.assertTrue("https://www.master-7rqtwti-gcpjkefjk4wc2.us-2.platformsh.site/" in routes)
+        self.assertEqual("https://www.{default}/", routes["https://www.master-7rqtwti-gcpjkefjk4wc2.us-2.platformsh.site/"]["original_url"])
+
+    def test_upstream_routes_for_app_on_dedicated(self):
+        env = self.mockEnvironmentDeploy
+        routeData = self.loadJsonFile('PLATFORM_ROUTES')
+        routeData['https://www.master-7rqtwti-gcpjkefjk4wc2.us-2.platformsh.site/']['upstream'] = 'app:http'
+        env['PLATFORM_ROUTES'] = self.encode(routeData)
+
+        config = Config(env)
+        routes = config.get_upstream_routes("app")
+
+        self.assertEqual(len(routes), 2)
+        self.assertTrue("https://www.master-7rqtwti-gcpjkefjk4wc2.us-2.platformsh.site/" in routes)
+        self.assertEqual("https://www.{default}/", routes["https://www.master-7rqtwti-gcpjkefjk4wc2.us-2.platformsh.site/"]["original_url"])
+
     def test_onenterprise_returns_true_on_enterprise(self):
 
         env = self.mockEnvironmentDeploy