vagrant-ebcommon 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3a85966114c79554c3b98a5eb1e06683d1532ee3
+  data.tar.gz: d4a1872890065308cf65607e2ccffb01ded1bc75
+SHA512:
+  metadata.gz: 95fa38ffa061cd37301cb2d7c4232ec6897a6879bd7271c37fcd65c6845359052642bcc4ffef2fcb2df004a6d0b9eab71873fdf13a8ec97e0362b445893a2b98
+  data.tar.gz: 4c4cf51b1b63482a38278897ec93231b01551cc315a68357b3461c331dfbfc9b67ab643e71dac0820bc373d2cc22afd3bd4a4388f554754f0b31b32831bc59ac

data/.gitignore

@@ -0,0 +1,20 @@
+*.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 files
+.vagrant
+.VAGRANT_GIT_COMMITER_DETAILS

data/Gemfile

@@ -0,0 +1,13 @@
+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-ebcommon', 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,38 @@
+# vagrant-ebcommon
+
+A [Vagrant](http://www.vagrantup.com/) plugin to handle various Eventbrite workflows.
+
+Using this plugin we can:
+
+    - take actions before we bring up the virtualenv
+    - take actions before we provision the virtualenv
+    - add custom commands like "start-selenium" to distribute commands to our
+      dev team that run on the host machine
+
+## Installation
+
+``` bash
+vagrant plugin install vagrant-ebcommon
+```
+
+## Usage
+
+This plugin exposes the following additional vagrant commands:
+
+* clear-requirements-cache: will remove the pip_requirements_cache file within the VM
+* start-selenium: will ensure selenium is started on the host machine
+* stop-selenium: will stop selenium on the host machine
+
+## Development
+
+``` bash
+$ bundle
+$ bundle exec vagrant <any vagrant option or command defined by the plugin>
+```
+
+## 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,19 @@
+#!/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.ebcommon.vpn_urls = [
+    "https://docs.evbhome.com",
+    "https://reviews.evbhome.com",
+  ]
+
+  config.vm.provision 'puppet' do |puppet|
+    puppet.manifests_path = 'manifests'
+    puppet.manifest_file = 'init.pp'
+  end
+
+end

data/lib/vagrant-ebcommon/actions/setup_provision.rb

@@ -0,0 +1,165 @@
+require 'timeout'
+require 'socket'
+require_relative '../errors'
+
+module VagrantPlugins
+  module Ebcommon
+    class Action
+      class SetupProvision
+        def initialize(app, env)
+          @app = app
+          @env = env
+          @ebcommon = env[:machine].config.ebcommon
+          @puppet_fact_generator = @env[:machine].config.puppet_fact_generator
+
+          provisioner = @env[:machine].config.vm.provisioners[0]
+          @puppet_config = provisioner ? provisioner.config: nil
+          @vagrant_git_commiter_details = @env[:machine].env.local_data_path.join(
+            'git_commit_details'
+          )
+        end
+
+        # Some of our requirements contain references to private eventbrite
+        # github repos. We'll fail to clone these unless we've added our
+        # ssh-keys so their available to vagrant.
+        def setup_ssh_keys
+          @env[:ui].info 'Ensuring ssh-keys have been added via `ssh-add`...'
+          current_keys = `ssh-add -l`
+          if current_keys.include? 'no identities'
+            success = system('ssh-add')
+            if success
+              @env[:ui].success '...ssh-keys successfully added'
+            else
+              @env[:ui].warn 'failed to call `ssh-add`, some requirements may fail to install'
+            end
+          else
+            @env[:ui].info '...ssh-keys detected, skipping `ssh-add`'
+          end
+        end
+
+        # In order to provision vagrant, we require you to be in the office or
+        # connected to VPN. There are several packages that are hosted
+        # internally and everything will fail miserably if you're not on our
+        # network.
+        def ensure_vpn
+          if not ENV['FORCE_PROVISION'] and @ebcommon.vpn_urls
+            vpn_valid = false
+            @ebcommon.vpn_urls.each { |url|
+              vpn_valid = ping url
+              break if vpn_valid
+            }
+            if not vpn_valid
+              raise Ebcommon::Errors::VPNRequired.new
+            end
+            @env[:ui].success 'VPN connection verified, continuing provision.'
+          end
+        end
+
+        # We store the git commiter details in a file within the vagrant
+        # directory. We do this so we're not always prompting a user for their
+        # full name and email.  If they don't provide them the first time
+        # around, we'll opt them out and never ask them again.
+        #
+        # :Returns:
+        #   - dict of github creds
+        def fetch_git_commiter_details_from_file
+          creds = {}
+          contents = ""
+          if File.exists?(@vagrant_git_commiter_details)
+            File.open(@vagrant_git_commiter_details, 'r') do |f|
+              while line = f.gets
+                contents += line
+              end
+            end
+          end
+          if not contents.empty?
+            creds = JSON.parse contents
+          end
+          return creds
+        end
+
+        # Write the git commiter details to a file so we can load them next
+        # time the user starts up vagrant.
+        def write_git_commiter_details(full_name, email)
+          if full_name.empty? and email.empty?
+            creds = {'optout' => true}
+          else
+            creds = {'full_name' => full_name, 'email' => email}
+          end
+          File.open(@vagrant_git_commiter_details, 'w') do |f|
+            f.write(JSON.dump(creds))
+          end
+        end
+
+        # When a user is setting up a new vagrant, prompt them for their full
+        # name and email. We'll set these within vagrant so we avoid people
+        # accidently commiting as the "vagrant" user.
+        def generate_git_commiter_facts()
+          existing_details = fetch_git_commiter_details_from_file()
+          # don't set the git configs if the user opted out
+          if existing_details.has_key? 'optout'
+            return
+          end
+
+          if existing_details.any?
+            full_name = existing_details.fetch 'full_name', nil
+            email = existing_details.fetch 'email', nil
+          elsif existing_details.has_key? 'optout'
+            full_name = nil
+            email = nil
+          else
+            @env[:ui].warn \
+              "You'll be prompted to enter your full name and eventbrite email.\n"\
+              "We'll set these for you within your vagrant's .gitconfig.\n"\
+              "This will avoid accidentally committing code as 'vagrant'.\n"\
+              "If you ever want to reset these, remove\n"\
+              "#{@vagrant_git_commiter_details} from your vagrant directory.\n"
+            full_name = @env[:ui].ask 'Enter your full name: '
+            email = @env[:ui].ask 'Enter your eventbrite email: '
+            write_git_commiter_details(full_name, email)
+          end
+          if not full_name.empty? or not email.empty?
+            @env[:ui].success "Will setup global github details in vagrant."\
+              " Full Name: #{full_name}, Email: #{email}"
+          end
+          # NB: We have to escape single quotes for the bash command line.
+          # These facts will get run with puppet_apply like:
+          # FACTER_github_username='Brian O'Niell'. We use this special
+          # escaping to concat an escaped single quote with the rest of the
+          # string, outputting: FACTER_github_username='Brian O'\''Niell'
+          @puppet_fact_generator.add_fact(
+            'github_full_name',
+            full_name.gsub("'", "'\\\\''")
+          )
+          @puppet_fact_generator.add_fact('github_email', email)
+        end
+
+        def call(env)
+          provision_enabled = env.has_key?(:provision_enabled) ? env[:provision_enabled] : true
+          if provision_enabled
+            ensure_vpn()
+            setup_ssh_keys()
+            generate_git_commiter_facts()
+          end
+          @app.call(env)
+        end
+
+        private
+
+          def ping(url)
+            uri = URI(url)
+            begin
+              timeout(1) do
+                s = TCPSocket.new(uri.host, uri.port)
+                s.close
+              end
+            rescue Timeout::Error, SocketError
+              return false
+            end
+            return true
+          end
+
+      end
+    end
+  end
+end

data/lib/vagrant-ebcommon/commands/clear_requirements_cache.rb

@@ -0,0 +1,12 @@
+module VagrantPlugins
+  module Ebcommon
+    class Command < Vagrant.plugin('2', 'command')
+      def execute
+        @env.ui.info 'Clearing PIP requirements cache...'
+        machine = @env.machine :default, :virtualbox
+        machine.communicate.execute '/bin/rm /home/vagrant/python_venv/*/pip_requirements_cache'
+      @env.ui.error '...cache cleared!'
+      end
+    end
+  end
+end

data/lib/vagrant-ebcommon/commands/start-selenium.rb

@@ -0,0 +1,25 @@
+module VagrantPlugins
+  module Ebcommon
+    class Command < Vagrant.plugin('2', 'command')
+
+      def execute
+
+        selserverjar = 'selenium-server-standalone-2.37.0.jar'
+
+        opts = OptionParser.new do |o|
+          o.banner = 'Usage: vagrant start-selenium [-h]'
+          o.separator ''
+          o.separator 'Will ensure that selenium has started on the host machine'
+        end
+        argv = parse_options opts
+        return if !argv
+        raise Vagrant::Errors::CLIInvalidUsage, :help => opts.help.chomp if argv.length > 0
+
+        system "kill $(ps aux | grep '[s]elenium-server.jar' | awk '{print $2}') > /dev/null 2>&1"
+        system "java -jar ../../../src/www/eventbrite/common/automation/webdriver/server/#{selserverjar} -trustAllSSLCertificates > /dev/null 2>&1 &"
+        @env.ui.success 'Selenium server started!'
+      end
+
+    end
+  end
+end

data/lib/vagrant-ebcommon/commands/stop-selenium.rb

@@ -0,0 +1,24 @@
+module VagrantPlugins
+  module Ebcommon
+    class Command < Vagrant.plugin('2', 'command')
+
+      def execute
+
+        selserverjar = 'selenium-server-standalone-2.37.0.jar'
+
+        opts = OptionParser.new do |o|
+          o.banner = 'Usage: vagrant start-selenium [-h]'
+          o.separator ''
+          o.separator 'Will shutdown selenium on the host machine'
+        end
+        argv = parse_options opts
+        return if !argv
+        raise Vagrant::Errors::CLIInvalidUsage, :help => opts.help.chomp if argv.length > 0
+
+        system "kill $(ps aux | grep '[s]elenium-server-standalone' | awk '{print $2}') > /dev/null 2>&1"
+        @env.ui.success 'Selenium server stopped!'
+      end
+
+    end
+  end
+end

data/lib/vagrant-ebcommon/config.rb

@@ -0,0 +1,33 @@
+module VagrantPlugins
+  module Ebcommon
+    class Config < Vagrant.plugin(2, :config)
+      attr_accessor :vpn_urls
+
+      def initialize
+        @vpn_urls = UNSET_VALUE
+      end
+
+      def finalize!
+        @vpn_urls = nil if @vpn_urls == UNSET_VALUE
+      end
+
+      def validate(machine)
+        errors = []
+        if @vpn_urls
+          if not @vpn_urls.kind_of?(Array)
+            errors << '`vpn_urls` must be a list of urls to test vpn connection'
+          else
+            @vpn_urls.each { |url|
+              uri = URI(url)
+              if not (uri.host and uri.port)
+                errors << "`vpn_urls` must be a list of urls: '#{url}' is not valid."
+              end
+            }
+          end
+        end
+        return { 'ebcommon' => errors }
+      end
+
+    end
+  end
+end

data/lib/vagrant-ebcommon/errors.rb

@@ -0,0 +1,12 @@
+module VagrantPlugins
+  module Ebcommon
+    module Errors
+
+      class VPNRequired < Vagrant::Errors::VagrantError
+        error_key('vpn_required')
+      end
+
+    end
+  end
+end
+

data/lib/vagrant-ebcommon/plugin.rb

@@ -0,0 +1,54 @@
+begin
+  require 'vagrant'
+rescue LoadError
+  abort 'vagrant-ebcommon must be loaded in a Vagrant environment.'
+end
+
+begin
+  require 'vagrant-puppet-fact-generator'
+rescue LoadError
+  abort 'vagrant-ebcommon depends on the `vagrant-puppet-fact-generator` plugin.'
+end
+
+# Add our custom translations to the load path
+I18n.load_path << File.expand_path("../../../locales/en.yml", __FILE__)
+
+module VagrantPlugins
+  module Ebcommon
+    class Plugin < Vagrant.plugin('2')
+      name 'vagrant-ebcommon'
+      description <<-DESC
+A Vagrant plugin to handle various Eventbrite workflows.
+DESC
+
+      # define configs
+      config 'ebcommon' do
+        require_relative 'config'
+        Config
+      end
+
+      # define hooks
+      action_hook 'setup_provision' do |hook|
+        require_relative 'actions/setup_provision'
+        hook.before VagrantPlugins::PuppetFactGenerator::Action::GenerateFacts, Action::SetupProvision
+      end
+
+      # define commands
+      command 'clear-requirements-cache' do
+        require_relative 'commands/clear_requirements_cache'
+        Command
+      end
+
+      command 'start-selenium' do
+        require_relative 'commands/start-selenium'
+        Command
+      end
+
+      command 'stop-selenium' do
+        require_relative 'commands/stop-selenium'
+        Command
+      end
+
+    end
+  end
+end

data/lib/vagrant-ebcommon/version.rb

@@ -0,0 +1,5 @@
+module VagrantPlugins
+  module Ebcommon
+    VERSION = "0.4.0"
+  end
+end

data/lib/vagrant-ebcommon.rb

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

data/locales/en.yml

@@ -0,0 +1,5 @@
+en:
+    vagrant:
+        errors:
+            vpn_required: |-
+                VPN is required when provisioning! Please enable VPN or run with "FORCE_PROVISION=true".

data/manifests/init.pp

@@ -0,0 +1,7 @@
+class dev {
+  notify { 'Development provision!':}
+  notify { "Github full name: ${github_full_name}":}
+  notify { "Github email: ${github_email}":}
+}
+
+include dev

data/vagrant-ebcommon.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-ebcommon/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "vagrant-ebcommon"
+  spec.version       = VagrantPlugins::Ebcommon::VERSION
+  spec.authors       = ["Michael Hahn"]
+  spec.email         = ["mhahn@eventbrite.com"]
+  spec.description   = %q{Vagrant plugin to execute various Eventbrite workflows.}
+  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,97 @@
+--- !ruby/object:Gem::Specification
+name: vagrant-ebcommon
+version: !ruby/object:Gem::Version
+  version: 0.4.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 execute various Eventbrite workflows.
+email:
+- mhahn@eventbrite.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- Vagrantfile
+- lib/vagrant-ebcommon.rb
+- lib/vagrant-ebcommon/actions/setup_provision.rb
+- lib/vagrant-ebcommon/commands/clear_requirements_cache.rb
+- lib/vagrant-ebcommon/commands/start-selenium.rb
+- lib/vagrant-ebcommon/commands/stop-selenium.rb
+- lib/vagrant-ebcommon/config.rb
+- lib/vagrant-ebcommon/errors.rb
+- lib/vagrant-ebcommon/plugin.rb
+- lib/vagrant-ebcommon/version.rb
+- locales/en.yml
+- manifests/init.pp
+- pkg/vagrant-ebcommon-0.1.0.gem
+- pkg/vagrant-ebcommon-0.2.0.gem
+- pkg/vagrant-ebcommon-0.3.0.gem
+- pkg/vagrant-ebcommon-0.3.1.gem
+- pkg/vagrant-ebcommon-0.3.2.gem
+- pkg/vagrant-ebcommon-0.4.0.gem
+- vagrant-ebcommon.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 execute various Eventbrite workflows.
+test_files: []
+has_rdoc: