Log error in StaticFIleServer init if passed a non-directory path

Sources/Kitura/staticFileServer/StaticFileServer.swift

@@ -15,6 +15,7 @@
  */
 
 import Foundation
+import LoggerAPI
 
 // MARK: StaticFileServer
 
@@ -101,9 +102,25 @@ open class StaticFileServer: RouterMiddleware {
     /// - Parameter customResponseHeadersSetter: an object of a class that
     /// implements `ResponseHeadersSetter` protocol providing a custom method to set
     /// the headers of the response.
-    public init(path: String = "./public", options: Options = Options(),
+    public init?(path: String = "./public", options: Options = Options(),
                  customResponseHeadersSetter: ResponseHeadersSetter? = nil) {
-        absoluteRootPath = StaticFileServer.ResourcePathHandler.getAbsolutePath(for: path)
+        let rootPathAbsolute = StaticFileServer.ResourcePathHandler.getAbsolutePath(for: path)
+        absoluteRootPath = rootPathAbsolute
+        // Check the supplied path is a directory and if not fail initialisation
+        var isDirectory = ObjCBool(false)
+
+        let pathExists = FileManager.default.fileExists(atPath: absoluteRootPath, isDirectory: &isDirectory)
+        #if !os(Linux) || swift(>=4.1)
+        let isDirectoryBool = isDirectory.boolValue
+        #else
+        let isDirectoryBool = isDirectory
+        #endif
+        if !pathExists {
+            Log.warning("StaticFileServer being initialised with invalid path: \(rootPathAbsolute)")
+        } else if !isDirectoryBool {
+            Log.error("StaticFileServer cannot be intialised with a file")
+            return nil
+        }
 
         let cacheOptions = options.cacheOptions
         let cacheRelatedHeadersSetter =

Tests/KituraTests/TestStaticFileServer.swift

@@ -171,28 +171,28 @@ class TestStaticFileServer: KituraTest {
         let router = Router(enableWelcomePage: enableWelcomePage)
 
         // The route below ensures that the static file server does not prevent all routes being walked
-        router.all("/", middleware: StaticFileServer())
+        router.all("/", middleware: StaticFileServer()!)
 
         var cacheOptions = StaticFileServer.CacheOptions(maxAgeCacheControlHeader: 2)
         var options = StaticFileServer.Options(possibleExtensions: ["exe", "html"], cacheOptions: cacheOptions)
-        router.all("/qwer", middleware: StaticFileServer(path: "./Tests/KituraTests/TestStaticFileServer/", options:options, customResponseHeadersSetter: HeaderSetter()))
+        router.all("/qwer", middleware: StaticFileServer(path: "./Tests/KituraTests/TestStaticFileServer/", options:options, customResponseHeadersSetter: HeaderSetter())!)
 
         cacheOptions = StaticFileServer.CacheOptions(addLastModifiedHeader: false, generateETag: false)
         options = StaticFileServer.Options(serveIndexForDirectory: false, cacheOptions: cacheOptions)
-        router.all("/zxcv", middleware: StaticFileServer(path: "./Tests/KituraTests/TestStaticFileServer/", options:options))
+        router.all("/zxcv", middleware: StaticFileServer(path: "./Tests/KituraTests/TestStaticFileServer/", options:options)!)
 
         options = StaticFileServer.Options(redirect: false)
         let directoryURL = URL(fileURLWithPath: #file + "/../TestStaticFileServer").standardizedFileURL
-        router.all("/asdf", middleware: StaticFileServer(path: directoryURL.path, options:options))
+        router.all("/asdf", middleware: StaticFileServer(path: directoryURL.path, options:options)!)
 
         options = StaticFileServer.Options(possibleExtensions: ["exe", "html"], cacheOptions: cacheOptions, acceptRanges: false)
-        router.all("/tyui", middleware: StaticFileServer(path: "./Tests/KituraTests/TestStaticFileServer/", options:options, customResponseHeadersSetter: HeaderSetter()))
+        router.all("/tyui", middleware: StaticFileServer(path: "./Tests/KituraTests/TestStaticFileServer/", options:options, customResponseHeadersSetter: HeaderSetter())!)
 
         options = StaticFileServer.Options(serveIndexForDirectory: true, redirect: true, cacheOptions: cacheOptions)
-        router.route("/ghjk").all(middleware: StaticFileServer(path: "./Tests/KituraTests/TestStaticFileServer/", options: options))
+        router.route("/ghjk").all(middleware: StaticFileServer(path: "./Tests/KituraTests/TestStaticFileServer/", options: options)!)
 
         options = StaticFileServer.Options(serveIndexForDirectory: true, redirect: true, cacheOptions: cacheOptions)
-        router.route("/opnm/:parameter").all(middleware: StaticFileServer(path: "./Tests/KituraTests/TestStaticFileServer/subfolder", options: options))
+        router.route("/opnm/:parameter").all(middleware: StaticFileServer(path: "./Tests/KituraTests/TestStaticFileServer/subfolder", options: options)!)
 
         return router
     }
@@ -271,7 +271,7 @@ class TestStaticFileServer: KituraTest {
     }
 
     func testAbsoluteRootPath() {
-        XCTAssertEqual(StaticFileServer(path: "/").absoluteRootPath, "/", "Absolute root path did not resolve to system root")
+        XCTAssertEqual(StaticFileServer(path: "/")!.absoluteRootPath, "/", "Absolute root path did not resolve to system root")
     }
 
     let indexHtmlContents = "<!DOCTYPE html><html><body><b>Index</b></body></html>" // contents of index.html
@@ -589,4 +589,14 @@ class TestStaticFileServer: KituraTest {
             expectation.fulfill()
         }
     }
+
+    // Test the StaticFileServer can not be initialised when passed a file path rather than folder.
+    func testRejectFile() {
+        let filePath = #file
+        guard let _ = StaticFileServer(path: filePath) else {
+            return
+        }
+        XCTFail("Static file server initialised for file path")
+        return
+    }
 }