Hosting #86 - Consume WebRootFileSystem

Tratcher · Tratcher · commit 3343bb4d2395 · 2014-12-05T11:03:19.000-08:00
diff --git a/samples/StaticFileSample/Startup.cs b/samples/StaticFileSample/Startup.cs
@@ -6,12 +6,11 @@ namespace StaticFilesSample
 {
     public class Startup
     {
-        public void Configuration(IApplicationBuilder app)
+        public void Configure(IApplicationBuilder app)
         {
             app.UseFileServer(new FileServerOptions()
             {
                 EnableDirectoryBrowsing = true,
-                FileSystem = new PhysicalFileSystem(@"c:\temp")
             });
         }
     }
diff --git a/samples/StaticFileSample/project.json b/samples/StaticFileSample/project.json
@@ -1,11 +1,16 @@
 {
+    "commands": {
+        "web": "Microsoft.AspNet.Hosting --server Microsoft.AspNet.Server.WebListener --server.Urls http://localhost:12345/"
+    },
     "dependencies": {
         "Microsoft.AspNet.Server.IIS": "1.0.0-*",
+        "Microsoft.AspNet.Server.WebListener": "1.0.0-*",
         "Kestrel": "1.0.0-*",
         "Microsoft.AspNet.StaticFiles": "1.0.0-*"
     },
     "frameworks": {
         "aspnet50": { },
-        "aspnetcore50": {}
-    }
+        "aspnetcore50": { }
+    },
+    "webroot": "wwwroot"
 }
diff --git a/samples/StaticFileSample/wwwroot/htmlpage.html b/samples/StaticFileSample/wwwroot/htmlpage.html
@@ -0,0 +1,11 @@
+﻿<!DOCTYPE html>
+
+<html>
+<head>
+    <meta charset="utf-8" />
+    <title></title>
+</head>
+<body>
+    A static HTML file.
+</body>
+</html>
diff --git a/src/Microsoft.AspNet.StaticFiles/DefaultFilesExtensions.cs b/src/Microsoft.AspNet.StaticFiles/DefaultFilesExtensions.cs
@@ -12,7 +12,7 @@ namespace Microsoft.AspNet.Builder
     public static class DefaultFilesExtensions
     {
         /// <summary>
-        /// Enables default file mapping on the current path from the current directory
+        /// Enables default file mapping on the current path
         /// </summary>
         /// <param name="builder"></param>
         /// <returns></returns>
@@ -22,10 +22,10 @@ public static IApplicationBuilder UseDefaultFiles([NotNull] this IApplicationBui
         }
 
         /// <summary>
-        /// Enables default file mapping for the given request path from the directory of the same name
+        /// Enables default file mapping for the given request path
         /// </summary>
         /// <param name="builder"></param>
-        /// <param name="requestPath">The relative request path and physical path.</param>
+        /// <param name="requestPath">The relative request path.</param>
         /// <returns></returns>
         public static IApplicationBuilder UseDefaultFiles([NotNull] this IApplicationBuilder builder, [NotNull] string requestPath)
         {
diff --git a/src/Microsoft.AspNet.StaticFiles/DefaultFilesMiddleware.cs b/src/Microsoft.AspNet.StaticFiles/DefaultFilesMiddleware.cs
@@ -29,10 +29,7 @@ public class DefaultFilesMiddleware
         /// <param name="options">The configuration options for this middleware.</param>
         public DefaultFilesMiddleware([NotNull] RequestDelegate next, [NotNull] IHostingEnvironment hostingEnv, [NotNull] DefaultFilesOptions options)
         {
-            if (options.FileSystem == null)
-            {
-                options.FileSystem = new PhysicalFileSystem(Helpers.ResolveRootPath(hostingEnv.WebRoot, options.RequestPath));
-            }
+            options.ResolveFileSystem(hostingEnv);
 
             _next = next;
             _options = options;
diff --git a/src/Microsoft.AspNet.StaticFiles/DirectoryBrowserExtensions.cs b/src/Microsoft.AspNet.StaticFiles/DirectoryBrowserExtensions.cs
@@ -12,7 +12,7 @@ namespace Microsoft.AspNet.Builder
     public static class DirectoryBrowserExtensions
     {
         /// <summary>
-        /// Enable directory browsing on the current path for the current directory
+        /// Enable directory browsing on the current path
         /// </summary>
         /// <param name="builder"></param>
         /// <returns></returns>
@@ -22,10 +22,10 @@ public static IApplicationBuilder UseDirectoryBrowser([NotNull] this IApplicatio
         }
 
         /// <summary>
-        /// Enables directory browsing for the given request path from the directory of the same name
+        /// Enables directory browsing for the given request path
         /// </summary>
         /// <param name="builder"></param>
-        /// <param name="requestPath">The relative request path and physical path.</param>
+        /// <param name="requestPath">The relative request path.</param>
         /// <returns></returns>
         public static IApplicationBuilder UseDirectoryBrowser([NotNull] this IApplicationBuilder builder, [NotNull] string requestPath)
         {
diff --git a/src/Microsoft.AspNet.StaticFiles/DirectoryBrowserMiddleware.cs b/src/Microsoft.AspNet.StaticFiles/DirectoryBrowserMiddleware.cs
@@ -31,10 +31,7 @@ public DirectoryBrowserMiddleware([NotNull] RequestDelegate next, [NotNull] IHos
             {
                 throw new ArgumentException(Resources.Args_NoFormatter);
             }
-            if (options.FileSystem == null)
-            {
-                options.FileSystem = new PhysicalFileSystem(Helpers.ResolveRootPath(hostingEnv.WebRoot, options.RequestPath));
-            }
+            options.ResolveFileSystem(hostingEnv);
 
             _next = next;
             _options = options;
diff --git a/src/Microsoft.AspNet.StaticFiles/DirectoryBrowserOptions.cs b/src/Microsoft.AspNet.StaticFiles/DirectoryBrowserOptions.cs
@@ -11,15 +11,15 @@ namespace Microsoft.AspNet.StaticFiles
     public class DirectoryBrowserOptions : SharedOptionsBase<DirectoryBrowserOptions>
     {
         /// <summary>
-        /// Enabled directory browsing in the current physical directory for all request paths
+        /// Enabled directory browsing for all request paths
         /// </summary>
         public DirectoryBrowserOptions()
             : this(new SharedOptions())
         {
         }
 
         /// <summary>
-        /// Enabled directory browsing in the current physical directory for all request paths
+        /// Enabled directory browsing all request paths
         /// </summary>
         /// <param name="sharedOptions"></param>
         public DirectoryBrowserOptions(SharedOptions sharedOptions)
diff --git a/src/Microsoft.AspNet.StaticFiles/FileServerExtensions.cs b/src/Microsoft.AspNet.StaticFiles/FileServerExtensions.cs
@@ -38,7 +38,7 @@ public static IApplicationBuilder UseFileServer([NotNull] this IApplicationBuild
         /// Enables all static file middleware (except directory browsing) for the given request path from the directory of the same name
         /// </summary>
         /// <param name="builder"></param>
-        /// <param name="requestPath">The relative request path and physical path.</param>
+        /// <param name="requestPath">The relative request path.</param>
         /// <returns></returns>
         public static IApplicationBuilder UseFileServer([NotNull] this IApplicationBuilder builder, [NotNull] string requestPath)
         {
diff --git a/src/Microsoft.AspNet.StaticFiles/IHostingEnvironment.cs b/src/Microsoft.AspNet.StaticFiles/IHostingEnvironment.cs
diff --git a/src/Microsoft.AspNet.StaticFiles/Infrastructure/SharedOptions.cs b/src/Microsoft.AspNet.StaticFiles/Infrastructure/SharedOptions.cs
@@ -15,7 +15,7 @@ public class SharedOptions
         private PathString _requestPath;
 
         /// <summary>
-        /// Defaults to all request paths and the current physical directory.
+        /// Defaults to all request paths.
         /// </summary>
         public SharedOptions()
         {
diff --git a/src/Microsoft.AspNet.StaticFiles/Infrastructure/SharedOptionsBase.cs b/src/Microsoft.AspNet.StaticFiles/Infrastructure/SharedOptionsBase.cs
@@ -3,6 +3,7 @@
 
 using System;
 using Microsoft.AspNet.FileSystems;
+using Microsoft.AspNet.Hosting;
 using Microsoft.AspNet.Http;
 
 namespace Microsoft.AspNet.StaticFiles.Infrastructure
@@ -49,5 +50,17 @@ public IFileSystem FileSystem
             get { return SharedOptions.FileSystem; }
             set { SharedOptions.FileSystem = value; }
         }
+
+        internal void ResolveFileSystem(IHostingEnvironment hostingEnv)
+        {
+            if (FileSystem == null)
+            {
+                FileSystem = hostingEnv.WebRootFileSystem;
+                if (FileSystem == null)
+                {
+                    throw new InvalidOperationException("Missing FileSystem.");
+                }
+            }
+        }
     }
 }
diff --git a/src/Microsoft.AspNet.StaticFiles/StaticFileExtensions.cs b/src/Microsoft.AspNet.StaticFiles/StaticFileExtensions.cs
@@ -12,7 +12,7 @@ namespace Microsoft.AspNet.Builder
     public static class StaticFileExtensions
     {
         /// <summary>
-        /// Enables static file serving for the current request path from the current directory
+        /// Enables static file serving for the current request path
         /// </summary>
         /// <param name="builder"></param>
         /// <returns></returns>
@@ -22,10 +22,10 @@ public static IApplicationBuilder UseStaticFiles([NotNull] this IApplicationBuil
         }
 
         /// <summary>
-        /// Enables static file serving for the given request path from the directory of the same name
+        /// Enables static file serving for the given request path
         /// </summary>
         /// <param name="builder"></param>
-        /// <param name="requestPath">The relative request path and physical path.</param>
+        /// <param name="requestPath">The relative request path.</param>
         /// <returns></returns>
         public static IApplicationBuilder UseStaticFiles([NotNull] this IApplicationBuilder builder, [NotNull] string requestPath)
         {
diff --git a/src/Microsoft.AspNet.StaticFiles/StaticFileMiddleware.cs b/src/Microsoft.AspNet.StaticFiles/StaticFileMiddleware.cs
@@ -30,10 +30,7 @@ public StaticFileMiddleware([NotNull] RequestDelegate next, [NotNull] IHostingEn
             {
                 throw new ArgumentException(Resources.Args_NoContentTypeProvider);
             }
-            if (options.FileSystem == null)
-            {
-                options.FileSystem = new PhysicalFileSystem(Helpers.ResolveRootPath(hostingEnv.WebRoot, options.RequestPath));
-            }
+            options.ResolveFileSystem(hostingEnv);
 
             _next = next;
             _options = options;
diff --git a/src/Microsoft.AspNet.StaticFiles/StaticFileOptions.cs b/src/Microsoft.AspNet.StaticFiles/StaticFileOptions.cs
@@ -12,14 +12,14 @@ namespace Microsoft.AspNet.StaticFiles
     public class StaticFileOptions : SharedOptionsBase<StaticFileOptions>
     {
         /// <summary>
-        /// Defaults to all request paths in the current physical directory
+        /// Defaults to all request paths
         /// </summary>
         public StaticFileOptions() : this(new SharedOptions())
         {
         }
 
         /// <summary>
-        /// Defaults to all request paths in the current physical directory
+        /// Defaults to all request paths
         /// </summary>
         /// <param name="sharedOptions"></param>
         public StaticFileOptions(SharedOptions sharedOptions) : base(sharedOptions)
diff --git a/src/Microsoft.AspNet.StaticFiles/project.json b/src/Microsoft.AspNet.StaticFiles/project.json
@@ -2,7 +2,8 @@
     "version": "1.0.0-*",
     "description": "ASP.NET 5 static files middleware.",
     "dependencies": {
-        "Microsoft.AspNet.FileSystems": "1.0.0-*",
+        "Microsoft.AspNet.FileSystems.Interfaces": { "version": "1.0.0-*", "type": "build" },
+        "Microsoft.AspNet.Hosting": { "version": "1.0.0-*", "type": "build" },
         "Microsoft.AspNet.Http": "1.0.0-*",
         "Microsoft.AspNet.Http.Extensions": "1.0.0-*",
         "Microsoft.AspNet.HttpFeature": { "version": "1.0.0-*", "type": "build" }
diff --git a/test/Microsoft.AspNet.StaticFiles.Tests/StaticFileMiddlewareTests.cs b/test/Microsoft.AspNet.StaticFiles.Tests/StaticFileMiddlewareTests.cs
@@ -30,12 +30,6 @@ public async Task NullArguments()
             Assert.Equal(HttpStatusCode.NotFound, response.StatusCode);
         }
 
-        [Fact]
-        public void GivenDirDoesntExist_Throw()
-        {
-            Assert.Throws<TargetInvocationException>(() => TestServer.Create(app => app.UseStaticFiles("/ThisDirDoesntExist")));
-        }
-
         [Theory]
         [InlineData("", @".", "/missing.file")]
         [InlineData("/subdir", @".", "/subdir/missing.file")]

Original file line number	Diff line number	Diff line change
`@@ -6,12 +6,11 @@ namespace StaticFilesSample`
`6`	`6`	`{`
`7`	`7`	`public class Startup`
`8`	`8`	`{`
`9`		`- public void Configuration(IApplicationBuilder app)`
	`9`	`+ public void Configure(IApplicationBuilder app)`
`10`	`10`	`{`
`11`	`11`	`app.UseFileServer(new FileServerOptions()`
`12`	`12`	`{`
`13`	`13`	`EnableDirectoryBrowsing = true,`
`14`		`- FileSystem = new PhysicalFileSystem(@"c:\temp")`
`15`	`14`	`});`
`16`	`15`	`}`
`17`	`16`	`}`
Original file line number	Diff line number	Diff line change
`@@ -31,10 +31,7 @@ public DirectoryBrowserMiddleware([NotNull] RequestDelegate next, [NotNull] IHos`
`31`	`31`	`{`
`32`	`32`	`throw new ArgumentException(Resources.Args_NoFormatter);`
`33`	`33`	`}`
`34`		`- if (options.FileSystem == null)`
`35`		`- {`
`36`		`- options.FileSystem = new PhysicalFileSystem(Helpers.ResolveRootPath(hostingEnv.WebRoot, options.RequestPath));`
`37`		`- }`
	`34`	`+ options.ResolveFileSystem(hostingEnv);`
`38`	`35`
`39`	`36`	`_next = next;`
`40`	`37`	`_options = options;`
Original file line number	Diff line number	Diff line change
`@@ -11,15 +11,15 @@ namespace Microsoft.AspNet.StaticFiles`
`11`	`11`	`public class DirectoryBrowserOptions : SharedOptionsBase<DirectoryBrowserOptions>`
`12`	`12`	`{`
`13`	`13`	`/// <summary>`
`14`		`- /// Enabled directory browsing in the current physical directory for all request paths`
	`14`	`+ /// Enabled directory browsing for all request paths`
`15`	`15`	`/// </summary>`
`16`	`16`	`public DirectoryBrowserOptions()`
`17`	`17`	`: this(new SharedOptions())`
`18`	`18`	`{`
`19`	`19`	`}`
`20`	`20`
`21`	`21`	`/// <summary>`
`22`		`- /// Enabled directory browsing in the current physical directory for all request paths`
	`22`	`+ /// Enabled directory browsing all request paths`
`23`	`23`	`/// </summary>`
`24`	`24`	`/// <param name="sharedOptions"></param>`
`25`	`25`	`public DirectoryBrowserOptions(SharedOptions sharedOptions)`
Original file line number	Diff line number	Diff line change
`@@ -38,7 +38,7 @@ public static IApplicationBuilder UseFileServer([NotNull] this IApplicationBuild`
`38`	`38`	`/// Enables all static file middleware (except directory browsing) for the given request path from the directory of the same name`
`39`	`39`	`/// </summary>`
`40`	`40`	`/// <param name="builder"></param>`
`41`		`- /// <param name="requestPath">The relative request path and physical path.</param>`
	`41`	`+ /// <param name="requestPath">The relative request path.</param>`
`42`	`42`	`/// <returns></returns>`
`43`	`43`	`public static IApplicationBuilder UseFileServer([NotNull] this IApplicationBuilder builder, [NotNull] string requestPath)`
`44`	`44`	`{`