front 0.1.2

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MzAwNTk0OTg0MWE0NjA3YTVhMzM3MmU5ZDVlMTk0OTI5ZTEwODQzMw==
+  data.tar.gz: !binary |-
+    YmNlMWMwNDY4MmMxZGUwYzQxNTQzY2YxNzBjMzMzM2M3ODA1NDdmMA==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    YTY0NWZlNzFmNjJmMGIzOGE0MmUwNjU1ZGE1YjZhNzQ0MTExMGVlMWU2ZjZh
+    YjVhOTk0ODliNTlmNWU2OGE0OThhMWVhNjYyZTgzMTgxY2I3YTFmNTRjMTFj
+    YjVjODc5NDU5MGYzZDQ4YmM5NTNlNmZiOTYxMmJkNGY1NzI4ODQ=
+  data.tar.gz: !binary |-
+    M2JlZDEzZTMyYmJhMmEyM2QxNGY3ZGNiODlmOTg5NjdkMzgwYTIzNDFhODQx
+    NzRiMzRiNDEyNDBiMTgzODU3ZmQxMmZhYzU3YTBmYjc3NzQ3NTUwYTM3Njg3
+    MjU4YjViZGM1YzIzZDE5NTUzMzdmMzEzNDFjNTY0MzNhMDdlMGM=

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.front
+.vagrant

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in front.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Darshan Sawardekar
+
+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,87 @@
+# Front
+
+### Speed up your Vagrant workflow
+
+Booting up a fresh virtual machine takes time. `Front` speeds up VM boot
+time by preinitializing a pool of VMs. When you need a fresh instance,
+use `front next` and you are ready to work instantly. And while you work
+it rebuilds the old VM for your next refill!
+
+## Installation
+
+Install with rubygems:
+
+    $ gem install front
+
+## Usage
+
+When starting a work session, create a new Vagrantfile for your project.
+Then create a new pool with `create`. Without an inventory file, front
+uses a default Vagrantfile with a Ubuntu `precise64` box.
+
+    $ front create
+
+As soon as the 1st VM is ready control is returned to you while the
+other instances in the pool are being preloaded. You can now login to
+this VM with,
+
+    $ front ssh
+
+After you are done with this instance, and need a fresh one, you can
+fetch it with `front next`.
+
+    $ front next
+
+An inventory file is maintained with the SSH port every time you switch
+instances. This can be accessed with the `inventory` action.
+
+    $ front inventory
+
+Finally when done, dispose of the pool with the `destroy` action.
+
+    $ front destroy
+
+## Implementation
+
+`Front` clones your project Vagrantfile into a `.front` directory
+containing the virtual machine instances. When you access the
+`front` commands it steps into these subdirectories and calls the
+corresponding vagrant command. Most actions run in the background
+allowing you to continue working while they complete.
+
+## Complete Usage
+
+    $ front [options] [action]
+
+    Actions
+      create     : create a new pool
+      destroy    : destroy pool
+      next       : switch to next instance in pool
+      ssh        : ssh to current instance => vagrant ssh
+      ssh_config : print ssh config for current instance
+      inventory  : print inventory file
+
+Options
+
+    -s, --size <size>                Size of instance pool
+    -V, --version                    Print Front version
+    -h, --help                       Print Front help
+
+## Caveats
+
+* Running multiple VMs requires a fast computer with lots of RAM.
+  The actual amount depends on the number of VMs, and their configuration.
+  Eg:- For a Ubuntu box with 512MB ram with a pool of size 4, you need
+  at least 2GB for Virtual Box. Plus additional RAM for the host system.
+* Default pool size is 2.
+
+## TODO
+
+* Needs to handle Vagrant errors better.
+* Pool size once created should be persistent.
+* If an instance isn't ready should be able to show it's status.
+* Allow running of other vagrant subcommands
+
+## Contributing
+
+* This project uses the gitflow branching model. PR's go against `develop`.

data/Rakefile

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

data/Vagrantfile

@@ -0,0 +1,3 @@
+Vagrant.configure('2') do |config|
+  config.vm.box = 'precise64'
+end

data/bin/front

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require File.expand_path('../../lib/front/loader', __FILE__)
+
+module Front
+  require 'front/cli/app'
+
+  app = Front::CLI::App.new
+  app.start(ARGV)
+end

data/front.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'front/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "front"
+  spec.version       = Front::VERSION
+  spec.authors       = ["Darshan Sawardekar"]
+  spec.email         = ["darshan@sawardekar.org"]
+  spec.description   = %q{Speed up your Vagrant workflow}
+  spec.summary       = %q{Booting up a fresh virtual machine takes time. `Front` speeds up VM boot time by preinitializing a pool of VMs. When you need a fresh instance, use `front next` and you are ready to work instantly. And while you work it rebuilds the old VM for your next refill!}
+  spec.homepage      = "https://github.com/dsawardekar/front"
+  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

data/lib/front/cli/app.rb

@@ -0,0 +1,16 @@
+module Front
+  module CLI
+    require_relative 'configuration'
+    require_relative 'router'
+
+    class App
+      def start(args)
+        config = Configuration.new
+        options = config.load(args)
+
+        router = Router.new
+        router.route(options)
+      end
+    end
+  end
+end

data/lib/front/cli/configuration.rb

@@ -0,0 +1,75 @@
+module Front
+  module CLI
+    require 'optparse'
+    require 'ostruct'
+
+    class Configuration
+      include Loader
+
+      def load(args)
+        options = OpenStruct.new
+        options.action = nil
+        options.error = nil
+        options.pool_size = 2
+
+        parse(args, options)
+      end
+
+      def get_parser(args, options)
+        OptionParser.new do |opts|
+          options.opts = opts
+          opts.banner = 'Usage: front [options] [action]'
+          opts.separator ''
+          opts.separator 'Actions'
+          opts.separator '  create     : create a new pool'
+          opts.separator '  destroy    : destroy pool'
+          opts.separator '  next       : switch to next instance in pool'
+          opts.separator '  ssh        : ssh to current instance => vagrant ssh'
+          opts.separator '  ssh_config : print ssh config for current instance'
+          opts.separator '  inventory  : print inventory file (for ansible)'
+          opts.separator ''
+          opts.separator 'Options'
+          opts.separator ''
+
+          opts.on('-s', '--size <size>', Integer, 'Size of instance pool') do |pool_size|
+            options.pool_size = pool_size
+          end
+
+          opts.on_tail('-V', '--version', 'Print Front version') do
+            options.action = :show_version
+          end
+
+          opts.on_tail('-h', '--help', 'Print Front help') do
+            options.action = :show_help
+          end
+        end
+      end
+
+      def parse(args, options)
+        parser = get_parser(args, options)
+
+        begin
+          parser.parse!(args)
+          if options.action.nil?
+            if args.length == 1
+              options.action = args[0]
+            else
+              raise OptionParser::InvalidOption.new(args)
+            end
+          end
+        rescue OptionParser::InvalidOption => err
+          options.error = err
+          options.action = :show_invalid_option
+        rescue OptionParser::MissingArgument => err
+          options.error = err
+          options.action = :show_missing_args
+        rescue OptionParser::ParseError => err
+          options.error = err
+          options.action = :show_parser_error
+        end
+
+        options
+      end
+    end
+  end
+end

data/lib/front/cli/controller.rb

@@ -0,0 +1,81 @@
+module Front
+  module CLI
+    require 'front/version'
+    require 'front/loader'
+    require_relative 'vagrant'
+    require_relative 'vagrant_pool'
+
+    class Controller
+      include Loader
+      attr_reader :options
+
+      def initialize(options)
+        @options = options
+        @pool = VagrantPool.new(options.pool_size)
+      end
+
+      # actions
+      def create
+        @pool.create
+        @pool.load
+      end
+
+      def destroy
+        @pool.unload
+      end
+
+      def next
+        @pool.next
+      end
+
+      def ssh
+        @pool.ssh
+      end
+
+      def ssh_config
+        puts @pool.ssh_config
+      end
+
+      def inventory
+        puts File.read(@pool.get_inventory_file())
+      end
+
+      def status
+        @pool.status
+      end
+
+      # errors
+      def show_invalid_option
+        show_error @options.error
+      end
+
+      def show_missing_args
+        show_error @options.error
+      end
+
+      def show_parser_error
+        show_error @options.error
+      end
+
+      def show_error(msg = @options.error)
+        puts "Error: #{msg}"
+        puts
+
+        show_help
+      end
+
+      def method_missing(method)
+        show_error "Unknown action: #{method}"
+      end
+
+      # help
+      def show_help
+        puts @options.opts
+      end
+
+      def show_version
+        puts VERSION
+      end
+    end
+  end
+end

data/lib/front/cli/front_file.rb

@@ -0,0 +1,51 @@
+module Front
+  module CLI
+    require 'json'
+
+    class Frontfile
+      attr_reader :path
+      attr_reader :data
+
+      def initialize(path)
+        @path = path
+      end
+
+      def exists?
+        File.exists?(path)
+      end
+
+      def create(defaults)
+        @data = defaults
+        save()
+      end
+
+      def load
+        file_contents = File.read(path)
+        @data = JSON.parse(file_contents)
+      end
+
+      def save
+        json = @data.to_json
+        File.open(path, 'w') do |file|
+          file.write(json)
+        end
+      end
+
+      def get_current_id
+        @data['current_id']
+      end
+
+      def set_current_id(current_id)
+        @data['current_id'] = current_id
+      end
+
+      def get_pool_size
+        @data['pool_size']
+      end
+
+      def set_pool_size(pool_size)
+        @data['pool_size'] = pool_size
+      end
+    end
+  end
+end

data/lib/front/cli/router.rb

@@ -0,0 +1,12 @@
+module Front
+  module CLI
+    require_relative 'controller'
+
+    class Router
+      def route(options)
+        controller = Controller.new(options)
+        controller.send(options.action)
+      end
+    end
+  end
+end

data/lib/front/cli/script.rb

@@ -0,0 +1,38 @@
+module Front
+  module CLI
+    class Script
+      def initialize(path)
+        @commands = []
+        @path = path
+      end
+
+      def enqueue(cmd)
+        @commands << cmd
+      end
+
+      def save
+        File.open(@path, 'w') do |file|
+          file.puts("#!/bin/bash")
+
+          @commands.each do |command|
+            file.puts(command)
+          end
+        end
+
+        File.chmod(0755, @path)
+      end
+
+      def run
+        if pending?
+          save()
+          pid = Kernel.spawn(@path)
+          Process.detach pid
+        end
+      end
+
+      def pending?
+        @commands.length > 0
+      end
+    end
+  end
+end

data/lib/front/cli/vagrant.rb

@@ -0,0 +1,125 @@
+module Front
+  module CLI
+    require 'resque'
+
+    class Vagrant
+      attr_reader :id
+      attr_reader :path
+      attr_accessor :wait
+      attr_accessor :script
+
+      def initialize(id, path, script)
+        @id = id
+        @path = path
+        @wait = true
+        @script = script
+      end
+
+      def up
+        run('up')
+      end
+
+      def destroy
+        run('destroy -f')
+      end
+
+      def reload
+        run('reload')
+      end
+
+      def ssh
+        run('ssh')
+      end
+
+      def ssh_config
+        capture('ssh-config')
+      end
+
+      def ssh_port
+        output = ssh_config()
+        re = /^\s*Port\s*(\d+)$/m
+
+        matches = output.match(re)
+        return matches[1]
+      end
+
+      def status
+        output = capture('status')
+        re = /^(\w+\s+\w+ \(\w+\))/m
+        matches = output.match(re)
+        if matches
+          return matches[1]
+        else
+          'pending'
+        end
+      end
+
+      def get_log_file
+        "#{path}/front.log"
+      end
+
+      def run(cmd)
+        cmd = "vagrant #{cmd}"
+        options = {}
+        options[:chdir] = path
+
+        if wait
+          pid = Kernel.spawn(cmd, options)
+          Process.wait pid
+        else
+          cmd = "#{cmd} &>> #{get_log_file()} "
+          script.enqueue "cd #{path} && #{cmd}"
+        end
+      end
+
+      def run2(cmd)
+        options = {}
+        options[:chdir] = path
+        unless wait
+          log_file = "#{path}/front.log"
+          options[:out] = log_file
+          options[:err] = log_file
+        end
+
+        pid = Kernel.spawn("vagrant #{cmd}", options)
+        if wait
+          Process.wait pid
+        else
+          Process.detach pid
+        end
+      end
+
+      def capture(cmd)
+        Dir.chdir(path) do
+          `vagrant #{cmd}`
+        end
+      end
+    end
+
+    class VagrantWorker
+      @queue = :vagrant
+
+      def self.perform(task)
+        cmd = task.cmd
+        options = task.options
+        options[:out] = task.log_file
+        options[:err] = task.log_file
+
+        pid = Kernel.spawn(cmd, options)
+        Process.wait pid
+      end
+    end
+
+    class VagrantTask
+      attr_accessor :cmd
+      attr_accessor :options
+      attr_accessor :log_file
+
+      def initialize(cmd, options, log_file)
+        @cmd = cmd
+        @options = options
+        @log_file = log_file
+      end
+    end
+  end
+end

data/lib/front/cli/vagrant_pool.rb

@@ -0,0 +1,193 @@
+module Front
+  module CLI
+    require 'fileutils'
+    require_relative 'front_file'
+    require_relative 'script'
+
+    class VagrantPool
+      include Loader
+
+      def initialize(size)
+        @size = size
+        @script = Script.new(get_script_path())
+      end
+
+      def create
+        front_path = get_front_path()
+        FileUtils.mkdir_p(front_path)
+
+        get_pool_size().times do |index|
+          instance_id = index + 1
+          instance_path = get_instance_path(instance_id)
+
+          FileUtils.mkdir_p(instance_path)
+          FileUtils.cp get_vagrant_file(), instance_path
+        end
+
+        create_front_file
+      end
+
+      def load
+        loaded = false
+        get_pool_size().times do |index|
+          vagrant = get_vagrant(index + 1)
+          vagrant.wait = !loaded
+          vagrant.up
+
+          loaded = true
+        end
+
+        @script.run
+      end
+
+      def unload
+        get_pool_size().times do |index|
+          instance_id = index + 1
+          vagrant = get_vagrant(instance_id)
+          puts "Destroying instance \##{instance_id}"
+          vagrant.destroy
+        end
+
+        FileUtils.rm_rf(get_front_path())
+      end
+
+      def next
+        current_id = get_current_id()
+        vagrant = get_vagrant(current_id)
+        vagrant.wait = false
+        vagrant.destroy
+        vagrant.up
+
+        next_id = get_next_id()
+        vagrant = get_vagrant(next_id)
+        puts "Switched to instance \##{next_id}"
+
+        save_front_file(next_id)
+        update_inventory(vagrant)
+        @script.run()
+
+        next_id
+      end
+
+      def ssh
+        vagrant = get_vagrant(get_current_id())
+        vagrant.ssh
+      end
+
+      def ssh_config
+        vagrant = get_vagrant(get_current_id())
+        vagrant.ssh_config
+      end
+
+      def status
+        current_id = get_current_id()
+        get_pool_size().times do |index|
+          instance_id = index + 1
+          if instance_id == current_id
+            instance_label = "\##{instance_id}*"
+          else
+            instance_label = "\##{instance_id} "
+          end
+
+          vagrant = get_vagrant(instance_id)
+          puts "Instance #{instance_label}: #{vagrant.status}"
+        end
+      end
+
+      def get_vagrant(instance_id)
+        instance_path = get_instance_path(instance_id)
+        Vagrant.new(instance_id, instance_path, @script)
+      end
+
+      def get_inventory_file
+        "#{get_front_path()}/inventory.ini"
+      end
+
+      def get_front_path
+        "#{Dir.pwd}/.front"
+      end
+
+      def get_script_path
+        "#{get_front_path()}/pending.sh"
+      end
+
+      def get_instance_path(id)
+        "#{get_front_path()}/#{id}"
+      end
+
+      def get_vagrant_file
+        custom_path = "#{Dir.pwd}/Vagrantfile"
+        if File.exists?(custom_path)
+          return custom_path
+        else
+          return "#{ROOT_DIR}/Vagrantfile"
+        end
+      end
+
+      def get_frontfile_path
+        "#{get_front_path()}/Frontfile"
+      end
+
+      def get_current_id
+        get_front_file().get_current_id()
+      end
+
+      def get_next_id
+        current_id = get_current_id()
+        if current_id + 1 > get_pool_size()
+          next_id = 1
+        else
+          next_id = current_id + 1
+        end
+
+        next_id
+      end
+
+      def get_pool_size
+        front_file = get_front_file()
+        if front_file.exists?
+          front_file.get_pool_size()
+        else
+          @size
+        end
+      end
+
+      # helpers
+      def get_front_file
+        if @front_file.nil?
+          @front_file = Frontfile.new(get_frontfile_path())
+          if @front_file.exists?
+            @front_file.load()
+          end
+        end
+
+        @front_file
+      end
+
+      def create_front_file
+        defaults = {}
+        defaults['current_id'] = 1
+        defaults['pool_size'] = @size
+
+        front_file = get_front_file()
+        front_file.create(defaults)
+      end
+
+      def save_front_file(current_id)
+        front_file = get_front_file()
+        front_file.set_current_id(current_id)
+        front_file.save()
+      end
+
+      def update_inventory(vagrant)
+        ip_address = "127.0.0.#{get_current_id()}"
+        port = vagrant.ssh_port()
+
+        item = "#{ip_address}:#{port}"
+        File.open(get_inventory_file(), 'w') do |file|
+          file.write(item)
+        end
+      end
+    end
+  end
+end

data/lib/front/loader.rb

@@ -0,0 +1,7 @@
+module Front
+  module Loader
+    ROOT_DIR = File.expand_path('../../../', __FILE__)
+    LIB_DIR  = File.join(ROOT_DIR, 'lib')
+    $:.unshift(LIB_DIR) unless $:.include? LIB_DIR
+  end
+end

data/lib/front/version.rb

@@ -0,0 +1,3 @@
+module Front
+  VERSION = "0.1.2"
+end

data/lib/front.rb

@@ -0,0 +1,5 @@
+require "front/version"
+
+module Front
+  # Your code goes here...
+end

data/portkey.json

@@ -0,0 +1,11 @@
+{
+  "lib/front/cli/*.rb": {
+    "type": "cli",
+    "test": "spec/front/cli/%s_spec.rb"
+  },
+
+  "test/front/cli/*_spec.rb": {
+    "type": "spec",
+    "alternate": "lib/front/cli/%s.rb"
+  }
+}

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: front
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Darshan Sawardekar
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-11 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: Speed up your Vagrant workflow
+email:
+- darshan@sawardekar.org
+executables:
+- front
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- Vagrantfile
+- bin/front
+- front.gemspec
+- lib/front.rb
+- lib/front/cli/app.rb
+- lib/front/cli/configuration.rb
+- lib/front/cli/controller.rb
+- lib/front/cli/front_file.rb
+- lib/front/cli/router.rb
+- lib/front/cli/script.rb
+- lib/front/cli/vagrant.rb
+- lib/front/cli/vagrant_pool.rb
+- lib/front/loader.rb
+- lib/front/version.rb
+- portkey.json
+homepage: https://github.com/dsawardekar/front
+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.5
+signing_key: 
+specification_version: 4
+summary: Booting up a fresh virtual machine takes time. `Front` speeds up VM boot
+  time by preinitializing a pool of VMs. When you need a fresh instance, use `front
+  next` and you are ready to work instantly. And while you work it rebuilds the old
+  VM for your next refill!
+test_files: []