vagrant-export 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 972a8fee7388353a022cd1e9f8e75d324bafa269
+  data.tar.gz: 4df09cfe8e06af3ef5511c277d218b1bc57877cf
+SHA512:
+  metadata.gz: 51948fb3fc9df0f489eb2cbad87430e36b90c2794a03eca400c9199efe3e400e89cf33b73dbb7c6868e85c01c979e15ffd5acefc94f502aa1103908539633ce7
+  data.tar.gz: ca28ad5ec9b52aced5ac660c81afdf5d279ab66cdac5cba79c466fe4be79cf633d16a643f386282221745b086dcaadcf433802b3da658a1796cb85ddc1192fbf

data/.gitignore

@@ -0,0 +1,4 @@
+/.idea
+/.vagrant
+/Gemfile.lock
+Vagrantfile

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+group :development do
+  gem 'vagrant', git: 'https://github.com/mitchellh/vagrant.git'
+end
+
+group :plugins do
+  gem 'vagrant-export', path: '.'
+end

data/Gemfile.lock

@@ -0,0 +1,100 @@
+GIT
+  remote: https://github.com/mitchellh/vagrant.git
+  revision: bde0e3fb2a577f58df98d053eb89a40b88d8fed0
+  specs:
+    vagrant (1.6.5)
+      bundler (>= 1.5.2, < 1.7.0)
+      childprocess (~> 0.5.0)
+      erubis (~> 2.7.0)
+      hashicorp-checkpoint (~> 0.1.1)
+      i18n (~> 0.6.0)
+      listen (~> 2.7.1)
+      log4r (~> 1.1.9, < 1.1.11)
+      net-scp (~> 1.1.0)
+      net-ssh (>= 2.6.6, < 2.10.0)
+      nokogiri (= 1.6.3.1)
+      rb-kqueue (~> 0.2.0)
+      wdm (~> 0.1.0)
+      winrm (~> 1.1.3)
+
+PATH
+  remote: .
+  specs:
+    vagrant-export (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    akami (1.2.2)
+      gyoku (>= 0.4.0)
+      nokogiri
+    builder (3.2.2)
+    celluloid (0.16.0)
+      timers (~> 4.0.0)
+    childprocess (0.5.3)
+      ffi (~> 1.0, >= 1.0.11)
+    erubis (2.7.0)
+    ffi (1.9.3)
+    gssapi (1.0.3)
+      ffi (>= 1.0.1)
+    gyoku (1.1.1)
+      builder (>= 2.1.2)
+    hashicorp-checkpoint (0.1.4)
+    hitimes (1.2.2)
+    httpclient (2.4.0)
+    httpi (0.9.7)
+      rack
+    i18n (0.6.11)
+    listen (2.7.9)
+      celluloid (>= 0.15.2)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+    little-plugger (1.1.3)
+    log4r (1.1.10)
+    logging (1.8.2)
+      little-plugger (>= 1.1.3)
+      multi_json (>= 1.8.4)
+    mini_portile (0.6.0)
+    multi_json (1.10.1)
+    net-scp (1.1.2)
+      net-ssh (>= 2.6.5)
+    net-ssh (2.9.1)
+    nokogiri (1.6.3.1)
+      mini_portile (= 0.6.0)
+    nori (1.1.5)
+    rack (1.5.2)
+    rb-fsevent (0.9.4)
+    rb-inotify (0.9.5)
+      ffi (>= 0.5.0)
+    rb-kqueue (0.2.3)
+      ffi (>= 0.5.0)
+    rubyntlm (0.1.1)
+    savon (0.9.5)
+      akami (~> 1.0)
+      builder (>= 2.1.2)
+      gyoku (>= 0.4.0)
+      httpi (~> 0.9)
+      nokogiri (>= 1.4.0)
+      nori (~> 1.0)
+      wasabi (~> 1.0)
+    timers (4.0.1)
+      hitimes
+    uuidtools (2.1.5)
+    wasabi (1.0.0)
+      nokogiri (>= 1.4.0)
+    wdm (0.1.0)
+    winrm (1.1.3)
+      gssapi (~> 1.0.0)
+      httpclient (~> 2.2, >= 2.2.0.2)
+      logging (~> 1.6, >= 1.6.1)
+      nokogiri (~> 1.5)
+      rubyntlm (~> 0.1.1)
+      savon (= 0.9.5)
+      uuidtools (~> 2.1.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  vagrant!
+  vagrant-export!

data/lib/vagrant-export.rb

@@ -0,0 +1,7 @@
+#                                                                       #
+# This is free software; you can redistribute it and/or modify it under #
+# the terms of the MIT- / X11 - License                                 #
+#                                                                       #
+
+require "vagrant-export/plugin"
+require "vagrant-export/version"

data/lib/vagrant-export/command.rb

@@ -0,0 +1,45 @@
+#                                                                       #
+# This is free software; you can redistribute it and/or modify it under #
+# the terms of the MIT- / X11 - License                                 #
+#                                                                       #
+
+module VagrantPlugins
+  module Export
+    class Command < Vagrant.plugin '2', :command
+
+      def self.synopsis
+        'exports a box file with additional actions taken'
+      end
+
+      def execute
+        options = {}
+        options[:quick] = false
+        options[:bare] = false
+
+        opts = OptionParser.new do |o|
+          o.banner = 'Usage: vagrant export [switches]'
+          o.separator ''
+
+          o.on('-f', '--fast', 'Do not perform cleanups.') do |f|
+            options[:fast] = f
+          end
+
+          o.on('-b', '--bare', 'Do not include additional files.') do |b|
+            options[:bare] = b
+          end
+        end
+
+        argv = parse_options(opts)
+        return 1 unless argv
+
+        require_relative 'exporter'
+        ex = Exporter.new(@env, @logger)
+
+        with_target_vms argv, reverse: true do |machine|
+          ex.handle machine, options[:fast], options[:bare]
+        end
+        0
+      end
+    end
+  end
+end

data/lib/vagrant-export/exporter.rb

@@ -0,0 +1,183 @@
+#                                                                       #
+# This is free software; you can redistribute it and/or modify it under #
+# the terms of the MIT- / X11 - License                                 #
+#                                                                       #
+
+require 'fileutils'
+
+module VagrantPlugins
+  module Export
+    class Exporter
+
+      # @param env Vagrant::Environment
+      # @param logger Log4r::Logger
+      def initialize env, logger
+        @env = env
+        @logger = logger
+      end
+
+      # @param vm Vagrant::Machine
+      # @param fast Boolean
+      # @param bare Boolean
+      def handle vm, fast, bare
+        @vm = vm
+        @did_run = false
+
+        unless fast
+          if can_compress
+            compress
+          else
+            @env.uid.error 'Cannot compress this type of machine'
+            return 1
+          end
+        end
+
+        return 1 unless export
+
+        unless bare
+          return 1 unless files
+        end
+
+        finalize
+      end
+
+      protected
+
+
+      def can_compress
+        if @vm.state.short_description == 'running'
+          @did_run = true
+        else
+          @env.ui.info 'Machine not running, bringing it up'
+          @vm.action :up
+        end
+
+        compress_supported = false
+
+        if @vm.config.vm.communicator != :winrm
+          @vm.communicate.execute 'lsb_release -i -s', error_key: :ssh_bad_exit_status_muted do |type, data|
+            if type == :stdout && data.to_s =~ /mint|ubuntu|debian/i
+              compress_supported = true
+            end
+          end
+        end
+
+        compress_supported
+      end
+
+      def compress
+
+        target_script = "/tmp/_cleanup_#{Time.now.to_i.to_s}.sh"
+        source_script = File.expand_path('../../../res/cleanup.sh', __FILE__)
+        comm = @vm.communicate
+
+        @logger.debug "Uploading #{source_script} to #{target_script}"
+        comm.upload source_script, target_script
+
+        sudo comm, "chmod +x #{target_script}"
+        sudo comm, "#{target_script}"
+
+        0
+      end
+
+      def sudo communicator, command
+        @logger.debug "Execute '#{command}'"
+        communicator.sudo command, error_key: :ssh_bad_exit_status_muted do |type, data|
+          if [:stderr, :stdout].include?(type)
+            return if data.empty?
+            data = data.to_s.chomp.strip
+            if type == :stdout
+                @vm.ui.info data
+            else
+              @vm.ui.error data
+            end
+          end
+        end
+      end
+
+      def export
+        # Halt the machine
+        if @vm.state.short_description == 'running'
+          @env.ui.info 'Halting VM for export'
+          @vm.action(:halt)
+        end
+
+        # Export to file
+        exported_path = File.join @env.tmp_path, Time.now.to_i.to_s
+        @tmp_path = exported_path
+        FileUtils.mkpath exported_path
+
+        @env.ui.info I18n.t 'vagrant.actions.vm.export.exporting'
+        @vm.provider.driver.export File.join(exported_path, 'box.ovf') do |progress|
+          @env.ui.clear_line
+          @env.ui.report_progress progress.percent, 100, false
+        end
+
+        @logger.debug "Exported VM to #{exported_path}"
+      end
+
+      def files
+
+        # Add metadata json
+        begin
+          metadata = File.open(File.join(@tmp_path, 'metadata.json'), 'wb')
+          metadata.write '{"provider":"' + @vm.provider_name.to_s + '"}'
+        ensure
+          metadata.close
+        end
+
+        target_include_path = File.join @tmp_path, 'include'
+        source_include_path = File.join @vm.box.directory, 'include'
+
+        # Copy includes
+        if Dir.exist? source_include_path
+          FileUtils.cp_r source_include_path, @tmp_path
+
+        # Add the orignal vagrant file as include
+        else
+          FileUtils.mkpath target_include_path
+          Dir.glob(File.join(@vm.box.directory, '**', '*')).each do |file|
+            if file.to_s =~ /Vagrantfile$/
+              FileUtils.cp file.to_s, File.join(target_include_path, '_Vagrantfile')
+            end
+          end
+        end
+
+        # Add the mac address setting as a Vagrantfile
+        File.open(File.join(@tmp_path, 'Vagrantfile'), 'wb') do |f|
+          f.write(Vagrant::Util::TemplateRenderer.render('package_Vagrantfile', {
+              base_mac: @vm.provider.driver.read_mac_address
+          }))
+        end
+
+        # Make a box file out of it
+        @box_file_name = @tmp_path + '.box'
+
+        Vagrant::Util::SafeChdir.safe_chdir(@tmp_path) do
+          files = Dir.glob File.join('.', '**', '*')
+          Vagrant::Util::Subprocess.execute('bsdtar', '-czf', @box_file_name, *files)
+        end
+
+        0
+      end
+
+      def finalize
+        # Rename the box file
+        if File.exist? @box_file_name
+          box_name = @vm.box.name.gsub '/', '_'
+          target_box = File.join @env.cwd, box_name + '.box'
+          File.rename @box_file_name, target_box
+        end
+
+        # Remove the tmp files
+        FileUtils.rm_rf @tmp_path
+
+        # Resume the machine
+        if @did_run
+          @env.ui.info 'Bringing the machine back up'
+          @vm.action :up
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-export/plugin.rb

@@ -0,0 +1,25 @@
+#                                                                       #
+# This is free software; you can redistribute it and/or modify it under #
+# the terms of the MIT- / X11 - License                                 #
+#                                                                       #
+
+module VagrantPlugins
+  module Export
+    class Plugin < Vagrant.plugin '2'
+
+      name 'Vagrant Export'
+
+      description <<-EOF
+      Export an existing box to a .box file, like the vagrant repackage command
+      Additionally it will include the original Vagrantfile and other included
+      files and perform several cleanup operations inside the VM to reduce its
+      exported size. The latter requires a Ubuntu or compatible guest.
+      EOF
+
+      command 'export' do
+        require_relative 'command'
+        Command
+      end
+   	end
+  end
+end

data/lib/vagrant-export/version.rb

@@ -0,0 +1,10 @@
+#                                                                       #
+# This is free software; you can redistribute it and/or modify it under #
+# the terms of the MIT- / X11 - License                                 #
+#                                                                       #
+
+module VagrantPlugins
+  module Export
+    VERSION = '0.1.0'
+  end
+end

data/res/cleanup.sh

@@ -0,0 +1,83 @@
+#!/bin/bash -eux
+
+# Removing old kernel packages
+apt-get -y --purge remove $(dpkg --list | grep '^rc' | awk '{print $2}')
+apt-get -y --purge remove $(dpkg --list | egrep 'linux-image-[0-9]' | awk '{print $3,$2}' | sort -nr | tail -n +2 | grep -v $(uname -r) | awk '{ print $2}')
+
+# Cleaning up apt
+apt-get -y --purge autoremove
+apt-get -y clean
+rm -rf /var/lib/apt/lists/*
+rm -rf /var/lib/aptitude/*
+
+# Cleaning up home
+rm -rf $HOME/.cache
+rm -rf $HOME/.local
+rm -rf $HOME/.npm
+rm -rf $HOME/tmp
+
+# Empty TYPO3 CMS temp files
+if [[ -d /var/www/typo3temp ]]; then
+    find /var/www/typo3temp -type f -exec rm -f {} \;
+fi
+
+# Empty Flow temp files
+if [[ -d /var/www/Data/Temporary ]]; then
+    rm -rf /var/www/Data/Temporary
+fi
+
+
+# Empty Magento temp files
+if [[ -d /var/www/downloader/.cache ]]; then
+    rm -rf /var/www/downloader/.cache/*
+fi
+
+if [[ -d /var/www/downloader/pearlib/cache ]]; then
+    rm -rf /var/www/downloader/pearlib/cache/*
+fi
+
+if [[ -d /var/www/downloader/pearlib/download ]]; then
+    rm -rf /var/www/downloader/pearlib/download/*
+fi
+
+if [[ -d /var/www/var/cache ]]; then
+    rm -rf /var/www/var/cache/*
+fi
+
+if [[ -d /var/www/var/locks ]]; then
+    rm -rf /var/www/var/locks/*
+fi
+
+if [[ -d /var/www/var/log ]]; then
+    rm -rf /var/www/var/log/*
+fi
+
+if [[ -d /var/www/var/report ]]; then
+    rm -rf /var/www/var/report/*
+fi
+
+if [[ -d /var/www/var/cache ]]; then
+    rm -rf /var/www/var/cache/*
+fi
+
+if [[ -d /var/www/var/session ]]; then
+    rm -rf /var/www/var/session/*
+fi
+
+if [[ -d /var/www/var/tmp ]]; then
+    rm -rf /var/www/var/tmp/*
+fi
+
+
+# Empty tmp
+rm -rf /tmp/*
+
+# Make sure we sync before the next step
+sync
+
+# Zero out the free space to save space in the final image:
+echo "Zeroing device to make space..."
+dd if=/dev/zero of=/EMPTY bs=1M
+rm -f /EMPTY
+
+exit 0

data/vagrant-export.gemspec

@@ -0,0 +1,49 @@
+$:.unshift File.expand_path("../lib", __FILE__)
+
+require 'vagrant-export/version'
+
+Gem::Specification.new do |g|
+  g.name          = 'vagrant-export'
+  g.version       = VagrantPlugins::Export::VERSION
+  g.platform      = Gem::Platform::RUBY
+  g.license       = 'MIT'
+  g.authors       = 'Georg Großberger'
+  g.email         = 'contact@grossberger-ge.org'
+  g.homepage      = 'https://github.com/trenker/vagrant-export'
+  g.summary       = 'Export boxes to .box files including the original Vagrantfile and some cleanups inside the VM'
+  g.description   = 'Export boxes to .box files including the original Vagrantfile and some cleanups inside the VM'
+
+  # The following block of code determines the files that should be included
+  # in the gem. It does this by reading all the files in the directory where
+  # this gemspec is, and parsing out the ignored files from the gitignore.
+  # Note that the entire gitignore(5) syntax is not supported, specifically
+  # the "!" syntax, but it should mostly work correctly.
+  root_path      = File.dirname(__FILE__)
+  all_files      = Dir.chdir(root_path) { Dir.glob('**/{*,.*}') }
+  all_files.reject! { |file| %w(. ..).include?(File.basename(file)) }
+  gitignore_path = File.join(root_path, '.gitignore')
+  gitignore      = File.readlines(gitignore_path)
+  gitignore.map!    { |line| line.chomp.strip }
+  gitignore.reject! { |line| line.empty? || line =~ /^(#|!)/ }
+
+  unignored_files = all_files.reject do |file|
+    # Ignore any directories, the gemspec only cares about files
+    next true if File.directory?(file)
+
+    # Ignore any paths that match anything in the gitignore. We do
+    # two tests here:
+    #
+    #   - First, test to see if the entire path matches the gitignore.
+    #   - Second, match if the basename does, this makes it so that things
+    #     like '.DS_Store' will match sub-directories too (same behavior
+    #     as git).
+    #
+    gitignore.any? do |ignore|
+      File.fnmatch(ignore, file, File::FNM_PATHNAME) ||
+        File.fnmatch(ignore, File.basename(file), File::FNM_PATHNAME)
+    end
+  end
+
+  g.files         = unignored_files
+  g.require_path  = 'lib'
+end

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: vagrant-export
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Georg Großberger
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-15 00:00:00.000000000 Z
+dependencies: []
+description: Export boxes to .box files including the original Vagrantfile and some
+  cleanups inside the VM
+email: contact@grossberger-ge.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- lib/vagrant-export.rb
+- lib/vagrant-export/command.rb
+- lib/vagrant-export/exporter.rb
+- lib/vagrant-export/plugin.rb
+- lib/vagrant-export/version.rb
+- res/cleanup.sh
+- vagrant-export.gemspec
+homepage: https://github.com/trenker/vagrant-export
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Export boxes to .box files including the original Vagrantfile and some cleanups
+  inside the VM
+test_files: []