landscape-turner 1.2.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in landscape_turner.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 DAQRI
+
+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,45 @@
+# Landscape Turner
+
+Landscape Turner is a set of two ruby scripts for backing up the Landscape service, 	`landscape-turner-backup` and `landscape-turner-restore` .
+
+## General Usage
+
+```bash
+$ landscape-turner-backup --snapshot-path=/home/daqri/backup
+
+$ landscape-turner-restore /home/daqri/backup.tar.gz
+```
+
+## Options for landscape-turner-backup
+
+###-s, --snapshot-path=/path/to/snapshot
+Required
+
+###-o, --override=*string*
+Override paths with -o name1=path1
+
+### -d, --disable=*string*
+Disable paths with -d name
+
+### -n, --no-db
+Disable database backup
+
+### -l, --landscape-prefix=/path/to/default/dirs
+Path to prefix default landscape dirs (/var, /etc), default is nothing.
+
+### -p, --no-op
+No-op (dry run)
+
+
+To override specific paths, use `-o name1=path1 -o name2=path2 -o name3=path3`. To disable specific paths for backup, use `-d name1 -d name2`. Overrides have higher priority than `--landscape-prefix`.
+
+## Options for landscape-turner-restore
+
+### -r, --restore-prefix=*string*
+Prefix to prepend default landscape dirs (/var, /etc) with (default: nothing)
+
+### -n, --no-db
+Disable database restore
+
+
+In addition to the optional arguments, you must specify exactly one .tar.gz file to restore.

data/Rakefile

@@ -0,0 +1,10 @@
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/test*.rb']
+  t.verbose= true
+end
+
+
+

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "landscape_turner"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/landscape-turner-backup

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require 'landscape-turner/backup'
+
+if ENV['USER'] != "root"
+   puts "You must have root permissions to run this tool."
+   exit -1
+end
+
+Backup.backup_with_cli_args

data/exe/landscape-turner-restore

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require 'landscape-turner/restore'
+
+if ENV['USER'] != "root"
+  puts "You must have root permissions to run this tool."
+  exit 
+end
+  
+Restore.restore_with_cli_args

data/landscape-turner.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'landscape-turner/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "landscape-turner"
+  spec.version       = LandscapeTurner::VERSION
+  spec.authors       = ["Justin Boisvert"]
+  spec.email         = ["justin.boisvert@daqri.com"]
+
+  spec.summary       = "Backup tool for the Landscape service"
+  spec.description   = "A backup tool for the Landscape service that backs up the configuration files and the database related to the service."
+  spec.homepage      = "http://www.daqri.com"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables << "landscape-turner-backup"
+  spec.executables << "landscape-turner-restore"
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency     "trollop"
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest"
+end

data/lib/landscape-turner/backup.rb

@@ -0,0 +1,116 @@
+require_relative 'helpers'
+require 'fileutils'
+require 'pathname'
+require 'open3'
+require 'trollop'
+
+class Backup
+  extend LandscapeTurner::Helpers
+
+  def self.backup_with_cli_args(args = ARGV)
+    paths = {
+      :x509_certificate  => "/etc/ssl/certs/landscape_server.pem",
+      :ca_certificate    => "/etc/ssl/certs/landscape_server_ca.crt",
+      :ssl_private_key   => "/etc/ssl/private/landscape_server.key",
+      :postgresql_config => "/etc/postgresql/9.3/main",
+      :apache_config     => "/etc/apache2/sites-available/landscape-server.conf",
+      :hash_id_database  => "/var/lib/landscape/hash-id-databases",
+      :landscape_dir     => "/etc/landscape",
+      :landscape_default => "/etc/default/landscape-server",
+    }
+
+    new_args = Trollop.options(args) do
+      opt :snapshot_path,         "Path to snapshot (required)",                             :type => String
+      opt :override,              "Override paths with -o name1=path1",                      :type => :strings
+      opt :disable,               "Disable paths with -d name",                              :type => :strings
+      opt :no_db,                 "Disable database backup"
+      opt :landscape_prefix,      "Path to prefix default landscape dirs (/var, /etc) with", :default => ""
+      opt :no_op,                 "No-op (dry run)"
+      opt :sudo,                  "Program to use as sudo",                                  :default => "sudo"
+
+      banner <<-USAGE
+To override specific paths, use -o name1=path1 -o name2=path2 -o name3=path3
+To disable specific paths for backup, use -d name1 -d name2
+Overrides have higher priority than --landscape-prefix.
+
+Names with default values:
+#{paths.keys.map { |k| "  #{k}: #{paths[k]}"} }
+      USAGE
+    end
+
+    @@sudo = new_args[:sudo]
+
+    prefix = new_args[:landscape_prefix]
+    paths.each { |k, v| paths[k] = "#{prefix}#{v}" }
+
+    (new_args[:override] || []).each do |o|
+      key, val = o.split("=")
+      key = key.to_sym
+      raise "Unrecognized name argument: #{key.inspect}!" unless paths[key]
+      paths[key] = val
+    end
+
+    (new_args[:disable] || []).each do |d|
+      raise "Unrecognized name argument: #{d.inspect}!" unless paths[key]
+      paths.delete d.to_sym
+    end
+
+    backup_landscape(new_args, paths, prefix)
+  end
+
+  def self.backup_landscape(params = {}, paths, prefix)
+    #check required arguments needed
+    unless params[:snapshot_path]
+      raise ArgumentError,  "Error: Must supply snapshot path with --snapshot-path"
+    end
+    destination = params[:snapshot_path] + "/"
+    operate = !params[:no_op]
+
+    #create the top-level destination path
+    operate ? (FileUtils.mkdir(destination) rescue nil) : nil
+
+    paths.each do |name, path|
+      # Get path relative to landscape_prefix
+      rel_path = Pathname.new(path).relative_path_from(Pathname.new(File.expand_path(prefix))).to_s
+
+      # Make sure destination subdir exists
+      dest_subdir = File.dirname "#{destination}/#{rel_path}"
+      puts "Copying #{path} to #{dest_subdir}..."
+      FileUtils.mkdir_p dest_subdir if operate
+      FileUtils.cp_r(path, dest_subdir, :preserve => true) if operate
+    end
+
+    puts "Backing up Postgres databases.."
+    (operate && !params[:no_db]) ? dump_landscape_databases(destination) : nil
+    destination = params[:snapshot_path]
+    puts "Compressing to file #{destination}.tar.gz"
+    tgz_file = "#{File.basename(destination)}.tar.gz"
+    operate ? safe_system("cd #{destination} && rm -f #{tgz_file} && tar -cpzf #{tgz_file} * && mv #{tgz_file} ..") : nil
+    if operate && !check_consistent_tar(destination)
+      raise "Tarball inconsistent with backup"
+    end
+    # remove the folder where we stored everything
+    operate ? FileUtils.remove_dir(destination) : nil
+    puts "Finished backing up to #{destination}"     
+  end
+
+  def self.dump_landscape_databases(backup_destination)
+    FileUtils.mkdir("#{backup_destination}/postgresql_backup") rescue nil
+    get_landscape_databases().each { |database_name| 
+    # pg_dump dbname > outfile
+    safe_system("cd /tmp && sudo -u postgres pg_dump #{database_name} > #{database_name}.bak")
+    FileUtils.mv("/tmp/#{database_name}.bak","#{backup_destination}/postgresql_backup/")
+    }  
+  end
+
+  def self.check_consistent_tar(destination)
+    FileUtils.rm_rf("/tmp/tar_check")
+    puts "cd #{File.dirname(destination)} && mkdir /tmp/tar_check && tar -xf #{File.basename(destination)}.tar.gz -C /tmp/tar_check"
+    safe_system("cd #{File.dirname(destination)} && mkdir /tmp/tar_check && tar -xf #{File.basename(destination)}.tar.gz -C /tmp/tar_check")
+    hash_folder1 = Open3.capture3("find #{destination} -type f 2>/dev/null -exec md5sum {} \;")
+    hash_folder2 = Open3.capture3("find /tmp/tar_check -type f 2>/dev/null -exec md5sum {} \;")
+    FileUtils.rm_rf("/tmp/tar_check")
+    return hash_folder1 == hash_folder2     
+  end
+
+end

data/lib/landscape-turner/helpers.rb

@@ -0,0 +1,25 @@
+require 'open3'
+
+module LandscapeTurner
+  module Helpers
+    def safe_system(cmd)
+      e = system(cmd)
+      raise "Failure in command: #{cmd.inspect}!" unless e
+    end
+    def get_landscape_databases()
+      landscape_databases = Array.new()
+      list = Open3.capture3("cd /tmp && sudo -u postgres psql -qlA")[0].split("\n")
+      #This is to remove irrelevant information generated from this command at the first and last line.
+      list.shift()
+      list.pop()
+      landscape_list = Array.new()
+      list.each { |item|
+      db_name = item.split("|")[0]
+      if db_name.start_with?("landscape")
+        landscape_list.push(db_name)
+      end
+      }
+      return landscape_list
+     end
+  end
+end

data/lib/landscape-turner/restore.rb

@@ -0,0 +1,87 @@
+require_relative 'helpers'
+require_relative 'backup'
+require 'fileutils'
+
+# TODO: Document that overridden files get restored to their
+# original location
+
+class Restore
+  extend LandscapeTurner::Helpers
+  POSTGRES_CONFIG = "/etc/postgresql/9.3/main"
+  EXCLUDE_FILES = [POSTGRES_CONFIG]
+  def self.restore_with_cli_args(args = ARGV)
+    opts = Trollop.options(args) do
+      opt :restore_prefix, "Prefix to prepend default landscape dirs (/var, /etc) with", :default => ""
+      opt :no_db,          "Disable database restore"
+      opt :sudo,           "Program to use as 'sudo'",                                   :default => "sudo"
+
+      banner <<-USAGE
+In addition to optional arguments, give exactly one .tar.gz file to restore.
+      USAGE
+    end
+
+    raise "You must supply exactly one argument, the backup path!" unless args.size == 1
+    @@sudo = opts[:sudo]
+    restore_landscape args[0], opts
+  end
+
+  def self.with_service_stopped(service)
+    begin
+      safe_system("#{@@sudo} service #{service} stop")
+      yield
+    ensure
+      safe_system("#{@@sudo} service #{service} start")
+    end
+  end
+
+  def self.restore_landscape(backup_loc, options = {})
+
+    with_service_stopped("landscape-server") do
+      expanded_path = File.expand_path(backup_loc)
+      FileUtils.rm_rf "/tmp/landscape_backup"
+      FileUtils.mkdir "/tmp/landscape_backup"
+      safe_system "cd /tmp/landscape_backup && tar xpf \"#{expanded_path}\""
+
+      Dir["/tmp/landscape_backup/*"].each do |top_level|
+        sub_path = top_level.sub /^\/tmp\/landscape_backup/, ""
+        next if EXCLUDE_FILES.any? { |exc| sub_path[exc] }
+        new_location = File.join options[:restore_prefix], sub_path
+        replace new_location, top_level
+      end
+
+      puts "Restoring Postgres"
+      unless options[:no_db]
+        restore_landscape_databases("/tmp/landscape_backup/postgresql_backup")
+        with_service_stopped("postgresql") do
+          replace(POSTGRES_CONFIG,"/tmp/landscape_backup/#{POSTGRES_CONFIG}")
+        end
+      end      
+
+      puts "Restoration of Landscape configuration completed."
+
+      FileUtils.rm_rf "/tmp/landscape_backup" rescue nil
+    end
+
+  end
+
+  def self.replace(filename_replace,filename)
+    puts "Copying #{filename} to #{File.dirname(filename_replace)}..."
+    FileUtils.cp_r(filename, File.dirname(filename_replace), :preserve => true, :remove_destination => true)
+  end
+ 
+
+  def self.restore_landscape_databases(restore_location)
+    #clear the databases first
+    Dir["#{restore_location}/*"].each { |database_name|
+      database_name = File.basename(database_name)
+      database_name.slice!(".bak")
+      safe_system("cd /tmp && sudo -u postgres dropdb #{database_name}") rescue nil
+      safe_system("cd /tmp && sudo -u postgres createdb #{database_name}")
+      # psql dbname < infile
+      safe_system("cd /tmp && sudo -u postgres psql #{database_name} < #{restore_location}/#{database_name}.bak")
+    }
+
+  end
+
+    
+end

data/lib/landscape-turner/version.rb

@@ -0,0 +1,3 @@
+module LandscapeTurner
+  VERSION = "1.2.0"
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: landscape-turner
+version: !ruby/object:Gem::Version
+  version: 1.2.0
+  prerelease: 
+platform: ruby
+authors:
+- Justin Boisvert
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-02-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: trollop
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A backup tool for the Landscape service that backs up the configuration
+  files and the database related to the service.
+email:
+- justin.boisvert@daqri.com
+executables:
+- landscape-turner-backup
+- landscape-turner-restore
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/landscape-turner-backup
+- exe/landscape-turner-restore
+- landscape-turner.gemspec
+- lib/landscape-turner/backup.rb
+- lib/landscape-turner/helpers.rb
+- lib/landscape-turner/restore.rb
+- lib/landscape-turner/version.rb
+homepage: http://www.daqri.com
+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.23
+signing_key: 
+specification_version: 3
+summary: Backup tool for the Landscape service
+test_files: []