javier
dc6b22e648
This PR contains the work done to introduce a _Fluent_-based persistence layer for the Website service, selectable at runtime alongside the existing in-memory default, plus the local dev tooling and docs to support it. To provide further details about the work: * Persistence package * The `Driver` and `TLS` enumerations * The `Configuration` type * The `Service` factory that builds the service * `PrepareDB` for migrations registration * The `Probe` for readiness checks. * App integration * Builds the driver, registers migrations, and attaches `Fluent` to the service lifecycle so it starts/stops with the HTTP server. * Migrate-on-boot is gated to the in-memory backend; MySQL/MariaDB is migrated out of band via --database-migrate so shared databases never race on startup. * The `ConfigReader+Properties` extension maps database.* config keys onto the driver. * Library * Added database configuration constants. * The `HealthController` controller gains a readiness probe: `GET /health/ready` checks whether the database is reachable, separate from the existing liveness check. * Others * Updated the `docker-compose` files to support a database service behind a database profile, and hardened for local development * New database targets on the `Makefile` file and overall documentation updated * Updated the `.env.local`, `Dockerfile`, and `README` files to document the persistence workflow, config keys, and local DB commands Reviewed-on: rock-n-code/loud-amsterdam#13 Co-authored-by: Javier Cicchelli <javier@rock-n-code.com> Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
262 lines
8.6 KiB
Swift
262 lines
8.6 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
|
|
|
|
private let textExtensions: [StaticFile.Extension] = [
|
|
.css,
|
|
.js,
|
|
.txt
|
|
]
|
|
|
|
// 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 {
|
|
try await app(
|
|
staticFilesPath: staticFilesPath
|
|
).test(.router) { client in
|
|
try await client.execute(
|
|
uri: "/",
|
|
method: .get
|
|
) { response in
|
|
let body = String(buffer: response.body)
|
|
|
|
#expect(response.status == .ok)
|
|
#expect(response.headers[.contentType] == "text/html; charset=utf-8")
|
|
#expect(body.contains("Hello world!"))
|
|
}
|
|
}
|
|
}
|
|
|
|
@Test
|
|
func `health check to be served at the health path`() async throws {
|
|
try await app(
|
|
staticFilesPath: staticFilesPath
|
|
).test(.router) { client in
|
|
try await client.execute(
|
|
uri: "/health",
|
|
method: .get
|
|
) { response in
|
|
let body = String(buffer: response.body)
|
|
|
|
#expect(response.status == .ok)
|
|
#expect(response.headers[.contentType] == "application/json")
|
|
#expect(body == #"{"status":"ok"}"#)
|
|
}
|
|
}
|
|
}
|
|
|
|
@Test
|
|
func `readiness check to be served at the readiness path`() async throws {
|
|
// Live mode runs the application's service group, so the `Fluent` service starts before the
|
|
// request and shuts its connection pool down after — the router-only mode never would.
|
|
try await app(
|
|
staticFilesPath: staticFilesPath
|
|
).test(.live) { client in
|
|
try await client.execute(
|
|
uri: "/health/ready",
|
|
method: .get
|
|
) { response in
|
|
let body = String(buffer: response.body)
|
|
|
|
#expect(response.status == .ok)
|
|
#expect(response.headers[.contentType] == "application/json")
|
|
#expect(body == #"{"status":"ready"}"#)
|
|
}
|
|
}
|
|
}
|
|
|
|
@Test(arguments: StaticFile.allCases)
|
|
func `static files to be served`(
|
|
staticFile file: StaticFile
|
|
) async throws {
|
|
try await app(
|
|
staticFilesPath: staticFilesPath
|
|
).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)
|
|
|
|
let cacheControl = try #require(response.headers[.cacheControl])
|
|
|
|
#expect(cacheControl.contains("public") == true)
|
|
#expect(cacheControl.contains("max-age=") == true)
|
|
|
|
if textExtensions.contains(file.fileExtension) {
|
|
#expect(cacheControl.contains("must-revalidate") == true)
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
@Test
|
|
func `response to be compressed when the client supports it`() async throws {
|
|
try await app(
|
|
staticFilesPath: staticFilesPath
|
|
).test(.router) { client in
|
|
try await client.execute(
|
|
uri: "/",
|
|
method: .get,
|
|
headers: [.acceptEncoding: "gzip"]
|
|
) { response in
|
|
#expect(response.status == .ok)
|
|
#expect(response.headers[.contentEncoding] == "gzip")
|
|
}
|
|
}
|
|
}
|
|
|
|
@Test
|
|
func `response to not be compressed when the client does not support it`() async throws {
|
|
try await app(
|
|
staticFilesPath: staticFilesPath
|
|
).test(.router) { client in
|
|
try await client.execute(
|
|
uri: "/",
|
|
method: .get
|
|
) { response in
|
|
#expect(response.status == .ok)
|
|
#expect(response.headers[.contentEncoding] == nil)
|
|
}
|
|
}
|
|
}
|
|
|
|
@Test
|
|
func `error page to be served when not found`() async throws {
|
|
try await app(
|
|
staticFilesPath: staticFilesPath
|
|
).test(.router) { client in
|
|
try await client.execute(
|
|
uri: "/this-path-does-not-exist",
|
|
method: .get
|
|
) { response in
|
|
let body = String(buffer: response.body)
|
|
|
|
#expect(response.status == .notFound)
|
|
#expect(response.headers[.contentType] == "text/html; charset=utf-8")
|
|
#expect(body.contains("Page Not Found"))
|
|
}
|
|
}
|
|
}
|
|
|
|
@Test
|
|
func `security headers to be applied to the landing page`() async throws {
|
|
try await app(
|
|
staticFilesPath: staticFilesPath
|
|
).test(.router) { client in
|
|
try await client.execute(
|
|
uri: "/",
|
|
method: .get
|
|
) { response in
|
|
#expect(response.status == .ok)
|
|
#expect(response.headers[.contentSecurityPolicy] == String.Security.contentSecurityPolicy)
|
|
#expect(response.headers[.xContentTypeOptions] == String.Security.contentTypeOptions)
|
|
#expect(response.headers[.frameOptions] == String.Security.frameOptions)
|
|
#expect(response.headers[.referrerPolicy] == String.Security.referrerPolicy)
|
|
#expect(response.headers[.permissionsPolicy] == String.Security.permissionsPolicy)
|
|
#expect(response.headers[.strictTransportSecurity] == nil)
|
|
}
|
|
}
|
|
}
|
|
|
|
@Test
|
|
func `security headers to be applied to the error page`() async throws {
|
|
try await app(
|
|
staticFilesPath: staticFilesPath
|
|
).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[.contentSecurityPolicy] == String.Security.contentSecurityPolicy)
|
|
#expect(response.headers[.xContentTypeOptions] == String.Security.contentTypeOptions)
|
|
}
|
|
}
|
|
}
|
|
|
|
@Test
|
|
func `strict-transport-security to be applied when configured`() async throws {
|
|
try await app(
|
|
staticFilesPath: staticFilesPath,
|
|
strictTransportSecurity: "max-age=31536000; includeSubDomains"
|
|
).test(.router) { client in
|
|
try await client.execute(
|
|
uri: "/",
|
|
method: .get
|
|
) { response in
|
|
#expect(response.status == .ok)
|
|
#expect(response.headers[.strictTransportSecurity] == "max-age=31536000; includeSubDomains")
|
|
}
|
|
}
|
|
}
|
|
|
|
}
|
|
|
|
// MARK: - Helpers
|
|
|
|
private extension AppTests {
|
|
|
|
// MARK: Methods
|
|
|
|
func app(
|
|
staticFilesPath: String,
|
|
strictTransportSecurity: String? = nil
|
|
) async -> some ApplicationProtocol {
|
|
await application(
|
|
reader: reader(
|
|
staticFilesPath: staticFilesPath,
|
|
strictTransportSecurity: strictTransportSecurity
|
|
)
|
|
)
|
|
}
|
|
|
|
func reader(
|
|
staticFilesPath: String,
|
|
strictTransportSecurity: String? = nil
|
|
) -> ConfigReader {
|
|
ConfigReader(providers: [{
|
|
if let strictTransportSecurity {
|
|
InMemoryProvider(values: [
|
|
.HTTP.host: "127.0.0.1",
|
|
.HTTP.port: "0",
|
|
.Log.level: "trace",
|
|
.Path.staticFiles: .init(stringLiteral: staticFilesPath),
|
|
.Security.strictTransportSecurity: .init(stringLiteral: strictTransportSecurity)
|
|
])
|
|
} else {
|
|
InMemoryProvider(values: [
|
|
.HTTP.host: "127.0.0.1",
|
|
.HTTP.port: "0",
|
|
.Log.level: "trace",
|
|
.Path.staticFiles: .init(stringLiteral: staticFilesPath),
|
|
])
|
|
}
|
|
}()])
|
|
}
|
|
|
|
}
|