javier
f5f14eb97c
This PR contains the work done to add a `NotFoundMiddleware` middleware to the Website service so requests matching neither a route nor a static file return a custom 404.html page with a 404 Not Found status. Also enables index.html fallback so the landing page is served at the site root. To provider further details about the work done: * NotFoundMiddleware — intercepts the `.notFound` error from the `FileMiddleware` middleware and serves the preloaded error page with the correct content type; all other errors propagate. Falls back to a minimal body if the file is missing. * Router — wires the `NotFoundMiddleware` middleware ahead of the `FileMiddleware` and enables searchForIndexHtml. * Package — adds the **Hummingbird** product to the Library target. * Tooling — sets a custom working directory in the Xcode scheme; removes the unused `pkg-deps` target from the `Makefile` file. Reviewed-on: rock-n-code/loud-amsterdam#4 Co-authored-by: Javier Cicchelli <javier@rock-n-code.com> Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
125 lines
3.4 KiB
Swift
125 lines
3.4 KiB
Swift
import Configuration
|
|
import Foundation
|
|
import Hummingbird
|
|
import HummingbirdTesting
|
|
import Logging
|
|
import NIOCore
|
|
import Testing
|
|
|
|
@testable import Website
|
|
@testable import WebsiteCore
|
|
|
|
@Suite("App executable")
|
|
struct AppTests {
|
|
|
|
// MARK: Constants
|
|
|
|
// Absolute path to the package's "Resources/Static" folder, derived from this
|
|
// file's location so the static files resolve regardless of the working directory.
|
|
private let staticFilesPath = URL(fileURLWithPath: #filePath)
|
|
.deletingLastPathComponent() // Tests/App
|
|
.deletingLastPathComponent() // Tests
|
|
.deletingLastPathComponent() // package root
|
|
.appendingPathComponent(.Path.staticResources)
|
|
.path
|
|
|
|
// MARK: Functional tests
|
|
|
|
@Test
|
|
func `landing page to be served at root`() async throws {
|
|
let file: StaticFile = .indexHTML
|
|
let app = try await application(
|
|
reader: reader(
|
|
staticFilesPath: staticFilesPath
|
|
)
|
|
)
|
|
|
|
try await app.test(.router) { client in
|
|
try await client.execute(
|
|
uri: "/",
|
|
method: .get
|
|
) { response in
|
|
#expect(response.status == .ok)
|
|
#expect(response.headers[.contentType] == file.contentType)
|
|
#expect(response.body == data(of: file))
|
|
}
|
|
}
|
|
}
|
|
|
|
@Test(arguments: StaticFile.allCases)
|
|
func `static files to be served`(
|
|
staticFile file: StaticFile
|
|
) async throws {
|
|
let app = try await application(
|
|
reader: reader(
|
|
staticFilesPath: staticFilesPath
|
|
)
|
|
)
|
|
|
|
try await app.test(.router) { client in
|
|
try await client.execute(
|
|
uri: "/\(file.relativePath)",
|
|
method: .get
|
|
) { response in
|
|
#expect(response.status == .ok)
|
|
#expect(response.headers[.contentType] == file.contentType)
|
|
}
|
|
}
|
|
}
|
|
|
|
@Test
|
|
func `error page to be served when not found`() async throws {
|
|
let file: StaticFile = .errorHTML
|
|
let app = try await application(
|
|
reader: reader(
|
|
staticFilesPath: staticFilesPath
|
|
)
|
|
)
|
|
|
|
try await app.test(.router) { client in
|
|
try await client.execute(
|
|
uri: "/this-path-does-not-exist",
|
|
method: .get
|
|
) { response in
|
|
#expect(response.status == .notFound)
|
|
#expect(response.headers[.contentType] == file.contentType)
|
|
#expect(response.body == data(of: file))
|
|
}
|
|
}
|
|
}
|
|
|
|
}
|
|
|
|
// MARK: - Helpers
|
|
|
|
private extension AppTests {
|
|
|
|
// MARK: Methods
|
|
|
|
func data(
|
|
of file: StaticFile
|
|
) -> ByteBuffer {
|
|
let url = URL(fileURLWithPath: file.path(relativeTo: staticFilesPath))
|
|
|
|
guard let data = try? Data(contentsOf: url) else {
|
|
return ByteBuffer()
|
|
}
|
|
|
|
return ByteBuffer(bytes: data)
|
|
}
|
|
|
|
func reader(
|
|
staticFilesPath: String
|
|
) -> ConfigReader {
|
|
ConfigReader(providers: [
|
|
InMemoryProvider(values: [
|
|
.HTTP.host: .HTTP.host,
|
|
.HTTP.port: .HTTP.port,
|
|
.Log.level: .Log.level,
|
|
.Path.staticFiles: .init(stringLiteral: staticFilesPath),
|
|
])
|
|
])
|
|
}
|
|
|
|
}
|