vagrant-lightsail 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 82b6fc2ea5e0e5fd4c462a2e74516426060ca956
-  data.tar.gz: 3a9418b432a35da4848f966695fa40b0ef2b5b2e
+  metadata.gz: ba1f77ceffe556ec6fd1a0ce5ae63caa9f62864b
+  data.tar.gz: d5740a3fd4889b718aa970f947599adb15a59865
 SHA512:
-  metadata.gz: 51b0c4ba1515e68cf9cfa559e51f57708f4576d4a145f4875e3b8d4c9992ff0a1978a98ebf3bfdd49ab678ac02c728dea224021237f044d49dfd05c155c5afd6
-  data.tar.gz: 6b13ed86e7e12095f3dc5ab2961f8f6fbec18be9095ba8f27c65d352d1ca89ede07bb3ef566bf23a5eed1d834da71b71f1cd386b7933732ce7d839c14c62f5f7
+  metadata.gz: f0262c3f1677c1bd933a7d8115429aea232f05cbbdb2fd193e56cd32e1129e7dc5dc88d9593d981b73e96525db457ddf04f0ff34d3a0fb0ebdc6d94417b54929
+  data.tar.gz: aa18a305de6327a944a6b789dcb6c350b31ef154ea480bbd5a4edc0cef9d765c15263aacb5bd3e963e278a58791d25b7e421b0e2bc7ea82b566cb8c5be0e9cbf

data/.gitignore

@@ -4,7 +4,7 @@
 /_yardoc/
 /coverage/
 /doc/
-/pkg/
+*.gem
 /spec/reports/
 /tmp/
 /test/.vagrant/

data/CHANGELOG.md

@@ -0,0 +1,21 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/)
+and this project adheres to [Semantic Versioning](http://semver.org/).
+
+## [Unreleased]
+
+## [0.2.0] - 2017-01-24
+### Added
+- Translation information for vagrant states
+- New action, configure_ports, allows for opening of public firewall
+  ports
+
+### Changed
+- Simplify API calls when starting, stopping, and terminating
+  instances
+
+## [0.1.0] - 2017-01-17
+### Added
+- Initial release

data/README.md

@@ -1,5 +1,7 @@
 # Lightsail Vagrant Provider
 
+[![Gem Version](https://badge.fury.io/rb/vagrant-lightsail.svg)](https://badge.fury.io/rb/vagrant-lightsail)
+
 `vagrant-lightsail` is a [Vagrant](https://www.vagrantup.com/) 1.2+
 plugin that support managing [Lightsail](https://amazonlightsail.com/)
 instances.
@@ -9,6 +11,7 @@ It can:
 - Power on and off instances
 - Provision an instance
 - Setup an SSH public key for authentication
+- Open public firewall ports on instance
 
 It is based heavily
 on [vagrant-aws](https://github.com/mitchellh/vagrant-aws)
@@ -37,6 +40,7 @@ Vagrant.configure('2') do |config|
     provider.access_key_id     = 'YOUR KEY'
     provider.secret_access_key = 'YOUR SECRET KEY'
     provider.keypair_name      = 'KEYPAIR NAME'
+    provider.port_info         = [{ from_port: 443, to_port: 443, protocol: 'tcp' }]
   end
 end
 ```
@@ -84,6 +88,8 @@ The following attributes are available to configure the provider:
 - `keypair_name`
   * The name to use when creating an SSH key for
     authentication. Defaults to *vagrant*.
+- `port_info`
+  * Array of ports to open. See below.
 - `region`
   * The region to start the instance in. Defaults to *us-east-1*.
 - `secret_access_key`
@@ -93,6 +99,36 @@ The following attributes are available to configure the provider:
 - `user_data`
   * Plain text user data for the instance being booted.
 
+## Public Firewall Ports
+The plugin supports opening firewall ports via the `port_info`
+configuration parmater. Any number of port hashes can be specified in the
+array but they must contain only the following keys:
+
+- `from_port`
+  * Type: *Integer* The first port in the range. Valid Range: Minimum
+    value of 0. Maximum value of 65535.
+- `protocol`
+  * Type: *String* The protocol. Valid Values: `tcp | all | udp`
+- `to_port`
+  * Type: *Integer* The last port in the range. Valid Range: Minimum
+    value of 0. Maximum value of 65535.
+
+### Examples
+Open port `TCP:443`
+
+```
+provider.port_info = [{ from_port: 443, to_port: 443, protocol: 'tcp' }]
+```
+
+Open ports `TCP:3306` and `UDP:161`
+
+```
+provider.port_info = [
+    { from_port: 3306, to_port: 3306, protocol: 'tcp' },
+    { from_port: 161,  to_port: 161,  protocol: 'udp' },
+]
+```
+
 ## Contributing
 
 - Fork and clone repo
@@ -110,6 +146,7 @@ bundle exec rake test
 ```
 - Make code changes
 - Run tests again
+- Update *README.md* and *CHANGELOG.md*
 - Create a Pull Request!
 
 ## License

data/lib/vagrant-lightsail/action.rb

@@ -38,6 +38,7 @@ module VagrantPlugins
                 if env2[:result]
                   b2.use prepare_boot
                   b2.use StartInstance # restart this instance
+                  b2.use ConfigurePorts
                 else
                   b2.use MessageAlreadyCreated # TODO: write a better message
                 end
@@ -46,6 +47,7 @@ module VagrantPlugins
               b1.use SetupKey
               b1.use prepare_boot
               b1.use RunInstance # launch a new instance
+              b1.use ConfigurePorts
             end
           end
         end
@@ -146,6 +148,7 @@ module VagrantPlugins
 
       # The autload farm
       action_root = Pathname.new(File.expand_path('../action', __FILE__))
+      autoload :ConfigurePorts, action_root.join('configure_ports')
       autoload :ConnectLightsail, action_root.join('connect_lightsail')
       autoload :IsCreated, action_root.join('is_created')
       autoload :IsStopped, action_root.join('is_stopped')

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

@@ -0,0 +1,43 @@
+require 'log4r'
+
+module VagrantPlugins
+  module Lightsail
+    module Action
+      # This configures ports on instance
+      class ConfigurePorts
+        def initialize(app, _)
+          @app = app
+          @logger = Log4r::Logger.new('vagrant_lightsail::action::configure_ports')
+        end
+
+        def call(env)
+          port_info = env[:machine].provider_config.port_info
+
+          port_info.each do |pi|
+            begin
+              env[:lightsail_client].open_instance_public_ports(
+                port_info: pi,
+                instance_name: env[:machine].id
+              )
+
+              env[:ui].info I18n.t 'vagrant_lightsail.port_open',
+                                   proto: pi[:protocol],
+                                   port_no_from: pi[:from_port],
+                                   port_no_to: pi[:to_port]
+            rescue Aws::Lightsail::Errors::InvalidInputException => e
+              env[:ui].info I18n.t 'vagrant_lightsail.port_open_fail',
+                                   proto: pi[:protocol],
+                                   port_no_from: pi[:from_port],
+                                   port_no_to: pi[:to_port],
+                                   error: e.to_s
+            rescue Aws::Lightsail::Errors => e
+              raise Errors::LightailError, message: e
+            end
+          end
+
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

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

@@ -14,12 +14,10 @@ module VagrantPlugins
         end
 
         def call(env)
-          server = env[:lightsail_client].get_instance(instance_name: env[:machine].id).instance
-
           env[:ui].info I18n.t 'vagrant_lightsail.starting'
 
           begin
-            env[:lightsail_client].start_instance(instance_name: server.name).operations[0]
+            env[:lightsail_client].start_instance(instance_name: env[:machine].id).operations[0]
           rescue Aws::Lightsail::Errors => e
             raise Errors::LightailError, message: e
           end

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

@@ -11,13 +11,11 @@ module VagrantPlugins
         end
 
         def call(env)
-          server = env[:lightsail_client].get_instance(instance_name: env[:machine].id).instance
-
           if env[:machine].state.id == :stopped
             env[:ui].info I18n.t('vagrant_lightsail.already_status', status: env[:machine].state.id)
           else
             env[:ui].info(I18n.t('vagrant_lightsail.stopping'))
-            env[:lightsail_client].stop_instance(instance_name: server.name)
+            env[:lightsail_client].stop_instance(instance_name: env[:machine].id)
           end
 
           @app.call(env)

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

@@ -10,13 +10,11 @@ module VagrantPlugins
           @logger = Log4r::Logger.new('vagrant_lightsail::action::terminate_instance')
         end
 
+        # Destroy the server and remove the tracking ID
         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)
+            env[:lightsail_client].delete_instance(instance_name: env[:machine].id)
           rescue Aws::Lightsail::Errors => e
             raise Errors::LightailError, message: e
           end

data/lib/vagrant-lightsail/config.rb

@@ -11,6 +11,7 @@ module VagrantPlugins
       attr_accessor :bundle_id
       attr_accessor :endpoint
       attr_accessor :keypair_name
+      attr_accessor :port_info
       attr_accessor :region
       attr_accessor :secret_access_key
       attr_accessor :session_token
@@ -25,6 +26,7 @@ module VagrantPlugins
         @bundle_id         = UNSET_VALUE
         @endpoint          = UNSET_VALUE
         @keypair_name      = UNSET_VALUE
+        @port_info         = [UNSET_VALUE]
         @region            = UNSET_VALUE
         @secret_access_key = UNSET_VALUE
         @session_token     = UNSET_VALUE
@@ -47,6 +49,7 @@ module VagrantPlugins
         @bundle_id         = 'nano_1_0'     if @bundle_id         == UNSET_VALUE
         @endpoint          = nil            if @endpoint          == UNSET_VALUE
         @keypair_name      = 'vagrant'      if @keypair_name      == UNSET_VALUE
+        @port_info         = []             if @port_info         == [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
@@ -61,6 +64,8 @@ module VagrantPlugins
                            profile: @aws_profile, location: @aws_dir)
         end
 
+        errors << I18n.t('vagrant_lightsail.config.port_info_array') unless @port_info.is_a? Array
+
         errors << I18n.t('vagrant_lightsail.config.region_required') if @region.nil?
 
         { 'Lightsail Provider' => errors }

data/lib/vagrant-lightsail/version.rb

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

data/locales/en.yml

@@ -6,6 +6,8 @@ en:
         One or more of the needed AWS credentials are missing. No
         environment variables are set nor profile '%{profile}' exists
         at '%{location}'
+      port_info_array: |-
+        Port info must be an array. See plugin documentation.
       region_required: |-
         A region must be specified via "region"
 
@@ -33,6 +35,10 @@ en:
       This can sometimes result in not being able to access your instance.
     not_created: |-
       Instance is not created. Please run `vagrant up` first.
+    port_open: |-
+      Opened ports %{proto}:%{port_no_from} - %{proto}:%{port_no_to}
+    port_open_fail: |-
+      Unable to open ports %{proto}:%{port_no_from} - %{proto}:%{port_no_to}: %{error}
     ready: |-
       Machine is booted and ready for use!
     starting: |-
@@ -48,3 +54,40 @@ en:
     will_not_destroy: |-
       The instance '%{name}' will not be destroyed, since the
       confirmation was declined.
+
+  states:
+    short_not_created: |-
+      not created
+    long_not_created: |-
+      The Lightsail instance is not created. Run `vagrant up` to
+      create it.
+
+    short_stopped: |-
+      stopped
+    long_stopped: |-
+      The Lightsail instance is stopped. Run `vagrant up` to start it.
+
+    short_stopping: |-
+      stopping
+    long_stopping: |-
+      The Lightsail instance is stopping. Wait until is completely
+      stopped to run `vagrant up` and start it.
+
+    short_pending: |-
+      pending
+    long_pending: |-
+      The Lightsail instance is pending a start (i.e. this is a
+      transition state).
+
+    short_running: |-
+      running
+    long_running: |-
+      The Lightsail instance is running. To stop this machine, you can
+      run `vagrant halt`. To destroy the machine, you can run `vagrant
+      destroy`.
+
+    short_pending: |-
+      pending
+    long_pending: |-
+      The Lightsail instance is still being initialized. To destroy
+      this machine, you can run `vagrant destroy`.

data/test/Vagrantfile

@@ -9,7 +9,19 @@ Vagrant.configure('2') do |config|
     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'
+    provider.port_info    = [
+      { from_port: 22,
+        to_port: 22,
+        protocol: 'tcp' },
+      { from_port: 80,
+        to_port: 80,
+        protocol: 'udp' },
+      { from_port: 443,
+        to_port: 443,
+        protocol: 'tcp' }
+    ]
   end
 
   config.vm.provision :shell, path: 'scripts/provision.sh'

data/test/test.sh

@@ -25,7 +25,6 @@ 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-lightsail
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Alejandro Figueroa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-18 00:00:00.000000000 Z
+date: 2017-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk
@@ -92,6 +92,7 @@ files:
 - ".rubocop.yml"
 - ".ruby-version"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -100,6 +101,7 @@ files:
 - box/metadata.json
 - lib/vagrant-lightsail.rb
 - lib/vagrant-lightsail/action.rb
+- lib/vagrant-lightsail/action/configure_ports.rb
 - lib/vagrant-lightsail/action/connect_lightsail.rb
 - lib/vagrant-lightsail/action/is_created.rb
 - lib/vagrant-lightsail/action/is_stopped.rb