Update hello example to use output from latest template

Author: adam-fowler

hello/.github/workflows/ci.yml

@@ -0,0 +1,26 @@
+name: CI
+
+on:
+  push:
+    branches:
+    - main
+    paths:
+    - '**.swift'
+    - '**.yml'
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  linux:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        image:
+          - 'swift:latest'
+    container:
+      image: ${{ matrix.image }}
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v4
+    - name: Test
+      run: swift test

hello/.gitignore

@@ -1 +1,10 @@
-public/
+.DS_Store
+/.build
+/.swiftpm
+/.devContainer
+/Packages
+/*.xcodeproj
+xcuserdata/
+/.vscode/*
+.env.*
+.env

hello/Dockerfile

@@ -1,7 +1,7 @@
 # ================================
 # Build image
 # ================================
-FROM swift:5.10-jammy as build
+FROM swift:6.1-noble AS build
 
 # Install OS updates
 RUN export DEBIAN_FRONTEND=noninteractive DEBCONF_NONINTERACTIVE_SEEN=true \
@@ -23,8 +23,9 @@ RUN swift package resolve
 # Copy entire repo into container
 COPY . .
 
-# Build everything, with optimizations, with static linking, and using jemalloc
+# Build the application, with optimizations, with static linking, and using jemalloc
 RUN swift build -c release \
+    --product "App" \
     --static-swift-stdlib \
     -Xlinker -ljemalloc
 
@@ -47,20 +48,20 @@ RUN [ -d /build/public ] && { mv /build/public ./public && chmod -R a-w ./public
 # ================================
 # Run image
 # ================================
-FROM ubuntu:jammy
+FROM ubuntu:noble
 
 # Make sure all system packages are up to date, and install only essential packages.
 RUN export DEBIAN_FRONTEND=noninteractive DEBCONF_NONINTERACTIVE_SEEN=true \
     && apt-get -q update \
     && apt-get -q dist-upgrade -y \
     && apt-get -q install -y \
-    libjemalloc2 \
-    ca-certificates \
-    tzdata \
-    # If your app or its dependencies import FoundationNetworking, also install `libcurl4`.
-    # libcurl4 \
-    # If your app or its dependencies import FoundationXML, also install `libxml2`.
-    # libxml2 \
+      libjemalloc2 \
+      ca-certificates \
+      tzdata \
+# If your app or its dependencies import FoundationNetworking, also install `libcurl4`.
+      # libcurl4 \
+# If your app or its dependencies import FoundationXML, also install `libxml2`.
+      # libxml2 \
     && rm -r /var/lib/apt/lists/*
 
 # Create a hummingbird user and group with /app as its home directory

hello/Package.swift

@@ -1,36 +1,32 @@
-// swift-tools-version:5.9
+// swift-tools-version:6.2
+// The swift-tools-version declares the minimum version of Swift required to build this package.
+
 import PackageDescription
 
 let package = Package(
     name: "hello",
-    platforms: [
-        .macOS(.v14),
+    platforms: [.macOS(.v15), .iOS(.v18), .tvOS(.v18)],
+    products: [
+        .executable(name: "App", targets: ["App"]),
     ],
     dependencies: [
         .package(url: "https://github.com/hummingbird-project/hummingbird.git", from: "2.0.0"),
-        .package(url: "https://github.com/apple/swift-argument-parser.git", from: "1.4.0"),
+        .package(url: "https://github.com/apple/swift-configuration.git", from: "1.0.0", traits: [.defaults, "CommandLineArguments"]),
     ],
     targets: [
-        .executableTarget(
-            name: "App",
+        .executableTarget(name: "App",
             dependencies: [
-                .product(name: "ArgumentParser", package: "swift-argument-parser"),
+                .product(name: "Configuration", package: "swift-configuration"),
                 .product(name: "Hummingbird", package: "hummingbird"),
             ],
-            swiftSettings: [
-                // Enable better optimizations when building in Release configuration. Despite the use of
-                // the `.unsafeFlags` construct required by SwiftPM, this flag is recommended for Release
-                // builds. See <https://github.com/swift-server/guides#building-for-production> for details.
-                .unsafeFlags(["-cross-module-optimization"], .when(configuration: .release)),
-            ]
+            path: "Sources/App"
         ),
-        .testTarget(
-            name: "AppTests",
+        .testTarget(name: "AppTests",
             dependencies: [
                 .byName(name: "App"),
-                .product(name: "Hummingbird", package: "hummingbird"),
-                .product(name: "HummingbirdTesting", package: "hummingbird"),
-            ]
-        ),
+                .product(name: "HummingbirdTesting", package: "hummingbird")
+            ],
+            path: "Tests/AppTests"
+        )
     ]
 )

hello/README.md

@@ -1,9 +1,9 @@
 # Hello
 
-This is a simple app that will responds with the word "hello". This example is here just to demonstrate how to start up a server.
+This is a simple app that will responds with the string "Hello!". This example is here just to demonstrate how to start up a server. The example code is exactly the same as the output from the template when you chose all the default options.
 
 You can test the sample as follows
 ```sh
-curl localhost:8080/
+curl -i localhost:8080/
 ```
-It should return a response with status 200 and the body text "Hello".
+It should return a response with status 200 and the body text "Hello!".

hello/Sources/App/App+build.swift

@@ -0,0 +1,38 @@
+import Configuration
+import Hummingbird
+import Logging
+
+// Request context used by application
+typealias AppRequestContext = BasicRequestContext
+
+///  Build application
+/// - Parameter reader: configuration reader
+func buildApplication(reader: ConfigReader) async throws -> some ApplicationProtocol {
+    let logger = {
+        var logger = Logger(label: "hello")
+        logger.logLevel = reader.string(forKey: "log.level", as: Logger.Level.self, default: .info)
+        return logger
+    }()
+    let router = try buildRouter()
+    let app = Application(
+        router: router,
+        configuration: ApplicationConfiguration(reader: reader.scoped(to: "http")),
+        logger: logger
+    )
+    return app
+}
+
+/// Build router
+func buildRouter() throws -> Router<AppRequestContext> {
+    let router = Router(context: AppRequestContext.self)
+    // Add middleware
+    router.addMiddleware {
+        // logging middleware
+        LogRequestsMiddleware(.info)
+    }
+    // Add default endpoint
+    router.get("/") { _,_ in
+        return "Hello!"
+    }
+    return router
+}

hello/Sources/App/Application+build.swift

@@ -1,20 +1,21 @@
-import ArgumentParser
+import Configuration
+import Hummingbird
+import Logging
 
 @main
-struct HummingbirdArguments: AsyncParsableCommand {
-    @Option(name: .shortAndLong)
-    var hostname: String = "127.0.0.1"
-
-    @Option(name: .shortAndLong)
-    var port: Int = 8080
-
-    func run() async throws {
-        let app = buildApplication(
-            configuration: .init(
-                address: .hostname(self.hostname, port: self.port),
-                serverName: "Hummingbird"
-            )
-        )
+struct App {
+    static func main() async throws {
+        // Application will read configuration from the following in the order listed
+        // Command line, Environment variables, dotEnv file, defaults provided in memory 
+        let reader = try await ConfigReader(providers: [
+            CommandLineArgumentsProvider(),
+            EnvironmentVariablesProvider(),
+            EnvironmentVariablesProvider(environmentFilePath: ".env", allowMissing: true),
+            InMemoryProvider(values: [
+                "http.serverName": "hello"
+            ])
+        ])
+        let app = try await buildApplication(reader: reader)
         try await app.runService()
     }
 }

hello/Sources/App/app.swift

@@ -1,15 +1,27 @@
-@testable import App
+import Configuration
 import Hummingbird
 import HummingbirdTesting
-import XCTest
+import Logging
+import Testing
+
+@testable import App
+
+private let reader = ConfigReader(providers: [
+    InMemoryProvider(values: [
+        "host": "127.0.0.1",
+        "port": "0",
+        "log.level": "trace"
+    ])
+])
 
-final class AppTests: XCTestCase {
-    func testApp() async throws {
-        let app = buildApplication(configuration: .init())
+@Suite
+struct AppTests {
+    @Test
+    func app() async throws {
+        let app = try await buildApplication(reader: reader)
         try await app.test(.router) { client in
             try await client.execute(uri: "/", method: .get) { response in
-                XCTAssertEqual(response.status, .ok)
-                XCTAssertEqual(String(buffer: response.body), "Hello")
+                #expect(response.body == ByteBuffer(string: "Hello!"))
             }
         }
     }