macinbox 3.3.0 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 36bd1285647b90d338e5519ba42e429e6bb8ea12
-  data.tar.gz: 65c6e91a11e43bed2921f006fe1469542d716205
+SHA256:
+  metadata.gz: 36a4f3b181302a8a5d4efdf5e23d97add1b2f7424c1b981d0fa8467f4317a398
+  data.tar.gz: cbab11b8a79ee6eb57db5e164ac34867a3e892f97b166afe3176d1ed9f629657
 SHA512:
-  metadata.gz: e08c547e56e15487b2d22cdc492aeaa7b3b78dd13b4df4ebdd77daa09537237b18413daa63bd3e473e2b67d4fb4e83137cf493cca63452e54fb994e5ced8953a
-  data.tar.gz: 1d4dbf5faac11e49922894e001ea1a32988a11dc85a9327f2f78a6708e9769c18ef32286fbb888273e74183b23e971cf3962328d77d0f443c798bb4df4c235cf
+  metadata.gz: 706f282c101a01f8077f3b5e826441610263aee40c19e7b3ffea6480be6c50252f0e38070c4160153abb094a898dddd5b4195fb5d75ae9ecd1c69f1002c54a6c
+  data.tar.gz: 65c34dc426dc8a155319a781d0225920208e02c5eeaf74d3c61791fe9cfa0c85a6e8fe79021f1713653c9bd17f14cba039472954182264b7e268b7f80992a687

data/CHANGELOG.md

@@ -1,3 +1,18 @@
+## 3.4.0 (November 12, 2019)
+
+FEATURES:
+
+- Create `vagrant` group on first boot of the box. [GH-37]
+- Add a preflight check to ensure that VMware disk conversion will be successful. [GH-12]
+
+BUG FIXES:
+
+- Handle missing package in Parallels Tools. [GH-43]
+
+IMPROVEMENTS:
+
+- Remove dependency on vmware-rawdiskCreator tool.
+
 ## 3.3.0 (February 26, 2019)
 
 FEATURES:

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    macinbox (3.3.0)
+    macinbox (3.4.0)
 
 GEM
   remote: https://rubygems.org/
@@ -17,4 +17,4 @@ DEPENDENCIES
   rake (~> 10.0)
 
 BUNDLED WITH
-   1.16.1
+   1.17.2

data/README.md

@@ -24,13 +24,13 @@ The following software is required. Versions other than those mentioned may work
 
 To boot a box created by `macinbox` you will need Vagrant:
 
-* [Vagrant 2.2.3](https://www.vagrantup.com/)
+* [Vagrant 2.2.5](https://www.vagrantup.com/)
 
 ### 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)
+* [macOS Mojave installer application](http://appstore.com/mac/macosmojave) Tested with 10.14.3, 10.14.4, 10.14.5, 10.14.6
 
 Previous versions of the macOS installer (e.g. High Sierra) may also work.
 
@@ -44,23 +44,21 @@ One of the following virtualization applications is required:
 
 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 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.
+* [VMware Fusion Pro 11.5.1](http://www.vmware.com/products/fusion.html)
+* [Vagrant VMware Desktop Provider 2.0.3](https://www.vagrantup.com/vmware/)
 
 #### 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/)
+* [Parallels Desktop 15 for Mac Pro Edition 15.0.0](https://www.parallels.com/products/desktop/)
+* [Vagrant Parallels Provider 2.0.1](https://parallels.github.io/vagrant-parallels/)
 
 #### 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)
+* [VirtualBox 6.0.12 with the extension pack](https://www.virtualbox.org)
 
 ## Installation
 
@@ -228,7 +226,7 @@ opts[:full_name] = "Vagrant"
 opts[:password] = "vagrant"
 opts[:image_path] = "macinbox.sparseimage"
 opts[:boxes_dir] = File.expand_path "~/.vagrant.d/boxes"
-opts[:debug] = true
+$debug = $verbose = true
 
 include Macinbox::Actions
 

data/lib/macinbox.rb

@@ -4,7 +4,9 @@ require "macinbox/collector"
 require "macinbox/copyfiles"
 require "macinbox/error"
 require "macinbox/logger"
+require "macinbox/os_version"
 require "macinbox/task"
 require "macinbox/tty"
 require "macinbox/version"
 require "macinbox/virtual_disk"
+require "macinbox/vmdk"

data/lib/macinbox/actions/check_macos_versions.rb

@@ -1,3 +1,6 @@
+require "macinbox/error"
+require "macinbox/os_version"
+
 module Macinbox
 
   module Actions
@@ -16,21 +19,14 @@ module Macinbox
         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]
+        installer_os_version = Macinbox::OSVersion.new(Task.backtick %W[ /usr/libexec/PlistBuddy -c #{'Print :System\ Image\ Info:version'} #{install_info_plist} ])
         Logger.info "Installer macOS version detected: #{installer_os_version}" if $verbose
 
-        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]
+        host_os_version = Macinbox::OSVersion.new(Task.backtick %W[ /usr/bin/sw_vers -productVersion ])
         Logger.info "Host macOS version detected: #{host_os_version}" if $verbose
 
-        if installer_os_version_major != host_os_version_major || installer_os_version_minor != host_os_version_minor
+        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

data/lib/macinbox/actions/create_hdd_from_image.rb

@@ -6,6 +6,7 @@ require 'macinbox/error'
 require 'macinbox/logger'
 require 'macinbox/task'
 require 'macinbox/virtual_disk'
+require 'macinbox/vmdk'
 
 module Macinbox
 
@@ -94,8 +95,10 @@ module Macinbox
           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} ]
+            if File.exist? "#{tools_packages_dir}/#{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
           end
 
           prl_nettool_source = "/Library/Parallels Guest Tools/prl_nettool"
@@ -122,53 +125,7 @@ module Macinbox
 
         def convert_image
           Logger.info "Converting the image to HDD format..." do
-
-            disk_info = Task.backtick %W[ /usr/sbin/fdisk #{@disk.device} ]
-
-            geometry_re = /geometry: (\d+)\/(\d+)\/(\d+) \[(\d+) sectors\]/
-
-            match = geometry_re.match(disk_info)
-
-            raise Macinbox::Error.new("failed to determine disk geometry") if match.nil? || match.captures.length != 4
-
-            device_sectors = match.captures[3]
-
-            device_cylinders = match.captures[0]
-            device_heads_per_track = match.captures[1]
-            device_sectors_per_track = match.captures[2]
-
-            bios_cylinders = 1024
-            bios_heads_per_track = device_heads_per_track
-            bios_sectors_per_track = device_sectors_per_track
-
-            File.write "#{@temp_dir}/macinbox.vmdk", <<~EOF
-              # Disk DescriptorFile
-              version=1
-              encoding="UTF-8"
-              CID=fffffffe
-              parentCID=ffffffff
-              isNativeSnapshot="no"
-              createType="monolithicFlat"
-
-              # Extent description
-              RW #{device_sectors} FLAT "#{@disk.device}" 0
-
-              # The Disk Data Base
-              #DDB
-
-              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
-
+            VMDK.create_raw_vmdk(@disk.device, "#{@temp_dir}/macinbox.vmdk")
             prl_convert = "#{@parallels_app}/Contents/MacOS/prl_convert"
             task_opts = $verbose ? {} : { :out => File::NULL }
             Task.run %W[ #{prl_convert} #{@temp_dir}/macinbox.vmdk --allow-no-os --dst=#{@temp_dir} ] + [task_opts]

data/lib/macinbox/actions/create_image_from_installer.rb

@@ -48,6 +48,7 @@ module Macinbox
         install_macos
         create_rc_vagrant
         automate_user_account_creation
+        automate_vagrant_group_creation
         automate_vagrant_ssh_key_installation
         enable_passwordless_sudo
         enable_sshd
@@ -107,17 +108,28 @@ module Macinbox
       end
 
       def create_rc_vagrant
-        scratch_rc_installer_cleanup = "#{@scratch_mountpoint}/private/etc/rc.installer_cleanup"
-        @scratch_rc_vagrant = "#{@scratch_mountpoint}/private/etc/rc.vagrant"
-        File.write scratch_rc_installer_cleanup, <<~EOF
-          #!/bin/sh
-          rm -f /etc/rc.installer_cleanup
-          /etc/rc.vagrant &
-          exit 0
+        first_boot_launch_daemon = "#{@scratch_mountpoint}/Library/LaunchDaemons/rc.vagrant.plist"
+        File.write first_boot_launch_daemon, <<~EOF
+          <?xml version="1.0" encoding="UTF-8"?>
+          <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+          <plist version="1.0">
+          <dict>
+            <key>Label</key>
+            <string>rc.vagrant</string>
+            <key>ProgramArguments</key>
+            <array>
+              <string>/etc/rc.vagrant</string>
+            </array>
+            <key>RunAtLoad</key>
+            <true/>
+          </dict>
+          </plist>
         EOF
-        FileUtils.chmod 0755, scratch_rc_installer_cleanup
+        FileUtils.chmod 0755, first_boot_launch_daemon
+        @scratch_rc_vagrant = "#{@scratch_mountpoint}/private/etc/rc.vagrant"
         File.write @scratch_rc_vagrant, <<~EOF
           #!/bin/sh
+          rm -r /Library/LaunchDaemons/rc.vagrant.plist
           rm -f /etc/rc.vagrant
         EOF
         FileUtils.chmod 0755, @scratch_rc_vagrant
@@ -154,6 +166,23 @@ module Macinbox
         end
       end
 
+      def automate_vagrant_group_creation
+        if @short_name == "vagrant"
+          Logger.info "Configuring the 'vagrant' group..." do
+            contents = <<~EOF
+              until dscl . -read /Users/vagrant UniqueID; do
+                sleep 1
+              done
+              dscl . -create /Groups/vagrant
+              dscl . -create /Groups/vagrant gid 501
+              dscl . -create /Groups/vagrant GroupMembers `dscl . -read /Users/vagrant GeneratedUID | cut -d ' ' -f 2`
+              dscl . -create /Groups/vagrant GroupMembership vagrant
+            EOF
+            File.write @scratch_rc_vagrant, contents, mode: 'a'
+          end
+        end
+      end
+
       def automate_vagrant_ssh_key_installation
         if @short_name == "vagrant"
           Logger.info "Installing the default insecure vagrant ssh key..." do

data/lib/macinbox/actions/create_vmdk_from_image.rb

@@ -6,6 +6,7 @@ require 'macinbox/error'
 require 'macinbox/logger'
 require 'macinbox/task'
 require 'macinbox/virtual_disk'
+require 'macinbox/vmdk'
 
 module Macinbox
 
@@ -139,11 +140,15 @@ module Macinbox
           else
             @disk.attach
             task_opts = $verbose ? {} : { :out => File::NULL }
-            rawdiskCreator = "#{@vmware_fusion_app}/Contents/Library/vmware-rawdiskCreator"
             vdiskmanager = "#{@vmware_fusion_app}/Contents/Library/vmware-vdiskmanager"
             Dir.chdir(@temp_dir) do
-              Task.run %W[ #{rawdiskCreator} create #{@disk.device} fullDevice rawdisk lsilogic ] + [task_opts]
-              Task.run %W[ #{vdiskmanager} -t 0 -r rawdisk.vmdk macinbox.vmdk ] + [task_opts]
+              VMDK.create_raw_vmdk(@disk.device, "rawdisk.vmdk")
+              begin
+                Task.run %W[ #{vdiskmanager} -t 0 -r rawdisk.vmdk macinbox.vmdk ] + [task_opts]
+              rescue Macinbox::Error => e
+                Logger.error "If the conversion failed due to an AppleXPC error please see https://kb.vmware.com/s/article/65163 for a possible workaround."
+                raise e
+              end
             end
             @disk.eject
           end

data/lib/macinbox/actions/install_box.rb

@@ -17,7 +17,7 @@ module Macinbox
         @box_format  = opts[:box_format] or raise ArgumentError.new(":box_format not specified")
         @boxes_dir   = opts[:boxes_dir]  or raise ArgumentError.new(":boxes_dir not specified")
 
-        @box_version = opts[:macos_version]
+        @box_version = opts[:macos_version].to_s rescue nil
 
         raise Macinbox::Error.new("box not found: #{@input_box}") unless File.exist? @input_box
         raise Macinbox::Error.new("boxes directory not found: #{@boxes_dir}") unless File.exist? @boxes_dir

data/lib/macinbox/cli.rb

@@ -57,8 +57,12 @@ module Macinbox
         raise Macinbox::Error.new("Box format not supported: #{@options[:box_format]}")
       end
 
-      if /^vmware_(fusion|desktop)$/ === @options[:box_format] && !File.exists?(@options[:vmware_path])
-        raise Macinbox::Error.new("VMware Fusion app not found: #{@options[:vmware_path]}")
+      if /^vmware_(fusion|desktop)$/ === @options[:box_format]
+        unless File.exists?(@options[:vmware_path])
+          raise Macinbox::Error.new("VMware Fusion app not found: #{@options[:vmware_path]}")
+        end
+        vmware_version = Task.backtick %W[ defaults read #{@options[:vmware_path]}/Contents/Info.plist CFBundleShortVersionString ]
+        @options[:vmware_major_version] = vmware_version.split(".")[0].to_i rescue 10
       end
 
       if /^parallels$/ === @options[:box_format] && !File.exists?(@options[:parallels_path])
@@ -73,6 +77,18 @@ module Macinbox
         raise Macinbox::Error.new("QEMU not found: /usr/local/bin/qemu-img")
       end
 
+      if /^vmware_(fusion|desktop)$/ === @options[:box_format] && !@options[:use_qemu] && @options[:vmware_major_version] >= 11
+        fusion_is_not_running = false
+        begin
+          Task.run %W[ pgrep -q #{"^VMware Fusion$"} ]
+        rescue
+          fusion_is_not_running = true
+        end
+        if fusion_is_not_running || !File.exist?("/Library/PrivilegedHelperTools/com.vmware.DiskHelper")
+          raise Macinbox::Error.new("VMware Fusion is not running and the workaround was not detected. See https://kb.vmware.com/s/article/65163 for more information, or try the --use-qemu option.")
+        end
+      end
+
       vagrant_home = ENV["VAGRANT_HOME"]
 
       if vagrant_home.nil? or vagrant_home.empty?

data/lib/macinbox/os_version.rb

@@ -0,0 +1,56 @@
+module Macinbox
+
+  class OSVersion
+
+    def initialize(version)
+      @version = version
+      @components = @version.split(".") rescue [0, 0]
+    end
+
+    def to_s
+      @version
+    end
+
+    def major
+      @components[0].to_i rescue 0
+    end
+
+    def minor
+      @components[1].to_i rescue 0
+    end
+
+    def darwin_major
+      minor + 4
+    end
+
+    def is_sierra?
+      major == 10 && minor == 12
+    end
+
+    def is_high_sierra?
+      major == 10 && minor == 13
+    end
+
+    def is_mojave?
+      major == 10 && minor == 14
+    end
+
+    def is_catalina?
+      major == 10 && minor == 15
+    end
+
+    def is_sierra_or_later?
+      major == 10 && minor >= 12
+    end
+
+    def is_mojave_or_earlier?
+      major == 10 && minor <= 14
+    end
+
+    def is_catalina_or_later?
+      major == 10 && minor >= 15
+    end
+
+  end
+  
+end

data/lib/macinbox/version.rb

@@ -1,3 +1,3 @@
 module Macinbox
-  VERSION = "3.3.0"
+  VERSION = "3.4.0"
 end

data/lib/macinbox/vmdk.rb

@@ -0,0 +1,60 @@
+require 'macinbox/error'
+require 'macinbox/task'
+
+module Macinbox
+
+  class VMDK
+
+    def self.create_raw_vmdk(device, output)
+
+      disk_info = Task.backtick %W[ /usr/sbin/fdisk #{device} ]
+
+      geometry_re = /geometry: (\d+)\/(\d+)\/(\d+) \[(\d+) sectors\]/
+
+      match = geometry_re.match(disk_info)
+
+      raise Macinbox::Error.new("failed to determine disk geometry") if match.nil? || match.captures.length != 4
+
+      device_sectors = match.captures[3]
+
+      device_cylinders = match.captures[0]
+      device_heads_per_track = match.captures[1]
+      device_sectors_per_track = match.captures[2]
+
+      bios_cylinders = 1024
+      bios_heads_per_track = device_heads_per_track
+      bios_sectors_per_track = device_sectors_per_track
+
+      File.write output, <<~EOF
+        # Disk DescriptorFile
+        version=1
+        encoding="UTF-8"
+        CID=fffffffe
+        parentCID=ffffffff
+        isNativeSnapshot="no"
+        createType="monolithicFlat"
+
+        # Extent description
+        RW #{device_sectors} FLAT "#{device}" 0
+
+        # The Disk Data Base
+        #DDB
+
+        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
+
+    end
+
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: macinbox
 version: !ruby/object:Gem::Version
-  version: 3.3.0
+  version: 3.4.0
 platform: ruby
 authors:
 - David Kramer
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-02-27 00:00:00.000000000 Z
+date: 2019-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -74,10 +74,12 @@ files:
 - lib/macinbox/copyfiles.rb
 - lib/macinbox/error.rb
 - lib/macinbox/logger.rb
+- lib/macinbox/os_version.rb
 - lib/macinbox/task.rb
 - lib/macinbox/tty.rb
 - lib/macinbox/version.rb
 - lib/macinbox/virtual_disk.rb
+- lib/macinbox/vmdk.rb
 - macinbox.gemspec
 homepage: https://github.com/bacongravy/macinbox
 licenses:
@@ -101,8 +103,7 @@ requirements:
 - macOS Mojave
 - macOS Mojave installer app
 - Vagrant
-rubyforge_project: 
-rubygems_version: 2.5.2.3
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Puts macOS in a Vagrant box