vaquero_io 0.1.1

data/lib/vaquero_io/platform.rb

@@ -0,0 +1,195 @@
+require 'resolv'
+require 'uri'
+require 'vaquero_io/provision'
+
+module VaqueroIo
+  # rubocop:disable ClassLength
+  class Platform
+    include VaqueroIo::Platform::Provision
+
+    attr_accessor :provider
+    attr_accessor :product
+    attr_accessor :product_provider, :product_provider_version
+    attr_accessor :environments
+    attr_accessor :nodename
+    attr_accessor :components
+    attr_accessor :required
+    attr_accessor :env_definition
+
+    # rubocop:disable MethodLength, LineLength
+    def initialize(provider = nil)
+      @provider = provider
+      fail unless platform_files_exist?
+      platform = YAML.load_file(PLATFORMFILE).fetch('platform')
+      @product = platform['product']
+      @product_provider = platform['provider']
+
+      # Lazy provider loading if we weren't given one...
+      if @provider.nil?
+        @provider = VaqueroIo::Provider.new(@product_provider)
+        # re-test platform health
+        fail unless platform_files_exist?
+      end
+
+      @product_provider_version = platform['plugin_version']
+      @environments = platform['environments']
+      @nodename = platform['nodename']
+      @components = platform['components']
+      @required = {}
+      @provider.definition['structure']['require'].each do |required_file|
+        @required[required_file] = YAML.load_file(@provider.definition['structure'][required_file]['path'] + required_file + '.yml').fetch(required_file)
+      end
+    end
+    # rubocop:enable MethodLength, LineLength
+
+    # rubocop:disable MethodLength, LineLength, CyclomaticComplexity, PerceivedComplexity
+    def healthy?(env = '')
+      health = ''
+      health += (FAIL_PROVIDER + "\n") if @provider.definition['name'] != @product_provider
+      puts WARN_PROVIDER_VERSION if @provider.definition['version'] != @product_provider_version
+      health += (FAIL_EMPTY_ENVIRONMENTS + "\n") unless @environments.all?
+      @environments.each do |e|
+        health += (FAIL_MISSING_ENV + e + "\n") unless File.file?(ENVIRONMENTFILE + e + '.yml')
+      end if @environments.all?
+      health += (FAIL_EMPTY_NODENAME + "\n") unless @nodename.all?
+
+      # confirm that the platform definition references all required files
+      @provider.definition['structure']['require'].each do |required_file|
+        @components.each do |_param, value|
+          health += (FAIL_REQUIRED_FILES + required_file + "\n") unless value.key?(required_file)
+          # TODO: Validate that the value for the required file key actually matches a defined key value
+        end
+        # Validate required files against template
+        health += validate(@provider.definition['structure'][required_file]['params'], @required[required_file])
+      end
+      # Validate platform against template
+      health += validate(@provider.definition['structure']['platform']['params'], @components)
+
+      # TODO: if an environment is specified then we are checking the health of the environment rather than platform
+      puts 'list nodes' unless env.empty?
+      if health.length > 0
+        puts health + "\n#{health.lines.count} platform offense(s) detected"
+        false
+      else
+        true
+      end
+    end
+    # rubocop:enable MethodLength, LineLength, CyclomaticComplexity, PerceivedComplexity
+
+    # rubocop:disable MethodLength, LineLength
+    def environment(env)
+      return unless healthy?
+      build_env = YAML.load_file(ENVIRONMENTFILE + env + '.yml').fetch(env)
+      @components.each do |component, _config|
+        begin
+          build_env['components'][component].merge!(@components[component]) { |_key, v1, _v2| v1 } unless build_env['components'][component].nil?
+        rescue => error
+          puts "ERROR: build_env: could not merge component \"#{component}\" for environment \"#{env}\"!"
+          raise error
+        end
+      end
+      build_env['components'].each do |component, config|
+        @required.each do |required_item, _values|
+          build_env['components'][component][required_item] = @required[required_item][build_env['components'][component][required_item]]
+        end
+        config['component_role'] = config['component_role'].gsub('#', component) if config['component_role']
+      end
+      @env_definition = {}
+      build_env['components'].each do |component, config|
+        nodes = []
+        (1..config['count']).each do |n|
+          nodes << node_name(env, component, n)
+        end
+        # build_env['components'][component].merge!(@components[component])
+        build_env['components'][component]['nodes'] = nodes
+      end
+      @env_definition = build_env
+    end
+    # rubocop:enable MethodLength, LineLength
+
+    private
+
+    # rubocop:disable MethodLength
+    def node_name(env, component, instance)
+      name = ''
+      @nodename.each do |i|
+        case i
+        when 'environment'
+          name += env
+        when 'component'
+          name += component
+        when 'instance'
+          name += instance.to_s.rjust(2, '0')
+        else
+          name += i
+        end
+      end
+      name
+    end
+    # rubocop:enable MethodLength
+
+    # rubocop:disable MethodLength, LineLength, CyclomaticComplexity, PerceivedComplexity
+    def validate(templatefile, definitionfile)
+      health = ''
+      templatefile.each do |param, value|
+        definitionfile.each do |component, keys|
+          case
+          when value['array']
+            if keys[param].class == Array
+              keys[param].each do |i|
+                health += "Validation error: #{component}:#{param}\n" unless valid?(i, value['array'])
+              end
+            else
+              health += "Validation error: #{component}:#{param}\n"
+            end
+          when value['hash']
+            keys[param].each do |k, v|
+              health += "Validation error: #{component}:#{param}\n" unless valid?(v, value['hash'][k])
+            end
+          else
+            health += "Validation error: #{component}:#{param}\n" unless valid?(keys[param], value)
+          end
+        end
+      end
+      health
+    end
+    # rubocop:enable MethodLength, LineLength, CyclomaticComplexity, PerceivedComplexity
+
+    # rubocop:disable MethodLength, DoubleNegation, CyclomaticComplexity, PerceivedComplexity, LineLength
+    def valid?(value, validate)
+      if value.nil?
+        false
+      else
+        case validate['type']
+        when 'integer'
+          rng = validate['range'].split('..').map { |d| Integer(d) }
+          (value.class != Fixnum) ? false : Range.new(rng[0], rng[1]).member?(value)
+        when 'string'
+          (value.class != String) ? false : value.match(Regexp.new(validate['match']))
+        when 'IP'
+          (value.class != String) ? false : Resolv::IPv4::Regex.match(value)
+        when 'URL'
+          (value.class != String) ? false : value.match(URI.regexp)
+        when 'boolean'
+          !!value == value
+        else
+          false
+        end
+      end
+    end
+    # rubocop:enable MethodLength, DoubleNegation, CyclomaticComplexity, PerceivedComplexity, LineLength
+
+    # rubocop:disable LineLength
+    def platform_files_exist?
+      fail(IOError, MISSING_PLATFORM) unless File.file?(PLATFORMFILE)
+      unless @provider.nil? # We can't check that everything's present yet...
+        @provider.definition['structure']['require'].each do |required_file|
+          fail(IOError, MISSING_PLATFORM + required_file) unless File.file?(@provider.definition['structure'][required_file]['path'] + required_file + '.yml')
+        end
+      end
+      true
+    end
+    # rubocop:enable LineLength
+  end
+  # rubocop:enable ClassLength
+end

data/lib/vaquero_io/plugin.rb

@@ -0,0 +1,118 @@
+require 'pathname'
+require 'yaml'
+require 'git'
+require 'fileutils'
+
+module VaqueroIo
+  # top level comment
+  class Plugin < Thor
+    include Thor::Actions
+
+    # list of installed providers (includes PWD)
+    # rubocop:disable LineLength
+    desc 'list', DESC_PLUGIN_LIST
+    def list
+      installed_providers.each { |k, v| puts "#{k} (#{v}) #{ENV[PUTENV_PROVIDER] == k ? '<default' : ''}" }
+    end
+    # rubocop:enable LineLength
+
+    desc 'init', DESC_PLUGIN_INIT
+    def init
+      template(TEMPLATE_PROVIDER, PROVIDERFILE)
+    end
+
+    # rubocop:disable LineLength
+    desc 'install LOCATION', DESC_PLUGIN_INSTALL
+    def install(path)
+      latest = get_working_copy(path)
+      if installed_providers.key?(latest['name'])
+        puts "#{latest['name']} already installed"
+      else
+        Dir.mkdir(PROVIDERS_PATH) unless Dir.exist?(PROVIDERS_PATH)
+        FileUtils.cp_r("#{TMP_INSTALL_FOLDER}/.", "#{PROVIDERS_PATH}#{latest['name']}")
+        puts "Successfully installed #{latest['name']} (#{latest['version']})"
+      end if latest != NO_PROVIDER_FILE
+      clear_working_copy
+      fail(IOError, NO_PROVIDER_FILE) if latest == NO_PROVIDER_FILE
+    end
+    # rubocop:enable LineLength
+
+    # rubocop:disable MethodLength, LineLength
+    desc 'update [PROVIDER]', DESC_PLUGIN_UPDATE
+    def update(plugin = '')
+      update_list = {}
+      providers = installed_providers
+      if plugin.empty?
+        update_list = providers
+      else
+        if installed_providers.key?(plugin)
+          update_list[plugin] = providers[plugin]
+        else
+          update_list = NO_PROVIDER_FILE
+        end
+      end
+      update_list.each { |prov, ins_vers| update_plugin(prov, ins_vers) } if update_list != NO_PROVIDER_FILE
+      fail(IOError, NO_PROVIDER_FILE) if update_list == NO_PROVIDER_FILE
+    end
+    # rubocop:enable MethodLength, LineLength
+
+    desc 'remove PROVIDER', DESC_PLUGIN_REMOVE
+    def remove(plugin)
+      if installed_providers.key?(plugin)
+        FileUtils.remove_dir("#{PROVIDERS_PATH}#{plugin}")
+        puts "#{plugin} removed"
+      else
+        fail(IOError, NO_PROVIDER_FILE)
+      end
+    end
+
+    private
+
+    def get_working_copy(path)
+      Git.clone(path, TMP_INSTALL_FOLDER)
+      NO_PROVIDER_FILE_FILE unless File.file?(TMP_INSTALL_PROVIDER)
+      YAML.load_file(TMP_INSTALL_PROVIDER).fetch('provider', NO_PROVIDER_FILE)
+    end
+
+    def clear_working_copy
+      FileUtils.remove_dir(TMP_INSTALL_FOLDER)
+    end
+
+    def installed_providers
+      providers = {}
+      Pathname.glob(LIST_PLUGINS_PATH).each do |prov|
+        plugin = YAML.load_file(prov).fetch('provider')
+        providers[plugin['name']] = plugin['version']
+      end
+      providers
+    end
+
+    def plugin_locations
+      locations = {}
+      Pathname.glob(LIST_PLUGINS_PATH).each do |prov|
+        plugin = YAML.load_file(prov).fetch('provider')
+        locations[plugin['name']] = plugin['location']
+      end
+      locations
+    end
+
+    # rubocop:disable LineLength
+    def update_plugin(plugin, version)
+      locations = plugin_locations
+      latest = get_working_copy(locations[plugin])
+      if latest['version'] != version
+        FileUtils.remove_dir("#{PROVIDERS_PATH}#{plugin}")
+        FileUtils.cp_r("#{TMP_INSTALL_FOLDER}/.", "#{PROVIDERS_PATH}#{latest['name']}")
+        puts "Updated #{plugin} version #{version} -> #{latest['version']}"
+      else
+        puts "#{plugin}#{PLUGINS_CURRENT}"
+      end
+      clear_working_copy
+    end
+    # rubocop:enable LineLength
+
+    def self.source_root
+      File.dirname(__FILE__)
+    end
+  end
+end

data/lib/vaquero_io/provider.rb

@@ -0,0 +1,48 @@
+module VaqueroIo
+  # comment
+  class Provider
+    attr_accessor :provider
+    attr_accessor :definition
+
+    # rubocop:disable LineLength
+    def initialize(use_provider)
+      @provider = resolve_provider(use_provider)
+      @definition = YAML.load_file(PROVIDERS_PATH + @provider + '/' + PROVIDERFILE).fetch('provider')
+      require PROVIDERS_PATH + @provider + '/' + @provider.gsub('-', '_') + '.rb'
+    end
+    # rubocop:enable LineLength
+
+    # rubocop:disable MethodLength, LineLength
+    def new_definition
+      if File.exist?('platform.yml')
+        fail(IOError, PLATFORM_EXISTS)
+      else
+        Pathname.glob(PROVIDERS_PATH + @provider + '/templates/*.yml').each do |prov|
+          path = @definition['structure'][File.basename(prov, '.yml')]['path']
+          if @definition['structure'][File.basename(prov, '.yml')]['path'].nil?
+            path = ''
+          else
+            unless File.directory?(@definition['structure'][File.basename(prov, '.yml')]['path'])
+              FileUtils.mkdir(@definition['structure'][File.basename(prov, '.yml')]['path'])
+            end
+          end
+          FileUtils.cp(prov, path + File.basename(prov))
+        end
+        puts MSG_NEW_SUCCESS
+      end
+    end
+    # rubocop:enable MethodLength, LineLength
+
+    private
+
+    # rubocop:disable LineLength
+    def resolve_provider(provider)
+      if provider.nil?
+        ENV[PUTENV_PROVIDER].nil? ? fail(IOError, NO_PROVIDER) : ENV[PUTENV_PROVIDER]
+      else
+        provider
+      end
+    end
+    # rubocop:enable LineLength
+  end
+end

data/lib/vaquero_io/provision.rb

@@ -0,0 +1,13 @@
+# Basically a dummy placeholder for the provision method that
+# plugins will override
+module VaqueroIo
+  # comment
+  class Platform
+    # comment
+    module Provision
+      def provision(_env)
+        puts 'success'
+      end
+    end
+  end
+end

data/lib/vaquero_io/runner.rb

@@ -0,0 +1,42 @@
+require 'vaquero_io'
+
+module VaqueroIo
+  # wrapper to assist aruba in single process execution
+  class Runner
+    # rubocop:disable LineLength
+    def initialize(argv, stdin = STDIN, stdout = STDOUT, stderr = STDERR, kernel = Kernel)
+      @argv, @stdin, @stdout, @stderr, @kernel = argv, stdin, stdout, stderr, kernel
+    end
+    # rubocop:enable LineLength
+
+    # rubocop:disable MethodLength
+    def execute!
+      exit_code = begin
+        $stderr = @stderr
+        $stdin = @stdin
+        $stdout = @stdout
+
+        VaqueroIo::CLI.start(@argv)
+
+        # Thor::Base#start does not have a return value
+        # assume success if no exception is raised.
+        0
+      rescue StandardError => err
+        # The ruby interpreter would pipe this to STDERR and
+        # exit 1 in the case of an unhandled exception
+        b = err.backtrace
+        b.unshift("#{b.shift}: #{err.message} (#{err.class})")
+        @stderr.puts(b.map { |s| "\tfrom #{s}" }.join("\n"))
+        1
+      ensure
+        # put them back.
+        $stderr = STDERR
+        $stdin = STDIN
+        $stdout = STDOUT
+      end
+      # Proxy exit code back to the injected kernel.
+      @kernel.exit(exit_code)
+    end
+    # rubocop:enable MethodLength
+  end
+end

data/lib/vaquero_io/templates/Providerfile.yml.tt

@@ -0,0 +1,86 @@
+# vaquero: Provider template definition file
+#
+# Complete provider file documentation can be found on the vaquero wiki
+# https://github.com/vaquero-io/vaquero/wiki/Custom-Provider-Plugins
+#
+provider:
+  # define the plugin name that can be used to select this provider from the command line or environmental variable
+  name:
+  version: 0.0.0
+
+  # Repository location for installation and updates
+  location:
+
+  structure:
+
+    platform:
+      # default to present working directory to find platform.yml
+      path:
+
+      # Use of additional reference files is optional (see documentation)
+      #
+      # Example
+      #
+      # references:
+      #   - compute
+      #   - tags
+      #
+      references:
+        -
+
+      params:
+        name:
+          type: string
+          match: 'regex'
+        description:
+          type: string
+          match: 'regex'
+        environments:
+          array:
+            type: string
+            match: 'regex'
+        nodename:
+          array:
+            type: string
+            match: 'regex'
+        pools:
+          count:
+            type: integer
+            range: 1..100
+          runlist:
+            array:
+              type: string
+              match: 'regex'
+          componentrole:
+            type: string
+            match: 'regex'
+          compute:
+            type: string
+            match: 'regex'
+
+        components:
+
+    environment:
+      path: 'environments/'
+
+    compute:
+      path: 'infrastructure/'
+      references:
+      params:
+        ram:
+          type: integer
+          range: 128..262144
+        cpu:
+          type: integer
+          range: 1..16
+        drive:
+          hash:
+            mount:
+              type: string
+              match: 'regex'
+            capacity:
+              type: integer
+              range: 8..2048
+        image:
+          type: string
+          match: 'regex'

data/lib/vaquero_io/version.rb

@@ -0,0 +1,4 @@
+# simple gem version number tracking
+module VaqueroIo
+  VERSION = '0.1.1'
+end

data/lib/vaquero_io.rb

@@ -0,0 +1,43 @@
+require 'thor'
+require 'vaquero_io/messages'
+require 'vaquero_io/config'
+require 'vaquero_io/plugin'
+require 'vaquero_io/provider'
+require 'vaquero_io/platform'
+require 'vaquero_io/build'
+require 'vaquero_io/provision'
+
+# Refer to README.md for use instructions
+module VaqueroIo
+  # Start of main CLI
+  class CLI < Thor
+    package_name 'vaquero_io'
+    map '--version' => :version
+    map '-v' => :version
+
+    desc 'version, -v', DESC_VERSION
+    def version
+      puts VERSION
+    end
+
+    desc 'new', DESC_NEW
+    method_options %w( provider -p ) => :string, :required => true
+    def new
+      VaqueroIo::Provider.new(options[:provider]).new_definition
+    end
+
+    # rubocop:disable LineLength
+    desc 'health [ENVIRONMENT]', DESC_HEALTH
+    method_options %w( provider -p ) => :string
+    def health(env = '')
+      provider = options[:provider] ? VaqueroIo::Provider.new(options[:provider]) : nil
+      # puts HEALTHY if VaqueroIo::Platform.new(VaqueroIo::Provider.new(options[:provider])).healthy?(env)
+      puts HEALTHY if VaqueroIo::Platform.new(provider).healthy?(env)
+    end
+    # rubocop:enable LineLength
+
+    # subcommand in Thor called as registered class
+    register(VaqueroIo::Plugin, 'plugin', 'plugin COMMAND', DESC_PLUGIN)
+    register(VaqueroIo::Build, 'build', 'build TARGET', DESC_BUILD)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+# $LOAD_PATH << '../../lib'
+#
+require 'coveralls'
+Coveralls.wear!

data/vaquero_io.gemspec

@@ -0,0 +1,38 @@
+# rubocop:disable all
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift lib unless $LOAD_PATH.include?(lib)
+require 'vaquero_io/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'vaquero_io'
+  spec.version       = VaqueroIo::VERSION
+  spec.authors       = %w('Nic Cheneweth','Gregory Ruiz-ade')
+  spec.email         = %w('Nic.Cheneweth@thoughtworks.com','gregory.ruiz-ade@activenetwork.com')
+  spec.summary       = 'Automated provisioning of application environments'
+  spec.description   = 'Command line tool to automate the provision and bootstrap of virtual machine application environments'
+  spec.homepage      = 'http://vaquero.io/'
+  spec.license       = 'Apache 2.0'
+
+  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'
+  spec.add_development_dependency 'rubocop', '>= 0.27.0'
+  spec.add_development_dependency 'aruba', '>= 0.6'
+  spec.add_development_dependency 'rspec', '>= 3.0'
+  spec.add_development_dependency 'coveralls', '>= 0.7.9'
+  spec.add_development_dependency 'guard', '>= 2.10.0'
+  spec.add_development_dependency 'guard-rubocop', '>= 1.1.0'
+  spec.add_development_dependency 'guard-rspec', '>= 4.5.0'
+  spec.add_development_dependency 'guard-cucumber', '>= 1.6.0'
+  spec.add_development_dependency 'guard-yard', '>= 2.1.4'
+  # growl functionality in Guardfile depends on growlnotify binary
+  spec.add_development_dependency 'growl'
+  spec.add_development_dependency 'yard', '>= 0.8'
+  spec.add_dependency 'thor', '>= 0.18.0'
+  spec.add_dependency 'git', '>= 1.2.0'
+end
+# rubocop:enable all