bump version to 0.5.1

- rewrite large parts of cron file generation
- now using deep_merge to merge possible overrides into the default hash
  (eliminates a lit of spaghetti code)

.bundle/config

@@ -0,0 +1,3 @@
+---
+BUNDLE_PATH: vendor/bundle
+BUNDLE_DISABLE_SHARED_GEMS: '1'

.fixtures.yml

@@ -1,5 +1,8 @@
 fixtures:
-  repositories:
+  forge_modules:
-    "stdlib": "git://github.com/puppetlabs/puppetlabs-stdlib.git"
+    stdlib: 
+      repo: "puppetlabs/stdlib"
+    epel: 
+      repo: "stahnma/epel"
   symlinks:
     "rsnapshot": "#{source_dir}"

.travis.yml

@@ -3,17 +3,10 @@ sudo: false
 language: ruby
 cache: bundler
 bundler_args: --without system_tests
-script: "bundle exec rake validate && bundle exec rake lint && bundle exec rake spec SPEC_OPTS='--format documentation'"
+script: "bundle exec rake validate && bundle exec rake spec SPEC_OPTS='--format documentation'"
 matrix:
   fast_finish: true
   include:
-  - rvm: 1.8.7
-    env: PUPPET_GEM_VERSION="~> 3.0"
-  - rvm: 1.9.3
-    env: PUPPET_GEM_VERSION="~> 3.0"
-  - rvm: 2.0.0
-    env: PUPPET_GEM_VERSION="~> 3.0"
-  - rvm: 2.1.6
     env: PUPPET_GEM_VERSION="~> 4.0"
 notifications:
   email: false

Gemfile

@@ -1,32 +1,7 @@
-source ENV['GEM_SOURCE'] || 'https://rubygems.org'
+source 'https://rubygems.org'
 
-group :development, :unit_tests do
+puppetversion = ENV.key?('PUPPET_VERSION') ? "#{ENV['PUPPET_VERSION']}" : ['>= 4.0']
-  gem 'rspec-core', '~> 3.1.7',  :require => false
+gem 'puppet', puppetversion
-  gem 'rspec-puppet', '~> 2.1',  :require => false
+gem 'puppetlabs_spec_helper', '>= 0.8.2'
-  gem 'puppetlabs_spec_helper',  :require => false
+gem 'puppet-lint', '>= 1.0.0'
-  gem 'simplecov',               :require => false
+gem 'facter', '>= 1.7.0'
-  gem 'puppet_facts',            :require => false
-  gem 'json',                    :require => false
-  gem 'metadata-json-lint',      :require => false
-  gem 'puppet-lint', '< 1.1.0',  :require => false
-end
-
-group :system_tests do
-  gem 'beaker-rspec',                  :require => false
-  gem 'serverspec',                    :require => false
-  gem 'beaker-puppet_install_helper',  :require => false
-end
-
-if facterversion = ENV['FACTER_GEM_VERSION']
-  gem 'facter', facterversion, :require => false
-else
-  gem 'facter', :require => false
-end
-
-if puppetversion = ENV['PUPPET_GEM_VERSION']
-  gem 'puppet', puppetversion, :require => false
-else
-  gem 'puppet', :require => false
-end
-
-# vim:ft=ruby

README.md

@@ -1,5 +1,7 @@
 # rsnapshot
 
+## NOTE: ! Configuration for backup_scripts changed with version 0.4.0 (it was pretty useless in prior versions) !
+
 #### Table of Contents
 
 1. [Overview](#overview)
@@ -358,6 +360,53 @@ Default is:
   }
 ```
 
+#### `$backup_scripts`
+Additional scripts to create, possible values are: mysql, psql, misc
+
+Default is:
+
+```puppet
+  $backup_scripts = {
+    mysql             => {
+      dbbackup_user     => 'root',
+      dbbackup_password => 'myFancyPassWord',
+    },
+    psql                => {
+      dbbackup_user     => 'postgres',
+      dbbackup_password => '',
+    },
+    misc => {},
+  }
+```
+
+Configuration example:
+
+```yaml
+rsnapshot::backup_scripts:
+  mysql:
+    dbbackup_user: 'dbbackup'
+    dbbackup_password: 'hunter2'
+  psql:
+    dbbackup_user: 'dbbackup'
+    dbbackup_password: 'yeshorsebatterystaple'
+
+rsnapshot::hosts:
+  foobar.com:
+    backup_scripts:
+      mysql:
+      psql:
+  bazqux:de:
+    backup_scripts:
+      mysql:
+        dbbackup_user: 'myuser'
+        dbbackup_password: 'mypassword'
+```
+
+This creates 
+- a mysql and a psql backup script for `foobar.com` using the credentials `dbbackup:hunter2` for mysql and `dbbackup:yeshorsebatterystaple` for psql
+- a mysql backup script for `bazqux.de` using the credentials `myuser:mypassword`
+
+
 ### rsnapshot configuration variables
 Please read up on the following in the [rsnapshot manpage](http://linux.die.net/man/1/rsnapshot)
 
@@ -493,9 +542,6 @@ Default is:  1
 #### `$use_lazy_deletes`
 Default is:  false
 
-#### `$backup_scripts`
-Default is:  {}
-
 ## Limitations
 Currently, this module support CentOS, Fedora, Ubuntu and Debian.
 

manifests/config.pp

@@ -5,12 +5,13 @@ class rsnapshot::config (
   $hosts          = $rsnapshot::hosts,
   $cron_dir       = $rsnapshot::cron_dir,
 ) {
+
   # these are global settings, no point in setting them per host
   $config_version         = $rsnapshot::params::config_version
-  $lockpath               = pick($rsnapshot::lockpath, $rsnapshot::params::config_lockpath)
+  $lockpath               = pick($rsnapshot::lockpath, $rsnapshot::params::config_lockpath, '/var/run/rsnapshot')
-  $conf_d                 = pick($rsnapshot::conf_d, $rsnapshot::params::conf_d)
+  $conf_d                 = pick($rsnapshot::conf_d, $rsnapshot::params::conf_d, '/etc/rsnapshot')
-  $snapshot_root          = pick($hosts['snapshot_root'], $rsnapshot::params::config_snapshot_root)
+  $snapshot_root          = pick($hosts['snapshot_root'], $rsnapshot::snapshot_root, '/backup')
-  $default_cron           = assert_empty_hash($::rsnapshot::cron)
+
   # make sure lock path and conf path exist
   file { $conf_d:
     ensure => 'directory',
@@ -30,10 +31,10 @@ class rsnapshot::config (
   # { foo => } and converts those to { foo => {} }
   $hosts_clean = assert_empty_hash($hosts)
 
-  $hosts_clean.each |String $host, Hash $hash | {
+  $hosts_clean.each |String $host, $hash | {
     $backup_user            = pick($hash['backup_user'], $rsnapshot::params::config_backup_user)
     $default_backup_dirs    = pick($rsnapshot::default_backup, $rsnapshot::params::config_default_backup)
-    $backup_levels          = pick($hash['backup_levels'], $rsnapshot::params::config_backup_levels, 'weekly')
+    $backup_levels          = pick($hash['backup_levels'], $rsnapshot::backup_levels, 'weekly')
     $backup                 = $hash['backup']
     $backup_defaults        = pick($hash['backup_defaults'], $rsnapshot::params::config_backup_defaults)
     $cmd_cp                 = pick($hash['cmd_cp'], $rsnapshot::params::config_cmd_cp)
@@ -66,15 +67,15 @@ class rsnapshot::config (
     $one_fs                 = pick_undef($hash['one_fs'], $rsnapshot::params::config_one_fs)
     $interval               = pick($hash['interval'], $rsnapshot::params::config_interval)
     $retain                 = pick_undef($hash['retain'], $rsnapshot::params::config_retain)
-    $include                = pick_undef($hash['include'], $rsnapshot::params::config_include)
+    $include                = pick($hash['include'], [])
-    $exclude                = pick_undef($hash['exclude'], $rsnapshot::params::config_exclude)
+    $exclude                = pick($hash['exclude'], [])
-    $include_file           = pick_undef($hash['include_file'], $rsnapshot::params::config_include_file)
+    $include_file           = pick($hash['include_file'], $rsnapshot::params::config_include_file, "${conf_d}/${host}.include")
     $exclude_file           = pick($hash['exclude_file'], $rsnapshot::params::config_exclude_file, "${conf_d}/${host}.exclude")
     $link_dest              = pick_undef($hash['link_dest'], $rsnapshot::params::config_link_dest)
     $sync_first             = pick_undef($hash['sync_first'], $rsnapshot::params::config_sync_first)
     $use_lazy_deletes       = pick_undef($hash['use_lazy_deletes'], $rsnapshot::params::config_use_lazy_deletes)
     $rsync_numtries         = pick_undef($hash['rsync_numtries'], $rsnapshot::params::config_rsync_numtries)
-    $backup_scripts         = pick_undef($hash['backup_scripts'], $rsnapshot::params::config_backup_scripts)
+    #$backup_scripts         = pick_undef($hash['backup_scripts'], $rsnapshot::params::config_backup_scripts)
 
     $snapshot_dir           = "${config_snapshot_root}/${host}"
     $config                 = "${conf_d}/${host}.rsnapshot.conf"
@@ -108,79 +109,69 @@ class rsnapshot::config (
       $use_lazy_deletes_num = bool2num($use_lazy_deletes)
     }
 
-    if $include != '' {
+    $real_include = $rsnapshot::include + $include
+    unless empty($real_include)  {
       file { $include_file:
         ensure  => 'file',
         content => template('rsnapshot/include.erb'),
       }
     }
 
-    if $exclude != '' {
+    $real_exclude = $rsnapshot::exclude + $exclude 
+    unless empty($real_exclude) {
       file { $exclude_file:
         ensure  => 'file',
         content => template('rsnapshot/exclude.erb'),
       }
     }
 
-    file { $config:
+    concat { $config:
+    }
+    concat::fragment { "${config} for ${host}":
+      target  => $config,
       content => template('rsnapshot/rsnapshot.erb'),
     }
+
+    if has_key($hash, backup_scripts) {
+
+      $hash[backup_scripts].each |$script, $credentials| {
+
+        if is_hash($credentials) {
+          $dbbackup_user     = $credentials['dbbackup_user']
+          $dbbackup_password = $credentials['dbbackup_password']
+        } else {
+          $dbbackup_user     = $rsnapshot::default_backup_scripts[$script]['dbbackup_user']
+          $dbbackup_password = $rsnapshot::default_backup_scripts[$script]['dbbackup_password']
+        }
+
+        concat::fragment { "${host}_${script}_backup":
+          target  => $config,
+          content => "backup_script	${conf_d}/${host}.${script}.sh	./${script}\n",
+        }
+
+        file { "${conf_d}/${host}.${script}.sh":
+          ensure  => present,
+          content => template("rsnapshot/${script}.sh.erb"),
+          mode    => '0755',
+        }
+        
+      }
+    }
+
     $cronfile = "${cron_dir}/${host}"
     concat { $cronfile:
     }
-
     # create cron files for each backup level
+    # merge possible cron definitions to one
+    $real_cron = deep_merge($rsnapshot::params::cron, $rsnapshot::cron, $hash[cron])
+
     $backup_levels.each |String $level| {
+      $minute   = rand_from_array($real_cron[$level][minute],   "${host}.${level}.minute")
+      $hour     = rand_from_array($real_cron[$level][hour],     "${host}.${level}.hour")
+      $monthday = rand_from_array($real_cron[$level][monthday], "${host}.${level}.monthday")
+      $month    = rand_from_array($real_cron[$level][month],    "${host}.${level}.month")
+      $weekday  = rand_from_array($real_cron[$level][weekday],  "${host}.${level}.weekday")
 
-      # allow to globally override ranges, create random numbers for backup_levels daily, weekly, monthly
-      if has_key($hash,cron){
-        if has_key($hash[cron], $level) {
-            $cron = $hash[cron][$level]
-          } else {
-            if has_key($default_cron, $level) {
-              $cron = $default_cron[$level]
-            } else {
-              $cron = $rsnapshot::params::cron[$level]
-            }
-        }
-      } else {
-        if has_key($default_cron, $level) {
-          $cron = $default_cron[$level]
-        } else {
-          $cron = $rsnapshot::params::cron[$level]
-        }
-      }
-
-      if has_key($cron, minute) {
-        $c_min                      = $cron[minute]
-      } else {
-        $c_min                      = $rsnapshot::params::cron[$level][minute]
-      }
-      if has_key($cron, hour) {
-        $c_hour                     = $cron[hour]
-      } else {
-        $c_hour                     = $rsnapshot::params::cron[$level][hour]
-      }
-      if has_key($cron, monthday) {
-        $c_monthday                 = $cron[monthday]
-      } else {
-        $c_monthday                 = $rsnapshot::params::cron[$level][monthday]
-      }
-      if has_key($cron, month) {
-        $c_month                    = $cron[month]
-      } else {
-        $c_month                    = $rsnapshot::params::cron[$level][month]
-      }
-      if has_key($cron, weekday)  {
-        $c_weekday                  = $cron[weekday]
-      } else {
-        $c_weekday                  = $rsnapshot::params::cron[$level][weekday]
-      }
-      $minute                           = rand_from_array($c_min, "${host}.${level}.minute")
-      $hour                             = rand_from_array($c_hour, "${host}.${level}.hour")
-      $monthday                         = rand_from_array($c_monthday, "${host}.${level}.monthday")
-      $month                            = rand_from_array($c_month, "${host}.${level}.month")
-      $weekday                          = rand_from_array($c_weekday, "${host}.${level}.weekday")
       concat::fragment { "${host}.${level}":
         target  => $cronfile,
         content => template('rsnapshot/cron.erb'),

manifests/init.pp

@@ -13,10 +13,15 @@ class rsnapshot (
   $package_name                  = $rsnapshot::params::package_name,
   $package_ensure                = $rsnapshot::params::package_ensure,
   $cron                          = $rsnapshot::params::cron,
+  $backup_scripts                = $rsnapshot::params::backup_scripts,
+  $include                       = $rsnapshot::params::config_include,
+  $exclude                       = $rsnapshot::params::config_exclude,
+  $snapshot_root                 = $rsnapshot::params::config_snapshot_root,
+  $backup_levels                 = $rsnapshot::params::config_backup_levels,
 ) inherits rsnapshot::params {
-  if $::puppetversion =~ /^(1|2|3)/ {
+
-    fail('This module requires Puppet 4')
+  $default_backup_scripts = $rsnapshot::params::backup_scripts + $backup_scripts
-  }
+  $default_exclude        = $rsnapshot::params::config_exclude + $exclude
   if $hosts {
     class { '::rsnapshot::install': }->
     class { '::rsnapshot::config': }

manifests/install.pp

@@ -1,7 +1,7 @@
 # == Class: rsnapshot::install
 #
 # Installs the rsnapshot package.
-class rsnapshot::install inherits rsnapshot {
+class rsnapshot::install {
   case $::operatingsystem {
     /^CentOS$/: { include epel }
     default: {}

manifests/params.pp

@@ -8,7 +8,7 @@ class rsnapshot::params {
   $package_name                  = 'rsnapshot'
   $package_ensure                = 'present'
   $cron_dir                      = '/etc/cron.d'
-  $config_backup_levels          = [ 'daily', 'weekly', ]
+  $config_backup_levels          = [ 'daily', 'weekly', 'monthly' ]
   $config_backup_defaults        = true
   $config_version                = '1.2'
   $config_cmd_cp                 = '/bin/cp'
@@ -91,4 +91,15 @@ class rsnapshot::params {
       weekday  => '*',
     },
   }
+  $backup_scripts = {
+    mysql             => {
+      dbbackup_user     => 'root',
+      dbbackup_password => 'myFancyPassWord',
+    },
+    psql                => {
+      dbbackup_user     => 'postgres',
+      dbbackup_password => '',
+    },
+    misc => {},
+  }
 }

metadata.json

@@ -1,6 +1,6 @@
 {
   "name": "loomsen-rsnapshot",
-  "version": "0.3.1",
+  "version": "0.5.1",
   "author": "loomsen",
   "summary": "Configures rsnapshot.",
   "license": "Apache-2.0",

spec/classes/init_spec.rb

@@ -1,37 +1,5 @@
 require 'spec_helper'
 describe 'rsnapshot' do
-
+      it { should contain_class('rsnapshot::params') }
-  {'Ubuntu' => 'Debian', 'Debian' => 'Debian'}.each do |system, family|
+      it { is_expected.to compile  }
-    context "when on system #{system} no lvm" do
-      let :facts do
-        {
-          :osfamily        => family,
-          :operatingsystem => system,
-        }
-      end
-
-      it { should contain_class('rsnapshot') }
-      it { should contain_class('rsnapshot::install') }
-      it { should contain_class('rsnapshot::config') }
-    end
-
-    context "when on system #{system} with lvm" do
-      let :facts do
-        {
-          :osfamily        => family,
-          :operatingsystem => system,
-        }
-      end
-
-      let(:params) { {:use_lvm => true} }
-
-      it { should contain_class('rsnapshot') }
-      it { should contain_class('rsnapshot::install') }
-      it { should contain_class('rsnapshot::config') }
-
-      it {
-        should contain_file('/etc/rsnapshot.conf').with_content(/^linux_lvm_((\w|_)+)\t(.*)$/)
-      }
-    end
-  end
 end

templates/exclude.erb

@@ -1,3 +1,3 @@
-<% @exclude.each do |exc| -%>
+<% @real_exclude.each do |exc| -%>
 <%= exc %>
 <% end %>

templates/include.erb

@@ -1,3 +1,3 @@
-<% @include.each do |inc| -%>
+<% @real_include.each do |inc| -%>
 <%= inc %>
 <% end %>

templates/misc.sh.erb

@@ -0,0 +1,10 @@
+#!/bin/bash
+# add custom stuff here 
+# FIXME: remember to concat for custom stuff after the last line of the puppet generated script
+<% if @osfamily == 'RedHat' -%>
+ssh <%=@host-%> rpm -qa --qf='%{name},' > packages.txt
+<%end-%>
+#
+#
+#
+# ++++++++++++++++++++++++++++++++++++++++++++

templates/mysql.sh.erb

@@ -0,0 +1,16 @@
+#!/bin/bash
+# written by Norbert Varzariu <loomsen@gmail.com>
+# This Script is triggered by rsnapshot and dumps the specified dbs on the configured host.
+#
+host=<%=@host%>
+user=<%=@dbbackup_user%>
+pass=<%=@dbbackup_password%>
+
+dbs=( $(mysql -h "$host" -u "$user" -p"$pass" -e 'show databases' | sed '1d;/information_schema/d;/performance_schema/d')  )
+
+for db in "${dbs[@]}"; do
+  mysqldump --host="$host" --user="$user" --password="$pass" --single-transaction --quick --routines --ignore-table=mysql.event "$db" > "$db".sql
+  wait
+  pbzip2 -p3 "$db".sql
+done
+

templates/psql.sh.erb

@@ -0,0 +1,17 @@
+#!/bin/bash
+# written by Norbert Varzariu <loomsen@gmail.com>
+# This Script is triggered by rsnapshot and dumps the specified dbs on the configured host.
+#
+host=<%=@host%>
+user=<%=@dbbackup_user%>
+pass=<%=@dbbackup_password%>
+
+PGPASSWORD="$pass"
+dbs=( $(psql -h "$host" -U "$user" -Atc "SELECT datname FROM pg_database WHERE NOT datistemplate AND datname <> 'postgres'")  )
+
+for db in "${dbs[@]}"; do
+  ssh -l root "$host" "pg_dump -U ${user} -Fc ${db}" > "$db".sql
+  wait
+  pbzip2 -p3 "$db".sql
+done
+

templates/rsnapshot.erb

@@ -1,8 +1,8 @@
 # This file is being managed by puppet
-# Module 'rsnaphost'
+# Module 'rsnapshot'
 
 config_version	<%= @config_version %>
-snapshot_root	<%= @snapshot_root %>
+snapshot_root	<%= @snapshot_root -%>/<%=@host%>
 <% if @no_create_root != '' -%> 
 no_create_root	<%= @no_create_root %>
 <% end -%>
@@ -130,9 +130,3 @@ backup	<%= @backup_user %>@<%=@host%>:<%= source %>	<%=dest%>
 backup	<%=@host%>:<%= source %>	<%=dest%>
 <% end -%>
 <% end -%>
-<% if @backup_scripts != '' -%>
-<% @backup_scripts.each_pair do |source, dest| -%>
-backup_script	<%= source %>	<%= dest %>
-<% end -%>
-<%end-%>
-