Add unit test for GetAdminToken endpoint

Author: Hanzhang Zeng (Roger)

src/WebJobs.Script.WebHost/Controllers/HostController.cs

@@ -19,6 +19,7 @@
 using Microsoft.Azure.WebJobs.Script.WebHost.Filters;
 using Microsoft.Azure.WebJobs.Script.WebHost.Management;
 using Microsoft.Azure.WebJobs.Script.WebHost.Models;
+using Microsoft.Azure.WebJobs.Script.WebHost.Security;
 using Microsoft.Azure.WebJobs.Script.WebHost.Security.Authorization;
 using Microsoft.Azure.WebJobs.Script.WebHost.Security.Authorization.Policies;
 using Microsoft.Extensions.Logging;
@@ -229,6 +230,28 @@ public async Task<IActionResult> SetState([FromBody] string state)
             return Accepted();
         }
 
+        /// <summary>
+        /// This endpoint generates a temporary x-ms-site-restricted-token for core tool
+        /// to access KuduLite zipdeploy endpoint in Linux Consumption
+        /// </summary>
+        /// <returns>
+        /// 200 on token generated
+        /// 400 on non-Linux container environment
+        /// </returns>
+        [HttpGet]
+        [Route("admin/host/token")]
+        [Authorize(Policy = PolicyNames.AdminAuthLevel)]
+        public IActionResult GetAdminToken()
+        {
+            if (!_environment.IsLinuxContainerEnvironment())
+            {
+                return BadRequest("Endpoint is only available when running in Linux Container");
+            }
+
+            string requestHeaderToken = SimpleWebTokenHelper.CreateToken(DateTime.UtcNow.AddHours(2));
+            return Ok(requestHeaderToken);
+        }
+
         [AcceptVerbs("GET", "POST", "DELETE")]
         [Authorize(AuthenticationSchemes = AuthLevelAuthenticationDefaults.AuthenticationScheme)]
         [Route("runtime/webhooks/{name}/{*extra}")]

src/WebJobs.Script.WebHost/Controllers/InstanceController.cs

@@ -1,14 +1,12 @@
 // Copyright (c) .NET Foundation. All rights reserved.
 // Licensed under the MIT License. See License.txt in the project root for license information.
 
-using System;
 using System.Threading.Tasks;
 using Microsoft.AspNetCore.Authorization;
 using Microsoft.AspNetCore.Http;
 using Microsoft.AspNetCore.Mvc;
 using Microsoft.Azure.WebJobs.Script.WebHost.Management;
 using Microsoft.Azure.WebJobs.Script.WebHost.Models;
-using Microsoft.Azure.WebJobs.Script.WebHost.Security;
 using Microsoft.Azure.WebJobs.Script.WebHost.Security.Authorization.Policies;
 
 namespace Microsoft.Azure.WebJobs.Script.WebHost.Controllers
@@ -67,34 +65,5 @@ public IActionResult GetInstanceInfo()
         {
             return Ok(_instanceManager.GetInstanceInfo());
         }
-
-        /// <summary>
-        /// This endpoint generates a temporary x-ms-site-restricted-token for core tool
-        /// to access KuduLite zipdeploy endpoint in Linux Consumption
-        /// </summary>
-        /// <returns>
-        /// 200 on token generated
-        /// 400 on non-Linux container environment
-        /// 404 on WEBSITE_AUTH_ENCRYPTION_KEY is not set
-        /// </returns>
-        [HttpGet]
-        [Route("admin/getsitetoken")]
-        [Authorize(Policy = PolicyNames.AdminAuthLevel)]
-        public IActionResult GetSiteToken()
-        {
-            if (!_environment.IsLinuxContainerEnvironment())
-            {
-                return BadRequest("Endpoint is only available when running in Linux Container");
-            }
-
-            string websiteEncryptionKey = _environment.GetEnvironmentVariable(EnvironmentSettingNames.WebSiteAuthEncryptionKey);
-            if (string.IsNullOrEmpty(websiteEncryptionKey))
-            {
-                return NotFound("WEBSITE_AUTH_ENCRYPTION_KEY is not set.");
-            }
-
-            string requestHeaderToken = SimpleWebTokenHelper.CreateToken(DateTime.UtcNow.AddHours(2), websiteEncryptionKey.ToKeyBytes());
-            return Ok(requestHeaderToken);
-        }
     }
 }

test/WebJobs.Script.Tests/Controllers/Admin/HostControllerTests.cs

@@ -90,5 +90,43 @@ public async Task SetState_Succeeds(string desiredState, ScriptHostState current
                 Assert.False(fileExists);
             }
         }
+
+        [Fact]
+        public void GetAdminToken_Succeeds()
+        {
+            // Arrange
+            _mockEnvironment.Setup(p => p.GetEnvironmentVariable(It.Is<string>(k => k == EnvironmentSettingNames.ContainerName))).Returns<string>(v => v = "ContainerName");
+
+            var key = TestHelpers.GenerateKeyBytes();
+            var stringKey = TestHelpers.GenerateKeyHexString(key);
+            using (new TestScopedEnvironmentVariable(EnvironmentSettingNames.WebSiteAuthEncryptionKey, stringKey))
+            {
+                // Act
+                ObjectResult result = (ObjectResult)_hostController.GetAdminToken();
+                HttpStatusCode resultStatus = (HttpStatusCode)result.StatusCode;
+
+                // Assert
+                Assert.Equal(HttpStatusCode.OK, resultStatus);
+            }
+        }
+
+        [Fact]
+        public void GetAdminToken_Fails_NotLinuxContainer()
+        {
+            // Arrange
+            _mockEnvironment.Setup(p => p.GetEnvironmentVariable(It.Is<string>(k => k == EnvironmentSettingNames.ContainerName))).Returns<string>(v => v = null);
+
+            var key = TestHelpers.GenerateKeyBytes();
+            var stringKey = TestHelpers.GenerateKeyHexString(key);
+            using (new TestScopedEnvironmentVariable(EnvironmentSettingNames.WebSiteAuthEncryptionKey, stringKey))
+            {
+                // Act
+                ObjectResult result = (ObjectResult)_hostController.GetAdminToken();
+                HttpStatusCode resultStatus = (HttpStatusCode)result.StatusCode;
+
+                // Assert
+                Assert.Equal(HttpStatusCode.BadRequest, resultStatus);
+            }
+        }
     }
 }