anjea_backup 0.0.1 → 0.1.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MmZjYWM2NDI3ZGUyOTllZDUxYTZhOTRjNDkwMjk5MTczYmMwNzYyYg==
+    MjE2N2EwNThkYWZmY2E4OTFiM2UyYzc4YWUxZjIxMWU2M2M1YWI3Mw==
   data.tar.gz: !binary |-
-    NGNjYTA3OWVmYWZhOTk2OWVlNTc0ZmU4MzQ0ZjgxMzJkZTI5OGIxYQ==
+    ZDc1ZDMyZGNlNTY4MmIxZDFkY2RmODEwMmM4ZmU2NWUyZTVjZjI1Zg==
 SHA512:
   metadata.gz: !binary |-
-    MmM4NTQ1ODI2MzBiYjQ3YjY1Mjg5ZWQzYjM3MWEwZmUxOTNiN2Q1NmUwOGQ0
-    OWI0OWZlNWM4OGRlNDUwNTExMzJlYjU4MjMxYWI4NDkxMjBmZTg4MjcxYThh
-    NzUwNzMzYjk4NWU4YmY1YWVhMTQzODk2OTczMzBhMTgyZGQ3ZDc=
+    ZDlhMzk5ZDQyYTczN2Q2MDI4MDQwN2FjZGYzY2YxZWViZWU2MjBiNDE3NDA4
+    NGQyYzk3MTk0OTJiZWE5MGE1ZTkxZDYyYjNmN2IwMGU5MWU4M2QxYjg3MGNk
+    YWNiYzRkOGVhOGYyYzMwZDBkNWQ5MTg2NTJlZGE2ZjZkOGY1YzY=
   data.tar.gz: !binary |-
-    MjE3NTJjMzA1Yzg1OGU0YTBmMTczMzFjYTQ5YTVkNWRlOTRiY2QxNDJmZjNj
-    OGQxMTRjNDZlYzdmNWM1ZTYxZWY4MmZlMDdiZGMyOWQxYmNlMzlmMDRiNjMx
-    MzQ1MGM3NTdmOTkwZjZiNjZjOGE3MTk5MzU0YzE5OWU3ZjA5NDY=
+    MGNlNzU2N2M3NmFmYWMwNDM5NzQyMDgxZTFhYTlkZTQ4ODY4MDU0YzAyNDg2
+    YTU4ZDhkODZiMDE5MDRlZjFmNGE2NWY2ZTFlNGI3MjcxZDM5NzE1MDA5NTY2
+    OTZjOGJjZTAyY2FkZTdlNDVlNmI0YWQyNzlhMTc0ZjhhOTJmOGI=

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    anjea_backup (0.0.1)
+    anjea_backup (0.1.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -4,11 +4,34 @@ Warning: *I do not consider AnjeaBackup anything close to production-ready* .
 
 It is however a fun toy, and some things do work.
 
+# Mission
+
+AnjeaBackup should
+
+ - not depend on many gems (ideally a plain ruby installation should suffice).
+ - use rsync and hard links (it helps a lot if you understand these).
+ - be configurable through editing configuration files.
+ - not depend on other services (e.g. not use an external database).
+ - concentrate on doing the file synchronization, stuff like mailing or regular execution can be left to your other favorite tools (see #Example).
+
 AnjeaBackup will create copies of local or remote (via ssh) files and directories, hard-linked to former versions of the same files and directories.
 
 The approach has been beautifully implemented by numerous people using e.g. bash or perl scripts.
 I aimed for quick and easy configurability and some oppinionated choices that were given my usage scenario.
 
+With anjea_backup you define what folders and files to backup (these can be on a remote server to which you have passwordless key-based ssh access to, or use sshfs to 'tunnel' it to your local filesystem).  On each execution of anjea_backup, a copy of these files and folders will be created in a defined location.  Hard links are used which means:
+  - only changed files need to be transferred
+  - unchanged files are represented by inodes, taking away virtually no disk space.  Always the last backup serves as reference for the next ones (against which changes are computed).  The drawback here is that if a single byte in a big file changes, the whole file is transferred and created again - thus it is not a solution to sparsely backup e.g. VM images.
+
+anjea_backup preserves the original full path and will put your files in a folder structure similar to this:
+
+    /backup/2014-11-21-04/symbolic_name/path/to/asset
+    /backup/2014-11-21-04/other_name/path/to_other/asset
+
+where `/backup` can be configured, `symbolic_name` is a user-given name and `/path/to/asset` is the path on the machine that receives the backup.
+
+Note that symbolic links the in source can be tricky.
+
 ## Installation
 
 You'll probably need a decent linux installation and have rsync installed.
@@ -19,7 +42,7 @@ You'll probably need a decent linux installation and have rsync installed.
 
 AnjeaBackup is meant to be a script.  If you find 'library' usage for it, get in touch.  Also, I think if you want to use it, get in touch.
 
-The script is in `/bin/anjea` .
+The script is in `bin/anjea` .
 
 The working basic use case is to just call it.  It will pick up two configuration files (see next sections) and immediately start a backup-attempt.
 
@@ -57,7 +80,9 @@ Defines *what* to backup and how to access it.  Example:
     key=/home/anjea/.anjea/keys/otherhostkey_rsa
     user=anjea
 
-Second group saves files from a remote box (`anjea@otherhost.mynetwork:/home/remoteanjea/stuff`) using public key as defined in `key` .
+The group names (e.g. [files]) serve as human readable name and as directory name within the `dst` location specified in `anjea.conf`.
+
+In this example, the second group (_remotebox_) saves files from a remote box (`anjea@otherhost.mynetwork:/home/remoteanjea/stuff`) using the public key defined in `key` .
 
 ## Example
 
@@ -77,11 +102,14 @@ This will need work.
 * Continue with other backups in case one faults
 * Allow manual targeted backups of single sources
 * Revive tests
+* Nested groups in ".ini" files
+* Proper ini file parser
 * (missing: send mail) -> easy to do from outside
 * (missing: do full, non incremental, non hardlinked backups into vault from time to time)
 
 ## Contributing
 
+0. Contact me
 1. Fork it ( https://github.com/[my-github-username]/anjea_backup/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)

data/bin/anjea

@@ -2,6 +2,19 @@
 
 require 'anjea_backup'
 
+usage_doc = <<eos
+anjea [backup|vault|list|help]
+
+  anjea_backup uses rsync to synchronize files.
+  It uses hard links which are suitable for large sets of small, chaning files.
+  Hard links are not so optimal for large files, a single changed byte
+  will leed to a full copy of that file.
+
+  Configuration takes place in two files, anjea.conf and backup.conf .
+  The the README for details.
+eos
+
+
 action = :backup
 if ARGV.length > 0
   case ARGV[0].downcase
@@ -11,6 +24,10 @@ if ARGV.length > 0
     action = :vault
   when 'list'
     action = :list
+  when 'help'
+    action = :help
+  else
+    action = :help
   end
 end
 
@@ -19,11 +36,14 @@ begin
   when :backup
     AnjeaBackup::Backup.new.backup
   when :list
-    AnjeaBackup.new.cleanup
+    AnjeaBackup::Backup.new.cleanup
   when :vault
-    AnjeaBackup.new.to_vault
+    AnjeaBackup::Backup.new.to_vault
+  when :help
+    puts usage_doc
   else
     STDERR.puts "unknown action"
+    puts usage_doc
     exit 3
   end
 rescue NoIniFileError => ex

data/lib/anjea_backup.rb

@@ -1,7 +1,8 @@
 require "anjea_backup/version"
+require "anjea_backup/logger"
+require "anjea_backup/backup_item"
 require "anjea_backup/anjea_backup"
 require "anjea_backup/inifile"
 
 module AnjeaBackup
-  # Our code goes here...
 end

data/lib/anjea_backup/anjea_backup.rb

@@ -4,38 +4,22 @@ require 'pathname'
 require_relative 'inifile'
 
 module AnjeaBackup
-  class BackupItem
-    attr_accessor :name
-    attr_accessor :description
-    attr_accessor :src_dir
-    attr_accessor :ssh_url
-    attr_accessor :ssh_key
-  
-    def initialize hash
-      @name        = hash[:name]
-      @description = hash['description']
-      @src_dir     = hash['src']
-      if hash['host'] && hash['user'] && hash['key']
-        @ssh_url = "#{hash['user']}@#{hash['host']}:#{@src_dir}"
-        @ssh_key = hash['key']
-      end
-    end
-  end
-  
   class Backup
+    include AnjeaBackup::Logger
+
     def initialize
       read_system_conf
+      setup_dirs
       if !lock!
         log_err "Aborting, anjea already running.  Delete #{@lock_file} if not."
         exit 2
       end
       read_backups_conf
-      setup_dirs
     end
   
     def backup
-      yyyymmdd = DateTime.now.strftime("%Y-%m-%d-%H")
-      
+      yyyymmdd = now_with_hour
+
       # TODO work in a tmp work dir
       @backup_items.each do |item|
         last_backup  = File.join(@last, item.name)
@@ -46,7 +30,11 @@ module AnjeaBackup
         source = item.ssh_url ? "-e \"ssh -i #{item.ssh_key}\" #{item.ssh_url}"
                               : item.src_dir
   
-        rsync_cmd = "rsync -avz --delete --relative --stats --log-file #{log_file_for(yyyymmdd, item)} --link-dest #{last_backup} #{source} #{today_backup}"
+        rsync_cmd = "rsync -avz "\
+          "--delete --relative --stats "\
+          "--log-file #{log_file_for(yyyymmdd, item)} "\
+          "--link-dest #{last_backup} "\
+          "#{source} #{today_backup}"
       
         log item, "rsync start"
         if system(rsync_cmd)
@@ -100,19 +88,13 @@ module AnjeaBackup
     end
   
     def log_err item=nil, msg
-      if item
-        STDERR.puts "[#{item.name}] #{DateTime.now.strftime("%Y-%m-%d-%H:%M")} - #{msg}"
-      else
-        STDERR.puts "#{DateTime.now.strftime("%Y-%m-%d-%H:%M")} - #{msg}"
-      end
-    end
-  
-    def log item, msg
-      puts "[#{item.name}] #{DateTime.now.strftime("%Y-%m-%d-%H-%M")} - #{msg}"
+      log_msg = (!item.nil?) ? "[#{item.name}] #{now_with_minutes} - #{msg}"
+        : "#{now_with_minutes} - #{msg}"
+      STDERR.puts log_msg
     end
   
     def lock!
-      File.new(@lock_file,'w').flock( File::LOCK_NB | File::LOCK_EX )
+      File.new(@lock_file, 'w').flock(File::LOCK_NB | File::LOCK_EX)
     end
   
     def link_last_backup today_backup, last_backup
@@ -134,6 +116,7 @@ module AnjeaBackup
       @failed      = File.join(@destination, 'failed')
       @partial     = File.join(@destination, 'partial')
       @lock_file   = system_conf[0]['lock']
+      # rescue from malformed config
     end
   
     def log_file_for yyyymmdd, item

data/lib/anjea_backup/backup_item.rb

@@ -0,0 +1,19 @@
+module AnjeaBackup
+  class BackupItem
+    attr_accessor :name
+    attr_accessor :description
+    attr_accessor :src_dir
+    attr_accessor :ssh_url
+    attr_accessor :ssh_key
+  
+    def initialize hash
+      @name        = hash[:name]
+      @description = hash['description']
+      @src_dir     = hash['src']
+      if hash['host'] && hash['user'] && hash['key']
+        @ssh_url = "#{hash['user']}@#{hash['host']}:#{@src_dir}"
+        @ssh_key = hash['key']
+      end
+    end
+  end
+end

data/lib/anjea_backup/inifile.rb

@@ -18,9 +18,11 @@ end
 
 def read_ini_file filename
   ini_objs = []
-  file_contents = File.readlines(filename)
-  rescue Errno::ENOENT
+  begin
+    file_contents = File.readlines(filename)
+  rescue Errno::ENOENT  
     raise NoIniFileError, "#{filename} config file error"
+  end
   ini_obj = {}
   file_contents.each do |line|
     next if(line.strip.empty? || line.start_with?("#"))

data/lib/anjea_backup/logger.rb

@@ -0,0 +1,20 @@
+module AnjeaBackup
+  module Logger
+    def now_with_minutes
+      DateTime.now.strftime("%Y-%m-%d-%H-%M")
+    end
+
+    def now_with_hour
+      DateTime.now.strftime("%Y-%m-%d-%H")
+    end
+
+    def log item, msg
+      if item
+        puts "[#{item.name}] #{now_with_minutes} - #{msg}"
+      else
+        puts "#{now_with_minutes} - #{msg}"
+      end
+    end
+  end
+end
+

data/lib/anjea_backup/version.rb

@@ -1,3 +1,3 @@
 module AnjeaBackup
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: anjea_backup
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Felix Wolfsteller
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-28 00:00:00.000000000 Z
+date: 2015-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -57,7 +57,9 @@ files:
 - bin/anjea
 - lib/anjea_backup.rb
 - lib/anjea_backup/anjea_backup.rb
+- lib/anjea_backup/backup_item.rb
 - lib/anjea_backup/inifile.rb
+- lib/anjea_backup/logger.rb
 - lib/anjea_backup/version.rb
 homepage: https://github.com/fwolfst/anjea_backup/
 licenses: