Merge pull request #9 from Automattic/add/benchmarking

Add Benchmarking + Configuration Backward Compatibility

Author: jkmassel

Package.swift

@@ -31,12 +31,24 @@ let package = Package(
                 .product(name: "Tqdm", package: "swift-tqdm"),
                 .product(name: "Logging", package: "swift-log"),
                 .product(name: "kcpassword", package: "kcpassword"),
+                .target(name: "libhostmgr")
             ],
             exclude: ["resources"]
         ),
+        .target(
+            name: "libhostmgr",
+            dependencies: [
+                .product(name: "ArgumentParser", package: "swift-argument-parser"),
+                .product(name: "SotoS3", package: "soto"),
+            ]
+        ),
         .testTarget(
-            name: "hostmgrTests",
-            dependencies: ["hostmgr"]
+            name: "libhostmgrTests",
+            dependencies: ["libhostmgr"],
+            resources: [
+                .copy("resources/configurations/0.6.0.json"),
+                .copy("resources/configurations/defaults.json"),
+            ]
         ),
     ]
 )

Sources/hostmgr/BenchmarkCommand.swift

@@ -0,0 +1,13 @@
+import Foundation
+import ArgumentParser
+
+struct BenchmarkCommand: ParsableCommand {
+    static let configuration = CommandConfiguration(
+        commandName: "benchmark",
+        abstract: "System tests",
+        subcommands: [
+            NetworkBenchmark.self,
+            DiskBenchmark.self
+        ]
+    )
+}

Sources/hostmgr/SyncCommand.swift

@@ -1,5 +1,6 @@
 import Foundation
 import ArgumentParser
+import libhostmgr
 
 struct SyncCommand: ParsableCommand {
     static let configuration = CommandConfiguration(
@@ -15,7 +16,7 @@ struct SyncCommand: ParsableCommand {
     var list: Bool = false
 
     @Argument
-    var task: SchedulableSyncCommand?
+    var task: Configuration.SchedulableSyncCommand?
 
     func run() throws {
 
@@ -25,7 +26,7 @@ struct SyncCommand: ParsableCommand {
         }
 
         if list {
-            SchedulableSyncCommand.allCases.forEach { print($0) }
+            Configuration.SchedulableSyncCommand.allCases.forEach { print($0) }
             return
         }
 
@@ -38,10 +39,10 @@ struct SyncCommand: ParsableCommand {
         }
     }
 
-    private func perform(task: SchedulableSyncCommand) throws {
+    private func perform(task: Configuration.SchedulableSyncCommand) throws {
         switch task {
-            case .authorized_keys: try SyncAuthorizedKeysTask().run()
-            case .vm_images: try SyncVMImagesTask().run()
+            case .authorizedKeys: try SyncAuthorizedKeysTask().run()
+            case .vmImages: try SyncVMImagesTask().run()
         }
     }
 }

Sources/hostmgr/commands/benchmark/DiskBenchmark.swift

@@ -0,0 +1,40 @@
+import Foundation
+import ArgumentParser
+import prlctl
+import Logging
+
+private let startDate = Date()
+
+struct DiskBenchmark: ParsableCommand {
+    static let configuration = CommandConfiguration(
+        commandName: "disk",
+        abstract: "Test Disk Write"
+    )
+
+    func run() throws {
+        let byteCount = 4096
+        let bytes = Data([UInt8](repeating: 0, count: byteCount))
+        let tempFile = try FileManager.default.createTemporaryFile()
+        let file = try FileHandle(forWritingTo: tempFile)
+
+        var totalBytesWritten: Int64 = 0
+
+        while true {
+            file.write(bytes)
+            totalBytesWritten += Int64(byteCount)
+
+            /// Sample only one in 100 entries
+            guard Int.random(in: 0...1000) == 0 else {
+                continue
+            }
+
+            let writtenSize = ByteCountFormatter.string(fromByteCount: totalBytesWritten, countStyle: .file)
+
+            let secondsElapsed = Date().timeIntervalSince(startDate)
+            let perSecond = Double(totalBytesWritten) / Double(secondsElapsed)
+            let rate = ByteCountFormatter.string(fromByteCount: Int64(perSecond), countStyle: .file)
+
+            print("\(writtenSize) written  [Rate: \(rate) per second]")
+        }
+    }
+}

Sources/hostmgr/commands/benchmark/NetworkBenchmark.swift

@@ -0,0 +1,46 @@
+import Foundation
+import ArgumentParser
+import prlctl
+import Logging
+import libhostmgr
+
+private let startDate = Date()
+
+struct NetworkBenchmark: ParsableCommand {
+
+    static let configuration = CommandConfiguration(
+        commandName: "network",
+        abstract: "Test Network Speed"
+    )
+
+    func run() throws {
+        guard let file = try VMRemoteImageManager().list().sorted(by: { $0.size < $1.size }).first else {
+            throw CleanExit.message("Unable to find a remote image to use as a network benchmark")
+        }
+
+        try S3Manager().streamingDownloadFile(
+            region: Configuration.shared.vmImagesRegion,
+            bucket: Configuration.shared.vmImagesBucket,
+            key: file.imageKey,
+            destination: URL(fileURLWithPath: "/dev/null"),
+            progressCallback: self.showProgress
+        )
+    }
+
+    private func showProgress(availableBytes: Int, downloadedBytes: Int, totalBytes: Int64) -> Void {
+
+        /// Sample only one in 100 entries
+        guard Int.random(in: 0...1000) == 0 else {
+            return
+        }
+
+        let downloadedSize = ByteCountFormatter.string(fromByteCount: Int64(downloadedBytes), countStyle: .file)
+        let totalSize = ByteCountFormatter.string(fromByteCount: totalBytes, countStyle: .file)
+
+        let secondsElapsed = Date().timeIntervalSince(startDate)
+        let perSecond = Double(downloadedBytes) / Double(secondsElapsed)
+        let rate = ByteCountFormatter.string(fromByteCount: Int64(perSecond), countStyle: .file)
+
+        logger.info("Downloaded \(downloadedSize) of \(totalSize) [Rate: \(rate) per second]")
+    }
+}

Sources/hostmgr/commands/generate/GenerateBuildkiteJobScript.swift

@@ -1,6 +1,7 @@
 import Foundation
 import ArgumentParser
 import prlctl
+import libhostmgr
 
 struct GenerateBuildkiteJobScript: ParsableCommand {
 

Sources/hostmgr/commands/generate/GenerateGitMirrorManifestCommand.swift

@@ -1,6 +1,7 @@
 import Foundation
 import ArgumentParser
 import Logging
+import libhostmgr
 
 struct GenerateGitMirrorManifestCommand: ParsableCommand {
 

Sources/hostmgr/commands/sync/SyncAuthorizedKeysCommand.swift

@@ -1,6 +1,7 @@
 import Foundation
 import ArgumentParser
 import SotoS3
+import libhostmgr
 
 struct SyncAuthorizedKeysCommand: ParsableCommand {
 

Sources/hostmgr/commands/sync/SyncVMImagesCommand.swift

@@ -2,6 +2,7 @@ import Foundation
 import ArgumentParser
 import SotoS3
 import prlctl
+import libhostmgr
 
 struct SyncVMImagesCommand: ParsableCommand {
 

Sources/hostmgr/commands/vm/image/local/VMLocalImageManager.swift

@@ -1,5 +1,6 @@
 import Foundation
 import prlctl
+import libhostmgr
 
 struct VMLocalImageManager {