Rename snapshots and attempt to make them more tree like

Author: RLovelett

Sources/gitlab-fusion/Stages/Cleanup.swift

@@ -48,7 +48,7 @@ struct Cleanup: ParsableCommand {
         let base = VirtualMachine(image: baseVMPath, executable: options.vmwareFusion)
 
         /// The name of VMware Fusion guest created by the clone operation
-        let clonedGuestName = "\(base.name)-runner-\(ciRunnerId)-concurrent-\(ciConcurrentProjectId)"
+        let clonedGuestName = "\(base.name)-\(ciServerHost)-runner-\(ciRunnerId)-concurrent-\(ciConcurrentProjectId)"
 
         /// The path of the VMware Fusion guest created by the clone operation
         let clonedGuestPath = options.vmImagesPath

Sources/gitlab-fusion/Stages/Prepare.swift

@@ -79,18 +79,26 @@ struct Prepare: ParsableCommand {
         os_log("The base VMware Fusion guest is %{public}@", log: log, type: .debug, baseVMPath.string)
         let base = VirtualMachine(image: baseVMPath, executable: options.vmwareFusion)
 
-        /// The name of VMware Fusion guest created by the clone operation
-        let clonedGuestName = "\(base.name)-runner-\(ciRunnerId)-concurrent-\(ciConcurrentProjectId)"
+        // Check if the snapshot exists (creating it if necessary)
+        let rootSnapshotname = subsystem
+        if !base.snapshots.contains(rootSnapshotname) {
+            FileHandle.standardOutput
+                .write(line: "Creating snapshot \"\(rootSnapshotname)\" in base guest \"\(base.name)\"...")
+            try base.snapshot(rootSnapshotname)
+        }
 
         // Check if the snapshot exists (creating it if necessary)
-        let baseVMSnapshotName = "base-snapshot-\(clonedGuestName)"
-        if !base.snapshots.contains(baseVMSnapshotName) {
+        let cloneBaseSnapshotname = "\(ciServerHost)-runner-\(ciRunnerId)-concurrent-\(ciConcurrentProjectId)"
+        if !base.snapshots.contains(cloneBaseSnapshotname) {
             FileHandle.standardOutput
-                .write(line: "Creating snapshot \"\(baseVMSnapshotName)\" in base guest \"\(base.name)\"...")
-            try base.snapshot(baseVMSnapshotName)
+                .write(line: "Creating snapshot \"\(cloneBaseSnapshotname)\" in base guest \"\(base.name)\"...")
+            // Ensure that the common base snapshot is used
+            try base.revert(to: rootSnapshotname)
+            try base.snapshot(cloneBaseSnapshotname)
         }
 
         /// The path of the VMware Fusion guest created by the clone operation
+        let clonedGuestName = "\(base.name)-\(ciServerHost)-runner-\(ciRunnerId)-concurrent-\(ciConcurrentProjectId)"
         let clonedGuestPath = options.vmImagesPath
             .join("\(clonedGuestName).vmwarevm")
             .join("\(clonedGuestName).vmx")
@@ -99,8 +107,8 @@ struct Prepare: ParsableCommand {
         let clone: VirtualMachine
         if !clonedGuestPath.exists {
             FileHandle.standardOutput
-                .write(line: "Cloning from snapshot \"\(baseVMSnapshotName)\" in base guest \"\(base.name)\" to \"\(clonedGuestName)\"...")
-            clone = try base.clone(to: clonedGuestPath, named: clonedGuestName, linkedTo: baseVMSnapshotName)
+                .write(line: "Cloning from snapshot \"\(cloneBaseSnapshotname)\" in base guest \"\(base.name)\" to \"\(clonedGuestName)\"...")
+            clone = try base.clone(to: clonedGuestPath, named: clonedGuestName, linkedTo: cloneBaseSnapshotname)
         } else {
             clone = VirtualMachine(image: clonedGuestPath, executable: options.vmwareFusion)
         }

Sources/gitlab-fusion/Stages/Run.swift

@@ -65,7 +65,7 @@ struct Run: ParsableCommand {
         let base = VirtualMachine(image: baseVMPath, executable: options.vmwareFusion)
 
         /// The name of VMware Fusion guest created by the clone operation
-        let clonedGuestName = "\(base.name)-runner-\(ciRunnerId)-concurrent-\(ciConcurrentProjectId)"
+        let clonedGuestName = "\(base.name)-\(ciServerHost)-runner-\(ciRunnerId)-concurrent-\(ciConcurrentProjectId)"
 
         /// The path of the VMware Fusion guest created by the clone operation
         let clonedGuestPath = options.vmImagesPath

Sources/gitlab-fusion/main.swift

@@ -67,6 +67,22 @@ let ciConcurrentProjectId = Environment.CUSTOM_ENV_CI_CONCURRENT_PROJECT_ID ?? 0
 /// - SeeAlso: https://docs.gitlab.com/ee/ci/variables/predefined_variables.html
 let ciProjectPath = Environment.CUSTOM_ENV_CI_PROJECT_PATH ?? ""
 
+/// Host component of the GitLab instance URL, without protocol and port
+/// (like `gitlab.example.com`).
+///
+/// This is pulled from the environment variable
+/// `CUSTOM_ENV_CI_SERVER_HOST`. If that variable is unset then the value
+/// defaults to `me.lovelett.gitlab-fusion`.
+///
+/// The `CUSTOM_ENV_CI_SERVER_HOST` is a variation on the typical  GitLab
+/// predefined environment variable `CI_SERVER_HOST`. The environment variables
+/// provided by GitLab are prefixed with `CUSTOM_ENV_` to prevent conflicts with
+/// system environment variables.
+///
+/// - SeeAlso: https://docs.gitlab.com/runner/executors/custom.html#stages
+/// - SeeAlso: https://docs.gitlab.com/ee/ci/variables/predefined_variables.html
+let ciServerHost = Environment.CUSTOM_ENV_CI_SERVER_HOST ?? subsystem
+
 /// Collects the command-line options that were passed to `gitlab-fusion` and
 /// dispatches them to the appropriate subcommands (executor stages).
 struct GitlabFusion: ParsableCommand {