vagrant-hmurca 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6e1d3d8b8c0364076264a98dfb745de017382bae
+  data.tar.gz: 820fe62cfe4b5ccbe417c61d0867ca08e3401f58
+SHA512:
+  metadata.gz: 1d11604f05257f785cb599128a9a4b4f1bd0709579163ca15d997e793c62e33aaa06c7c7fc75dacecdd8f3cdf9df5ded0cd383bd3376a82a9adfff79143bebfb
+  data.tar.gz: ea182236bd13693bcbf1d79077acfb558c9e01116c5b0913b0ee4553583206bfd46d5eab7bc157e9957cd83f1337238576a397032b4388c19e118cc747600007

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+group :development do
+  gem "vagrant", :git => "https://github.com/mitchellh/vagrant.git", :tag => "v1.6.3"
+end
+
+group :plugins do
+  gemspec
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Kris Kovalik
+
+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,31 @@
+# Hmurca's Vagrant Kit
+
+This toolkit (codename *Hobo*) is a *Vagrant* plugin that wraps and simplifies
+building of *Hmurca* powered development formations.
+
+## Installation
+
+Install this gem as a *Vagrant* plugin.
+
+    $ vagrant plugin install vagrant-hmurca
+
+## Usage
+
+Check project documentation [here](http://docs.hmurca.com/en/latest/vagrant-hmurca.html).
+
+## End-to-end testing
+
+Because there's not mean to run end-to-end test automatically (for example Vagrant
+doesn't work on drone.io that we use for CI testing), you should test it manually
+before making any changes. There's a test `Vagrantfile` and `hmurca.conf` in project
+root directory, use them to bring the formation up and check if everything works as
+expected. Run the following from project root directory:
+
+    $ bundle exec vagrant up
+
+## Contributing
+
+1. Work on your changes in a feature branch.
+2. Make sure that tests are passing.
+3. Send a pull request.
+4. Wait for feedback.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs.push "lib"
+  t.pattern = "test/*_test.rb"
+  t.verbose = false
+end
+
+task :default => :test

data/Vagrantfile

@@ -0,0 +1,15 @@
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+# WARNING: Never ever edit this file if you want Hmurca Kit to work properly!
+
+ui = Vagrant::UI::Colored.new
+
+begin
+  require 'vagrant-hmurca'
+  Vagrant::Hmurca.configure!
+rescue LoadError => err
+  ui.error("Oops! Looks like `vagrant-hmurca' plugin is not installed!")
+  ui.error("Execute `vagrant plugin install vagrant-hmurca` to fix this error...")
+  exit(1)
+end

data/dot_gitignore

@@ -0,0 +1,2 @@
+.vagrant
+*.conf.sample

data/hmurca.conf

@@ -0,0 +1,12 @@
+# hmurca.conf - Testing configuration.
+
+domain example.dev
+base-box cargomedia/debian-7-amd64-plain
+sync-folder . /vagrant
+use-nfs yes
+
+node
+  name all-in-one
+  cpus 1
+  memory 1024
+  forward-port 80 8080

data/hmurca.conf.sample

@@ -0,0 +1,32 @@
+# hmurca.conf - The Hmurca Vagrant Kit configuration file.
+#
+# If this file is named `hmurca.conf.sample`, copy it to `hmurca.conf`
+# and adjust settings specific for your host machine or your own preferences.
+
+# General setup
+#-------------------------------------------------------------------------------
+
+# Domain name used by this formation.
+domain example
+
+# Name of the base box from Vagrant Cloud.
+base-box hmurca/debian75-x64
+
+# Configure synchronized folders from host to guests...
+sync-folder . /vagrant
+
+# Use Network File System to share folders?
+use-nfs yes
+
+# Nodes configuration...
+#-------------------------------------------------------------------------------
+
+node
+  # Short host name of the node.
+  name all-in-one
+  # The number of virtual processors.
+  cpus 2
+  # The number of virtual memory limit.
+  memory 1024
+  # Configure which ports to forward from guest to host...
+  forward-port 80 8080

data/lib/vagrant-hmurca.rb

@@ -0,0 +1 @@
+require 'vagrant/hmurca'

data/lib/vagrant/hmurca.rb

@@ -0,0 +1,33 @@
+require "vagrant"
+require "booby"
+
+module Vagrant
+  module Hmurca
+    require "vagrant/hmurca/version"
+    require "vagrant/hmurca/errors"
+    require "vagrant/hmurca/config_parser"
+
+    # Internal: Hmurca vagrant plugin.
+    class Plugin < Vagrant.plugin(2)
+      name "Hmurca"
+      description "Hmurka's Vagrant Kit"
+
+      command "hmurca", primary: true do
+        require "vagrant/hmurca/command"
+        Command
+      end
+    end
+
+    # Public: Sets up vagrant configuration.
+    def self.configure!
+      begin
+        config_file = File.join(Dir.pwd, "hmurca.conf")
+        $CONF = ConfigParser.parse_file(config_file)
+        load(File.expand_path("../hmurca/vagrantfile.rb", __FILE__))
+      rescue ParserError, Errno::ENOENT => err
+        $stderr.write("ERROR: #{err.to_s}\n")
+        exit(1)
+      end
+    end
+  end
+end

data/lib/vagrant/hmurca/command.rb

@@ -0,0 +1,75 @@
+require "thor"
+
+module Vagrant
+  module Hmurca
+    # Internal: Files generator for hmurca default command.
+    class Generator < Thor::Group
+      include Thor::Actions
+
+      argument :domain
+      argument :project_root, :optional => true, :default => "."
+
+      def self.source_root
+        File.expand_path("../templates", __FILE__)
+      end
+
+      def create_project_root
+        empty_directory(project_root)
+      end
+
+      def create_hmurca_conf_sample
+        target = File.join(project_root, "hmurca.conf.sample")
+        template("hmurca.conf.sample.tt", target)
+      end
+
+      def copy_dot_gitignore
+        target = File.join(project_root, ".gitignore")
+        copy_file("dot_gitignore", target)
+      end
+
+      def copy_vagrantfile
+        target = File.join(project_root, "Vagrantfile")
+        copy_file("Vagrantfile", target)
+      end
+    end
+
+    # Internal: Hmurca command that generates project scaffold.
+    class Command < Vagrant.plugin(2, :command)
+      def self.synopsis
+        "initializes hmurca-powered project"
+      end
+
+      def execute
+        argv = parse_options(option_parser)
+
+        if argv.empty?
+          @env.ui.error "You must specify domain name for development formation."
+          exit(1)
+        end
+
+        if argv.size > 2
+          @env.ui.error "Too many actual arguments."
+          exit(1)
+        end
+
+        Generator.start(argv)
+      end
+
+      def option_parser
+        OptionParser.new do |o|
+          o.banner = "Usage: vagrant hmurca DOMAIN [ROOT]"
+
+          o.on("-h", "--help", "Print this help.") do
+            safe_puts(o.help)
+            exit(0)
+          end
+
+          o.on("-p", "--plugin-version", "Print version of installed Hmurca Kit.") do
+            safe_puts("Hmurca Vagrant Kit #{Vagrant::Hmurca::VERSION}")
+            exit(0)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/vagrant/hmurca/config_parser.rb

@@ -0,0 +1,225 @@
+module Vagrant
+  module Hmurca
+    # Public: Processor that handles node definition groups.
+    class NodeGroupProcessor
+      ARITY = {
+        'name'         => 1,
+        'cpus'         => 1,
+        'memory'       => 1,
+        'forward-port' => 2,
+      }
+
+      attr_reader :name, :cpus, :memory, :forward_ports
+
+      def initialize(line_no, name=nil)
+        @name          = name
+        @forward_ports = {}
+
+        return unless name
+        raise InvalidNodeNameError.new(name, line_no) unless valid_name?(name)
+      end
+
+      def process(line_no, cmd, *args)
+        case cmd
+        when "name"
+          n = args.first
+          raise InvalidNodeNameError.new(n, line_no) unless valid_name?(n)
+          @name = n
+        when "cpus"
+          @cpus = parse_int(args.first, line_no)
+        when "memory"
+          @memory = parse_int(args.first, line_no)
+        when "forward-port"
+          guest, host = parse_int(args[0], line_no), parse_int(args[1], line_no)
+
+          if @forward_ports[host]
+            raise NodeForwardPortDuplicatedError.new(host)
+          end
+
+          @forward_ports[host] = guest
+        else
+          return false
+        end
+
+        true
+      end
+
+      # Internal: Validates post-parsing constraints, like presence checking, etc.
+      #
+      # Returns itself.
+      def validate!
+        raise NoNodeNameSpecifiedError unless self.name
+        raise NoNodeCpusCountSpecifiedError.new(name) unless self.cpus
+        raise NoNodeMemorySizeSpecifiedError.new(name) unless self.memory
+
+        return self
+      end
+
+      # Internal: Checks if given node name is valid.
+      #
+      # name - The String node name to check.
+      #
+      # Return true if node name is valid.
+      def valid_name?(name)
+        name =~ /^[\w\d\-]+$/
+      end
+
+      # Internal: Parses given string value and converts it to integer if
+      # it's possible. If given value is not a valid integer, it raises
+      # an error.
+      #
+      # v       - The String value to covnert.
+      # line_no - The Integer number of the current parsed line.
+      #
+      # Returns converted int value.
+      # Raises InvalidIntegerValueError if value can't be converted.
+      def parse_int(v, line_no)
+        v_int = v.to_i
+        raise InvalidIntegerValueError.new(v, line_no) if v_int.to_s != v
+        v_int
+      end
+    end
+
+    # Public: Processor for top level configuration.
+    class GeneralProcessor
+      ARITY = {
+        'domain'      => 1,
+        'base-box'    => 1,
+        'sync-folder' => 2,
+        'use-nfs'     => 1
+      }
+
+      attr_reader :domain, :base_box, :sync_folders, :use_nfs, :nodes
+
+      def initialize
+        @nodes        = []
+        @sync_folders = []
+      end
+
+      def process(line_no, cmd, *args)
+        case cmd
+        when 'domain'
+          d = args.first
+          raise InvalidDomainNameError.new(d, line_no) unless valid_domain?(d)
+          @domain = d
+        when 'base-box'
+          b = args.first
+          @base_box = b
+        when 'sync-folder'
+          host, guest = *args
+
+          unless File.directory?(host)
+            raise SyncedFolderNotFoundError.new(host, line_no)
+          end
+
+          @sync_folders << [host, guest]
+        when 'use-nfs'
+          @use_nfs = parse_bool(args.first, line_no)
+        when 'node'
+          if args.size > 1
+            raise Booby::InvalidNumberOfParametersError.new(
+              "0 or 1", args.size, cmd, line_no
+              )
+          end
+
+          @nodes << (p = NodeGroupProcessor.new(line_no, *args))
+          return p
+        else
+          return false
+        end
+
+        true
+      end
+
+      # Public: Produces reverse domain name to use as a box prefix.
+      def name_as_prefix
+        return self.domain.split('.').reverse.join('.')
+      end
+
+      # Internal: Validates post-parsing constraints, like presence checking, etc.
+      #
+      # Returns itself.
+      def validate!
+        raise NoDomainSpecifiedError unless self.domain
+
+        # Validate each node separately...
+        self.nodes.each(&:validate!)
+
+        # Check for duplicated nodes...
+        # XXX: Yes this way of checking might be slow, but who cares with max
+        # 10 defined nodes?
+        unique_nodes = {}
+        self.nodes.each do |node|
+          name = node.name
+          raise NodeDuplicatedError.new(name) if unique_nodes[name]
+          unique_nodes[name] = true
+        end
+
+        # Check for duplicated forward ports...
+        # XXX: Same here in terms of efficiency.
+        unique_ports = {}
+        self.nodes.each do |node|
+          node.forward_ports.keys.each do |port|
+            raise NodeForwardPortDuplicatedError.new(port) if unique_ports[port]
+            unique_ports[port] = true
+          end
+        end
+
+        return self
+      end
+
+      # Internal: Checks weather given domain name is valid or not.
+      #
+      # domain - The String domain name to check.
+      #
+      # Returns true if domain name is valid.
+      def valid_domain?(domain)
+        domain =~ /^[a-z0-9]+([\-\.]{1}[a-z0-9]+)*\.[a-z]{2,5}(:[0-9]{1,5})?(\/.*)?$/ix
+      end
+
+      # Internal: Converts given string value to boolean. If value isn't one
+      # of 'yes' or 'no', then it raises an error.
+      #
+      # v       - The String value to covnert.
+      # line_no - The Integer number of the current parsed line.
+      #
+      # Returns true if value equals 'yes', false if 'no'.
+      # Raises InvalidBooleanValueError if value can't be converted.
+      def parse_bool(v, line_no)
+        case v
+        when "yes"
+          true
+        when "no"
+          false
+        else
+          raise InvalidBooleanValueError.new(v, line_no)
+        end
+      end
+    end
+
+    # Public: Global entry point to config parser features.
+    module ConfigParser
+      PROCESSOR = GeneralProcessor
+
+      # Public: Loads given file and parses it.
+      #
+      # fname - The String name of the config file.
+      #
+      # Returns filled processor.
+      def self.parse_file(fname)
+        p = Booby.open(fname)
+        p.parse_with(PROCESSOR).validate!
+      end
+
+      # Public: Parses given source of the config file.
+      #
+      # str - The String source to parse.
+      #
+      # Returns filled processor.
+      def self.parse_string(str)
+        p = Booby.prepare(str)
+        p.parse_with(PROCESSOR).validate!
+      end
+    end
+  end
+end