gonzo 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c6de463660b7b19173f1c55cc959da789352175e
-  data.tar.gz: 5467643687ac220822d5401813c2871e669afe91
+  metadata.gz: 9073924988a4eece01433e99a9ebd3f969485d4d
+  data.tar.gz: 7db3c68d6a6cc4e5acbf49b3ea4b3fe12b5661c9
 SHA512:
-  metadata.gz: b525b04275760a01f3ffdfbe2fa76a6a72beb05f5badb482e3ac43cc1dee28f9ac55e7878ab923ddcc2dfb0dd092f284bd18e38758f9b4dfe5693f700a5e7979
-  data.tar.gz: d6de87214e480a3f41edb25b145d4591bb2a9c95e0adf9176e32cf3d83467e264e8c59e7e155f972eb10f37fd250852c4f3626249488d0095c75883a58e634b8
+  metadata.gz: 69703ec5ea2d82fe6e7e9952ebe9b1637f2614ae41d77228cb355132b37f7250e4a9c04a37a8802c3fd3ebad84af352c1f6e60e5dec89b506c74f291d2e72c81
+  data.tar.gz: ccc1869b11e2ada68a2dd259726b57bcbab0dbdc273433b29e09c66bdecc855f34377ecd3c9fd972605e19ab54287368bbd549222d9516013848525a98e9adde

data/README.md

@@ -22,7 +22,7 @@ gem 'gonzo'
 
 ## Usage
 
-At the root of your project, you'll need to create a `.gonzo.yml` file. This is where you'll configure VMs for Gonzo. You'll need to configure a supported provider. As of right now, the only supported provider is `vagrant`. The top-level key will be the name of the provider. Here's an example `.gonzo.yml` that contains a single VM:
+At the root of your project, you'll need to create a `.gonzo.yml` file. This is where you'll configure VMs for Gonzo. You'll need to configure a supported provider. As of right now, the only supported providers are `vagrant` and `docker`. The top-level key will be the name of the provider. Here's an example `.gonzo.yml` that contains a single VM:
 
 ```yaml
 ---
@@ -83,7 +83,7 @@ Gonzo will aggregate the exit statuses from all VMs and exit 1 if any of them fa
 
 ### Commands
 
-Commands will be run sequentially inside the directory where your `.gonzo.yml` file is. The `vagrant` provider copies the directory to `/tmp/gonzo` instead of running in `/vagrant` to avoid changing the project in flight. If you want to retrieve test results or generated binaries, simply add a command to copy them into `/vagrant` at the end of your run:
+Commands will be run sequentially inside the directory where your `.gonzo.yml` file is. The `vagrant` provider copies the directory to `/tmp/gonzo` instead of running in `/gonzo` to avoid changing the project in flight. If you want to retrieve test results or generated binaries, simply add a command to copy them into `/gonzo` at the end of your run:
 
 ```yaml
 ---
@@ -94,9 +94,62 @@ Commands will be run sequentially inside the directory where your `.gonzo.yml` f
     commands:
       - 'puppet module install puppetlabs-strings'
       - 'puppet strings'
-      - 'cp -r doc /vagrant'
+      - 'cp -r doc /gonzo'
 ```
 
 ### Environment Variables
 
 The `env` key allows you to pass environment variables to your commands. The key must be the variable name, and the value the value you wish to assign to that variable.
+
+## Providers
+
+Gonzo has the ability to support multiple providers. Each provider defines the options available in `.gonzo.yml`. The working directory will be available in the VM/container at `/gonzo` but will build in `/tmp/gonzo` as to not make destructive changes to the project.
+
+All providers implement the `env` and `commands` parameters.
+
+- `env`: The `env` parameter takes a hash of variable names and values that should be available to the commands defined in the `commands` parameter.
+
+- `commands`: The `commands` parameter takes an array of commands to be executed inside the VM/container.
+
+When defining multiple execution environments with multiple providers, they will execute serially:
+
+```yaml
+---
+  docker:
+    image: 'centos:centos7'
+    env:
+      PUPPET_VERSION: '3.8.0'
+    commands:
+      - 'yum -y install rubygem-bundler'
+      - 'bundle install --path vendor'
+      - 'bundle exec rake spec'
+  vagrant:
+    box: 'puppetlabs/centos-7.0-64-puppet'
+    env:
+      PUPPET_VERSION: '4.1.0'
+    commands:
+      - 'puppet module install puppetlabs-strings'
+      - 'puppet strings'
+      - 'cp -r doc /gonzo'
+```
+
+The example above will run the `docker` provider first, followed by the `vagrant` provider.
+
+### Docker
+
+The Docker provider requires the `image` parameter to be defined in `.gonzo.yml`. This tells `docker` what image to run the commands in. If the image is not available, `docker` will try and download it.
+
+#### Available Parameters:
+
+- `image`: The image that `docker` should use to run the commands defined in the `commands` section.
+- `user`: The user under which the commands defined in the `command` array should be run. This user must exist in the container for the command to succeed.
+
+### Vagrant
+
+The Vagrant provider requires the `box` paramater to be defined in `.gonzo.yml`.
+
+#### Available Parameters:
+
+- `box`: The Vagrant box that should be used.
+- `box_url`: The URL for the Vagrant box specified in the `box` parameter. If the `box` is not available on the system, this tells Vagrant where to download the box from.
+ i

data/bin/gonzo

@@ -4,4 +4,6 @@ require 'gonzo'
 
 project = ARGV.last || '.'
 
-Gonzo::Runner.new(Gonzo.config('.')).run
+Dir.chdir(project) do
+  Gonzo::Runner.new(Gonzo.config(project)).run
+end

data/lib/gonzo.rb

@@ -1,26 +1,37 @@
 require 'gonzo/runner'
 
 module Gonzo
-  def self.config(path = '.')
-    return @config if @config
-    project = File.expand_path(path)
-    config_file = File.join(project, '.gonzo.yml')
-    fail "No .gonzo.yml found in #{project}!" unless File.exist?(config_file)
-    data = YAML.load_file(config_file)
-    data['gonzo'] = global_defaults.merge data['gonzo'] || {}
-    data['gonzo']['project'] = project
-    data['gonzo']['statedir'] = "#{project}/.gonzo"
-    @config = data
-  end
+  class << self
+    def config(path = '.')
+      return @config if @config
+      project = File.expand_path(path)
+      config_file = File.join(project, '.gonzo.yml')
+      fail "No .gonzo.yml found in #{project}!" unless File.exist?(config_file)
+      data = YAML.load_file(config_file)
+      data['gonzo'] = global_defaults.merge data['gonzo'] || {}
+      data['gonzo']['project'] = project
+      data['gonzo']['statedir'] = "#{project}/.gonzo"
+      @config = data
+    end
 
-  def self.reload!
-    @config = nil
-  end
+    def reload!
+      @config = nil
+    end
+
+    def global_defaults
+      {
+        'stop_on_failure' => false,
+        'cleanup' => true
+      }
+    end
+
+    def required_command(cmd)
+      ENV['PATH'].split(File::PATH_SEPARATOR).each do |path|
+        bin = File.join(path, cmd)
+        return if File.executable?(bin) && !File.directory?(bin)
+      end
 
-  def self.global_defaults
-    {
-      'stop_on_failure' => false,
-      'cleanup' => true
-    }
+      fail "Required command #{cmd} not found in $PATH!"
+    end
   end
 end

data/lib/gonzo/providers.rb

@@ -1 +1,2 @@
 require 'gonzo/providers/vagrant'
+require 'gonzo/providers/docker'

data/lib/gonzo/providers/abstract.rb

@@ -0,0 +1,37 @@
+require 'fileutils'
+
+module Gonzo
+  module Providers
+    class Abstract
+      def shellscript(provider_config)
+        script = []
+
+        script << '#!/bin/bash'
+        script << 'set -e'
+        script << 'set -x'
+        script << 'cp -r /gonzo /tmp/gonzo'
+        script << 'cd /tmp/gonzo'
+
+        if env = provider_config['env']
+          env.each do |k,v|
+            script << "export #{k}=\"#{v}\""
+          end
+        end
+
+        provider_config['commands'].each do |command|
+          script << command
+        end
+
+        script.join("\n")
+      end
+
+      def cleanup
+        FileUtils.rm_rf providerdir
+      end
+
+      def relative_providerdir
+        (providerdir.split('/') - global['project'].split('/')).join('/')
+      end
+    end
+  end
+end

data/lib/gonzo/providers/docker.rb

@@ -0,0 +1,50 @@
+require 'gonzo/providers/abstract'
+
+module Gonzo
+  module Providers
+    class Docker < Gonzo::Providers::Abstract
+      attr_reader :config, :providerdir, :global
+
+      def initialize(config, global)
+        @global = global
+        @providerdir = "#{global['statedir']}/provider/docker"
+
+        Gonzo.required_command 'docker'
+
+        if config.keys.include?('image')
+          @config = { 'default' => config }
+        else
+          @config = config
+        end
+      end
+
+      def provision(container, container_config)
+        FileUtils.mkdir_p(providerdir) unless File.directory?(providerdir)
+        local_script = "#{providerdir}/#{container}.sh"
+        relative_script = "#{relative_providerdir}/#{container}.sh"
+        if container_config['commands']
+          command = ['docker', 'run', "-v #{Dir.pwd}:/gonzo"]
+          command << "-u #{container_config['user']}" if container_config['user']
+          File.open(local_script, 'w') do |f|
+            f << shellscript(container_config)
+          end
+          FileUtils.chmod('+x', local_script)
+          command << "#{container_config['image']} /bin/bash /gonzo/#{relative_script}"
+          system command.join(' ')
+        else
+          fail "No provisioner commands given for #{container}!"
+        end
+      end
+
+      def run
+        exit_codes = []
+        config.each do |container, container_config|
+          exit_codes << provision(container, container_config)
+        end
+
+        return false if exit_codes.include?(false)
+        true
+      end
+    end
+  end
+end

data/lib/gonzo/providers/vagrant.rb

@@ -1,14 +1,16 @@
-require 'fileutils'
+require 'gonzo/providers/abstract'
 
 module Gonzo
   module Providers
-    class Vagrant
+    class Vagrant < Gonzo::Providers::Abstract
       attr_reader :config, :providerdir, :global
 
       def initialize(config, global)
         @global = global
         @providerdir = "#{global['statedir']}/provider/vagrant"
 
+        Gonzo.required_command 'vagrant'
+
         if config.keys.include?('box')
           @config = { 'default' => config }
         else
@@ -21,28 +23,6 @@ module Gonzo
         FileUtils.rm_rf 'Vagrantfile'
       end
 
-      def shellscript(commands, env = nil)
-        script = []
-
-        script << '#!/bin/bash'
-        script << 'set -e'
-        script << 'set -x'
-        script << 'cp -r /vagrant /tmp/gonzo'
-        script << 'cd /tmp/gonzo'
-
-        if env
-          env.each do |k,v|
-            script << "export #{k}=\"#{v}\""
-          end
-        end
-
-        commands.each do |command|
-          script << command
-        end
-
-        script.join("\n")
-      end
-
       def vagrantfile
         vf = []
 
@@ -53,6 +33,7 @@ module Gonzo
           vf << "  config.vm.define :#{name} do |#{name}|"
           vf << "    #{name}.vm.box = '#{conf['box']}'"
           vf << "    #{name}.vm.box_url = '#{conf['box_url']}'" if conf['box_url']
+          vf << "    #{name}.vm.synced_folder '.', '/gonzo'"
           vf << '  end'
         end
 
@@ -68,20 +49,17 @@ module Gonzo
         system "vagrant up #{box}"
       end
 
-      def relative_providerdir
-        (providerdir.split('/') - global['project'].split('/')).join('/')
-      end
-
       def provision(box, box_config)
         FileUtils.mkdir_p(providerdir) unless File.directory?(providerdir)
         local_script = "#{providerdir}/#{box}.sh"
         relative_script = "#{relative_providerdir}/#{box}.sh"
         if box_config['commands']
           File.open(local_script, 'w') do |f|
-            f << shellscript(box_config['commands'], box_config['env'])
+            f << shellscript(box_config)
           end
           FileUtils.chmod('+x', local_script)
-          system "vagrant ssh #{box} -c /vagrant/#{relative_script}"
+          command = box_config['sudo'] ? "'sudo /gonzo/#{relative_script}'" : "/gonzo/#{relative_script}"
+          system "vagrant ssh #{box} -c #{command}"
         else
           fail "No provisioner commands given for #{box}!"
         end

data/lib/gonzo/runner.rb

@@ -12,7 +12,7 @@ module Gonzo
     end
 
     def supported_providers
-      %w(vagrant)
+      %w(docker vagrant)
     end
 
     def providers
@@ -24,7 +24,7 @@ module Gonzo
           puts "Provider #{provider} is not implemented!"
           break
         end
-        @providers << Gonzo::Providers::Vagrant.new(config, global)
+        @providers << Object.const_get("Gonzo::Providers::#{provider.capitalize}").new(config, global)
       end
       @providers
     end

data/lib/gonzo/version.rb

@@ -1,3 +1,3 @@
 module Gonzo
-  VERSION = '0.1.0'
+  VERSION = '0.2.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gonzo
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - David Danzilio
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-04 00:00:00.000000000 Z
+date: 2015-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -52,6 +52,8 @@ files:
 - bin/gonzo
 - lib/gonzo.rb
 - lib/gonzo/providers.rb
+- lib/gonzo/providers/abstract.rb
+- lib/gonzo/providers/docker.rb
 - lib/gonzo/providers/vagrant.rb
 - lib/gonzo/rake_tasks.rb
 - lib/gonzo/runner.rb
@@ -81,4 +83,3 @@ signing_key:
 specification_version: 4
 summary: A simpler Muppet for simpler Puppets
 test_files: []
-has_rdoc: