backup_jenkins 0.0.10 → 0.0.11

data/backup_jenkins.gemspec

@@ -16,5 +16,7 @@ Gem::Specification.new do |gem|
   gem.version       = BackupJenkins::VERSION
 
   gem.add_dependency("aws-sdk")
+  gem.add_dependency("hashie")
+
   gem.add_development_dependency("rake")
 end

data/lib/backup_jenkins/aws.rb

@@ -54,7 +54,7 @@ module BackupJenkins
 
     # TODO change this to use a time decay algorithm
     def files_to_remove
-      files - files.last(config.backup["backups_to_keep"]["remote"])
+      files - files.last(config.backup.backups_to_keep.remote)
     end
 
     def files
@@ -66,20 +66,20 @@ module BackupJenkins
     end
 
     def backup_files_for_all_hosts
-      s3_files.with_prefix(config.backup["file_name_base"])
+      s3_files.with_prefix(config.backup.file_name_base)
     end
 
     def setup_aws
       s3 = initialize_s3_object
-      @bucket = s3.buckets[config.aws["bucket_name"]]
-      @bucket = s3.buckets.create(config.aws["bucket_name"]) unless @bucket.exists?
+      @bucket = s3.buckets[config.aws.bucket_name]
+      @bucket = s3.buckets.create(config.aws.bucket_name) unless @bucket.exists?
       raise "Couldn't create bucket!" unless @bucket.exists?
     end
 
     def initialize_s3_object
       ::AWS::S3.new(
-        :access_key_id => config.aws["access_key"],
-        :secret_access_key => config.aws["secret"]
+        :access_key_id => config.aws.access_key,
+        :secret_access_key => config.aws.secret
       )
     end
 

data/lib/backup_jenkins/backup.rb

@@ -42,7 +42,7 @@ module BackupJenkins
     attr_reader :config
 
     def backup_directory
-      @backup_directory ||= "#{config.backup["dir_base"]}/#{config.base_file_name}_#{timestamp}"
+      @backup_directory ||= "#{config.backup.dir_base}/#{config.base_file_name}_#{timestamp}"
     end
 
     def timestamp
@@ -72,21 +72,21 @@ module BackupJenkins
     end
 
     def new_file_path(file_name)
-      "#{backup_directory}/#{file_name.gsub(%r{#{config.jenkins["home"]}}, "")}".gsub(%r{//}, '/')
+      "#{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"] +
-        Dir["#{config.jenkins["home"]}/plugins/*.jpi.disabled"]
+      Dir["#{config.jenkins.home}/plugins/*.jpi"] +
+        Dir["#{config.jenkins.home}/plugins/*.jpi.pinned"] +
+        Dir["#{config.jenkins.home}/plugins/*.jpi.disabled"]
     end
 
     def user_content_files
-      Dir["#{config.jenkins["home"]}/userContent/*"]
+      Dir["#{config.jenkins.home}/userContent/*"]
     end
 
     def jobs_files
-      `find #{config.jenkins["home"]}/jobs -maxdepth 3 -name config.xml -or -name nextBuildNumber`.split(/\n/)
+      `find #{config.jenkins.home}/jobs -maxdepth 3 -name config.xml -or -name nextBuildNumber`.split(/\n/)
     end
 
     def create_tarball
@@ -110,17 +110,17 @@ module BackupJenkins
 
     def files_to_remove
       glob_of_backup_files -
-        glob_of_backup_files.last(config.backup["backups_to_keep"]["local"])
+        glob_of_backup_files.last(config.backup.backups_to_keep.local)
     end
 
     def glob_of_backup_files
-      Dir["#{config.backup["dir_base"]}/#{config.base_file_name}_*tar.bz2"]
+      Dir["#{config.backup.dir_base}/#{config.base_file_name}_*tar.bz2"]
     end
 
     def backup_files
       glob_of_backup_files.sort.map do |file|
         {
-          :key => file.gsub(%r{#{config.backup["dir_base"]}/}, ''),
+          :key => file.gsub(%r{#{config.backup.dir_base}/}, ''),
           :content_length => File.size(file)
         }
       end

data/lib/backup_jenkins/cli.rb

@@ -9,6 +9,9 @@ module BackupJenkins
       end
     end
 
+    # TODO Some options depend on the config file being correct. Some other
+    # options exit. Mark different options with whether they do one thing or
+    # another.
     def parse_options
       options.each do |opt, arg|
         case opt

data/lib/backup_jenkins/config.rb

@@ -3,7 +3,7 @@ module BackupJenkins
     attr_reader :s3
 
     def initialize(path = default_config_file_path)
-      @config = config_file(path)
+      @config = Hashie::Mash.new(config_file(path))
     end
 
     def valid?
@@ -11,7 +11,7 @@ module BackupJenkins
     end
 
     def base_file_name
-      "#{backup["file_name_base"]}_#{hostname}"
+      "#{backup.file_name_base}_#{hostname}"
     end
 
     def override(options = {})
@@ -44,18 +44,21 @@ module BackupJenkins
     end
 
     def aws_valid?
-      aws["access_key"] && aws["secret"] && aws["bucket_name"]
+      aws.access_key &&
+        aws.secret &&
+        aws.bucket_name
     end
 
     def jenkins_valid?
-      !!jenkins["home"]
+      !!jenkins.home
     end
 
     def backup_valid?
-      backup["dir_base"] && backup["file_name_base"] &&
-        backup["backups_to_keep"] &&
-        backup["backups_to_keep"]["remote"] &&
-        backup["backups_to_keep"]["local"]
+      backup.dir_base &&
+        backup.file_name_base &&
+        backup.backups_to_keep &&
+        backup.backups_to_keep.remote &&
+        backup.backups_to_keep.local
     end
 
     def hostname

data/lib/backup_jenkins/formatter.rb

@@ -60,7 +60,7 @@ module BackupJenkins
     end
 
     def extract_data_from_filename(filename)
-      sans_base = filename.gsub(/#{config.backup["file_name_base"]}_/, '').gsub(/\.tar\.bz2/, '')
+      sans_base = filename.gsub(/#{config.backup.file_name_base}_/, '').gsub(/\.tar\.bz2/, '')
       (hostname, date, time) = sans_base.split("_")
       formatted_date = Time.parse(date << time).strftime("%Y/%m/%d %H:%M")
       [formatted_date, hostname, filename]

data/lib/backup_jenkins/version.rb

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

data/lib/backup_jenkins.rb

@@ -1,6 +1,7 @@
 require 'rubygems'
 require 'aws'
 require 'getoptlong'
+require 'hashie'
 require 'time'
 require 'yaml'
 

data/spec/lib/backup_jenkins/aws_spec.rb

@@ -1,26 +1,30 @@
 require 'spec_helper'
 
 describe BackupJenkins::AWS do
-  let(:config) { stub }
-  let(:s3_mocks) { stub(:buckets => stub(:[] => stub(:exists? => true), :create => true)) }
+  let(:config) { stub(:aws => aws, :backup => backup) }
+  let(:s3_mocks) {
+    stub(:buckets => stub(:[] => stub(:exists? => true), :create => true))
+  }
+  let(:aws) {
+    stub(
+      :access_key => "some_key",
+      :secret => "some_secret",
+      :bucket_name => "some_bucket"
+    )
+  }
+  let(:backup) {
+    stub(:backups_to_keep => stub(:remote => 2), :file_name_base => "jenkins")
+  }
 
   before do
     BackupJenkins::Config.stub(:new).and_return(config)
-
-    config.stub(:aws).and_return({ "access_key" => "some_key", "secret" => "some_secret" })
-    config.stub(:backup).and_return({ "backups_to_keep" => { "remote" => 2 }, "file_name_base" => "jenkins" })
-
     ::AWS::S3.stub(:new).and_return(s3_mocks)
   end
 
   describe "#setup_aws" do
-    after do
-      subject
-    end
+    after { subject }
 
-    it "should instantiate an S3 object" do
-      ::AWS::S3.should_receive(:new).and_return(s3_mocks)
-    end
+    it { ::AWS::S3.should_receive(:new).and_return(s3_mocks) }
 
     it "shuld create bucket" do
       s3_mocks.buckets.should_receive(:[]).and_return(mock(:exists? => false))
@@ -53,7 +57,7 @@ describe BackupJenkins::AWS do
 
   describe "#backup_files_for_all_hosts" do
     it "should return the right files" do
-      config.should_receive(:backup).and_return("file_name_base" => "base_file_name")
+      config.should_receive(:backup).and_return(mock(:file_name_base => "base_file_name"))
       objects = mock
       objects.should_receive(:with_prefix).with("base_file_name").and_return([1, 2, 3])
       subject.should_receive(:s3_files).and_return(objects)

data/spec/lib/backup_jenkins/backup_spec.rb

@@ -16,7 +16,7 @@ describe BackupJenkins::Backup do
   describe "#backup_files" do
     it "should get a listing for all the files in backup directory" do
       file = "dir/base_1234"
-      config.stub(:backup).and_return("dir_base" => "dir")
+      config.stub_chain(:backup, :dir_base).and_return("dir")
       config.stub(:base_file_name).and_return("base")
 
       File.should_receive(:size).with(file).and_return("size")
@@ -31,7 +31,7 @@ describe BackupJenkins::Backup do
   end
 
   describe "#backup_directory" do
-    let(:backup) { { "dir_base" => "/path/to/some/dir_base" } }
+    let(:backup) { mock(:dir_base => "/path/to/some/dir_base") }
 
     it "should return the dir base + the base file name + time stamp" do
       config.should_receive(:backup).and_return(backup)
@@ -81,7 +81,7 @@ describe BackupJenkins::Backup do
 
   describe "#list_local_files" do
     before do
-      config.stub(:backup).and_return("dir_base" => "base")
+      config.stub_chain(:backup, :dir_base).and_return("base")
       config.stub(:base_file_name).and_return("base_file_name")
     end
 
@@ -195,7 +195,7 @@ describe BackupJenkins::Backup do
   end
 
   describe "#jobs_files" do
-    before { config.stub(:jenkins).and_return({ "home" => "home" }) }
+    before { config.stub_chain(:jenkins, :home).and_return("home") }
 
     it "should return the config.xml and nextBuildNumber files in job directories" do
       subject.should_receive(:`).
@@ -208,7 +208,7 @@ describe BackupJenkins::Backup do
   describe "#new_file_path" do
     it "should return backup_directory/something" do
       subject.should_receive(:backup_directory).and_return("backup_directory")
-      config.should_receive(:jenkins).and_return({ "home" => "some_nice_house"})
+      config.should_receive(:jenkins).and_return(mock(:home => "some_nice_house"))
 
       subject.send(:new_file_path, "some_nice_house/and/then/a/room").should ==
         "backup_directory/and/then/a/room"
@@ -216,7 +216,7 @@ describe BackupJenkins::Backup do
   end
 
   describe "#plugin_files" do
-    before { config.stub(:jenkins).and_return({ "home" => "home" }) }
+    before { config.stub_chain(:jenkins, :home).and_return("home") }
 
     it "returns a collection of directories including all the files that have .jpi" do
       Dir.should_receive(:[]).with("home/plugins/*.jpi").and_return(["jpi"])
@@ -238,7 +238,7 @@ describe BackupJenkins::Backup do
 
   describe "#files_to_remove" do
     before do
-      config.stub(:backup).and_return("backups_to_keep" => { "local" => 2 })
+      config.stub_chain(:backup, :backups_to_keep, :local).and_return(2)
       subject.stub(:glob_of_backup_files).and_return(
         %w(old_file_1 old_file_2 old_file_3 old_file_4 old_file_5)
       )
@@ -278,14 +278,13 @@ describe BackupJenkins::Backup do
 
   describe "#timestamp" do
     it "should return the current time with the desired timestamp from the config" do
-      config.stub(:backup).and_return("timestamp" => "%Y%m%d_%H%M")
       Time.stub(:now).and_return(Time.parse("2013/01/01 12:34PM"))
       subject.send(:timestamp).should == "20130101_1234"
     end
   end
 
   describe "#user_content_files" do
-    before { config.stub(:jenkins).and_return({ "home" => "home" }) }
+    before { config.stub_chain(:jenkins, :home).and_return("home") }
 
     it "should return files inside the userContent directory" do
       Dir.should_receive(:[]).with("home/userContent/*").and_return(["my_file"])

data/spec/lib/backup_jenkins/config_spec.rb

@@ -30,8 +30,8 @@ describe BackupJenkins::Config do
 
   describe "#config_file" do
     it "should load file" do
-      YAML.should_receive(:load_file).and_return("configuration")
-      subject.instance_variable_get(:"@config").should == "configuration"
+      YAML.should_receive(:load_file).and_return({ :a => :b })
+      subject.instance_variable_get(:"@config").should == Hashie::Mash.new({ :a => :b })
     end
 
     it "should exit with non 0 on error" do

data/spec/lib/backup_jenkins/formatter_spec.rb

@@ -11,7 +11,7 @@ class SpecFormatterIncluder
 end
 
 describe BackupJenkins::Formatter do
-  let(:config) { mock(:backup => { "file_name_base" => "jenkins" }) }
+  let(:config) { mock(:backup => mock(:file_name_base => "jenkins")) }
   subject { SpecFormatterIncluder.new(config) }
 
   describe "#format_backup_file_data" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: backup_jenkins
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.0.11
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk
-  requirement: &32124580 !ruby/object:Gem::Requirement
+  requirement: &29093460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,21 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *32124580
+  version_requirements: *29093460
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: &29093040 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *29093040
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &32124160 !ruby/object:Gem::Requirement
+  requirement: &29092620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +43,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *32124160
+  version_requirements: *29092620
 description: Simple Jenkins config and plugin backup to S3
 email:
 - jcmuller@gmail.com