Improved the Build subcommand to support the building of Docker images (#11)

This PR contains the work done to support the building of Docker images in the `Build` subcommand in the executable target. So, for this purpose, the following task have been done:

- added a basic boilerplate of the `docker-compose.yml` file;
- fixed some issues found in the boilerplate of the `Dockerfile` file;
- defined the `Randomable` protocol;
- defined the `Artifact` enumeration;
- updated the `BuildProjectTask` task to support building Docker images if required;
- renamed the `BuildProjectTask` task as `BuildArtifactTask`.

Reviewed-on: #11
Co-authored-by: Javier Cicchelli <javier@rock-n-code.com>
Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>

Executable/Sources/Commands/BuildCommand.swift

@@ -20,9 +20,9 @@ extension Colibri {
         mutating func run() async throws {
             let terminalService = TerminalService()
 
-            let buildProject = BuildProjectTask(terminalService: terminalService)
+            let buildArtifact = BuildArtifactTask(terminalService: terminalService)
             
-            try await buildProject(at: options.locationURL)
+            try await buildArtifact(options.artifact, at: options.locationURL)
         }
 
     }

Executable/Sources/Definitions/Conformances.swift

@@ -3,4 +3,5 @@ import ColibriLibrary
 
 // MARK: - ExpressibleByArgument
 
+extension Artifact: ExpressibleByArgument {}
 extension IDE: ExpressibleByArgument {}

Executable/Sources/Options/BuildOptions.swift

@@ -6,6 +6,9 @@ extension Colibri.Build {
         
         // MARK: Properties
         
+        @Option(name: .shortAndLong)
+        var artifact: Artifact = .executable
+        
         @Option(name: .shortAndLong)
         var location: String?
 

Library/Resources/Files/Sources/DockerCompose

@@ -0,0 +1,7 @@
+services:
+  app:
+    build:
+      context: .
+    port:
+      - 3000:8080
+    command: ["--hostname", "0.0.0.0", "--port", "8080"]

Library/Resources/Files/Sources/DockerFile

@@ -1,7 +1,7 @@
 # ================================
 # Build image
 # ================================
-FROM swift:6.0-noble as build
+FROM swift:6.0.3-noble AS build
 
 # Install OS updates
 RUN export DEBIAN_FRONTEND=noninteractive DEBCONF_NONINTERACTIVE_SEEN=true \
@@ -83,5 +83,5 @@ USER hummingbird:hummingbird
 EXPOSE 8080
 
 # Start the Hummingbird service when the image is run, default to listening on 8080 in production environment
-ENTRYPOINT ["./App]
+ENTRYPOINT ["./App"]
 CMD ["--hostname", "0.0.0.0", "--port", "8080"]

Library/Sources/Internal/Enumerations/File.swift

@@ -2,6 +2,7 @@ enum File: String {
     case appArguments = "AppArguments"
     case appBuilder = "AppBuilder"
     case appOptions = "AppOptions"
+    case dockerCompose = "DockerCompose"
     case dockerFile = "DockerFile"
     case dockerIgnore = "DockerIgnore"
     case environment = "Environment"
@@ -24,6 +25,7 @@ extension File {
         case .appArguments: "AppArguments.swift"
         case .appBuilder: "AppBuilder.swift"
         case .appOptions: "AppOptions.swift"
+        case .dockerCompose: "docker-compose.yml"
         case .dockerFile: "Dockerfile"
         case .dockerIgnore: ".dockerignore"
         case .environment: "Environment+Properties.swift"

Library/Sources/Internal/Protocols/Randomable.swift

@@ -0,0 +1,7 @@
+protocol Randomable: CaseIterable {
+    
+    // MARK: Functions
+    
+    static func random() -> Self
+    
+}

Library/Sources/Public/Enumerations/Artifact.swift

@@ -0,0 +1,16 @@
+public enum Artifact: String {
+    case executable
+    case image
+}
+
+// MARK: - Randomable
+
+extension Artifact: Randomable {
+    
+    // MARK: Functions
+    
+    static func random() -> Artifact {
+        .allCases.randomElement() ?? .executable
+    }
+    
+}

Library/Sources/Public/Enumerations/IDE.swift

@@ -3,9 +3,9 @@ public enum IDE: String {
     case xcode
 }
 
-// MARK: - Extension
+// MARK: - Randomable
 
-extension IDE {
+extension IDE: Randomable {
     
     // MARK: Functions
     
@@ -14,7 +14,3 @@ extension IDE {
     }
     
 }
-
-// MARK: - CaseIterable
-
-extension IDE: CaseIterable {}

Library/Sources/Public/Tasks/BuildArtifactTask.swift

@@ -0,0 +1,40 @@
+import Foundation
+
+public struct BuildArtifactTask {
+    
+    // MARK: Properties
+    
+    private let terminalService: TerminalServicing
+    
+    // MARK: Initialisers
+    
+    public init(terminalService: TerminalServicing) {
+        self.terminalService = terminalService
+    }
+    
+    // MARK: Functions
+    
+    public func callAsFunction(_ artifact: Artifact, at location: URL? = nil) async throws (TerminalServiceError) {
+        let executableURL: URL = switch artifact {
+        case .executable: .init(at: "/usr/bin/swift")
+        case .image: .init(at: "/usr/local/bin/docker")
+        }
+
+        var arguments: [String] = switch artifact {
+        case .executable: ["build"]
+        case .image: ["compose", "build"]
+        }
+
+        if let location {
+            if case .executable = artifact {
+                arguments.append(contentsOf: ["--package-path", location.pathString])
+            } else if case .image = artifact {
+                arguments.insert(contentsOf: ["--project-directory", location.pathString], at: 1)
+            }
+        }
+        
+        try await terminalService.run(executableURL, arguments: arguments)
+    }
+    
+}
+

Library/Sources/Public/Tasks/BuildProjectTask.swift

@@ -1,29 +0,0 @@
-import Foundation
-
-public struct BuildProjectTask {
-    
-    // MARK: Properties
-    
-    private let terminalService: TerminalServicing
-    
-    // MARK: Initialisers
-    
-    public init(terminalService: TerminalServicing) {
-        self.terminalService = terminalService
-    }
-    
-    // MARK: Functions
-    
-    public func callAsFunction(at location: URL? = nil) async throws (TerminalServiceError) {
-        let executableURL = URL(at: "/usr/bin/swift")
-
-        var arguments: [String] = ["build"]
-        
-        if let location {
-            arguments.append(contentsOf: ["--package-path", location.pathString])
-        }
-        
-        try await terminalService.run(executableURL, arguments: arguments)
-    }
-    
-}

Test/Sources/Cases/Internal/Enumerations/FileTests.swift

@@ -56,6 +56,7 @@ private extension FileTests {
             "AppArguments.swift",
             "AppBuilder.swift",
             "AppOptions.swift",
+            "docker-compose.yml",
             "Dockerfile",
             ".dockerignore",
             "Environment+Properties.swift",
@@ -70,6 +71,7 @@ private extension FileTests {
             "Library/Sources/Public/AppArguments.swift",
             "Library/Sources/Public/AppBuilder.swift",
             "App/Sources/AppOptions.swift",
+            "docker-compose.yml",
             "Dockerfile",
             ".dockerignore",
             "Library/Sources/Internal/Environment+Properties.swift",
@@ -86,6 +88,7 @@ private extension FileTests {
             .app,
             .root,
             .root,
+            .root,
             .libraryInternal,
             .root,
             .root,
@@ -100,6 +103,7 @@ private extension FileTests {
             "Resources/Files/Sources/App",
             "Resources/Files/Sources",
             "Resources/Files/Sources",
+            "Resources/Files/Sources",
             "Resources/Files/Sources/Library",
             "Resources/Files/Sources",
             "Resources/Files/Sources",

Test/Sources/Cases/Internal/Protocols/RandomableTests.swift

@@ -0,0 +1,32 @@
+import Testing
+
+@testable import ColibriLibrary
+
+struct RandomableTest {
+
+    @Test func random() {
+        // GIVEN
+        let allCases = TestRandomable.allCases
+
+        // WHEN
+        let random = TestRandomable.random()
+        
+        // THEN
+        #expect(allCases.contains(random))
+    }
+
+}
+
+// MARK: - Enumerations
+
+enum TestRandomable: Randomable {
+    case someCase
+    case someOtherCase
+
+    // MARK: Functions
+    
+    static func random() -> TestRandomable {
+        .allCases.randomElement() ?? .someCase
+    }
+    
+}

Test/Sources/Cases/Public/Tasks/BuildArtifactTaskTests.swift

@@ -0,0 +1,63 @@
+import Foundation
+import Testing
+
+@testable import ColibriLibrary
+
+struct BuildArtifactTaskTests {
+
+    @Test(arguments: [nil, URL.someCurrentFolder])
+    func taskForExecutable(at location: URL?) async throws {
+        // GIVEN
+        let terminalService = TerminalServiceSpy()
+        let task = BuildArtifactTask(terminalService: terminalService)
+
+        // WHEN
+        try await task(.executable, at: location)
+
+        // THEN
+        let executableURL = URL(at: "/usr/bin/swift")
+        let arguments = if let location {
+            ["build", "--package-path", location.pathString]
+        } else {
+            ["build"]
+        }
+        
+        #expect(terminalService.actions.count == 1)
+        #expect(terminalService.actions[0] == .ran(executableURL, arguments))
+    }
+    
+    @Test(arguments: [nil, URL.someCurrentFolder])
+    func taskForImage(at location: URL?) async throws {
+        // GIVEN
+        let terminalService = TerminalServiceSpy()
+        let task = BuildArtifactTask(terminalService: terminalService)
+        
+        // WHEN
+        try await task(.image, at: location)
+        
+        // THEN
+        let executableURL = URL(at: "/usr/local/bin/docker")
+        let arguments = if let location {
+            ["compose", "--project-directory", location.pathString, "build"]
+        } else {
+            ["compose", "build"]
+        }
+        
+        #expect(terminalService.actions.count == 1)
+        #expect(terminalService.actions[0] == .ran(executableURL, arguments))
+    }
+    
+    @Test(arguments: [nil, URL.someCurrentFolder], [TerminalServiceError.unexpected, .output(""), .captured("")])
+    func taskForArtifact(at location: URL?, throws error: TerminalServiceError) async throws {
+        // GIVEN
+        let terminalService = TerminalServiceMock(action: .error(error))
+        let task = BuildArtifactTask(terminalService: terminalService)
+
+        // WHEN
+        // THEN
+        await #expect(throws: error) {
+            try await task(.random(), at: location)
+        }
+    }
+
+}

Test/Sources/Cases/Public/Tasks/BuildProjectTaskTests.swift

@@ -1,42 +0,0 @@
-import Foundation
-import Testing
-
-@testable import ColibriLibrary
-
-struct BuildProjectTaskTests {
-
-    @Test(arguments: [nil, URL.someCurrentFolder])
-    func task(at location: URL?) async throws {
-        // GIVEN
-        let terminalService = TerminalServiceSpy()
-        let task = BuildProjectTask(terminalService: terminalService)
-
-        // WHEN
-        try await task(at: location)
-
-        // THEN
-        let executableURL = URL(at: "/usr/bin/swift")
-        let arguments = if let location {
-            ["build", "--package-path", location.pathString]
-        } else {
-            ["build"]
-        }
-        
-        #expect(terminalService.actions.count == 1)
-        #expect(terminalService.actions[0] == .ran(executableURL, arguments))
-    }
-    
-    @Test(arguments: [nil, URL.someCurrentFolder], [TerminalServiceError.unexpected, .output(""), .captured("")])
-    func task(at location: URL?, throws error: TerminalServiceError) async throws {
-        // GIVEN
-        let terminalService = TerminalServiceMock(action: .error(error))
-        let task = BuildProjectTask(terminalService: terminalService)
-
-        // WHEN
-        // THEN
-        await #expect(throws: error) {
-            try await task(at: location)
-        }
-    }
-
-}