Add Function checks back to KeysController

Author: mathewc

src/WebJobs.Script.WebHost/App_Start/AutofacBootstrap.cs

@@ -1,6 +1,7 @@
 // Copyright (c) .NET Foundation. All rights reserved.
 // Licensed under the MIT License. See License.txt in the project root for license information.
 
+using System.IO.Abstractions;
 using Autofac;
 using Microsoft.Azure.WebJobs.Host;
 using Microsoft.Azure.WebJobs.Script.Config;
@@ -16,6 +17,7 @@ internal static void Initialize(ScriptSettingsManager settingsManager, Container
         {
             builder.RegisterInstance(settingsManager);
             builder.RegisterInstance(settings);
+            builder.Register<IFileSystem>(_ => FileUtility.Instance).SingleInstance();
 
             builder.RegisterType<WebHostResolver>().SingleInstance();
             builder.RegisterType<DefaultSecretManagerFactory>().As<ISecretManagerFactory>().SingleInstance();

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

@@ -3,6 +3,8 @@
 
 using System;
 using System.Collections.Generic;
+using System.IO;
+using System.IO.Abstractions;
 using System.Linq;
 using System.Net;
 using System.Threading.Tasks;
@@ -26,12 +28,16 @@ public class KeysController : ApiController
         private readonly ISecretManager _secretManager;
         private readonly TraceWriter _traceWriter;
         private readonly ILogger _logger;
+        private readonly WebHostSettings _settings;
+        private readonly IFileSystem _fileSystem;
 
-        public KeysController(ISecretManager secretManager, TraceWriter traceWriter, ILoggerFactory loggerFactory)
+        public KeysController(WebHostSettings settings, ISecretManager secretManager, TraceWriter traceWriter, ILoggerFactory loggerFactory, IFileSystem fileSystem)
         {
+            _settings = settings;
             _secretManager = secretManager;
             _traceWriter = traceWriter.WithDefaults($"{ScriptConstants.TraceSourceSecretManagement}.Api");
             _logger = loggerFactory?.CreateLogger(ScriptConstants.LogCategoryKeysController);
+            _fileSystem = fileSystem;
         }
 
         [HttpGet]
@@ -86,6 +92,11 @@ public async Task<IHttpActionResult> GetHostKey(string name)
 
         private async Task<IDictionary<string, string>> GetFunctionKeys(string functionName)
         {
+            if (!IsFunction(functionName))
+            {
+                return null;
+            }
+
             return await _secretManager.GetFunctionSecretsAsync(functionName);
         }
 
@@ -155,6 +166,11 @@ private async Task<IHttpActionResult> PutKeyAsync(string keyName, Key key, strin
 
         private async Task<IHttpActionResult> AddOrUpdateSecretAsync(string keyName, string value, string keyScope, ScriptSecretsType secretsType)
         {
+            if (secretsType == ScriptSecretsType.Function && keyScope != null && !IsFunction(keyScope))
+            {
+                return NotFound();
+            }
+
             KeyOperationResult operationResult;
             if (secretsType == ScriptSecretsType.Host && string.Equals(keyName, MasterKeyName, StringComparison.OrdinalIgnoreCase))
             {
@@ -224,7 +240,8 @@ private async Task<IHttpActionResult> DeleteFunctionSecretAsync(string keyName,
                 return BadRequest("Invalid key name.");
             }
 
-            if (!await _secretManager.DeleteSecretAsync(keyName, keyScope, secretsType))
+            if ((secretsType == ScriptSecretsType.Function && keyScope != null && !IsFunction(keyScope)) || 
+                !await _secretManager.DeleteSecretAsync(keyName, keyScope, secretsType))
             {
                 // the key was not found
                 return NotFound();
@@ -236,5 +253,12 @@ private async Task<IHttpActionResult> DeleteFunctionSecretAsync(string keyName,
 
             return StatusCode(HttpStatusCode.NoContent);
         }
+
+        private bool IsFunction(string functionName)
+        {
+            string json = null;
+            string functionPath = Path.Combine(_settings.ScriptPath, functionName);
+            return ScriptHost.TryReadFunctionConfig(functionPath, out json, _fileSystem);
+        }
     }
 }

src/WebJobs.Script.WebHost/WebJobs.Script.WebHost.csproj

@@ -351,6 +351,9 @@
       <HintPath>..\..\packages\System.IO.4.3.0\lib\net462\System.IO.dll</HintPath>
       <Private>True</Private>
     </Reference>
+    <Reference Include="System.IO.Abstractions, Version=2.0.0.140, Culture=neutral, processorArchitecture=MSIL">
+      <HintPath>..\..\packages\System.IO.Abstractions.2.0.0.140\lib\net40\System.IO.Abstractions.dll</HintPath>
+    </Reference>
     <Reference Include="System.IO.Compression, Version=4.1.2.0, Culture=neutral, PublicKeyToken=b77a5c561934e089, processorArchitecture=MSIL">
       <HintPath>..\..\packages\System.IO.Compression.4.3.0\lib\net46\System.IO.Compression.dll</HintPath>
       <Private>True</Private>

src/WebJobs.Script.WebHost/packages.config

@@ -107,6 +107,7 @@
   <package id="System.Globalization.Calendars" version="4.3.0" targetFramework="net471" />
   <package id="System.IdentityModel.Tokens.Jwt" version="5.1.3" targetFramework="net471" />
   <package id="System.IO" version="4.3.0" targetFramework="net471" />
+  <package id="System.IO.Abstractions" version="2.0.0.140" targetFramework="net471" />
   <package id="System.IO.Compression" version="4.3.0" targetFramework="net471" />
   <package id="System.IO.Compression.ZipFile" version="4.3.0" targetFramework="net471" />
   <package id="System.IO.FileSystem" version="4.3.0" targetFramework="net471" />

src/WebJobs.Script/Extensions/FileUtility.cs

@@ -3,28 +3,38 @@
 
 using System;
 using System.IO;
+using System.IO.Abstractions;
 using System.Text;
 using System.Threading.Tasks;
 
 namespace Microsoft.Azure.WebJobs.Script
 {
     public static class FileUtility
     {
+        private static IFileSystem _default = new FileSystem();
+        private static IFileSystem _instance;
+
+        public static IFileSystem Instance
+        {
+            get { return _instance ?? _default; }
+            set { _instance = value; }
+        }
+
         public static void EnsureDirectoryExists(string path)
         {
-            if (!Directory.Exists(path))
+            if (!Instance.Directory.Exists(path))
             {
-                Directory.CreateDirectory(path);
+                Instance.Directory.CreateDirectory(path);
             }
         }
 
         public static Task DeleteDirectoryAsync(string path, bool recursive)
         {
             return Task.Run(() =>
             {
-                if (Directory.Exists(path))
+                if (Instance.Directory.Exists(path))
                 {
-                    Directory.Delete(path, recursive);
+                    Instance.Directory.Delete(path, recursive);
                 }
             });
         }
@@ -33,9 +43,9 @@ public static Task<bool> DeleteIfExistsAsync(string path)
         {
             return Task.Run(() =>
             {
-                if (File.Exists(path))
+                if (Instance.File.Exists(path))
                 {
-                    File.Delete(path);
+                    Instance.File.Delete(path);
                     return true;
                 }
                 return false;
@@ -55,7 +65,8 @@ public static async Task WriteAsync(string path, string contents, Encoding encod
             }
 
             encoding = encoding ?? Encoding.UTF8;
-            using (var writer = new StreamWriter(path, false, encoding, 4096))
+            using (Stream fileStream = OpenFile(path, FileMode.Create, FileAccess.Write, FileShare.ReadWrite | FileShare.Delete))
+            using (var writer = new StreamWriter(fileStream, encoding, 4096))
             {
                 await writer.WriteAsync(contents);
             }
@@ -69,12 +80,20 @@ public static async Task<string> ReadAsync(string path, Encoding encoding = null
             }
 
             encoding = encoding ?? Encoding.UTF8;
-            using (var reader = new StreamReader(path, encoding, true, 4096))
+            using (var fileStream = OpenFile(path, FileMode.Open, FileAccess.Read, FileShare.ReadWrite | FileShare.Delete))
+            using (var reader = new StreamReader(fileStream, encoding, true, 4096))
             {
                 return await reader.ReadToEndAsync();
             }
         }
 
+        public static string ReadAllText(string path) => Instance.File.ReadAllText(path);
+
+        public static Stream OpenFile(string path, FileMode mode, FileAccess access = FileAccess.ReadWrite, FileShare share = FileShare.None)
+        {
+            return Instance.File.Open(path, mode, access, share);
+        }
+
         public static string GetRelativePath(string path1, string path2)
         {
             if (path1 == null)
@@ -124,7 +143,7 @@ public static Task<string[]> GetFilesAsync(string path, string prefix)
 
             return Task.Run(() =>
             {
-                return Directory.GetFiles(path, prefix);
+                return Instance.Directory.GetFiles(path, prefix);
             });
         }
     }

src/WebJobs.Script/Host/ScriptHost.cs

@@ -1093,59 +1093,66 @@ public static Collection<FunctionMetadata> ReadFunctionMetadata(IEnumerable<stri
                 traceWriter.Info(msg);
             }
 
-            foreach (var scriptDir in functionDirectories)
+            foreach (var functionDirectory in functionDirectories)
             {
-                string functionName = null;
-                try
+                var function = ReadFunctionMetadata(functionDirectory, traceWriter, logger, functionErrors, settingsManager, functionWhitelist);
+                if (function != null)
                 {
-                    // read the function config
-                    string functionConfigPath = Path.Combine(scriptDir, ScriptConstants.FunctionMetadataFileName);
-                    string json = null;
-                    try
-                    {
-                        json = File.ReadAllText(functionConfigPath);
-                    }
-                    catch (FileNotFoundException)
-                    {
-                        // not a function directory
-                        continue;
-                    }
+                    functions.Add(function);
+                }
+            }
 
-                    functionName = Path.GetFileName(scriptDir);
-                    if (functionWhitelist != null &&
-                        !functionWhitelist.Contains(functionName, StringComparer.OrdinalIgnoreCase))
-                    {
-                        // a functions filter has been specified and the current function is
-                        // not in the filter list
-                        continue;
-                    }
+            return functions;
+        }
 
-                    ValidateName(functionName);
+        public static FunctionMetadata ReadFunctionMetadata(string functionDirectory, TraceWriter traceWriter, ILogger logger, Dictionary<string, Collection<string>> functionErrors, ScriptSettingsManager settingsManager = null, IEnumerable<string> functionWhitelist = null)
+        {
+            string functionName = null;
 
-                    JObject functionConfig = JObject.Parse(json);
+            try
+            {
+                // read the function config
+                string json = null;
+                if (!TryReadFunctionConfig(functionDirectory, out json))
+                {
+                    // not a function directory
+                    return null;
+                }
 
-                    string functionError = null;
-                    FunctionMetadata functionMetadata = null;
-                    if (!TryParseFunctionMetadata(functionName, functionConfig, traceWriter, logger, scriptDir, settingsManager, out functionMetadata, out functionError))
-                    {
-                        // for functions in error, log the error and don't
-                        // add to the functions collection
-                        AddFunctionError(functionErrors, functionName, functionError);
-                        continue;
-                    }
-                    else if (functionMetadata != null)
-                    {
-                        functions.Add(functionMetadata);
-                    }
+                functionName = Path.GetFileName(functionDirectory);
+                if (functionWhitelist != null &&
+                    !functionWhitelist.Contains(functionName, StringComparer.OrdinalIgnoreCase))
+                {
+                    // a functions filter has been specified and the current function is
+                    // not in the filter list
+                    return null;
                 }
-                catch (Exception ex)
+
+                ValidateName(functionName);
+
+                JObject functionConfig = JObject.Parse(json);
+
+                string functionError = null;
+                FunctionMetadata functionMetadata = null;
+                if (!TryParseFunctionMetadata(functionName, functionConfig, traceWriter, logger, functionDirectory, settingsManager, out functionMetadata, out functionError))
                 {
-                    // log any unhandled exceptions and continue
-                    AddFunctionError(functionErrors, functionName, Utility.FlattenException(ex, includeSource: false), isFunctionShortName: true);
+                    // for functions in error, log the error and don't
+                    // add to the functions collection
+                    AddFunctionError(functionErrors, functionName, functionError);
+                    return null;
+                }
+                else if (functionMetadata != null)
+                {
+                    return functionMetadata;
                 }
             }
+            catch (Exception ex)
+            {
+                // log any unhandled exceptions and continue
+                AddFunctionError(functionErrors, functionName, Utility.FlattenException(ex, includeSource: false), isFunctionShortName: true);
+            }
 
-            return functions;
+            return null;
         }
 
         internal Collection<FunctionMetadata> ReadProxyMetadata(ScriptHostConfiguration config, ScriptSettingsManager settingsManager = null)
@@ -1177,6 +1184,27 @@ internal Collection<FunctionMetadata> ReadProxyMetadata(ScriptHostConfiguration
             return null;
         }
 
+        internal static bool TryReadFunctionConfig(string scriptDir, out string json, IFileSystem fileSystem = null)
+        {
+            json = null;
+            fileSystem = fileSystem ?? FileUtility.Instance;
+
+            // read the function config
+            string functionConfigPath = Path.Combine(scriptDir, ScriptConstants.FunctionMetadataFileName);
+            try
+            {
+                json = fileSystem.File.ReadAllText(functionConfigPath);
+            }
+            catch (IOException ex) when
+                (ex is FileNotFoundException || ex is DirectoryNotFoundException)
+            {
+                // not a function directory
+                return false;
+            }
+
+            return true;
+        }
+
         private Collection<FunctionMetadata> LoadProxyRoutes(string proxiesJson)
         {
             var proxies = new Collection<FunctionMetadata>();