heirloom 0.11.2 → 0.12.0

data/.gitignore

@@ -4,3 +4,5 @@ Gemfile.lock
 pkg/*
 .idea/
 coverage
+/tmp/*
+Guardfile

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## HEAD: 
+
+## 0.12.0 (08/14/2013):
+
+* Fixed bug 130 which did not exclude subdirectories
+* Fixes bug 145 when no config file, it no longer errors out
+* Added HEIRLOOM_CONFIG_FILE as alternate config file
+
 ## 0.11.2 (06/19/2013):
 
 * Adding hashie to runtime.

data/README.md

@@ -40,6 +40,11 @@ default:
 #   metadata_region: us-west-1
 ```
 
+You can specify an alternate config file by setting "HEIRLOOM_CONFIG_FILE" 
+```
+export HEIRLOOM_CONFIG_FILE="~/special_config.yml"
+```
+
 Documentation
 -------------
 

data/lib/heirloom.rb

@@ -1,5 +1,5 @@
 require "heirloom/utils"
-
+require "heirloom/env"
 require "heirloom/acl"
 require "heirloom/archive"
 require "heirloom/aws"

data/lib/heirloom/config.rb

@@ -25,19 +25,31 @@ module Heirloom
     private
 
     def load_config_file
-      config_file = "#{ENV['HOME']}/.heirloom.yml"
-
       if File.exists? config_file
         data = YAML::load File.open(config_file)
         if data.has_key? @environment
-          data[@environment]
+          return data[@environment]
         else
-          @logger.error "Environment '#{@environment}' not found in config file."
-          exit 1
+          @logger.warn "Environment '#{@environment}' not found in config file."
         end
-      else
-        { }
       end
+      {}
+    end
+
+    def config_file
+     @config_file ||= env_config_file || default_config_file
+    end
+
+    def env_config_file
+      env.load 'HEIRLOOM_CONFIG_FILE'
+    end
+
+    def default_config_file
+      "#{env.load 'HOME'}/.heirloom.yml"
+    end
+
+    def env
+      @env ||= Env.new
     end
 
   end

data/lib/heirloom/directory/directory.rb

@@ -17,7 +17,6 @@ module Heirloom
 
       @logger.debug "Building Heirloom '#{@file}' from '#{@path}'."
       @logger.debug "Excluding #{@exclude.to_s}."
-      @logger.debug "Adding #{files_to_pack}."
 
       return build_archive unless @secret
 
@@ -28,7 +27,7 @@ module Heirloom
 
     def build_archive
       return false unless tar_in_path?
-      command = "cd #{@path} && tar czf #{@file} #{files_to_pack}"
+      command = "cd #{@path} && tar czf #{@file} #{build_exclude_files} ."
       @logger.info "Archiving with: `#{command}`"
       output = `#{command}`
       @logger.debug "Exited with status: '#{$?.exitstatus}' ouput: '#{output}'"
@@ -50,10 +49,8 @@ module Heirloom
       true
     end
 
-    def files_to_pack
-      @files_to_pack ||= (Dir.entries(@path) - ['.', '..'] - @exclude).map do |file|
-        "'#{file}'"
-      end.join(' ')
+    def build_exclude_files
+      @exclude.map { |x| "--exclude #{x}" }.join ' '
     end
 
     def cipher_file

data/lib/heirloom/env.rb

@@ -0,0 +1,9 @@
+module Heirloom
+  class Env
+
+    def load(var)
+      ENV.fetch var, nil
+    end
+
+  end
+end

data/lib/heirloom/version.rb

@@ -1,3 +1,3 @@
 module Heirloom
-  VERSION = "0.11.2"
+  VERSION = "0.12.0"
 end

data/spec/cli/rotate_spec.rb

@@ -18,6 +18,8 @@ describe Heirloom do
     Heirloom::Catalog.stub(:new).and_return catalog_stub
 
     @archive_mock = mock 'archive'
+    @logger_mock = mock_log
+    Heirloom::HeirloomLogger.stub :new => @logger_mock
     Heirloom::Archive.stub(:new).and_return @archive_mock
 
   end
@@ -34,9 +36,6 @@ describe Heirloom do
     
     @archive_mock.stub(:rotate).and_raise Heirloom::Exceptions::RotateFailed.new("failed")
 
-    @logger_mock = mock 'logger'
-    Heirloom::HeirloomLogger.stub :new => @logger_mock
-    
     @logger_mock.should_receive(:error).with "failed"
     expect {
       Heirloom::CLI::Rotate.new.rotate

data/spec/config_spec.rb

@@ -20,79 +20,104 @@ describe Heirloom do
                  
   end
 
-  it "should create a new config object from the hash passed as config" do
-    File.stub :exists? => false
-    File.should_receive(:open).never
-    config = Heirloom::Config.new :opts   => @opts,
-                                  :logger => 'da-logger'
-    config.access_key.should == @opts[:aws_access_key]
-    config.secret_key.should == @opts[:aws_secret_key]
-    config.metadata_region.should == @opts[:metadata_region]
-    config.logger.should == 'da-logger'
-  end
+  context "#test the config file" do
+    it "should open the HEIRLOOM_CONFIG_FILE if set" do
+      File.stub :exists? => true
+      File.should_receive(:open).with('~/.special_config.yml').and_return(@config_file.to_yaml)
+      env_mock = mock 'env'
+      env_mock.should_receive(:load).with('HEIRLOOM_CONFIG_FILE').and_return('~/.special_config.yml')
+      Heirloom::Env.stub(:new).and_return(env_mock)
+      config = Heirloom::Config.new :opts   => @opts,
+                                    :logger => 'da-logger'
+    end
 
-  it "should create a new config object and read from ~/.heirloom.yml" do
-    File.stub :exists? => true
-    File.should_receive(:open).with("#{ENV['HOME']}/.heirloom.yml").
-                               and_return(@config_file.to_yaml)
-    config = Heirloom::Config.new
-    config.access_key.should == @config_file['default']['access_key']
-    config.secret_key.should == @config_file['default']['secret_key']
-    config.metadata_region.should == @config_file['default']['metadata_region']
-  end
-  
-  it "should override config settings in file from opts" do
-    File.stub :exists? => true
-    File.should_receive(:open).with("#{ENV['HOME']}/.heirloom.yml").
-                               and_return(@config_file.to_yaml)
-    config = Heirloom::Config.new :opts => @opts
-    config.access_key.should == @opts[:aws_access_key]
-    config.secret_key.should == @opts[:aws_secret_key]
-    config.metadata_region.should == @opts[:metadata_region]
+    it "should open the default config file if HEIRLOOM_CONFIG_FILE is not set" do
+      File.stub :exists? => true
+      File.should_receive(:open).with('~/.heirloom.yml').and_return(@config_file.to_yaml)
+      env_mock = mock 'env'
+      env_mock.should_receive(:load).with('HEIRLOOM_CONFIG_FILE').and_return(nil)
+      env_mock.should_receive(:load).with('HOME').and_return('~')
+      Heirloom::Env.stub(:new).and_return(env_mock)
+      config = Heirloom::Config.new :opts   => @opts,
+                                    :logger => 'da-logger'
+    end
   end
 
-  it "should load a blank config if the file does not exist and no config passed" do
-    File.stub :exists? => false
-    config = Heirloom::Config.new
-    config.access_key.should be_nil
-    config.secret_key.should be_nil
-    config.metadata_region.should be_nil
-  end
+  context "#with config file set" do
+    before do
+      env_mock = mock 'env'
+      env_mock.should_receive(:load).with('HEIRLOOM_CONFIG_FILE').and_return(nil)
+      env_mock.should_receive(:load).with('HOME').and_return('~')
+      Heirloom::Env.stub(:new).and_return(env_mock)
+    end
 
-  it "should load a different environment if requested" do
-    File.stub :exists? => true
-    File.should_receive(:open).with("#{ENV['HOME']}/.heirloom.yml").
-                               and_return(@config_file.to_yaml)
-    config = Heirloom::Config.new :environment => 'dev'
-    config.access_key.should == @config_file['dev']['access_key']
-    config.secret_key.should == @config_file['dev']['secret_key']
-    config.metadata_region.should == @config_file['dev']['metadata_region']
-  end
+    it "should create a new config object from the hash passed as config" do
+      File.stub :exists? => false
+      File.should_receive(:open).never
+      config = Heirloom::Config.new :opts   => @opts,
+                                    :logger => 'da-logger'
+      config.access_key.should == @opts[:aws_access_key]
+      config.secret_key.should == @opts[:aws_secret_key]
+      config.metadata_region.should == @opts[:metadata_region]
+      config.logger.should == 'da-logger'
+    end
 
-  it "should still allow overrides with different environments" do
-    File.stub :exists? => true
-    File.should_receive(:open).with("#{ENV['HOME']}/.heirloom.yml").
-                               and_return(@config_file.to_yaml)
-    opts = {
-      :aws_access_key => 'specialdevkey'
-    }
+    it "should create a new config object and read from ~/.heirloom.yml" do
+      File.stub :exists? => true
+      File.should_receive(:open).with("~/.heirloom.yml").and_return(@config_file.to_yaml)
+      config = Heirloom::Config.new
+      config.access_key.should == @config_file['default']['access_key']
+      config.secret_key.should == @config_file['default']['secret_key']
+      config.metadata_region.should == @config_file['default']['metadata_region']
+    end
+    
+    it "should override config settings in file from opts" do
+      File.stub :exists? => true
+      File.should_receive(:open).with("~/.heirloom.yml").and_return(@config_file.to_yaml)
+      config = Heirloom::Config.new :opts => @opts
+      config.access_key.should == @opts[:aws_access_key]
+      config.secret_key.should == @opts[:aws_secret_key]
+      config.metadata_region.should == @opts[:metadata_region]
+    end
 
-    config = Heirloom::Config.new :opts => opts, :environment => 'dev'
-    config.access_key.should == 'specialdevkey'
-    config.metadata_region.should == @config_file['dev']['metadata_region']
-  end
+    it "should load a blank config if the file does not exist and no config passed" do
+      File.stub :exists? => false
+      config = Heirloom::Config.new
+      config.access_key.should be_nil
+      config.secret_key.should be_nil
+      config.metadata_region.should be_nil
+    end
 
-  it "should complain if a non-existing environment is requested" do
-    File.stub :exists? => true
-    File.should_receive(:open).with("#{ENV['HOME']}/.heirloom.yml").
-                               and_return(@config_file.to_yaml)
+    it "should load a different environment if requested" do
+      File.stub :exists? => true
+      File.should_receive(:open).with("~/.heirloom.yml").and_return(@config_file.to_yaml)
+      config = Heirloom::Config.new :environment => 'dev'
+      config.access_key.should == @config_file['dev']['access_key']
+      config.secret_key.should == @config_file['dev']['secret_key']
+      config.metadata_region.should == @config_file['dev']['metadata_region']
+    end
 
-    logger_mock = mock 'logger'
-    logger_mock.should_receive(:error)
+    it "should still allow overrides with different environments" do
+      File.stub :exists? => true
+      File.should_receive(:open).with("~/.heirloom.yml").and_return(@config_file.to_yaml)
+      opts = {
+        :aws_access_key => 'specialdevkey'
+      }
 
-    lambda {
-      config = Heirloom::Config.new :environment => 'missing', :logger => logger_mock
-    }.should raise_error SystemExit
-  end
+      config = Heirloom::Config.new :opts => opts, :environment => 'dev'
+      config.access_key.should == 'specialdevkey'
+      config.metadata_region.should == @config_file['dev']['metadata_region']
+    end
 
+    it "should log a warning if a non-existing environment is requested from existing config file" do
+      File.stub :exists? => true
+      File.should_receive(:open).with("~/.heirloom.yml").and_return(@config_file.to_yaml)
+      logger_mock = mock 'logger'
+      logger_mock.should_receive(:warn)
+
+      lambda {
+        config = Heirloom::Config.new :environment => 'missing', :logger => logger_mock
+      }.should_not raise_error SystemExit
+    end
+  end
 end

data/spec/directory/directory_spec.rb

@@ -11,7 +11,7 @@ describe Heirloom::Directory do
                           :error => 'true'
       @config_mock.stub(:logger).and_return(@logger_stub)
       @directory = Heirloom::Directory.new :config  => @config_mock,
-                                           :exclude => ['.', '..', 'dont_pack_me'],
+                                           :exclude => ['dont_pack_me', 'dont_pack_me1'],
                                            :path    => '/dir',
                                            :file    => '/tmp/file.tar.gz'
     end
@@ -20,13 +20,11 @@ describe Heirloom::Directory do
       before do 
         @directory.should_receive(:which).with('tar').and_return true
         output_mock = double 'output mock'
-        command = "cd /dir && tar czf /tmp/file.tar.gz 'pack_me' '.hidden' 'with a space'"
-        files = ['pack_me', '.hidden', 'with a space', 'dont_pack_me']
+        command = "cd /dir && tar czf /tmp/file.tar.gz --exclude dont_pack_me --exclude dont_pack_me1 ."
+        files = ['pack_me', '.hidden', 'with a space', 'dont_pack_me', 'dont_pack_me1']
         Heirloom::Directory.any_instance.should_receive(:`).
                             with(command).
                             and_return output_mock
-        Dir.should_receive(:entries).with('/dir').
-                                     and_return files
         $?.stub :success? => true
       end
 
@@ -60,12 +58,11 @@ describe Heirloom::Directory do
       before do 
         @directory.should_receive(:which).with('tar').and_return true
         output_mock = double 'output mock'
-        command = "cd /dir && tar czf /tmp/file.tar.gz 'pack_me' '.hidden' 'with a space'"
-        files = ['pack_me', '.hidden', 'with a space', 'dont_pack_me']
+        command = "cd /dir && tar czf /tmp/file.tar.gz --exclude dont_pack_me --exclude dont_pack_me1 ."
+        files = ['pack_me', '.hidden', 'with a space', 'dont_pack_me', 'dont_pack_me1']
         Heirloom::Directory.any_instance.should_receive(:`).
                             with(command).
                             and_return output_mock
-        Dir.should_receive(:entries).with('/dir').and_return files
         $?.stub(:success?).and_return(false)
       end
 
@@ -81,8 +78,7 @@ describe Heirloom::Directory do
 
     context 'when required executable is missing' do
       before do
-        files = ['pack_me', '.hidden', 'with a space', 'dont_pack_me']
-        Dir.should_receive(:entries).with('/dir').and_return files
+        files = ['pack_me', '.hidden', 'with a space', 'dont_pack_me', 'dont_pack_me1']
       end
 
       it "should return false if tar is not in path" do
@@ -92,10 +88,6 @@ describe Heirloom::Directory do
     end
 
     context "parameter validation" do
-      before do
-        Dir.stub(:entries).and_return ['pack_me', 'dont_pack_me']
-      end
-
       it "should not fail if exclude is nil" do
         @directory = Heirloom::Directory.new :config  => @config_mock,
                                              :exclude => nil,

data/spec/env_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe Heirloom do
+
+  it "should return ENV value if passed the name" do
+    set_env_var("HOME", "~")
+    env = Heirloom::Env.new
+    expect(env.load 'HOME').to eq '~'
+  end
+
+  it "should return nil if the ENV name does not exist" do
+    env = Heirloom::Env.new
+    expect(env.load 'SOME_RANDOM_MISSING_VALUE').to eq nil
+  end
+
+end

data/spec/spec_helper.rb

@@ -16,6 +16,10 @@ RUN_INTEGRATION_TESTS = HEIRLOOM_INT_BP && !HEIRLOOM_INT_BP.empty?
 
 module SpecHelpers
 
+  def set_env_var(name,value)
+    ENV.stub(:fetch).with(name, nil).and_return(value)
+  end
+
   def mock_log
     mock 'log', :debug => true, :info => true, :warn => true, :error => true, :level= => true
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: heirloom
 version: !ruby/object:Gem::Version
-  version: 0.11.2
+  version: 0.12.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-19 00:00:00.000000000 Z
+date: 2013-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70204272959080 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70204272959080
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70204272957220 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +37,15 @@ dependencies:
         version: 2.11.0
   type: :development
   prerelease: false
-  version_requirements: *70204272957220
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.11.0
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &70204272955560 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,21 +53,31 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70204272955560
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: vcr
-  requirement: &70204272954540 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - =
+    - - '='
       - !ruby/object:Gem::Version
         version: 2.4.0
   type: :development
   prerelease: false
-  version_requirements: *70204272954540
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.4.0
 - !ruby/object:Gem::Dependency
   name: watchr
-  requirement: &70204272952980 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,54 +85,79 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70204272952980
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: excon
-  requirement: &70204273119180 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - =
+    - - '='
       - !ruby/object:Gem::Version
         version: '0.16'
   type: :runtime
   prerelease: false
-  version_requirements: *70204273119180
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '0.16'
 - !ruby/object:Gem::Dependency
   name: fog
-  requirement: &70204273118060 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - =
+    - - '='
       - !ruby/object:Gem::Version
         version: 1.10.0
   type: :runtime
   prerelease: false
-  version_requirements: *70204273118060
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.10.0
 - !ruby/object:Gem::Dependency
   name: hashie
-  requirement: &70204273116860 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - =
+    - - '='
       - !ruby/object:Gem::Version
         version: 2.0.5
   type: :runtime
   prerelease: false
-  version_requirements: *70204273116860
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.5
 - !ruby/object:Gem::Dependency
   name: trollop
-  requirement: &70204273112960 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - =
+    - - '='
       - !ruby/object:Gem::Version
         version: '2.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70204273112960
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: xml-simple
-  requirement: &70204273112240 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -120,7 +165,12 @@ dependencies:
         version: 1.1.2
   type: :runtime
   prerelease: false
-  version_requirements: *70204273112240
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.2
 description: I help build and manage building tar.gz files and deploying them into
   the cloud
 email:
@@ -196,6 +246,7 @@ files:
 - lib/heirloom/directory/directory.rb
 - lib/heirloom/downloader.rb
 - lib/heirloom/downloader/s3.rb
+- lib/heirloom/env.rb
 - lib/heirloom/exceptions.rb
 - lib/heirloom/logger.rb
 - lib/heirloom/uploader.rb
@@ -249,6 +300,7 @@ files:
 - spec/destroyer/s3_spec.rb
 - spec/directory/directory_spec.rb
 - spec/downloader/s3_spec.rb
+- spec/env_spec.rb
 - spec/fixtures/cassettes/Heirloom_AWS_SimpleDB/select/should_be_able_to_offset_results.yml
 - spec/fixtures/cassettes/Heirloom_AWS_SimpleDB/select/should_get_results.yml
 - spec/fixtures/cassettes/Heirloom_AWS_SimpleDB/select/should_yield_when_requested.yml
@@ -274,21 +326,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -2840410231775603378
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -2840410231775603378
 requirements: []
 rubyforge_project: heirloom
-rubygems_version: 1.8.16
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: I help with deploying code into the cloud
@@ -338,6 +384,7 @@ test_files:
 - spec/destroyer/s3_spec.rb
 - spec/directory/directory_spec.rb
 - spec/downloader/s3_spec.rb
+- spec/env_spec.rb
 - spec/fixtures/cassettes/Heirloom_AWS_SimpleDB/select/should_be_able_to_offset_results.yml
 - spec/fixtures/cassettes/Heirloom_AWS_SimpleDB/select/should_get_results.yml
 - spec/fixtures/cassettes/Heirloom_AWS_SimpleDB/select/should_yield_when_requested.yml