Reserving "runtime" route

saranyakrishnasamy · Sep 17, 2018 · cd0af65 · cd0af65
1 parent b490a2c
commit cd0af65
Show file tree

Hide file tree

Showing 3 changed files with 81 additions and 68 deletions.
diff --git a/src/WebJobs.Script.WebHost/Controllers/FunctionsController.cs b/src/WebJobs.Script.WebHost/Controllers/FunctionsController.cs
@@ -121,14 +121,15 @@ public IActionResult Invoke(string name, [FromBody] FunctionInvocation invocatio
         [HttpGet]
         [Route("admin/functions/{name}/status")]
         [Authorize(Policy = PolicyNames.AdminAuthLevel)]
-        public async Task<IActionResult> GetFunctionStatus(string name, [FromServices] IScriptJobHost scriptHost)
+        public async Task<IActionResult> GetFunctionStatus(string name, [FromServices] IScriptJobHost scriptHost = null)
         {
             FunctionStatus status = new FunctionStatus();
 
             // first see if the function has any errors
             // if the host is not running or is offline
             // there will be no error info
-            if (scriptHost.FunctionErrors.TryGetValue(name, out ICollection<string> functionErrors))
+            if (scriptHost != null &&
+                scriptHost.FunctionErrors.TryGetValue(name, out ICollection<string> functionErrors))
             {
                 status.Errors = functionErrors;
             }

diff --git a/src/WebJobs.Script/Host/ScriptHost.cs b/src/WebJobs.Script/Host/ScriptHost.cs
@@ -764,7 +764,8 @@ internal static void ValidateHttpFunction(string functionName, HttpTriggerAttrib
 
             // disallow custom routes in our own reserved route space
             string httpRoute = httpTrigger.Route.Trim('/').ToLowerInvariant();
-            if (httpRoute.StartsWith("admin"))
+            if (httpRoute.StartsWith("admin") ||
+                httpRoute.StartsWith("runtime"))
             {
                 throw new InvalidOperationException("The specified route conflicts with one or more built in routes.");
             }

diff --git a/test/WebJobs.Script.Tests/ScriptHostTests.cs b/test/WebJobs.Script.Tests/ScriptHostTests.cs
@@ -927,67 +927,6 @@ public async Task InitializeRpcService_Throws()
             Assert.Equal("Failed to start Grpc Service. Check if your app is hitting connection limits.", ex.Message);
         }
 
-#if WEBROUTING
-        [Fact]
-        public void HttpRoutesConflict_ReturnsExpectedResult()
-        {
-            var first = new HttpTriggerAttribute
-            {
-                Route = "foo/bar/baz"
-            };
-            var second = new HttpTriggerAttribute
-            {
-                Route = "foo/bar"
-            };
-            Assert.False(ScriptHost.HttpRoutesConflict(first, second));
-            Assert.False(ScriptHost.HttpRoutesConflict(second, first));
-
-            first = new HttpTriggerAttribute
-            {
-                Route = "foo/bar/baz"
-            };
-            second = new HttpTriggerAttribute
-            {
-                Route = "foo/bar/baz"
-            };
-            Assert.True(ScriptHost.HttpRoutesConflict(first, second));
-            Assert.True(ScriptHost.HttpRoutesConflict(second, first));
-
-            // no conflict since methods do not intersect
-            first = new HttpTriggerAttribute(AuthorizationLevel.Function, "get", "head")
-            {
-                Route = "foo/bar/baz"
-            };
-            second = new HttpTriggerAttribute(AuthorizationLevel.Function, "post", "put")
-            {
-                Route = "foo/bar/baz"
-            };
-            Assert.False(ScriptHost.HttpRoutesConflict(first, second));
-            Assert.False(ScriptHost.HttpRoutesConflict(second, first));
-
-            first = new HttpTriggerAttribute(AuthorizationLevel.Function, "get", "head")
-            {
-                Route = "foo/bar/baz"
-            };
-            second = new HttpTriggerAttribute
-            {
-                Route = "foo/bar/baz"
-            };
-            Assert.True(ScriptHost.HttpRoutesConflict(first, second));
-            Assert.True(ScriptHost.HttpRoutesConflict(second, first));
-
-            first = new HttpTriggerAttribute(AuthorizationLevel.Function, "get", "head", "put", "post")
-            {
-                Route = "foo/bar/baz"
-            };
-            second = new HttpTriggerAttribute(AuthorizationLevel.Function, "put")
-            {
-                Route = "foo/bar/baz"
-            };
-            Assert.True(ScriptHost.HttpRoutesConflict(first, second));
-            Assert.True(ScriptHost.HttpRoutesConflict(second, first));
-        }
-
         [Fact]
         public void ValidateFunction_ValidatesHttpRoutes()
         {
@@ -1056,16 +995,88 @@ public void ValidateFunction_ValidatesHttpRoutes()
             });
             Assert.Equal("The specified route conflicts with one or more built in routes.", ex.Message);
 
-            // verify that empty route is defaulted to function name
+            // try to add a route under reserved runtime route
             function = new Mock<FunctionDescriptor>(MockBehavior.Strict, "test6", null, metadata, null, null, null, null);
+            attribute = new HttpTriggerAttribute
+            {
+                Route = "runtime/foo/bar"
+            };
+            function.Setup(p => p.GetTriggerAttributeOrNull<HttpTriggerAttribute>()).Returns(() => attribute);
+            ex = Assert.Throws<InvalidOperationException>(() =>
+            {
+                ScriptHost.ValidateFunction(function.Object, httpFunctions);
+            });
+            Assert.Equal("The specified route conflicts with one or more built in routes.", ex.Message);
+
+            // verify that empty route is defaulted to function name
+            function = new Mock<FunctionDescriptor>(MockBehavior.Strict, "test7", null, metadata, null, null, null, null);
             attribute = new HttpTriggerAttribute();
             function.Setup(p => p.GetTriggerAttributeOrNull<HttpTriggerAttribute>()).Returns(() => attribute);
             ScriptHost.ValidateFunction(function.Object, httpFunctions);
             Assert.Equal(4, httpFunctions.Count);
-            Assert.True(httpFunctions.ContainsKey("test6"));
-            Assert.Equal("test6", attribute.Route);
+            Assert.True(httpFunctions.ContainsKey("test7"));
+            Assert.Equal("test7", attribute.Route);
+        }
+
+        [Fact]
+        public void HttpRoutesConflict_ReturnsExpectedResult()
+        {
+            var first = new HttpTriggerAttribute
+            {
+                Route = "foo/bar/baz"
+            };
+            var second = new HttpTriggerAttribute
+            {
+                Route = "foo/bar"
+            };
+            Assert.False(ScriptHost.HttpRoutesConflict(first, second));
+            Assert.False(ScriptHost.HttpRoutesConflict(second, first));
+
+            first = new HttpTriggerAttribute
+            {
+                Route = "foo/bar/baz"
+            };
+            second = new HttpTriggerAttribute
+            {
+                Route = "foo/bar/baz"
+            };
+            Assert.True(ScriptHost.HttpRoutesConflict(first, second));
+            Assert.True(ScriptHost.HttpRoutesConflict(second, first));
+
+            // no conflict since methods do not intersect
+            first = new HttpTriggerAttribute(AuthorizationLevel.Function, "get", "head")
+            {
+                Route = "foo/bar/baz"
+            };
+            second = new HttpTriggerAttribute(AuthorizationLevel.Function, "post", "put")
+            {
+                Route = "foo/bar/baz"
+            };
+            Assert.False(ScriptHost.HttpRoutesConflict(first, second));
+            Assert.False(ScriptHost.HttpRoutesConflict(second, first));
+
+            first = new HttpTriggerAttribute(AuthorizationLevel.Function, "get", "head")
+            {
+                Route = "foo/bar/baz"
+            };
+            second = new HttpTriggerAttribute
+            {
+                Route = "foo/bar/baz"
+            };
+            Assert.True(ScriptHost.HttpRoutesConflict(first, second));
+            Assert.True(ScriptHost.HttpRoutesConflict(second, first));
+
+            first = new HttpTriggerAttribute(AuthorizationLevel.Function, "get", "head", "put", "post")
+            {
+                Route = "foo/bar/baz"
+            };
+            second = new HttpTriggerAttribute(AuthorizationLevel.Function, "put")
+            {
+                Route = "foo/bar/baz"
+            };
+            Assert.True(ScriptHost.HttpRoutesConflict(first, second));
+            Assert.True(ScriptHost.HttpRoutesConflict(second, first));
         }
-#endif
 
         [Fact]
         public void ValidateFunction_ThrowsOnDuplicateName()