vagrant-vultr_pro 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: af7e04eb1e12c5f8c361ca9048bb5845c48edb049a54df7253ac37de9f95c702
+  data.tar.gz: 0f2e346487d9e580924718d23067e90d83f31d5b3a47e371ccfe8ffdc11291a5
+SHA512:
+  metadata.gz: a86c1a36f3a57040692ed7d27838e5c24f8b06c16acd485bb0a39e7844335c690e82cebfa039f097ede800b35a2f508aac66a58294dab2646c3df2903f035583
+  data.tar.gz: bee7783e0e1db418ddf877a33d0be06e28f7f9f14564b23d0c1803f1c912e1d9cab195ab1beb216bbe05b401bdb1d33f28ff59465809c7747a3cd873a1070c94

data/.gitignore

@@ -0,0 +1,9 @@
+pkg/
+tmp/
+.bundle/
+vendor/bundle/
+.vagrant/
+Gemfile.lock
+.envrc
+.ruby-version
+/.idea/

data/.projections.json

@@ -0,0 +1,4 @@
+{
+  "lib/vagrant-vultr/action.rb": {"type": "action"},
+  "lib/vagrant-vultr/action/*.rb": {"type": "action"}
+}

data/CHANGELOG.md

@@ -0,0 +1,23 @@
+## 0.2.0
+
+* Add the 'label', 'tag', and 'hostname' parameters to create_server.
+
+* Add the 'ssh_key' and 'startup_script' parameters to create_server.
+
+* Add the 'timeout' parameter to `client.rb`.
+
+* Fix the bug of vultr v0.4.3 for `reboot` method.
+
+* Fix the bug of `wait_to_power_on` method when ssh is not ready
+
+## 0.1.2
+
+* Fixed issues with renamed Vultr API (#4, #5)
+
+## 0.1.1
+
+* Fix issue with plan selection (#1)
+
+## 0.1.0
+
+* Initial release

data/Gemfile

@@ -0,0 +1,9 @@
+source 'http://rubygems.org'
+
+group :development do
+  gem 'vagrant', github: 'mitchellh/vagrant'
+end
+
+group :plugins do
+  gemspec
+end

data/LICENSE.md

@@ -0,0 +1,20 @@
+Copyright (c) 2015 Alex Rodionov
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,116 @@
+vagrant-vultr_pro [![Gem Version](https://badge.fury.io/rb/vagrant-vultr.svg)](http://badge.fury.io/rb/vagrant-vultr)
+============
+
+Vagrant plugin that allows to use [Vultr](https://vultr.com/) as provider.
+
+For now, basic operations like vagrant up/halt/reload/destroy/provision are supported.
+
+Installation
+------------
+
+```bash
+$ vagrant plugin install vagrant-vultr_pro
+```
+
+Usage
+-----
+
+Create simple Vagrantfile:
+
+```ruby
+Vagrant.configure(2) do |config|
+  config.vm.provider :vultr do |vultr, override|
+    override.ssh.private_key_path = '~/.ssh/id_rsa'
+    override.vm.box = 'vultr'
+    override.vm.box_url = 'https://github.com/p0deje/vagrant-vultr/raw/master/box/vultr.box'
+
+    vultr.token = 'YOUR_TOKEN'  # You can also use VULTR_TOKEN environment variable
+    vultr.region = 'Seattle'
+    vultr.plan = '768 MB RAM,15 GB SSD,1.00 TB BW'
+
+    # Use either OS name or Snapshot identifier
+    vultr.os = 'Ubuntu 14.04 x64'
+    vultr.snapshot = '524557af2439b'
+
+    # Optional parameters
+    vultr.label    = 'My Label'
+    vultr.tag      = 'My Tag'
+    vultr.hostname = 'myhostname'
+
+    # New optional parameters
+    vultr.timeout  = 300
+    vultr.ssh_key  = 'vagrant'
+    vultr.startup_script  = 'user'
+  end
+end
+```
+
+Now start vagrant box:
+
+```bash
+$ vagrant up --provider=vultr
+```
+
+Notes
+-----
+
+1. You have to specify `override.ssh.private_key_path`. Public key will be uploaded to Vultr as "vagrant" SSH key and will be used when servers are created.
+2. Currently, servers are created with "root" user.
+3. If you hit API rate limit, you can set `VULTR_RATE_LIMIT_INTERVAL_MS` environment variable to introduce delay between API requests.
+
+Build
+-------
+
+First commit all modifications to git, and then upload gem to `https://rubygems.org` by command below:
+
+```bash
+$ rake release
+```
+
+If you have any mistake for uploaded gem, you can remove it from `https://rubygems.org` by command below:
+
+```bash
+$ gem yank vagrant-vultr_pro -v 0.2.0
+```
+
+Testing
+-------
+
+First of all, add the box that is used for testing:
+
+```bash
+$ bundle exec rake box:add
+```
+
+Since the tests involve actual calls to Vultr, you have to provide a valid API token:
+
+```bash
+$ export VULTR_TOKEN="token"
+```
+
+Now you can run tests:
+
+```bash
+$ bundle exec rake cucumber
+```
+
+Note that Vultr is not very stable, so tests sometimes may fail due to timeout or 404 API requests.
+
+In the end, remove the box:
+
+```bash
+$ bundle exec rake box:remove
+```
+
+Contributing
+------------
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Commit, do not mess with Rakefile, version, or history. If you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull.
+* Send me a pull request. Bonus points for topic branches.
+
+Copyright
+---------
+
+Copyright (c) 2015 Alex Rodionov. See LICENSE.md for details.

data/Rakefile

@@ -0,0 +1,17 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+namespace :box do
+  desc 'Adds test vagrant box.'
+  task :add do
+    sh 'bundle exec vagrant box add --name vultr ./box/vultr.box'
+  end
+
+  desc 'Removes testing vagrant box.'
+  task :remove do
+    sh 'bundle exec vagrant box remove vultr'
+  end
+end
+
+require 'cucumber/rake/task'
+Cucumber::Rake::Task.new

data/features/support/env.rb

@@ -0,0 +1,11 @@
+require 'aruba/cucumber'
+
+Before do
+  # VM start takes a long time
+  @aruba_timeout_seconds = 600
+end
+
+After do
+  # halt VM
+  system 'cd tmp/aruba; bundle exec vagrant halt &> /dev/null'
+end

data/features/vagrant-vultr.feature

@@ -0,0 +1,78 @@
+@announce
+@no-clobber
+Feature: vagrant-vultr_pro
+  In order to use Vultr
+  As a Vagrant provider
+  I want to use plugin for that
+
+  Background:
+    Given I write to "Vagrantfile" with:
+      """
+      Vagrant.configure(2) do |config|
+        config.vm.box = 'vultr'
+        config.vm.synced_folder '.', '/vagrant', type: 'rsync'
+        config.ssh.private_key_path = '~/.ssh/id_rsa'
+
+        config.vm.provision 'shell',
+          inline: 'echo "it works" > /tmp/vultr-provision',
+          privileged: false
+      end
+      """
+
+  Scenario: creates server on up
+    When I run `bundle exec vagrant up --provider=vultr`
+    Then the exit status should be 0
+    And the output should contain "Machine is booted and ready to use!"
+    When I run `bundle exec vagrant status`
+    Then the output should contain "active (vultr)"
+
+  Scenario: starts created server on up
+    When I run `bundle exec vagrant up --provider=vultr`
+    And I run `bundle exec vagrant halt`
+    And I run `bundle exec vagrant up --provider=vultr`
+    Then the exit status should be 0
+    And the output should contain "Machine is booted and ready to use!"
+    When I run `bundle exec vagrant status`
+    Then the output should contain "active (vultr)"
+
+  Scenario: syncs folders
+    When I run `bundle exec vagrant up --provider=vultr`
+    And I run `bundle exec vagrant ssh -c "test -d /vagrant"`
+    Then the exit status should be 0
+
+  Scenario: provisions server
+    When I run `bundle exec vagrant up --provider=vultr`
+    And I run `bundle exec vagrant ssh -c "cat /tmp/vultr-provision"`
+    Then the exit status should be 0
+    And the output should contain "it works"
+
+  Scenario: executes SSH to created server
+    When I run `bundle exec vagrant up --provider=vultr`
+    And I run `bundle exec vagrant ssh` interactively
+    And I type "uname -a"
+    And I close the stdin stream
+    Then the output should contain "vultr.guest"
+
+  Scenario: reboots server on reload
+    When I run `bundle exec vagrant up --provider=vultr`
+    And I run `bundle exec vagrant reload`
+    Then the exit status should be 0
+    And the output should contain "Machine is booted and ready to use!"
+    When I run `bundle exec vagrant status`
+    Then the output should contain "active (vultr)"
+
+  Scenario: shutdowns server on halt
+    When I run `bundle exec vagrant up --provider=vultr`
+    And I run `bundle exec vagrant halt`
+    Then the exit status should be 0
+    And the output should contain "Machine is stopped."
+    When I run `bundle exec vagrant status`
+    Then the output should contain "off (vultr)"
+
+  Scenario: removes server on destroy
+    When I run `bundle exec vagrant up --provider=vultr`
+    And I run `bundle exec vagrant destroy --force`
+    Then the exit status should be 0
+    And the output should contain "Machine is destroyed."
+    When I run `bundle exec vagrant status`
+    Then the output should contain "not created"

data/lib/vagrant-vultr/action/check_state.rb

@@ -0,0 +1,20 @@
+module VagrantPlugins
+  module Vultr
+    module Action
+      class CheckState
+        def initialize(app, env)
+          @app = app
+          @machine = env[:machine]
+          @logger = Log4r::Logger.new('vagrant::vultr::check_state')
+        end
+
+        def call(env)
+          env[:machine_state] = @machine.state.id
+          @logger.info "Machine state is '#{@machine.state.id}'."
+
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-vultr/action/create.rb

@@ -0,0 +1,73 @@
+require 'vagrant-vultr/helpers/client'
+
+module VagrantPlugins
+  module Vultr
+    module Action
+      class Create
+        include Helpers::Client
+
+        def initialize(app, env)
+          @app = app
+          @machine = env[:machine]
+          @client = client
+          @logger = Log4r::Logger.new('vagrant::vultr::create')
+        end
+
+        def call(env)
+          region   = env[:machine].provider_config.region
+          plan     = env[:machine].provider_config.plan
+          os       = env[:machine].provider_config.os
+          snapshot = env[:machine].provider_config.snapshot
+          enable_ipv6 = env[:machine].provider_config.enable_ipv6
+          enable_private_network = env[:machine].provider_config.enable_private_network
+          label    = env[:machine].provider_config.label
+          tag      = env[:machine].provider_config.tag
+          hostname = env[:machine].provider_config.hostname
+          ssh_key = env[:machine].provider_config.ssh_key
+          startup_script = env[:machine].provider_config.startup_script
+
+          @logger.info "Creating server with:"
+          @logger.info "  -- Region: #{region}"
+          @logger.info "  -- OS: #{os}"
+          @logger.info "  -- Plan: #{plan}"
+          @logger.info "  -- Snapshot: #{snapshot}"
+          @logger.info "  -- Enable IPv6: #{enable_ipv6}"
+          @logger.info "  -- Enable Private Network: #{enable_private_network}"
+          @logger.info "  -- Label: #{label}"
+          @logger.info "  -- Tag: #{tag}"
+          @logger.info "  -- Hostname: #{hostname}"
+          @logger.info "  -- Ssh key: #{ssh_key}"
+          @logger.info "  -- Startup script: #{startup_script}"
+
+          attributes = {
+            region: region,
+            os: os,
+            plan: plan,
+            snapshot: snapshot,
+            enable_ipv6: enable_ipv6,
+            enable_private_network: enable_private_network,
+            label: label,
+            tag: tag,
+            hostname: hostname,
+            ssh_key_name: ssh_key,
+            startup_script_name: startup_script,
+          }
+          @machine.id = @client.create_server(attributes)
+
+          env[:ui].info 'Waiting for subscription to become active...'
+          @client.wait_to_activate(@machine.id)
+
+          env[:ui].info 'Waiting for server to start...'
+          @client.wait_to_power_on(@machine.id)
+
+          env[:ui].info 'Waiting for SSH to become active...'
+          @client.wait_for_ssh(@machine)
+
+          env[:ui].info 'Machine is booted and ready to use!'
+
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-vultr/action/destroy.rb

@@ -0,0 +1,30 @@
+require 'vagrant-vultr/helpers/client'
+
+module VagrantPlugins
+  module Vultr
+    module Action
+      class Destroy
+        include Helpers::Client
+
+        def initialize(app, env)
+          @app = app
+          @machine = env[:machine]
+          @client = client
+          @logger = Log4r::Logger.new('vagrant::vultr::destroy')
+        end
+
+        def call(env)
+          @client.destroy_server(@machine.id)
+
+          env[:ui].info 'Waiting for server to be destroyed...'
+          @client.wait_to_destroy(@machine.id)
+
+          env[:ui].info 'Machine is destroyed.'
+          @machine.id = nil
+
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-vultr/action/power_off.rb

@@ -0,0 +1,25 @@
+require 'vagrant-vultr/helpers/client'
+
+module VagrantPlugins
+  module Vultr
+    module Action
+      class PowerOff
+        include Helpers::Client
+
+        def initialize(app, env)
+          @app = app
+          @machine = env[:machine]
+          @client = client
+          @logger = Log4r::Logger.new('vagrant::vultr::power_off')
+        end
+
+        def call(env)
+          @client.stop_server(@machine.id)
+          env[:ui].info 'Machine is stopped.'
+
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-vultr/action/power_on.rb

@@ -0,0 +1,32 @@
+require 'vagrant-vultr/helpers/client'
+
+module VagrantPlugins
+  module Vultr
+    module Action
+      class PowerOn
+        include Helpers::Client
+
+        def initialize(app, env)
+          @app = app
+          @machine = env[:machine]
+          @client = client
+          @logger = Log4r::Logger.new('vagrant::vultr::power_on')
+        end
+
+        def call(env)
+          @client.start_server(@machine.id)
+
+          env[:ui].info 'Waiting for server to start...'
+          @client.wait_to_power_on(@machine.id)
+
+          env[:ui].info 'Waiting for SSH to become active...'
+          @client.wait_for_ssh(@machine)
+
+          env[:ui].info 'Machine is booted and ready to use!'
+
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-vultr/action/reload.rb

@@ -0,0 +1,32 @@
+require 'vagrant-vultr/helpers/client'
+
+module VagrantPlugins
+  module Vultr
+    module Action
+      class Reload
+        include Helpers::Client
+
+        def initialize(app, env)
+          @app = app
+          @machine = env[:machine]
+          @client = client
+          @logger = Log4r::Logger.new('vagrant::vultr::reload')
+        end
+
+        def call(env)
+          @client.reboot_server(@machine.id)
+          env[:ui].info 'Machine is stopped.'
+
+          env[:ui].info 'Waiting for server to start...'
+          @client.wait_to_power_on(@machine.id)
+          env[:ui].info 'Waiting for SSH to become active...'
+          @client.wait_for_ssh(@machine)
+
+          env[:ui].info 'Machine is booted and ready to use!'
+
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-vultr/action/setup_ssh_key.rb

@@ -0,0 +1,31 @@
+require 'vagrant-vultr/helpers/client'
+
+module VagrantPlugins
+  module Vultr
+    module Action
+      class SetupSSHKey
+        include Helpers::Client
+
+        def initialize(app, env)
+          @app = app
+          @machine = env[:machine]
+          @name = @machine.provider_config.ssh_key
+          @client = client
+          @logger = Log4r::Logger.new('vagrant::vultr::setup_ssh_key')
+        end
+
+        def call(env)
+          ssh_key_id = @client.ssh_key_id(@name)
+          unless ssh_key_id
+            @logger.info 'SSH key does not exist. Creating new one...'
+            key_path = File.expand_path("#{@machine.config.ssh.private_key_path.first}.pub")
+            ssh_key_id = @client.create_ssh_key(@name, File.read(key_path))
+          end
+          @logger.info "Using SSH key: #{ssh_key_id}."
+
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-vultr/action.rb

@@ -0,0 +1,132 @@
+require 'vagrant-vultr/action/check_state'
+require 'vagrant-vultr/action/create'
+require 'vagrant-vultr/action/destroy'
+require 'vagrant-vultr/action/power_off'
+require 'vagrant-vultr/action/power_on'
+require 'vagrant-vultr/action/reload'
+require 'vagrant-vultr/action/setup_ssh_key'
+
+module VagrantPlugins
+  module Vultr
+    module Action
+      include Vagrant::Action::Builtin
+
+      def self.up
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use Call, CheckState do |env, b2|
+            case env[:machine_state]
+            when :active
+              env[:ui].info 'Machine is already booted.'
+            when :off
+              b2.use PowerOn
+              b2.use Provision
+              b2.use SyncedFolders
+            when :not_created
+              b2.use SetupSSHKey
+              b2.use Create
+              b2.use Provision
+              b2.use SyncedFolders
+            end
+          end
+        end
+      end
+
+      def self.halt
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use Call, CheckState do |env, b2|
+            case env[:machine_state]
+            when :active
+              b2.use PowerOff
+            when :off
+              env[:ui].info 'Machine is not booted.'
+            when :not_created
+              env[:ui].info 'Machine is not created.'
+            end
+          end
+        end
+      end
+
+      def self.reload
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use Call, CheckState do |env, b2|
+            case env[:machine_state]
+            when :active
+              b2.use Reload
+              b2.use Provision
+              b2.use SyncedFolders
+            when :off
+              env[:ui].info 'Machine is not booted.'
+            when :not_created
+              env[:ui].info 'Machine is not created.'
+            end
+          end
+        end
+      end
+
+      def self.destroy
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use Call, CheckState do |env, b2|
+            case env[:machine_state]
+            when :active, :off
+              b2.use Destroy
+            when :not_created
+              env[:ui].info 'Machine is not created.'
+            end
+          end
+        end
+      end
+
+      def self.provision
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use Call, CheckState do |env, b2|
+            case env[:machine_state]
+            when :active
+              b2.use Provision
+            when :off
+              env[:ui].info 'Machine is not booted.'
+            when :not_created
+              env[:ui].info 'Machine is not created.'
+            end
+          end
+        end
+      end
+
+      def self.ssh
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use Call, CheckState do |env, b2|
+            case env[:machine_state]
+            when :active
+              b2.use SSHExec
+            when :off
+              env[:ui].info 'Machine is not booted.'
+            when :not_created
+              env[:ui].info 'Machine is not created.'
+            end
+          end
+        end
+      end
+
+      def self.ssh_run
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use Call, CheckState do |env, b2|
+            case env[:machine_state]
+            when :active
+              b2.use SSHRun
+            when :off
+              env[:ui].info 'Machine is not booted.'
+            when :not_created
+              env[:ui].info 'Machine is not created.'
+            end
+          end
+        end
+      end
+    end
+  end
+end