vagrant-vmpooler 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0cc6fb009c3b0a198615d4fcd1adcdc5e7fd394d
-  data.tar.gz: b8759e327f2d75a66ce22afb7e918b5dcb26c280
+  metadata.gz: e486440ea637821124539808198cc50957bb029b
+  data.tar.gz: e554e152df419b00c8000868820e948eb5aa2347
 SHA512:
-  metadata.gz: b8c60d6655b641bb197c492755a6cb4049b813ce17464b2be5f15f8a0cd0c7f49ccefaedef1c245c564ca14cc2d938a12d16b4ae419daad50193507b00542013
-  data.tar.gz: df132df2989f210c4ecaad64ac6a1d8ec5ee4dc681df1213df33500c295d1c17972f82c43ef9faa62854fbd9edf8e8cbcdd576f7914d45ef426f7b441ab93dcf
+  metadata.gz: 882376fe4efc5110bd38861b3e90f0369de12f2dc36f2040bf0b914e9f1cc04d9f059a981d4bc6fb8a06f199bcaead92fa4dd77f41b76e6252806238b1de4404
+  data.tar.gz: ab6784bc7c9201ca52e411ed3b31eaa3ab60786f4094e29b3b119f8974aee1cc0ab094794b40b637dd3e80cd134cb68e716e064ae03da8d91c0039ba4f71e45b

data/.gitignore

@@ -0,0 +1,21 @@
+# OS-specific
+.DS_Store
+
+# editors
+*.swp
+
+# Bundler/Rubygems
+*.gem
+.bundle
+pkg/*
+tags
+Gemfile.lock
+
+# Vagrant
+.vagrant
+Vagrantfile
+!example_box/Vagrantfile
+
+# RVM files for gemset/ruby setting
+.ruby-*
+.rvmrc

data/Gemfile

@@ -0,0 +1,15 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem "vmfloaty", "0.5.0"
+
+group :development do
+  gem "vagrant", git: "https://github.com/mitchellh/vagrant.git"
+  gem "rspec"
+  gem "rake"
+end
+
+group :plugins do
+  gem "vagrant-vmpooler", path: "."
+end

data/LICENSE

@@ -0,0 +1,15 @@
+   vagrant-vmpooler
+
+   Copyright (C) 2016 Brian cain
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,143 @@
+# Vagrant Vmpooler Provider
+
+vagrant-vmpooler is still a work in progress and a lot of things might not work at the moment. If you find a bug, feel free to open up an issue on this repository.
+
+[![Gem Version](https://badge.fury.io/rb/vagrant-vmpooler.svg)](https://badge.fury.io/rb/vagrant-vmpooler)
+
+### Features
+
+* Quickly provision virtual machines with vmpooler and vagrant
+* SSH into machines
+* Provision the instances with any built-in Vagrant provisioner
+* Sync folders with Rsync
+* Built off of the [vmfloaty](https://github.com/briancain/vmfloaty) library, using the [vmpooler](https://github.com/puppetlabs/vmpooler) api
+
+## Usage
+
+### Quick Start
+
+To quickly get started, install the vagrant plugin with the command below. Then you'll want to add a dummy box from the [example_box](example_box) directory...finally create a Vagrantfile and run the up command with the `vmpooler` provider.
+
+```
+$ vagrant plugin install vagrant-vmpooler
+...
+$ vagrant box add dummy https://github.com/briancain/vagrant-vmpooler/blob/master/example_box/dummy.box
+...
+$ vagrant up --provider=vmpooler
+...
+```
+
+### Example Vagrantfile
+
+A few examples to get you started
+
+```ruby
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+# Provisioning script
+provision_script = <<SCRIPT
+#!/bin/bash
+echo "Hello there" > ~/hi.txt
+SCRIPT
+
+Vagrant.configure("2") do |config|
+  config.vm.box = "dummy"
+
+  # vagrant-vmpooler already assumes you are root
+  config.vm.provision :shell, :inline => provision_script, privileged: false
+
+  config.vm.provider :vmpooler do |vmpooler|
+    vmpooler.os = "centos-7-x86_64"
+    vmpooler.ttl = 24
+    vmpooler.password = "secretpassword"
+  end
+end
+```
+
+## Configuration
+
+Similar to [vmfloaty](https://github.com/briancain/vmfloaty#vmfloaty-dotfile), a few of these settings can be defined in the `vmfloaty` dotfile located in your home directory. However, they can be overridden in a Vagrantfile if needed. The configuration values that can be set in that dotfile below are explicitly called out.
+
+* `url`
+  + __REQUIRED__
+  + __vmfloaty dotfile config setting__
+  + string
+  + The url to your vmpooler installation
+* `os`
+  + __REQUIRED__
+  + string
+  + The type of operatingsystem to get from the pooler
+* `password`
+  + __REQUIRED__
+  + string
+  + The password to use to log into the vmpooler machine
+* `verbose`
+  + boolean
+  + Whether or not to run vmfloaty api calls in verbose mode
+  + defaults to `false`
+* `token`
+  + __vmfloaty dotfile config setting__
+  + string
+  + The token used to obtain vms
+* `ttl`
+  + integer
+  + How long the vm should additionally stay active for (default is 12 with token)
+* `disk`
+  + integer
+  + Increases default disk space by this size
+
+These can be set like any other vagrant provider:
+
+```ruby
+Vagrant.configure("2") do |config|
+  # ... other stuff
+
+  config.vm.provider :vmpooler do |vmpooler|
+    vmpooler.password = "foo"
+    vmpooler.os = "ubuntu-1604-x86_64"
+    vmpooler.ttl = 48
+  end
+end
+```
+
+## Synced Folders
+
+At the moment, vagrant-vmpooler only supports rsync for syncing folders. It requires both the host machine and remote machine to have rsync installed. Right now there's a basic setup step that will install rsync on the remote host before syncing folders since several vmpooler machines do not have it installed by default.
+
+## Limitations
+
+Both of the commands are not supported in this plugin since vmpooler gives no api support for halting or suspending vms. Running these commands will result in a warning from vagrant-vmpooler.
+
+* `vagrant halt`
+* `vagrant suspend`
+
+vagrant-vmpooler assumes that it will be logging in as root or Administrator (windows) to any vmpooler vm.
+
+## Development
+
+To work on the `vagrant-vmpooler` plugin, clone this repository out, and use
+[Bundler](http://gembundler.com) to get the dependencies:
+
+```
+$ bundle
+```
+
+Once you have the dependencies, verify the unit tests pass with `rake`:
+
+```
+$ bundle exec rake
+```
+
+If those pass, you're ready to start developing the plugin. You can test
+the plugin without installing it into your Vagrant environment by just
+creating a `Vagrantfile` in the top level of this directory (it is gitignored)
+and add the following line to your `Vagrantfile`
+
+```ruby
+Vagrant.require_plugin "vagrant-vmpooler"
+```
+Use bundler to execute Vagrant:
+```
+$ bundle exec vagrant up --provider=vmpooler
+```

data/Rakefile

@@ -0,0 +1,22 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'rspec/core/rake_task'
+
+# Immediately sync all stdout so that tools like buildbot can
+# immediately load in the output.
+$stdout.sync = true
+$stderr.sync = true
+
+# Change to the directory of this file.
+Dir.chdir(File.expand_path("../", __FILE__))
+
+# This installs the tasks that help with gem creation and
+# publishing.
+Bundler::GemHelper.install_tasks
+
+# Install the `spec` task so that we can run tests.
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = "--order defined"
+end
+# Default task is to run the unit tests
+task :default => :spec

data/example_box/Vagrantfile

@@ -0,0 +1,22 @@
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+# Provisioning script
+provision_script = <<SCRIPT
+#!/bin/bash
+echo "Hello there" > ~/hi.txt
+SCRIPT
+
+Vagrant.configure("2") do |config|
+  config.vm.box = "dummy"
+
+  # vagrant-vmpooler already assumes you are root
+  config.vm.provision :shell, :inline => provision_script, privileged: false
+
+  config.vm.provider :vmpooler do |vmpooler|
+    vmpooler.os = "centos-7-x86_64"
+    #vmpooler.os = "ubuntu-1604-x86_64"
+    vmpooler.ttl = 24
+    vmpooler.password = "Qu@lity!"
+  end
+end

data/example_box/metadata.json

@@ -0,0 +1,3 @@
+{
+  "provider": "vmpooler"
+}

data/example_box/readme.md

@@ -0,0 +1,8 @@
+# Vagrant vmpooler example Vagrantfile
+
+Creating and adding a dummy box
+
+```shell
+tar -czvf dummy.box metadata.json
+vagrant box add dummy.box --name dummy
+```

data/lib/vagrant-vmpooler.rb

@@ -0,0 +1,53 @@
+require "pathname"
+
+require "vagrant-vmpooler/plugin"
+
+module VagrantPlugins
+  module Vmpooler
+    lib_path = Pathname.new(File.expand_path("../vagrant-vmpooler", __FILE__))
+    autoload :Errors, lib_path.join("errors")
+
+    # This initializes the i18n load path so that the plugin-specific
+    # translations work.
+    def self.init_i18n
+      I18n.load_path << File.expand_path("locales/en.yml", source_root)
+      I18n.reload!
+    end
+
+    # This initializes the logging so that our logs are outputted at
+    # the same level as Vagrant core logs.
+    def self.init_logging
+      # Initialize logging
+      level = nil
+      begin
+        level = Log4r.const_get(ENV["VAGRANT_LOG"].upcase)
+      rescue NameError
+        # This means that the logging constant wasn't found,
+        # which is fine. We just keep `level` as `nil`. But
+        # we tell the user.
+        level = nil
+      end
+
+      # Some constants, such as "true" resolve to booleans, so the
+      # above error checking doesn't catch it. This will check to make
+      # sure that the log level is an integer, as Log4r requires.
+      level = nil if !level.is_a?(Integer)
+
+      # Set the logging level on all "vagrant" namespaced
+      # logs as long as we have a valid level.
+      if level
+        logger = Log4r::Logger.new("vagrant_vmpooler")
+        logger.outputters = Log4r::Outputter.stderr
+        logger.level = level
+        logger = nil
+      end
+    end
+
+    # This returns the path to the source of this plugin.
+    #
+    # @return [Pathname]
+    def self.source_root
+      @source_root ||= Pathname.new(File.expand_path("../../", __FILE__))
+    end
+  end
+end

data/lib/vagrant-vmpooler/action.rb

@@ -0,0 +1,212 @@
+require "pathname"
+
+require "vagrant/action/builder"
+
+module VagrantPlugins
+  module Vmpooler
+    module Action
+      # Include the built-in modules so we can use them as top-level things.
+      include Vagrant::Action::Builtin
+
+      # This action is called when `vagrant destroy` is executed.
+      def self.action_destroy
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use Call, DestroyConfirm do |env, b1|
+            if env[:result]
+              b1.use DeleteServer
+            else
+              b1.use MessageWillNotDestroy
+            end
+          end
+        end
+      end
+
+      # This action is called to read the SSH info of the machine. The
+      # resulting state is expected to be put into the `:machine_ssh_info`
+      # key.
+      def self.action_read_ssh_info
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use ReadSSHInfo
+        end
+      end
+
+      # This action is called to read the state of the machine. The
+      # resulting state is expected to be put into the `:machine_state_id`
+      # key.
+      def self.action_read_state
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use ReadState
+        end
+      end
+
+      # This action is called when `vagrant ssh` is executed.
+      def self.action_ssh
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use Call, IsCreated do |env, b1|
+            unless env[:result]
+              b1.use MessageNotCreated
+              next
+            end
+
+            b1.use SSHExec
+          end
+        end
+      end
+
+      def self.action_ssh_run
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use Call, IsCreated do |env, b1|
+            unless env[:result]
+              b1.use MessageNotCreated
+              next
+            end
+
+            b1.use SSHRun
+          end
+        end
+      end
+
+      def self.action_prepare_boot
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use Provision
+          b.use SyncFolders
+          b.use SetHostname
+        end
+      end
+
+      # This action is called when `vagrant up` is executed.
+      def self.action_up
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use HandleBox
+          b.use ConfigValidate
+          b.use Call, IsCreated do |env, b1|
+            unless env[:result]
+              b1.use action_prepare_boot
+              b1.use CreateServer
+              b1.use SetupRsync
+            else
+              b1.use action_resume
+            end
+          end
+        end
+      end
+
+      # This action is called when `vagrant provision` is executed.
+      def self.action_provision
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use Call, IsCreated do |env, b1|
+            unless env[:result]
+              b1.use MessageNotCreated
+              next
+            end
+
+            b1.use Provision
+            b1.use SyncFolders
+          end
+        end
+      end
+
+      # This action is called when `vagrant reload` is executed.
+      def self.action_reload
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use Call, IsPaused do |env, b1|
+            unless env[:result]
+              b1.use Call, IsSuspended do |env2, b2|
+                env[:ui].warn(I18n.t("vagrant_vmpooler.not_supported"))
+                #b2.use RebootServer
+              end
+            end
+
+            b1.use Call, WaitForState, [:active], 120 do |env2, b2|
+              unless env2[:result]
+                env[:ui].warn(I18n.t("vagrant_vmpooler.not_supported"))
+                #b2.use HardRebootServer
+              end
+            end
+          end
+        end
+      end
+
+      # This action is called when `vagrant halt` is executed.
+      def self.action_halt
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use Call, IsCreated do |env, b1|
+            # throw error?
+            env[:ui].warn(I18n.t("vagrant_vmpooler.not_supported"))
+          end
+        end
+      end
+
+      # This action is called when `vagrant resume` is executed.
+      def self.action_resume
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use Call, IsCreated do |env, b1|
+            if env[:result]
+              b1.use MessageServerRunning
+              next
+            end
+
+            b1.use ResumeServer
+            b1.use SyncFolders
+          end
+        end
+      end
+
+      # This action is called when `vagrant suspend` is executed.
+      def self.action_suspend
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use Call, IsCreated do |env, b1|
+            env[:ui].warn(I18n.t("vagrant_vmpooler.not_supported"))
+          end
+        end
+      end
+
+      def self.action_take_snapshot
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use Call, IsCreated do |env, b1|
+            if env[:result]
+              b2.use TakeSnapshot
+            else
+              b1.use MessageNotCreated
+            end
+          end
+        end
+      end
+
+      # The autoload farm
+      action_root = Pathname.new(File.expand_path("../action", __FILE__))
+      autoload :CreateServer, action_root.join("create_server")
+      autoload :DeleteServer, action_root.join("delete_server")
+      autoload :HardRebootServer, action_root.join("hard_reboot_server")
+      autoload :IsCreated, action_root.join("is_created")
+      autoload :IsPaused, action_root.join("is_paused")
+      autoload :IsSuspended, action_root.join("is_suspended")
+      autoload :MessageAlreadyCreated, action_root.join("message_already_created")
+      autoload :MessageNotCreated, action_root.join("message_not_created")
+      autoload :MessageNotSuspended, action_root.join("message_not_suspended")
+      autoload :MessageWillNotDestroy, action_root.join("message_will_not_destroy")
+      autoload :MessageServerRunning, action_root.join("message_server_running")
+      autoload :PauseServer, action_root.join("pause_server")
+      autoload :ReadSSHInfo, action_root.join("read_ssh_info")
+      autoload :ReadState, action_root.join("read_state")
+      autoload :RebootServer, action_root.join("reboot_server")
+      autoload :ResumeServer, action_root.join("resume_server")
+      autoload :SuspendServer, action_root.join("suspend_server")
+      autoload :SyncFolders, action_root.join("sync_folders")
+      autoload :TakeSnapshot, action_root.join("take_snapshot")
+      autoload :WaitForState, action_root.join("wait_for_state")
+      autoload :SetupRsync, action_root.join("setup_rsync")
+    end
+  end
+end