vagrant-soa 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f9bad216eb549f706c4703ddce8629bf2bd37630
+  data.tar.gz: cde6e442ca52860d4b2ca09db2f50a62d25517dc
+SHA512:
+  metadata.gz: f849a15385437ad9e59b00f21dbf9fce34413eb04b38f29567696e048b3a07e18c81757bfba4fe5e5acb9061b865802c107f32d9b70f96a4cac2c5078392afde
+  data.tar.gz: 3766e2e26edb30b200257f00941cff9f72d7e19a64161a546db69d0bc37733a08f6e9153f0928377a4ffad767c2552379f6fc874483bea1ca9cf145c46688061

data/.gitignore

@@ -0,0 +1,22 @@
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+pkg
+
+# ignore vagrant directory
+.vagrant
+
+# ignore dev files
+.SERVICES

data/Gemfile

@@ -0,0 +1,14 @@
+source "https://rubygems.org"
+
+gemspec
+
+group :development do
+  gem "vagrant", github: "mitchellh/vagrant"
+  gem "debugger"
+end
+
+group :plugins do
+  gem 'vagrant-puppet-fact-generator', :git => 'git@github.com:eventbrite/vagrant-puppet-fact-generator.git'
+  gem 'vagrant-puppet-module-registry', :git => 'git@github.com:eventbrite/vagrant-puppet-module-registry.git'
+  gem 'vagrant-soa', path: '.'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Michael Hahn
+
+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,54 @@
+# vagrant-soa
+
+A [Vagrant](http://www.vagrantup.com/) plugin to handle our SOA infrastructre within vagrant.
+
+## Installation
+
+``` bash
+vagrant plugin install vagrant-soa
+```
+
+## Usage
+
+This plugin allows you to specify one or more services to run within the VM. By
+"services", we mean github repos that define puppet modules which can then be
+included in the main manifest.
+
+This structure allows developers of services to easily distribute services to
+the rest of the team. Any changes to the service will be synced when users
+provision.
+
+Services are defined within the ``Vagrantfile``::
+
+    config.soa.services = {
+      'example_service' => {
+        'puppet_path' => 'services/example_service/puppet',
+        'github_url' => 'git@github.com:eventbrite/vagrant-soa.git',
+        'home_dir' => 'services/example_service',
+        'branch' => 'test_branch',
+      },
+    }
+
+The attributes of the service are optional, with the following defaults:
+
+* puppet_path: The location of the puppet module from the root of the service
+  repository. If this isn't specified, we'll default to "puppet"
+* github_url: The github url for the service. If this isn't provided, we'll
+  fallback to: #{config.soa.github_base}/#{service}.git
+* branch: The specific branch we want to checkout. Defaults to "master".
+* home_dir: The home directory of the service. This is useful if the service
+  isn't contained within its own repo.
+
+## Development
+
+``` bash
+$ bundle
+$ bundle exec vagrant up
+```
+
+## Contributing
+
+1. Create your feature branch (`git checkout -b my-new-feature`)
+2. Commit your changes (`git commit -am 'Add some feature'`)
+3. Push to the branch (`git push origin my-new-feature`)
+4. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/Vagrantfile

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+Vagrant.configure('2') do |config|
+  config.vm.box = 'precise64'
+  config.vm.box_url = 'http://files.vagrantup.com/precise64.box'
+
+  config.soa.services = {
+    'example_service' => {
+      'puppet_path' => 'services/example_service/puppet',
+      'github_url' => 'git@github.com:eventbrite/vagrant-soa.git'
+    },
+  }
+
+  config.vm.provision 'puppet' do |puppet|
+    puppet.manifests_path = 'manifests'
+    puppet.manifest_file = 'init.pp'
+    puppet.module_path = config.puppet_module_registry.get_puppet_module_paths()
+  end
+
+end

data/lib/vagrant-soa/actions/install_services.rb

@@ -0,0 +1,196 @@
+require_relative '../errors'
+
+module VagrantPlugins
+  module Soa
+    class Action
+      class InstallServices
+
+        def initialize(app, env)
+          @app = app
+          @env = env
+          @soa = env[:machine].config.soa
+          @puppet_fact_generator = env[:machine].config.puppet_fact_generator
+          @puppet_module_registry = env[:machine].config.puppet_module_registry
+          @git = get_local_git()
+          # we use the local_data_path of the machine since vagrant ensures it
+          # exists as well as mounts it to the VM for us.
+          @install_dir = env[:machine].env.local_data_path.join('services')
+          # this "/vagrant" dir is hard coded in vagrant as well:
+          # https://github.com/mitchellh/vagrant/blob/master/plugins/kernel_v2/config/vm.rb#L385-L389
+          @vagrant_install_dir = '/vagrant/.vagrant/services'
+        end
+
+        # Get the proper git to clone the service repos.
+        def get_local_git
+          git = `which git`.chomp
+          if git == ""
+            raise Soa::Errors::GitRequired.new
+          else
+            return git
+          end
+        end
+
+        def update_repo(service, target_branch, pwd, chdir_on_success=true)
+          # make sure the branch is up to date
+          updated = system "#{@git} pull --rebase"
+          if not updated
+            # pop back to the original directory
+            Dir.chdir pwd
+            raise Soa::Errors::UpdatingRepoFailed,
+              target_branch: target_branch,
+              service: service
+          else
+            # pop back to the original directory
+            if chdir_on_success
+              Dir.chdir pwd
+            end
+            @env[:ui].success(
+              "Successfully updated branch: #{target_branch} for #{service}"
+            )
+          end
+        end
+
+        # When installing a service we have to clone the service repository.
+        # Ideally, we would manage these modules with librarian-puppet and the
+        # Puppetfile, but because services depend on files that aren't
+        # contained within their puppet module (ie. requirements.txt or uwsgi
+        # handlers etc.), cloning the repo is the next best solution.
+        def clone_service_repo(service, config)
+          target_directory = File.join @install_dir, service
+
+          # make sure the repo is checked out
+          if File.directory? target_directory
+            @env[:ui].info "Service: #{service} is already checked out"
+          else
+            if not config['github_url'] || @soa.github_base
+              raise Soa::Errors::NoGithubUrlProvided,
+                service: service
+            end
+
+            github_target = config['github_url'] ? config['github_url'] : "#{@soa.github_base}/#{service}.git"
+            @env[:ui].info(
+              "Cloning service: #{service} (#{github_target}) to target directory:"\
+              " #{target_directory}"
+            )
+            success = system "#{@git} clone --recurse-submodules #{github_target} #{target_directory}"
+            if not success
+              raise Soa::Errors::CloningServiceFailed,
+                service: service
+            else
+              @env[:ui].success "Successfully checked out service: #{service}"
+            end
+          end
+
+          # move to the target_directory so we can examine it with git
+          pwd = Dir.pwd
+          Dir.chdir(target_directory)
+          update_repo = true
+
+          # don't attempt to auto-update if we've found any changes in the repo we
+          # already have checked out (stolen from boxen)
+          clean = `#{@git} status --porcelain`.empty?
+          current_branch = `#{@git} rev-parse --abbrev-ref HEAD`.chomp
+          fast_forwardable = `#{@git} rev-list --count origin/master..master`.chomp == '0'
+          if current_branch.empty?
+            ref = `#{@git} log -1 --pretty=format:%h`
+            @env[:ui].warn "#{service} not currently on any branch (ref: #{ref}), won't auto-update!"
+            update_repo = false
+          elsif !fast_forwardable
+            @env[:ui].warn "#{service}'s master branch is out of sync, won't auto-update!"
+            update_repo = false
+          elsif !clean
+            @env[:ui].warn "#{service} has a dirty tree, won't auto-update!"
+            update_repo = false
+          end
+
+          # make sure we're on the correct branch
+          target_branch = config.fetch('branch', 'master')
+          if !update_repo
+            # pop back to the original directory
+            Dir.chdir(pwd)
+            return target_directory
+          elsif target_branch != current_branch
+            # we have to pull first to ensure that we have all available branches
+            update_repo(service, current_branch, pwd, false)
+            checkout_target = system("#{@git} checkout #{target_branch}")
+            if not checkout_target
+              # pop back to the original directory
+              Dir.chdir(pwd)
+              raise Soa::Errors::BranchCheckoutFailed,
+                target_branch: target_branch,
+                service: service
+            else
+              @env[:ui].success(
+                "Successfully checked out branch: #{target_branch}"\
+                " for service #{service}"
+              )
+            end
+          end
+
+          if clean
+            update_repo(service, target_branch, pwd)
+          end
+          return target_directory
+        end
+
+        # When services are installed they can specify a 'home_dir' in their
+        # vagrant config. This needs to be a path that exists within the VM and
+        # points to their desired home directory.
+        #
+        #   These custom facts will be of the form: "#{service}_home_dir"
+        def register_service_home_fact(service, config)
+          home_dir = config.fetch('home_dir', nil)
+          # not sure if there is a better way to do this in ruby, we don't want a
+          # trailing slash if "home_dir" is empty
+          if home_dir
+            full_path = File.join(
+              @vagrant_install_dir,
+              service,
+              home_dir
+            )
+          else
+            full_path = File.join(
+              @vagrant_install_dir,
+              service
+            )
+          end
+          if File.directory?(full_path)
+            @env[:ui].warn "Invalid home_dir passed for service:"\
+              " #{service}, home_dir: #{full_path}"
+          else
+            @puppet_fact_generator.add_fact("#{service}_home_dir", full_path)
+          end
+        end
+
+        # To install a service we clone the service repo and add the puppet
+        # path to @puppet_module_registry.puppet_module_paths.
+        def install_service(service, config)
+          target_directory = clone_service_repo(service, config)
+          puppet_path = config.fetch('puppet_path', 'puppet')
+          full_path = File.join(target_directory, puppet_path)
+          register_service_home_fact(service, config)
+          @puppet_module_registry.register_module_path(service, full_path)
+        end
+
+        # If any services are specified, install them
+        def install_services()
+          if @soa.services
+            @soa.services.each_pair do |service, config|
+              install_service(service, config)
+            end
+          end
+        end
+
+        def call(env)
+          # determine if provision is enabled, if we provided the
+          # "--no-provision" flag this would be false. if it isn't present, we
+          # should consider provision enabled
+          provision_enabled = env.has_key?(:provision_enabled) ? env[:provision_enabled] : true
+          install_services() if provision_enabled
+          @app.call(env)
+        end
+
+      end
+    end
+  end
+end

data/lib/vagrant-soa/config.rb

@@ -0,0 +1,36 @@
+module VagrantPlugins
+  module Soa
+    class Config < Vagrant.plugin(2, :config)
+      attr_accessor :services
+      attr_accessor :github_base
+
+      def initialize
+        @services = UNSET_VALUE
+        @github_base = UNSET_VALUE
+      end
+
+      def finalize!
+        @services = nil if @services == UNSET_VALUE
+        @github_base = nil if @github_base == UNSET_VALUE
+      end
+
+      def validate(machine)
+        errors = []
+
+        if @services
+          if not @services.kind_of?(Hash)
+            errors << '`services` must be a hash of form service => {service config hash}'
+          end
+          @services.each_pair do |service, config|
+            if not config.kind_of?(Hash)
+              errors << "Invalid configuration for #{service}, config must be a hash, not #{config}"
+            end
+          end
+        end
+
+        return { 'soa' => errors }
+      end
+
+    end
+  end
+end

data/lib/vagrant-soa/errors.rb

@@ -0,0 +1,27 @@
+module VagrantPlugins
+  module Soa
+    module Errors
+
+      class GitRequired < Vagrant::Errors::VagrantError
+        error_key('git_required')
+      end
+
+      class UpdatingRepoFailed < Vagrant::Errors::VagrantError
+        error_key('git_update_failed')
+      end
+
+      class CloningServiceFailed < Vagrant::Errors::VagrantError
+        error_key('git_clone_failed')
+      end
+
+      class BranchCheckoutFailed < Vagrant::Errors::VagrantError
+        error_key('git_checkout_failed')
+      end
+
+      class NoGithubUrlProvided < Vagrant::Errors::VagrantError
+        error_key('missing_github_url')
+      end
+
+    end
+  end
+end

data/lib/vagrant-soa/plugin.rb

@@ -0,0 +1,39 @@
+begin
+  require 'vagrant'
+rescue LoadError
+  abort 'vagrant-soa must be loaded in a Vagrant environment.'
+end
+
+begin
+  require 'vagrant-puppet-module-registry'
+rescue LoadError
+  abort 'vagrant-soa depends on the `vagrant-puppet-module-registry` plugin.'
+end
+
+# Add our custom translations to the load path
+I18n.load_path << File.expand_path("../../../locales/en.yml", __FILE__)
+
+module VagrantPlugins
+  module Soa
+    class Plugin < Vagrant.plugin('2')
+      name 'vagrant-soa'
+      description <<-DESC
+A Vagrant plugin to manage vagrant SOA infrastructure.
+DESC
+
+      # define configs
+      config 'soa' do
+        require_relative 'config'
+        Config
+      end
+
+      # define hooks
+      action_hook 'install_services' do |hook|
+        require_relative 'actions/install_services'
+        # we need to install services before we AddModuleFacts
+        hook.before VagrantPlugins::PuppetModuleRegistry::Action::AddModuleFacts, Action::InstallServices
+      end
+
+    end
+  end
+end

data/lib/vagrant-soa/version.rb

@@ -0,0 +1,5 @@
+module VagrantPlugins
+  module Soa
+    VERSION = "0.3.0"
+  end
+end

data/lib/vagrant-soa.rb

@@ -0,0 +1,2 @@
+require "vagrant-soa/version"
+require "vagrant-soa/plugin"

data/locales/en.yml

@@ -0,0 +1,15 @@
+en:
+    vagrant:
+        errors:
+            git_required: |-
+                Please install `git` before continuing.
+            git_update_failed: |-
+                Error updating branch: '%{target_branch}' for '%{service}'.
+            git_clone_faield: |-
+                Error cloning service: '%{service}'.
+            git_checkout_failed: |-
+                Error checking out branch: '%{target_branch}' for '%{service}'.
+            missing_github_url: |-
+                No `github_url` specified for service: '%{service}'. Either
+                specify the `github_url` or set `cofing.soa.github_base` to
+                the organization's github.

data/manifests/init.pp

@@ -0,0 +1,6 @@
+class dev {
+  notify { 'Development provision!':}
+  include example_service
+}
+
+include dev

data/services/example_service/puppet/example_service/manifests/init.pp

@@ -0,0 +1,3 @@
+class example_service {
+  notify { 'including example service': }
+}

data/vagrant-soa.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'vagrant-soa/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "vagrant-soa"
+  spec.version       = VagrantPlugins::Soa::VERSION
+  spec.authors       = ["Michael Hahn"]
+  spec.email         = ["mhahn@eventbrite.com"]
+  spec.description   = %q{Vagrant plugin to manage vagrant SOA infrastructure.}
+  spec.summary       = spec.description
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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.3"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: vagrant-soa
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Michael Hahn
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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 manage vagrant SOA infrastructure.
+email:
+- mhahn@eventbrite.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- Vagrantfile
+- lib/vagrant-soa.rb
+- lib/vagrant-soa/actions/install_services.rb
+- lib/vagrant-soa/config.rb
+- lib/vagrant-soa/errors.rb
+- lib/vagrant-soa/plugin.rb
+- lib/vagrant-soa/version.rb
+- locales/en.yml
+- manifests/init.pp
+- pkg/vagrant-soa-0.1.0.gem
+- pkg/vagrant-soa-0.2.0.gem
+- pkg/vagrant-soa-0.2.1.gem
+- pkg/vagrant-soa-0.3.0.gem
+- services/example_service/puppet/example_service/manifests/init.pp
+- vagrant-soa.gemspec
+homepage: ''
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Vagrant plugin to manage vagrant SOA infrastructure.
+test_files: []
+has_rdoc: