backup_jenkins 0.0.9 → 0.0.10

data/lib/backup_jenkins/backup.rb

@@ -8,34 +8,6 @@ module BackupJenkins
       @config = config
     end
 
-    def backup_directory
-      @backup_directory ||= "#{config.backup["dir_base"]}/#{config.base_file_name}_#{timestamp}"
-    end
-
-    def create_dir_and_copy(file_names)
-      file_names.each do |file_name|
-        create_dir_and_copy_impl(file_name)
-      end
-    end
-
-    def list_local_files
-      format_backup_file_data(backup_files)
-    end
-
-    def create_dir_and_copy_impl(file_name)
-      raise "file '#{file_name}' does not exist" unless FileTest.file?(file_name)
-
-      new_file_name = new_file_path(file_name)
-      new_file_dir = File.dirname(new_file_name)
-
-      FileUtils.mkdir_p(new_file_dir, :verbose => config.verbose)
-      FileUtils.cp(file_name, new_file_name, :verbose => config.verbose)
-    end
-
-    def new_file_path(file_name)
-      "#{backup_directory}/#{file_name.gsub(%r{#{config.jenkins["home"]}}, "")}".gsub(%r{//}, '/')
-    end
-
     def do_backup
       raise "Backup directory already exists! (#{backup_directory})" if FileTest.directory?(backup_directory)
 
@@ -48,15 +20,12 @@ module BackupJenkins
       clean_up
     end
 
-    def remove_old_backups
-      files_to_remove.each do |file|
-        FileUtils.rm(file)
-      end
+    def tarball_filename
+      "#{backup_directory}.tar.bz2"
     end
 
-    def files_to_remove
-      glob_of_backup_files -
-        glob_of_backup_files.last(config.backup["backups_to_keep"]["local"])
+    def list_local_files
+      format_backup_file_data(backup_files)
     end
 
     def clean_up
@@ -65,8 +34,19 @@ module BackupJenkins
 
       puts "Removing #{tarball_filename}"
       FileUtils.rm_rf(tarball_filename)
-    rescue Errno::ENOENT => e
-      puts e
+    rescue Errno::ENOENT
+    end
+
+    private
+
+    attr_reader :config
+
+    def backup_directory
+      @backup_directory ||= "#{config.backup["dir_base"]}/#{config.base_file_name}_#{timestamp}"
+    end
+
+    def timestamp
+      Time.now.strftime("%Y%m%d_%H%M")
     end
 
     def copy_files
@@ -75,6 +55,26 @@ module BackupJenkins
       create_dir_and_copy(jobs_files)
     end
 
+    def create_dir_and_copy(file_names)
+      file_names.each do |file_name|
+        create_dir_and_copy_impl(file_name)
+      end
+    end
+
+    def create_dir_and_copy_impl(file_name)
+      raise "file '#{file_name}' does not exist" unless FileTest.file?(file_name)
+
+      new_file_name = new_file_path(file_name)
+      new_file_dir = File.dirname(new_file_name)
+
+      FileUtils.mkdir_p(new_file_dir, :verbose => config.verbose)
+      FileUtils.cp(file_name, new_file_name, :verbose => config.verbose)
+    end
+
+    def new_file_path(file_name)
+      "#{backup_directory}/#{file_name.gsub(%r{#{config.jenkins["home"]}}, "")}".gsub(%r{//}, '/')
+    end
+
     def plugin_files
       Dir["#{config.jenkins["home"]}/plugins/*.jpi"] +
         Dir["#{config.jenkins["home"]}/plugins/*.jpi.pinned"] +
@@ -90,31 +90,31 @@ module BackupJenkins
     end
 
     def create_tarball
+      puts "Creating #{tarball_filename}..." if config.verbose
       Dir.chdir(backup_directory)
       %x{tar #{tar_options} #{tarball_filename} .}
       raise "Error creating tarball" unless FileTest.file?(tarball_filename)
     end
 
-    def remove_temporary_files
-      FileUtils.rm_rf(backup_directory, :verbose => config.verbose)
-    end
-
-    def tarball_filename
-      "#{backup_directory}.tar.bz2"
-    end
-
     def tar_options
       %w(j c f).tap do |options|
         options.unshift('v') if config.verbose
       end.join('')
     end
 
-    private
+    def remove_old_backups
+      files_to_remove.each do |file|
+        FileUtils.rm(file)
+      end
+    end
 
-    attr_reader :config
+    def files_to_remove
+      glob_of_backup_files -
+        glob_of_backup_files.last(config.backup["backups_to_keep"]["local"])
+    end
 
-    def timestamp
-      Time.now.strftime("%Y%m%d_%H%M")
+    def glob_of_backup_files
+      Dir["#{config.backup["dir_base"]}/#{config.base_file_name}_*tar.bz2"]
     end
 
     def backup_files
@@ -126,8 +126,8 @@ module BackupJenkins
       end
     end
 
-    def glob_of_backup_files
-      Dir["#{config.backup["dir_base"]}/#{config.base_file_name}_*tar.bz2"]
+    def remove_temporary_files
+      FileUtils.rm_rf(backup_directory, :verbose => config.verbose)
     end
   end
 end

data/lib/backup_jenkins/cli.rb

@@ -9,13 +9,6 @@ module BackupJenkins
       end
     end
 
-    def check_config
-      if !config.valid?
-        STDERR.puts "Config file is incorrect."
-        show_help
-      end
-    end
-
     def parse_options
       options.each do |opt, arg|
         case opt
@@ -45,6 +38,23 @@ module BackupJenkins
       show_help
     end
 
+    def check_config
+      if !config.valid?
+        STDERR.puts "Config file is incorrect."
+        show_help
+      end
+    end
+
+    def run
+      do_backup
+      upload_file unless @only_local
+    rescue Interrupt
+      clean_up_backup
+      exit 0
+    end
+
+    private
+
     def options_possible
       [
         [
@@ -65,15 +75,6 @@ module BackupJenkins
       ]
     end
 
-    def run
-      do_backup
-      upload_file unless @only_local
-    rescue Interrupt
-      clean_up_backup
-    end
-
-    private
-
     def do_backup
       backup.do_backup
     end

data/lib/backup_jenkins/config.rb

@@ -10,23 +10,10 @@ module BackupJenkins
       !verbose.nil? && jenkins_valid? && aws_valid? && backup_valid?
     end
 
-    def method_missing(meth, *args, &block)
-      return config[meth.to_s] if config.has_key?(meth.to_s)
-      super
-    end
-
-    def respond_to?(meth)
-      config.has_key?(meth.to_s) || super
-    end
-
     def base_file_name
       "#{backup["file_name_base"]}_#{hostname}"
     end
 
-    def hostname
-      %x{hostname -s}.chomp
-    end
-
     def override(options = {})
       @config.merge!(options)
     end
@@ -35,6 +22,10 @@ module BackupJenkins
 
     attr_reader :config
 
+    def default_config_file_path
+      "#{ENV['HOME']}/.config/backup_jenkins/config.yml"
+    end
+
     def config_file(config_file_path)
       YAML.load_file(config_file_path)
     rescue Errno::ENOENT
@@ -44,10 +35,6 @@ module BackupJenkins
       exit 1
     end
 
-    def default_config_file_path
-      "#{ENV['HOME']}/.config/backup_jenkins/config.yml"
-    end
-
     def config_file_example
       File.read(config_file_example_path)
     end
@@ -70,5 +57,18 @@ module BackupJenkins
         backup["backups_to_keep"]["remote"] &&
         backup["backups_to_keep"]["local"]
     end
+
+    def hostname
+      %x{hostname -s}.chomp
+    end
+
+    def method_missing(meth, *args, &block)
+      return config[meth.to_s] if config.has_key?(meth.to_s)
+      super
+    end
+
+    def respond_to?(meth)
+      config.has_key?(meth.to_s) || super
+    end
   end
 end

data/lib/backup_jenkins/formatter.rb

@@ -1,32 +1,64 @@
 module BackupJenkins
   module Formatter
 
-    # Assumes that filenames are ordered already
+    # Assumes that filenames are ordered already.
+    #
     # Requires a structure like:
     # [
     #   { :key => "jenkins_berman_20121107_1721.tar.bz2", :content_length => 88762813 },
     #   { :key => "jenkins_berman_20121107_1745.tar.bz2", :content_length => 88762572 }
     # ]
     def format_backup_file_data(file_hashes)
-      by_host = {}
-      file_hashes.each do |file_hash|
-        (date, host, key) = extract_data_from_filename(file_hash[:key])
-        by_host[host] ||= []
-        by_host[host].push([date, key, file_hash[:content_length] / 2.0**20])
+      by_host = build_structure_by_host(file_hashes)
+      by_host_to_formatted_output(by_host)
+    end
+
+    private
+
+    BYTES_IN_MBYTE = 2.0 ** 20
+
+    class EntryFormatter
+      def initialize(entry)
+        @entry = entry
       end
 
-      "".tap do |output|
-        by_host.keys.sort.each do |host|
-          data = by_host[host]
-          output << host.capitalize << ":" << $/
-          data.each do |datum|
-            output << sprintf("  - %s key: %s (%0.2f MB)#{$/}", *datum)
-          end
-          output << $/
+      def to_s
+        sprintf("  - %s key: %s (%0.2f MB)#{$/}", *entry)
+      end
+
+      private
+
+      attr_reader :entry
+    end
+
+    class DataFormatter
+      def initialize(data)
+        @entries = data.map{ |entry| EntryFormatter.new(entry) }
+      end
+
+      def to_s
+        entries.map(&:to_s).join
+      end
+
+      private
+
+      attr_reader :entries
+    end
+
+    def build_structure_by_host(file_hashes)
+      {}.tap do |by_host|
+        file_hashes.each do |file_hash|
+          (date, host, key) = extract_data_from_filename(file_hash[:key])
+          by_host[host] ||= []
+          by_host[host].push([date, key, bytes_to_mb(file_hash[:content_length])])
         end
       end
     end
 
+    def bytes_to_mb(bytes)
+      bytes / BYTES_IN_MBYTE
+    end
+
     def extract_data_from_filename(filename)
       sans_base = filename.gsub(/#{config.backup["file_name_base"]}_/, '').gsub(/\.tar\.bz2/, '')
       (hostname, date, time) = sans_base.split("_")
@@ -34,5 +66,17 @@ module BackupJenkins
       [formatted_date, hostname, filename]
     end
 
+    def by_host_to_formatted_output(by_host)
+      "".tap do |output|
+        by_host.keys.sort.each do |host|
+          data = by_host[host]
+          output << build_host_entry(host, data)
+        end
+      end
+    end
+
+    def build_host_entry(host, data)
+      host.capitalize << ":" << $/ << DataFormatter.new(data).to_s << $/
+    end
   end
 end

data/lib/backup_jenkins/version.rb

@@ -1,3 +1,3 @@
 module BackupJenkins
-  VERSION = "0.0.9"
+  VERSION = "0.0.10"
 end

data/spec/lib/backup_jenkins/backup_spec.rb

@@ -38,7 +38,8 @@ describe BackupJenkins::Backup do
       config.should_receive(:base_file_name).and_return("filename")
       subject.should_receive(:timestamp).and_return("timestamp")
 
-      subject.backup_directory.should == "/path/to/some/dir_base/filename_timestamp"
+      subject.send(:backup_directory).should ==
+        "/path/to/some/dir_base/filename_timestamp"
     end
 
     it "should get data only once" do
@@ -46,9 +47,9 @@ describe BackupJenkins::Backup do
       config.should_receive(:base_file_name).once.and_return("filename")
       subject.should_receive(:timestamp).once.and_return("timestamp")
 
-      subject.backup_directory
-      subject.backup_directory
-      subject.backup_directory
+      subject.send(:backup_directory)
+      subject.send(:backup_directory)
+      subject.send(:backup_directory)
     end
   end
 
@@ -61,7 +62,7 @@ describe BackupJenkins::Backup do
       subject.stub(:create_dir_and_copy)
     end
 
-    after { subject.copy_files }
+    after { subject.send(:copy_files) }
 
     it { subject.should_receive(:create_dir_and_copy).with("plugin_files") }
     it { subject.should_receive(:create_dir_and_copy).with("user_content_files") }
@@ -74,7 +75,7 @@ describe BackupJenkins::Backup do
       subject.should_receive(:create_dir_and_copy_impl).with("b")
       subject.should_receive(:create_dir_and_copy_impl).with("c")
 
-      subject.create_dir_and_copy(%w(a b c))
+      subject.send(:create_dir_and_copy, %w(a b c))
     end
   end
 
@@ -120,22 +121,22 @@ describe BackupJenkins::Backup do
 
     it "should get the new file path of the file" do
       subject.should_receive(:new_file_path)
-      subject.create_dir_and_copy_impl("filename")
+      subject.send(:create_dir_and_copy_impl, "filename")
     end
 
     it "should create directory new_directory" do
       FileUtils.should_receive(:mkdir_p).with("/this/is/a/new/path", :verbose => false)
-      subject.create_dir_and_copy_impl("filename")
+      subject.send(:create_dir_and_copy_impl, "filename")
     end
 
     it "should copy old file to new file" do
       FileUtils.should_receive(:cp).with("filename", "/this/is/a/new/path/to_file", :verbose => false)
-      subject.create_dir_and_copy_impl("filename")
+      subject.send(:create_dir_and_copy_impl, "filename")
     end
 
     it "should raise error if file to copy from doesn't exist" do
       FileTest.should_receive(:file?).and_return(false)
-      expect{ subject.create_dir_and_copy_impl("filename") }.to raise_error
+      expect{ subject.send(:create_dir_and_copy_impl, "filename") }.to raise_error
     end
   end
 
@@ -152,14 +153,14 @@ describe BackupJenkins::Backup do
     end
 
     context do
-      after { subject.create_tarball }
+      after { subject.send(:create_tarball) }
       it { Dir.should_receive(:chdir).with("directory") }
       it { subject.should_receive(:`).with("tar options directory.tar.bz2 .") }
     end
 
     it "should raise error if file doesn't exist" do
       FileTest.should_receive(:file?).and_return(false)
-      expect{ subject.create_tarball }.to raise_error
+      expect{ subject.send(:create_tarball) }.to raise_error
     end
   end
 
@@ -200,7 +201,7 @@ describe BackupJenkins::Backup do
       subject.should_receive(:`).
         with("find home/jobs -maxdepth 3 -name config.xml -or -name nextBuildNumber").
         and_return("file1\nfile2\nfile3")
-      subject.jobs_files.should == %w(file1 file2 file3)
+      subject.send(:jobs_files).should == %w(file1 file2 file3)
     end
   end
 
@@ -209,7 +210,8 @@ describe BackupJenkins::Backup do
       subject.should_receive(:backup_directory).and_return("backup_directory")
       config.should_receive(:jenkins).and_return({ "home" => "some_nice_house"})
 
-      subject.new_file_path("some_nice_house/and/then/a/room").should == "backup_directory/and/then/a/room"
+      subject.send(:new_file_path, "some_nice_house/and/then/a/room").should ==
+        "backup_directory/and/then/a/room"
     end
   end
 
@@ -221,7 +223,7 @@ describe BackupJenkins::Backup do
       Dir.should_receive(:[]).with("home/plugins/*.jpi.pinned").and_return(["pinned"])
       Dir.should_receive(:[]).with("home/plugins/*.jpi.disabled").and_return(["disabled"])
 
-      subject.plugin_files.should == %w(jpi pinned disabled)
+      subject.send(:plugin_files).should == %w(jpi pinned disabled)
     end
   end
 
@@ -230,7 +232,7 @@ describe BackupJenkins::Backup do
       subject.should_receive(:files_to_remove).and_return(['a_file'])
       FileUtils.should_receive(:rm).with('a_file')
 
-      subject.remove_old_backups
+      subject.send(:remove_old_backups)
     end
   end
 
@@ -243,7 +245,7 @@ describe BackupJenkins::Backup do
     end
 
     it "should remove old files" do
-      subject.files_to_remove.should == %w(old_file_1 old_file_2 old_file_3)
+      subject.send(:files_to_remove).should == %w(old_file_1 old_file_2 old_file_3)
     end
   end
 
@@ -253,19 +255,19 @@ describe BackupJenkins::Backup do
       config.stub(:verbose).and_return(false)
     end
 
-    after { subject.remove_temporary_files }
+    after { subject.send(:remove_temporary_files) }
     it { FileUtils.should_receive(:rm_rf).with("backup_directory", :verbose => false) }
   end
 
   describe "#tar_options" do
     it "should be jcf" do
       config.should_receive(:verbose).and_return(false)
-      subject.tar_options == "jcf"
+      subject.send(:tar_options) == "jcf"
     end
 
     it "should be vjcf" do
       config.should_receive(:verbose).and_return(true)
-      subject.tar_options == "vjcf"
+      subject.send(:tar_options) == "vjcf"
     end
   end
 
@@ -287,7 +289,7 @@ describe BackupJenkins::Backup do
 
     it "should return files inside the userContent directory" do
       Dir.should_receive(:[]).with("home/userContent/*").and_return(["my_file"])
-      subject.user_content_files.should == %w(my_file)
+      subject.send(:user_content_files).should == %w(my_file)
     end
   end
 end

data/spec/lib/backup_jenkins/cli_spec.rb

@@ -113,21 +113,25 @@ describe BackupJenkins::CLI do
   end
 
   describe "#run" do
-    after { subject.run }
+    context do
+      after { subject.run }
 
-    it { subject.should_receive(:do_backup) }
-    it { subject.should_receive(:upload_file) }
+      it { subject.should_receive(:do_backup) }
+      it { subject.should_receive(:upload_file) }
 
-    it "should not upload file if only_local is set" do
-      subject.instance_variable_set(:"@only_local", true)
+      it "should not upload file if only_local is set" do
+        subject.instance_variable_set(:"@only_local", true)
 
-      subject.should_receive(:do_backup)
-      subject.should_not_receive(:upload_file)
+        subject.should_receive(:do_backup)
+        subject.should_not_receive(:upload_file)
+      end
     end
 
     it "should clean up" do
       subject.should_receive(:do_backup).and_raise(Interrupt)
       backup.should_receive(:clean_up)
+
+      expect{ subject.run }.to raise_error SystemExit
     end
   end
 

data/spec/lib/backup_jenkins/config_spec.rb

@@ -24,7 +24,7 @@ describe BackupJenkins::Config do
   end
 
   describe "#hostname" do
-    after { subject.hostname.should == 'hostname' }
+    after { subject.send(:hostname).should == 'hostname' }
     it { subject.should_receive(:`).with("hostname -s").and_return("hostname\n") }
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: backup_jenkins
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.10
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-09 00:00:00.000000000 Z
+date: 2012-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &32124580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,15 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *32124580
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &32124160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -37,12 +32,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *32124160
 description: Simple Jenkins config and plugin backup to S3
 email:
 - jcmuller@gmail.com
@@ -95,14 +85,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: This gem allows you to get a backup instance of jenkins up and running pretty
   quickly
 test_files:
-- spec/lib/backup_jenkins/aws_spec.rb
+- spec/lib/backup_jenkins/formatter_spec.rb
 - spec/lib/backup_jenkins/backup_spec.rb
 - spec/lib/backup_jenkins/cli_spec.rb
 - spec/lib/backup_jenkins/config_spec.rb
-- spec/lib/backup_jenkins/formatter_spec.rb
+- spec/lib/backup_jenkins/aws_spec.rb