Fix ArgumentParser's exception printing (#367)

* Fixed --help

Apparently `--help` works via exceptions 🤷‍♂️

Fixes #360

* lint issue

.cirrus.yml

@@ -1,13 +1,44 @@
+use_compute_credits: true
+
 task:
   name: Test on Ventura
+  alias: test
   persistent_worker:
     labels:
-      name: Mac-Mini-M1
-  build_script: swift test
-  test_script: swift test
+      name: scaleway-m1
+  test_script:
+    - swift test
+  integration_test_script:
+    # Build Tart
+    - swift build
+    - codesign --sign - --entitlements Resources/tart.entitlements --force .build/debug/tart
+    - export PATH=$(pwd)/.build/arm64-apple-macosx/debug:$PATH
+    # Run integration tests
+    - cd integration-tests
+    - HOMEBREW_NO_AUTO_UPDATE=1 brew install virtualenv
+    - virtualenv venv
+    - source venv/bin/activate
+    - pip install -r requirements.txt
+    - pytest --verbose --junit-xml=pytest-junit.xml
+  pytest_junit_result_artifacts:
+    path: "integration-tests/pytest-junit.xml"
+    format: junit
+
+task:
+  name: Lint
+  alias: lint
+  macos_instance:
+    image: ghcr.io/cirruslabs/macos-ventura-xcode:latest
+  lint_script:
+    - swift package plugin --allow-writing-to-package-directory swiftformat --cache ignore --lint --report swiftformat.json .
+  always:
+    swiftformat_report_artifacts:
+      path: swiftformat.json
+      format: swiftformat
 
 task:
   name: Build
+  alias: build
   only_if: $CIRRUS_TAG == ''
   macos_instance:
     image: ghcr.io/cirruslabs/macos-ventura-xcode:latest
@@ -19,6 +50,10 @@ task:
 task:
   name: Release
   only_if: $CIRRUS_TAG != ''
+  depends_on:
+    - lint
+    - test
+    - build
   macos_instance:
     image: ghcr.io/cirruslabs/macos-ventura-xcode:latest
   env:
@@ -26,6 +61,9 @@ task:
     AC_PASSWORD: ENCRYPTED[4a761023e7e06fe2eb350c8b6e8e7ca961af193cb9ba47605f25f1d353abc3142606f412e405be48fd897a78787ea8c2]
     GITHUB_TOKEN: ENCRYPTED[!98ace8259c6024da912c14d5a3c5c6aac186890a8d4819fad78f3e0c41a4e0cd3a2537dd6e91493952fb056fa434be7c!]
     GORELEASER_KEY: ENCRYPTED[!9b80b6ef684ceaf40edd4c7af93014ee156c8aba7e6e5795f41c482729887b5c31f36b651491d790f1f668670888d9fd!]
+    SENTRY_ORG: cirrus-labs
+    SENTRY_PROJECT: persistent-workers
+    SENTRY_AUTH_TOKEN: ENCRYPTED[!c16a5cf7da5f856b4bc2f21fe8cb7aa2a6c981f851c094ed4d3025fd02ea59a58a86cee8b193a69a1fc20fa217e56ac3!]
   setup_script:
     - cd $HOME
     - echo $MACOS_CERTIFICATE | base64 --decode > certificate.p12
@@ -36,10 +74,23 @@ task:
     - security set-key-partition-list -S apple-tool:,apple:,codesign: -s -k password101 build.keychain
     - xcrun notarytool store-credentials "notarytool" --apple-id "hello@cirruslabs.org" --team-id "9M2P8L4D89" --password $AC_PASSWORD
   install_script: 
-    - brew install go goreleaser/tap/goreleaser-pro
+    - brew install go goreleaser/tap/goreleaser-pro getsentry/tools/sentry-cli
     - brew install mitchellh/gon/gon
   info_script:
     - security find-identity -v
     - xcodebuild -version
     - swift -version
   release_script: goreleaser
+  upload_sentry_debug_files_script:
+    - cd .build/arm64-apple-macosx/debug/
+    # Generate and upload symbols
+    - dsymutil tart
+    - sentry-cli debug-files upload tart.dSYM/
+    # Bundle and upload sources
+    - sentry-cli debug-files bundle-sources tart.dSYM
+    - sentry-cli debug-files upload tart.src.zip
+  create_sentry_release_script:
+    - export SENTRY_RELEASE="tart@$CIRRUS_TAG"
+    - sentry-cli releases new $SENTRY_RELEASE
+    - sentry-cli releases set-commits $SENTRY_RELEASE --auto
+    - sentry-cli releases finalize $SENTRY_RELEASE

.github/CODEOWNERS

@@ -0,0 +1 @@
+* @edigaryev @fkorotkov

.swiftformat

@@ -0,0 +1,5 @@
+--disable all
+--enable indent
+--indent 2
+--exclude Sources/tart/OCI/Reference/Generated
+--swiftversion 5.7

Package.resolved

@@ -27,6 +27,15 @@
         "version" : "0.5.1"
       }
     },
+    {
+      "identity" : "sentry-cocoa",
+      "kind" : "remoteSourceControl",
+      "location" : "https://github.com/getsentry/sentry-cocoa",
+      "state" : {
+        "revision" : "c3c19e29f775ee95b77aa3168f3e2fd6c20deba6",
+        "version" : "7.31.3"
+      }
+    },
     {
       "identity" : "swift-algorithms",
       "kind" : "remoteSourceControl",
@@ -98,6 +107,15 @@
         "revision" : "6190d0cefff3013e77ed567e6b074f324e5c5bf5",
         "version" : "6.3.1"
       }
+    },
+    {
+      "identity" : "swiftformat",
+      "kind" : "remoteSourceControl",
+      "location" : "https://github.com/nicklockwood/SwiftFormat",
+      "state" : {
+        "revision" : "da637c398c5d08896521b737f2868ddc2e7996ae",
+        "version" : "0.50.6"
+      }
     }
   ],
   "version" : 2

Package.swift

@@ -18,6 +18,8 @@ let package = Package(
     .package(url: "https://github.com/sushichop/Puppy", from: "0.5.1"),
     .package(url: "https://github.com/antlr/antlr4", branch: "dev"),
     .package(url: "https://github.com/apple/swift-atomics.git", .upToNextMajor(from: "1.0.0")),
+    .package(url: "https://github.com/nicklockwood/SwiftFormat", from: "0.50.6"),
+    .package(url: "https://github.com/getsentry/sentry-cocoa", from: "7.31.3"),
   ],
   targets: [
     .executableTarget(name: "tart", dependencies: [
@@ -29,6 +31,8 @@ let package = Package(
       .product(name: "Puppy", package: "Puppy"),
       .product(name: "Antlr4Static", package: "Antlr4"),
       .product(name: "Atomics", package: "swift-atomics"),
+      .product(name: "Sentry", package: "sentry-cocoa"),
+
     ], exclude: [
       "OCI/Reference/Makefile",
       "OCI/Reference/Reference.g4",

README.md

@@ -1,6 +1,6 @@
 <img src="https://github.com/cirruslabs/tart/raw/main/Resources/TartSocial.png"/>
 
-*Tart* is a virtualization toolset to build, run and manage macOS and Linux virtual machines on Apple Silicon.
+*Tart* is a virtualization toolset to build, run and manage macOS and Linux virtual machines (VMs) on Apple Silicon.
 Built by CI engineers for your automation needs. Here are some highlights of Tart:
 
 * Tart uses Apple's own `Virtualization.Framework` for [near-native performance](https://browser.geekbench.com/v5/cpu/compare/14966395?baseline=14966339).
@@ -22,9 +22,25 @@ Built by CI engineers for your automation needs. Here are some highlights of Tar
   </a>
 </p>
 
+Many more companies are using Tart in their internal setups. Here are a few of them:
+
+<p align="center">
+  <a href="https://ahrefs.com/" target=_blank>
+    <img src="https://github.com/cirruslabs/tart/raw/main/Resources/Users/ahrefs.png" height="65"/>
+  </a>
+  <a href="https://suran.com/" target=_blank>
+    <img src="https://github.com/cirruslabs/tart/raw/main/Resources/Users/Suran.png" height="65"/>
+  </a>
+  <a href="https://symflower.com/" target=_blank>
+    <img src="https://github.com/cirruslabs/tart/raw/main/Resources/Users/Symflower.png" height="65"/>
+  </a>
+</p>
+
+**Note:** If your company or project is using Tart please consider [adding yourself to the list above](/Resources/Users/HowToAddYourself.md).
+
 ## Usage
 
-Try running a Tart VM on your Apple Silicon device running macOS Monterey or later (will download a 25 GB image):
+Try running a Tart VM on your Apple Silicon device running macOS 12.0 (Monterey) or later (will download a 25 GB image):
 
 ```shell
 brew install cirruslabs/cli/tart
@@ -117,7 +133,7 @@ task:
 
 Running Cirrus CLI with `--artifacts-dir` will write defined `artifacts` to the provided local directory on the host:
 
-```bash
+```shell
 cirrus run --artifacts-dir artifacts
 ```
 
@@ -151,7 +167,9 @@ After the initial booting of the VM you'll need to manually go through the macOS
 
 #### Creating a Linux VM image from scratch
 
-```bash
+Linux VMs are supported on hosts running macOS 13.0 (Ventura) or newer.
+
+```shell
 # Create a bare VM
 tart create --linux ubuntu
 
@@ -258,6 +276,50 @@ tart clone acme.io/remoteorg/name:latest my-local-vm-name
 
 This invocation calls the `tart pull` implicitly (if the image is not being present) before doing the actual cloning.
 
+### Mounting directories
+
+To mount a directory, run the VM with the `--dir` argument:
+
+```shell
+tart run --dir=project:~/src/project vm
+```
+
+Here, the `project` specifies a mount name, whereas the `~/src/project` is a path to the host's directory to expose to the VM.
+
+It is also possible to mount directories in read-only mode by adding a third parameter, `ro`:
+
+```shell
+tart run --dir=project:~/src/project:ro vm
+```
+
+To mount multiple directories, repeat the `--dir` argument for each directory:
+
+```shell
+tart run --dir=www1:~/project1/www --dir=www2:~/project2/www
+```
+
+Note that the first parameter in each `--dir` argument must be unique, otherwise only the last `--dir` argument using that name will be used.
+
+Note: to use the directory mounting feature, the host needs to run macOS 13.0 (Ventura) or newer.
+
+#### Accessing mounted directories in macOS guests
+
+All shared directories are automatically mounted to `/Volumes/My Shared Files` directory.
+
+The directory we've mounted above will be accessible from the `/Volumes/My Shared Files/project` path inside a guest VM.
+
+Note: to use the directory mounting feature, the guest VM needs to run macOS 13.0 (Ventura) or newer.
+
+#### Accessing mounted directories in Linux guests
+
+To be able to access the shared directories from the Linux guest, you need to manually mount the virtual filesystem first:
+
+```shell
+mount -t virtiofs com.apple.virtio-fs.automount /mnt/shared
+```
+
+The directory we've mounted above will be accessible from the `/mnt/shared/project` path inside a guest VM.
+
 ## FAQ
 
 <details>
@@ -296,7 +358,7 @@ This invocation calls the `tart pull` implicitly (if the image is not being pres
   <summary>VM location on disk</summary>
 
   Tart stores all it's files in `~/.tart/` directory. Local images that you can run are stored in `~/.tart/vms/`.
-  Remote images are pulled into `~/.tart/vms/cache/OCIs/`.
+  Remote images are pulled into `~/.tart/cache/OCIs/`.
 </details>
 
 <details>
@@ -311,7 +373,7 @@ This invocation calls the `tart pull` implicitly (if the image is not being pres
 
   To change the default network to `192.168.77.1`:
 
-  ```
+  ```shell
   sudo defaults write /Library/Preferences/SystemConfiguration/com.apple.vmnet.plist Shared_Net_Address -string 192.168.77.1
   ```
 
@@ -319,7 +381,17 @@ This invocation calls the `tart pull` implicitly (if the image is not being pres
 
   The default subnet mask `255.255.255.0` should suffice for most use-cases, however, you can also change it to `255.255.0.0`, for example:
 
-  ```
+  ```shell
   sudo defaults write /Library/Preferences/SystemConfiguration/com.apple.vmnet.plist Shared_Net_Mask -string 255.255.0.0
   ```
 </details>
+
+<details>
+  <summary>How to connect to a VM over SSH?</summary>
+
+  If the guest VM is running and configured to accept incoming SSH connections you can conveniently connect to it like so:
+  
+  ```shell
+  ssh admin@$(tart ip macos-monterey-base)
+  ```
+</details>

Resources/Users/Background.png

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:4d1f58f6460217434ae133c6d6e444320eb705c5dcf9efebbb215b117ae452c1
+size 589

Resources/Users/HowToAddYourself.md

@@ -0,0 +1,4 @@
+If you'd like to highlight your use of Tart, please create a `456px` by `130px` logo and create a PR
+that adds it to `README.md` in alphabetical order. Don't forget to include a small description of your usage pattern.
+
+You can refer to `Background.png` as a base for your logo.

Resources/Users/Suran.png

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:630c4975b9eead9e4f62e2a5375509dc0ee6cab2940ec3ffc2ae16b08d325964
+size 6765

Resources/Users/Symflower.png

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:5e48fbe90f6cc84e100fc286a5349c681cacb22358811181046d35ea298309de
+size 16379

Resources/Users/ahrefs.png

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:1c7f7f9bf0fc0c9807f3a415fe6bf773c8a416b351c5aa08de46149a13de7387
+size 5297

Sources/tart/CI/CI.swift

@@ -4,6 +4,10 @@ struct CI {
   static var version: String {
     rawVersion.expanded() ? rawVersion : "SNAPSHOT"
   }
+
+  static var release: String? {
+    rawVersion.expanded() ? "tart@\(rawVersion)" : nil
+  }
 }
 
 private extension String {

Sources/tart/Commands/Clone.swift

@@ -21,43 +21,35 @@ struct Clone: AsyncParsableCommand {
   }
 
   func run() async throws {
-    do {
-      let ociStorage = VMStorageOCI()
-      let localStorage = VMStorageLocal()
+    let ociStorage = VMStorageOCI()
+    let localStorage = VMStorageLocal()
 
-      if let remoteName = try? RemoteName(sourceName), !ociStorage.exists(remoteName) {
-        // Pull the VM in case it's OCI-based and doesn't exist locally yet
-        let registry = try Registry(host: remoteName.host, namespace: remoteName.namespace, insecure: insecure)
-        try await ociStorage.pull(remoteName, registry: registry)
-      }
-
-      let sourceVM = try VMStorageHelper.open(sourceName)
-
-      let tmpVMDir = try VMDirectory.temporary()
-
-      // Lock the temporary VM directory to prevent it's garbage collection
-      let tmpVMDirLock = try FileLock(lockURL: tmpVMDir.baseURL)
-      try tmpVMDirLock.lock()
-
-      try await withTaskCancellationHandler(operation: {
-        let lock = try FileLock(lockURL: Config().tartHomeDir)
-        try lock.lock()
-
-        let generateMAC = try localStorage.hasVMsWithMACAddress(macAddress: sourceVM.macAddress())
-        try sourceVM.clone(to: tmpVMDir, generateMAC: generateMAC)
-        try localStorage.move(newName, from: tmpVMDir)
-
-        try lock.unlock()
-      }, onCancel: {
-        try? FileManager.default.removeItem(at: tmpVMDir.baseURL)
-      })
-
-      Foundation.exit(0)
-    } catch {
-      print(error)
-
-      Foundation.exit(1)
+    if let remoteName = try? RemoteName(sourceName), !ociStorage.exists(remoteName) {
+      // Pull the VM in case it's OCI-based and doesn't exist locally yet
+      let registry = try Registry(host: remoteName.host, namespace: remoteName.namespace, insecure: insecure)
+      try await ociStorage.pull(remoteName, registry: registry)
     }
+
+    let sourceVM = try VMStorageHelper.open(sourceName)
+
+    let tmpVMDir = try VMDirectory.temporary()
+
+    // Lock the temporary VM directory to prevent it's garbage collection
+    let tmpVMDirLock = try FileLock(lockURL: tmpVMDir.baseURL)
+    try tmpVMDirLock.lock()
+
+    try await withTaskCancellationHandler(operation: {
+      let lock = try FileLock(lockURL: Config().tartHomeDir)
+      try lock.lock()
+
+      let generateMAC = try localStorage.hasVMsWithMACAddress(macAddress: sourceVM.macAddress())
+      try sourceVM.clone(to: tmpVMDir, generateMAC: generateMAC)
+      try localStorage.move(newName, from: tmpVMDir)
+
+      try lock.unlock()
+    }, onCancel: {
+      try? FileManager.default.removeItem(at: tmpVMDir.baseURL)
+    })
   }
 }
 

Sources/tart/Commands/Create.swift

@@ -25,46 +25,38 @@ struct Create: AsyncParsableCommand {
   }
 
   func run() async throws {
-    do {
-      let tmpVMDir = try VMDirectory.temporary()
+    let tmpVMDir = try VMDirectory.temporary()
 
-      // Lock the temporary VM directory to prevent it's garbage collection
-      let tmpVMDirLock = try FileLock(lockURL: tmpVMDir.baseURL)
-      try tmpVMDirLock.lock()
+    // Lock the temporary VM directory to prevent it's garbage collection
+    let tmpVMDirLock = try FileLock(lockURL: tmpVMDir.baseURL)
+    try tmpVMDirLock.lock()
 
-      try await withTaskCancellationHandler(operation: {
-        if let fromIPSW = fromIPSW {
-          let ipswURL: URL
+    try await withTaskCancellationHandler(operation: {
+      if let fromIPSW = fromIPSW {
+        let ipswURL: URL
 
-          if fromIPSW == "latest" {
-            ipswURL = try await VM.latestIPSWURL()
-          } else if fromIPSW.starts(with: "http://") || fromIPSW.starts(with: "https://") {
-            ipswURL = URL(string: fromIPSW)!
-          } else {
-            ipswURL = URL(fileURLWithPath: fromIPSW)
-          }
-
-          _ = try await VM(vmDir: tmpVMDir, ipswURL: ipswURL, diskSizeGB: diskSize)
+        if fromIPSW == "latest" {
+          ipswURL = try await VM.latestIPSWURL()
+        } else if fromIPSW.starts(with: "http://") || fromIPSW.starts(with: "https://") {
+          ipswURL = URL(string: fromIPSW)!
+        } else {
+          ipswURL = URL(fileURLWithPath: fromIPSW)
         }
 
-        if linux {
-          if #available(macOS 13, *) {
-            _ = try await VM.linux(vmDir: tmpVMDir, diskSizeGB: diskSize)
-          } else {
-            throw UnsupportedOSError("Linux VMs", "are")
-          }
+        _ = try await VM(vmDir: tmpVMDir, ipswURL: ipswURL, diskSizeGB: diskSize)
+      }
+
+      if linux {
+        if #available(macOS 13, *) {
+          _ = try await VM.linux(vmDir: tmpVMDir, diskSizeGB: diskSize)
+        } else {
+          throw UnsupportedOSError("Linux VMs", "are")
         }
+      }
 
-        try VMStorageLocal().move(name, from: tmpVMDir)
-      }, onCancel: {
-        try? FileManager.default.removeItem(at: tmpVMDir.baseURL)
-      })
-
-      Foundation.exit(0)
-    } catch {
-      print(error)
-
-      Foundation.exit(1)
-    }
+      try VMStorageLocal().move(name, from: tmpVMDir)
+    }, onCancel: {
+      try? FileManager.default.removeItem(at: tmpVMDir.baseURL)
+    })
   }
 }

Sources/tart/Commands/Delete.swift

@@ -9,16 +9,8 @@ struct Delete: AsyncParsableCommand {
   var name: [String]
 
   func run() async throws {
-    do {
-      for it in name {
-        try VMStorageHelper.delete(it)
-      }
-
-      Foundation.exit(0)
-    } catch {
-      print(error)
-
-      Foundation.exit(1)
+    for it in name {
+      try VMStorageHelper.delete(it)
     }
   }
 }

Sources/tart/Commands/Get.swift

@@ -4,28 +4,49 @@ import Foundation
 struct Get: AsyncParsableCommand {
   static var configuration = CommandConfiguration(commandName: "get", abstract: "Get a VM's configuration")
 
-  @Argument(help: "VM name")
+  @Argument(help: "VM name.")
   var name: String
 
+  @Flag(help: "Number of VM CPUs.")
+  var cpu: Bool = false
+
+  @Flag(help: "VM memory size in megabytes.")
+  var memory: Bool = false
+
+  @Flag(help: "Disk size in gigabytes.")
+  var diskSize: Bool = false
+
+  @Flag(help: "VM display resolution in a format of <width>x<height>. For example, 1200x800.")
+  var display: Bool = false
+
+  func validate() throws {
+    if [cpu, memory, diskSize, display].filter({$0}).count > 1 {
+      throw ValidationError("Options --cpu, --memory, --disk-size and --display are mutually exclusive")
+    }
+  }
+
   func run() async throws {
-    do {
-      let vmDir = try VMStorageLocal().open(name)
-      let vmConfig = try VMConfig(fromURL: vmDir.configURL)
-      let diskSize = try vmDir.sizeBytes() / 1000 / 1000 / 1000
+    let vmDir = try VMStorageLocal().open(name)
+    let vmConfig = try VMConfig(fromURL: vmDir.configURL)
+    let diskSizeInGb = try vmDir.sizeBytes() / 1000 / 1000 / 1000
+    let memorySizeInMb = vmConfig.memorySize  / 1024 / 1024
 
-      print("CPU\tMemory\tDisk\tDisplay")
-
-      var s = "\(vmConfig.cpuCount)\t"
-      s += "\(vmConfig.memorySize / 1024 / 1024) MB\t"
-      s += "\(diskSize) GB\t"
-      s += "\(vmConfig.display.width)x\(vmConfig.display.height)"
-      print(s)
-
-      Foundation.exit(0)
-    } catch {
-      print(error)
-
-      Foundation.exit(1)
+    if cpu {
+      print(vmConfig.cpuCount)
+    } else if memory {
+      print(memorySizeInMb)
+    } else if diskSize {
+      print(diskSizeInGb)
+    } else if display {
+      print("\(vmConfig.display.width)x\(vmConfig.display.height)")
+    } else {
+      print(
+        "CPU\tMemory\tDisk\tDisplay\n" +
+          "\(vmConfig.cpuCount)\t" +
+          "\(memorySizeInMb) MB\t" +
+          "\(diskSizeInGb) GB\t" +
+          "\(vmConfig.display)"
+      )
     }
   }
 }

Sources/tart/Commands/IP.swift

@@ -2,6 +2,7 @@ import ArgumentParser
 import Foundation
 import Network
 import SystemConfiguration
+import Sentry
 
 struct IP: AsyncParsableCommand {
   static var configuration = CommandConfiguration(abstract: "Get VM's IP address")
@@ -13,31 +14,37 @@ struct IP: AsyncParsableCommand {
   var wait: UInt16 = 0
 
   func run() async throws {
-    do {
-      let vmDir = try VMStorageLocal().open(name)
-      let vmConfig = try VMConfig.init(fromURL: vmDir.configURL)
-      let vmMACAddress = MACAddress(fromString: vmConfig.macAddress.string)!
+    let vmDir = try VMStorageLocal().open(name)
+    let vmConfig = try VMConfig.init(fromURL: vmDir.configURL)
+    let vmMACAddress = MACAddress(fromString: vmConfig.macAddress.string)!
 
-      guard let ipViaDHCP = try await IP.resolveIP(vmMACAddress, secondsToWait: wait) else {
-        print("no IP address found, is your VM running?")
-
-        Foundation.exit(1)
-      }
-
-      if let ipViaARP = try ARPCache.ResolveMACAddress(macAddress: vmMACAddress), ipViaARP != ipViaDHCP {
-        fputs("WARNING: DHCP lease and ARP cache entries for MAC address \(vmMACAddress) differ: "
-          + "got \(ipViaDHCP) and \(ipViaARP) respectively, consider reporting this case to"
-          + " https://github.com/cirruslabs/tart/issues/172\n", stderr)
-      }
-
-      print(ipViaDHCP)
-
-      Foundation.exit(0)
-    } catch {
-      print(error)
-
-      Foundation.exit(1)
+    guard let ipViaDHCP = try await IP.resolveIP(vmMACAddress, secondsToWait: wait) else {
+      throw RuntimeError.NoIPAddressFound("no IP address found, is your VM running?")
     }
+
+    let arpCache = try ARPCache()
+
+    if let ipViaARP = try arpCache.ResolveMACAddress(macAddress: vmMACAddress), ipViaARP != ipViaDHCP {
+      // Capture the warning into Sentry
+      SentrySDK.capture(message: "DHCP lease and ARP cache entries for a single MAC address differ") { scope in
+        scope.setLevel(.warning)
+
+        scope.setContext(value: [
+          "MAC address": vmMACAddress,
+          "IP via ARP": ipViaARP,
+          "IP via DHCP": ipViaDHCP,
+        ], key: "Address conflict details")
+
+        scope.add(Attachment(path: "/var/db/dhcpd_leases", filename: "dhcpd_leases.txt", contentType: "text/plain"))
+        scope.add(Attachment(data: arpCache.arpCommandOutput, filename: "arp-an-output.txt", contentType: "text/plain"))
+      }
+
+      fputs("WARNING: DHCP lease and ARP cache entries for MAC address \(vmMACAddress) differ: "
+        + "got \(ipViaDHCP) and \(ipViaARP) respectively, consider reporting this case to"
+        + " https://github.com/cirruslabs/tart/issues/172\n", stderr)
+    }
+
+    print(ipViaDHCP)
   }
 
   static public func resolveIP(_ vmMACAddress: MACAddress, secondsToWait: UInt16) async throws -> IPv4Address? {

Sources/tart/Commands/List.swift

@@ -5,23 +5,33 @@ import SwiftUI
 struct List: AsyncParsableCommand {
   static var configuration = CommandConfiguration(abstract: "List created VMs")
 
-  @Flag(name: [.short, .long], help: ArgumentHelp("Only display VM names"))
+  @Flag(name: [.short, .long], help: ArgumentHelp("Only display VM names."))
   var quiet: Bool = false
 
+  @Option(help: ArgumentHelp("Only display VMs from the specified source (e.g. --source local, --source oci)."))
+  var source: String?
+
+  func validate() throws {
+    guard let source = source else {
+      return
+    }
+
+    if !["local", "oci"].contains(source) {
+      throw ValidationError("'\(source)' is not a valid <source>")
+    }
+  }
+
   func run() async throws {
-    do {
-      if !quiet {
-        print("Source\tName")
-      }
+    if !quiet {
+      print("Source\tName")
+    }
 
+    if source == nil || source == "local" {
       displayTable("local", try VMStorageLocal().list())
+    }
+
+    if source == nil || source == "oci" {
       displayTable("oci", try VMStorageOCI().list().map { (name, vmDir, _) in (name, vmDir) })
-
-      Foundation.exit(0)
-    } catch {
-      print(error)
-
-      Foundation.exit(1)
     }
   }
 
@@ -30,6 +40,7 @@ struct List: AsyncParsableCommand {
       if quiet {
         print(name)
       } else {
+        let source = source.padding(toLength: "Source".count, withPad: " ", startingAt: 0)
         print("\(source)\t\(name)")
       }
     }

Sources/tart/Commands/Login.swift

@@ -27,40 +27,30 @@ struct Login: AsyncParsableCommand {
   }
 
   func run() async throws {
-    do {
-      var user: String
-      var password: String
+    var user: String
+    var password: String
 
-      if let username = username {
-        user = username
+    if let username = username {
+      user = username
 
-        let passwordData = FileHandle.standardInput.readDataToEndOfFile()
-        password = String(decoding: passwordData, as: UTF8.self)
-      } else {
-        (user, password) = try StdinCredentials.retrieve()
-      }
-      let credentialsProvider = DictionaryCredentialsProvider([
-        host: (user, password)
-      ])
-
-      do {
-        let registry = try Registry(host: host, namespace: "", insecure: insecure,
-          credentialsProviders: [credentialsProvider])
-        try await registry.ping()
-      } catch {
-        print("invalid credentials: \(error)")
-
-        Foundation.exit(1)
-      }
-
-      try KeychainCredentialsProvider().store(host: host, user: user, password: password)
-
-      Foundation.exit(0)
-    } catch {
-      print(error)
-
-      Foundation.exit(1)
+      let passwordData = FileHandle.standardInput.readDataToEndOfFile()
+      password = String(decoding: passwordData, as: UTF8.self)
+    } else {
+      (user, password) = try StdinCredentials.retrieve()
     }
+    let credentialsProvider = DictionaryCredentialsProvider([
+      host: (user, password)
+    ])
+
+    do {
+      let registry = try Registry(host: host, namespace: "", insecure: insecure,
+                                  credentialsProviders: [credentialsProvider])
+      try await registry.ping()
+    } catch {
+      throw RuntimeError.InvalidCredentials("invalid credentials: \(error)")
+    }
+
+    try KeychainCredentialsProvider().store(host: host, user: user, password: password)
   }
 }
 

Sources/tart/Commands/Prune.swift

@@ -1,5 +1,6 @@
 import ArgumentParser
 import Dispatch
+import Sentry
 import SwiftUI
 import SwiftDate
 
@@ -7,13 +8,13 @@ struct Prune: AsyncParsableCommand {
   static var configuration = CommandConfiguration(abstract: "Prune OCI and IPSW caches")
 
   @Option(help: ArgumentHelp("Remove cache entries last accessed more than n days ago",
-    discussion: "For example, --older-than=7 will remove entries that weren't accessed by Tart in the last 7 days.",
-    valueName: "n"))
+                             discussion: "For example, --older-than=7 will remove entries that weren't accessed by Tart in the last 7 days.",
+                             valueName: "n"))
   var olderThan: UInt?
 
   @Option(help: ArgumentHelp("Remove least recently used cache entries that do not fit the specified cache size budget n, expressed in gigabytes",
-    discussion: "For example, --cache-budget=50 will effectively shrink all caches to a total size of 50 gigabytes.",
-    valueName: "n"))
+                             discussion: "For example, --cache-budget=50 will effectively shrink all caches to a total size of 50 gigabytes.",
+                             valueName: "n"))
   var cacheBudget: UInt?
 
   @Flag(help: .hidden)
@@ -26,29 +27,21 @@ struct Prune: AsyncParsableCommand {
   }
 
   func run() async throws {
-    do {
-      if gc {
-        try VMStorageOCI().gc()
-      }
+    if gc {
+      try VMStorageOCI().gc()
+    }
 
-      // Clean up cache entries based on last accessed date
-      if let olderThan = olderThan {
-        let olderThanInterval = Int(exactly: olderThan)!.days.timeInterval
-        let olderThanDate = Date().addingTimeInterval(olderThanInterval)
+    // Clean up cache entries based on last accessed date
+    if let olderThan = olderThan {
+      let olderThanInterval = Int(exactly: olderThan)!.days.timeInterval
+      let olderThanDate = Date().addingTimeInterval(olderThanInterval)
 
-        try Prune.pruneOlderThan(olderThanDate: olderThanDate)
-      }
+      try Prune.pruneOlderThan(olderThanDate: olderThanDate)
+    }
 
-      // Clean up cache entries based on imposed cache size limit and entry's last accessed date
-      if let cacheBudget = cacheBudget {
-        try Prune.pruneCacheBudget(cacheBudgetBytes: UInt64(cacheBudget) * 1024 * 1024 * 1024)
-      }
-
-      Foundation.exit(0)
-    } catch {
-      print(error)
-
-      Foundation.exit(1)
+    // Clean up cache entries based on imposed cache size limit and entry's last accessed date
+    if let cacheBudget = cacheBudget {
+      try Prune.pruneCacheBudget(cacheBudgetBytes: UInt64(cacheBudget) * 1024 * 1024 * 1024)
     }
   }
 
@@ -62,8 +55,8 @@ struct Prune: AsyncParsableCommand {
   static func pruneCacheBudget(cacheBudgetBytes: UInt64) throws {
     let prunableStorages: [PrunableStorage] = [VMStorageOCI(), try IPSWCache()]
     let prunables: [Prunable] = try prunableStorages
-            .flatMap { try $0.prunables() }
-            .sorted { try $0.accessDate() > $1.accessDate() }
+      .flatMap { try $0.prunables() }
+      .sorted { try $0.accessDate() > $1.accessDate() }
 
     var cacheBudgetBytes = cacheBudgetBytes
     var prunablesToDelete: [Prunable] = []
@@ -87,8 +80,8 @@ struct Prune: AsyncParsableCommand {
   static func pruneReclaim(reclaimBytes: UInt64) throws {
     let prunableStorages: [PrunableStorage] = [VMStorageOCI(), try IPSWCache()]
     let prunables: [Prunable] = try prunableStorages
-            .flatMap { try $0.prunables() }
-            .sorted { try $0.accessDate() < $1.accessDate() }
+      .flatMap { try $0.prunables() }
+      .sorted { try $0.accessDate() < $1.accessDate() }
 
     // Does it even make sense to start?
     let cacheUsedBytes = try prunables.map { try $0.sizeBytes() }.reduce(0, +)
@@ -111,5 +104,7 @@ struct Prune: AsyncParsableCommand {
     }
 
     puppy.info("reclaimed \(cacheReclaimedBytes) bytes")
+
+    SentrySDK.span?.setMeasurement(name: "gc_disk_reclaimed", value: cacheReclaimedBytes as NSNumber, unit: MeasurementUnitInformation.byte);
   }
 }

Sources/tart/Commands/Pull.swift

@@ -12,27 +12,19 @@ struct Pull: AsyncParsableCommand {
   var insecure: Bool = false
 
   func run() async throws {
-    do {
-      // Be more liberal when accepting local image as argument,
-      // see https://github.com/cirruslabs/tart/issues/36
-      if VMStorageLocal().exists(remoteName) {
-        print("\"\(remoteName)\" is a local image, nothing to pull here!")
+    // Be more liberal when accepting local image as argument,
+    // see https://github.com/cirruslabs/tart/issues/36
+    if VMStorageLocal().exists(remoteName) {
+      print("\"\(remoteName)\" is a local image, nothing to pull here!")
 
-        Foundation.exit(0)
-      }
-
-      let remoteName = try RemoteName(remoteName)
-      let registry = try Registry(host: remoteName.host, namespace: remoteName.namespace, insecure: insecure)
-
-      defaultLogger.appendNewLine("pulling \(remoteName)...")
-
-      try await VMStorageOCI().pull(remoteName, registry: registry)
-
-      Foundation.exit(0)
-    } catch {
-      print(error)
-
-      Foundation.exit(1)
+      return
     }
+
+    let remoteName = try RemoteName(remoteName)
+    let registry = try Registry(host: remoteName.host, namespace: remoteName.namespace, insecure: insecure)
+
+    defaultLogger.appendNewLine("pulling \(remoteName)...")
+
+    try await VMStorageOCI().pull(remoteName, registry: registry)
   }
 }

Sources/tart/Commands/Push.swift

@@ -16,66 +16,58 @@ struct Push: AsyncParsableCommand {
   var insecure: Bool = false
 
   @Option(help: ArgumentHelp("chunk size in MB if registry supports chunked uploads",
-    discussion: """
-                By default monolithic method is used for uploading blobs to the registry but some registries support a more efficient chunked method.
-                For example, AWS Elastic Container Registry supports only chunks larger than 5MB but GitHub Container Registry supports only chunks smaller than 4MB. Google Container Registry on the other hand doesn't support chunked uploads at all.
-                Please refer to the documentation of your particular registry in order to see if this option is suitable for you and what's the recommended chunk size.
-                """))
+                             discussion: """
+                             By default monolithic method is used for uploading blobs to the registry but some registries support a more efficient chunked method.
+                             For example, AWS Elastic Container Registry supports only chunks larger than 5MB but GitHub Container Registry supports only chunks smaller than 4MB. Google Container Registry on the other hand doesn't support chunked uploads at all.
+                             Please refer to the documentation of your particular registry in order to see if this option is suitable for you and what's the recommended chunk size.
+                             """))
   var chunkSize: Int = 0
 
   @Flag(help: ArgumentHelp("cache pushed images locally",
-          discussion: "Increases disk usage, but saves time if you're going to pull the pushed images later."))
+                           discussion: "Increases disk usage, but saves time if you're going to pull the pushed images later."))
   var populateCache: Bool = false
 
   func run() async throws {
-    do {
-      let localVMDir = try VMStorageLocal().open(localName)
+    let localVMDir = try VMStorageLocal().open(localName)
 
-      // Parse remote names supplied by the user
-      let remoteNames = try remoteNames.map{
-        try RemoteName($0)
-      }
+    // Parse remote names supplied by the user
+    let remoteNames = try remoteNames.map{
+      try RemoteName($0)
+    }
 
-      // Group remote names by registry
-      struct RegistryIdentifier: Hashable, Equatable {
-        var host: String
-        var namespace: String
-      }
+    // Group remote names by registry
+    struct RegistryIdentifier: Hashable, Equatable {
+      var host: String
+      var namespace: String
+    }
 
-      let registryGroups = Dictionary(grouping: remoteNames, by: {
-        RegistryIdentifier(host: $0.host, namespace: $0.namespace)
-      })
+    let registryGroups = Dictionary(grouping: remoteNames, by: {
+      RegistryIdentifier(host: $0.host, namespace: $0.namespace)
+    })
 
-      // Push VM
-      for (registryIdentifier, remoteNamesForRegistry) in registryGroups {
-        let registry = try Registry(host: registryIdentifier.host, namespace: registryIdentifier.namespace,
-          insecure: insecure)
+    // Push VM
+    for (registryIdentifier, remoteNamesForRegistry) in registryGroups {
+      let registry = try Registry(host: registryIdentifier.host, namespace: registryIdentifier.namespace,
+                                  insecure: insecure)
 
-        defaultLogger.appendNewLine("pushing \(localName) to "
-          + "\(registryIdentifier.host)/\(registryIdentifier.namespace)\(remoteNamesForRegistry.referenceNames())...")
+      defaultLogger.appendNewLine("pushing \(localName) to "
+        + "\(registryIdentifier.host)/\(registryIdentifier.namespace)\(remoteNamesForRegistry.referenceNames())...")
 
-        let pushedRemoteName = try await localVMDir.pushToRegistry(
-          registry: registry, 
-          references: remoteNamesForRegistry.map{ $0.reference.value }, 
-          chunkSizeMb: chunkSize
-        )
+      let pushedRemoteName = try await localVMDir.pushToRegistry(
+        registry: registry,
+        references: remoteNamesForRegistry.map{ $0.reference.value },
+        chunkSizeMb: chunkSize
+      )
 
-        // Populate the local cache (if requested)
-        if populateCache {
-          let ociStorage = VMStorageOCI()
-          let expectedPushedVMDir = try ociStorage.create(pushedRemoteName)
-          try localVMDir.clone(to: expectedPushedVMDir, generateMAC: false)
-          for remoteName in remoteNamesForRegistry {
-            try ociStorage.link(from: remoteName, to: pushedRemoteName)
-          }
+      // Populate the local cache (if requested)
+      if populateCache {
+        let ociStorage = VMStorageOCI()
+        let expectedPushedVMDir = try ociStorage.create(pushedRemoteName)
+        try localVMDir.clone(to: expectedPushedVMDir, generateMAC: false)
+        for remoteName in remoteNamesForRegistry {
+          try ociStorage.link(from: remoteName, to: pushedRemoteName)
         }
       }
-
-      Foundation.exit(0)
-    } catch {
-      print(error)
-
-      Foundation.exit(1)
     }
   }
 }

Sources/tart/Commands/Rename.swift

@@ -2,39 +2,31 @@ import ArgumentParser
 import Foundation
 
 struct Rename: AsyncParsableCommand {
-    static var configuration = CommandConfiguration(abstract: "Rename a VM")
+  static var configuration = CommandConfiguration(abstract: "Rename a VM")
 
-    @Argument(help: "VM name")
-    var name: String
+  @Argument(help: "VM name")
+  var name: String
 
-    @Argument(help: "new VM name")
-    var newName: String
+  @Argument(help: "new VM name")
+  var newName: String
 
-    func validate() throws {
-        if newName.contains("/") {
-            throw ValidationError("<new-name> should be a local name")
-        }
+  func validate() throws {
+    if newName.contains("/") {
+      throw ValidationError("<new-name> should be a local name")
+    }
+  }
+
+  func run() async throws {
+    let localStorage = VMStorageLocal()
+
+    if !localStorage.exists(name) {
+      throw ValidationError("failed to rename a non-existent VM: \(name)")
     }
 
-    func run() async throws {
-        do {
-            let localStorage = VMStorageLocal()
-
-            if !localStorage.exists(name) {
-                throw ValidationError("failed to rename a non-existent VM: \(name)")
-            }
-
-            if localStorage.exists(newName) {
-                throw ValidationError("failed to rename VM \(name), target VM \(name) already exists, delete it first!")
-            }
-
-            try localStorage.rename(name, newName)
-
-            Foundation.exit(0)
-        } catch {
-            print(error)
-
-            Foundation.exit(1)
-        }
+    if localStorage.exists(newName) {
+      throw ValidationError("failed to rename VM \(name), target VM \(name) already exists, delete it first!")
     }
+
+    try localStorage.rename(name, newName)
+  }
 }

Sources/tart/Commands/Run.swift

@@ -2,6 +2,7 @@ import ArgumentParser
 import Dispatch
 import SwiftUI
 import Virtualization
+import Sentry
 
 var vm: VM?
 
@@ -15,8 +16,8 @@ struct Run: AsyncParsableCommand {
   var name: String
 
   @Flag(help: ArgumentHelp(
-          "Don't open a UI window.",
-          discussion: "Useful for integrating Tart VMs into other tools.\nUse `tart ip` in order to get an IP for SSHing or VNCing into the VM.")) 
+    "Don't open a UI window.",
+    discussion: "Useful for integrating Tart VMs into other tools.\nUse `tart ip` in order to get an IP for SSHing or VNCing into the VM.")) 
   var noGraphics: Bool = false
 
   @Flag(help: "Force open a UI window, even when VNC is enabled.")
@@ -24,11 +25,11 @@ struct Run: AsyncParsableCommand {
 
   @Flag(help: "Boot into recovery mode") 
   var recovery: Bool = false
-  
+
   @Flag(help: ArgumentHelp(
-          "Use screen sharing instead of the built-in UI.",
-          discussion: "Useful since Screen Sharing supports copy/paste, drag and drop, etc.\n"
-            + "Note that Remote Login option should be enabled inside the VM."))
+    "Use screen sharing instead of the built-in UI.",
+    discussion: "Useful since Screen Sharing supports copy/paste, drag and drop, etc.\n"
+      + "Note that Remote Login option should be enabled inside the VM."))
   var vnc: Bool = false
 
   @Flag(help: ArgumentHelp(
@@ -41,32 +42,46 @@ struct Run: AsyncParsableCommand {
   var withSoftnet: Bool = false
 
   @Option(help: ArgumentHelp("""
-    Additional disk attachments with an optional read-only specifier\n(e.g. --disk=\"disk.bin\" --disk=\"ubuntu.iso:ro\")
-    """, discussion: """
-    Learn how to create a disk image using Disk Utility here:
-    https://support.apple.com/en-gb/guide/disk-utility/dskutl11888/mac
-    """, valueName: "path[:ro]"))
+  Additional disk attachments with an optional read-only specifier\n(e.g. --disk=\"disk.bin\" --disk=\"ubuntu.iso:ro\")
+  """, discussion: """
+  Learn how to create a disk image using Disk Utility here:
+  https://support.apple.com/en-gb/guide/disk-utility/dskutl11888/mac
+  """, valueName: "path[:ro]"))
   var disk: [String] = []
 
+  @Option(name: [.customLong("rosetta")], help: ArgumentHelp(
+    "Attaches a Rosetta share to the guest Linux VM with a specific tag (e.g. --rosetta=\"rosetta\")",
+    discussion: """
+    Requires host to be macOS 13.0 (Ventura) with Rosetta installed. The latter can be done
+    by running "softwareupdate --install-rosetta" (without quotes) in the Terminal.app.
+
+    Note that you also have to configure Rosetta in the guest Linux VM by following the
+    steps from "Mount the Shared Directory and Register Rosetta" section here:
+    https://developer.apple.com/documentation/virtualization/running_intel_binaries_in_linux_vms_with_rosetta#3978496
+    """,
+    valueName: "tag"
+  ))
+  var rosettaTag: String?
+
   @Option(help: ArgumentHelp("""
-                             Additional directory shares with an optional read-only specifier\n(e.g. --dir=\"build:~/src/build\" --dir=\"sources:~/src/sources:ro\")
-                             """, discussion: """
-                                              Requires host to be macOS 13.0 (Ventura) or newer.
-                                              All shared directories are automatically mounted to "/Volumes/My Shared Files" directory on macOS,
-                                              while on Linux you have to do it manually: "mount -t virtiofs com.apple.virtio-fs.automount /mount/point".
-                                              For macOS guests, they must be running macOS 13.0 (Ventura) or newer.
-                                              """, valueName: "name:path[:ro]"))
+  Additional directory shares with an optional read-only specifier\n(e.g. --dir=\"build:~/src/build\" --dir=\"sources:~/src/sources:ro\")
+  """, discussion: """
+  Requires host to be macOS 13.0 (Ventura) or newer.
+  All shared directories are automatically mounted to "/Volumes/My Shared Files" directory on macOS,
+  while on Linux you have to do it manually: "mount -t virtiofs com.apple.virtio-fs.automount /mount/point".
+  For macOS guests, they must be running macOS 13.0 (Ventura) or newer.
+  """, valueName: "name:path[:ro]"))
   var dir: [String] = []
 
   @Option(help: ArgumentHelp("""
-                             Use bridged networking instead of the default shared (NAT) networking \n(e.g. --net-bridged=en0 or --net-bridged=\"Wi-Fi\")
-                             """, discussion: """
-                                              Specify "list" as an interface name (--net-bridged=list) to list the available bridged interfaces.
-                                              """, valueName: "interface name"))
+  Use bridged networking instead of the default shared (NAT) networking \n(e.g. --net-bridged=en0 or --net-bridged=\"Wi-Fi\")
+  """, discussion: """
+  Specify "list" as an interface name (--net-bridged=list) to list the available bridged interfaces.
+  """, valueName: "interface name"))
   var netBridged: String?
 
   @Flag(help: ArgumentHelp("Use software networking instead of the default shared (NAT) networking",
-          discussion: "Learn how to configure Softnet for use with Tart here: https://github.com/cirruslabs/softnet"))
+                           discussion: "Learn how to configure Softnet for use with Tart here: https://github.com/cirruslabs/softnet"))
   var netSoftnet: Bool = false
 
   func validate() throws {
@@ -90,11 +105,28 @@ struct Run: AsyncParsableCommand {
   @MainActor
   func run() async throws {
     let vmDir = try VMStorageLocal().open(name)
+
+    let additionalDiskAttachments = try additionalDiskAttachments()
+
+    // Error out if the disk is locked by the host (e.g. it was mounted in Finder),
+    // see https://github.com/cirruslabs/tart/issues/323 for more details.
+    for additionalDiskAttachment in additionalDiskAttachments {
+      // Read-only attachments do not seem to acquire the lock
+      if additionalDiskAttachment.isReadOnly {
+        continue
+      }
+
+      if try !FileLock(lockURL: additionalDiskAttachment.url).trylock() {
+        throw RuntimeError.DiskAlreadyInUse("disk \(additionalDiskAttachment.url.path) seems to be already in use, "
+          + "unmount it first in Finder")
+      }
+    }
+
     vm = try VM(
       vmDir: vmDir,
       network: userSpecifiedNetwork(vmDir: vmDir) ?? NetworkShared(),
-      additionalDiskAttachments: additionalDiskAttachments(),
-      directoryShares: directoryShares()
+      additionalDiskAttachments: additionalDiskAttachments,
+      directorySharingDevices: directoryShares() + rosettaDirectoryShare()
     )
 
     let vncImpl: VNC? = try {
@@ -122,8 +154,7 @@ struct Run: AsyncParsableCommand {
     // [1]: https://man.openbsd.org/fcntl
     let lock = try PIDLock(lockURL: vmDir.configURL)
     if try !lock.trylock() {
-      print("Virtual machine \"\(name)\" is already running!")
-      Foundation.exit(2)
+      throw RuntimeError.VMAlreadyRunning("VM \"\(name)\" is already running!")
     }
 
     let task = Task {
@@ -147,7 +178,12 @@ struct Run: AsyncParsableCommand {
 
         Foundation.exit(0)
       } catch {
+        // Capture the error into Sentry
+        SentrySDK.capture(error: error)
+        SentrySDK.flush(timeout: 2.seconds.timeInterval)
+
         print(error)
+
         Foundation.exit(1)
       }
     }
@@ -229,8 +265,22 @@ struct Run: AsyncParsableCommand {
     return result
   }
 
-  func directoryShares() throws -> [DirectoryShare] {
-    var result: [DirectoryShare] = []
+  func directoryShares() throws -> [VZDirectorySharingDeviceConfiguration] {
+    if dir.isEmpty {
+      return []
+    }
+
+    guard #available(macOS 13, *) else {
+      throw UnsupportedOSError("directory sharing", "is")
+    }
+
+    struct DirectoryShare {
+      let name: String
+      let path: URL
+      let readOnly: Bool
+    }
+
+    var directoryShares: [DirectoryShare] = []
 
     for rawDir in dir {
       let splits = rawDir.split(maxSplits: 2) { $0 == ":" }
@@ -251,10 +301,46 @@ struct Run: AsyncParsableCommand {
 
       let (name, path) = (String(splits[0]), String(splits[1]))
 
-      result.append(DirectoryShare(name: name, path: URL(fileURLWithPath: NSString(string: path).expandingTildeInPath), readOnly: readOnly))
+      directoryShares.append(DirectoryShare(
+        name: name,
+        path: URL(fileURLWithPath: NSString(string: path).expandingTildeInPath),
+        readOnly: readOnly)
+      )
     }
 
-    return result
+    var directories: [String : VZSharedDirectory] = Dictionary()
+    directoryShares.forEach { directories[$0.name] = VZSharedDirectory(url: $0.path, readOnly: $0.readOnly) }
+
+    let automountTag = VZVirtioFileSystemDeviceConfiguration.macOSGuestAutomountTag
+    let sharingDevice = VZVirtioFileSystemDeviceConfiguration(tag: automountTag)
+    sharingDevice.share = VZMultipleDirectoryShare(directories: directories)
+
+    return [sharingDevice]
+  }
+
+  private func rosettaDirectoryShare() throws -> [VZDirectorySharingDeviceConfiguration] {
+    guard let rosettaTag = rosettaTag else {
+      return []
+    }
+
+    guard #available(macOS 13, *) else {
+      throw UnsupportedOSError("Rosetta directory share", "is")
+    }
+
+    switch VZLinuxRosettaDirectoryShare.availability {
+    case .notInstalled:
+      throw UnsupportedOSError("Rosetta directory share", "is", "that have Rosetta installed")
+    case .notSupported:
+      throw UnsupportedOSError("Rosetta directory share", "is", "running Apple silicon")
+    default:
+      break
+    }
+
+    try VZVirtioFileSystemDeviceConfiguration.validateTag(rosettaTag)
+    let device = VZVirtioFileSystemDeviceConfiguration(tag: rosettaTag)
+    device.share = try VZLinuxRosettaDirectoryShare()
+
+    return [device]
   }
 
   private func runUI() {
@@ -275,16 +361,16 @@ struct Run: AsyncParsableCommand {
             }
           }.frame(width: CGFloat(vm!.config.display.width), height: CGFloat(vm!.config.display.height))
         }.commands {
-                  // Remove some standard menu options
-                  CommandGroup(replacing: .help, addition: {})
-                  CommandGroup(replacing: .newItem, addition: {})
-                  CommandGroup(replacing: .pasteboard, addition: {})
-                  CommandGroup(replacing: .textEditing, addition: {})
-                  CommandGroup(replacing: .undoRedo, addition: {})
-                  CommandGroup(replacing: .windowSize, addition: {})
-                  // Replace some standard menu options
-                  CommandGroup(replacing: .appInfo) { AboutTart() }
-                }
+          // Remove some standard menu options
+          CommandGroup(replacing: .help, addition: {})
+          CommandGroup(replacing: .newItem, addition: {})
+          CommandGroup(replacing: .pasteboard, addition: {})
+          CommandGroup(replacing: .textEditing, addition: {})
+          CommandGroup(replacing: .undoRedo, addition: {})
+          CommandGroup(replacing: .windowSize, addition: {})
+          // Replace some standard menu options
+          CommandGroup(replacing: .appInfo) { AboutTart() }
+        }
       }
     }
 

Sources/tart/Commands/Set.swift

@@ -11,7 +11,7 @@ struct Set: AsyncParsableCommand {
   var cpu: UInt16?
 
   @Option(help: "VM memory size in megabytes")
-  var memory: UInt16?
+  var memory: UInt64?
 
   @Option(help: "VM display resolution in a format of <width>x<height>. For example, 1200x800")
   var display: VMDisplayConfig?
@@ -20,38 +20,30 @@ struct Set: AsyncParsableCommand {
   var diskSize: UInt16?
 
   func run() async throws {
-    do {
-      let vmDir = try VMStorageLocal().open(name)
-      var vmConfig = try VMConfig(fromURL: vmDir.configURL)
+    let vmDir = try VMStorageLocal().open(name)
+    var vmConfig = try VMConfig(fromURL: vmDir.configURL)
 
-      if let cpu = cpu {
-        try vmConfig.setCPU(cpuCount: Int(cpu))
+    if let cpu = cpu {
+      try vmConfig.setCPU(cpuCount: Int(cpu))
+    }
+
+    if let memory = memory {
+      try vmConfig.setMemory(memorySize: memory * 1024 * 1024)
+    }
+
+    if let display = display {
+      if (display.width > 0) {
+        vmConfig.display.width = display.width
       }
-
-      if let memory = memory {
-        try vmConfig.setMemory(memorySize: UInt64(memory) * 1024 * 1024)
+      if (display.height > 0) {
+        vmConfig.display.height = display.height
       }
+    }
 
-      if let display = display {
-        if (display.width > 0) {
-          vmConfig.display.width = display.width
-        }
-        if (display.height > 0) {
-          vmConfig.display.height = display.height
-        }
-      }
+    try vmConfig.save(toURL: vmDir.configURL)
 
-      try vmConfig.save(toURL: vmDir.configURL)
-
-      if diskSize != nil {
-        try vmDir.resizeDisk(diskSize!)
-      }
-
-      Foundation.exit(0)
-    } catch {
-      print(error)
-
-      Foundation.exit(1)
+    if diskSize != nil {
+      try vmDir.resizeDisk(diskSize!)
     }
   }
 }

Sources/tart/Commands/Stop.swift

@@ -13,60 +13,48 @@ struct Stop: AsyncParsableCommand {
   var timeout: UInt64 = 30
 
   func run() async throws {
-    do {
-      let vmDir = try VMStorageLocal().open(name)
-      let lock = try PIDLock(lockURL: vmDir.configURL)
+    let vmDir = try VMStorageLocal().open(name)
+    let lock = try PIDLock(lockURL: vmDir.configURL)
 
-      // Find the VM's PID
-      var pid = try lock.pid()
+    // Find the VM's PID
+    var pid = try lock.pid()
+    if pid == 0 {
+      throw RuntimeError.VMNotRunning("VM \"\(name)\" is not running")
+    }
+
+    // Try to gracefully terminate the VM
+    //
+    // Note that we don't check the return code here
+    // to provide a clean exit from "tart stop" in cases
+    // when the VM is already shutting down and we hit
+    // a race condition.
+    //
+    // We check the return code in the kill(2) below, though,
+    // because it's a less common scenario and it would be
+    // nice to know for the user that we've tried all methods
+    // and failed to shutdown the VM.
+    kill(pid, SIGINT)
+
+    // Ensure that the VM has terminated
+    var gracefulWaitDuration = Measurement(value: Double(timeout), unit: UnitDuration.seconds)
+    let gracefulTickDuration = Measurement(value: Double(100), unit: UnitDuration.milliseconds)
+
+    while gracefulWaitDuration.value > 0 {
+      pid = try lock.pid()
       if pid == 0 {
-        print("VM \(name) is not running")
-
-        Foundation.exit(2)
+        return
       }
 
-      // Try to gracefully terminate the VM
-      //
-      // Note that we don't check the return code here
-      // to provide a clean exit from "tart stop" in cases
-      // when the VM is already shutting down and we hit
-      // a race condition.
-      //
-      // We check the return code in the kill(2) below, though,
-      // because it's a less common scenario and it would be
-      // nice to know for the user that we've tried all methods
-      // and failed to shutdown the VM.
-      kill(pid, SIGINT)
+      try await Task.sleep(nanoseconds: UInt64(gracefulTickDuration.converted(to: .nanoseconds).value))
+      gracefulWaitDuration = gracefulWaitDuration - gracefulTickDuration
+    }
 
-      // Ensure that the VM has terminated
-      var gracefulWaitDuration = Measurement(value: Double(timeout), unit: UnitDuration.seconds)
-      let gracefulTickDuration = Measurement(value: Double(100), unit: UnitDuration.milliseconds)
+    // Seems that VM is still running, proceed with forceful termination
+    let ret = kill(pid, SIGKILL)
+    if ret != 0 {
+      let details = Errno(rawValue: CInt(errno))
 
-      while gracefulWaitDuration.value > 0 {
-        pid = try lock.pid()
-        if pid == 0 {
-          Foundation.exit(0)
-        }
-
-        try await Task.sleep(nanoseconds: UInt64(gracefulTickDuration.converted(to: .nanoseconds).value))
-        gracefulWaitDuration = gracefulWaitDuration - gracefulTickDuration
-      }
-
-      // Seems that VM is still running, proceed with forceful termination
-      let ret = kill(pid, SIGKILL)
-      if ret != 0 {
-        let details = Errno(rawValue: CInt(errno))
-
-        print("failed to forcefully terminate the VM \(name): \(details)")
-
-        Foundation.exit(1)
-      }
-
-      Foundation.exit(0)
-    } catch {
-      print(error)
-
-      Foundation.exit(1)
+      throw RuntimeError.VMTerminationFailed("failed to forcefully terminate the VM \"\(name)\": \(details)")
     }
   }
 }

Sources/tart/Config.swift

@@ -12,8 +12,8 @@ struct Config {
       tartHomeDir = URL(fileURLWithPath: customTartHome)
     } else {
       tartHomeDir = FileManager.default
-              .homeDirectoryForCurrentUser
-              .appendingPathComponent(".tart", isDirectory: true)
+        .homeDirectoryForCurrentUser
+        .appendingPathComponent(".tart", isDirectory: true)
     }
     self.tartHomeDir = tartHomeDir
 
@@ -26,7 +26,7 @@ struct Config {
 
   func gc() throws {
     for entry in try FileManager.default.contentsOfDirectory(at: tartTmpDir,
-        includingPropertiesForKeys: [], options: []) {
+                                                             includingPropertiesForKeys: [], options: []) {
       let lock = try FileLock(lockURL: entry)
       if try !lock.trylock() {
         continue

Sources/tart/Credentials/CredentialsProvider.swift

@@ -1,10 +1,10 @@
 import Foundation
 
 enum CredentialsProviderError: Error {
-    case Failed(message: String)
+  case Failed(message: String)
 }
 
 protocol CredentialsProvider {
-    func retrieve(host: String) throws -> (String, String)?
-    func store(host: String, user: String, password: String) throws
+  func retrieve(host: String) throws -> (String, String)?
+  func store(host: String, user: String, password: String) throws
 }

Sources/tart/Credentials/DockerConfigCredentialsProvider.swift

@@ -22,14 +22,14 @@ class DockerConfigCredentialsProvider: CredentialsProvider {
     guard let executableURL = resolveBinaryPath(binaryName) else {
       throw CredentialsProviderError.Failed(message: "\(binaryName) not found in PATH")
     }
-    
+
     let process = Process.init()
     process.executableURL = executableURL
     process.arguments = ["get"]
 
     let outPipe = Pipe()
     let inPipe = Pipe()
-    
+
     process.standardOutput = outPipe
     process.standardError = outPipe
     process.standardInput = inPipe
@@ -38,7 +38,7 @@ class DockerConfigCredentialsProvider: CredentialsProvider {
 
     inPipe.fileHandleForWriting.write("\(host)\n".data(using: .utf8)!)
     inPipe.fileHandleForWriting.closeFile()
-    
+
     process.waitUntilExit()
 
     if !(process.terminationReason == .exit && process.terminationStatus == 0) {

Sources/tart/Credentials/KeychainCredentialsProvider.swift

@@ -1,66 +1,66 @@
 import Foundation
 
 class KeychainCredentialsProvider: CredentialsProvider {
-    func retrieve(host: String) throws -> (String, String)? {
-        let query: [String: Any] = [kSecClass as String: kSecClassInternetPassword,
-                                    kSecAttrProtocol as String: kSecAttrProtocolHTTPS,
-                                    kSecAttrServer as String: host,
-                                    kSecMatchLimit as String: kSecMatchLimitOne,
-                                    kSecReturnAttributes as String: true,
-                                    kSecReturnData as String: true,
-                                    kSecAttrLabel as String: "Tart Credentials",
-        ]
+  func retrieve(host: String) throws -> (String, String)? {
+    let query: [String: Any] = [kSecClass as String: kSecClassInternetPassword,
+                                kSecAttrProtocol as String: kSecAttrProtocolHTTPS,
+                                kSecAttrServer as String: host,
+                                kSecMatchLimit as String: kSecMatchLimitOne,
+                                kSecReturnAttributes as String: true,
+                                kSecReturnData as String: true,
+                                kSecAttrLabel as String: "Tart Credentials",
+    ]
 
-        var item: CFTypeRef?
-        let status = SecItemCopyMatching(query as CFDictionary, &item)
+    var item: CFTypeRef?
+    let status = SecItemCopyMatching(query as CFDictionary, &item)
 
-        if status != errSecSuccess {
-            if status == errSecItemNotFound {
-                return nil
-            }
+    if status != errSecSuccess {
+      if status == errSecItemNotFound {
+        return nil
+      }
 
-            throw CredentialsProviderError.Failed(message: "Keychain returned unsuccessful status \(status)")
-        }
-
-        guard let item = item as? [String: Any],
-              let user = item[kSecAttrAccount as String] as? String,
-              let passwordData = item[kSecValueData as String] as? Data,
-              let password = String(data: passwordData, encoding: .utf8)
-        else {
-            throw CredentialsProviderError.Failed(message: "Keychain item has unexpected format")
-        }
-
-        return (user, password)
+      throw CredentialsProviderError.Failed(message: "Keychain returned unsuccessful status \(status)")
     }
 
-    func store(host: String, user: String, password: String) throws {
-        let passwordData = password.data(using: .utf8)
-        let key: [String: Any] = [kSecClass as String: kSecClassInternetPassword,
-                                  kSecAttrProtocol as String: kSecAttrProtocolHTTPS,
-                                  kSecAttrServer as String: host,
-                                  kSecAttrLabel as String: "Tart Credentials",
-        ]
-        let value: [String: Any] = [kSecAttrAccount as String: user,
-                                    kSecValueData as String: passwordData,
-        ]
-
-        let status = SecItemCopyMatching(key as CFDictionary, nil)
-
-        switch status {
-        case errSecItemNotFound:
-            let status = SecItemAdd(key.merging(value) { (current, _) in current } as CFDictionary, nil)
-            if status != errSecSuccess {
-              throw CredentialsProviderError.Failed(message: "Keychain failed to add item: \(status.explanation())")
-            }
-        case errSecSuccess:
-            let status = SecItemUpdate(key as CFDictionary, value as CFDictionary)
-            if status != errSecSuccess {
-              throw CredentialsProviderError.Failed(message: "Keychain failed to update item: \(status.explanation())")
-            }
-        default:
-            throw CredentialsProviderError.Failed(message: "Keychain failed to find item: \(status.explanation())")
-        }
+    guard let item = item as? [String: Any],
+          let user = item[kSecAttrAccount as String] as? String,
+          let passwordData = item[kSecValueData as String] as? Data,
+          let password = String(data: passwordData, encoding: .utf8)
+    else {
+      throw CredentialsProviderError.Failed(message: "Keychain item has unexpected format")
     }
+
+    return (user, password)
+  }
+
+  func store(host: String, user: String, password: String) throws {
+    let passwordData = password.data(using: .utf8)
+    let key: [String: Any] = [kSecClass as String: kSecClassInternetPassword,
+                              kSecAttrProtocol as String: kSecAttrProtocolHTTPS,
+                              kSecAttrServer as String: host,
+                              kSecAttrLabel as String: "Tart Credentials",
+    ]
+    let value: [String: Any] = [kSecAttrAccount as String: user,
+                                kSecValueData as String: passwordData,
+    ]
+
+    let status = SecItemCopyMatching(key as CFDictionary, nil)
+
+    switch status {
+    case errSecItemNotFound:
+      let status = SecItemAdd(key.merging(value) { (current, _) in current } as CFDictionary, nil)
+      if status != errSecSuccess {
+        throw CredentialsProviderError.Failed(message: "Keychain failed to add item: \(status.explanation())")
+      }
+    case errSecSuccess:
+      let status = SecItemUpdate(key as CFDictionary, value as CFDictionary)
+      if status != errSecSuccess {
+        throw CredentialsProviderError.Failed(message: "Keychain failed to update item: \(status.explanation())")
+      }
+    default:
+      throw CredentialsProviderError.Failed(message: "Keychain failed to find item: \(status.explanation())")
+    }
+  }
 }
 
 extension OSStatus {

Sources/tart/FileLock.swift

@@ -2,47 +2,47 @@ import Foundation
 import System
 
 enum FileLockError: Error, Equatable {
-    case Failed(_ message: String)
-    case AlreadyLocked
+  case Failed(_ message: String)
+  case AlreadyLocked
 }
 
 class FileLock {
-    let url: URL
-    let fd: Int32
+  let url: URL
+  let fd: Int32
 
-    init(lockURL: URL) throws {
-        url = lockURL
-        fd = open(lockURL.path, 0)
+  init(lockURL: URL) throws {
+    url = lockURL
+    fd = open(lockURL.path, 0)
+  }
+
+  deinit {
+    close(fd)
+  }
+
+  func trylock() throws -> Bool {
+    try flockWrapper(LOCK_EX | LOCK_NB)
+  }
+
+  func lock() throws {
+    _ = try flockWrapper(LOCK_EX)
+  }
+
+  func unlock() throws {
+    _ = try flockWrapper(LOCK_UN)
+  }
+
+  func flockWrapper(_ operation: Int32) throws -> Bool {
+    let ret = flock(fd, operation)
+    if ret != 0 {
+      let details = Errno(rawValue: CInt(errno))
+
+      if (operation & LOCK_NB) != 0 && details == .wouldBlock {
+        return false
+      }
+
+      throw FileLockError.Failed("failed to lock \(url): \(details)")
     }
 
-    deinit {
-        close(fd)
-    }
-
-    func trylock() throws -> Bool {
-        try flockWrapper(LOCK_EX | LOCK_NB)
-    }
-
-    func lock() throws {
-        _ = try flockWrapper(LOCK_EX)
-    }
-
-    func unlock() throws {
-        _ = try flockWrapper(LOCK_UN)
-    }
-
-    func flockWrapper(_ operation: Int32) throws -> Bool {
-        let ret = flock(fd, operation)
-        if ret != 0 {
-            let details = Errno(rawValue: CInt(errno))
-
-            if (operation & LOCK_NB) != 0 && details == .wouldBlock {
-                return false
-            }
-
-            throw FileLockError.Failed("failed to lock \(url): \(details)")
-        }
-
-        return true
-    }
+    return true
+  }
 }

Sources/tart/IPSWCache.swift

@@ -15,6 +15,6 @@ class IPSWCache: PrunableStorage {
 
   func prunables() throws -> [Prunable] {
     try FileManager.default.contentsOfDirectory(at: baseURL, includingPropertiesForKeys: nil)
-            .filter { $0.lastPathComponent.hasSuffix(".ipsw")}
+      .filter { $0.lastPathComponent.hasSuffix(".ipsw")}
   }
 }

Sources/tart/MACAddressResolver/ARPCache.swift

@@ -3,117 +3,124 @@ import Network
 import Virtualization
 
 struct ARPCommandFailedError: Error, CustomStringConvertible {
-    var terminationReason: Process.TerminationReason
-    var terminationStatus: Int32
+  var terminationReason: Process.TerminationReason
+  var terminationStatus: Int32
 
-    var description: String {
-        var reason: String
+  var description: String {
+    var reason: String
 
-        switch terminationReason {
-        case .exit:
-            reason = "exit code \(terminationStatus)"
-        case .uncaughtSignal:
-            reason = "uncaught signal"
-        default:
-            reason = "unknown reason"
-        }
-
-        return "arp command failed: \(reason)"
+    switch terminationReason {
+    case .exit:
+      reason = "exit code \(terminationStatus)"
+    case .uncaughtSignal:
+      reason = "uncaught signal"
+    default:
+      reason = "unknown reason"
     }
+
+    return "arp command failed: \(reason)"
+  }
 }
 
 struct ARPCommandYieldedInvalidOutputError: Error, CustomStringConvertible {
-    var explanation: String
+  var explanation: String
 
-    var description: String {
-        "arp command yielded invalid output: \(explanation)"
-    }
+  var description: String {
+    "arp command yielded invalid output: \(explanation)"
+  }
 }
 
 struct ARPCacheInternalError: Error, CustomStringConvertible {
-    var explanation: String
+  var explanation: String
 
-    var description: String {
-        "ARPCache internal error: \(explanation)"
-    }
+  var description: String {
+    "ARPCache internal error: \(explanation)"
+  }
 }
 
 struct ARPCache {
-    static func ResolveMACAddress(macAddress: MACAddress, bridgeOnly: Bool = true) throws -> IPv4Address? {
-        let process = Process.init()
-        process.executableURL = URL.init(fileURLWithPath: "/usr/sbin/arp")
-        process.arguments = ["-an"]
+  let arpCommandOutput: Data
 
-        let pipe = Pipe()
-        process.standardOutput = pipe
-        process.standardError = pipe
-        process.standardInput = FileHandle.nullDevice
+  init() throws {
+    let process = Process.init()
+    process.executableURL = URL.init(fileURLWithPath: "/usr/sbin/arp")
+    process.arguments = ["-an"]
 
-        try process.run()
-        process.waitUntilExit()
+    let pipe = Pipe()
+    process.standardOutput = pipe
+    process.standardError = pipe
+    process.standardInput = FileHandle.nullDevice
 
-        if !(process.terminationReason == .exit && process.terminationStatus == 0) {
-            throw ARPCommandFailedError(
-                    terminationReason: process.terminationReason,
-                    terminationStatus: process.terminationStatus)
-        }
+    try process.run()
+    process.waitUntilExit()
 
-        guard let rawLines = try pipe.fileHandleForReading.readToEnd() else {
-            throw ARPCommandYieldedInvalidOutputError(explanation: "empty output")
-        }
-        let lines = String(decoding: rawLines, as: UTF8.self)
-                .trimmingCharacters(in: .whitespacesAndNewlines)
-                .components(separatedBy: "\n")
-
-        // Based on https://opensource.apple.com/source/network_cmds/network_cmds-606.40.2/arp.tproj/arp.c.auto.html
-        let regex = try NSRegularExpression(pattern: #"^.* \((?<ip>.*)\) at (?<mac>.*) on (?<interface>.*) .*$"#)
-
-        for line in lines {
-            let nsLineRange = NSRange(line.startIndex..<line.endIndex, in: line)
-
-            guard let match = regex.firstMatch(in: line, range: nsLineRange) else {
-                throw ARPCommandYieldedInvalidOutputError(explanation: "unparseable entry \"\(line)\"")
-            }
-
-            let rawIP = try match.getCaptureGroup(name: "ip", for: line)
-            guard let ip = IPv4Address(rawIP) else {
-                throw ARPCommandYieldedInvalidOutputError(explanation: "failed to parse IPv4 address \(rawIP)")
-            }
-
-            let rawMAC = try match.getCaptureGroup(name: "mac", for: line)
-            if rawMAC == "(incomplete)" {
-                continue
-            }
-            guard let mac = MACAddress(fromString: rawMAC) else {
-                throw ARPCommandYieldedInvalidOutputError(explanation: "failed to parse MAC address \(rawMAC)")
-            }
-
-            let interface = try match.getCaptureGroup(name: "interface", for: line)
-            if bridgeOnly && !interface.starts(with: "bridge") {
-                continue
-            }
-
-            if macAddress == mac {
-                return ip
-            }
-        }
-
-        return nil
+    if !(process.terminationReason == .exit && process.terminationStatus == 0) {
+      throw ARPCommandFailedError(
+        terminationReason: process.terminationReason,
+        terminationStatus: process.terminationStatus)
     }
+
+    guard let arpCommandOutput = try pipe.fileHandleForReading.readToEnd() else {
+      throw ARPCommandYieldedInvalidOutputError(explanation: "empty output")
+    }
+
+    self.arpCommandOutput = arpCommandOutput
+  }
+
+  func ResolveMACAddress(macAddress: MACAddress, bridgeOnly: Bool = true) throws -> IPv4Address? {
+    let lines = String(decoding: arpCommandOutput, as: UTF8.self)
+      .trimmingCharacters(in: .whitespacesAndNewlines)
+      .components(separatedBy: "\n")
+
+    // Based on https://opensource.apple.com/source/network_cmds/network_cmds-606.40.2/arp.tproj/arp.c.auto.html
+    let regex = try NSRegularExpression(pattern: #"^.* \((?<ip>.*)\) at (?<mac>.*) on (?<interface>.*) .*$"#)
+
+    for line in lines {
+      let nsLineRange = NSRange(line.startIndex..<line.endIndex, in: line)
+
+      guard let match = regex.firstMatch(in: line, range: nsLineRange) else {
+        throw ARPCommandYieldedInvalidOutputError(explanation: "unparseable entry \"\(line)\"")
+      }
+
+      let rawIP = try match.getCaptureGroup(name: "ip", for: line)
+      guard let ip = IPv4Address(rawIP) else {
+        throw ARPCommandYieldedInvalidOutputError(explanation: "failed to parse IPv4 address \(rawIP)")
+      }
+
+      let rawMAC = try match.getCaptureGroup(name: "mac", for: line)
+      if rawMAC == "(incomplete)" {
+        continue
+      }
+      guard let mac = MACAddress(fromString: rawMAC) else {
+        throw ARPCommandYieldedInvalidOutputError(explanation: "failed to parse MAC address \(rawMAC)")
+      }
+
+      let interface = try match.getCaptureGroup(name: "interface", for: line)
+      if bridgeOnly && !interface.starts(with: "bridge") {
+        continue
+      }
+
+      if macAddress == mac {
+        return ip
+      }
+    }
+
+    return nil
+  }
 }
 
 extension NSTextCheckingResult {
-    func getCaptureGroup(name: String, for string: String) throws -> String {
-        let nsRange = self.range(withName: name)
+  func getCaptureGroup(name: String, for string: String) throws -> String {
+    let nsRange = self.range(withName: name)
 
-        if nsRange.location == NSNotFound {
-            throw ARPCacheInternalError(explanation: "attempted to retrieve non-existent named capture group \(name)")
-        }
-
-        guard let range = Range.init(nsRange, in: string) else {
-            throw ARPCacheInternalError(explanation: "failed to convert NSRange to Range")
-        }
-
-        return String(string[range])
+    if nsRange.location == NSNotFound {
+      throw ARPCacheInternalError(explanation: "attempted to retrieve non-existent named capture group \(name)")
     }
+
+    guard let range = Range.init(nsRange, in: string) else {
+      throw ARPCacheInternalError(explanation: "failed to convert NSRange to Range")
+    }
+
+    return String(string[range])
+  }
 }

Sources/tart/Network/NetworkBridged.swift

@@ -2,21 +2,21 @@ import Foundation
 import Virtualization
 
 class NetworkBridged: Network {
-    let interface: VZBridgedNetworkInterface
+  let interface: VZBridgedNetworkInterface
 
-    init(interface: VZBridgedNetworkInterface) {
-        self.interface = interface
-    }
+  init(interface: VZBridgedNetworkInterface) {
+    self.interface = interface
+  }
 
-    func attachment() -> VZNetworkDeviceAttachment {
-        VZBridgedNetworkDeviceAttachment(interface: interface)
-    }
+  func attachment() -> VZNetworkDeviceAttachment {
+    VZBridgedNetworkDeviceAttachment(interface: interface)
+  }
 
-    func run(_ sema: DispatchSemaphore) throws {
-        // no-op, only used for Softnet
-    }
+  func run(_ sema: DispatchSemaphore) throws {
+    // no-op, only used for Softnet
+  }
 
-    func stop() async throws {
-        // no-op, only used for Softnet
-    }
+  func stop() async throws {
+    // no-op, only used for Softnet
+  }
 }

Sources/tart/Network/NetworkShared.swift

@@ -2,15 +2,15 @@ import Foundation
 import Virtualization
 
 class NetworkShared: Network {
-    func attachment() -> VZNetworkDeviceAttachment {
-        VZNATNetworkDeviceAttachment()
-    }
+  func attachment() -> VZNetworkDeviceAttachment {
+    VZNATNetworkDeviceAttachment()
+  }
 
-    func run(_ sema: DispatchSemaphore) throws {
-        // no-op, only used for Softnet
-    }
+  func run(_ sema: DispatchSemaphore) throws {
+    // no-op, only used for Softnet
+  }
 
-    func stop() async throws {
-        // no-op, only used for Softnet
-    }
+  func stop() async throws {
+    // no-op, only used for Softnet
+  }
 }

Sources/tart/Network/Softnet.swift

@@ -69,15 +69,19 @@ class Softnet: Network {
   }
 
   private func setSocketBuffers(_ fd: Int32, _ sizeBytes: Int) throws {
-    var option_value = sizeBytes
     let option_len = socklen_t(MemoryLayout<Int>.size)
 
-    var ret = setsockopt(fd, SOL_SOCKET, SO_RCVBUF, &option_value, option_len)
+    // The system expects the value of SO_RCVBUF to be at least double the value of SO_SNDBUF,
+    // and for optimal performance, the recommended value of SO_RCVBUF is four times the value of SO_SNDBUF.
+    // See: https://developer.apple.com/documentation/virtualization/vzfilehandlenetworkdeviceattachment/3969266-maximumtransmissionunit
+    var receiveBufferSize = 4 * sizeBytes
+    var ret = setsockopt(fd, SOL_SOCKET, SO_RCVBUF, &receiveBufferSize, option_len)
     if ret != 0 {
       throw SoftnetError.InitializationFailed(why: "setsockopt(SO_RCVBUF) returned \(ret)")
     }
 
-    ret = setsockopt(fd, SOL_SOCKET, SO_SNDBUF, &option_value, option_len)
+    var sendBufferSize = sizeBytes
+    ret = setsockopt(fd, SOL_SOCKET, SO_SNDBUF, &sendBufferSize, option_len)
     if ret != 0 {
       throw SoftnetError.InitializationFailed(why: "setsockopt(SO_SNDBUF) returned \(ret)")
     }

Sources/tart/OCI/Digest.swift

@@ -20,8 +20,8 @@ class Digest {
 extension SHA256.Digest {
   func hexdigest() -> String {
     "sha256:" + self.map {
-              String(format: "%02x", $0)
-            }
-            .joined()
+      String(format: "%02x", $0)
+    }
+    .joined()
   }
 }

Sources/tart/OCI/Registry.swift

@@ -130,11 +130,11 @@ class Registry {
     let manifestJSON = try manifest.toJSON()
 
     let (data, response) = try await dataRequest(.PUT, endpointURL("\(namespace)/manifests/\(reference)"),
-      headers: ["Content-Type": manifest.mediaType],
-      body: manifestJSON)
+                                                 headers: ["Content-Type": manifest.mediaType],
+                                                 body: manifestJSON)
     if response.statusCode != HTTPCode.Created.rawValue {
       throw RegistryError.UnexpectedHTTPStatusCode(when: "pushing manifest", code: response.statusCode,
-        details: data.asText())
+                                                   details: data.asText())
     }
 
     return Digest.hash(manifestJSON)
@@ -142,10 +142,10 @@ class Registry {
 
   public func pullManifest(reference: String) async throws -> (OCIManifest, Data) {
     let (data, response) = try await dataRequest(.GET, endpointURL("\(namespace)/manifests/\(reference)"),
-      headers: ["Accept": ociManifestMediaType])
+                                                 headers: ["Accept": ociManifestMediaType])
     if response.statusCode != HTTPCode.Ok.rawValue {
       throw RegistryError.UnexpectedHTTPStatusCode(when: "pulling manifest", code: response.statusCode,
-        details: data.asText())
+                                                   details: data.asText())
     }
 
     let manifest = try OCIManifest(fromJSON: data)
@@ -168,17 +168,17 @@ class Registry {
   public func pushBlob(fromData: Data, chunkSizeMb: Int = 0) async throws -> String {
     // Initiate a blob upload
     let (data, postResponse) = try await dataRequest(.POST, endpointURL("\(namespace)/blobs/uploads/"),
-      headers: ["Content-Length": "0"])
+                                                     headers: ["Content-Length": "0"])
     if postResponse.statusCode != HTTPCode.Accepted.rawValue {
       throw RegistryError.UnexpectedHTTPStatusCode(when: "pushing blob (POST)", code: postResponse.statusCode,
-        details: data.asText())
+                                                   details: data.asText())
     }
 
     // Figure out where to upload the blob
     var uploadLocation = try uploadLocationFromResponse(postResponse)
 
     let digest = Digest.hash(fromData)
-    
+
     if chunkSizeMb == 0 {
       // monolithic upload
       let (data, response) = try await dataRequest(
@@ -192,7 +192,7 @@ class Registry {
       )
       if response.statusCode != HTTPCode.Created.rawValue {
         throw RegistryError.UnexpectedHTTPStatusCode(when: "pushing blob (PUT) to \(uploadLocation)",
-          code: response.statusCode, details: data.asText())
+                                                     code: response.statusCode, details: data.asText())
       }
       return digest
     }
@@ -215,13 +215,13 @@ class Registry {
       // always accept both statuses since AWS ECR is not following specification
       if response.statusCode != HTTPCode.Created.rawValue && response.statusCode != HTTPCode.Accepted.rawValue {
         throw RegistryError.UnexpectedHTTPStatusCode(when: "streaming blob to \(uploadLocation)",
-          code: response.statusCode, details: data.asText())
+                                                     code: response.statusCode, details: data.asText())
       }
       uploadedBytes += chunk.count
       // Update location for the next chunk
       uploadLocation = try uploadLocationFromResponse(response)
     }
-    
+
     return digest
   }
 
@@ -230,7 +230,7 @@ class Registry {
     if response.statusCode != HTTPCode.Ok.rawValue {
       let body = try await channel.asData().asText()
       throw RegistryError.UnexpectedHTTPStatusCode(when: "pulling blob", code: response.statusCode,
-        details: body)
+                                                   details: body)
     }
 
     for try await part in channel {
@@ -247,15 +247,15 @@ class Registry {
   }
 
   private func dataRequest(
-          _ method: HTTPMethod,
-          _ urlComponents: URLComponents,
-          headers: Dictionary<String, String> = Dictionary(),
-          parameters: Dictionary<String, String> = Dictionary(),
-          body: Data? = nil,
-          doAuth: Bool = true
+    _ method: HTTPMethod,
+    _ urlComponents: URLComponents,
+    headers: Dictionary<String, String> = Dictionary(),
+    parameters: Dictionary<String, String> = Dictionary(),
+    body: Data? = nil,
+    doAuth: Bool = true
   ) async throws -> (Data, HTTPURLResponse) {
     let (channel, response) = try await channelRequest(method, urlComponents,
-            headers: headers, parameters: parameters, body: body, doAuth: doAuth)
+                                                       headers: headers, parameters: parameters, body: body, doAuth: doAuth)
 
     return (try await channel.asData(), response)
   }
@@ -312,15 +312,15 @@ class Registry {
 
     let wwwAuthenticate = try WWWAuthenticate(rawHeaderValue: wwwAuthenticateRaw)
 
-    if wwwAuthenticate.scheme == "Basic" {
-      if let (user, password) = try lookupCredentials(host: baseURL.host!) {
+    if wwwAuthenticate.scheme.lowercased() == "basic" {
+      if let (user, password) = try lookupCredentials() {
         currentAuthToken = BasicAuthentication(user: user, password: password)
       }
 
       return
     }
 
-    if wwwAuthenticate.scheme != "Bearer" {
+    if wwwAuthenticate.scheme.lowercased() != "bearer" {
       throw RegistryError.AuthFailed(why: "WWW-Authenticate header's authentication scheme "
         + "\"\(wwwAuthenticate.scheme)\" is unsupported, expected \"Bearer\" scheme")
     }
@@ -350,7 +350,7 @@ class Registry {
 
     var headers: Dictionary<String, String> = Dictionary()
 
-    if let (user, password) = try lookupCredentials(host: baseURL.host!) {
+    if let (user, password) = try lookupCredentials() {
       let encodedCredentials = "\(user):\(password)".data(using: .utf8)?.base64EncodedString()
       headers["Authorization"] = "Basic \(encodedCredentials!)"
     }
@@ -364,7 +364,13 @@ class Registry {
     currentAuthToken = try TokenResponse.parse(fromData: data)
   }
 
-  private func lookupCredentials(host: String) throws -> (String, String)? {
+  private func lookupCredentials() throws -> (String, String)? {
+    var host = baseURL.host!
+
+    if let port = baseURL.port {
+      host += ":\(port)"
+    }
+
     for provider in credentialsProviders {
       if let (user, password) = try provider.retrieve(host: host) {
         return (user, password)

Sources/tart/OCI/RemoteName.swift

@@ -106,7 +106,7 @@ struct RemoteName: Comparable, Hashable, CustomStringConvertible {
     try ParseTreeWalker().walk(referenceCollector, try parser.root())
 
     if let error = errorCollector.error {
-      throw RuntimeError("failed to parse remote name: \(error)")
+      throw RuntimeError.FailedToParseRemoteName("\(error)")
     }
 
     host = referenceCollector.host!
@@ -120,7 +120,7 @@ struct RemoteName: Comparable, Hashable, CustomStringConvertible {
       } else if reference.starts(with: ":") {
         self.reference = Reference(tag: String(reference.dropFirst(1)))
       } else {
-        throw RuntimeError("failed to parse remote name: unknown reference format")
+        throw RuntimeError.FailedToParseRemoteName("unknown reference format")
       }
     } else {
       self.reference = Reference(tag: "latest")

Sources/tart/PIDLock.swift

@@ -44,7 +44,7 @@ class PIDLock {
 
       let details = Errno(rawValue: CInt(errno))
 
-      throw RuntimeError("\(message): \(details)")
+      throw RuntimeError.PIDLockFailed("\(message): \(details)")
     }
 
     return (true, result)

Sources/tart/Passphrase/PassphraseGenerator.swift

@@ -1,13 +1,13 @@
 import Foundation
 
 struct PassphraseGenerator: Sequence {
-    func makeIterator() -> PassphraseIterator {
-        PassphraseIterator()
-    }
+  func makeIterator() -> PassphraseIterator {
+    PassphraseIterator()
+  }
 }
 
 struct PassphraseIterator: IteratorProtocol {
-    mutating func next() -> String? {
-        passphrases[Int(arc4random_uniform(UInt32(passphrases.count)))]
-    }
+  mutating func next() -> String? {
+    passphrases[Int(arc4random_uniform(UInt32(passphrases.count)))]
+  }
 }

Sources/tart/Platform/Architecture.swift

@@ -1,14 +1,14 @@
 import Foundation
 
 enum Architecture: String, Codable {
-    case arm64
-    case amd64
+  case arm64
+  case amd64
 }
 
 func CurrentArchitecture() -> Architecture {
-    #if arch(arm64)
-        return .arm64
-    #elseif arch(x86_64)
-        return .amd64
-    #endif
+  #if arch(arm64)
+    return .arm64
+  #elseif arch(x86_64)
+    return .amd64
+  #endif
 }

Sources/tart/Platform/Darwin.swift

@@ -1,97 +1,97 @@
 import Virtualization
 
 struct Darwin: Platform {
-    var ecid: VZMacMachineIdentifier
-    var hardwareModel: VZMacHardwareModel
+  var ecid: VZMacMachineIdentifier
+  var hardwareModel: VZMacHardwareModel
 
-    init(ecid: VZMacMachineIdentifier, hardwareModel: VZMacHardwareModel) {
-        self.ecid = ecid
-        self.hardwareModel = hardwareModel
+  init(ecid: VZMacMachineIdentifier, hardwareModel: VZMacHardwareModel) {
+    self.ecid = ecid
+    self.hardwareModel = hardwareModel
+  }
+
+  init(from decoder: Decoder) throws {
+    let container = try decoder.container(keyedBy: CodingKeys.self)
+
+    let encodedECID = try container.decode(String.self, forKey: .ecid)
+    guard let data = Data.init(base64Encoded: encodedECID) else {
+      throw DecodingError.dataCorruptedError(forKey: .ecid,
+                                             in: container,
+                                             debugDescription: "failed to initialize Data using the provided value")
+    }
+    guard let ecid = VZMacMachineIdentifier.init(dataRepresentation: data) else {
+      throw DecodingError.dataCorruptedError(forKey: .ecid,
+                                             in: container,
+                                             debugDescription: "failed to initialize VZMacMachineIdentifier using the provided value")
+    }
+    self.ecid = ecid
+
+    let encodedHardwareModel = try container.decode(String.self, forKey: .hardwareModel)
+    guard let data = Data.init(base64Encoded: encodedHardwareModel) else {
+      throw DecodingError.dataCorruptedError(forKey: .hardwareModel, in: container, debugDescription: "")
+    }
+    guard let hardwareModel = VZMacHardwareModel.init(dataRepresentation: data) else {
+      throw DecodingError.dataCorruptedError(forKey: .hardwareModel, in: container, debugDescription: "")
+    }
+    self.hardwareModel = hardwareModel
+  }
+
+  func encode(to encoder: Encoder) throws {
+    var container = encoder.container(keyedBy: CodingKeys.self)
+
+    try container.encode(ecid.dataRepresentation.base64EncodedString(), forKey: .ecid)
+    try container.encode(hardwareModel.dataRepresentation.base64EncodedString(), forKey: .hardwareModel)
+  }
+
+  func os() -> OS {
+    .darwin
+  }
+
+  func bootLoader(nvramURL: URL) throws -> VZBootLoader {
+    VZMacOSBootLoader()
+  }
+
+  func platform(nvramURL: URL) -> VZPlatformConfiguration {
+    let result = VZMacPlatformConfiguration()
+
+    result.machineIdentifier = ecid
+    result.auxiliaryStorage = VZMacAuxiliaryStorage(contentsOf: nvramURL)
+    result.hardwareModel = hardwareModel
+
+    return result
+  }
+
+  func graphicsDevice(vmConfig: VMConfig) -> VZGraphicsDeviceConfiguration {
+    let result = VZMacGraphicsDeviceConfiguration()
+
+    if let hostMainScreen = NSScreen.main {
+      let vmScreenSize = NSSize(width: vmConfig.display.width, height: vmConfig.display.height)
+      result.displays = [
+        VZMacGraphicsDisplayConfiguration(for: hostMainScreen, sizeInPoints: vmScreenSize)
+      ]
+
+      return result
     }
 
-    init(from decoder: Decoder) throws {
-        let container = try decoder.container(keyedBy: CodingKeys.self)
+    result.displays = [
+      VZMacGraphicsDisplayConfiguration(
+        widthInPixels: vmConfig.display.width,
+        heightInPixels: vmConfig.display.height,
+        // A reasonable guess according to Apple's documentation[1]
+        // [1]: https://developer.apple.com/documentation/coregraphics/1456599-cgdisplayscreensize
+        pixelsPerInch: 72
+      )
+    ]
 
-        let encodedECID = try container.decode(String.self, forKey: .ecid)
-        guard let data = Data.init(base64Encoded: encodedECID) else {
-            throw DecodingError.dataCorruptedError(forKey: .ecid,
-                    in: container,
-                    debugDescription: "failed to initialize Data using the provided value")
-        }
-        guard let ecid = VZMacMachineIdentifier.init(dataRepresentation: data) else {
-            throw DecodingError.dataCorruptedError(forKey: .ecid,
-                    in: container,
-                    debugDescription: "failed to initialize VZMacMachineIdentifier using the provided value")
-        }
-        self.ecid = ecid
+    return result
+  }
 
-        let encodedHardwareModel = try container.decode(String.self, forKey: .hardwareModel)
-        guard let data = Data.init(base64Encoded: encodedHardwareModel) else {
-            throw DecodingError.dataCorruptedError(forKey: .hardwareModel, in: container, debugDescription: "")
-        }
-        guard let hardwareModel = VZMacHardwareModel.init(dataRepresentation: data) else {
-            throw DecodingError.dataCorruptedError(forKey: .hardwareModel, in: container, debugDescription: "")
-        }
-        self.hardwareModel = hardwareModel
-    }
-
-    func encode(to encoder: Encoder) throws {
-        var container = encoder.container(keyedBy: CodingKeys.self)
-
-        try container.encode(ecid.dataRepresentation.base64EncodedString(), forKey: .ecid)
-        try container.encode(hardwareModel.dataRepresentation.base64EncodedString(), forKey: .hardwareModel)
-    }
-
-    func os() -> OS {
-        .darwin
-    }
-
-    func bootLoader(nvramURL: URL) throws -> VZBootLoader {
-        VZMacOSBootLoader()
-    }
-
-    func platform(nvramURL: URL) -> VZPlatformConfiguration {
-        let result = VZMacPlatformConfiguration()
-
-        result.machineIdentifier = ecid
-        result.auxiliaryStorage = VZMacAuxiliaryStorage(contentsOf: nvramURL)
-        result.hardwareModel = hardwareModel
-
-        return result
-    }
-
-    func graphicsDevice(vmConfig: VMConfig) -> VZGraphicsDeviceConfiguration {
-        let result = VZMacGraphicsDeviceConfiguration()
-
-        if let hostMainScreen = NSScreen.main {
-            let vmScreenSize = NSSize(width: vmConfig.display.width, height: vmConfig.display.height)
-            result.displays = [
-                VZMacGraphicsDisplayConfiguration(for: hostMainScreen, sizeInPoints: vmScreenSize)
-            ]
-
-            return result
-        }
-
-        result.displays = [
-            VZMacGraphicsDisplayConfiguration(
-                    widthInPixels: vmConfig.display.width,
-                    heightInPixels: vmConfig.display.height,
-                    // A reasonable guess according to Apple's documentation[1]
-                    // [1]: https://developer.apple.com/documentation/coregraphics/1456599-cgdisplayscreensize
-                    pixelsPerInch: 72
-            )
-        ]
-
-        return result
-    }
-
-    func pointingDevices() -> [VZPointingDeviceConfiguration] {
-        if #available(macOS 13, *) {
-            // Trackpad is only supported starting with macOS Ventura
-            // macOS Monterey will continue using a USB device == .darwin 
-            return [VZMacTrackpadConfiguration(), VZUSBScreenCoordinatePointingDeviceConfiguration()]
-        } else {
-            return [VZUSBScreenCoordinatePointingDeviceConfiguration()]
-        }
+  func pointingDevices() -> [VZPointingDeviceConfiguration] {
+    if #available(macOS 13, *) {
+      // Trackpad is only supported starting with macOS Ventura
+      // macOS Monterey will continue using a USB device == .darwin 
+      return [VZMacTrackpadConfiguration(), VZUSBScreenCoordinatePointingDeviceConfiguration()]
+    } else {
+      return [VZUSBScreenCoordinatePointingDeviceConfiguration()]
     }
+  }
 }

Sources/tart/Platform/Linux.swift

@@ -2,36 +2,36 @@ import Virtualization
 
 @available(macOS 13, *)
 struct Linux: Platform {
-    func os() -> OS {
-        .linux
-    }
+  func os() -> OS {
+    .linux
+  }
 
-    func bootLoader(nvramURL: URL) throws -> VZBootLoader {
-        let result = VZEFIBootLoader()
+  func bootLoader(nvramURL: URL) throws -> VZBootLoader {
+    let result = VZEFIBootLoader()
 
-        result.variableStore = VZEFIVariableStore(url: nvramURL)
+    result.variableStore = VZEFIVariableStore(url: nvramURL)
 
-        return result
-    }
+    return result
+  }
 
-    func platform(nvramURL: URL) -> VZPlatformConfiguration {
-        VZGenericPlatformConfiguration()
-    }
+  func platform(nvramURL: URL) -> VZPlatformConfiguration {
+    VZGenericPlatformConfiguration()
+  }
 
-    func graphicsDevice(vmConfig: VMConfig) -> VZGraphicsDeviceConfiguration {
-        let result = VZVirtioGraphicsDeviceConfiguration()
+  func graphicsDevice(vmConfig: VMConfig) -> VZGraphicsDeviceConfiguration {
+    let result = VZVirtioGraphicsDeviceConfiguration()
 
-        result.scanouts = [
-            VZVirtioGraphicsScanoutConfiguration(
-                    widthInPixels: vmConfig.display.width,
-                    heightInPixels: vmConfig.display.height
-            )
-        ]
+    result.scanouts = [
+      VZVirtioGraphicsScanoutConfiguration(
+        widthInPixels: vmConfig.display.width,
+        heightInPixels: vmConfig.display.height
+      )
+    ]
 
-        return result
-    }
+    return result
+  }
 
-    func pointingDevices() -> [VZPointingDeviceConfiguration] {
-        [VZUSBScreenCoordinatePointingDeviceConfiguration()]
-    }
+  func pointingDevices() -> [VZPointingDeviceConfiguration] {
+    [VZUSBScreenCoordinatePointingDeviceConfiguration()]
+  }
 }

Sources/tart/Platform/OS.swift

@@ -1,6 +1,6 @@
 import Virtualization
 
 enum OS: String, Codable {
-    case darwin
-    case linux
+  case darwin
+  case linux
 }

Sources/tart/Platform/Platform.swift

@@ -1,9 +1,9 @@
 import Virtualization
 
 protocol Platform: Codable {
-    func os() -> OS
-    func bootLoader(nvramURL: URL) throws -> VZBootLoader
-    func platform(nvramURL: URL) -> VZPlatformConfiguration
-    func graphicsDevice(vmConfig: VMConfig) -> VZGraphicsDeviceConfiguration
-    func pointingDevices() -> [VZPointingDeviceConfiguration]
+  func os() -> OS
+  func bootLoader(nvramURL: URL) throws -> VZBootLoader
+  func platform(nvramURL: URL) -> VZPlatformConfiguration
+  func graphicsDevice(vmConfig: VMConfig) -> VZGraphicsDeviceConfiguration
+  func pointingDevices() -> [VZPointingDeviceConfiguration]
 }

Sources/tart/Root.swift

@@ -1,13 +1,14 @@
 import ArgumentParser
 import Foundation
 import Puppy
+import Sentry
 
 var puppy = Puppy.default
 
 class LogFormatter: LogFormattable {
-    func formatMessage(_ level: LogLevel, message: String, tag: String, function: String, file: String, line: UInt, swiftLogInfo: [String: String], label: String, date: Date, threadID: UInt64) -> String {
-        "\(date) \(level) \(message)"
-    }
+  func formatMessage(_ level: LogLevel, message: String, tag: String, function: String, file: String, line: UInt, swiftLogInfo: [String: String], label: String, date: Date, threadID: UInt64) -> String {
+    "\(date) \(level) \(message)"
+  }
 }
 
 @main
@@ -33,6 +34,35 @@ struct Root: AsyncParsableCommand {
     ])
 
   public static func main() async throws {
+    // Initialize Sentry
+    if let dsn = ProcessInfo.processInfo.environment["SENTRY_DSN"] {
+      SentrySDK.start { options in
+        options.dsn = dsn
+        options.releaseName = CI.release
+        options.tracesSampleRate = Float(
+          ProcessInfo.processInfo.environment["SENTRY_TRACES_SAMPLE_RATE"] ?? "1.0"
+        ) as NSNumber?
+
+        // By default only 5XX are captured
+        // Let's capture everything but 401 (unauthorized)
+        options.enableCaptureFailedRequests = true
+        options.failedRequestStatusCodes = [
+          HttpStatusCodeRange(min: 400, max: 400),
+          HttpStatusCodeRange(min: 402, max: 599)
+        ]
+      }
+    }
+    defer { SentrySDK.flush(timeout: 2.seconds.timeInterval) }
+
+    // Enrich future events with Cirrus CI-specific tags
+    if let tags = ProcessInfo.processInfo.environment["CIRRUS_SENTRY_TAGS"] {
+      SentrySDK.configureScope { scope in
+        for (key, value) in tags.split(separator: ",").compactMap({ parseCirrusSentryTag($0) }) {
+          scope.setTag(value: value, key: key)
+        }
+      }
+    }
+
     // Ensure the default SIGINT handled is disabled,
     // otherwise there's a race between two handlers
     signal(SIGINT, SIG_IGN);
@@ -66,7 +96,28 @@ struct Root: AsyncParsableCommand {
         try command.run()
       }
     } catch {
+      // Capture the error into Sentry
+      SentrySDK.capture(error: error)
+      SentrySDK.flush(timeout: 2.seconds.timeInterval)
+
+      // Handle a non-ArgumentParser's exception that requires a specific exit code to be set
+      if let errorWithExitCode = error as? HasExitCode {
+        print(error)
+
+        Foundation.exit(errorWithExitCode.exitCode)
+      }
+
+      // Handle any other exception, including ArgumentParser's ones
       exit(withError: error)
     }
   }
+
+  private static func parseCirrusSentryTag(_ tag: String.SubSequence) -> (String, String)? {
+    let splits = tag.split(separator: "=", maxSplits: 1)
+    if splits.count != 2 {
+      return nil
+    }
+
+    return (String(splits[0]), String(splits[1]))
+  }
 }

Sources/tart/URL+AccessDate.swift

@@ -13,7 +13,7 @@ extension URL {
     let times = [accessDate.asTimeval(), modificationDate.asTimeval()]
     let ret = utimes(path, times)
     if ret != 0 {
-      throw RuntimeError("utimes(2) failed: \(ret.explanation())")
+      throw RuntimeError.FailedToUpdateAccessDate("utimes(2) failed: \(ret.explanation())")
     }
   }
 }

Sources/tart/Utils.swift

@@ -13,7 +13,7 @@ func resolveBinaryPath(_ name: String) -> URL? {
 
   for pathComponent in path.split(separator: ":") {
     let url = URL(fileURLWithPath: String(pathComponent))
-            .appendingPathComponent(name, isDirectory: false)
+      .appendingPathComponent(name, isDirectory: false)
 
     if FileManager.default.fileExists(atPath: url.path) {
       return url

Sources/tart/VM.swift

@@ -14,8 +14,8 @@ struct DownloadFailed: Error {
 struct UnsupportedOSError: Error, CustomStringConvertible {
   let description: String
 
-  init(_ what: String, _ plural: String) {
-    description = "error: \(what) \(plural) only supported on hosts running macOS 13.0 (Ventura) or newer"
+  init(_ what: String, _ plural: String, _ requires: String = "running macOS 13.0 (Ventura) or newer") {
+    description = "error: \(what) \(plural) only supported on hosts \(requires)"
   }
 }
 
@@ -31,7 +31,7 @@ class VM: NSObject, VZVirtualMachineDelegate, ObservableObject {
 
   // VM's config
   var name: String
-  
+
   // VM's config
   var config: VMConfig
 
@@ -40,7 +40,7 @@ class VM: NSObject, VZVirtualMachineDelegate, ObservableObject {
   init(vmDir: VMDirectory,
        network: Network = NetworkShared(),
        additionalDiskAttachments: [VZDiskImageStorageDeviceAttachment] = [],
-       directoryShares: [DirectoryShare] = []
+       directorySharingDevices: [VZDirectorySharingDeviceConfiguration] = []
   ) throws {
     name = vmDir.name
     config = try VMConfig.init(fromURL: vmDir.configURL)
@@ -52,9 +52,10 @@ class VM: NSObject, VZVirtualMachineDelegate, ObservableObject {
     // Initialize the virtual machine and its configuration
     self.network = network
     let configuration = try Self.craftConfiguration(diskURL: vmDir.diskURL,
-      nvramURL: vmDir.nvramURL, vmConfig: config,
-      network: network, additionalDiskAttachments: additionalDiskAttachments,
-            directoryShares: directoryShares)
+                                                    nvramURL: vmDir.nvramURL, vmConfig: config,
+                                                    network: network, additionalDiskAttachments: additionalDiskAttachments,
+                                                    directorySharingDevices: directorySharingDevices
+    )
     virtualMachine = VZVirtualMachine(configuration: configuration)
 
     super.init()
@@ -63,7 +64,7 @@ class VM: NSObject, VZVirtualMachineDelegate, ObservableObject {
 
   static func retrieveIPSW(remoteURL: URL) async throws -> URL {
     // Check if we already have this IPSW in cache
-    let (channel, response) = try await Fetcher.fetch(URLRequest(url: remoteURL))
+    let (channel, response) = try await Fetcher.fetch(URLRequest(url: remoteURL), viaFile: true)
 
     if let hash = response.value(forHTTPHeaderField: "x-amz-meta-digest-sha256") {
       let ipswLocation = try IPSWCache().locationFor(fileName: "sha256:\(hash).ipsw")
@@ -121,7 +122,7 @@ class VM: NSObject, VZVirtualMachineDelegate, ObservableObject {
       virtualMachine.state == VZVirtualMachine.State.stopped ||
         virtualMachine.state == VZVirtualMachine.State.paused ||
         virtualMachine.state == VZVirtualMachine.State.error
-      
+
     }
   }
 
@@ -130,7 +131,8 @@ class VM: NSObject, VZVirtualMachineDelegate, ObservableObject {
     ipswURL: URL,
     diskSizeGB: UInt16,
     network: Network = NetworkShared(),
-    additionalDiskAttachments: [VZDiskImageStorageDeviceAttachment] = []
+    additionalDiskAttachments: [VZDiskImageStorageDeviceAttachment] = [],
+    directorySharingDevices: [VZDirectorySharingDeviceConfiguration] = []
   ) async throws {
     var ipswURL = ipswURL
 
@@ -138,6 +140,11 @@ class VM: NSObject, VZVirtualMachineDelegate, ObservableObject {
       ipswURL = try await VM.retrieveIPSW(remoteURL: ipswURL)
     }
 
+    // We create a temporary TART_HOME directory in tests, which has its "cache" folder symlinked
+    // to the users Tart cache directory (~/.tart/cache). However, the Virtualization.Framework
+    // cannot deal with paths that contain symlinks, so expand them here first.
+    ipswURL.resolveSymlinksInPath()
+
     // Load the restore image and try to get the requirements
     // that match both the image and our platform
     let image = try await withCheckedThrowingContinuation { continuation in
@@ -170,9 +177,10 @@ class VM: NSObject, VZVirtualMachineDelegate, ObservableObject {
     // Initialize the virtual machine and its configuration
     self.network = network
     let configuration = try Self.craftConfiguration(diskURL: vmDir.diskURL, nvramURL: vmDir.nvramURL,
-      vmConfig: config, network: network,
-      additionalDiskAttachments: additionalDiskAttachments,
-      directoryShares: [])
+                                                    vmConfig: config, network: network,
+                                                    additionalDiskAttachments: additionalDiskAttachments,
+                                                    directorySharingDevices: directorySharingDevices
+    )
     virtualMachine = VZVirtualMachine(configuration: configuration)
 
     super.init()
@@ -211,7 +219,7 @@ class VM: NSObject, VZVirtualMachineDelegate, ObservableObject {
   func run(_ recovery: Bool) async throws {
     try network.run(sema)
 
-    DispatchQueue.main.sync {
+    let startTask = DispatchQueue.main.sync {
       Task {
         if #available(macOS 13, *) {
           // new API introduced in Ventura
@@ -225,7 +233,12 @@ class VM: NSObject, VZVirtualMachineDelegate, ObservableObject {
       }
     }
 
-    await withTaskCancellationHandler(operation: {
+    try await withTaskCancellationHandler(operation: {
+      // Await on VZVirtualMachine.start() result
+      _ = try await startTask.value
+
+      // Wait for the VM to finish running
+      // or for the exit condition
       sema.wait()
     }, onCancel: {
       sema.signal()
@@ -248,7 +261,7 @@ class VM: NSObject, VZVirtualMachineDelegate, ObservableObject {
     vmConfig: VMConfig,
     network: Network = NetworkShared(),
     additionalDiskAttachments: [VZDiskImageStorageDeviceAttachment],
-    directoryShares: [DirectoryShare]
+    directorySharingDevices: [VZDirectorySharingDeviceConfiguration]
   ) throws -> VZVirtualMachineConfiguration {
     let configuration = VZVirtualMachineConfiguration()
 
@@ -292,19 +305,8 @@ class VM: NSObject, VZVirtualMachineDelegate, ObservableObject {
     // Entropy
     configuration.entropyDevices = [VZVirtioEntropyDeviceConfiguration()]
 
-    // Directory share
-    if #available(macOS 13, *) {
-      var directories: [String : VZSharedDirectory] = Dictionary()
-      directoryShares.forEach { directories[$0.name] = VZSharedDirectory(url: $0.path, readOnly: $0.readOnly) }
-
-      let automountTag = VZVirtioFileSystemDeviceConfiguration.macOSGuestAutomountTag
-      let sharingDevice = VZVirtioFileSystemDeviceConfiguration(tag: automountTag)
-      sharingDevice.share = VZMultipleDirectoryShare(directories: directories)
-
-      configuration.directorySharingDevices = [sharingDevice]
-    } else if !directoryShares.isEmpty {
-      throw UnsupportedOSError("directory sharing", "is")
-    }
+    // Directory sharing devices
+    configuration.directorySharingDevices = directorySharingDevices
 
     try configuration.validate()
 
@@ -317,7 +319,7 @@ class VM: NSObject, VZVirtualMachineDelegate, ObservableObject {
   }
 
   func virtualMachine(_ virtualMachine: VZVirtualMachine, didStopWithError error: Error) {
-    print("guest has stopped the virtual machine due to error")
+    print("guest has stopped the virtual machine due to error: \(error)")
     sema.signal()
   }
 
@@ -326,9 +328,3 @@ class VM: NSObject, VZVirtualMachineDelegate, ObservableObject {
     sema.signal()
   }
 }
-
-struct DirectoryShare {
-  let name: String
-  let path: URL
-  let readOnly: Bool
-}

Sources/tart/VMConfig.swift

@@ -35,6 +35,12 @@ struct VMDisplayConfig: Codable {
   var height: Int = 768
 }
 
+extension VMDisplayConfig: CustomStringConvertible {
+  var description: String {
+    "\(width)x\(height)"
+  }
+}
+
 struct VMConfig: Codable {
   var version: Int = 1
   var os: OS
@@ -48,10 +54,10 @@ struct VMConfig: Codable {
   var display: VMDisplayConfig = VMDisplayConfig()
 
   init(
-          platform: Platform,
-          cpuCountMin: Int,
-          memorySizeMin: UInt64,
-          macAddress: VZMACAddress = VZMACAddress.randomLocallyAdministered()
+    platform: Platform,
+    cpuCountMin: Int,
+    memorySizeMin: UInt64,
+    macAddress: VZMACAddress = VZMACAddress.randomLocallyAdministered()
   ) {
     self.os = platform.os()
     self.arch = CurrentArchitecture()
@@ -105,12 +111,12 @@ struct VMConfig: Codable {
     let encodedMacAddress = try container.decode(String.self, forKey: .macAddress)
     guard let macAddress = VZMACAddress.init(string: encodedMacAddress) else {
       throw DecodingError.dataCorruptedError(
-                forKey: .hardwareModel,
-                in: container,
-                debugDescription: "failed to initialize VZMacAddress using the provided value")
+        forKey: .hardwareModel,
+        in: container,
+        debugDescription: "failed to initialize VZMacAddress using the provided value")
     }
     self.macAddress = macAddress
-    
+
     display = try container.decodeIfPresent(VMDisplayConfig.self, forKey: .display) ?? VMDisplayConfig()
   }
 
@@ -132,7 +138,7 @@ struct VMConfig: Codable {
   mutating func setCPU(cpuCount: Int) throws {
     if cpuCount < cpuCountMin {
       throw LessThanMinimalResourcesError("VM should have \(cpuCountMin) CPU cores"
-              + " at minimum (requested \(cpuCount))")
+        + " at minimum (requested \(cpuCount))")
     }
 
     self.cpuCount = cpuCount
@@ -141,7 +147,7 @@ struct VMConfig: Codable {
   mutating func setMemory(memorySize: UInt64) throws {
     if memorySize < memorySizeMin {
       throw LessThanMinimalResourcesError("VM should have \(memorySizeMin) bytes"
-              + " of memory at minimum (requested \(memorySizeMin))")
+        + " of memory at minimum (requested \(memorySizeMin))")
     }
 
     self.memorySize = memorySize

Sources/tart/VMDirectory+OCI.swift

@@ -1,5 +1,6 @@
 import Foundation
 import Compression
+import Sentry
 
 enum OCIError: Error {
   case ShouldBeExactlyOneLayer
@@ -59,11 +60,11 @@ extension VMDirectory {
 
     // Progress
     let diskCompressedSize: Int64 = Int64(diskLayers.map {
-              $0.size
-            }
-            .reduce(0) {
-              $0 + $1
-            })
+      $0.size
+    }
+    .reduce(0) {
+      $0 + $1
+    })
     let prettyDiskSize = String(format: "%.1f", Double(diskCompressedSize) / 1_000_000_000.0)
     defaultLogger.appendNewLine("pulling disk (\(prettyDiskSize) GB compressed)...")
     let progress = Progress(totalUnitCount: diskCompressedSize)
@@ -77,6 +78,7 @@ extension VMDirectory {
     }
     try filter.finalize()
     try disk.close()
+    SentrySDK.span?.setMeasurement(name: "compressed_disk_size", value: diskCompressedSize as NSNumber, unit: MeasurementUnitInformation.byte);
 
     // Pull VM's NVRAM file layer and store it in an NVRAM file
     defaultLogger.appendNewLine("pulling NVRAM...")
@@ -144,9 +146,9 @@ extension VMDirectory {
     let ociConfigJSON = try OCIConfig(architecture: config.arch, os: config.os).toJSON()
     let ociConfigDigest = try await registry.pushBlob(fromData: ociConfigJSON, chunkSizeMb: chunkSizeMb)
     let manifest = OCIManifest(
-            config: OCIManifestConfig(size: ociConfigJSON.count, digest: ociConfigDigest),
-            layers: layers,
-            uncompressedDiskSize: UInt64(mappedDiskReadOffset)
+      config: OCIManifestConfig(size: ociConfigJSON.count, digest: ociConfigDigest),
+      layers: layers,
+      uncompressedDiskSize: UInt64(mappedDiskReadOffset)
     )
 
     // Manifest

Sources/tart/VMDirectory.swift

@@ -41,7 +41,7 @@ struct VMDirectory: Prunable {
 
   func initialize(overwrite: Bool = false) throws {
     if !overwrite && initialized {
-      throw RuntimeError("VM directory is already initialized, preventing overwrite")
+      throw RuntimeError.VMDirectoryAlreadyInitialized("VM directory is already initialized, preventing overwrite")
     }
 
     try FileManager.default.createDirectory(at: baseURL, withIntermediateDirectories: true, attributes: nil)
@@ -53,11 +53,11 @@ struct VMDirectory: Prunable {
 
   func validate() throws {
     if !FileManager.default.fileExists(atPath: baseURL.path) {
-      throw RuntimeError("the specified VM does not exist")
+      throw RuntimeError.VMDoesNotExist(name: baseURL.lastPathComponent)
     }
 
     if !initialized {
-      throw RuntimeError("VM is missing some of its files (\(configURL.lastPathComponent),"
+      throw RuntimeError.VMMissingFiles("VM is missing some of its files (\(configURL.lastPathComponent),"
         + " \(diskURL.lastPathComponent) or \(nvramURL.lastPathComponent))")
     }
   }

Sources/tart/VMStorageHelper.swift

@@ -26,7 +26,7 @@ class VMStorageHelper {
       return try closure()
     } catch {
       if error.isFileNotFound() {
-        throw RuntimeError("source VM \"\(name)\" not found, is it listed in \"tart list\"?")
+        throw RuntimeError.VMDoesNotExist(name: name)
       }
 
       throw error
@@ -40,14 +40,76 @@ extension Error {
   }
 }
 
-class RuntimeError: Error, CustomStringConvertible {
-  let message: String
+enum RuntimeError : Error {
+  case VMDoesNotExist(name: String)
+  case VMMissingFiles(_ message: String)
+  case VMNotRunning(_ message: String)
+  case VMAlreadyRunning(_ message: String)
+  case NoIPAddressFound(_ message: String)
+  case DiskAlreadyInUse(_ message: String)
+  case FailedToUpdateAccessDate(_ message: String)
+  case PIDLockFailed(_ message: String)
+  case FailedToParseRemoteName(_ message: String)
+  case VMTerminationFailed(_ message: String)
+  case InvalidCredentials(_ message: String)
+  case VMDirectoryAlreadyInitialized(_ message: String)
+}
 
-  init(_ message: String) {
-    self.message = message
-  }
+protocol HasExitCode {
+  var exitCode: Int32 { get }
+}
 
-  var description: String {
-    message
+extension RuntimeError : CustomStringConvertible {
+  public var description: String {
+    switch self {
+    case .VMDoesNotExist(let name):
+      return "the specified VM \"\(name)\" does not exist"
+    case .VMMissingFiles(let message):
+      return message
+    case .VMNotRunning(let message):
+      return message
+    case .VMAlreadyRunning(let message):
+      return message
+    case .NoIPAddressFound(let message):
+      return message
+    case .DiskAlreadyInUse(let message):
+      return message
+    case .FailedToUpdateAccessDate(let message):
+      return message
+    case .PIDLockFailed(let message):
+      return message
+    case .FailedToParseRemoteName(let cause):
+      return "failed to parse remote name: \(cause)"
+    case .VMTerminationFailed(let message):
+      return message
+    case .InvalidCredentials(let message):
+      return message
+    case .VMDirectoryAlreadyInitialized(let message):
+      return message
+    }
+  }
+}
+
+extension RuntimeError : HasExitCode {
+  var exitCode: Int32 {
+    switch self {
+    case .VMNotRunning:
+      return 2
+    case .VMAlreadyRunning:
+      return 2
+    default:
+      return 1
+    }
+  }
+}
+
+// Customize error description for Sentry[1]
+//
+// [1]: https://docs.sentry.io/platforms/apple/guides/ios/usage/#customizing-error-descriptions
+extension RuntimeError : CustomNSError {
+  var errorUserInfo: [String : Any] {
+    [
+      NSDebugDescriptionErrorKey: description,
+    ]
   }
 }

Sources/tart/VMStorageOCI.swift

@@ -1,4 +1,5 @@
 import Foundation
+import Sentry
 
 class VMStorageOCI: PrunableStorage {
   let baseURL = try! Config().tartCacheDir.appendingPathComponent("OCIs", isDirectory: true)
@@ -39,7 +40,7 @@ class VMStorageOCI: PrunableStorage {
     // Pre-create intermediate directories (e.g. creates ~/.tart/cache/OCIs/github.com/org/repo/
     // for github.com/org/repo:latest)
     try FileManager.default.createDirectory(at: targetURL.deletingLastPathComponent(),
-            withIntermediateDirectories: true)
+                                            withIntermediateDirectories: true)
 
     _ = try FileManager.default.replaceItemAt(targetURL, withItemAt: from.baseURL)
   }
@@ -53,7 +54,7 @@ class VMStorageOCI: PrunableStorage {
     var refCounts = Dictionary<URL, UInt>()
 
     guard let enumerator = FileManager.default.enumerator(at: baseURL,
-            includingPropertiesForKeys: [.isSymbolicLinkKey]) else {
+                                                          includingPropertiesForKeys: [.isSymbolicLinkKey]) else {
       return
     }
 
@@ -90,7 +91,7 @@ class VMStorageOCI: PrunableStorage {
     var result: [(String, VMDirectory, Bool)] = Array()
 
     guard let enumerator = FileManager.default.enumerator(at: baseURL,
-      includingPropertiesForKeys: [.isSymbolicLinkKey], options: [.producesRelativePathURLs]) else {
+                                                          includingPropertiesForKeys: [.isSymbolicLinkKey], options: [.producesRelativePathURLs]) else {
       return []
     }
 
@@ -127,7 +128,7 @@ class VMStorageOCI: PrunableStorage {
     let (manifest, manifestData) = try await registry.pullManifest(reference: name.reference.value)
 
     let digestName = RemoteName(host: name.host, namespace: name.namespace,
-            reference: Reference(digest: Digest.hash(manifestData)))
+                                reference: Reference(digest: Digest.hash(manifestData)))
 
     // Ensure that host directory for given RemoteName exists in OCI storage
     let hostDirectoryURL = hostDirectoryURL(digestName)
@@ -148,6 +149,7 @@ class VMStorageOCI: PrunableStorage {
     }
 
     if !exists(digestName) {
+      let transaction = SentrySDK.startTransaction(name: name.description, operation: "pull", bindToScope: true)
       let tmpVMDir = try VMDirectory.temporary()
 
       // Lock the temporary VM directory to prevent it's garbage collection
@@ -165,15 +167,15 @@ class VMStorageOCI: PrunableStorage {
 
         if capacityImportant == 0 || capacityAvailable == 0 {
           puppy.warning("important capacity \(capacityImportant) bytes, "
-                  + "available capacity is \(capacityAvailable) bytes")
+            + "available capacity is \(capacityAvailable) bytes")
         }
 
         // There is a suspicious that occasionally capacity is returned as zero which can't be true.
         // Let's validate to avoid unnecessary pruning.
         if 0 < availableCapacityBytes && availableCapacityBytes < requiredCapacityBytes {
           puppy.info("pruning cache to accommodate \(name) with a disk of size \(uncompressedDiskSize) bytes ("
-                  + "available capacity is \(availableCapacityBytes) bytes, required capacity "
-                  + "is \(requiredCapacityBytes) bytes)")
+            + "available capacity is \(availableCapacityBytes) bytes, required capacity "
+            + "is \(requiredCapacityBytes) bytes)")
 
           try Prune.pruneReclaim(reclaimBytes: requiredCapacityBytes - availableCapacityBytes)
         }
@@ -182,7 +184,9 @@ class VMStorageOCI: PrunableStorage {
       try await withTaskCancellationHandler(operation: {
         try await tmpVMDir.pullFromRegistry(registry: registry, manifest: manifest)
         try move(digestName, from: tmpVMDir)
+        transaction.finish()
       }, onCancel: {
+        transaction.finish(status: SentrySpanStatus.cancelled)
         try? FileManager.default.removeItem(at: tmpVMDir.baseURL)
       })
     } else {
@@ -191,7 +195,7 @@ class VMStorageOCI: PrunableStorage {
 
     if name != digestName {
       // Create new or overwrite the old symbolic link
-      try link(from: digestName, to: name)
+      try link(from: name, to: digestName)
     } else {
       // Ensure that images pulled by content digest
       // are excluded from garbage collection
@@ -200,11 +204,11 @@ class VMStorageOCI: PrunableStorage {
   }
 
   func link(from: RemoteName, to: RemoteName) throws {
-    if FileManager.default.fileExists(atPath: vmURL(to).path) {
-      try FileManager.default.removeItem(at: vmURL(to))
+    if FileManager.default.fileExists(atPath: vmURL(from).path) {
+      try FileManager.default.removeItem(at: vmURL(from))
     }
 
-    try FileManager.default.createSymbolicLink(at: vmURL(to), withDestinationURL: vmURL(from))
+    try FileManager.default.createSymbolicLink(at: vmURL(from), withDestinationURL: vmURL(to))
 
     try gc()
   }

Sources/tart/VNC/FullFledgedVNC.swift

@@ -3,36 +3,36 @@ import Dynamic
 import Virtualization
 
 class FullFledgedVNC: VNC {
-    let password: String
-    private let vnc: Dynamic
+  let password: String
+  private let vnc: Dynamic
 
-    init(virtualMachine: VZVirtualMachine) {
-        password = Array(PassphraseGenerator().prefix(4)).joined(separator: "-")
-        let securityConfiguration = Dynamic._VZVNCAuthenticationSecurityConfiguration(password: password)
-        vnc = Dynamic._VZVNCServer(port: 0, queue: DispatchQueue.global(),
-                securityConfiguration: securityConfiguration)
-        vnc.virtualMachine = virtualMachine
-        vnc.start()
-    }
+  init(virtualMachine: VZVirtualMachine) {
+    password = Array(PassphraseGenerator().prefix(4)).joined(separator: "-")
+    let securityConfiguration = Dynamic._VZVNCAuthenticationSecurityConfiguration(password: password)
+    vnc = Dynamic._VZVNCServer(port: 0, queue: DispatchQueue.global(),
+                               securityConfiguration: securityConfiguration)
+    vnc.virtualMachine = virtualMachine
+    vnc.start()
+  }
 
-    func waitForURL() async throws -> URL {
-      while true {
-        // Port is 0 shortly after start(),
-        // but will be initialized later
-        if let port = vnc.port.asUInt16, port != 0 {
-          return URL(string: "vnc://:\(password)@127.0.0.1:\(port)")!
-        }
-
-        // Wait 50 ms.
-        try await Task.sleep(nanoseconds: 50_000_000)
+  func waitForURL() async throws -> URL {
+    while true {
+      // Port is 0 shortly after start(),
+      // but will be initialized later
+      if let port = vnc.port.asUInt16, port != 0 {
+        return URL(string: "vnc://:\(password)@127.0.0.1:\(port)")!
       }
-    }
 
-    func stop() throws {
-        vnc.stop()
+      // Wait 50 ms.
+      try await Task.sleep(nanoseconds: 50_000_000)
     }
+  }
 
-    deinit {
-        try? stop()
-    }
+  func stop() throws {
+    vnc.stop()
+  }
+
+  deinit {
+    try? stop()
+  }
 }

Tests/TartTests/FileLockTests.swift

@@ -2,33 +2,33 @@ import XCTest
 @testable import tart
 
 final class FileLockTests: XCTestCase {
-    func testSimple() throws {
-        // Create a temporary file that will be used as a lock
-        let url = temporaryFile()
+  func testSimple() throws {
+    // Create a temporary file that will be used as a lock
+    let url = temporaryFile()
 
-        // Make sure this file can be locked and unlocked
-        let lock = try FileLock(lockURL: url)
-        try lock.lock()
-        try lock.unlock()
-    }
+    // Make sure this file can be locked and unlocked
+    let lock = try FileLock(lockURL: url)
+    try lock.lock()
+    try lock.unlock()
+  }
 
-    func testDoubleLockResultsInError() throws {
-        // Create a temporary file that will be used as a lock
-        let url = temporaryFile()
+  func testDoubleLockResultsInError() throws {
+    // Create a temporary file that will be used as a lock
+    let url = temporaryFile()
 
-        // Create two locks on a same file and ensure one of them fails
-        let firstLock = try FileLock(lockURL: url)
-        try firstLock.lock()
+    // Create two locks on a same file and ensure one of them fails
+    let firstLock = try FileLock(lockURL: url)
+    try firstLock.lock()
 
-        let secondLock = try! FileLock(lockURL: url)
-        XCTAssertFalse(try secondLock.trylock())
-    }
+    let secondLock = try! FileLock(lockURL: url)
+    XCTAssertFalse(try secondLock.trylock())
+  }
 
-    private func temporaryFile() -> URL {
-        let url = URL(fileURLWithPath: NSTemporaryDirectory()).appendingPathComponent(UUID().uuidString)
+  private func temporaryFile() -> URL {
+    let url = URL(fileURLWithPath: NSTemporaryDirectory()).appendingPathComponent(UUID().uuidString)
 
-        FileManager.default.createFile(atPath: url.path, contents: nil)
+    FileManager.default.createFile(atPath: url.path, contents: nil)
 
-        return url
-    }
+    return url
+  }
 }

Tests/TartTests/MACAddressResolverTests.swift

@@ -5,31 +5,31 @@ import Network
 final class MACAddressResolverTests: XCTestCase {
   func testSingleEntry() throws {
     let leases = try Leases("""
-                            {
-                              ip_address=1.2.3.4
-                              hw_address=1,00:11:22:33:44:55
-                            }
-                            """)
+    {
+      ip_address=1.2.3.4
+      hw_address=1,00:11:22:33:44:55
+    }
+    """)
 
     XCTAssertEqual(IPv4Address("1.2.3.4"),
-      try leases.resolveMACAddress(macAddress: MACAddress(fromString: "00:11:22:33:44:55")!))
+                   try leases.resolveMACAddress(macAddress: MACAddress(fromString: "00:11:22:33:44:55")!))
   }
 
   func testMultipleEntries() throws {
     let leases = try Leases("""
-                            {
-                              ip_address=1.2.3.4
-                              hw_address=1,00:11:22:33:44:55
-                            }
-                            {
-                              ip_address=5.6.7.8
-                              hw_address=1,AA:BB:CC:DD:EE:FF
-                            }
-                            """)
+    {
+      ip_address=1.2.3.4
+      hw_address=1,00:11:22:33:44:55
+    }
+    {
+      ip_address=5.6.7.8
+      hw_address=1,AA:BB:CC:DD:EE:FF
+    }
+    """)
 
     XCTAssertEqual(IPv4Address("1.2.3.4"),
-      try leases.resolveMACAddress(macAddress: MACAddress(fromString: "00:11:22:33:44:55")!))
+                   try leases.resolveMACAddress(macAddress: MACAddress(fromString: "00:11:22:33:44:55")!))
     XCTAssertEqual(IPv4Address("5.6.7.8"),
-      try leases.resolveMACAddress(macAddress: MACAddress(fromString: "AA:BB:CC:DD:EE:FF")!))
+                   try leases.resolveMACAddress(macAddress: MACAddress(fromString: "AA:BB:CC:DD:EE:FF")!))
   }
 }

Tests/TartTests/RegistryTests.swift

@@ -2,88 +2,88 @@ import XCTest
 @testable import tart
 
 final class RegistryTests: XCTestCase {
-    var registryRunner: RegistryRunner?
+  var registryRunner: RegistryRunner?
 
-    override func setUp() async throws {
-        try await super.setUp()
+  override func setUp() async throws {
+    try await super.setUp()
 
-        do {
-            registryRunner = try await RegistryRunner()
-        } catch {
-            try XCTSkipIf(ProcessInfo.processInfo.environment["CI"] == nil)
-        }
+    do {
+      registryRunner = try await RegistryRunner()
+    } catch {
+      try XCTSkipIf(ProcessInfo.processInfo.environment["CI"] == nil)
+    }
+  }
+
+  override func tearDown() async throws {
+    try await super.tearDown()
+
+    registryRunner = nil
+  }
+
+  var registry: Registry {
+    registryRunner!.registry
+  }
+
+  func testPushPullBlobSmall() async throws {
+    // Generate a simple blob
+    let pushedBlob = Data("The quick brown fox jumps over the lazy dog".utf8)
+
+    // Push it
+    let pushedBlobDigest = try await registry.pushBlob(fromData: pushedBlob)
+    XCTAssertEqual("sha256:d7a8fbb307d7809469ca9abcb0082e4f8d5651e46d3cdb762d02d0bf37c9e592", pushedBlobDigest)
+
+    // Pull it
+    var pulledBlob = Data()
+    try await registry.pullBlob(pushedBlobDigest) { data in
+      pulledBlob.append(data)
     }
 
-    override func tearDown() async throws {
-        try await super.tearDown()
+    // Ensure that both blobs are identical
+    XCTAssertEqual(pushedBlob, pulledBlob)
+  }
 
-        registryRunner = nil
+  func testPushPullBlobHugeInChunks() async throws {
+    // Generate a large enough blob
+    let fh = FileHandle(forReadingAtPath: "/dev/urandom")!
+    let largeBlobToPush = try fh.read(upToCount: 768 * 1024 * 1024)!
+
+    // Push it
+    let largeBlobDigest = try await registry.pushBlob(fromData: largeBlobToPush, chunkSizeMb: 10)
+
+    // Pull it
+    var pulledLargeBlob = Data()
+    try await registry.pullBlob(largeBlobDigest) { data in
+      pulledLargeBlob.append(data)
     }
 
-    var registry: Registry {
-        registryRunner!.registry
-    }
+    // Ensure that both blobs are identical
+    XCTAssertEqual(largeBlobToPush, pulledLargeBlob)
+  }
 
-    func testPushPullBlobSmall() async throws {
-        // Generate a simple blob
-        let pushedBlob = Data("The quick brown fox jumps over the lazy dog".utf8)
+  func testPushPullManifest() async throws {
+    // Craft a basic config
+    let configData = try OCIConfig().toJSON()
+    let configDigest = try await registry.pushBlob(fromData: configData)
 
-        // Push it
-        let pushedBlobDigest = try await registry.pushBlob(fromData: pushedBlob)
-        XCTAssertEqual("sha256:d7a8fbb307d7809469ca9abcb0082e4f8d5651e46d3cdb762d02d0bf37c9e592", pushedBlobDigest)
+    // Craft a basic layer
+    let layerData = Data("doesn't matter".utf8)
+    let layerDigest = try await registry.pushBlob(fromData: layerData)
 
-        // Pull it
-        var pulledBlob = Data()
-        try await registry.pullBlob(pushedBlobDigest) { data in
-            pulledBlob.append(data)
-        }
+    // Craft a basic manifest and push it
+    let manifest = OCIManifest(
+      config: OCIManifestConfig(size: configData.count, digest: configDigest),
+      layers: [
+        OCIManifestLayer(mediaType: "application/octet-stream", size: layerData.count, digest: layerDigest)
+      ]
+    )
+    let pushedManifestDigest = try await registry.pushManifest(reference: "latest", manifest: manifest)
 
-        // Ensure that both blobs are identical
-        XCTAssertEqual(pushedBlob, pulledBlob)
-    }
+    // Ensure that the manifest pulled by tag matches with the one pushed above
+    let (pulledByTagManifest, _) = try await registry.pullManifest(reference: "latest")
+    XCTAssertEqual(manifest, pulledByTagManifest)
 
-    func testPushPullBlobHugeInChunks() async throws {
-        // Generate a large enough blob
-        let fh = FileHandle(forReadingAtPath: "/dev/urandom")!
-        let largeBlobToPush = try fh.read(upToCount: 768 * 1024 * 1024)!
-
-        // Push it
-        let largeBlobDigest = try await registry.pushBlob(fromData: largeBlobToPush, chunkSizeMb: 10)
-
-        // Pull it
-        var pulledLargeBlob = Data()
-        try await registry.pullBlob(largeBlobDigest) { data in
-            pulledLargeBlob.append(data)
-        }
-
-        // Ensure that both blobs are identical
-        XCTAssertEqual(largeBlobToPush, pulledLargeBlob)
-    }
-
-    func testPushPullManifest() async throws {
-        // Craft a basic config
-        let configData = try OCIConfig().toJSON()
-        let configDigest = try await registry.pushBlob(fromData: configData)
-
-        // Craft a basic layer
-        let layerData = Data("doesn't matter".utf8)
-        let layerDigest = try await registry.pushBlob(fromData: layerData)
-
-        // Craft a basic manifest and push it
-        let manifest = OCIManifest(
-                config: OCIManifestConfig(size: configData.count, digest: configDigest),
-                layers: [
-                    OCIManifestLayer(mediaType: "application/octet-stream", size: layerData.count, digest: layerDigest)
-                ]
-        )
-        let pushedManifestDigest = try await registry.pushManifest(reference: "latest", manifest: manifest)
-
-        // Ensure that the manifest pulled by tag matches with the one pushed above
-        let (pulledByTagManifest, _) = try await registry.pullManifest(reference: "latest")
-        XCTAssertEqual(manifest, pulledByTagManifest)
-
-        // Ensure that the manifest pulled by digest matches with the one pushed above
-        let (pulledByDigestManifest, _) = try await registry.pullManifest(reference: "\(pushedManifestDigest)")
-        XCTAssertEqual(manifest, pulledByDigestManifest)
-    }
+    // Ensure that the manifest pulled by digest matches with the one pushed above
+    let (pulledByDigestManifest, _) = try await registry.pullManifest(reference: "\(pushedManifestDigest)")
+    XCTAssertEqual(manifest, pulledByDigestManifest)
+  }
 }

Tests/TartTests/RemoteNameTests.swift

@@ -7,7 +7,7 @@ final class RemoteNameTests: XCTestCase {
 
     XCTAssertEqual(expectedRemoteName, try RemoteName("ghcr.io/a/b:latest"))
   }
-  
+
   func testComplexTag() throws {
     let expectedRemoteName = RemoteName(host: "ghcr.io", namespace: "a/b", reference: Reference(tag: "1.2.3-RC-1"))
 
@@ -22,7 +22,7 @@ final class RemoteNameTests: XCTestCase {
     )
 
     XCTAssertEqual(expectedRemoteName,
-      try RemoteName("ghcr.io/a/b@sha256:e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"))
+                   try RemoteName("ghcr.io/a/b@sha256:e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"))
   }
 
   func testASCIIOnly() throws {

Tests/TartTests/URLAbsolutizationTests.swift

@@ -4,14 +4,14 @@ import XCTest
 final class URLAbsolutizationTets: XCTestCase {
   func testNeedsAbsolutization() throws {
     let url = URL(string: "/v2/some/path?some=query")!
-            .absolutize(URL(string: "https://example.com/v2/")!)
+      .absolutize(URL(string: "https://example.com/v2/")!)
 
     XCTAssertEqual(url.absoluteString, "https://example.com/v2/some/path?some=query")
   }
 
   func testDoesntNeedAbsolutization() throws {
     let url = URL(string: "https://example.org/v2/some/path?some=query")!
-            .absolutize(URL(string: "https://example.com/v2/")!)
+      .absolutize(URL(string: "https://example.com/v2/")!)
 
     XCTAssertEqual(url.absoluteString, "https://example.org/v2/some/path?some=query")
   }

Tests/TartTests/Util/RegistryRunner.swift

@@ -2,53 +2,53 @@ import Foundation
 @testable import tart
 
 enum RegistryRunnerError: Error {
-    case DockerFailed(exitCode: Int32)
+  case DockerFailed(exitCode: Int32)
 }
 
 class RegistryRunner {
-    let containerID: String
-    let registry: Registry
+  let containerID: String
+  let registry: Registry
 
-    static func dockerCmd(_ arguments: String...) throws -> String {
-        let stdoutPipe = Pipe()
+  static func dockerCmd(_ arguments: String...) throws -> String {
+    let stdoutPipe = Pipe()
 
-        let proc = Process()
-        proc.executableURL = URL(fileURLWithPath: "/usr/local/bin/docker")
-        proc.arguments = arguments
-        proc.standardOutput = stdoutPipe
-        try proc.run()
+    let proc = Process()
+    proc.executableURL = URL(fileURLWithPath: "/usr/local/bin/docker")
+    proc.arguments = arguments
+    proc.standardOutput = stdoutPipe
+    try proc.run()
 
-        let stdoutData = stdoutPipe.fileHandleForReading.readDataToEndOfFile()
+    let stdoutData = stdoutPipe.fileHandleForReading.readDataToEndOfFile()
 
-        proc.waitUntilExit()
+    proc.waitUntilExit()
 
-        if proc.terminationStatus != 0 {
-            throw RegistryRunnerError.DockerFailed(exitCode: proc.terminationStatus)
-        }
-
-        return String(data: stdoutData, encoding: .utf8) ?? ""
+    if proc.terminationStatus != 0 {
+      throw RegistryRunnerError.DockerFailed(exitCode: proc.terminationStatus)
     }
 
-    init() async throws {
-        // Start container
-        let container = try Self.dockerCmd("run", "-d", "--rm", "-p", "5000", "registry:2")
-                .trimmingCharacters(in: CharacterSet.newlines)
-        containerID = container
+    return String(data: stdoutData, encoding: .utf8) ?? ""
+  }
 
-        // Get forwarded port
-        let port = try Self.dockerCmd("inspect", containerID, "--format", "{{(index (index .NetworkSettings.Ports \"5000/tcp\") 0).HostPort}}")
-                .trimmingCharacters(in: CharacterSet.newlines)
+  init() async throws {
+    // Start container
+    let container = try Self.dockerCmd("run", "-d", "--rm", "-p", "5000", "registry:2")
+      .trimmingCharacters(in: CharacterSet.newlines)
+    containerID = container
 
-        registry = try Registry(urlComponents: URLComponents(string: "http://127.0.0.1:\(port)/v2/")!,
-                namespace: "vm-image")
+    // Get forwarded port
+    let port = try Self.dockerCmd("inspect", containerID, "--format", "{{(index (index .NetworkSettings.Ports \"5000/tcp\") 0).HostPort}}")
+      .trimmingCharacters(in: CharacterSet.newlines)
 
-        // Wait for the Docker Registry to start
-        while ((try? await registry.ping()) == nil) {
-            try await Task.sleep(nanoseconds: 100_000_000)
-        }
+    registry = try Registry(urlComponents: URLComponents(string: "http://127.0.0.1:\(port)/v2/")!,
+                            namespace: "vm-image")
+
+    // Wait for the Docker Registry to start
+    while ((try? await registry.ping()) == nil) {
+      try await Task.sleep(nanoseconds: 100_000_000)
     }
+  }
 
-    deinit {
-        _ = try! Self.dockerCmd("kill", containerID)
-    }
+  deinit {
+    _ = try! Self.dockerCmd("kill", containerID)
+  }
 }

integration-tests/conftest.py

@@ -0,0 +1,16 @@
+import pytest
+
+from tart import Tart
+from docker_registry import DockerRegistry
+
+
+@pytest.fixture(scope="class")
+def tart():
+    with Tart() as tart:
+        yield tart
+
+
+@pytest.fixture(scope="class")
+def docker_registry():
+    with DockerRegistry() as docker_registry:
+        yield docker_registry

integration-tests/docker_registry.py

@@ -0,0 +1,20 @@
+import requests
+
+from testcontainers.core.waiting_utils import wait_container_is_ready
+from testcontainers.general import DockerContainer
+
+
+class DockerRegistry(DockerContainer):
+    _default_exposed_port = 5000
+
+    def __init__(self):
+        super().__init__("registry:2")
+        self.with_exposed_ports(self._default_exposed_port)
+
+    @wait_container_is_ready(requests.exceptions.ConnectionError)
+    def remote_name(self, for_vm: str):
+        exposed_port = self.get_exposed_port(self._default_exposed_port)
+
+        requests.get(f"http://127.0.0.1:{exposed_port}/v2/")
+
+        return f"127.0.0.1:{exposed_port}/tart/{for_vm}:latest"

integration-tests/requirements.txt

@@ -0,0 +1,5 @@
+pytest
+testcontainers
+requests
+bitmath
+pytest-dependency

integration-tests/tart.py

@@ -0,0 +1,33 @@
+import tempfile
+import os
+import subprocess
+
+
+class Tart:
+    def __init__(self):
+        self.tmp_dir = tempfile.TemporaryDirectory(dir=os.environ.get("CIRRUS_WORKING_DIR"))
+
+        # Link to the users IPSW cache to make things faster
+        src = os.path.join(os.path.expanduser("~"), ".tart", "cache", "IPSWs")
+        dst = os.path.join(self.tmp_dir.name, "cache", "IPSWs")
+        os.makedirs(os.path.join(self.tmp_dir.name, "cache"))
+        os.symlink(src, dst)
+
+    def __enter__(self):
+        return self
+
+    def __exit__(self, exc_type, exc_val, exc_tb):
+        self.tmp_dir.cleanup()
+
+    def home(self) -> str:
+        return self.tmp_dir.name
+
+    def run(self, args):
+        env = os.environ.copy()
+        env.update({"TART_HOME": self.tmp_dir.name})
+
+        completed_process = subprocess.run(["tart"] + args, env=env, capture_output=True)
+
+        completed_process.check_returncode()
+
+        return completed_process.stdout.decode("utf-8"), completed_process.stderr.decode("utf-8")

integration-tests/test_clone.py

@@ -0,0 +1,10 @@
+def test_clone(tart):
+    # Create a Linux VM (because we can create it really fast)
+    tart.run(["create", "--linux", "debian"])
+
+    # Clone the VM
+    tart.run(["clone", "debian", "ubuntu"])
+
+    # Ensure that we have now 2 VMs
+    stdout, _, = tart.run(["list", "--quiet"])
+    assert stdout == "debian\nubuntu\n"

integration-tests/test_create.py

@@ -0,0 +1,16 @@
+def test_create_macos(tart):
+    # Create a macOS VM
+    tart.run(["create", "--from-ipsw", "latest", "macos-vm"])
+
+    # Ensure that the VM was created
+    stdout, _ = tart.run(["list", "--quiet"])
+    assert stdout == "macos-vm\n"
+
+
+def test_create_linux(tart):
+    # Create a Linux VM
+    tart.run(["create", "--linux", "linux-vm"])
+
+    # Ensure that the VM was created
+    stdout, _ = tart.run(["list", "--quiet"])
+    assert stdout == "linux-vm\n"

integration-tests/test_delete.py

@@ -0,0 +1,14 @@
+def test_delete(tart):
+    # Create a Linux VM (because we can create it really fast)
+    tart.run(["create", "--linux", "debian"])
+
+    # Ensure that the VM exists
+    stdout, _, = tart.run(["list", "--quiet"])
+    assert stdout == "debian\n"
+
+    # Delete the VM
+    tart.run(["delete", "debian"])
+
+    # Ensure that the VM was removed
+    stdout, _, = tart.run(["list", "--quiet"])
+    assert stdout == ""

integration-tests/test_oci.py

@@ -0,0 +1,55 @@
+import os
+import tempfile
+import timeit
+import uuid
+
+import bitmath
+import pytest
+
+amount_to_transfer = bitmath.GB(1)
+minimal_speed_per_second = bitmath.Mb(100)
+
+
+class TestOCI:
+    @pytest.mark.dependency()
+    def test_push_speed(self, tart, vm_with_random_disk, docker_registry):
+        start = timeit.default_timer()
+        tart.run(["push", "--insecure", vm_with_random_disk, docker_registry.remote_name(vm_with_random_disk)])
+        stop = timeit.default_timer()
+
+        actual_speed_per_second = self._calculate_speed_per_second(amount_to_transfer, stop - start)
+        assert actual_speed_per_second > minimal_speed_per_second
+
+    @pytest.mark.dependency(depends=["TestOCI::test_push_speed"])
+    def test_pull_speed(self, tart, vm_with_random_disk, docker_registry):
+        start = timeit.default_timer()
+        tart.run(["pull", "--insecure", docker_registry.remote_name(vm_with_random_disk)])
+        stop = timeit.default_timer()
+
+        actual_speed_per_second = self._calculate_speed_per_second(amount_to_transfer, stop - start)
+        assert actual_speed_per_second > minimal_speed_per_second
+
+    @staticmethod
+    def _calculate_speed_per_second(amount_transferred, time_taken):
+        return (amount_transferred / time_taken).best_prefix(bitmath.SI)
+
+
+@pytest.fixture(scope="class")
+def vm_with_random_disk(tart):
+    vm_name = str(uuid.uuid4())
+
+    # Create a VM (Linux for speed's sake)
+    tart.run(["create", "--linux", vm_name])
+
+    # Populate VM's disk with "amount_to_transfer" of random bytes
+    # to effectively disable Tart's OCI blob compression
+    disk_path = os.path.join(tart.home(), "vms", vm_name, "disk.img")
+
+    with tempfile.NamedTemporaryFile(delete=False) as tf:
+        tf.write(os.urandom(amount_to_transfer.bytes))
+        tf.close()
+        os.rename(tf.name, disk_path)
+
+    yield vm_name
+
+    tart.run(["delete", vm_name])

integration-tests/test_rename.py

@@ -0,0 +1,10 @@
+def test_rename(tart):
+    # Create a Linux VM (because we can create it really fast)
+    tart.run(["create", "--linux", "debian"])
+
+    # Rename that VM
+    tart.run(["rename", "debian", "ubuntu"])
+
+    # Ensure that the VM is now named "ubuntu"
+    stdout, _, = tart.run(["list", "--quiet"])
+    assert stdout == "ubuntu\n"