vagrant-lightsail 0.1.0

data/lib/vagrant-lightsail/action/terminate_instance.rb

@@ -0,0 +1,31 @@
+require 'log4r'
+
+module VagrantPlugins
+  module Lightsail
+    module Action
+      # This terminates the running instance.
+      class TerminateInstance
+        def initialize(app, _)
+          @app    = app
+          @logger = Log4r::Logger.new('vagrant_lightsail::action::terminate_instance')
+        end
+
+        def call(env)
+          server = env[:lightsail_client].get_instance(instance_name: env[:machine].id).instance
+
+          # Destroy the server and remove the tracking ID
+          env[:ui].info(I18n.t('vagrant_lightsail.terminating'))
+          begin
+            env[:lightsail_client].delete_instance(instance_name: server.name)
+          rescue Aws::Lightsail::Errors => e
+            raise Errors::LightailError, message: e
+          end
+
+          env[:machine].id = nil
+
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-lightsail/action/wait_for_state.rb

@@ -0,0 +1,40 @@
+require 'log4r'
+require 'timeout'
+
+module VagrantPlugins
+  module Lightsail
+    module Action
+      # This action will wait for a machine to reach a specific state
+      # or quit by timeout
+      class WaitForState
+        # env[:result] will be false in case of timeout.
+        # @param [Symbol] state Target machine state.
+        # @param [Number] timeout Timeout in seconds.
+        def initialize(app, _, state, timeout)
+          @app     = app
+          @logger  = Log4r::Logger.new('vagrant_lightsail::action::wait_for_state')
+          @state   = state
+          @timeout = timeout
+        end
+
+        def call(env)
+          env[:result] = true
+          if env[:machine].state.id == @state
+            @logger.info I18n.t('vagrant_lightsail.already_status', status: @state)
+          else
+            @logger.info "Waiting for machine to reach state #{@state}"
+            begin
+              Timeout.timeout(@timeout) do
+                sleep 2 until env[:machine].state.id == @state
+              end
+            rescue Timeout::Error
+              env[:result] = false # couldn't reach state in time
+            end
+          end
+
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-lightsail/action.rb

@@ -0,0 +1,165 @@
+module VagrantPlugins
+  module Lightsail
+    module Action
+      include Vagrant::Action::Builtin
+
+      # 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.read_ssh_info
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use ConnectLightsail
+          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.read_state
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use ConnectLightsail
+          b.use ReadState
+        end
+      end
+
+      # This action is called to bring the box up from nothing.
+      def self.up
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use HandleBox
+          b.use ConfigValidate
+          b.use BoxCheckOutdated
+          b.use ConnectLightsail
+          b.use Call, IsCreated do |env1, b1|
+            if env1[:result]
+              b1.use Call, IsStopped do |env2, b2|
+                if env2[:result]
+                  b2.use prepare_boot
+                  b2.use StartInstance # restart this instance
+                else
+                  b2.use MessageAlreadyCreated # TODO: write a better message
+                end
+              end
+            else
+              b1.use SetupKey
+              b1.use prepare_boot
+              b1.use RunInstance # launch a new instance
+            end
+          end
+        end
+      end
+
+      def self.prepare_boot
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use Provision
+          b.use SyncedFolders
+        end
+      end
+
+      # This action is called to terminate the remote machine.
+      def self.destroy
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use Call, DestroyConfirm do |env, b2|
+            if env[:result]
+              b2.use ConfigValidate
+              b2.use Call, IsCreated do |env2, b3|
+                unless env2[:result]
+                  b3.use MessageNotCreated
+                  next
+                end
+
+                b3.use ConnectLightsail
+                b3.use ProvisionerCleanup, :before if defined? ProvisionerCleanup
+                b3.use TerminateInstance
+              end
+            else
+              b2.use MessageWillNotDestroy
+            end
+          end
+        end
+      end
+
+      # This action is called when `vagrant provision` is called.
+      def self.provision
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use Call, IsCreated do |env, b2|
+            unless env[:result]
+              b2.use MessageNotCreated
+              next
+            end
+
+            b2.use Provision
+          end
+        end
+      end
+
+      def self.reload
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use ConnectLightsail
+          b.use Call, IsCreated do |env, b2|
+            unless env[:result]
+              b2.use MessageNotCreated
+              next
+            end
+
+            b2.use halt
+            b2.use up
+          end
+        end
+      end
+
+      # This action is called to halt the remote machine.
+      def self.halt
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use Call, IsCreated do |env, b2|
+            unless env[:result]
+              b2.use MessageNotCreated
+              next
+            end
+
+            b2.use ConnectLightsail
+            b2.use StopInstance
+            b2.use WaitForState, :stopped, 120
+          end
+        end
+      end
+
+      # This action is called to SSH into the machine.
+      def self.ssh
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use Call, IsCreated do |env, b2|
+            unless env[:result]
+              b2.use MessageNotCreated
+              next
+            end
+
+            b2.use SSHExec
+          end
+        end
+      end
+
+      # The autload farm
+      action_root = Pathname.new(File.expand_path('../action', __FILE__))
+      autoload :ConnectLightsail, action_root.join('connect_lightsail')
+      autoload :IsCreated, action_root.join('is_created')
+      autoload :IsStopped, action_root.join('is_stopped')
+      autoload :MessageAlreadyCreated, action_root.join('message_already_created')
+      autoload :MessageNotCreated, action_root.join('message_not_created')
+      autoload :MessageWillNotDestroy, action_root.join('message_will_not_destroy')
+      autoload :ReadSSHInfo, action_root.join('read_ssh_info')
+      autoload :ReadState, action_root.join('read_state')
+      autoload :RunInstance, action_root.join('run_instance')
+      autoload :SetupKey, action_root.join('setup_key')
+      autoload :StartInstance, action_root.join('start_instance')
+      autoload :StopInstance, action_root.join('stop_instance')
+      autoload :TerminateInstance, action_root.join('terminate_instance')
+      autoload :WaitForState, action_root.join('wait_for_state')
+    end
+  end
+end

data/lib/vagrant-lightsail/config.rb

@@ -0,0 +1,125 @@
+require 'iniparse'
+
+module VagrantPlugins
+  module Lightsail
+    class Config < Vagrant.plugin('2', :config)
+      attr_accessor :access_key_id
+      attr_accessor :availability_zone
+      attr_accessor :aws_dir
+      attr_accessor :aws_profile
+      attr_accessor :blueprint_id
+      attr_accessor :bundle_id
+      attr_accessor :endpoint
+      attr_accessor :keypair_name
+      attr_accessor :region
+      attr_accessor :secret_access_key
+      attr_accessor :session_token
+      attr_accessor :user_data
+
+      def initialize
+        @access_key_id     = UNSET_VALUE
+        @availability_zone = UNSET_VALUE
+        @aws_dir           = UNSET_VALUE
+        @aws_profile       = UNSET_VALUE
+        @blueprint_id      = UNSET_VALUE
+        @bundle_id         = UNSET_VALUE
+        @endpoint          = UNSET_VALUE
+        @keypair_name      = UNSET_VALUE
+        @region            = UNSET_VALUE
+        @secret_access_key = UNSET_VALUE
+        @session_token     = UNSET_VALUE
+        @user_data         = UNSET_VALUE
+      end
+
+      def finalize!
+        if @access_key_id == UNSET_VALUE || @secret_access_key == UNSET_VALUE
+          @aws_profile = 'default'                   if @aws_profile == UNSET_VALUE
+          @aws_dir     = ENV['HOME'].to_s + '/.aws/' if @aws_dir == UNSET_VALUE
+
+          @aws_region, @access_key_id, @secret_access_key, @session_token = Credentials.new.get_aws_info(@aws_profile, @aws_dir)
+          @region = @aws_region if @region == UNSET_VALUE && !@aws_region.nil?
+        else
+          @aws_profile = nil
+          @aws_dir     = nil
+        end
+
+        @blueprint_id      = 'ubuntu_16_04' if @blueprint_id      == UNSET_VALUE
+        @bundle_id         = 'nano_1_0'     if @bundle_id         == UNSET_VALUE
+        @endpoint          = nil            if @endpoint          == UNSET_VALUE
+        @keypair_name      = 'vagrant'      if @keypair_name      == UNSET_VALUE
+        @region            = 'us-east-1'    if @region            == UNSET_VALUE
+        @availability_zone = "#{@region}a"  if @availability_zone == UNSET_VALUE
+        @session_token     = nil            if @session_token     == UNSET_VALUE
+        @user_data         = nil            if @user_data         == UNSET_VALUE
+      end
+
+      def validate(_)
+        errors = []
+
+        if @aws_profile && (@access_key_id.nil? || @secret_access_key.nil? || @region.nil?)
+          errors << I18n.t('vagrant_lightsail.config.aws_info_required',
+                           profile: @aws_profile, location: @aws_dir)
+        end
+
+        errors << I18n.t('vagrant_lightsail.config.region_required') if @region.nil?
+
+        { 'Lightsail Provider' => errors }
+      end
+    end
+
+    class Credentials < Vagrant.plugin('2', :config)
+      def get_aws_info(profile, location)
+        aws_region, aws_id, aws_secret, aws_token = read_aws_environment
+
+        if aws_id.to_s.empty? || aws_secret.to_s.empty?
+          aws_config = ENV['AWS_CONFIG_FILE'].to_s
+          aws_creds  = ENV['AWS_SHARED_CREDENTIALS_FILE'].to_s
+
+          if aws_config.empty? || aws_creds.empty?
+            aws_config = location + 'config'
+            aws_creds  = location + 'credentials'
+          end
+
+          if File.exist?(aws_config) && File.exist?(aws_creds)
+            aws_region, aws_id, aws_secret, aws_token = read_aws_files(profile, aws_config, aws_creds)
+          end
+
+        end
+
+        aws_region = nil if aws_region == ''
+        aws_id     = nil if aws_id     == ''
+        aws_secret = nil if aws_secret == ''
+        aws_token  = nil if aws_token  == ''
+
+        [aws_region, aws_id, aws_secret, aws_token]
+      end
+
+      private
+
+      def read_aws_files(profile, aws_config, aws_creds)
+        conf_profile = profile == 'default' ? profile : 'profile ' + profile
+
+        data_conf   = File.read(aws_config)
+        doc_conf    = IniParse.parse(data_conf)
+        aws_region  = doc_conf[conf_profile]['region']
+
+        data_cred  = File.read(aws_creds)
+        doc_cred   = IniParse.parse(data_cred)
+        aws_id     = doc_cred[profile]['aws_access_key_id']
+        aws_secret = doc_cred[profile]['aws_secret_access_key']
+        aws_token  = doc_cred[profile]['aws_session_token']
+
+        [aws_region, aws_id, aws_secret, aws_token]
+      end
+
+      def read_aws_environment
+        aws_region = ENV['AWS_DEFAULT_REGION']
+        aws_id     = ENV['AWS_ACCESS_KEY_ID']
+        aws_secret = ENV['AWS_SECRET_ACCESS_KEY']
+        aws_token  = ENV['AWS_SESSION_TOKEN']
+
+        [aws_region, aws_id, aws_secret, aws_token]
+      end
+    end
+  end
+end

data/lib/vagrant-lightsail/errors.rb

@@ -0,0 +1,17 @@
+require 'vagrant'
+
+module VagrantPlugins
+  module Lightsail
+    class VagrantLightsailError < Vagrant::Errors::VagrantError
+      error_namespace('vagrant_lightsail.errors')
+    end
+
+    class LightsailError < VagrantLightsailError
+      error_key(:lightsail_error)
+    end
+
+    class PublicKeyError < VagrantLightsailError
+      error_key(:public_key)
+    end
+  end
+end

data/lib/vagrant-lightsail/plugin.rb

@@ -0,0 +1,28 @@
+module VagrantPlugins
+  module Lightsail
+    class Plugin < Vagrant.plugin('2')
+      name 'Lightsail'
+      description <<-DESC
+        This plugin installs a provider that allows Vagrant to manage
+        machines in AWS Lightsail.
+      DESC
+
+      config(:lightsail, :provider) do
+        require_relative 'config'
+        Config
+      end
+
+      provider(:lightsail, parallel: true) do
+        setup_i18n
+        require_relative 'provider'
+        Provider
+      end
+
+      # This initializes the internationalization strings.
+      def self.setup_i18n
+        I18n.load_path << File.expand_path('locales/en.yml', Lightsail.source_root)
+        I18n.reload!
+      end
+    end
+  end
+end

data/lib/vagrant-lightsail/provider.rb

@@ -0,0 +1,41 @@
+require 'vagrant'
+require 'vagrant-lightsail/action'
+
+module VagrantPlugins
+  module Lightsail
+    class Provider < Vagrant.plugin('2', :provider)
+      def initialize(machine)
+        @machine = machine
+      end
+
+      def action(name)
+        return Action.send(name) if Action.respond_to?(name)
+        nil
+      end
+
+      def ssh_info
+        # Run a custom action called "read_ssh_info" which does what
+        # it says and puts the resulting SSH info into the
+        # `:machine_ssh_info` key in the environment.
+        env = @machine.action('read_ssh_info', lock: false)
+        env[:machine_ssh_info]
+      end
+
+      def state
+        # Run a custom action called "read_state" which does what it
+        # says and puts the state into the `:machine_state_id` key in
+        # the environment.
+        env = @machine.action('read_state', lock: false)
+
+        state_id = env[:machine_state_id]
+
+        # Get the short and long description
+        short = I18n.t("vagrant_lightsail.states.short_#{state_id}")
+        long  = I18n.t("vagrant_lightsail.states.long_#{state_id}")
+
+        # Return the MachineState object
+        Vagrant::MachineState.new(state_id, short, long)
+      end
+    end
+  end
+end

data/lib/vagrant-lightsail/version.rb

@@ -0,0 +1,5 @@
+module VagrantPlugins
+  module Lightsail
+    VERSION = '0.1.0'.freeze
+  end
+end

data/lib/vagrant-lightsail.rb

@@ -0,0 +1,13 @@
+require 'vagrant-lightsail/version'
+require 'vagrant-lightsail/plugin'
+
+module VagrantPlugins
+  module Lightsail
+    # 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/locales/en.yml

@@ -0,0 +1,50 @@
+en:
+  vagrant_lightsail:
+
+    config:
+      aws_info_required: |-
+        One or more of the needed AWS credentials are missing. No
+        environment variables are set nor profile '%{profile}' exists
+        at '%{location}'
+      region_required: |-
+        A region must be specified via "region"
+
+    errors:
+      lightsail_error: |-
+        There was an error talking to AWS. The error message is shown
+        below:
+
+        %{message}
+      public_key: |-
+        There was an issue reading the public key at:
+
+        Path: %{path}
+
+        Please check the file's permissions.
+
+    already_status: |-
+      The machine is already %{status}.
+    creating_key: |-
+      Creating new SSH key %{name}...
+    launching_instance: |-
+      Launching an instance with the following settings...
+    launch_no_keypair: |-
+      Warning! You didn't specify a keypair to launch your instance with.
+      This can sometimes result in not being able to access your instance.
+    not_created: |-
+      Instance is not created. Please run `vagrant up` first.
+    ready: |-
+      Machine is booted and ready for use!
+    starting: |-
+      Starting the instance...
+    stopping: |-
+      Stopping the instance...
+    terminating: |-
+      Terminating the instance...
+    waiting_for_ready: |-
+      Waiting for instance to become "ready"...
+    waiting_for_ssh: |-
+      Waiting for SSH to become available...
+    will_not_destroy: |-
+      The instance '%{name}' will not be destroyed, since the
+      confirmation was declined.

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'vagrant-lightsail'

data/spec/vagrant/lightsail_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe VagrantPlugins::Lightsail do
+  it 'has a version number' do
+    expect(VagrantPlugins::Lightsail::VERSION).not_to be nil
+  end
+
+  it 'does something useful' do
+    expect(false).to eq(true)
+  end
+end

data/test/Vagrantfile

@@ -0,0 +1,21 @@
+Vagrant.require_plugin('vagrant-lightsail')
+
+Vagrant.configure('2') do |config|
+  config.ssh.private_key_path = '~/.ssh/id_rsa'
+
+  config.vm.synced_folder '.', '/vagrant', disabled: true
+
+  config.vm.provider :lightsail do |provider, override|
+    override.vm.box       = 'lightsail'
+    override.vm.box_url   = 'https://github.com/thejandroman/vagrant-lightsail/raw/master/box/lightsail.box'
+    override.ssh.username = 'ubuntu'
+    provider.keypair_name = 'Test-Key'
+  end
+
+  config.vm.provision :shell, path: 'scripts/provision.sh'
+  config.puppet_install.puppet_version = :latest
+  config.vm.provision 'puppet' do |puppet|
+    puppet.environment_path = 'puppet'
+    puppet.environment      = 'lightsail'
+  end
+end

data/test/puppet/lightsail/manifests/default.pp

@@ -0,0 +1 @@
+notify { 'Testing 1 2 3!': }

data/test/scripts/provision.sh

@@ -0,0 +1,3 @@
+#!/bin/bash
+
+echo 'Testing 1 2 3!'

data/test/test.sh

@@ -0,0 +1,33 @@
+#!/bin/bash
+
+destroy() {
+    ANSWER=$1
+    read -r -d '' EXPECT_CMD <<EOF
+spawn bundle exec vagrant destroy
+expect {Are you sure you want to destroy}
+send "$ANSWER\r"
+interact
+EOF
+    expect -c "$EXPECT_CMD"
+}
+
+if ! bundle exec vagrant box list | grep lightsail 1>/dev/null; then
+    bundle exec vagrant box add box/lightsail.box
+fi
+
+cd test || exit
+
+bundle exec vagrant up --provider=lightsail
+bundle exec vagrant up
+bundle exec vagrant provision
+bundle exec vagrant reload
+bundle exec vagrant halt
+bundle exec vagrant up
+destroy 'N'
+bundle exec vagrant destroy --force
+exit
+destroy 'N'
+destroy 'y'
+bundle exec vagrant destroy --force
+bundle exec vagrant provision
+bundle exec vagrant reload

data/vagrant-lightsail.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'vagrant-lightsail/version'
+require 'English'
+
+Gem::Specification.new do |spec|
+  spec.name        = 'vagrant-lightsail'
+  spec.version     = VagrantPlugins::Lightsail::VERSION
+  spec.authors     = ['Alejandro Figueroa']
+  spec.email       = ['alejandro@ideasftw.com']
+  spec.summary     = 'Enables Vagrant to manage machines in AWS Lightsail.'
+  spec.description = 'Enables Vagrant to manage machines in AWS Lightsail.'
+  spec.homepage    = 'http://github.com/thejandroman/vagrant-lightsail'
+  spec.license     = 'MIT'
+
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'aws-sdk', '~> 2.6'
+  spec.add_runtime_dependency 'iniparse', '~> 1.4'
+
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 12.0'
+  spec.add_development_dependency 'rubocop', '~> 0.46'
+end