-
Notifications
You must be signed in to change notification settings - Fork 145
Introduce "tart ip" command to retrieve a VM's IP address #8
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,116 @@ | ||
| import Foundation | ||
| import Network | ||
| import Virtualization | ||
|
|
||
| struct ARPCommandFailedError: Error, CustomStringConvertible { | ||
| var terminationReason: Process.TerminationReason | ||
| var terminationStatus: Int32 | ||
|
|
||
| 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)" | ||
| } | ||
| } | ||
|
|
||
| struct ARPCommandYieldedInvalidOutputError: Error, CustomStringConvertible { | ||
| var explanation: String | ||
|
|
||
| var description: String { | ||
| "arp command yielded invalid output: \(explanation)" | ||
| } | ||
| } | ||
|
|
||
| struct ARPCacheInternalError: Error, CustomStringConvertible { | ||
| var explanation: String | ||
|
|
||
| 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 pipe = Pipe() | ||
| process.standardOutput = pipe | ||
| process.standardError = pipe | ||
| process.standardInput = FileHandle.nullDevice | ||
|
|
||
| try process.run() | ||
| process.waitUntilExit() | ||
|
|
||
| if !(process.terminationReason == .exit && process.terminationStatus == 0) { | ||
| throw ARPCommandFailedError( | ||
| terminationReason: process.terminationReason, | ||
| terminationStatus: process.terminationStatus) | ||
| } | ||
|
|
||
| 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) | ||
| 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) | ||
|
|
||
| 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]) | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| import Foundation | ||
|
|
||
| struct MACAddress: Equatable, CustomStringConvertible { | ||
| var mac: [UInt8] = Array(repeating: 0, count: 6) | ||
|
|
||
| init?(fromString: String) { | ||
| let components = fromString.components(separatedBy: ":") | ||
|
|
||
| if components.count != 6 { | ||
| return nil | ||
| } | ||
|
|
||
| for (index, component) in components.enumerated() { | ||
| mac[index] = UInt8(component, radix: 16)! | ||
| } | ||
| } | ||
|
|
||
| var description: String { | ||
| return String(format: "%02x:%02x:%02x:%02x:%02x:%02x", mac[0], mac[1], mac[2], mac[3], mac[4], mac[5]) | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| import ArgumentParser | ||
| import Foundation | ||
| import SystemConfiguration | ||
|
|
||
| struct IP: ParsableCommand { | ||
| static var configuration = CommandConfiguration(abstract: "Get VM's IP address") | ||
|
|
||
| @Argument(help: "VM name") | ||
| var name: String | ||
|
|
||
| func run() throws { | ||
| Task { | ||
| do { | ||
| let vmDir = try VMStorage().read(name) | ||
| let vmConfig = try VMConfig.init(fromURL: vmDir.configURL) | ||
| let vmMacAddress = MACAddress(fromString: vmConfig.macAddress.string)! | ||
|
|
||
| guard let ip = try ARPCache.ResolveMACAddress(macAddress: vmMacAddress) else { | ||
| print("no IP address found, is your VM running?") | ||
|
|
||
| Foundation.exit(1) | ||
| } | ||
|
|
||
| print(ip) | ||
|
|
||
| Foundation.exit(0) | ||
| } catch { | ||
| print(error) | ||
|
|
||
| Foundation.exit(1) | ||
| } | ||
| } | ||
|
|
||
| dispatchMain() | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should there be a
catch.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There is a
catch: https://github.com/cirruslabs/tart/pull/8/files#diff-ce228612f2d55d92ea5fead851340c9defba604654c93a42ab7ebd0972086470R27.