packer-config 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a8d09aa2bf43904d51a9b8b86374a20ae71fd6fd
-  data.tar.gz: a84431fb5cbe4c2d2fd0dde6a694402af91cf153
+  metadata.gz: e45c5e454faed8c47d2303a5b62ccf57ab41ce80
+  data.tar.gz: 9bf6e3f2cdbbb446c7fad85caaaefe4be976a4a4
 SHA512:
-  metadata.gz: df285e99eeb101df9a5020399f53fc45edbb9f288c99b9cd50d62826e45be6a5c20f925a6c916960acd5923f4c876d615a1399916dfcd697df68d7ac9c39ebbb
-  data.tar.gz: e818223bcf70f201073a711ea7102e7b96a15f197b860a7c9b355b66e758fb0a1bea977391126f53c9d711a40448253a38c8c60301b986e4c3d9b50dacaf7644
+  metadata.gz: b4f75659bb9f8847b8952320d22032e51727b5fca6adb7df66c864034c6aa4ac271da2d7b2e5ac1eedaf58d27bf7d2a0871ebe16575ab01d36e2302f5bf5fd5e
+  data.tar.gz: 7bb2f90741d18c236262e9586c591e9c016b036ac572f0f67c782f9f79a371eef287903dea5f8d53ba69d2d5f5a8f1b1da602b1e0af31f450befad34b4e28185

data/.rubocop.yml

@@ -178,7 +178,7 @@ Style/AlignHash:
 Style/AlignParameters:
   Enabled: false
 
-Style/BlockNesting:
+Metrics/BlockNesting:
   Enabled: false
 
 Style/BracesAroundHashParameters:
@@ -214,9 +214,6 @@ Style/EmptyLines:
 Style/EmptyLinesAroundAccessModifier:
   Enabled: false
 
-Style/EmptyLinesAroundBody:
-  Enabled: false
-
 Style/GuardClause:
   Enabled: false
 
@@ -304,14 +301,17 @@ Style/Next:
 Style/NumericLiterals:
   Enabled: false
 
-Style/ParameterLists:
+Metrics/ParameterLists:
   Enabled: false
 
 Style/TrailingComma:
   # EnforcedStyleForMultiline: comma
   Enabled: false
 
-Style/CyclomaticComplexity:
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/AbcSize:
   Enabled: false
 
 ####
@@ -337,4 +337,4 @@ UselessAssignment:
   Enabled: false
 
 WordArray:
-  Enabled: false
+  Enabled: false

data/.travis.yml

@@ -1,6 +1,5 @@
 language: ruby
 rvm:
-- 1.9.3
 - 2.0.0
 - 2.1.1
-- ruby-head
+- ruby-head

data/README.md

@@ -15,6 +15,32 @@ Bonus: you can really go to town with templates when it's all done it Ruby.
 
     gem install packer-config
 
+## Use
+
+### Builders
+
+The following [Packer builders](http://www.packer.io/docs/templates/builders.html) are currently implemented:
+
+* [amazon-ebs](http://www.packer.io/docs/builders/amazon-ebs.html)
+* [amazon-instance](http://www.packer.io/docs/builders/amazon-instance.html)
+* [docker](http://www.packer.io/docs/builders/docker.html)
+* [virtualbox-iso](http://www.packer.io/docs/builders/virtualbox-iso.html)
+
+### Provisioners
+
+The following [Packer provisioners](http://www.packer.io/docs/templates/provisioners.html) are currently implemented:
+
+* [file](http://www.packer.io/docs/provisioners/file.html)
+* [shell](http://www.packer.io/docs/provisioners/shell.html)
+
+### Post-Processors
+
+The following [Packer post-processors](http://www.packer.io/docs/templates/post-processors.html) are currently implemented:
+
+* [docker-import](http://www.packer.io/docs/post-processors/docker-import.html)
+* [docker-push](http://www.packer.io/docs/post-processors/docker-push.html)
+* [vagrant](http://www.packer.io/docs/post-processors/vagrant.html)
+
 ## Examples
 
 ### Packing a Vagrant Basebox from a CentOS ISO Using VirtualBox
@@ -29,7 +55,7 @@ This example is based on the integration test [spec/integration/centos_vagrant_s
     pconfig.add_variable 'my_version', '0.0.1'
     pconfig.add_variable 'chef_version', 'latest'
 
-    builder = pconfig.add_builder Packer::Builder::VIRTUALBOX_ISO
+    builder = pconfig.add_builder 'virtualbox-iso'
     builder.boot_command ["<tab> text ks=http://#{pconfig.macro.HTTPIP}:#{pconfig.macro.HTTPPort}/#{OS}-ks.cfg<enter><wait>"]
     builder.boot_wait '10s'
     builder.disk_size 40960
@@ -62,11 +88,11 @@ This example is based on the integration test [spec/integration/centos_vagrant_s
     builder.virtualbox_version_file ".vbox_version"
     builder.vm_name "packer-#{OS}-x86_64"
 
-    provisioner = pconfig.add_provisioner Packer::Provisioner::FILE
+    provisioner = pconfig.add_provisioner 'file'
     provisioner.source 'scripts/hello.sh'
     provisioner.destination '/home/vagrant/hello.sh'
 
-    provisioner = pconfig.add_provisioner Packer::Provisioner::SHELL
+    provisioner = pconfig.add_provisioner 'shell'
     provisioner.scripts [
       'scripts/fix-slow-dns.sh',
       'scripts/sshd.sh',
@@ -82,7 +108,7 @@ This example is based on the integration test [spec/integration/centos_vagrant_s
     ]
     provisioner.execute_command "echo 'vagrant' | #{pconfig.macro.Vars} sudo -S -E bash '#{pconfig.macro.Path}'"
 
-    postprocessor = pconfig.add_postprocessor Packer::PostProcessor::VAGRANT
+    postprocessor = pconfig.add_postprocessor 'vagrant'
     postprocessor.output File.join('builds', pconfig.macro.Provider, "#{OS}-x86_64-#{pconfig.variable 'my_version'}.box")
 
     pconfig.validate

data/RELEASENOTES.md

@@ -0,0 +1,6 @@
+# packer-config Release Notes
+
+## 0.0.4
+
+* Added the ability to call `#build` with a quiet option. This option turns streaming to stdout off/on. With `quiet: false`, you will see the output of the Packer call on your screen while `#build` is executing it. This can be handy for view Packer status for long running Packer jobs.
+* Started writing release notes!

data/Rakefile

@@ -21,7 +21,7 @@ RuboCop::RakeTask.new(:lint)
 
 task :default => [:lint, 'test:spec']
 
-task :build => ['test:spec'] do
+task :build => [:lint, 'test:spec', :clean] do
   `gem build packer-config.gemspec`
 end
 
@@ -44,4 +44,4 @@ task :clean do
   Dir.glob('spec/integration/builds/*').select {|f| File.directory? f}.each do |d|
     FileUtils.rm_rf(d)
   end
-end
+end

data/TODO.md

@@ -5,4 +5,3 @@
 * Look in to something like VCR to drive the tests of the child classes -- there's a lot of repetitive testing that could be done on them.
 * Add missing builders, provisioners and post-processors. I only implemented the builders, provisioners and post-processors that I'm currently using.
 * Refactor the child classes. I get the feeling that these could be implemented in some better, templated, type of way
-* Building can take a long time. Look in to a way to query the state of a build. Maybe return the stdout from it on query.

data/lib/packer-config.rb

@@ -13,7 +13,7 @@
 #    See the License for the specific language governing permissions and
 #    limitations under the License.
 require 'json'
-require 'open3'
+require 'packer/runner'
 require 'packer/dataobject'
 require 'packer/builder'
 require 'packer/provisioner'
@@ -23,7 +23,6 @@ require 'packer/envvar'
 
 module Packer
   class Config < Packer::DataObject
-
     VERSION = '0.0.2'
 
     attr_accessor :builders
@@ -53,22 +52,20 @@ module Packer
       if self.builders.length == 0
         raise DataValidationError.new("At least one builder is required")
       end
-      self.builders.each do |thing|
-        thing.validate
-      end
-      self.provisioners.each do |thing|
-        thing.validate
-      end
-      self.postprocessors.each do |thing|
-        thing.validate
-      end
+      self.builders.each(&:validate)
+      self.provisioners.each(&:validate)
+      self.postprocessors.each(&:validate)
       self.write
+      stdout = nil
       Dir.chdir(File.dirname(self.output_file)) do
-        cmd = [self.packer, 'validate', File.basename(self.output_file)].join(' ')
-        stdout, stderr, status = Open3.capture3(cmd)
-        raise PackerBuildError.new(stderr) unless status == 0
+        begin
+          stdout = Packer::Runner.run! self.packer, 'validate', File.basename(self.output_file), quiet: true
+        rescue Packer::Runner::CommandExecutionError => e
+          raise PackerBuildError.new(e.to_s)
+        end
       end
       self.delete
+      stdout
     end
 
     class DumpError < StandardError
@@ -115,15 +112,19 @@ module Packer
     class PackerBuildError < StandardError
     end
 
-    def build
+    def build(quiet: false)
       self.validate
       self.write
+      stdout = nil
       Dir.chdir(File.dirname(self.output_file)) do
-        cmd = [self.packer, 'build', self.packer_options, File.basename(self.output_file)].join(' ')
-        stdout, stderr, status = Open3.capture3(cmd)
-        raise PackerBuildError.new(stderr) unless status == 0
+        begin
+          stdout = Packer::Runner.run! self.packer, 'build', self.packer_options, File.basename(self.output_file), quiet: quiet
+        rescue Packer::Runner::CommandExecutionError => e
+          raise PackerBuildError.new(e.to_s)
+        end
       end
       self.delete
+      stdout
     end
 
     def description(description)
@@ -176,6 +177,5 @@ module Packer
     attr_writer :output_file
     attr_writer :macro
     attr_writer :envvar
-
   end
 end

data/lib/packer/builder.rb

@@ -16,7 +16,6 @@ require 'packer/builders/all'
 
 module Packer
   class Builder < DataObject
-
     AMAZON_EBS      = 'amazon-ebs'
     AMAZON_INSTANCE = 'amazon-instance'
     DOCKER          = 'docker'
@@ -62,4 +61,4 @@ module Packer
       VALID_BUILDER_TYPES.include? type
     end
   end
-end
+end

data/lib/packer/builders/amazon.rb

@@ -18,7 +18,6 @@ require 'packer/dataobject'
 module Packer
   class Builder < Packer::DataObject
     class Amazon < Builder
-
       def initialize
         super
         self.add_required(
@@ -211,4 +210,4 @@ module Packer
       end
     end
   end
-end
+end

data/lib/packer/dataobject.rb

@@ -15,7 +15,6 @@
 
 module Packer
   class DataObject
-
     attr_accessor :data
     attr_accessor :required
 
@@ -71,7 +70,7 @@ module Packer
     def __add_array_of_strings(key, values, exclusives = [])
       self.__exclusive_key_error(key, exclusives)
       raise TypeError.new() unless Array.try_convert(values)
-      self.data[key.to_s] = values.to_ary.map{ |c| c.to_s }
+      self.data[key.to_s] = values.to_ary.map(&:to_s)
     end
 
     def __add_array_of_array_of_strings(key, values, exclusives = [])
@@ -80,7 +79,7 @@ module Packer
       self.data[key.to_s] = []
       values.each do |v|
         raise TypeError.new() unless Array.try_convert(v)
-        self.data[key.to_s].push(v.to_ary.map{ |c| c.to_s })
+        self.data[key.to_s].push(v.to_ary.map(&:to_s))
       end
     end
 

data/lib/packer/postprocessor.rb

@@ -17,7 +17,6 @@ require 'packer/dataobject'
 
 module Packer
   class PostProcessor < Packer::DataObject
-
     DOCKER_IMPORT = 'docker-import'
     DOCKER_PUSH = 'docker-push'
     VAGRANT = 'vagrant'
@@ -74,4 +73,4 @@ module Packer
       VALID_POST_PROCESSOR_TYPES.include? type
     end
   end
-end
+end

data/lib/packer/provisioner.rb

@@ -17,7 +17,6 @@ require 'packer/dataobject'
 
 module Packer
   class Provisioner < Packer::DataObject
-
     SHELL = 'shell'
     FILE = 'file'
 
@@ -83,4 +82,4 @@ module Packer
       VALID_PROVISIONER_TYPES.include? type
     end
   end
-end
+end

data/lib/packer/runner.rb

@@ -0,0 +1,44 @@
+require 'open3'
+require 'shellwords'
+require 'pty'
+
+module Packer
+  class Runner
+    class CommandExecutionError < StandardError
+    end
+
+    def self.run!(*args, quiet: false)
+      cmd = Shellwords.shelljoin(args.flatten)
+      status = 0
+      stdout = ''
+      stderr = ''
+      if quiet
+        # Run without streaming std* to any screen
+        stdout, stderr, status = Open3.capture3(cmd)
+      else
+        # Run but stream as well as capture stdout to the screen
+        status = pty(cmd) do |r,w,pid|
+          while !r.eof?
+            c = r.getc
+            stdout << c
+            $stdout.write "#{c}"
+          end
+          Process.wait(pid)
+        end
+      end
+      raise CommandExecutionError.new(stderr) unless status == 0
+      stdout
+    end
+
+    def self.exec!(*args)
+      cmd = Shellwords.shelljoin(args.flatten)
+      logger.debug "Exec'ing: #{cmd}, in: #{Dir.pwd}"
+      Kernel.exec cmd
+    end
+
+    def self.pty(cmd, &block)
+      PTY.spawn(cmd, &block)
+      $?.exitstatus
+    end
+  end
+end

data/packer-config.gemspec

@@ -15,7 +15,7 @@
 
 Gem::Specification.new do |spec|
   spec.name          = "packer-config"
-  spec.version       = "0.0.3"
+  spec.version       = "0.0.4"
   # For deploying alpha versions via Travis CI
   spec.version       = "#{spec.version}-alpha-#{ENV['TRAVIS_BUILD_NUMBER']}" if ENV['TRAVIS']
   spec.authors       = ["Ian Chesal"]

data/spec/packer/dataobject_spec.rb

@@ -121,7 +121,7 @@ RSpec.describe Packer::DataObject do
 
     it 'converts an array of non-strings to strings and assigns them to key' do
       dataobject.__add_array_of_strings('key', some_array_of_ints)
-      expect(dataobject.data['key']).to eq(some_array_of_ints.map{ |c| c.to_s })
+      expect(dataobject.data['key']).to eq(some_array_of_ints.map(&:to_s))
       dataobject.data.delete('key')
     end
 
@@ -235,5 +235,4 @@ RSpec.describe Packer::DataObject do
       expect { dataobject.__add_array_of_hashes('key', [some_hash_of_strings, 'illegal']) }.to raise_error
     end
   end
-
-end
+end

data/spec/packer/provisioners/shell_spec.rb

@@ -46,7 +46,7 @@ RSpec.describe Packer::Provisioner::Shell do
 
     it 'converts all commands to strings' do
       provisioner.inline(some_array_of_ints)
-      expect(provisioner.data['inline']).to eq(some_array_of_ints.map{ |c| c.to_s })
+      expect(provisioner.data['inline']).to eq(some_array_of_ints.map(&:to_s))
       provisioner.data.delete('inline')
     end
 
@@ -96,7 +96,7 @@ RSpec.describe Packer::Provisioner::Shell do
 
     it 'converts all commands to strings' do
       provisioner.scripts(some_array_of_ints)
-      expect(provisioner.data['scripts']).to eq(some_array_of_ints.map{ |c| c.to_s })
+      expect(provisioner.data['scripts']).to eq(some_array_of_ints.map(&:to_s))
       provisioner.data.delete('scripts')
     end
 
@@ -113,4 +113,4 @@ RSpec.describe Packer::Provisioner::Shell do
       provisioner.data.delete('scripts')
     end
   end
-end
+end

data/spec/packer/runner_spec.rb

@@ -0,0 +1,32 @@
+# Encoding: utf-8
+# Copyright 2014 Ian Chesal
+#
+#    Licensed under the Apache License, Version 2.0 (the "License");
+#    you may not use this file except in compliance with the License.
+#    You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS,
+#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#    See the License for the specific language governing permissions and
+#    limitations under the License.
+require 'spec_helper'
+require 'fakefs/spec_helpers'
+
+RSpec.describe Packer::Runner do
+  describe '#run!' do
+    it 'returns stdout on success' do
+      open3 = class_double("Open3").as_stubbed_const(:transfer_nested_constants => true)
+      expect(open3).to receive(:capture3).and_return(['output', 'error', 0])
+      expect(described_class.run! 'true', quiet: true).to eq('output')
+    end
+
+    it 'raises an error on failure' do
+      open3 = class_double("Open3").as_stubbed_const(:transfer_nested_constants => true)
+      expect(open3).to receive(:capture3).and_return(['output', 'error', 1])
+      expect{ described_class.run! 'false', quiet: true }.to raise_error
+    end
+  end
+end

data/spec/packer_config_spec.rb

@@ -34,8 +34,7 @@ RSpec.describe Packer::Config do
   describe "#validate" do
     it 'returns true for a valid instance' do
       expect(packer.builders).to receive(:length).and_return(1)
-      open3 = class_double("Open3").as_stubbed_const(:transfer_nested_constants => true)
-      expect(open3).to receive(:capture3).and_return(['output', 'error', 0])
+      expect(Packer::Runner).to receive(:run!).and_return('')
       FakeFS do
         expect(packer.validate).to be_truthy
       end
@@ -86,8 +85,7 @@ RSpec.describe Packer::Config do
     it 'returns successfully if the build command returns a successful exit code' do
       expect(packer).to receive(:validate).and_return(true)
       expect(packer).to receive(:write).and_return(true)
-      open3 = class_double("Open3").as_stubbed_const(:transfer_nested_constants => true)
-      expect(open3).to receive(:capture3).and_return(['output', 'error', 0])
+      expect(Packer::Runner).to receive(:run!).and_return('')
       FakeFS do
         expect(packer.build).to be_truthy
       end
@@ -109,8 +107,7 @@ RSpec.describe Packer::Config do
     it 'raises an error if the build command returns an unsuccessful exit code' do
       expect(packer).to receive(:validate).and_return(true)
       expect(packer).to receive(:write).and_return(true)
-      open3 = class_double("Open3").as_stubbed_const(:transfer_nested_constants => true)
-      expect(open3).to receive(:capture3).and_return(['output', 'error', 1])
+      expect(Packer::Runner).to receive(:run!).and_raise(Packer::Runner::CommandExecutionError)
       FakeFS do
         expect { packer.build }.to raise_error
       end
@@ -193,5 +190,4 @@ RSpec.describe Packer::Config do
       expect(packer.macro.var).to eq('{{ .Var }}')
     end
   end
-
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: packer-config
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Ian Chesal
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-10 00:00:00.000000000 Z
+date: 2014-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -113,6 +113,7 @@ files:
 - Gemfile
 - LICENSE
 - README.md
+- RELEASENOTES.md
 - Rakefile
 - TODO.md
 - lib/packer-config.rb
@@ -132,6 +133,7 @@ files:
 - lib/packer/provisioners/all.rb
 - lib/packer/provisioners/file.rb
 - lib/packer/provisioners/shell.rb
+- lib/packer/runner.rb
 - packer-config.gemspec
 - spec/integration/README.md
 - spec/integration/builds/.gitignore
@@ -160,6 +162,7 @@ files:
 - spec/packer/provisioner_spec.rb
 - spec/packer/provisioners/file_spec.rb
 - spec/packer/provisioners/shell_spec.rb
+- spec/packer/runner_spec.rb
 - spec/packer_config_spec.rb
 - spec/spec_helper.rb
 - spec/unit_helper.rb
@@ -215,6 +218,7 @@ test_files:
 - spec/packer/provisioner_spec.rb
 - spec/packer/provisioners/file_spec.rb
 - spec/packer/provisioners/shell_spec.rb
+- spec/packer/runner_spec.rb
 - spec/packer_config_spec.rb
 - spec/spec_helper.rb
 - spec/unit_helper.rb