Improve Cinder Backup support

In my last commit on Cinder module, I add cinder::backup::swift
without adding cinder::backup class which is useful to ensure that
package is installed and service is running.
It also includes variables related to backup configuration.

Note: swift is one of the drivers of backup in Cinder, other ones should
be included in manifests/backup/<driver>.pp

Change-Id: I1a55245abe61f9bbd71568d76ed00e0ecf08307e
Signed-off-by: Emilien Macchi <emilien.macchi@enovance.com>

manifests/backup.pp

@@ -0,0 +1,84 @@
+#
+# Copyright (C) 2013 eNovance SAS <licensing@enovance.com>
+#
+# Author: Emilien Macchi <emilien.macchi@enovance.com>
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License. You may obtain
+# a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
+#
+# == Class: cinder::backup
+#
+# Setup Cinder backup service
+#
+# === Parameters
+#
+# [*backup_topic*]
+#   (optional) The topic volume backup nodes listen on.
+#   Defaults to 'cinder-backup'
+#
+# [*backup_manager*]
+#   (optional) Full class name for the Manager for volume backup.
+#   Defaults to 'cinder.backup.manager.BackupManager'
+#
+# [*backup_api_class*]
+#   (optional) The full class name of the volume backup API class.
+#   Defaults to 'cinder.backup.api.API'
+#
+# [*backup_name_template*]
+#   (optional) Template string to be used to generate backup names.
+#   Defaults to 'backup-%s'
+#
+
+class cinder::backup (
+  $enabled              = true,
+  $package_ensure       = 'present',
+  $backup_topic         = 'cinder-backup',
+  $backup_manager       = 'cinder.backup.manager.BackupManager',
+  $backup_api_class     = 'cinder.backup.api.API',
+  $backup_name_template = 'backup-%s'
+) {
+
+  include cinder::params
+
+  Cinder_config<||> ~> Service['cinder-backup']
+
+  if $::cinder::params::backup_package {
+    Package['cinder-backup'] -> Cinder_config<||>
+    Package['cinder-backup'] -> Service['cinder-backup']
+    package { 'cinder-backup':
+      ensure => $package_ensure,
+      name   => $::cinder::params::backup_package,
+    }
+  }
+
+  if $enabled {
+    $ensure = 'running'
+  } else {
+    $ensure = 'stopped'
+  }
+
+  service { 'cinder-backup':
+    ensure    => $ensure,
+    name      => $::cinder::params::backup_service,
+    enable    => $enabled,
+    hasstatus => true,
+    require   => Package['cinder'],
+  }
+
+  cinder_config {
+    'DEFAULT/backup_topic':         value => $backup_topic;
+    'DEFAULT/backup_manager':       value => $backup_manager;
+    'DEFAULT/backup_api_class':     value => $backup_api_class;
+    'DEFAULT/backup_name_template': value => $backup_name_template;
+  }
+
+}

manifests/params.pp

@@ -9,6 +9,8 @@ class cinder::params {
     $client_package     = 'python-cinderclient'
     $api_package        = 'cinder-api'
     $api_service        = 'cinder-api'
+    $backup_package     = 'cinder-backup'
+    $backup_service     = 'cinder-backup'
     $scheduler_package  = 'cinder-scheduler'
     $scheduler_service  = 'cinder-scheduler'
     $volume_package     = 'cinder-volume'
@@ -24,6 +26,8 @@ class cinder::params {
     $client_package     = 'python-cinderclient'
     $api_package        = false
     $api_service        = 'openstack-cinder-api'
+    $backup_package     = false
+    $backup_service     = 'openstack-cinder-backup'
     $scheduler_package  = false
     $scheduler_service  = 'openstack-cinder-scheduler'
     $volume_package     = false

spec/classes/cinder_backup_spec.rb

@@ -0,0 +1,101 @@
+#
+# Copyright (C) 2013 eNovance SAS <licensing@enovance.com>
+#
+# Author: Emilien Macchi <emilien.macchi@enovance.com>
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License. You may obtain
+# a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
+#
+# Unit tests for cinder::backup class
+#
+
+require 'spec_helper'
+
+describe 'cinder::backup' do
+
+  let :default_params do
+    { :enable               => true,
+      :backup_topic         => 'cinder-backup',
+      :backup_manager       => 'cinder.backup.manager.BackupManager',
+      :backup_api_class     => 'cinder.backup.api.API',
+      :backup_name_template => 'backup-%s' }
+  end
+
+  let :params do
+    {}
+  end
+
+  shared_examples_for 'cinder backup' do
+    let :p do
+      default_params.merge(params)
+    end
+
+    it { should include_class('cinder::params') }
+
+    it 'installs cinder backup package' do
+      if platform_params.has_key?(:backup_package)
+        should contain_package('cinder-backup').with(
+          :name   => platform_params[:backup_package],
+          :ensure => 'present'
+        )
+        should contain_package('cinder-backup').with_before(/Cinder_config\[.+\]/)
+        should contain_package('cinder-backup').with_before(/Service\[cinder-backup\]/)
+      end
+    end
+
+    it 'ensure cinder backup service is running' do
+      should contain_service('cinder-backup').with('hasstatus' => true)
+    end
+
+    it 'configures cinder.conf' do
+      should contain_cinder_config('DEFAULT/backup_topic').with_value(p[:backup_topic])
+      should contain_cinder_config('DEFAULT/backup_manager').with_value(p[:backup_manager])
+      should contain_cinder_config('DEFAULT/backup_api_class').with_value(p[:backup_api_class])
+      should contain_cinder_config('DEFAULT/backup_name_template').with_value(p[:backup_name_template])
+    end
+
+    context 'when overriding backup_name_template' do
+      before :each do
+        params.merge!(:backup_name_template => 'foo-bar-%s')
+      end
+      it 'should replace default parameter with new value' do
+        should contain_cinder_config('DEFAULT/backup_name_template').with_value(p[:backup_name_template])
+      end
+    end
+  end
+
+  context 'on Debian platforms' do
+    let :facts do
+      { :osfamily => 'Debian' }
+    end
+
+    let :platform_params do
+      { :backup_package => 'cinder-backup',
+        :backup_service => 'cinder-backup' }
+    end
+
+    it_configures 'cinder backup'
+  end
+
+  context 'on RedHat platforms' do
+    let :facts do
+      { :osfamily => 'RedHat' }
+    end
+
+    let :platform_params do
+      { :backup_service => 'cinder-backup' }
+    end
+
+    it_configures 'cinder backup'
+  end
+
+end

spec/classes/cinder_backup_swift_spec.rb

@@ -15,7 +15,7 @@
 # License for the specific language governing permissions and limitations
 # under the License.
 #
-# Unit tests for cinder::swift class
+# Unit tests for cinder::backup::swift class
 #
 
 require 'spec_helper'