rock-n-code/colibri
1
0
Fork 0
Code Issues Pull Requests Actions Releases 3 Activity

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

Browse Source 
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>
This commit was merged in pull request #11.
This commit is contained in:
Javier Cicchelli
2025-02-22 00:33:52 +00:00
committed by Javier Cicchelli
parent 888d00c1e8
commit f8a14e46ed
15 changed files with 181 additions and 81 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Test/Sources/Cases/Internal/Enumerations/FileTests.swift
+4
View File
@@ -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
+32
View File
@@ -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
+63
View File
@@ -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
-42
View File
@@ -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)
}
}
}