Merge pull request #68 from traderepublic/feature/dummy-console-devices

Add dummy console device support

Author: HeEAaD

Cilicon/Config/Config.swift

@@ -13,7 +13,8 @@ struct Config: Codable {
         retryDelay: Int,
         sshCredentials: SSHCredentials,
         preRun: String? = nil,
-        postRun: String? = nil
+        postRun: String? = nil,
+        consoleDevices: [String] = []
     ) {
         self.provisioner = provisioner
         self.hardware = hardware
@@ -26,6 +27,7 @@ struct Config: Codable {
         self.sshCredentials = sshCredentials
         self.preRun = preRun
         self.postRun = postRun
+        self.consoleDevices = consoleDevices
     }
 
     /// Provisioner Configuration.
@@ -52,6 +54,8 @@ struct Config: Codable {
     let preRun: String?
     /// A command to run after the provisioning commands are run.
     let postRun: String?
+    /// A list of console device names that are going to be injected into the VM.
+    let consoleDevices: [String]
 
     enum CodingKeys: CodingKey {
         case provisioner
@@ -65,6 +69,7 @@ struct Config: Codable {
         case sshCredentials
         case preRun
         case postRun
+        case consoleDevices
     }
 
     init(from decoder: Decoder) throws {
@@ -82,6 +87,7 @@ struct Config: Codable {
         self.sshCredentials = try container.decodeIfPresent(SSHCredentials.self, forKey: .sshCredentials) ?? .default
         self.preRun = try container.decodeIfPresent(String.self, forKey: .preRun)
         self.postRun = try container.decodeIfPresent(String.self, forKey: .postRun)
+        self.consoleDevices = try container.decodeIfPresent([String].self, forKey: .consoleDevices) ?? []
     }
 }
 

Cilicon/VMConfigHelper+RunConfig.swift

@@ -24,6 +24,15 @@ extension VMConfigHelper {
             virtualMachineConfiguration.audioDevices = [createAudioDeviceConfiguration()]
         }
         virtualMachineConfiguration.directorySharingDevices = try [createDirectorySharingConfiguration(config: config)]
+
+        for consoleDeviceConfig in config.consoleDevices {
+            let consolePort = VZVirtioConsolePortConfiguration()
+            consolePort.name = consoleDeviceConfig
+            let consoleDevice = VZVirtioConsoleDeviceConfiguration()
+            consoleDevice.ports[0] = consolePort
+            virtualMachineConfiguration.consoleDevices.append(consoleDevice)
+        }
+
         try virtualMachineConfiguration.validate()
 
         return virtualMachineConfiguration

CiliconTests/OCI/Config/ConfigTests.swift

@@ -0,0 +1,50 @@
+import XCTest
+import Yams
+
+@testable import Cilicon
+
+final class ConfigTests: XCTestCase {
+    private var yamlDecoder: YAMLDecoder!
+
+    override func setUp() {
+        yamlDecoder = YAMLDecoder()
+    }
+
+    override func tearDown() {
+        yamlDecoder = nil
+    }
+
+    func test_decode_consoleDevices_notPresent_isEmptyArray() throws {
+        let yaml = fixtureConfig
+        let sut = try yamlDecoder.decode(Config.self, from: Data(yaml.utf8))
+
+        XCTAssertEqual(sut.consoleDevices, [])
+    }
+
+    func test_decode_consoleDevices_isPresent_isParsedCorrectly() throws {
+        let yaml = fixtureConfig.appending("""
+        consoleDevices:
+          - test-device
+          - test-device2
+        """)
+
+        let sut = try yamlDecoder.decode(Config.self, from: Data(yaml.utf8))
+        XCTAssertEqual(sut.consoleDevices, ["test-device", "test-device2"])
+    }
+}
+
+private extension ConfigTests {
+    var fixtureConfig: String {
+        """
+        source: oci://example.com/namespace/image_name:tag
+        provisioner:
+          type: github
+          config:
+            appId: 123456
+            organization: test-organization
+            runnerGroup: test-group
+            privateKeyPath: ~/github.pem
+
+        """
+    }
+}

README.md

@@ -104,6 +104,8 @@ provisioner:
     downloadLatest: <DOWNLOAD_LATEST> # defaults to 'true'. If 'false' it expects the binary to be present at the user's home directory
     downloadURL: <DOWNLOAD_URL> # defaults to GitLab official S3 bucket
     tomlPath: <PATH_TO_TOML> # defaults to `nil`. If set, it ignores the other runner related variables and passes the specified path to the runner executable
+consoleDevices:
+  - tart-version-cilicon
 ```
 
 #### Buildkite Agent
@@ -132,6 +134,17 @@ provisioner:
         sleep 10
 ```
 
+#### Console Devices
+
+Cilicon supports injecting console devices into the VM configuration. This is particularly useful for compatibility with tools like [tart-guest-agent](https://github.com/cirruslabs/tart-guest-agent) which expect specific console devices to be present.
+
+To add console devices, use the `consoleDevices` field in your configuration:
+
+```yml
+consoleDevices:
+  - tart-version-cilicon
+```
+
 ### 🔨 Setting Up the Host OS
 It is recommended to use Cilicon on a macOS device fully dedicated to the task, ideally one that is [freshly restored](https://support.apple.com/en-gb/guide/apple-configurator-mac/apdd5f3c75ad/mac).