boxgrinder-core 0.2.1 → 0.3.0

data/CHANGELOG

@@ -1,3 +1,8 @@
+v0.3.0
+
+* [BGBUILD-178] Remove sensitive data from logs
+* [BGBUILD-168] Support deprecated package inclusion format in appliance definitions
+
 v0.2.1
 
 * [BGBUILD-142] Backtraces make output unreadable - add option to enable them, and disable by default

data/boxgrinder-core.gemspec

@@ -2,15 +2,15 @@
 
 Gem::Specification.new do |s|
   s.name = %q{boxgrinder-core}
-  s.version = "0.2.1"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Marek Goldmann"]
-  s.date = %q{2011-02-22}
+  s.date = %q{2011-03-09}
   s.description = %q{Core library for BoxGrinder}
   s.email = %q{info@boxgrinder.org}
   s.extra_rdoc_files = ["CHANGELOG", "LICENSE", "README", "lib/boxgrinder-core.rb", "lib/boxgrinder-core/helpers/appliance-config-helper.rb", "lib/boxgrinder-core/helpers/appliance-definition-helper.rb", "lib/boxgrinder-core/helpers/exec-helper.rb", "lib/boxgrinder-core/helpers/log-helper.rb", "lib/boxgrinder-core/models/appliance-config.rb", "lib/boxgrinder-core/models/config.rb", "lib/boxgrinder-core/models/task.rb", "lib/boxgrinder-core/validators/appliance-config-validator.rb", "lib/boxgrinder-core/validators/errors.rb"]
-  s.files = ["CHANGELOG", "LICENSE", "Manifest", "README", "Rakefile", "boxgrinder-core.gemspec", "lib/boxgrinder-core.rb", "lib/boxgrinder-core/helpers/appliance-config-helper.rb", "lib/boxgrinder-core/helpers/appliance-definition-helper.rb", "lib/boxgrinder-core/helpers/exec-helper.rb", "lib/boxgrinder-core/helpers/log-helper.rb", "lib/boxgrinder-core/models/appliance-config.rb", "lib/boxgrinder-core/models/config.rb", "lib/boxgrinder-core/models/task.rb", "lib/boxgrinder-core/validators/appliance-config-validator.rb", "lib/boxgrinder-core/validators/errors.rb", "rubygem-boxgrinder-core.spec", "spec/helpers/appliance-config-helper-spec.rb", "spec/helpers/appliance-definition-helper-spec.rb", "spec/helpers/exec-helper-spec.rb", "spec/helpers/log-helper-spec.rb", "spec/models/config-spec.rb", "spec/rspec/ls/one", "spec/rspec/ls/two", "spec/rspec/src/appliances/ephemeral-repo.appl", "spec/rspec/src/appliances/full.appl", "spec/rspec/src/appliances/invalid_yaml.appl", "spec/rspec/src/appliances/repo.appl", "spec/rspec/src/config/empty", "spec/rspec/src/config/valid", "spec/validators/appliance-config-validator-spec.rb"]
+  s.files = ["CHANGELOG", "LICENSE", "Manifest", "README", "Rakefile", "boxgrinder-core.gemspec", "lib/boxgrinder-core.rb", "lib/boxgrinder-core/helpers/appliance-config-helper.rb", "lib/boxgrinder-core/helpers/appliance-definition-helper.rb", "lib/boxgrinder-core/helpers/exec-helper.rb", "lib/boxgrinder-core/helpers/log-helper.rb", "lib/boxgrinder-core/models/appliance-config.rb", "lib/boxgrinder-core/models/config.rb", "lib/boxgrinder-core/models/task.rb", "lib/boxgrinder-core/validators/appliance-config-validator.rb", "lib/boxgrinder-core/validators/errors.rb", "rubygem-boxgrinder-core.spec", "spec/helpers/appliance-config-helper-spec.rb", "spec/helpers/appliance-definition-helper-spec.rb", "spec/helpers/exec-helper-spec.rb", "spec/helpers/log-helper-spec.rb", "spec/models/config-spec.rb", "spec/rspec/ls/one", "spec/rspec/ls/two", "spec/rspec/src/appliances/ephemeral-repo.appl", "spec/rspec/src/appliances/full.appl", "spec/rspec/src/appliances/invalid-yaml.appl", "spec/rspec/src/appliances/legacy.appl", "spec/rspec/src/appliances/repo.appl", "spec/rspec/src/config/empty", "spec/rspec/src/config/valid", "spec/validators/appliance-config-validator-spec.rb"]
   s.homepage = %q{http://www.jboss.org/boxgrinder}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Boxgrinder-core", "--main", "README"]
   s.require_paths = ["lib"]

data/lib/boxgrinder-core/helpers/appliance-definition-helper.rb

@@ -105,9 +105,24 @@ module BoxGrinder
 
       definition['variables'].each { |key, value| appliance_config.variables[key] = value } unless definition['variables'].nil?
 
-      raise "packages section should be an Array" if !definition['packages'].nil? and !definition['packages'].is_a?(Array)
+      @log.debug "Adding packages to appliance..."
+
+      unless definition['packages'].nil?
+        if definition['packages'].is_a?(Array)
+          # new format
+          appliance_config.packages = definition['packages']
+        elsif definition['packages'].is_a?(Hash)
+          # legacy format
+          @log.warn "BoxGrinder Build packages section format has been changed. Support for legacy format will be removed in the future. See http://boxgrinder.org/tutorials/appliance-definition/ for more information about current format."
+          appliance_config.packages = definition['packages']['includes'] if definition['packages']['includes'].is_a?(Array)
+          @log.warn "BoxGrinder Build no longer supports package exclusion, the following packages will not be explicitly excluded: #{definition['packages']['excludes'].join(", ")}." if definition['packages']['excludes'].is_a?(Array)
+        else
+          @log.warn "Unsupported format for packages section."
+        end
+      end
+
+      @log.debug "#{appliance_config.packages.size} package(s) added to appliance."
 
-      appliance_config.packages = definition['packages'] if definition['packages'].is_a?(Array)
       appliance_config.appliances = definition['appliances'] unless definition['appliances'].nil?
       appliance_config.repos = definition['repos'] unless definition['repos'].nil?
 

data/lib/boxgrinder-core/helpers/exec-helper.rb

@@ -26,8 +26,13 @@ module BoxGrinder
       @log = options[:log] || Logger.new(STDOUT)
     end
 
-    def execute( command )
-      @log.debug "Executing command: '#{command}'"
+    def execute( command, options = {} )
+      redacted = options[:redacted] || []
+
+      redacted_command = command
+      redacted.each { |word| redacted_command = redacted_command.gsub(word, '<REDACTED>') }
+
+      @log.debug "Executing command: '#{redacted_command}'"
 
       output = ""
 
@@ -66,8 +71,7 @@ module BoxGrinder
         return output.strip
       rescue => e
         @log.error e.backtrace.join($/)
-        @log.error "An error occurred while executing command: '#{command}', #{e.message}"
-        raise "An error occurred while executing command: '#{command}', #{e.message}"
+        raise "An error occurred while executing command: '#{redacted_command}', #{e.message}"
       end
     end
   end

data/lib/boxgrinder-core/helpers/log-helper.rb

@@ -67,7 +67,7 @@ module BoxGrinder
         FileUtils.mkdir_p(File.dirname(location))
 
         @file_log             = Logger.new(location, 10, 1024000)
-        @file_log.level       = threshold == Logger::TRACE ? Logger::TRACE : Logger::DEBUG
+        @file_log.level       = Logger::TRACE
         @file_log.formatter   = formatter
       end
 

data/rubygem-boxgrinder-core.spec

@@ -5,7 +5,7 @@
 
 Summary: Core library for BoxGrinder
 Name: rubygem-%{gemname}
-Version: 0.2.1
+Version: 0.3.0
 Release: 1%{?dist}
 Group: Development/Languages
 License: LGPLv3+
@@ -74,6 +74,11 @@ popd
 %{gemdir}/doc/%{gemname}-%{version}
 
 %changelog
+* Sat Mar 05 2011  <mgoldman@redhat.com> - 0.3.0-1
+- Upstream release: 0.3.0
+- [BGBUILD-178] Remove sensitive data from logs
+- [BGBUILD-168] Support deprecated package inclusion format in appliance definitions
+
 * Tue Feb 16 2011  <mgoldman@redhat.com> - 0.2.1-1
 - Upstream release: 0.2.1
 - [BGBUILD-142] Backtraces make output unreadable - add option to enable them, and disable by default

data/spec/helpers/appliance-definition-helper-spec.rb

@@ -22,7 +22,7 @@ module BoxGrinder
   describe ApplianceDefinitionHelper do
 
     before(:each) do
-      @helper = ApplianceDefinitionHelper.new(:log => Logger.new('/dev/null'))
+      @helper = ApplianceDefinitionHelper.new(:log => LogHelper.new(:level => :trace, :type => :stdout))
     end
 
     describe ".read_definitions" do
@@ -166,7 +166,7 @@ module BoxGrinder
         configs.first.should == appliance_a
       end
 
-      it "should read a YAML content instead of a loading a file" do
+      it "should read YAML content instead of loading a file" do
         yaml = "name: abc\nos:\n  name: fedora\n  version: 13\npackages:\n  - @core\nhardware:\n  partitions:\n    \"/\":\n      size: 6"
         appliance = @helper.read_definitions(yaml).last
 
@@ -184,7 +184,7 @@ module BoxGrinder
       end
 
       it "should catch exception if YAML file parsing raises it" do
-        lambda { @helper.read_definitions("#{File.dirname(__FILE__)}/../rspec/src/appliances/invalid_yaml.appl") }.should raise_error(RuntimeError, /File '(.*)' could not be read./)
+        lambda { @helper.read_definitions("#{File.dirname(__FILE__)}/../rspec/src/appliances/invalid-yaml.appl") }.should raise_error(RuntimeError, /File '(.*)' could not be read./)
       end
 
       it "should raise because xml files aren't supported yet" do
@@ -263,6 +263,12 @@ module BoxGrinder
           appliance_config.hardware.partitions['/'].should == {'size' => 1}
           appliance_config.hardware.partitions['/home'].should == {'size' => 1}
         end
+
+        it "should allow legacy package inclusion style" do
+          appliance = @helper.read_yaml_file("#{File.dirname(__FILE__)}/../rspec/src/appliances/legacy.appl")
+          appliance.packages.should == ['squid','boxgrinder-rest']
+        end
+
       end
     end
   end

data/spec/helpers/exec-helper-spec.rb

@@ -21,11 +21,11 @@ require 'boxgrinder-core/helpers/exec-helper'
 module BoxGrinder
   describe ExecHelper do
     before(:each) do
-      @helper = ExecHelper.new( :log => Logger.new('/dev/null') )
+      @helper = ExecHelper.new(:log => Logger.new('/dev/null'))
     end
 
     it "should fail when command doesn't exists" do
-      Open4.should_receive( :popen4 ).with('thisdoesntexists').and_raise('abc')
+      Open4.should_receive(:popen4).with('thisdoesntexists').and_raise('abc')
 
       proc { @helper.execute("thisdoesntexists") }.should raise_error("An error occurred while executing command: 'thisdoesntexists', abc")
     end
@@ -34,7 +34,7 @@ module BoxGrinder
       open4 = mock(Open4)
       open4.stub!(:exitstatus).and_return(1)
 
-      Open4.should_receive( :popen4 ).with('abc').and_return(open4)
+      Open4.should_receive(:popen4).with('abc').and_return(open4)
 
       proc { @helper.execute("abc") }.should raise_error("An error occurred while executing command: 'abc', process exited with wrong exit status: 1")
     end
@@ -43,17 +43,27 @@ module BoxGrinder
       open4 = mock(Open4)
       open4.stub!(:exitstatus).and_return(0)
 
-      Open4.should_receive( :popen4 ).with('abc').and_return(open4)
+      Open4.should_receive(:popen4).with('abc').and_return(open4)
 
       proc { @helper.execute("abc") }.should_not raise_error
     end
 
     it "should execute the command and return output" do
-      @helper.execute("ls #{File.dirname( __FILE__ )}/../rspec/ls | wc -l").should == "2"
+      @helper.execute("ls #{File.dirname(__FILE__)}/../rspec/ls | wc -l").should == "2"
     end
 
     it "should execute the command and return multi line output" do
-      @helper.execute("ls -1 #{File.dirname( __FILE__ )}/../rspec/ls").should == "one\ntwo"
+      @helper.execute("ls -1 #{File.dirname(__FILE__)}/../rspec/ls").should == "one\ntwo"
+    end
+
+    it "should redact some words from a command" do
+      log = mock('Logger')
+      log.should_receive(:debug).with("Executing command: 'ala ma <REDACTED> i jest fajnie'")
+
+      @helper = ExecHelper.new(:log => log)
+      Open4.should_receive(:popen4).and_return(OpenStruct.new(:exitstatus => 0))
+
+      @helper.execute("ala ma kota i jest fajnie", :redacted => ['kota'])
     end
   end
 end

data/spec/helpers/log-helper-spec.rb

@@ -36,7 +36,7 @@ module BoxGrinder
       file_log    = @helper.instance_variable_get(:@file_log)
 
       stdout_log.level.should == Logger::INFO
-      file_log.level.should == Logger::DEBUG
+      file_log.level.should == Logger::TRACE
     end
 
     it "should allow to log in every known log level" do
@@ -56,7 +56,7 @@ module BoxGrinder
       file_log    = @helper.instance_variable_get(:@file_log)
 
       stdout_log.level.should == Logger::DEBUG
-      file_log.level.should == Logger::DEBUG
+      file_log.level.should == Logger::TRACE
     end
 
     it "should change log level" do
@@ -68,7 +68,7 @@ module BoxGrinder
       file_log    = @helper.instance_variable_get(:@file_log)
 
       stdout_log.level.should == Logger::INFO
-      file_log.level.should == Logger::DEBUG
+      file_log.level.should == Logger::TRACE
     end
   end
 end

data/spec/rspec/src/appliances/legacy.appl

@@ -0,0 +1,8 @@
+name: legacy test
+summary: testing legacy format support
+packages:
+  includes:
+    - squid
+    - boxgrinder-rest
+  excludes:
+    - useless

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: boxgrinder-core
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 19
   prerelease: false
   segments: 
   - 0
-  - 2
-  - 1
-  version: 0.2.1
+  - 3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Marek Goldmann
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-22 00:00:00 +01:00
+date: 2011-03-09 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -97,7 +97,8 @@ files:
 - spec/rspec/ls/two
 - spec/rspec/src/appliances/ephemeral-repo.appl
 - spec/rspec/src/appliances/full.appl
-- spec/rspec/src/appliances/invalid_yaml.appl
+- spec/rspec/src/appliances/invalid-yaml.appl
+- spec/rspec/src/appliances/legacy.appl
 - spec/rspec/src/appliances/repo.appl
 - spec/rspec/src/config/empty
 - spec/rspec/src/config/valid