vagrant-envbash 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2e8ab55723262f531ef6679be94de55ad9a714eb
+  data.tar.gz: 6a4c2a45c3cd3afff207174183ac28e820500246
+SHA512:
+  metadata.gz: 94fdba0131b7376d06f83b8a3fc72d92135028b43012c7479277bc8d0d628e084faf799dd56c717ebdd3e51043756630fe100bf52f87886cff1208e159f68a38
+  data.tar.gz: 9c589a1202f519b40307f7b0886dd33dff175e70a4b5f5caed5ed5cf95249c5d8f274622c524120a8f4ea35aed8bea2c73fe89e81af35c6d84eb187b80aef1c7

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,15 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  # We depend on Vagrant for development, but we don't add it as a
+  # gem dependency because we expect to be installed within the
+  # Vagrant environment itself using `vagrant plugin`.
+  gem "vagrant", git: "https://github.com/mitchellh/vagrant.git"
+end
+
+group :plugins do
+  gem "vagrant-envbash", path: "."
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2016 Aron Griffis
+
+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,152 @@
+# Vagrant envbash plugin
+
+This is a [Vagrant](http://www.vagrantup.com) plugin to load environment
+variables from `env.bash`. Putting settings in `env.bash` provides a single
+source of development configuration for Vagrant (e.g. AWS secrets that shouldn't
+be committed to source control) and the application under development. This is
+especially important for web apps that adhere to the
+[twelve-factor methodology](http://12factor.net/).
+
+This plugin was inspired by [vagrant-env](https://github.com/gosuri/vagrant-env)
+with the primary difference that `env.bash` is a proper Bash script that will be
+executed by `/bin/bash`, so it can contain conditionals, multi-line strings,
+etc. This also makes it easier to source into the shell in the Vagrant guest as
+application configuration.
+
+This plugin also adds a command `vagrant env` to inspect how `env.bash` modifies
+the environment.
+
+## Installation
+
+Install using Vagrant's plugin system:
+
+```
+vagrant plugin install vagrant-envbash
+```
+
+## Usage
+
+With the plugin installed, Vagrant will look for `env.bash` in the same
+directory as `Vagrantfile`. If found, Vagrant will execute the file as a Bash
+script. Any environment variables that are exported in the file will be updated
+in `ENV`. Additionally any variables that are unset will be removed from `ENV`.
+
+The plugin runs very early in the Vagrant execution, so `ENV` is fully updated
+before executing configuration in `Vagrantfile`. This means that `env.bash` is
+the ideal place to put development configuration such as AWS secrets for
+[vagrant-aws](https://github.com/mitchellh/vagrant-aws) that shouldn't be
+committed to source control in Vagrantfile.
+
+## Examples
+
+### Example of AWS secrets in `env.bash`
+
+With this `Vagrantfile`:
+
+```
+Vagrant.configure("2") do |config|
+  config.vm.provider :aws do |aws, override|
+    override.vm.box = "dummy"
+    aws.access_key_id = ENV['AWS_ACCESS_KEY_ID']
+    aws.secret_access_key = ENV['AWS_SECRET_ACCESS_KEY']
+    aws.keypair_name = ENV['AWS_KEYPAIR_NAME']
+    aws.ami = ENV.fetch('AWS_AMI', "ami-7747d01e")
+  end
+end
+```
+
+then the secrets can be put into `env.bash`:
+
+```
+export AWS_ACCESS_KEY_ID=xxxxxxxxxxxx
+export AWS_SECRET_ACCESS_KEY=yyyyyyyyyyyyyyyyyy
+export AWS_KEYPAIR_NAME=email@example.com
+```
+
+Additionally if the `Vagrantfile` has multiple provider configuration stanzas to
+enable a large developer organization, then the developer can choose their
+preferred provider on a per-project basis by setting `VAGRANT_DEFAULT_PROVIDER`
+in `env.bash`:
+
+```
+export VAGRANT_DEFAULT_PROVIDER=aws
+```
+
+### Trivial example of `vagrant env`
+
+With this initial environment configuration:
+
+```
+$ export W=unmodified
+$ export X=unmodified
+$ # Y is not set
+$ export Z=unmodified
+```
+
+And this `env.bash`:
+
+```
+export W=unmodified
+export X=modified
+export Y=added
+unset Z  # remove from ENV
+```
+
+Then we can run `vagrant env` to see what happens:
+
+```
+$ vagrant env
+CHANGED the following variables:
+    X="modified" (was: "unmodified")
+ADDED the following variables:
+    Y="added"
+REMOVED the following variables:
+    Z="unmodified"
+```
+
+## FAQ
+
+### Is it necessary to explicitly `export` variables in `env.bash`?
+
+Yes. If you have a lot of settings and want to avoid repeating `export`, you can
+put `set -a` at the top of your `env.bash` to automatically export all
+variables. In that case, you should also `set +a` at the bottom to avoid
+confusion if you source `env.bash` into your guest shell configuration.
+
+### How do I put a multi-line string into `env.bash`?
+
+You can put newlines directly into a multi-line string in Bash, so for example
+this works:
+
+```
+export PRIVATE_KEY="
+-----BEGIN RSA PRIVATE KEY-----
+xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
+xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
+xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
+xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
+xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
+xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
+xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
+xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
+xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
+-----END RSA PRIVATE KEY-----"
+```
+
+### Can I remove settings from the environment?
+
+Yes, anything you `unset` will be removed from `ENV`. See the example of
+`vagrant env` above.
+
+### How do I source `env.bash` into my guest shell environment?
+
+Assuming that your source directory is available on the default `/vagrant` mount
+point in the guest, you can simply add a line at the bottom of
+`/home/vagrant/.bash_profile`:
+
+```
+source /vagrant/env.bash
+```
+
+Note that this means that settings are loaded on `vagrant ssh` so you need to
+exit the shell and rerun `vagrant ssh` to refresh if you change settings.

data/Rakefile

@@ -0,0 +1,4 @@
+require "rubygems"
+require "bundler/setup"
+Bundler::GemHelper.install_tasks
+

data/lib/vagrant-envbash.rb

@@ -0,0 +1,10 @@
+require "pathname"
+
+require "vagrant-envbash/plugin"
+
+module VagrantPlugins
+  module EnvBash
+    lib_path = Pathname.new(File.expand_path("../vagrant-envbash", __FILE__))
+    autoload :Action, lib_path.join("action")
+  end
+end

data/lib/vagrant-envbash/action.rb

@@ -0,0 +1,81 @@
+module VagrantPlugins
+  module EnvBash
+    module Action
+      class LoadEnvBash
+        def initialize(app, env)
+          # This method is defined to avoid a stack trace if it doesn't exist.
+          # We have no real need to save @app
+          @app = app
+        end
+
+        def call(env)
+          # Note that this loads early enough that there's no env[:ui] yet for
+          # outputting informational messages. Use the "vagrant env" command
+          # instead to investigate.
+
+          # The passed `env` is a wrapper around the env we want.
+          e = env[:env]
+
+          # This plugin will can be called multiple times, especially when
+          # operating on ids, for example "vagrant status 0fb925d". Don't try to
+          # load env.bash until we have a root path, and don't load twice.
+          return unless e.root_path
+          begin
+            return if e.envbash_ran
+          rescue
+            class << e
+              attr_accessor :envbash_ran, :envbash_file, :envbash_loaded,
+                            :envbash_before, :envbash_after
+            end
+
+            # Avoid running twice.
+            e.envbash_ran = true
+
+            # We haven't loaded yet.
+            e.envbash_file = nil
+            e.envbash_loaded = false
+
+            # Save the original ENV for comparison in "vagrant env"
+            e.envbash_before = ENV.to_h
+          end
+
+          # Try to find env.bash, since it will be adjacent to Vagrantfile.
+          keep_vagrant_envbash_file = !! ENV['VAGRANT_ENVBASH_FILE']
+          if ! keep_vagrant_envbash_file
+            ENV['VAGRANT_ENVBASH_FILE'] = (e.root_path + 'env.bash').to_s
+          end
+          e.envbash_file = ENV['VAGRANT_ENVBASH_FILE']
+
+          # Load env.bash. This runs bash inside %x because Ruby uses /bin/sh
+          # for backticks.
+          new_env = eval %x{bash -c '
+            if [[ -s $VAGRANT_ENVBASH_FILE ]]; then
+              source "$VAGRANT_ENVBASH_FILE"
+            fi
+            ruby -e "p ENV"
+          '}
+
+          # Ignore modification to SHLVL which is just a shell artifact.
+          if e.envbash_before['SHLVL']
+            new_env['SHLVL'] = e.envbash_before['SHLVL']
+          else
+            new_env.delete('SHLVL')
+          end
+
+          # Replace the entire ENV (rather than update) so that env.bash can
+          # both set and unset vars.
+          ENV.replace(new_env)
+
+          # We are loaded!
+          e.envbash_loaded = ENV['VAGRANT_ENVBASH_FILE']
+
+          # Remove VAGRANT_ENVBASH_FILE from ENV if we set it.
+          ENV.delete('VAGRANT_ENVBASH_FILE') unless keep_vagrant_envbash_file
+
+          # Save the new ENV for comparison in "vagrant env"
+          e.envbash_after = ENV.to_h
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-envbash/command.rb

@@ -0,0 +1,49 @@
+class EnvCommand < Vagrant.plugin(2, :command)
+  def execute
+    begin
+      @env.envbash_ran
+    rescue
+      @env.ui.error "vagrant-envbash plugin did not load! Do you have a Vagrantfile?"
+      return 2
+    end
+
+    if ! @env.envbash_loaded
+      @env.ui.warn "vagrant-envbash couldn't load #{@env.envbash_file.inspect}"
+      return 1
+    end
+
+    #@env.ui.info "vagrant-envbash loaded #{@env.envbash_loaded.inspect}"
+
+    before, after = @env.envbash_before, @env.envbash_after
+    added = after.to_a.select {|k, v| ! before.has_key? k}
+    removed = before.to_a.select {|k, v| ! after.has_key? k}
+    changed = after.to_a.select {|k, v| before.has_key? k and before[k] != v}
+
+    if ! changed.empty?
+      @env.ui.info "CHANGED the following variables:"
+      changed.each do |k, v|
+        @env.ui.info "    #{k}=#{v.inspect} (was: #{before[k].inspect})"
+      end
+    end
+
+    if ! added.empty?
+      @env.ui.info "ADDED the following variables:"
+      added.each do |k, v|
+        @env.ui.info "    #{k}=#{v.inspect}"
+      end
+    end
+
+    if ! removed.empty?
+      @env.ui.info "REMOVED the following variables:"
+      removed.each do |k, v|
+        @env.ui.info "    #{k}=#{v.inspect}"
+      end
+    end
+
+    if added.empty? && removed.empty? && changed.empty?
+      @env.ui.info "NOTHING added, removed or changed."
+    end
+
+    0
+  end
+end

data/lib/vagrant-envbash/plugin.rb

@@ -0,0 +1,30 @@
+begin
+  require "vagrant"
+rescue LoadError
+  raise "The Vagrant EnvBash plugin must be run within Vagrant."
+end
+
+module VagrantPlugins
+  module EnvBash
+    class Plugin < Vagrant.plugin("2")
+      name "EnvBash"
+      description <<-DESC
+      This plugin loads environment from env.bash.
+      DESC
+
+      # Hook as early as possible to load env.bash.
+      # This is the earliest hook that's publicly documented (and might be the
+      # earliest hook anyway).
+      action_hook(:load_env_bash, :environment_plugins_loaded) do |hook|
+        hook.prepend(VagrantPlugins::EnvBash::Action::LoadEnvBash)
+      end
+
+      # Register the "vagrant env" command which can list the full or partial
+      # environment.
+      command "env" do
+        require_relative "command"
+        EnvCommand
+      end
+    end
+  end
+end

data/lib/vagrant-envbash/version.rb

@@ -0,0 +1,5 @@
+module VagrantPlugins
+  module EnvBash
+    VERSION = "0.0.1"
+  end
+end

data/vagrant-envbash.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'vagrant-envbash/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "vagrant-envbash"
+  spec.version       = VagrantPlugins::EnvBash::VERSION
+  spec.authors       = ["Aron Griffis"]
+  spec.email         = ["aron@arongriffis.com"]
+  spec.summary       = %q{Vagrant plugin to load environment variables from env.bash}
+  spec.description   = %q{Vagrant plugin to load environment variables from env.bash}
+  spec.homepage      = "https://github.com/agriffis/vagrant-envbash"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  # It seems like this shouldn't be required, but I need this in order for
+  # "bundle exec vagrant" to run, even when cloning the upstream vagrant-aws
+  # plugin. https://botbot.me/freenode/vagrant/2016-05-15/?msg=66099642&page=3
+  spec.add_development_dependency "json"
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: vagrant-envbash
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Aron Griffis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Vagrant plugin to load environment variables from env.bash
+email:
+- aron@arongriffis.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- Vagrantfile
+- lib/vagrant-envbash.rb
+- lib/vagrant-envbash/action.rb
+- lib/vagrant-envbash/command.rb
+- lib/vagrant-envbash/plugin.rb
+- lib/vagrant-envbash/version.rb
+- vagrant-envbash.gemspec
+homepage: https://github.com/agriffis/vagrant-envbash
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Vagrant plugin to load environment variables from env.bash
+test_files: []