backup_jenkins 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+config/config.yml

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format progress
+--profile

data/.travis.yml

@@ -0,0 +1,5 @@
+---
+language: ruby
+bundler_args: --without development
+rvm:
+  - 1.9.3

data/Gemfile

@@ -0,0 +1,13 @@
+source :rubygems
+
+# Specify your gem's dependencies in backup_jenkins.gemspec
+gemspec
+
+group :test do
+  gem "rake"
+  gem "rspec"
+  gem "ci_reporter"
+  gem "simplecov"
+  gem "simplecov-rcov"
+  gem "flog"
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Juan C. Müller
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,32 @@
+# BackupJenkins
+[![Build Status](https://secure.travis-ci.org/jcmuller/jenkins_backup.png)](http://travis-ci.org/jcmuller/jenkins_backup)
+[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/jcmuller/jenkins_backup)
+[![Dependency Status](https://gemnasium.com/jcmuller/jenkins_backup.png)](https://gemnasium.com/jcmuller/jenkins_backup)
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'backup_jenkins'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install backup_jenkins
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,22 @@
+#!/usr/bin/env rake
+$:.push File.expand_path("../lib", __FILE__)
+
+require "rspec/core/rake_task"
+require "backup_jenkins/version"
+require "bundler/gem_tasks"
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = "spec/**/*_spec.rb"
+  spec.rspec_opts = ["--backtrace --format CI::Reporter::RSpec"]
+end
+
+desc "Clean backup and swap files, and artifacts"
+task :clean do
+  require "fileutils"
+  Dir["{pkg/*,**/*~,**/.*.sw?,coverage/**,spec/reports/**}"].each do |file|
+    rm_rf file
+  end
+end
+
+desc "Run rspec by default"
+task :default => :spec

data/backup_jenkins.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/backup_jenkins/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Juan C. Müller"]
+  gem.email         = ["jcmuller@gmail.com"]
+  gem.description   = %{Simple Jenkins config and plugin backup to S3}
+  gem.summary       = %q{This gem allows you to get a backup instance of jenkins up and running pretty quickly}
+  gem.homepage      = "http://github.com/jcmuller/jenkins_backup"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = Dir["spec/**/*_spec.rb"]
+  gem.name          = "backup_jenkins"
+  gem.require_paths = ["lib"]
+  gem.version       = BackupJenkins::VERSION
+
+  gem.add_dependency("aws-sdk")
+
+  gem.add_development_dependency("rake")
+  gem.add_development_dependency("pry-debugger")
+  gem.add_development_dependency("pry-stack_explorer")
+end

data/bin/backup_jenkins

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'backup_jenkins'
+
+BackupJenkins::CLI.run

data/config/config-sample.yml

@@ -0,0 +1,12 @@
+aws:
+  access_key: AWS_ACCESS_KEY
+  secret: AWS_SECRET
+  bucket_name: BUCKET_NAME
+backup:
+  dir_base: PATH_TO_BACKUP_DIRECTORY
+  file_name_base: SOME_BASE_NAME
+  timestamp: "%Y%m%d_%H%M"
+  backups_to_keep: 2
+jenkins:
+  home: PATH_TO_JENKINS_HOME
+verbose: true

data/lib/backup_jenkins.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'yaml'
+require 'aws'
+
+module BackupJenkins
+  autoload :AWS,      'backup_jenkins/aws'
+  autoload :Backup,   'backup_jenkins/backup'
+  autoload :CLI,      'backup_jenkins/cli'
+  autoload :Config,   'backup_jenkins/config'
+  autoload :Version,  'backup_jenkins/version'
+end

data/lib/backup_jenkins/aws.rb

@@ -0,0 +1,54 @@
+module BackupJenkins
+  class AWS
+    def initialize(config = Config.new)
+      @config = config
+      setup_aws
+    end
+
+    def populate_files
+      @files = []
+      bucket.objects.with_prefix(config.backup["file_name_base"]).each{ |o| files << o }
+      @files.sort!{ |a, b| a.key <=> b.key }
+    end
+
+    # TODO change this to use a time decay algorithm
+    def remove_old_files
+      puts "Looking for old files..." if config.verbose
+
+      populate_files
+
+      files_to_remove.each do |file|
+        puts "Removing #{file.key}..." if config.verbose
+        file.delete
+      end
+
+      puts "Done." if config.verbose
+    end
+
+    def files_to_remove
+      files - files.last(config.backup["backups_to_keep"])
+    end
+
+    def upload_file(filename, file)
+      puts "About to upload #{filename}..." if config.verbose
+      new_file = bucket.objects.create(filename, file)
+      puts "Done" if config.verbose
+      raise "Error uploading" unless new_file.class == ::AWS::S3::S3Object
+    end
+
+    private
+
+    attr_reader :config, :bucket, :files
+
+    def setup_aws
+      s3 = ::AWS::S3.new(
+        access_key_id: config.aws["access_key"],
+        secret_access_key: config.aws["secret"]
+      )
+      @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
+
+  end
+end

data/lib/backup_jenkins/backup.rb

@@ -0,0 +1,96 @@
+require 'fileutils'
+
+module BackupJenkins
+  class Backup
+    def initialize(config = Config.new)
+      @config = config
+    end
+
+    def backup_directory
+      @backup_directory ||= "#{config.backup["dir_base"]}/#{base_file_name}_#{timestamp}"
+    end
+
+    def base_file_name
+      "#{config.backup["file_name_base"]}_#{hostname}"
+    end
+
+    def hostname
+      %x{hostname -s}.chomp
+    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)
+      FileUtils.mkdir_p(File.dirname(new_file_name), 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"]}}, "")}"
+    end
+
+    def do_backup
+      raise "Backup directory already exists! (#{backup_directory})" if FileTest.directory?(backup_directory)
+
+      copy_files
+
+      create_tarball
+      remove_temporary_files
+    end
+
+    def copy_files
+      create_dir_and_copy(plugin_files)
+      create_dir_and_copy(user_content_files)
+      create_dir_and_copy(jobs_files)
+    end
+
+    def plugin_files
+      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/*"]
+    end
+
+    def jobs_files
+      `find #{config.jenkins["home"]} -maxdepth 3 -name config.xml -or -name nextBuildNumber`.split(/\n/)
+    end
+
+    def create_tarball
+      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
+      options = %w(jcf)
+      options.unshift('v') if config.verbose
+      options.join('')
+    end
+
+    private
+
+    attr_reader :config
+
+    def timestamp
+      Time.now.strftime(config.backup["timestamp"])
+    end
+  end
+end

data/lib/backup_jenkins/cli.rb

@@ -0,0 +1,19 @@
+module BackupJenkins
+  class CLI
+    class << self
+      def run
+        config = BackupJenkins::Config.new
+        backup = BackupJenkins::Backup.new(config)
+        aws = BackupJenkins::AWS.new(config)
+
+        backup.do_backup
+
+        full_filename = backup.tarball_filename
+        filename = File.basename(full_filename)
+
+        aws.upload_file(filename, File.open(full_filename))
+        aws.remove_old_files # Clean up!
+      end
+    end
+  end
+end

data/lib/backup_jenkins/config.rb

@@ -0,0 +1,23 @@
+module BackupJenkins
+  class Config
+    attr_reader :s3
+
+    def initialize
+      @config = YAML.load_file("config/config.yml")
+    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
+
+    private
+
+    attr_reader :config
+
+  end
+end

data/lib/backup_jenkins/version.rb

@@ -0,0 +1,3 @@
+module BackupJenkins
+  VERSION = "0.0.1"
+end

data/spec/lib/backup_jenkins/aws_spec.rb

@@ -0,0 +1,4 @@
+require 'spec_helper'
+
+describe BackupJenkins::AWS do
+end

data/spec/lib/backup_jenkins/backup_spec.rb

@@ -0,0 +1,4 @@
+require 'spec_helper'
+
+describe BackupJenkins::Backup do
+end

data/spec/lib/backup_jenkins/cli_spec.rb

@@ -0,0 +1,4 @@
+require 'spec_helper'
+
+describe BackupJenkins::CLI do
+end

data/spec/lib/backup_jenkins/config_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+require 'tempfile'
+
+describe BackupJenkins::Config do
+  before do
+    YAML.stub(:load_file).and_return({
+      "aws" => {
+        "access_key" => "some_key",
+        "secret" => "some_secret"
+      }
+    })
+  end
+
+  it "should get from YAML and define aws_key" do
+    subject.aws["access_key"].should == "some_key"
+  end
+
+  it "should get from YAML and define secret" do
+    subject.aws["secret"].should == "some_secret"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,28 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+require 'simplecov'
+require 'simplecov-rcov'
+SimpleCov.formatter = SimpleCov::Formatter::RcovFormatter
+SimpleCov.start do
+  add_filter "spec"
+  add_filter "vendor/bundler_gems"
+end
+
+require 'backup_jenkins'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: backup_jenkins
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Juan C. Müller
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: &28803200 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *28803200
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &28802660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *28802660
+- !ruby/object:Gem::Dependency
+  name: pry-debugger
+  requirement: &28802240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *28802240
+- !ruby/object:Gem::Dependency
+  name: pry-stack_explorer
+  requirement: &28801720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *28801720
+description: Simple Jenkins config and plugin backup to S3
+email:
+- jcmuller@gmail.com
+executables:
+- backup_jenkins
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- backup_jenkins.gemspec
+- bin/backup_jenkins
+- config/config-sample.yml
+- lib/backup_jenkins.rb
+- lib/backup_jenkins/aws.rb
+- lib/backup_jenkins/backup.rb
+- lib/backup_jenkins/cli.rb
+- lib/backup_jenkins/config.rb
+- lib/backup_jenkins/version.rb
+- spec/lib/backup_jenkins/aws_spec.rb
+- spec/lib/backup_jenkins/backup_spec.rb
+- spec/lib/backup_jenkins/cli_spec.rb
+- spec/lib/backup_jenkins/config_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/jcmuller/jenkins_backup
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+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/backup_spec.rb
+- spec/lib/backup_jenkins/cli_spec.rb
+- spec/lib/backup_jenkins/config_spec.rb
+- spec/lib/backup_jenkins/aws_spec.rb