zergrush 0.0.1

data/features/hive.feature

@@ -0,0 +1,227 @@
+Feature: Hive
+    When I init, verify list and import hive configs
+    As a CLI
+    I want to see success
+
+    Scenario: Initializing hive
+        When I run `zerg init`
+            Then the following files should exist:
+                | .hive/helloworld.ke | .hive/helloaws.ke | 
+            Then the file ".hive/helloworld.ke" should contain:
+                """
+                {
+                    "instances": 3,
+                    "tasks": [
+                        {
+                            "type": "shell",
+                            "inline": "echo \"ZERG RUSH!\""
+                        }        
+                    ],
+                    "vm": {
+                        "driver": {
+                            "drivertype": "vagrant",
+                            "providertype": "virtualbox",
+                            "provider_options": [
+                                "virtualbox.gui = false",
+                                "virtualbox.memory = 256",
+                                "# adjust for DNS weirdness in ubuntu 12.04",
+                                "virtualbox.customize ['modifyvm', :id,  '--natdnsproxy1', 'off']",
+                                "virtualbox.customize ['modifyvm', :id,  '--natdnshostresolver1', 'off']",
+                                "# set virtio type on the NIC driver. Better performance for large traffic bursts",
+                                "virtualbox.customize ['modifyvm', :id,  '--nictype1', 'virtio']",
+                                "virtualbox.customize ['modifyvm', :id,  '--nictype2', 'virtio']",
+                                "virtualbox.customize ['modifyvm', :id,  '--nictype3', 'virtio']"
+                            ]
+                        },
+                        "basebox": "http://files.vagrantup.com/precise32.box",
+                        "private_network": true
+                    }
+                }
+                """
+
+            Then the file ".hive/helloaws.ke" should contain:
+                """
+                {
+                    "instances": 3,
+                    "tasks": [
+                        {
+                            "type": "shell",
+                            "inline": "echo \"ZERG RUSH PRIME!\""
+                        }        
+                    ],
+                    "vm": {
+                        "driver": {
+                            "drivertype": "vagrant",
+                            "providertype": "aws",
+                            "provider_options": [
+                                "aws.instance_type = 't1.micro'",
+                                "aws.access_key_id = \"#{ENV['AWS_ACCESS_KEY_ID']}\"",
+                                "aws.secret_access_key = \"#{ENV['AWS_SECRET_ACCESS_KEY']}\"",
+                                "aws.keypair_name = \"#{ENV['AWS_KEY_PAIR']}\"",
+                                "aws.ami = 'ami-3fec7956'",
+                                "aws.region = 'us-east-1'",
+                                "aws.security_groups = [ \"#{ENV['AWS_SECURITY_GROUP']}\" ]",
+                                "override.ssh.username = 'ubuntu'",
+                                "override.ssh.private_key_path = \"#{ENV['AWS_PRIVATE_KEY_PATH']}\""
+                            ]
+                        },
+                        "basebox": "https://github.com/mitchellh/vagrant-aws/raw/master/dummy.box",
+                        "private_network": false
+                    }
+                }
+                """
+            And the exit status should be 0
+
+    @no-clobber
+    Scenario: Verifying hive
+        When I run `zerg hive verify`
+        Then the output should contain: 
+            """
+            SUCCESS!
+            """
+        And the exit status should be 0
+
+        When I run `zerg hive list`
+        Then the output should contain: 
+            """
+            2 tasks in current hive:
+            [
+                [0] "helloaws",
+                [1] "helloworld"
+            ]
+            """
+        And the exit status should be 0
+
+    @no-clobber
+    Scenario: Importing a hive task
+        Given a file named "arubatask.ke" with:
+            """
+            {
+                "instances": 1,
+                "tasks": [
+                    {
+                        "type": "shell",
+                        "inline": "echo \"ARRRRRRRUUUUUBAAAAAAAA!\""
+                    }        
+                ],
+                "vm": {
+                    "driver": {
+                        "drivertype": "vagrant",
+                        "providertype": "aws",
+                        "provider_options": [
+                            "aws.instance_type = 't1.micro'"
+                        ]
+                    },
+                    "basebox": "https://github.com/mitchellh/vagrant-aws/raw/master/dummy.box",
+                    "private_network": false
+                }
+            }
+            """
+        
+        When I run `zerg hive import arubatask.ke`
+        Then the output should contain:
+            """
+            SUCCESS!
+            """
+        And the exit status should be 0
+
+        When I run `zerg hive import arubatask.ke`
+        Then the output should contain:
+            """
+            ERROR: 'arubatask.ke' already exists in hive!
+            """
+        And the exit status should be 1
+
+        When I run `zerg hive import arubatask.ke --force`
+        Then the output should contain:
+            """
+            SUCCESS!
+            """
+        And the exit status should be 0
+
+    @no-clobber
+    Scenario: Listing hive tasks
+        When I run `zerg hive list`
+        Then the output should contain: 
+            """
+            3 tasks in current hive:
+            [
+                [0] "arubatask",
+                [1] "helloaws",
+                [2] "helloworld"
+            ]
+            """
+        And the exit status should be 0
+
+    Scenario: Overriding hive location
+        Given a directory named "overriden/hive/dir"
+        Given I set the environment variables to:
+            | variable           | value                |
+            | HIVE_CWD           | ./overriden/hive/dir |
+        When I run `zerg init`
+        Then the following files should exist:
+            | overriden/hive/dir/.hive/helloworld.ke | overriden/hive/dir/.hive/helloaws.ke | 
+        Then the file "overriden/hive/dir/.hive/helloworld.ke" should contain:
+            """
+            {
+                "instances": 3,
+                "tasks": [
+                    {
+                        "type": "shell",
+                        "inline": "echo \"ZERG RUSH!\""
+                    }        
+                ],
+                "vm": {
+                    "driver": {
+                        "drivertype": "vagrant",
+                        "providertype": "virtualbox",
+                        "provider_options": [
+                            "virtualbox.gui = false",
+                            "virtualbox.memory = 256",
+                            "# adjust for DNS weirdness in ubuntu 12.04",
+                            "virtualbox.customize ['modifyvm', :id,  '--natdnsproxy1', 'off']",
+                            "virtualbox.customize ['modifyvm', :id,  '--natdnshostresolver1', 'off']",
+                            "# set virtio type on the NIC driver. Better performance for large traffic bursts",
+                            "virtualbox.customize ['modifyvm', :id,  '--nictype1', 'virtio']",
+                            "virtualbox.customize ['modifyvm', :id,  '--nictype2', 'virtio']",
+                            "virtualbox.customize ['modifyvm', :id,  '--nictype3', 'virtio']"
+                        ]
+                    },
+                    "basebox": "http://files.vagrantup.com/precise32.box",
+                    "private_network": true
+                }
+            }
+            """
+
+        Then the file "overriden/hive/dir/.hive/helloaws.ke" should contain:
+            """
+            {
+                "instances": 3,
+                "tasks": [
+                    {
+                        "type": "shell",
+                        "inline": "echo \"ZERG RUSH PRIME!\""
+                    }        
+                ],
+                "vm": {
+                    "driver": {
+                        "drivertype": "vagrant",
+                        "providertype": "aws",
+                        "provider_options": [
+                            "aws.instance_type = 't1.micro'",
+                            "aws.access_key_id = \"#{ENV['AWS_ACCESS_KEY_ID']}\"",
+                            "aws.secret_access_key = \"#{ENV['AWS_SECRET_ACCESS_KEY']}\"",
+                            "aws.keypair_name = \"#{ENV['AWS_KEY_PAIR']}\"",
+                            "aws.ami = 'ami-3fec7956'",
+                            "aws.region = 'us-east-1'",
+                            "aws.security_groups = [ \"#{ENV['AWS_SECURITY_GROUP']}\" ]",
+                            "override.ssh.username = 'ubuntu'",
+                            "override.ssh.private_key_path = \"#{ENV['AWS_PRIVATE_KEY_PATH']}\""
+                        ]
+                    },
+                    "basebox": "https://github.com/mitchellh/vagrant-aws/raw/master/dummy.box",
+                    "private_network": false
+                }
+            }
+            """
+        And the exit status should be 0

data/features/support/setup.rb

@@ -0,0 +1,4 @@
+require 'aruba/cucumber'
+Before do
+    @aruba_timeout_seconds = 120
+end

data/features/task.feature

@@ -0,0 +1,31 @@
+Feature: Tasks
+    When I clean a task
+    As a CLI
+    I want to see success 
+      
+    @no-clobber
+    Scenario: Cleaning a task
+        When I run `zerg init`
+        When I run `zerg clean helloworld`
+        Then the output should contain:
+        """
+        SUCCESS!
+        """
+        And the exit status should be 0
+
+    Scenario: Cleaning a task that does not exist
+        When I run `zerg init`
+        When I run `zerg clean HRRGRHBGRGHLURGH`
+        Then the output should contain:
+        """
+        ERROR: Task HRRGRHBGRGHLURGH not found in current hive!
+        """
+        And the exit status should be 1
+
+    Scenario: Cleaning a task without hive
+        When I run `zerg clean helloaws`
+        Then the output should contain:
+        """
+        ERROR:
+        """
+        And the exit status should be 1

data/lib/zerg.rb

@@ -0,0 +1,30 @@
+#--
+
+# Copyright 2014 by MTN Sattelite Communications
+#
+# 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.
+#++
+
+require "zerg/hive"
+require "zerg/runner"
+require "zerg/driver_renderer"
+
+module Zerg
+  
+end

data/lib/zerg/cli.rb

@@ -0,0 +1,85 @@
+#--
+
+# Copyright 2014 by MTN Sattelite Communications
+#
+# 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.
+#++
+
+require 'thor'
+require 'zerg'
+require 'zerg/generators/hivegen'
+
+module Zerg
+    class HiveCLI < Thor
+        class_option :force, :type => :boolean, :banner => "force overwrite of files" 
+
+        # hack (https://github.com/erikhuda/thor/issues/261#issuecomment-16880836)
+        # to get around thor showing klass name snake case in subcommand help (instead of subcommand name) 
+        package_name "hive"
+        def self.banner(command, namespace = nil, subcommand = false)
+            "#{basename} #{@package_name} #{command.usage}"
+        end
+
+        desc "verify", "verifies hive tasks without loading them"
+        def verify
+            puts Zerg::Hive.verify
+        end
+
+        desc "list", "lists hive tasks"
+        def list
+            puts Zerg::Hive.list
+        end
+
+        desc "import [FILE]", "import a .ke file into the hive folder"
+        def import(file)
+            puts Zerg::Hive.import(file, options[:force])
+        end
+
+        desc "remove [TASK]", "remove a task from hive"
+        def remove(file)
+            puts Zerg::Hive.remove(file, options[:force])
+        end
+    end
+
+    class CLI < Thor 
+        class_option :force, :type => :boolean, :banner => "force overwrite of files" 
+        class_option :debug, :type => :boolean, :banner => "add debug option to driver"  
+
+        def self.exit_on_failure?
+            true
+        end
+
+        desc "init", "initializes new hive"
+        def init
+            puts Zerg::Generators::HiveGen.start
+        end
+
+        desc "rush [TASK]", "runs a task from hive"
+        def rush(task)
+            puts Zerg::Runner.rush(task, options[:debug])
+        end
+
+        desc "clean [TASK]", "cleans a task"
+        def clean(task)
+            puts Zerg::Runner.clean(task, options[:debug])
+        end
+          
+        register(HiveCLI, 'hive', 'hive [COMMAND]', 'Manage hive - a collection of task descriptions.')
+    end
+end

data/lib/zerg/driver_renderer.rb

@@ -0,0 +1,190 @@
+#--
+
+# Copyright 2014 by MTN Sattelite Communications
+#
+# 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.
+#++
+
+require 'awesome_print'
+require 'fileutils'
+require 'erb'
+require 'ostruct'
+require 'securerandom'
+
+module Zerg
+    class DriverRenderer
+        class Erbalize < OpenStruct
+            def self.erbalize_hash(template, sources)
+                Erbalize.new(sources).render(template)
+            end
+
+            def render(template)
+                ERB.new(template, nil, '-').result(binding)
+            end
+        end
+
+        # generate a virtualbox - compatible MAC address
+        def generateMACAddress()
+            firstChar = (0..255).map(&:chr).select{|x| x =~ /[0-9A-Fa-f]/}.sample(1).join
+            secondChar = (0..255).map(&:chr).select{|x| x =~ /[02468ACEace]/}.sample(1).join
+            restOfChars = (0..255).map(&:chr).select{|x| x =~ /[0-9A-Fa-f]/}.sample(10).join
+            return "#{firstChar}#{secondChar}#{restOfChars}"
+        end
+
+        def initialize(vm, name, instances, synced_folders, tasks )
+            @vm = vm
+            @name = name
+            @instances = instances
+            @tasks = tasks
+            @synced_folders = synced_folders
+        end
+
+        def render
+            puts ("Rendering driver templates...")
+
+            # TODO: generalize this processing better
+            abort("ERROR: Driver type '#{@vm["driver"]["drivertype"]} is not supported.") unless (@vm["driver"]["drivertype"] == "vagrant")
+
+            # load the template files
+            main_template = File.open(File.join("#{File.dirname(__FILE__)}", "..", "..", "data", "driver", "#{@vm["driver"]["drivertype"]}", "main.template"), 'r').read
+
+            # load the provider top level template
+            provider_parent_template = File.open(File.join("#{File.dirname(__FILE__)}", "..", "..", "data", "driver", "#{@vm["driver"]["drivertype"]}", "provider.template"), 'r').read
+
+            # load the machine details template
+            machine_template = File.open(File.join("#{File.dirname(__FILE__)}", "..", "..", "data", "driver", "#{@vm["driver"]["drivertype"]}", "machine.template"), 'r').read
+
+            # load the bridge details template
+            bridge_template = File.open(File.join("#{File.dirname(__FILE__)}", "..", "..", "data", "driver", "#{@vm["driver"]["drivertype"]}", "bridging.template"), 'r').read
+
+            # load the host only network details template
+            hostonly_template = File.open(File.join("#{File.dirname(__FILE__)}", "..", "..", "data", "driver", "#{@vm["driver"]["drivertype"]}", "hostonly.template"), 'r').read
+
+            # render templates....
+            # render provider details to string
+            # 
+            # render provider details into a string
+            provider_details_array = @vm["driver"]["provider_options"]
+            provider_details = ""
+            for index in 0..provider_details_array.length - 1
+                provider_details += "\t\t" + provider_details_array[index] + "\n"
+            end
+
+            # render provider parent
+            sources =  {
+                :provider => @vm["driver"]["providertype"],
+                :provider_specifics => provider_details
+            }
+            provider_parent_string = Erbalize.erbalize_hash(provider_parent_template, sources)
+
+            # render machine template
+            all_macs = Array.new
+            all_machines = ""
+            for index in 0..@instances - 1
+
+                # last ip octet offset for host only networking
+                ip_octet_offset = index
+
+                # inject randomized node_name into chef_client tasks
+                @tasks.each { |task| 
+                    if task["type"] == "chef_client"
+                        task["node_name"] = "zergling_#{index}_#{SecureRandom.hex(20)}"
+                    end
+                }
+
+                # tasks array rendered to ruby string. double encoding to escape quotes and allow for variable expansion
+                tasks_array = @tasks.to_json.to_json
+
+                # do we need the bridging template as well?
+                bridge_section = nil
+                if @vm.has_key?("bridge_description")
+                    # mac address to use?
+                    new_mac = ""
+                    begin
+                        new_mac = generateMACAddress()
+                    end while all_macs.include? new_mac
+
+                    sources = {
+                        :machine_mac => new_mac,
+                        :bridged_eth_description => @vm["bridge_description"]
+                    }
+                    bridge_section = Erbalize.erbalize_hash(bridge_template, sources)
+                end
+
+                # do we need the host only template as well?
+                hostonly_section = nil
+                if @vm["private_network"] == true
+                    sources = {
+                        :machine_name => "zergling_#{index}",
+                        :last_octet => ip_octet_offset + 4, # TODO: this is probably specific to virtualbox networking
+                    }
+                    hostonly_section = Erbalize.erbalize_hash(hostonly_template, sources)
+                end
+
+                # blah
+                folder_definitions = nil
+                if @synced_folders != nil
+                    folder_definitions = ""
+                    @synced_folders.each { |folder| 
+                        other_options = ""
+                        if folder.has_key?("options")
+                            folder["options"].each { |option|
+                                option.each do |key, value|
+                                    if value.is_a?(String)
+                                        other_options += ", :#{key} => \"#{value}\""
+                                    else
+                                        other_options += ", :#{key} => #{value}" 
+                                    end
+                                end
+                            } 
+                        end
+
+                        folder_definition = "zergling_#{index}.vm.synced_folder \"#{folder['host_path']}\", \"#{folder['guest_path']}\""
+                        folder_definition = "#{folder_definition}#{other_options}" unless other_options.empty?()
+                        folder_definitions += "\t\t#{folder_definition}\n"
+                    }
+                end
+
+                sources = {
+                    :machine_name => "zergling_#{index}",
+                    :bridge_specifics => bridge_section,
+                    :hostonly_specifics => hostonly_section,
+                    :tasks_array => tasks_array,
+                    :sync_folders_array => folder_definitions 
+                }.delete_if { |k, v| v.nil? }
+
+                machine_section = Erbalize.erbalize_hash(machine_template, sources)
+                all_machines += "\n#{machine_section}"
+            end
+
+            sources = {
+                :provider_section => provider_parent_string,
+                :basebox_path => @vm["basebox"],
+                :box_name => "zergling_#{@name}_#{@vm["driver"]["providertype"]}",
+                :vm_defines => all_machines
+            }
+            full_template = Erbalize.erbalize_hash(main_template, sources)
+
+            # write the file
+            puts ("Writing #{File.join("#{Dir.pwd}", ".hive", "driver", @vm["driver"]["drivertype"], @name, "Vagrantfile")}...")
+            FileUtils.mkdir_p(File.join("#{Dir.pwd}", ".hive", "driver", @vm["driver"]["drivertype"], @name))
+            File.open(File.join("#{Dir.pwd}", ".hive", "driver", @vm["driver"]["drivertype"], @name, "Vagrantfile"), 'w') { |file| file.write(full_template) }
+        end
+    end
+end