macinbox 3.1.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 56a162b7814012ac1d148abdbec556b1ad44c947
-  data.tar.gz: 0f6bb9b0154454670a525045fc40627462d84e21
+  metadata.gz: e03354e3ebf3d421641208fbd59e61b96a3bfd3b
+  data.tar.gz: 3f90e09c1a0bb98d6acb2512dd2644446e635a17
 SHA512:
-  metadata.gz: aa4a303bfdf7567dad85868082c79ed8e3305f6a72245f043995c0d4d2ae08fd1c07a95f197dcae949b1801e202a84e47fbe9e7aa7b40d6fe4c0478fa9ffb1ba
-  data.tar.gz: 3a3f827be1a640ec9394344bc0a5e5695a9f6304587203d9ddeb1ebbc5c050db8ffe43f15ac73e35952da1c86316ecf528c663037d46548f587653b06f3df2c9
+  metadata.gz: d8e7d1fd2a1b05a6bd89c778ef095ff70f268934281cc263f32375d5119dc25ac9ed3f3315e6e1316d7c1d93f4b23bf5314c32c557d2945a5c58b62e78902a55
+  data.tar.gz: 0d64344b66fb076a07e879a93a66c38d51d67adcd84c48679b83ac579494329e6f31d1e1201e240fb9abd68f36023121a8e15a8871e0b1a8d56db3fc7bc15171

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+## 3.2.0 (February 2, 2019)
+
+FEATURES:
+
+- Add --use-qemu option to support building vmware_desktop boxes with qemu-img. [GH-12]
+- Add --installer-dmg option to support using installers wrapped in disk images. [GH-21]
+
+IMPROVEMENTS:
+
+- Use clonefile (`cp -c`) to copy files faster.
+- Use the detected OS version as the box version.
+- Skip creation of the wrapper image when it isn't necessary. [GH-21]
+
 ## 3.1.0 (January 21, 2019)
 
 FEATURES:

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    macinbox (3.1.0)
+    macinbox (3.2.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -16,26 +16,49 @@ Supports creating boxes in either the 'vmware_fusion', 'vmware_desktop', 'parall
 * At least 2 cores (4 recommended)
 * At least 100 GB of available disk space
 
-## Dependencies
+## Additional Dependencies
 
-The following software is required. Versions other than those mentioned may work, but these are the latest versions tested:
+The following software is required. Versions other than those mentioned may work, but these are the latest versions tested.
+
+### Vagrant
+
+To boot a box created by `macinbox` you will need Vagrant:
 
-* [macOS 10.14.2 Mojave installer application](http://appstore.com/mac/macosmojave)
 * [Vagrant 2.2.3](https://www.vagrantup.com/)
 
-To create and boot a box in the 'vmware_fusion' or 'vmware_desktop' formats you must also have:
+### macOS Installer
+
+To create a box you will need a macOS installer application:
+
+* [macOS 10.14.3 Mojave installer application](http://appstore.com/mac/macosmojave)
+
+Previous versions of the macOS installer (e.g. High Sierra) may also work.
+
+**NOTE:** If you have questions about the permissibility of virtualizing macOS you may want to review the documentation for the virtualization software you are using and the [software license agreement](https://www.apple.com/legal/sla/) for macOS.
+
+### Virtualization Software
+
+One of the following virtualization applications is required:
+
+#### VMware Fusion
+
+To create and boot a box in the 'vmware_fusion' or 'vmware_desktop' formats you will need:
 
 * [VMware Fusion Pro 10.1.5](http://www.vmware.com/products/fusion.html)
 * [Vagrant VMware Desktop Provider 2.0.1](https://www.vagrantup.com/vmware/)
 
-**NOTE:** VMware Fusion Pro 11 is not yet supported; see [issue #12](https://github.com/bacongravy/macinbox/issues/12) for more information.
+**NOTE:** VMware Fusion Pro 11 is not yet supported for box creation; see [issue #12](https://github.com/bacongravy/macinbox/issues/12) for more information. As a workaround you can install `qemu-img` and pass the `--use-qemu` option.
 
-To create and boot a box in the 'parallels' format you must also have:
+#### Parallels Desktop
+
+To create and boot a box in the 'parallels' format you will need:
 
 * [Parallels Desktop 14 for Mac Pro Edition 14.1.0](https://www.parallels.com/products/desktop/)
 * [Vagrant Parallels Provider 1.7.8](https://parallels.github.io/vagrant-parallels/)
 
-To create and boot a box in the 'virtualbox' format you must also have:
+#### VirtualBox
+
+To create and boot a box in the 'virtualbox' format you will need:
 
 * [VirtualBox 6.0.2 with the extension pack](https://www.virtualbox.org)
 
@@ -80,6 +103,7 @@ Usage: macinbox [options]
     -p, --password PASSWORD          Password of the user    (default: vagrant)
 
         --installer PATH             Path to the macOS installer app
+        --installer-dmg PATH         Path to a macOS installer app disk image
         --vmware PATH                Path to the VMware Fusion app
         --parallels PATH             Path to the Parallels Desktop app
 
@@ -89,6 +113,8 @@ Usage: macinbox [options]
         --no-fullscreen              Display the virtual machine GUI in a window
         --no-gui                     Disable the GUI
 
+        --use-qemu                   Use qemu-img (vmware_desktop only)
+
         --debug                      Enable debug mode
 
     -v, --version
@@ -107,7 +133,7 @@ If you have the VAGRANT_HOME environment variable set and want the created box t
 
 ## Retina Display and HiDPI Support
 
-By default `macinbox` will configure the guest OS to have HiDPI resolutions enabled, and configure the virtual machine to use the native display resolution.  You can disable this behavior using the `--no-hidpi` option.
+By default `macinbox` will configure the guest OS to have HiDPI resolutions enabled, and configure the virtual machine to use the native display resolution. You can disable this behavior using the `--no-hidpi` option.
 
 ## Box Format Support
 
@@ -117,6 +143,10 @@ When the box format is set to 'parallels' using the `--box-format` option then t
 
 When the box format is set to 'virtualbox' no guest extensions are installed. Note that some features behave differently with VirtualBox. The screen resolution is set to 1280x800 and HiDPI resolutions are not supported. The GUI scale factor is set to 2.0 (so that the VM displays properly on a host with a retina display) unless the `--no-hidpi` option is used. Lastly, ssh port-forwarding is enabled by default so that the host can connect to the guest.
 
+## Installer Disk Image Support
+
+The `--installer-dmg` option allows you to indicate the path to a disk image containing a macOS installer, and overrides the `--installer` option. The specified disk image should not already be mounted; `macinbox` will mount and unmount it as needed. This feature allows you to use the installer disk images created by [installinstallmacos.py](https://github.com/munki/macadmin-scripts/blob/master/installinstallmacos.py) as part of the `macinbox` workflow.
+
 ## Implementation Details
 
 This tool performs the following actions:
@@ -190,16 +220,41 @@ opts = Macinbox::CLI::DEFAULT_OPTION_VALUES
 opts[:collector] = Macinbox::Collector.new
 opts[:full_name] = "Vagrant"
 opts[:password] = "vagrant"
-opts[:box_format] = "virtualbox"
-opts[:image_path] = "macinbox.dmg"
-opts[:vdi_path] = "macinbox.vdi"
-opts[:box_path] = "macinbox.box"
-opts[:boxes_dir] = File.expand_path "~/.vagrant.d"
+opts[:image_path] = "macinbox.sparseimage"
+opts[:boxes_dir] = File.expand_path "~/.vagrant.d/boxes"
 opts[:debug] = true
+
 include Macinbox::Actions
+
+opts[:macos_version] = CheckMacosVersions.new(opts).run
+
 CreateImageFromInstaller.new(opts).run
+
+opts[:vmdk_path] = "macinbox.vmdk"
+CreateVMDKFromImage.new(opts).run
+
+opts[:box_format] = "vmware_desktop"
+opts[:box_path] = "vmware_desktop.box"
+CreateBoxFromVMDK.new(opts).run
+InstallBox.new(opts).run
+
+opts[:hdd_path] = "macinbox.hdd"
+CreateHDDFromImage.new(opts).run
+
+opts[:box_format] = "parallels"
+opts[:box_path] = "parallels.box"
+CreateBoxFromHDD.new(opts).run
+InstallBox.new(opts).run
+
+opts[:vdi_path] = "macinbox.vdi"
 CreateVDIFromImage.new(opts).run
+
+opts[:box_format] = "virtualbox"
+opts[:box_path] = "virtualbox.box"
 CreateBoxFromVDI.new(opts).run
+InstallBox.new(opts).run
+
+opts[:collector].cleanup!
 ```
 
 To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

data/lib/macinbox.rb

@@ -1,8 +1,10 @@
 require "macinbox/actions"
 require "macinbox/cli"
 require "macinbox/collector"
+require "macinbox/copyfiles"
 require "macinbox/error"
 require "macinbox/logger"
 require "macinbox/task"
 require "macinbox/tty"
 require "macinbox/version"
+require "macinbox/virtual_disk"

data/lib/macinbox/actions.rb

@@ -1,3 +1,4 @@
+require "macinbox/actions/check_macos_versions"
 require "macinbox/actions/create_box_from_hdd"
 require "macinbox/actions/create_box_from_vdi"
 require "macinbox/actions/create_box_from_vmdk"

data/lib/macinbox/actions/check_macos_versions.rb

@@ -0,0 +1,44 @@
+module Macinbox
+
+  module Actions
+
+    class CheckMacosVersions
+
+      def initialize(opts)
+        @installer_app     = opts[:installer_path]  or raise ArgumentError.new(":installer_path not specified")
+
+        @collector         = opts[:collector]       or raise ArgumentError.new(":collector not specified")
+        @debug             = opts[:debug]
+
+        raise Macinbox::Error.new("Installer app not found") unless File.exist? @installer_app
+      end
+
+      def run
+        install_info_plist = "#{@installer_app}/Contents/SharedSupport/InstallInfo.plist"
+        raise Macinbox::Error.new("InstallInfo.plist not found in installer app bundle") unless File.exist? install_info_plist
+
+        installer_os_version = Task.backtick %W[ /usr/libexec/PlistBuddy -c #{'Print :System\ Image\ Info:version'} #{install_info_plist} ]
+        installer_os_version_components = installer_os_version.split(".") rescue [0, 0, 0]
+        installer_os_version_major = installer_os_version_components[0]
+        installer_os_version_minor = installer_os_version_components[1]
+        Logger.info "Installer macOS version detected: #{installer_os_version}" if @debug
+
+        host_os_version = Task.backtick %W[ /usr/bin/sw_vers -productVersion ]
+        host_os_version_components = host_os_version.split(".") rescue [0, 0, 0]
+        host_os_version_major = host_os_version_components[0]
+        host_os_version_minor = host_os_version_components[1]
+        Logger.info "Host macOS version detected: #{host_os_version}" if @debug
+
+        if installer_os_version_major != host_os_version_major || installer_os_version_minor != host_os_version_minor
+          Logger.error "Warning: host OS version (#{host_os_version}) and installer OS version (#{installer_os_version}) do not match"
+          # raise Macinbox::Error.new("host OS version (#{host_os_version}) and installer OS version (#{installer_os_version}) do not match")
+        end
+
+        installer_os_version
+      end
+
+    end
+
+  end
+
+end

data/lib/macinbox/actions/create_box_from_hdd.rb

@@ -1,6 +1,7 @@
 require 'fileutils'
 require 'rubygems/package'
 
+require 'macinbox/copyfiles'
 require 'macinbox/error'
 require 'macinbox/logger'
 require 'macinbox/task'
@@ -62,7 +63,8 @@ module Macinbox
             Task.run %W[ prlctl unregister macinbox ] + [task_opts]
           end
 
-          Task.run %W[ /bin/cp -r #{@input_hdd} #{@box_dir}/macinbox.pvm/macinbox.hdd ] + [task_opts]
+          Macinbox::copyfiles(from: @input_hdd, to: "#{@box_dir}/macinbox.pvm/macinbox.hdd", recursive: true)
+          
           Task.run %W[ prl_disk_tool convert --merge --hdd #{@box_dir}/macinbox.pvm/macinbox.hdd ] + [task_opts]
           Task.run %W[ prlctl set macinbox --device-add hdd --image #{@box_dir}/macinbox.pvm/macinbox.hdd ] + [task_opts]
           Task.run %W[ prlctl set macinbox --high-resolution #{@hidpi ? "on" : "off"} ] + [task_opts]

data/lib/macinbox/actions/create_box_from_vmdk.rb

@@ -1,6 +1,7 @@
 require 'fileutils'
 require 'rubygems/package'
 
+require 'macinbox/copyfiles'
 require 'macinbox/error'
 require 'macinbox/logger'
 require 'macinbox/task'
@@ -28,7 +29,7 @@ module Macinbox
         @debug             = opts[:debug]
 
         raise Macinbox::Error.new("VMDK not found") unless File.exist? @input_vmdk
-        raise Macinbox::Error.new("Box format not supported: #{@box_format}") unless ["vmware_fusion", "vmware_desktop"].include? @box_format        
+        raise Macinbox::Error.new("Box format not supported: #{@box_format}") unless ["vmware_fusion", "vmware_desktop"].include? @box_format
       end
 
       def run
@@ -128,7 +129,7 @@ module Macinbox
             end
           EOF
 
-          FileUtils.cp @input_vmdk, "#{@box_dir}/macinbox.vmdk"
+          Macinbox::copyfiles(from: @input_vmdk, to: "#{@box_dir}/macinbox.vmdk")
 
         end
 

data/lib/macinbox/actions/create_hdd_from_image.rb

@@ -1,9 +1,11 @@
 require 'fileutils'
 require 'shellwords'
 
+require 'macinbox/copyfiles'
 require 'macinbox/error'
 require 'macinbox/logger'
 require 'macinbox/task'
+require 'macinbox/virtual_disk'
 
 module Macinbox
 
@@ -24,88 +26,164 @@ module Macinbox
       end
 
       def run
+        create_temp_dir
+        copy_input_image
+        attach_image
+        install_parallels_tools
+        eject_and_reattach_image
+        convert_image
+        save_image
+      end
+
+      def create_temp_dir
         @temp_dir = Task.backtick %W[ /usr/bin/mktemp -d -t create_hdd_from_image ]
         @collector.add_temp_dir @temp_dir
+      end
 
+      def copy_input_image
+        Logger.info "Copying the image..." do
+          @image = "#{@temp_dir}/macinbox.sparseimage"
+          Macinbox::copyfiles(from: @input_image, to: @image)
+        end
+      end
+
+      def attach_image
         Logger.info "Attaching the image..." do
+          @disk = VirtualDisk.new(@image, @debug)
+          @collector.on_cleanup { @disk.detach! }
+          @image_mountpoint = "#{@temp_dir}/image_mountpoint"
+          FileUtils.mkdir @image_mountpoint
+          @disk.attach
+          @disk.mount(at: @image_mountpoint, owners: true)
+        end
+      end
+
+      def install_parallels_tools
+
+        Logger.info "Installing the Parallels Tools..." do
+
+          tools_image = "#{@parallels_app}/Contents/Resources/Tools/prl-tools-mac.iso"
+
+          tools_disk = VirtualDisk.new(tools_image, @debug)
+
+          @collector.on_cleanup { tools_disk.detach! }
 
-          @collector.on_cleanup do
-            %x( diskutil eject #{@device.shellescape} > /dev/null 2>&1 ) if @device
+          tools_mountpoint = "#{@temp_dir}/tools_mountpoint"
+          FileUtils.mkdir tools_mountpoint
+
+          tools_disk.attach
+          tools_disk.mount(at: tools_mountpoint)
+
+          tools_packages_dir = "#{tools_mountpoint}/Install.app/Contents/Resources/Install.mpkg/Contents/Packages"
+
+          tools_packages = [
+            "Parallels Tools Audio 10.9.pkg",
+            "Parallels Tools Coherence.pkg",
+            "Parallels Tools CopyPaste.pkg",
+            "Parallels Tools DragDrop.pkg",
+            "Parallels Tools HostTime.pkg",
+            "Parallels Tools InstallationAgent.pkg",
+            "Parallels Tools Network 10.9.pkg",
+            "Parallels Tools SharedFolders.pkg",
+            "Parallels Tools TimeSync.pkg",
+            "Parallels Tools ToolGate 10.9.pkg",
+            "Parallels Tools Utilities.pkg",
+            "Parallels Tools Video 10.9.pkg"
+          ]
+
+          tools_expanded_packages_dir = "#{@temp_dir}/tools_packages"
+          FileUtils.mkdir tools_expanded_packages_dir
+
+          tools_packages.each do |package|
+            Task.run %W[ /usr/sbin/pkgutil --expand #{tools_packages_dir}/#{package} #{tools_expanded_packages_dir}/#{package} ]
+            Task.run %W[ /usr/bin/ditto -x -z #{tools_expanded_packages_dir}/#{package}/Payload #{@image_mountpoint} ]
           end
 
-          @device = %x(
-            /usr/bin/hdiutil attach #{@input_image.shellescape} -nomount |
-            /usr/bin/grep _partition_scheme |
-            /usr/bin/cut -f1 |
-            /usr/bin/tr -d [:space:]
-          )
+          prl_nettool_source = "/Library/Parallels Guest Tools/prl_nettool"
+          prl_nettool_target = "#{@image_mountpoint}/usr/local/bin/prl_nettool"
+
+          FileUtils.mkdir_p File.dirname(prl_nettool_target)
+          FileUtils.ln_s prl_nettool_source, prl_nettool_target
+
+          prl_fsd_plist = "#{@image_mountpoint}/Library/LaunchDaemons/com.parallels.vm.prl_fsd.plist"
+          Task.run %W[ /usr/bin/sed -i #{''} s/PARALLELS_ADDITIONAL_ARGS/--share/ #{prl_fsd_plist} ]
 
-          raise Macinbox::Error.new("failed to attach the image") unless File.exist? @device
+          contents = "/Library/Parallels\ Guest\ Tools/dynres --enable-retina\n"
+          File.write "#{@image_mountpoint}/private/etc/rc.vagrant", contents, mode: 'a'
+
+          tools_disk.eject
         end
 
-        Logger.info "Converting the image to HDD format..." do
+        def eject_and_reattach_image
+          Logger.info "Reattaching the image..." do
+            @disk.eject
+            @disk.attach
+          end
+        end
 
-          disk_info = Task.backtick %W[ /usr/sbin/fdisk #{@device} ]
+        def convert_image
+          Logger.info "Converting the image to HDD format..." do
 
-          geometry_re = /geometry: (\d+)\/(\d+)\/(\d+) \[(\d+) sectors\]/
+            disk_info = Task.backtick %W[ /usr/sbin/fdisk #{@disk.device} ]
 
-          match = geometry_re.match(disk_info)
+            geometry_re = /geometry: (\d+)\/(\d+)\/(\d+) \[(\d+) sectors\]/
 
-          raise Macinbox::Error.new("failed to determine disk geometry") if match.nil? || match.captures.length != 4
+            match = geometry_re.match(disk_info)
 
-          device_sectors = match.captures[3]
+            raise Macinbox::Error.new("failed to determine disk geometry") if match.nil? || match.captures.length != 4
 
-          device_cylinders = match.captures[0]
-          device_heads_per_track = match.captures[1]
-          device_sectors_per_track = match.captures[2]
+            device_sectors = match.captures[3]
 
-          bios_cylinders = 1024
-          bios_heads_per_track = device_heads_per_track
-          bios_sectors_per_track = device_sectors_per_track
+            device_cylinders = match.captures[0]
+            device_heads_per_track = match.captures[1]
+            device_sectors_per_track = match.captures[2]
 
-          File.write "#{@temp_dir}/macinbox.vmdk", <<~EOF
-            # Disk DescriptorFile
-            version=1
-            encoding="UTF-8"
-            CID=fffffffe
-            parentCID=ffffffff
-            isNativeSnapshot="no"
-            createType="monolithicFlat"
+            bios_cylinders = 1024
+            bios_heads_per_track = device_heads_per_track
+            bios_sectors_per_track = device_sectors_per_track
 
-            # Extent description
-            RW #{device_sectors} FLAT "#{@device}" 0
+            File.write "#{@temp_dir}/macinbox.vmdk", <<~EOF
+              # Disk DescriptorFile
+              version=1
+              encoding="UTF-8"
+              CID=fffffffe
+              parentCID=ffffffff
+              isNativeSnapshot="no"
+              createType="monolithicFlat"
 
-            # The Disk Data Base
-            #DDB
+              # Extent description
+              RW #{device_sectors} FLAT "#{@disk.device}" 0
 
-            ddb.adapterType = "lsilogic"
-            ddb.deletable = "true"
-            ddb.geometry.biosCylinders = "#{bios_cylinders}"
-            ddb.geometry.biosHeads = "#{bios_heads_per_track}"
-            ddb.geometry.biosSectors = "#{bios_sectors_per_track}"
-            ddb.geometry.cylinders = "#{device_cylinders}"
-            ddb.geometry.heads = "#{device_heads_per_track}"
-            ddb.geometry.sectors = "#{device_sectors_per_track}"
-            ddb.longContentID = "9fa218b506cfe68615c39994fffffffe"
-            ddb.uuid = "60 00 C2 99 91 76 dd 77-6e 0d 84 8b b0 24 6e 00"
-            ddb.virtualHWVersion = "14"
-          EOF
+              # The Disk Data Base
+              #DDB
 
-          prl_convert = "#{@parallels_app}/Contents/MacOS/prl_convert"
-          task_opts = @debug ? {} : { :out => File::NULL }
-          Task.run %W[ #{prl_convert} #{@temp_dir}/macinbox.vmdk --allow-no-os --dst=#{@temp_dir} ] + [task_opts]
+              ddb.adapterType = "lsilogic"
+              ddb.deletable = "true"
+              ddb.geometry.biosCylinders = "#{bios_cylinders}"
+              ddb.geometry.biosHeads = "#{bios_heads_per_track}"
+              ddb.geometry.biosSectors = "#{bios_sectors_per_track}"
+              ddb.geometry.cylinders = "#{device_cylinders}"
+              ddb.geometry.heads = "#{device_heads_per_track}"
+              ddb.geometry.sectors = "#{device_sectors_per_track}"
+              ddb.longContentID = "9fa218b506cfe68615c39994fffffffe"
+              ddb.uuid = "60 00 C2 99 91 76 dd 77-6e 0d 84 8b b0 24 6e 00"
+              ddb.virtualHWVersion = "14"
+            EOF
 
+            prl_convert = "#{@parallels_app}/Contents/MacOS/prl_convert"
+            task_opts = @debug ? {} : { :out => File::NULL }
+            Task.run %W[ #{prl_convert} #{@temp_dir}/macinbox.vmdk --allow-no-os --dst=#{@temp_dir} ] + [task_opts]
+            @disk.eject
+          end
         end
 
-        Logger.info "Moving the HDD to the destination..." do
-          FileUtils.chown_R ENV["SUDO_USER"], nil, "#{@temp_dir}/macinbox.hdd"
-          FileUtils.mv "#{@temp_dir}/macinbox.hdd", @output_path
+        def save_image
+          Logger.info "Moving the HDD to the destination..." do
+            FileUtils.chown_R ENV["SUDO_USER"], nil, "#{@temp_dir}/macinbox.hdd"
+            FileUtils.mv "#{@temp_dir}/macinbox.hdd", @output_path
+          end
         end
 
-        task_opts = @debug ? {} : { :out => File::NULL }
-        Task.run %W[ /usr/sbin/diskutil eject #{@device.shellescape} ] + [task_opts]
-        @device = nil
-
       end
 
     end