macinbox 3.2.0 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e03354e3ebf3d421641208fbd59e61b96a3bfd3b
-  data.tar.gz: 3f90e09c1a0bb98d6acb2512dd2644446e635a17
+  metadata.gz: 36bd1285647b90d338e5519ba42e429e6bb8ea12
+  data.tar.gz: 65c6e91a11e43bed2921f006fe1469542d716205
 SHA512:
-  metadata.gz: d8e7d1fd2a1b05a6bd89c778ef095ff70f268934281cc263f32375d5119dc25ac9ed3f3315e6e1316d7c1d93f4b23bf5314c32c557d2945a5c58b62e78902a55
-  data.tar.gz: 0d64344b66fb076a07e879a93a66c38d51d67adcd84c48679b83ac579494329e6f31d1e1201e240fb9abd68f36023121a8e15a8871e0b1a8d56db3fc7bc15171
+  metadata.gz: e08c547e56e15487b2d22cdc492aeaa7b3b78dd13b4df4ebdd77daa09537237b18413daa63bd3e473e2b67d4fb4e83137cf493cca63452e54fb994e5ced8953a
+  data.tar.gz: 1d4dbf5faac11e49922894e001ea1a32988a11dc85a9327f2f78a6708e9769c18ef32286fbb888273e74183b23e971cf3962328d77d0f443c798bb4df4c235cf

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+## 3.3.0 (February 26, 2019)
+
+FEATURES:
+
+- Add --verbose option to show the commands being run. [GH-28]
+- Add --user-script option to support running user-provided customizations. [GH-24]
+
+BUG FIXES:
+
+- Only display the animated progress bar when stderr is a tty. [GH-25]
+
 ## 3.2.0 (February 2, 2019)
 
 FEATURES:

data/Gemfile.lock

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

data/README.md

@@ -106,6 +106,7 @@ Usage: macinbox [options]
         --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
+        --user-script PATH           Path to user script
 
         --no-auto-login              Disable auto login
         --no-skip-mini-buddy         Show the mini buddy on first login
@@ -115,6 +116,7 @@ Usage: macinbox [options]
 
         --use-qemu                   Use qemu-img (vmware_desktop only)
 
+        --verbose                    Enable verbose mode
         --debug                      Enable debug mode
 
     -v, --version
@@ -143,6 +145,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.
 
+## User scripts
+
+If additional box customization is required a user script may be specified using the `--user-script` option. The script is run after the OS has been installed and will be provided with the path to the install location as its first and only argument. The script must be executable and exit with code zero or the box creation will be aborted.
+
 ## 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.

data/lib/macinbox/actions/check_macos_versions.rb

@@ -8,7 +8,6 @@ module Macinbox
         @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
@@ -21,13 +20,13 @@ module Macinbox
         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
+        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]
-        Logger.info "Host macOS version detected: #{host_os_version}" if @debug
+        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
           Logger.error "Warning: host OS version (#{host_os_version}) and installer OS version (#{installer_os_version}) do not match"

data/lib/macinbox/actions/create_box_from_hdd.rb

@@ -25,7 +25,6 @@ module Macinbox
         @hidpi             = opts[:hidpi]
 
         @collector         = opts[:collector]       or raise ArgumentError.new(":collector not specified")
-        @debug             = opts[:debug]
 
         raise Macinbox::Error.new("HDD not found") unless File.exist? @input_hdd
       end
@@ -55,7 +54,7 @@ module Macinbox
             end
           EOF
 
-          task_opts = @debug ? {} : { :out => File::NULL }
+          task_opts = $verbose ? {} : { :out => File::NULL }
 
           Task.run %W[ prlctl create macinbox -o macos --no-hdd --dst #{@box_dir} ] + [task_opts]
 

data/lib/macinbox/actions/create_box_from_vdi.rb

@@ -24,7 +24,6 @@ module Macinbox
         @hidpi             = opts[:hidpi]
 
         @collector         = opts[:collector]       or raise ArgumentError.new(":collector not specified")
-        @debug             = opts[:debug]
 
         raise Macinbox::Error.new("VDI not found") unless File.exist? @input_vdi
       end
@@ -53,7 +52,7 @@ module Macinbox
             end
           EOF
 
-          task_opts = @debug ? {} : { :out => File::NULL }
+          task_opts = $verbose ? {} : { :out => File::NULL }
 
           Task.run %W[ VBoxManage createvm --register --name macinbox --ostype MacOS1013_64 ] + [task_opts]
 

data/lib/macinbox/actions/create_box_from_vmdk.rb

@@ -26,7 +26,6 @@ module Macinbox
         @hidpi             = opts[:hidpi]
 
         @collector         = opts[:collector]       or raise ArgumentError.new(":collector not specified")
-        @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

data/lib/macinbox/actions/create_hdd_from_image.rb

@@ -19,7 +19,6 @@ module Macinbox
         @parallels_app     = opts[:parallels_path] or raise ArgumentError.new(":parallels_path not specified")
 
         @collector         = opts[:collector]      or raise ArgumentError.new(":collector not specified")
-        @debug             = opts[:debug]
 
         raise Macinbox::Error.new("input image not found")       unless File.exist? @input_image
         raise Macinbox::Error.new("Parallels Desktop not found") unless File.exist? @parallels_app
@@ -49,7 +48,7 @@ module Macinbox
 
       def attach_image
         Logger.info "Attaching the image..." do
-          @disk = VirtualDisk.new(@image, @debug)
+          @disk = VirtualDisk.new(@image)
           @collector.on_cleanup { @disk.detach! }
           @image_mountpoint = "#{@temp_dir}/image_mountpoint"
           FileUtils.mkdir @image_mountpoint
@@ -64,7 +63,7 @@ module Macinbox
 
           tools_image = "#{@parallels_app}/Contents/Resources/Tools/prl-tools-mac.iso"
 
-          tools_disk = VirtualDisk.new(tools_image, @debug)
+          tools_disk = VirtualDisk.new(tools_image)
 
           @collector.on_cleanup { tools_disk.detach! }
 
@@ -171,7 +170,7 @@ module Macinbox
             EOF
 
             prl_convert = "#{@parallels_app}/Contents/MacOS/prl_convert"
-            task_opts = @debug ? {} : { :out => File::NULL }
+            task_opts = $verbose ? {} : { :out => File::NULL }
             Task.run %W[ #{prl_convert} #{@temp_dir}/macinbox.vmdk --allow-no-os --dst=#{@temp_dir} ] + [task_opts]
             @disk.eject
           end

data/lib/macinbox/actions/create_image_from_installer.rb

@@ -18,6 +18,7 @@ module Macinbox
         @output_path       = opts[:image_path]      or raise ArgumentError.new(":image_path not specified")
         @vmware_fusion_app = opts[:vmware_path]
         @parallels_app     = opts[:parallels_path]
+        @user_script       = opts[:user_script]
 
         @disk_size         = opts[:disk_size]       or raise ArgumentError.new(":disk_size not specified")
         @fstype            = opts[:fstype]          or raise ArgumentError.new(":fstype not specified")
@@ -31,7 +32,6 @@ module Macinbox
         @hidpi             = opts[:hidpi]
 
         @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
 
@@ -52,6 +52,7 @@ module Macinbox
         enable_passwordless_sudo
         enable_sshd
         enable_hidpi
+        run_user_script
         save_image
       end
 
@@ -69,7 +70,7 @@ module Macinbox
       def create_wrapper_image
         Logger.info "Creating and attaching wrapper disk image..." do
           @wrapper_image = "#{@temp_dir}/wrapper.dmg"
-          @wrapper_disk = VirtualDisk.new(@wrapper_image, @debug)
+          @wrapper_disk = VirtualDisk.new(@wrapper_image)
           @collector.on_cleanup { @wrapper_disk.detach! }
           @wrapper_disk.create_from_folder(@installer_app)
           @wrapper_disk.attach
@@ -81,7 +82,7 @@ module Macinbox
       def create_scratch_image
         Logger.info "Creating and attaching a new blank disk image..." do
           @scratch_image = "#{@temp_dir}/scratch.sparseimage"
-          @scratch_disk = VirtualDisk.new(@scratch_image, @debug)
+          @scratch_disk = VirtualDisk.new(@scratch_image)
           @collector.on_cleanup { @scratch_disk.detach! }
           @scratch_mountpoint = "#{@temp_dir}/scratch_mountpoint"
           FileUtils.mkdir @scratch_mountpoint
@@ -97,7 +98,7 @@ module Macinbox
           install_info_plist = "#{@installer_app}/Contents/SharedSupport/InstallInfo.plist"
           Task.run %W[ /usr/bin/touch #{@scratch_mountpoint}/.macinbox ]
           cmd = %W[ /usr/sbin/installer -verboseR -dumplog -pkg #{install_info_plist} -target #{@scratch_mountpoint} ]
-          opts = @debug ? {} : { :err => [:child, :out] }
+          opts = $verbose ? {} : { :err => [:child, :out] }
           Task.run_with_progress activity, cmd, opts do |line|
             /^installer:%(.*)$/.match(line)[1].to_f rescue nil
           end
@@ -190,12 +191,11 @@ module Macinbox
       def enable_sshd
         Logger.info "Enabling sshd..." do
           scratch_launchd_disabled_plist = "#{@scratch_mountpoint}/private/var/db/com.apple.xpc.launchd/disabled.plist"
-          opts = @debug ? {} : { :out => File::NULL }
+          opts = $verbose ? {} : { :out => File::NULL }
           Task.run %W[ /usr/libexec/PlistBuddy -c #{'Add :com.openssh.sshd bool False'} #{scratch_launchd_disabled_plist} ] + [opts]
         end
       end
 
-
       def enable_hidpi
         if @hidpi
           Logger.info "Enabling HiDPI resolutions..." do
@@ -214,9 +214,17 @@ module Macinbox
         end
       end
 
+      def run_user_script
+        if @user_script
+          Logger.info "Running user script..." do
+            Task.run %W[ #{@user_script} #{@scratch_mountpoint} ]
+          end
+        end
+      end
+
       def save_image
         Logger.info "Saving the image..." do
-          @scratch_disk.detach
+          @scratch_disk.eject
           FileUtils.chown ENV["SUDO_USER"], nil, @scratch_image
           FileUtils.mv @scratch_image, @output_path
         end

data/lib/macinbox/actions/create_vdi_from_image.rb

@@ -18,7 +18,6 @@ module Macinbox
         @output_path       = opts[:vdi_path]    or raise ArgumentError.new(":vdi_path not specified")
 
         @collector         = opts[:collector]   or raise ArgumentError.new(":collector not specified")
-        @debug             = opts[:debug]
 
         raise Macinbox::Error.new("input image not found")   unless File.exist? @input_image
       end
@@ -46,7 +45,7 @@ module Macinbox
 
       def attach_image
         Logger.info "Attaching the image..." do
-          @disk = VirtualDisk.new(@image, @debug)
+          @disk = VirtualDisk.new(@image)
           @collector.on_cleanup { @disk.detach! }
           @disk.attach
         end
@@ -80,7 +79,7 @@ module Macinbox
 
       def convert_image
         Logger.info "Converting the image to VDI format..." do
-          task_opts = @debug ? {} : { :out => File::NULL }
+          task_opts = $verbose ? {} : { :out => File::NULL }
           Task.run %W[ VBoxManage convertfromraw #{@disk.device} #{@temp_dir}/macinbox.vdi --format VDI ] + [task_opts]
         end
       end

data/lib/macinbox/actions/create_vmdk_from_image.rb

@@ -20,7 +20,6 @@ module Macinbox
         @use_qemu          = opts[:use_qemu]
 
         @collector         = opts[:collector]   or raise ArgumentError.new(":collector not specified")
-        @debug             = opts[:debug]
 
         raise Macinbox::Error.new("input image not found")   unless File.exist? @input_image
         raise Macinbox::Error.new("VMware Fusion not found") unless File.exist? @vmware_fusion_app
@@ -55,7 +54,7 @@ module Macinbox
 
       def attach_image
         Logger.info "Attaching the image..." do
-          @disk = VirtualDisk.new(@image, @debug)
+          @disk = VirtualDisk.new(@image)
           @collector.on_cleanup { @disk.detach! }
           @image_mountpoint = "#{@temp_dir}/image_mountpoint"
           FileUtils.mkdir @image_mountpoint
@@ -73,16 +72,16 @@ module Macinbox
             bundle_short_version = Task.backtick %W[ defaults read #{"/Applications/VMware Fusion.app/Contents/Info.plist"} CFBundleShortVersionString ]
             darwin_iso_url = "http://softwareupdate.vmware.com/cds/vmw-desktop/fusion/#{bundle_short_version}/#{bundle_version}/packages/com.vmware.fusion.tools.darwin.zip.tar"
             Dir.chdir(@temp_dir) do
-              Task.run %W[ /usr/bin/curl #{darwin_iso_url} -O ] + (@debug ? [] : %W[ -s -S ])
+              Task.run %W[ /usr/bin/curl #{darwin_iso_url} -O ] + ($verbose ? [] : %W[ -s -S ])
               Task.run %W[ /usr/bin/tar -xf com.vmware.fusion.tools.darwin.zip.tar com.vmware.fusion.tools.darwin.zip ]
-              Task.run %W[ /usr/bin/unzip ] + (@debug ? [] : %W[ -qq ]) + %W[ com.vmware.fusion.tools.darwin.zip payload/darwin.iso ]
+              Task.run %W[ /usr/bin/unzip ] + ($verbose ? [] : %W[ -qq ]) + %W[ com.vmware.fusion.tools.darwin.zip payload/darwin.iso ]
             end
             tools_image = "#{@temp_dir}/payload/darwin.iso"
           end
         end
 
         Logger.info "Installing the VMware Tools..." do
-          tools_disk = VirtualDisk.new(tools_image, @debug)
+          tools_disk = VirtualDisk.new(tools_image)
           @collector.on_cleanup { tools_disk.detach! }
           tools_mountpoint = "#{@temp_dir}/tools_mountpoint"
           FileUtils.mkdir tools_mountpoint
@@ -102,17 +101,26 @@ module Macinbox
       def set_spc_kextpolicy
         Logger.info "Setting the KextPolicy to allow loading the VMware kernel extensions..." do
           image_spc_kextpolicy = "#{@image_mountpoint}/private/var/db/SystemPolicyConfiguration/KextPolicy"
+          unless File.exist? image_spc_kextpolicy
+            Task.run_with_input %W[ /usr/bin/sqlite3 #{image_spc_kextpolicy} ] do |pipe|
+              pipe.write <<~EOF
+                PRAGMA foreign_keys=OFF;
+                BEGIN TRANSACTION;
+                CREATE TABLE kext_load_history_v3 ( path TEXT PRIMARY KEY, team_id TEXT, bundle_id TEXT, boot_uuid TEXT, created_at TEXT, last_seen TEXT, flags INTEGER );
+                CREATE TABLE kext_policy ( team_id TEXT, bundle_id TEXT, allowed BOOLEAN, developer_name TEXT, flags INTEGER, PRIMARY KEY (team_id, bundle_id) );
+                CREATE TABLE kext_policy_mdm ( team_id TEXT, bundle_id TEXT, allowed BOOLEAN, payload_uuid TEXT, PRIMARY KEY (team_id, bundle_id) );
+                CREATE TABLE settings ( name TEXT, value TEXT, PRIMARY KEY (name) );
+                COMMIT;
+              EOF
+            end
+          end
           Task.run_with_input %W[ /usr/bin/sqlite3 #{image_spc_kextpolicy} ] do |pipe|
             pipe.write <<~EOF
               PRAGMA foreign_keys=OFF;
               BEGIN TRANSACTION;
-              CREATE TABLE kext_load_history_v3 ( path TEXT PRIMARY KEY, team_id TEXT, bundle_id TEXT, boot_uuid TEXT, created_at TEXT, last_seen TEXT, flags INTEGER );
-              CREATE TABLE kext_policy ( team_id TEXT, bundle_id TEXT, allowed BOOLEAN, developer_name TEXT, flags INTEGER, PRIMARY KEY (team_id, bundle_id) );
-              INSERT INTO kext_policy VALUES('EG7KH642X6','com.vmware.kext.VMwareGfx',1,'VMware, Inc.',1);
-              INSERT INTO kext_policy VALUES('EG7KH642X6','com.vmware.kext.vmmemctl',1,'VMware, Inc.',1);
-              INSERT INTO kext_policy VALUES('EG7KH642X6','com.vmware.kext.vmhgfs',1,'VMware, Inc.',1);
-              CREATE TABLE kext_policy_mdm ( team_id TEXT, bundle_id TEXT, allowed BOOLEAN, payload_uuid TEXT, PRIMARY KEY (team_id, bundle_id) );
-              CREATE TABLE settings ( name TEXT, value TEXT, PRIMARY KEY (name) );
+              INSERT OR REPLACE INTO kext_policy VALUES('EG7KH642X6','com.vmware.kext.VMwareGfx',1,'VMware, Inc.',1);
+              INSERT OR REPLACE INTO kext_policy VALUES('EG7KH642X6','com.vmware.kext.vmmemctl',1,'VMware, Inc.',1);
+              INSERT OR REPLACE INTO kext_policy VALUES('EG7KH642X6','com.vmware.kext.vmhgfs',1,'VMware, Inc.',1);
               COMMIT;
             EOF
           end
@@ -130,7 +138,7 @@ module Macinbox
             Task.run %W[ /usr/local/bin/qemu-img convert -f dmg -O vmdk #{@temp_dir}/macinbox.dmg #{@temp_dir}/macinbox.vmdk ]
           else
             @disk.attach
-            task_opts = @debug ? {} : { :out => File::NULL }
+            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

data/lib/macinbox/actions/install_box.rb

@@ -18,7 +18,6 @@ module Macinbox
         @boxes_dir   = opts[:boxes_dir]  or raise ArgumentError.new(":boxes_dir not specified")
 
         @box_version = opts[:macos_version]
-        @debug       = opts[:debug]
 
         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

@@ -30,7 +30,7 @@ module Macinbox
 
       check_for_sudo_root
 
-      collector = Collector.new(preserve_temp_dirs: @options[:debug])
+      collector = Collector.new(preserve_temp_dirs: $debug)
 
       collector.on_cleanup do
         STDERR.print TTY::Color::RESET
@@ -42,7 +42,7 @@ module Macinbox
           raise Macinbox::Error.new("Installer disk image not found: #{@options[:installer_dmg]}")
         end
         Logger.info "Attaching installer disk image..."
-        installer_disk = VirtualDisk.new(@options[:installer_dmg], @options[:debug])
+        installer_disk = VirtualDisk.new(@options[:installer_dmg])
         collector.on_cleanup { installer_disk.detach! }
         installer_disk.attach
         installer_disk.mount

data/lib/macinbox/cli/options.rb

@@ -24,6 +24,7 @@ module Macinbox
       :fullscreen      => true,
       :gui             => true,
       :use_qemu        => false,
+      :verbose         => false,
       :debug           => false,
     }
 
@@ -45,10 +46,11 @@ module Macinbox
         o.on('-f', '--full NAME',          'Full name of the user   (default: Vagrant)')  { |v| @options[:full_name] = v }
         o.on('-p', '--password PASSWORD',  'Password of the user    (default: vagrant)')  { |v| @options[:password] = v }
         o.separator ''
-        o.on(      '--installer PATH',     'Path to the macOS installer app')             { |v| @options[:installer_path] = v }
-        o.on(      '--installer-dmg PATH', 'Path to a macOS installer app disk image')    { |v| @options[:installer_dmg] = v }
-        o.on(      '--vmware PATH',        'Path to the VMware Fusion app')               { |v| @options[:vmware_path] = v }
-        o.on(      '--parallels PATH',     'Path to the Parallels Desktop app')           { |v| @options[:parallels_path] = v }
+        o.on(      '--installer PATH',     'Path to the macOS installer app')             { |v| @options[:installer_path] = File.absolute_path(v) }
+        o.on(      '--installer-dmg PATH', 'Path to a macOS installer app disk image')    { |v| @options[:installer_dmg] = File.absolute_path(v) }
+        o.on(      '--vmware PATH',        'Path to the VMware Fusion app')               { |v| @options[:vmware_path] = File.absolute_path(v) }
+        o.on(      '--parallels PATH',     'Path to the Parallels Desktop app')           { |v| @options[:parallels_path] = File.absolute_path(v) }
+        o.on(      '--user-script PATH',   'Path to user script')                         { |v| @options[:user_script] = File.absolute_path(v) }
         o.separator ''
         o.on(      '--no-auto-login',      'Disable auto login')                          { |v| @options[:auto_login] = v }
         o.on(      '--no-skip-mini-buddy', 'Show the mini buddy on first login')          { |v| @options[:skip_mini_buddy] = v }
@@ -58,7 +60,8 @@ module Macinbox
         o.separator ''
         o.on(      '--use-qemu',           'Use qemu-img (vmware_desktop only)')          { |v| @options[:use_qemu] = v }
         o.separator ''
-        o.on(      '--debug',              'Enable debug mode')                           { |v| @options[:debug] = v }
+        o.on(      '--verbose',            'Enable verbose mode')                         { |v| $verbose = v }
+        o.on(      '--debug',              'Enable debug mode')                           { |v| $debug = $verbose = v }
         o.separator ''
         o.on('-v', '--version')                                                           { puts "macinbox #{Macinbox::VERSION}"; exit }
         o.on('-h', '--help')                                                              { puts o; exit }

data/lib/macinbox/task.rb

@@ -2,15 +2,19 @@ require 'macinbox/error'
 require 'macinbox/logger'
 require 'macinbox/tty'
 
+require 'shellwords'
+
 module Macinbox
 
   class Task
 
     def self.run(cmd)
+      Logger.info "Running command: #{Shellwords.join(cmd)}" if $verbose
       system(*cmd) or raise Macinbox::Error.new("#{cmd.slice(0)} failed with non-zero exit code: #{$? >> 8}")
     end
 
     def self.run_as_sudo_user(cmd)
+      Logger.info "Running command: sudo -u #{ENV["SUDO_USER"]} #{Shellwords.join(cmd)}" if $verbose
       system "sudo", "-u", ENV["SUDO_USER"], *cmd or raise Macinbox::Error.new("#{cmd.slice(0)} failed with non-zero exit code: #{$?.to_i}")
     end
 
@@ -30,13 +34,18 @@ module Macinbox
       header + bar
     end
 
+    def self.print_progress_bar(io, activity, percent_done)
+      io.print TTY::Line::CLEAR + TTY::Color::GREEN + progress_bar(activity, percent_done) + TTY::Color::RESET if io.isatty
+    end
+
     def self.run_with_progress(activity, cmd, opts={})
       STDERR.print TTY::Cursor::INVISIBLE
-      STDERR.print TTY::Line::CLEAR + TTY::Color::GREEN + progress_bar(activity, 0.0) + TTY::Color::RESET
+      print_progress_bar(STDERR, activity, 0.0)
+      Logger.info "Running command: #{Shellwords.join(cmd)}" if $verbose
       IO.popen cmd, opts do |pipe|
         pipe.each_line do |line|
           percent = yield line
-          STDERR.print TTY::Line::CLEAR + TTY::Color::GREEN + progress_bar(activity, percent) + TTY::Color::RESET if percent
+          print_progress_bar(STDERR, activity, percent) if percent
         end
       end
       STDERR.puts TTY::Cursor::NORMAL
@@ -49,14 +58,14 @@ module Macinbox
       total_size = File.size(source)
       last_percent_done = -1
       STDERR.print TTY::Cursor::INVISIBLE
-      STDERR.print TTY::Line::CLEAR + TTY::Color::GREEN + progress_bar(activity, 0.0) + TTY::Color::RESET
+      print_progress_bar(STDERR, activity, 0.0)
       File.open(source) do |file|
         until eof
           begin
             bytes_written += destination.write(file.readpartial(1024*1024))
             percent_done = ((bytes_written.to_f / total_size.to_f) * 100).round(1)
             last_percent_done = percent_done
-            STDERR.print TTY::Line::CLEAR + TTY::Color::GREEN + progress_bar(activity, percent_done) + TTY::Color::RESET
+            print_progress_bar(STDERR, activity, percent_done)
           rescue EOFError
             eof = true
           end
@@ -66,10 +75,12 @@ module Macinbox
     end
 
     def self.backtick(cmd)
+      Logger.info "Running command: #{Shellwords.join(cmd)}" if $verbose
       IO.popen(cmd).read.chomp
     end
 
     def self.run_with_input(cmd)
+      Logger.info "Running command: #{Shellwords.join(cmd)}" if $verbose
       IO.popen(cmd, "w") do |pipe|
         yield pipe
       end

data/lib/macinbox/version.rb

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

data/lib/macinbox/virtual_disk.rb

@@ -6,11 +6,10 @@ module Macinbox
 
   class VirtualDisk
 
-    def initialize(image, debug)
+    def initialize(image)
       @image = image
-      @debug = debug
-      @quiet_flag = @debug ? [] : %W[ -quiet ]
-      @task_opts = @debug ? [] : [{ :out => File::NULL }]
+      @quiet_flag = $verbose ? [] : %W[ -quiet ]
+      @task_opts = $verbose ? [] : [{ :out => File::NULL }]
     end
 
     def device
@@ -65,27 +64,22 @@ module Macinbox
       Task.run %W[ /usr/sbin/diskutil unmount #{@efi_device} ] + @task_opts
     end
 
-    def detach
+    def eject
       max_attempts = 5
       for attempt in 1..max_attempts
         begin
-          Logger.info "Detaching the image..." if @debug
-          Task.run %W[ /usr/bin/hdiutil detach #{@disk_device} ] + @quiet_flag
+          quiet = $verbose ? [] : %W[ quiet ]
+          Task.run %W[ /usr/sbin/diskutil ] + quiet + %W[ eject #{@disk_device} ] + @task_opts
           unset_devices
           break
         rescue Macinbox::Error => error
           raise if attempt == max_attempts
-          Logger.info "#{error.message}. Sleeping and retrying..." if @debug
+          Logger.info "Eject failed: #{error.message}. Sleeping and retrying..." if $verbose
           sleep 15
         end
       end
     end
 
-    def eject
-      Task.run %W[ /usr/sbin/diskutil eject #{@disk_device} ] + @task_opts
-      unset_devices
-    end
-
     def detach!
       return unless @disk_device
       %x( /usr/bin/hdiutil detach -quiet -force #{@disk_device.shellescape} > /dev/null 2>&1 )

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: macinbox
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.3.0
 platform: ruby
 authors:
 - David Kramer
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-02-02 00:00:00.000000000 Z
+date: 2019-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler