tnargav 1.3.5 → 1.3.6

data/plugins/commands/help/command.rb

@@ -0,0 +1,12 @@
+require 'optparse'
+
+module VagrantPlugins
+  module CommandHelp
+    class Command < Vagrant.plugin("2", :command)
+      def execute
+        return @env.cli([]) if @argv.empty?
+        @env.cli([@argv[0], "-h"])
+      end
+    end
+  end
+end

data/plugins/commands/help/plugin.rb

@@ -0,0 +1,17 @@
+require "vagrant"
+
+module VagrantPlugins
+  module CommandHelp
+    class Plugin < Vagrant.plugin("2")
+      name "help command"
+      description <<-DESC
+      The `help` command shows help for the given command.
+      DESC
+
+      command("help") do
+        require File.expand_path("../command", __FILE__)
+        Command
+      end
+    end
+  end
+end

data/plugins/commands/init/command.rb

@@ -0,0 +1,40 @@
+require 'optparse'
+
+require 'vagrant/util/template_renderer'
+
+module VagrantPlugins
+  module CommandInit
+    class Command < Vagrant.plugin("2", :command)
+      def execute
+        options = {}
+
+        opts = OptionParser.new do |opts|
+          opts.banner = "Usage: vagrant init [box-name] [box-url]"
+        end
+
+        # Parse the options
+        argv = parse_options(opts)
+        return if !argv
+
+        save_path = @env.cwd.join("Vagrantfile")
+        raise Vagrant::Errors::VagrantfileExistsError if save_path.exist?
+
+        template_path = ::Vagrant.source_root.join("templates/commands/init/Vagrantfile")
+        contents = Vagrant::Util::TemplateRenderer.render(template_path,
+                                                          :box_name => argv[0] || "base",
+                                                          :box_url => argv[1])
+
+        # Write out the contents
+        save_path.open("w+") do |f|
+          f.write(contents)
+        end
+
+        @env.ui.info(I18n.t("vagrant.commands.init.success"),
+                     :prefix => false)
+
+        # Success, exit status 0
+        0
+       end
+    end
+  end
+end

data/plugins/commands/init/plugin.rb

@@ -0,0 +1,18 @@
+require "vagrant"
+
+module VagrantPlugins
+  module CommandInit
+    class Plugin < Vagrant.plugin("2")
+      name "init command"
+      description <<-DESC
+      The `init` command sets up your working directory to be a
+      Vagrant-managed environment.
+      DESC
+
+      command("init") do
+        require File.expand_path("../command", __FILE__)
+        Command
+      end
+    end
+  end
+end

data/plugins/commands/package/command.rb

@@ -0,0 +1,83 @@
+require 'optparse'
+
+module VagrantPlugins
+  module CommandPackage
+    class Command < Vagrant.plugin("2", :command)
+      def execute
+        options = {}
+
+        opts = OptionParser.new do |o|
+          o.banner = "Usage: vagrant package [vm-name] [--base name] [--output name.box]"
+          o.separator "                       [--include one,two,three] [--vagrantfile file]"
+
+          o.separator ""
+
+          o.on("--base NAME", "Name of a VM in virtualbox to package as a base box") do |b|
+            options[:base] = b
+          end
+
+          o.on("--output NAME", "Name of the file to output") do |output|
+            options[:output] = output
+          end
+
+          o.on("--include x,y,z", Array, "Additional files to package with the box.") do |i|
+            options[:include] = i
+          end
+
+          o.on("--vagrantfile file", "Vagrantfile to package with the box.") do |v|
+            options[:vagrantfile] = v
+          end
+        end
+
+        # Parse the options
+        argv = parse_options(opts)
+        return if !argv
+
+        @logger.debug("package options: #{options.inspect}")
+        if options[:base]
+          package_base(options)
+        else
+          package_target(argv[0], options)
+        end
+
+        # Success, exit status 0
+        0
+      end
+
+      protected
+
+      def package_base(options)
+        # XXX: This whole thing is hardcoded and very temporary. The whole
+        # `vagrant package --base` process is deprecated for something much
+        # better in the future. We just hardcode this to keep VirtualBox working
+        # for now.
+        provider = Vagrant.plugin("2").manager.providers[:virtualbox]
+        vm = Vagrant::Machine.new(
+          options[:base],
+          :virtualbox, provider[0], nil, provider[1],
+          @env.config_global,
+          nil, nil,
+          @env, true)
+        @logger.debug("Packaging base VM: #{vm.name}")
+        package_vm(vm, options)
+      end
+
+      def package_target(name, options)
+        with_target_vms(name, :single_target => true) do |vm|
+          @logger.debug("Packaging VM: #{vm.name}")
+          package_vm(vm, options)
+        end
+      end
+
+      def package_vm(vm, options)
+        opts = options.inject({}) do |acc, data|
+          k,v = data
+          acc["package.#{k}"] = v
+          acc
+        end
+
+        vm.action(:package, opts)
+      end
+    end
+  end
+end

data/plugins/commands/package/plugin.rb

@@ -0,0 +1,18 @@
+require "vagrant"
+
+module VagrantPlugins
+  module CommandPackage
+    class Plugin < Vagrant.plugin("2")
+      name "package command"
+      description <<-DESC
+      The `package` command will take a previously existing Vagrant
+      environment and package it into a box file.
+      DESC
+
+      command("package") do
+        require File.expand_path("../command", __FILE__)
+        Command
+      end
+    end
+  end
+end

data/plugins/commands/plugin/action.rb

@@ -0,0 +1,63 @@
+require "pathname"
+
+require "vagrant/action/builder"
+
+module VagrantPlugins
+  module CommandPlugin
+    module Action
+      # This middleware sequence will install a plugin.
+      def self.action_install
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use BundlerCheck
+          b.use InstallGem
+          b.use PruneGems
+        end
+      end
+
+      # This middleware sequence licenses paid addons.
+      def self.action_license
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use BundlerCheck
+          b.use LicensePlugin
+        end
+      end
+
+      # This middleware sequence will list all installed plugins.
+      def self.action_list
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use BundlerCheck
+          b.use ListPlugins
+        end
+      end
+
+      # This middleware sequence will uninstall a plugin.
+      def self.action_uninstall
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use BundlerCheck
+          b.use UninstallPlugin
+          b.use PruneGems
+        end
+      end
+
+      # This middleware sequence will update a plugin.
+      def self.action_update
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use BundlerCheck
+          b.use PluginExistsCheck
+          b.use InstallGem
+          b.use PruneGems
+        end
+      end
+
+      # The autoload farm
+      action_root = Pathname.new(File.expand_path("../action", __FILE__))
+      autoload :BundlerCheck, action_root.join("bundler_check")
+      autoload :InstallGem, action_root.join("install_gem")
+      autoload :LicensePlugin, action_root.join("license_plugin")
+      autoload :ListPlugins, action_root.join("list_plugins")
+      autoload :PluginExistsCheck, action_root.join("plugin_exists_check")
+      autoload :PruneGems, action_root.join("prune_gems")
+      autoload :UninstallPlugin, action_root.join("uninstall_plugin")
+    end
+  end
+end

data/plugins/commands/plugin/action/bundler_check.rb

@@ -0,0 +1,25 @@
+module VagrantPlugins
+  module CommandPlugin
+    module Action
+      class BundlerCheck
+        def initialize(app, env)
+          @app = app
+        end
+
+        def call(env)
+          # Bundler sets up its own custom gem load paths such that our
+          # own gems are never loaded. Therefore, give an error if a user
+          # tries to install gems while within a Bundler-managed environment.
+          if defined?(Bundler)
+            require 'bundler/shared_helpers'
+            if Bundler::SharedHelpers.in_bundle?
+              raise Vagrant::Errors::GemCommandInBundler
+            end
+          end
+
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/plugins/commands/plugin/action/install_gem.rb

@@ -0,0 +1,106 @@
+require "rubygems"
+require "rubygems/dependency_installer"
+require "rubygems/format"
+
+require "log4r"
+
+module VagrantPlugins
+  module CommandPlugin
+    module Action
+      # This action takes the `:plugin_name` variable in the environment
+      # and installs it using the RubyGems API.
+      class InstallGem
+        def initialize(app, env)
+          @app    = app
+          @logger = Log4r::Logger.new("vagrant::plugins::plugincommand::installgem")
+        end
+
+        def call(env)
+          plugin_name = env[:plugin_name]
+          prerelease  = env[:plugin_prerelease]
+          version     = env[:plugin_version]
+
+          # Determine the plugin name we'll look for in the installed set
+          # in order to determine the version and all that.
+          find_plugin_name = plugin_name
+          if plugin_name =~ /\.gem$/
+            # If we're installing from a gem file, determine the name
+            # based on the spec in the file.
+            pkg = Gem::Format.from_file_by_path(plugin_name)
+            find_plugin_name = pkg.spec.name
+          end
+
+          # Install the gem
+          plugin_name_label = plugin_name
+          plugin_name_label += ' --prerelease' if prerelease
+          plugin_name_label += " --version '#{version}'" if version
+          env[:ui].info(I18n.t("vagrant.commands.plugin.installing",
+                               :name => plugin_name_label))
+          installed_gems = env[:gem_helper].with_environment do
+            # Override the list of sources by the ones set as a parameter if given
+            if env[:plugin_sources]
+              @logger.info("Custom plugin sources: #{env[:plugin_sources]}")
+              Gem.sources = env[:plugin_sources]
+            end
+
+            installer = Gem::DependencyInstaller.new(:document => [], :prerelease => prerelease)
+
+            begin
+              installer.install(plugin_name, version)
+            rescue Gem::GemNotFoundException
+              raise Vagrant::Errors::PluginInstallNotFound,
+                :name => plugin_name
+            end
+          end
+
+          # The plugin spec is the last installed gem since RubyGems
+          # currently always installed the requested gem last.
+          @logger.debug("Installed #{installed_gems.length} gems.")
+          plugin_spec = installed_gems.find do |gem|
+            gem.name.downcase == find_plugin_name.downcase
+          end
+
+          # Store the installed name so we can uninstall it if things go
+          # wrong.
+          @installed_plugin_name = plugin_spec.name
+
+          # Mark that we installed the gem
+          @logger.info("Adding the plugin to the state file...")
+          env[:plugin_state_file].add_plugin(plugin_spec.name)
+
+          # Tell the user
+          env[:ui].success(I18n.t("vagrant.commands.plugin.installed",
+                                  :name => plugin_spec.name,
+                                  :version => plugin_spec.version.to_s))
+
+          # If the plugin's spec includes a post-install message display it
+          post_install_message = plugin_spec.post_install_message
+          if post_install_message
+            if post_install_message.is_a?(Array)
+              post_install_message = post_install_message.join(" ")
+            end
+
+            env[:ui].info(I18n.t("vagrant.commands.plugin.post_install",
+                                 :name => plugin_spec.name,
+                                 :message => post_install_message.to_s))
+          end
+
+          # Continue
+          @app.call(env)
+        end
+
+        def recover(env)
+          # If any error happens, we uninstall it and remove it from
+          # the state file. We can only do this if we successfully installed
+          # the gem in the first place.
+          if @installed_plugin_name
+            new_env = env.dup
+            new_env.delete(:interrupted)
+            new_env[:plugin_name] = @installed_plugin_name
+            new_env[:action_runner].run(Action.action_uninstall, new_env)
+          end
+        end
+      end
+    end
+  end
+end

data/plugins/commands/plugin/action/license_plugin.rb

@@ -0,0 +1,54 @@
+require "fileutils"
+require "pathname"
+require "rubygems"
+require "set"
+
+require "log4r"
+
+module VagrantPlugins
+  module CommandPlugin
+    module Action
+      # This middleware licenses a plugin by copying the license file to
+      # the proper place.
+      class LicensePlugin
+        def initialize(app, env)
+          @app    = app
+          @logger = Log4r::Logger.new("vagrant::plugins::plugincommand::license")
+        end
+
+        def call(env)
+          # Get the list of installed plugins according to the state file
+          installed = Set.new(env[:plugin_state_file].installed_plugins)
+
+          # If the plugin we're trying to license doesn't exist in the
+          # state file, then it is an error.
+          if !installed.include?(env[:plugin_name])
+            raise Vagrant::Errors::PluginNotFound, :name => env[:plugin_name]
+          end
+
+          # Verify the license file exists
+          license_file = Pathname.new(env[:plugin_license_path])
+          if !license_file.file?
+            raise Vagrant::Errors::PluginInstallLicenseNotFound,
+              :name => env[:plugin_name],
+              :path => license_file.to_s
+          end
+
+          # Copy it in.
+          final_path = env[:home_path].join("license-#{env[:plugin_name]}.lic")
+          @logger.info("Copying license from: #{license_file}")
+          @logger.info("Copying license to: #{final_path}")
+          env[:ui].info(I18n.t("vagrant.commands.plugin.installing_license",
+                               :name => env[:plugin_name]))
+          FileUtils.cp(license_file, final_path)
+
+          # Installed!
+          env[:ui].success(I18n.t("vagrant.commands.plugin.installed_license",
+                                 :name => env[:plugin_name]))
+
+          @app.call(env)
+        end
+      end
+    end
+  end
+end