vagrant-nitrousio 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 94d3ce9a1598b2afa84fae47b829b9f6679a30ec
+  data.tar.gz: 2c18ff49dc0f120f3eba97e8810e8209c4cf6799
+SHA512:
+  metadata.gz: 25c9520ae892b6e64b8ae18a527d1ef08d5af72f933a072ab56bf099ea918616ce36cdc33b7cd4d890a38a5f9a3d537c9ac48d491123a3f63139bca9cf99c211
+  data.tar.gz: ac7bfb0fbc7bd16857270f5f7a7449d6054a9ee9e40482ab3e50d39858cc0941e72cb1d77847093732219ec70f731fb6e28cda7df0e50246deac77d98af35e16

data/.env-example

@@ -0,0 +1,4 @@
+VAGRANT_NITROUSIO_OAUTH_ID=0f53c0c1dc8f85c250b92ace97b3608256b20ff0feff116a63df241301513fd5
+VAGRANT_NITROUSIO_OAUTH_SECRET=0e5138e61c65a7f259b23a1b0c6161e67440d44d41160a36deac1b64d792bc17
+VAGRANT_NITROUSIO_VERIFY_SSL=false
+VAGRANT_NITROUSIO_HOST=https://www.n2odev.com:5000

data/.gitignore

@@ -0,0 +1,17 @@
+.env
+
+# OS-specific
+.DS_Store
+
+# Bundler/Rubygems
+*.gem
+.bundle
+pkg/*
+tags
+Gemfile.lock
+vendor/bundle
+
+# Vagrant
+.vagrant
+Vagrantfile
+!example_box/Vagrantfile

data/.rspec

@@ -0,0 +1 @@
+--colour --profile

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  gem 'vagrant', :git => 'git://github.com/mitchellh/vagrant.git'
+end

data/LICENSE

@@ -0,0 +1,10 @@
+Copyright (c) 2013 Irrational Industries Inc. and Mitchell Hashimoto
+
+MIT License
+
+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,97 @@
+# Vagrant Nitrous.IO Provider
+
+This is a [Vagrant](http://www.vagrantup.com/) 1.6+ plugin that adds an
+[Nitrous.IO](https://www.nitrous.io/) provider to Vagrant, allowing Vagrant
+to control and provision containers in Nitrous.IO.
+
+## Features
+
+* Create and boot Nitrous.IO containers (boxes) with Vagrant.
+* SSH into Nitrous.IO containers.
+* Minimal synced folder support via `rsync`.
+* Provision the boxes with any built-in Vagrant provisioner
+
+## Install
+
+Install using standard Vagrant plugin installation methods. After
+installing, `vagrant up` and specify the `nitrousio` provider. An example is
+shown below.
+
+```
+$ vagrant plugin install vagrant-nitrousio
+```
+
+## Configure
+
+Once the provider has been installed, you will need to configure your project
+to use it. A sample `Vagrantfile` to create a container on Nitrous.IO
+is shown below:
+
+```ruby
+Vagrant.configure("2") do |config|
+  config.vm.hostname = 'test-box'
+
+  config.vm.provider :nitrousio do |provider, override|
+    override.vm.box = 'nitrousio'
+    override.vm.box_url = 'https://github.com/nitrous-io/vagrant-nitrousio/raw/master/nitrousio.box'
+
+    provider.host = "HOST_SLUG" # copy the host slug from Nitrous.IO web app or CLI
+    provider.username = ENV['NITROUS_USERNAME']
+    provider.password = ENV['NITROUS_PASSWORD']
+    provider.ssh_private_key_path = "~/.ssh/id_rsa"
+
+    # remove this to sync your project folder on provision
+    override.vm.synced_folder '.', '/vagrant', :disabled => true
+  end
+end
+```
+
+## Usage
+
+Once you have configured the Vagrantfile, you can create a new container by running:
+
+```
+$ vagrant up --provider=nitrousio
+```
+
+**Supported Commands**
+
+The provider supports the following Vagrant sub-commands:
+- `vagrant destroy` - Destroys the container.
+- `vagrant ssh` - Logs into the container using the default user
+  account.
+- `vagrant halt` - Stops the container.
+- `vagrant provision` - Runs the configured provisioners and rsyncs any
+  specified `config.vm.synced_folder`.
+
+## Configuration
+
+The provider exposes a few provider-specific configuration options:
+
+* `username` - Username of your Nitrous.IO account.
+* `password` - Password of your Nitrous.IO account.
+* `host`     - Slug of your Nitrous.IO host (you can check this from the web app or CLI)
+* `image`    - Set a base image for the container. This can be a path to a Docker repository.
+By default, all vagrant boxes will use `nitrousio/vagrant-base` as the image.
+
+## Networks
+
+Networking features in the form of `config.vm.network` are not
+supported with `vagrant-nitrousio`, currently. If any of these are
+specified, Vagrant will emit a warning, but will otherwise boot
+the Nitrous.IO box.
+
+## Synced Folders
+
+There is minimal support for synced folders. Upon `vagrant up`,
+`vagrant reload`, and `vagrant provision`, the Actin.IO provider
+will use `rsync` (if available) to uni-directionally sync the folder
+to the remote machine over SSH.
+
+This is good enough for all built-in Vagrant provisioners (shell,
+chef, and puppet) to work!
+
+## License
+
+Copyright (c) 2014 Nitrous, Inc. (formerly Irrational Industries Inc.) and Mitchell Hashimoto
+This software is licensed under the [MIT License](https://raw.github.com/action-io/vagrant-nitrousio/master/LICENSE).

data/Rakefile

@@ -0,0 +1,26 @@
+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
+
+# Default task is to run the unit tests
+task :default => 'install'
+
+desc 'Installs the plugin to test locally'
+task :install => ['spec'] do
+  system "rm -rf pkg && rake build && /usr/bin/vagrant plugin uninstall vagrant-nitrousio && /usr/bin/vagrant plugin install pkg/*.gem"
+end

data/example_box/README.md

@@ -0,0 +1,13 @@
+# Vagrant Nitrous.IO Example Box
+
+Vagrant providers each require a custom provider-specific box format.
+This folder shows the example contents of a box for the `nitrousio` provider.
+To turn this into a `.box` file:
+
+```
+$ tar cvzf nitrousio.box ./metadata.json ./Vagrantfile
+```
+
+This box works by using Vagrant's built-in Vagrantfile merging to setup
+defaults for Nitrous.IO These defaults can easily be overwritten by
+higher-level Vagrantfiles (such as project root Vagrantfiles).

data/example_box/metadata.json

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

data/lib/vagrant-nitrousio/action/add_pub_key.rb

@@ -0,0 +1,44 @@
+require 'log4r'
+require 'vagrant/util/retryable'
+require 'vagrant-nitrousio/errors'
+
+module VagrantPlugins
+  module NitrousIO
+    module Action
+      # This add the public key to the box.
+      class AddPubKey
+        include Vagrant::Util::Retryable
+
+        def initialize(app, env)
+          @app    = app
+          @logger = Log4r::Logger.new('vagrant_nitrousio::action::start_instance')
+        end
+
+        def call(env)
+          add_pub_key(env[:nitrousio], env[:machine])
+
+          # Poll server to check whether the box is ready
+          env[:ui].info(I18n.t('vagrant_nitrousio.adding_pub_key'))
+
+          @app.call(env)
+        end
+
+        def add_pub_key(nitrousio, machine)
+          # assumed public key exists on the same path as the prviate key with .pub ext
+          path = machine.provider_config.ssh_private_key_path
+          path = path[0] if path.is_a?(Array)
+          path = File.expand_path(path, machine.env.root_path)
+          pub_key = read_pub_key(path)
+
+          nitrousio.request(:post, "/containers/#{machine.id}/keys", params: { key: pub_key })
+        end
+
+        def read_pub_key(private_key_path)
+          File.read("#{private_key_path}.pub")
+        rescue
+          raise Errors::PublicKeyError, path: "#{private_key_path}.pub"
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-nitrousio/action/connect_nitrousio.rb

@@ -0,0 +1,31 @@
+require 'log4r'
+require 'vagrant-nitrousio/client'
+require 'vagrant-nitrousio/errors'
+
+module VagrantPlugins
+  module NitrousIO
+    module Action
+      # This action connects to NitrousIO, verifies credentials work, and
+      # puts the NitrousIO connection object into the `:nitrousio` key
+      # in the environment.
+      class ConnectNitrousIO
+
+        def initialize(app, env)
+          @app    = app
+          @logger = Log4r::Logger.new('vagrant_nitrousio::action::connect_nitrousio')
+        end
+
+        def call(env)
+          username = env[:machine].provider_config.username
+          password = env[:machine].provider_config.password
+          client = Client.new
+          client.authorize(username, password)
+
+          env[:nitrousio] = client
+
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,79 @@
+require 'log4r'
+require 'vagrant/util/retryable'
+require 'vagrant-nitrousio/util/timer'
+require 'vagrant-nitrousio/errors'
+require 'securerandom'
+
+module VagrantPlugins
+  module NitrousIO
+    module Action
+      # This creates a new container.
+      class Create
+        include Vagrant::Util::Retryable
+
+        def initialize(app, env)
+          @app    = app
+          @logger = Log4r::Logger.new('vagrant_nitrousio::action::run_instance')
+        end
+
+        def call(env)
+          # Initialize metrics if they haven't been
+          env[:metrics] ||= {}
+
+          nitrousio = env[:nitrousio]
+          machine = env[:machine]
+
+          # Get the configs
+          prefix = machine.config.vm.hostname || machine.name || "vagrant"
+          privileged = machine.provider_config.privileged
+          name = "#{prefix}-#{SecureRandom.random_number 10000}"
+          host = machine.provider_config.host
+          image = machine.provider_config.image
+
+          # Launch!
+          env[:ui].info I18n.t('vagrant_nitrousio.launching_box')
+          env[:ui].info " -- Box Name: #{name}"
+          env[:ui].info " -- Host: #{host}"
+          env[:ui].info " -- Image: #{image}"
+
+          env[:ui].info(I18n.t('vagrant_nitrousio.pulling_image'))
+          pull_image(nitrousio, machine, host, image)
+
+          env[:ui].info(I18n.t('vagrant_nitrousio.creating_box'))
+          create_container(nitrousio, machine, host, image, name, privileged)
+
+          if !env[:interrupted]
+            # Ready and booted!
+            env[:ui].info(I18n.t('vagrant_nitrousio.box_ready'))
+          end
+
+          # Terminate the instance if we were interrupted
+          terminate(env) if env[:interrupted]
+
+          @logger.info("Time to instance ready: #{env[:metrics]["instance_ready_time"]}")
+
+          @app.call(env)
+        end
+
+        def pull_image(nitrousio, machine, host, image)
+          nitrousio.request(:post, "/hosts/#{host}/images/pull", params: { repository: image })
+        end
+
+        def create_container(nitrousio, machine, host, image, box_name, privileged = false)
+          response = nitrousio.request(:post, '/containers', body: { slug: box_name, host: host, image: image, privileged: privileged })
+
+          # save box id
+          machine.id = response.parsed['container']['id']
+        end
+
+        def terminate(env)
+          destroy_env = env.dup
+          destroy_env.delete(:interrupted)
+          destroy_env[:config_validate] = false
+          destroy_env[:force_confirm_destroy] = true
+          env[:action_runner].run(Action.action_destroy, destroy_env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-nitrousio/action/is_created.rb

@@ -0,0 +1,18 @@
+module VagrantPlugins
+  module NitrousIO
+    module Action
+      # This can be used with "Call" built-in to check if the machine
+      # is created and branch in the middleware.
+      class IsCreated
+        def initialize(app, env)
+          @app = app
+        end
+
+        def call(env)
+          env[:result] = env[:machine].state.id != :not_created
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-nitrousio/action/is_running.rb

@@ -0,0 +1,18 @@
+module VagrantPlugins
+  module NitrousIO
+    module Action
+      # This can be used with "Call" built-in to check if the machine
+      # is running and branch in the middleware.
+      class IsRunning
+        def initialize(app, env)
+          @app = app
+        end
+
+        def call(env)
+          env[:result] = env[:machine].state.id == :running
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-nitrousio/action/is_stopped.rb

@@ -0,0 +1,18 @@
+module VagrantPlugins
+  module NitrousIO
+    module Action
+      # This can be used with "Call" built-in to check if the machine
+      # is stopped and branch in the middleware.
+      class IsStopped
+        def initialize(app, env)
+          @app = app
+        end
+
+        def call(env)
+          env[:result] = [:stopped, :host_stopped].include?(env[:machine].state.id)
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-nitrousio/action/is_terminated.rb

@@ -0,0 +1,18 @@
+module VagrantPlugins
+  module NitrousIO
+    module Action
+      # This can be used with "Call" built-in to check if the machine
+      # is terminated and branch in the middleware.
+      class IsTerminated
+        def initialize(app, env)
+          @app = app
+        end
+
+        def call(env)
+          env[:result] = env[:machine].id == nil
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-nitrousio/action/message_already_created.rb

@@ -0,0 +1,16 @@
+module VagrantPlugins
+  module NitrousIO
+    module Action
+      class MessageAlreadyCreated
+        def initialize(app, env)
+          @app = app
+        end
+
+        def call(env)
+          env[:ui].info(I18n.t('vagrant_nitrousio.already_created'))
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-nitrousio/action/message_already_terminated.rb

@@ -0,0 +1,16 @@
+module VagrantPlugins
+  module NitrousIO
+    module Action
+      class MessageAlreadyTerminated
+        def initialize(app, env)
+          @app = app
+        end
+
+        def call(env)
+          env[:ui].info(I18n.t('vagrant_nitrousio.already_terminated'))
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-nitrousio/action/message_cannot_halt.rb

@@ -0,0 +1,16 @@
+module VagrantPlugins
+  module NitrousIO
+    module Action
+      class MessageCannotHalt
+        def initialize(app, env)
+          @app = app
+        end
+
+        def call(env)
+          env[:ui].info(I18n.t('vagrant_nitrousio.cannot_halt'))
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-nitrousio/action/message_cannot_terminate.rb

@@ -0,0 +1,16 @@
+module VagrantPlugins
+  module NitrousIO
+    module Action
+      class MessageCannotTerminate
+        def initialize(app, env)
+          @app = app
+        end
+
+        def call(env)
+          env[:ui].info(I18n.t('vagrant_nitrousio.cannot_terminate'))
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-nitrousio/action/message_not_created.rb

@@ -0,0 +1,16 @@
+module VagrantPlugins
+  module NitrousIO
+    module Action
+      class MessageNotCreated
+        def initialize(app, env)
+          @app = app
+        end
+
+        def call(env)
+          env[:ui].info(I18n.t('vagrant_nitrousio.not_created'))
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-nitrousio/action/message_not_running.rb

@@ -0,0 +1,16 @@
+module VagrantPlugins
+  module NitrousIO
+    module Action
+      class MessageNotRunning
+        def initialize(app, env)
+          @app = app
+        end
+
+        def call(env)
+          env[:ui].info(I18n.t('vagrant_nitrousio.not_running'))
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-nitrousio/action/message_provisioning_not_yet_supported.rb

@@ -0,0 +1,16 @@
+module VagrantPlugins
+  module NitrousIO
+    module Action
+      class MessageProvisioningNotYetSupported
+        def initialize(app, env)
+          @app = app
+        end
+
+        def call(env)
+          env[:ui].info(I18n.t('vagrant_nitrousio.provisioning_not_yet_supported'))
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-nitrousio/action/read_ssh_info.rb

@@ -0,0 +1,60 @@
+require "log4r"
+
+module VagrantPlugins
+  module NitrousIO
+    module Action
+      # This action reads the SSH info for the machine and puts it into the
+      # `:machine_ssh_info` key in the environment.
+      class ReadSSHInfo
+        NITROUS_HOST_HOSTNAME = "nitrouspro.com"
+
+        def initialize(app, env)
+          @app    = app
+          @logger = Log4r::Logger.new("vagrant_nitrousio::action::read_ssh_info")
+        end
+
+        def call(env)
+          nitrousio = env[:nitrousio]
+          machine = env[:machine]
+
+          return nil if machine.id.nil?
+
+          # Find the box
+          begin
+            response = nitrousio.request(:get, "/containers/#{machine.id}/config")
+          rescue => e
+            if e.respond_to?(:response) && e.response.status == 404
+              # The machine can't be found
+              @logger.info("Box not found on Nitrous.IO, assuming it got destroyed.")
+              machine.id = nil
+              return nil
+            else
+              raise e
+            end
+          end
+
+          ssh_port = nil
+          box_config = response.parsed['config']
+          ssh_port = box_config['port'].map {|p| entry = /\Apublic:([^:]+):22(\/tcp)?\z/.match(p); entry ? entry[1] : nil }.compact.pop
+
+          unless ssh_port
+            @logger.info("Box doesn't expose a SSH port")
+            return nil
+          end
+
+          # Get the configuration
+          config = machine.provider_config
+
+          env[:machine_ssh_info] = {
+            host: "#{config.host}.#{NITROUS_HOST_HOSTNAME}", # FIXME: config response should include the hostname
+            port: ssh_port,
+            private_key_path: config.ssh_private_key_path,
+            username: 'action' # FIXME: read from the config response
+          }
+
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-nitrousio/action/read_state.rb

@@ -0,0 +1,36 @@
+require 'log4r'
+require 'vagrant-nitrousio/errors'
+
+module VagrantPlugins
+  module NitrousIO
+    module Action
+      # This action reads the state of the machine and puts it in the
+      # `:machine_state_id` key in the environment.
+      class ReadState
+        def initialize(app, env)
+          @app    = app
+          @logger = Log4r::Logger.new("vagrant_nitrousio::action::read_state")
+        end
+
+        def call(env)
+          env[:machine_state_id] = read_state(env[:nitrousio], env[:machine])
+
+          @app.call(env)
+        end
+
+        def read_state(nitrousio, machine)
+          return :not_created if machine.id.nil?
+
+          # Find the box
+          state = nitrousio.fetch_box_state(machine.id)
+          if state.nil?
+            @logger.info("Box not found on Nitrous.IO, assuming it got destroyed.")
+            machine.id = nil
+            return :not_created
+          end
+          state
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-nitrousio/action/remove_machine_id.rb

@@ -0,0 +1,19 @@
+module VagrantPlugins
+  module NitrousIO
+    module Action
+      # This can be used with "Call" built-in to check if the machine
+      # is terminated and branch in the middleware.
+      class RemoveMachineId
+        def initialize(app, env)
+          @app = app
+        end
+
+        def call(env)
+          env[:machine].id = nil
+
+          @app.call(env)
+        end
+      end
+    end
+  end
+end