vagrant-tools 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7d2898850a57d6033da0766d357602395ba69b1d
+  data.tar.gz: 65271bbbca73801f2223bfebdd95965181be4ad6
+SHA512:
+  metadata.gz: da9a691708420a95151da7c89cc5c588c3aadac1f596215766cf19217df319a12cac5302049efee3b2448af0036df4f47f46c901b244cac99845efcdd9a78f57
+  data.tar.gz: c1325e21edf6785ca70e9ebe54c14018afb805b910f9eff437e653f9cd5a44acb5be7ab38a1dba4c0de2953deaec21743b89e63e0d4563e3d99be1eb732cb163

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Dennis Blommesteijn
+
+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,124 @@
+# Vagrant::Tools
+
+Vagrant configuration management tool (via cli).
+
+By using cli commands: `vgls` you can list all .vagrant configs on your system.
+Use `vgctl -t config -c (vagrant command)` to run vagrant commands from any path (working dir) on your system.
+
+
+## Roadmap
+
+* Version (0.0.1)
+
+  * Initial project
+  * List all vagrant configurations
+  * Add basic controls for up/ halt/ destroy etc.
+
+* Version (0.1.0) Current
+
+  * Enable `vagrant ssh` interactive shell
+
+* Version (0.1.1)
+
+  * Filter only active/ inactive
+  * Add option to switch to .config path `vgctl -t target-box -c cd`
+
+
+## Installation
+
+**Clone the git repository to your local machine.**
+
+```bash
+git clone https://github.com/dblommesteijn/vagrant-tools
+```
+
+**Install binaries to your system**
+
+```bash
+cd vagrant-tools
+rake install
+# vgls and vgctl will be available system wide
+```
+
+**Run commands**
+
+```bash
+# list all vagrant configs
+vgls
+# control vagrant
+vgctl
+```
+
+## Usage
+
+Verbose, this will output operations to STDOUT
+
+```bash
+vgls -v
+vgctl -v
+```
+
+Change target configuration (find operation), base from where .vagrant configs are discovered:
+
+`find "/home/user/path/to/your/repos" -type d -name ".vagrant"`
+
+*NOTE: this will force cache refresh*
+
+```bash
+vgls -p `$HOME`/path/to/your/repos
+vgctl -p `$HOME`/path/to/your/repos
+```
+
+Target or list vagrant config relative to a given config
+
+*NOTE: duplicate config names will get a _n offset*
+
+```bash
+vgls -t my-test-box
+vgctl -t my-test-box
+```
+
+Refresh cache, by default cache is stored at `$HOME/.vagrant-tools/settings.json`
+
+```bash
+# vgls and vgctl are equivalent
+vgls -x
+vgctl -x
+```
+
+Run a vagrant command (-c prepends `vagrant ` to all commands)
+
+```bash
+vgctl -t my-test-box -c list-commands
+# runs `vagrant list-commands` in the path of `my-test-box`
+# ... etc
+```
+
+Print help file
+
+```bash
+vgls -h
+vgctl -h
+```
+
+### Workflow
+
+Listing all vagrant configs, and starting VM
+
+```bash
+# list all configs
+vgls
+# execute `vagrant up` on path of `my-test-box`
+vgctl -t my-test-box -c up
+vgctl -t my-test-box -c ssh
+```
+
+Destroy a running VM
+
+```bash
+# list all configs
+vgls
+# execute `vagrant destroy` on path of `my-test-box`
+vgctl -t my-test-box -c destory
+```
+

data/Rakefile

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

data/bin/vgctl

@@ -0,0 +1,85 @@
+#!/usr/bin/env ruby
+
+require File.expand_path(File.dirname(__FILE__) + "/../lib/vagrant/tools")
+require 'optparse'
+
+
+def main(argv)
+  # set configuration
+  vgtools_cfg = Vagrant::Tools.config do |c|
+    # defaults
+    c.prefix = ENV["HOME"]
+    c.verbose = false
+    # getopts
+    opt_parser = OptionParser.new do |opts|
+      opts.banner = "Vagrant control, Usage: vgctl [options]"
+
+      opts.on("-p", "--prefix DIR", String, "Define prefix (default $HOME)") do |v|
+        c.prefix = v
+        c.refresh_cache = true
+      end
+      opts.on("-v", "--verbose", "Verbose output") do |v|
+        c.verbose = true
+      end
+      opts.on("-t", "--target TARGET", String, "Target specific Vagrantfile directory") do |v|
+        c.target = v
+      end
+      opts.on("-c", "--cmd COMMAND", String, "Run vagrant command relative to -t TARGET (-c \"up\")") do |v|
+        c.cmd = v
+      end
+      opts.on("-x", "--refresh-cache", "Refresh cached results") do |v|
+        c.refresh_cache = v
+      end
+      opts.on_tail("-h", "--help", "Show this message") do
+        puts opts
+        exit 1
+      end
+    end
+    begin
+      opt_parser.parse!
+    rescue OptionParser::MissingArgument => e
+      puts e.message
+      exit 1
+    rescue OptionParser::InvalidOption => e
+      puts e.message
+      exit 1
+    end
+  end
+  cfg = Vagrant::Tools.get_config 
+  verify = vgtools_cfg.verify? do |errors|
+    # if cfg.target.nil? || cfg.target == "
+    errors[:target] = "target does not exist" if cfg.target.nil?
+    errors[:cmd] = "invalid" if cfg.cmd.nil? || cfg.cmd == ""
+    # errors[:]
+  end
+  unless verify
+    puts vgtools_cfg.error_messages
+    exit 1
+  end
+
+  # print verbose message
+  if cfg.verbose
+    puts "Running `#{File.basename(__FILE__)}` in verbose mode (disable by removing -v [options])"
+  end
+  
+  # find config root by target name (project root name)
+  root = Vagrant::Tools::Root.new
+  config = root.find_by_project_root(cfg.target)
+  if config.nil?
+    puts "target config not found"
+    exit
+  else
+    puts "executing: #{cfg.cmd}" if cfg.verbose
+  end
+  # execute command relative to config
+  config.exec_vagrant_command(cfg.cmd)
+end
+
+
+if File.basename(__FILE__) == File.basename($0)
+  begin
+    main(ARGV)
+  rescue Interrupt
+    exit 0
+  end
+end

data/bin/vgls

@@ -0,0 +1,72 @@
+#!/usr/bin/env ruby
+
+require File.expand_path(File.dirname(__FILE__) + "/../lib/vagrant/tools")
+require 'optparse'
+
+
+def main(argv)
+  # set configuration
+  vgtools_cfg = Vagrant::Tools.config do |c|
+    # defaults
+    c.prefix = ENV["HOME"]
+    c.verbose = false
+    # getopts
+    opt_parser = OptionParser.new do |opts|
+      opts.banner = "Vagrant list, Usage: vgls [options]"
+      opts.on("-p", "--prefix DIR", String, "Define prefix (default $HOME)") do |v|
+        c.prefix = v
+        c.refresh_cache = true
+      end
+      opts.on("-v", "--verbose", "Verbose output") do |v|
+        c.verbose = true
+      end
+      opts.on("-t", "--target TARGET", String, "Target specific config (Vagrantfile dir)") do |v|
+        c.target = v
+      end
+      opts.on("-x", "--refresh-cache", "Refresh cached results") do |v|
+        c.refresh_cache = v
+      end
+      opts.on_tail("-h", "--help", "Show this message") do
+        puts opts
+        exit 1
+      end
+
+    end
+    begin
+      opt_parser.parse!
+    rescue OptionParser::InvalidOption => e
+      puts e.message
+      exit 1
+    rescue OptionParser::MissingArgument => e
+      puts e.message
+      exit 1
+    end
+  end
+
+  verify = vgtools_cfg.verify? do |errors|
+    # if
+    # errors[:]
+  end
+  unless verify
+    puts vgtools_cfg.error_messages
+    exit 1
+  end
+
+  cfg = Vagrant::Tools.get_config 
+  if cfg.verbose
+    puts "Running `#{File.basename(__FILE__)}` in verbose mode (disable by removing -v [options])"
+  end
+
+  # output lists
+  root = Vagrant::Tools::Root.new
+  puts root.to_outputs
+end
+
+
+if File.basename(__FILE__) == File.basename($0)
+  begin
+    main(ARGV)
+  rescue Interrupt
+    exit 0
+  end
+end

data/lib/vagrant/tools/cache.rb

@@ -0,0 +1,43 @@
+module Vagrant
+  module Tools
+
+    class Cache
+
+      # attr_accessor :prefix, :verbose, :output, :options, :target, :cmd
+      PATH = "#{ENV["HOME"]}/.vagrant-tools"
+
+      def initialize(path = PATH)
+        @path = path
+        @cfg = Vagrant::Tools.get_config
+        unless File.exists?(@path)
+          puts "Creating `#{path}`" if @cfg.verbose
+          FileUtils.mkpath(@path)
+        end
+        @filename = "#{@path}/settings.json"
+      end
+
+      def get_config
+        return {} unless File.exists?(@filename)
+        #TODO: read from file
+        begin
+          json = JSON.parse(File.read(@filename), {symbolize_names: true})
+          json[:configs]
+        rescue
+          return {}
+        end
+      end
+
+      def set_config(dirs)
+        puts "Writing to `#{@filename}`" if @cfg.verbose
+        config_paths = { configs: dirs.flat_map{|k,v| v.map(&:config_path)} }
+        flat_json = JSON.pretty_generate(config_paths)
+        puts flat_json if @cfg.verbose
+        File.open(@filename,"w") do |f|
+          f.write(flat_json)
+        end
+      end
+
+    end
+
+  end
+end

data/lib/vagrant/tools/config.rb

@@ -0,0 +1,38 @@
+module Vagrant
+  module Tools
+
+    class Config
+
+      attr_accessor :prefix, :verbose, :output, :options, :target, :cmd, :refresh_cache
+
+      def initialize
+        @errors = {}
+        self.prefix = ENV["HOME"]
+        self.verbose = false
+        self.output = {machine: false, long: false}
+        self.target = nil
+        self.cmd = nil
+      end
+
+      def verify?(&block)
+        # general checks
+        @errors[:prefix] = "file does not exist" unless File.exists?(self.prefix)
+        unless self.cmd.nil?
+          if self.cmd.start_with?("vagrant")
+            @errors[:cmd] = "all commands are prepended with `vagrant`"
+          end
+        end
+        # file specific checks
+        block.call(@errors)
+        # @errors[:target] = "unknown target" if self.target.present? && 
+        @errors.empty?
+      end
+
+      def error_messages
+        @errors.map{|k,v| "Error `#{k}`: #{v}"}
+      end
+
+    end
+
+  end
+end

data/lib/vagrant/tools/helper.rb

@@ -0,0 +1,25 @@
+module Vagrant
+  module Tools
+
+    class Helper
+
+      class << self
+
+        # collecting user input, continue if input == y else exit
+        # def collect_input_yn_exit!(action)
+        #   STDOUT.write "#{action} are you sure [y/N]? "
+        #   STDOUT.flush
+        #   a = gets
+        #   case a.downcase
+        #   when "y\n"
+        #     return true
+        #   else
+        #     exit
+        #   end
+        # end
+
+      end
+
+    end
+  end
+end

data/lib/vagrant/tools/orm/config.rb

@@ -0,0 +1,48 @@
+require 'open3'
+
+module Vagrant
+  module Tools
+    module Orm
+
+      class Config
+
+        attr_accessor :name, :project_root, :offset, :config_path
+
+        def initialize(config_path)
+          @cfg = Vagrant::Tools.get_config
+          self.config_path = config_path
+          self.project_root = File.absolute_path("#{config_path}/../")
+          @machines = Dir["#{self.config_path}/machines/*"].flat_map{|t| Machine.new(t)}
+          self.name = File.basename(File.absolute_path("#{config_path}/../"))
+          self.offset = 0
+        end
+
+        def project_root_name
+          File.basename(self.project_root)
+        end
+
+        def project_root_name_with_offset
+          o = (self.offset > 0) ? "_#{self.offset}" : ""
+          "#{self.project_root_name}#{o}"
+        end
+
+        def exec_vagrant_command(cmd)
+          cmd = "(cd #{self.project_root} && vagrant #{cmd})"
+          puts cmd if @cfg.verbose
+          system(cmd)
+        end
+
+        def names
+          @machines.map(&:name)
+        end
+
+        def to_outputs
+          machines = @machines.map(&:to_outputs).join("")
+          "#{self.project_root_name_with_offset} (#{@project_root})\n#{machines}"
+        end
+
+      end
+
+    end
+  end
+end

data/lib/vagrant/tools/orm/machine.rb

@@ -0,0 +1,33 @@
+module Vagrant
+  module Tools
+    module Orm
+
+      class Machine
+
+        attr_accessor :name
+
+        def initialize(machine_path)
+          @machine_path = machine_path
+          self.name = File.basename(machine_path)
+          @provider = Dir["#{@machine_path}/*"].flat_map{|t| Provider.new(t)}
+        end
+
+        def ids
+          @provider.map(&:id)
+        end
+
+        def processes
+          @provider.map(&:process)
+        end
+
+        def to_outputs
+          provider = @provider.map(&:to_outputs).join("")
+          return "- #{self.name} (no provider found)\n" if provider.empty?
+          "- #{self.name} (#{provider})\n"
+        end
+
+      end
+
+    end
+  end
+end

data/lib/vagrant/tools/orm/provider.rb

@@ -0,0 +1,49 @@
+require 'sys/proctable'
+
+module Vagrant
+  module Tools
+    module Orm
+
+      class Provider
+
+        attr_accessor :id
+
+        def initialize(provider_path)
+          @provider_path = provider_path
+          @id_file = "#{@provider_path}/id"
+          self.id = File.read(@id_file) if self.valid?
+          @process = nil
+        end
+
+        def valid?
+          File.exists?(@id_file)
+        end
+
+        def process
+          return @process unless @process.nil?
+          Sys::ProcTable.ps do |p|
+            @process = p if p.cmdline.include?(self.id)
+          end
+          @process
+        end
+
+        def to_outputs
+          ret = []
+          if self.valid?
+            p = self.process
+            if p.nil?
+              ret << "vmid: #{self.id}"
+            else
+              ret << "pid: #{p.pid}"
+            end
+          else
+            ret << "never started"
+          end
+          ret.join
+        end
+
+      end
+
+    end
+  end
+end

data/lib/vagrant/tools/root.rb

@@ -0,0 +1,94 @@
+require 'open3'
+require 'json'
+
+module Vagrant
+  module Tools
+
+    class Root
+
+      LOOKUP_DIR = ".vagrant"
+
+      def initialize
+        @cfg = Vagrant::Tools.get_config
+        @dirs = {}
+        self.find_vagrant_configs
+      end
+
+      def find_by_project_root(project_root_name)
+        self.get_config_without_offset(project_root_name)
+      end
+
+      def find_vagrant_configs
+        unless @dirs.empty?
+          puts "Config already loaded (use -x to force reload)" if @cfg.verbose
+          return @dirs
+        end
+        prefix = @cfg.prefix
+        cache = Cache.new
+        cache_configs = cache.get_config
+        # break if config found (unless refreshing)
+        if !cache_configs.empty? && !@cfg.refresh_cache
+          puts "Reading config from cache" if @cfg.verbose
+          cache_configs.each do |config|
+            # create new config instance
+            self.add_config_dirs(config)
+          end
+          return self 
+        end
+        # findin configs via find
+        cmd = "find \"#{prefix}\" -type d -name \"#{LOOKUP_DIR}\""
+        puts "Finding vagrant configs: `#{cmd}`..." if @cfg.verbose
+        Open3.popen3(cmd) do |stdin, stdout, stderr|
+          stdin.close_write
+          stdout.read.split("\n").each do |config|
+            # create new config instance
+            self.add_config_dirs(config)
+          end
+          stderr.close_read
+        end
+        cache.set_config(@dirs)
+        self
+      end
+
+      def to_outputs
+        ret = []
+        if @cfg.target.nil?
+          # print all
+          ret << @dirs.flat_map{|k,t| t.map(&:to_outputs)}
+        else
+          ret << self.get_config_without_offset(@cfg.target).to_outputs      
+        end
+        ret.join
+      end
+
+      protected
+
+      def add_config_dirs(config)
+        orm_config = Orm::Config.new(config)
+        n = orm_config.project_root_name
+        @dirs[n] ||= []
+        orm_config.offset = @dirs[n].size + 1 if @dirs[n].size > 0
+        @dirs[n] << orm_config
+        nil
+      end
+
+      def get_config_without_offset(name)
+        tmp = name.split("_")
+        if tmp.size > 1
+          n = tmp.first
+          o = tmp.last.to_i - 1
+          if @dirs.include?(n)
+            return @dirs[n][o]
+          end
+        # elsif @dirs[n].nil?
+          # puts @dirs.inspect
+        else
+          n = name
+          return @dirs[n].first
+        end
+        nil
+      end
+
+    end
+  end
+end

data/lib/vagrant/tools/version.rb

@@ -0,0 +1,5 @@
+module Vagrant
+  module Tools
+    VERSION = "0.1.0"
+  end
+end

data/lib/vagrant/tools.rb

@@ -0,0 +1,30 @@
+require File.expand_path(File.dirname(__FILE__) + "/tools/config")
+require File.expand_path(File.dirname(__FILE__) + "/tools/cache")
+require File.expand_path(File.dirname(__FILE__) + "/tools/root")
+require File.expand_path(File.dirname(__FILE__) + "/tools/version")
+require File.expand_path(File.dirname(__FILE__) + "/tools/helper")
+require File.expand_path(File.dirname(__FILE__) + "/tools/orm/config")
+require File.expand_path(File.dirname(__FILE__) + "/tools/orm/machine")
+require File.expand_path(File.dirname(__FILE__) + "/tools/orm/provider")
+
+
+module Vagrant
+  module Tools
+
+    @@config = ::Vagrant::Tools::Config.new
+
+    class << self
+
+      def config(&block)
+        block.call(@@config)
+        @@config
+      end
+
+      def get_config
+        @@config.dup
+      end
+
+    end
+
+  end
+end

data/vagrant-tools.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'vagrant/tools/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "vagrant-tools"
+  spec.version       = Vagrant::Tools::VERSION
+  spec.authors       = ["Dennis Blommesteijn"]
+  spec.email         = ["dennis@blommesteijn.com"]
+  spec.summary       = %q{Tools for Vagrant}
+  spec.description   = %q{Tools for Vagrant}
+  spec.homepage      = ""
+  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_dependency 'sys-proctable', "> 0.9"
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: vagrant-tools
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dennis Blommesteijn
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sys-proctable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>'
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>'
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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: Tools for Vagrant
+email:
+- dennis@blommesteijn.com
+executables:
+- vgctl
+- vgls
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/vgctl
+- bin/vgls
+- lib/vagrant/tools.rb
+- lib/vagrant/tools/cache.rb
+- lib/vagrant/tools/config.rb
+- lib/vagrant/tools/helper.rb
+- lib/vagrant/tools/orm/config.rb
+- lib/vagrant/tools/orm/machine.rb
+- lib/vagrant/tools/orm/provider.rb
+- lib/vagrant/tools/root.rb
+- lib/vagrant/tools/version.rb
+- vagrant-tools.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.2.2
+signing_key: 
+specification_version: 4
+summary: Tools for Vagrant
+test_files: []