Example of YAML config file in a Ruby admin script

config.yml

# Configuration de l'outil de migration LDAP/IMAP
#
# Date : 2009-01-13
#
# Copyright (C) 2009 Farzad FARID <[email protected]>

hostname: new-srv
ldap:
  user: cn=admin, o=customer, c=fr
  password: XXXXXXXX
  infile: customer-orig.ldif
  outfile: customer-clean.ldif
imap:
  user: cyrus
  password: YYYYY

Rakefile

# 
# Rakefile de contrôle de la migration LDAP / IMAP
# 
# Date : 2009-01-13
# 
# Copyright (C) 2009 Farzad FARID <[email protected]>
#
#  This program is free software; you can redistribute it and/or modify
#  it under the terms of the GNU General Public License as published by
#  the Free Software Foundation; either version 3 of the License, or
#  (at your option) any later version.
#
#  This program is distributed in the hope that it will be useful,
#  but WITHOUT ANY WARRANTY; without even the implied warranty of
#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
#  GNU General Public License for more details.
#
#  You should have received a copy of the GNU General Public License
#  along with this program.  If not, see <http://www.gnu.org/licenses/>.

# Note : les tâches Rake qui n'ont pas besoin d'être visibles pour
# l'utilisateur n'ont pas de description "desc".

require 'rake'
require 'rake/testtask'
require 'rake/rdoctask'

#######################################################################
# Configuration
#######################################################################
TESTDIR  = File.join(File.dirname(__FILE__), "test")
DATADIR  = File.join(File.dirname(__FILE__), "data")
CLEANER  = File.join("lib", "customer-clean-ldif.rb")
SMTP_SIMULATOR = File.join("lib", "smtp-simulator.rb")

MyConfig = YAML.load(IO.read(File.join(File.dirname(__FILE__), "config.yml")))
HOSTNAME = MyConfig["hostname"]
ROOTDN   = MyConfig["ldap"]["user"]
ROOTPW   = MyConfig["ldap"]["password"]
INFILE	 = File.join(DATADIR, MyConfig["ldap"]["infile"])
OUTFILE  = File.join(DATADIR, MyConfig["ldap"]["outfile"])


# Affiche une chaîne, pour exécute là dans un shell
def show_exec(str)
  puts ">>> " + str
  puts %x{#{str}}
end

# Vérification de l'environnement d'exécution
task :config do
  # Est-on sur la bonne machine ?
  if %x{hostname}.strip != HOSTNAME
    raise RuntimeError, "ERREUR : La machine courante doit être '#{HOSTNAME}'"
  end
  # Est-on root ?
  if Process.uid != 0
    raise RuntimeError, "ERREUR : Le script doit tourner sous l'utilisateur root'"
  end
end

# Tâche par défaut : ne fait rien
task :default do
  puts "Veuillez consulter 'rake -T' ou la documentation avant de lancer ce programme"
end

namespace :ldap do
  desc "Récupération de l'annuaire 'old-srv' et nettoyage"
  task :clean_ldif => :config do
    puts "Récupération de l'annuaire LDAP d'old-srv"
    show_exec %{ssh old-srv "slapcat" > "#{INFILE}"}
    puts "Nettoyage de l'annuaire LDAP"
    show_exec %{#{CLEANER} "#{INFILE}" > "#{OUTFILE}"}
  end

  desc "Test d'insertion des enregistrements LDAP sur #{HOSTNAME}"
  task :insert_test => :clean_ldif do
    puts "Simulation d'insertion des enregistrements LDAP"
    show_exec %{ldapadd -n -x -h localhost -D "#{ROOTDN}" -w "#{ROOTPW}" -f "#{OUTFILE}"}
  end

  # Attention : cette commande détruit le contenu de l'annuaire
  desc "Insère de façon incrémentale les enregistrements LDAP sur #{HOSTNAME}"
  task :insert_incr => :clean_ldif do
    puts "Insertion incrémentable des enregistrements LDAP"
    show_exec %{ldapadd -c -x -h localhost -D "#{ROOTDN}" -w "#{ROOTPW}" -f "#{OUTFILE}"}
  end

  # Attention : cette commande détruit le contenu de l'annuaire
  desc "Détruit le contenu actuel de l'annuaire LDAP"
  task :empty_directory => :config do
    puts "Remise à zéro de l'annuaire LDAP"
    show_exec %{/etc/init.d/slapd stop
    sleep 1
    rm -f /var/lib/ldap/*
    /etc/init.d/slapd start}
  end

  # Attention : cette commande détruit le contenu de l'annuaire
  desc "Insère les enregistrements LDAP sur #{HOSTNAME} en détruisant le contenu précédent"
  task :insert_full => [ :clean_ldif, :empty_directory] do
    puts "Insertion complète des enregistrements LDAP"
    show_exec %{sleep 2
    ldapadd -c -x -h localhost -D "#{ROOTDN}" -w "#{ROOTPW}" -f "#{OUTFILE}"}
  end
end

namespace :imap do
  # Connexion au serveur IMAP local
  task :connect => :config do
    require 'net/imap'

    IMAP = Net::IMAP.new("localhost")
    IMAP.login(MyConfig["imap"]["user"], MyConfig["imap"]["password"])
    # Extension de la class d'IMAP pour ajouter une fonction de logging
    # Si la fonction appelée est "IMAP.show_*" alors on affiche
    # la commande réelle et ses paramètre, et ensuite on exécute la
    # commande dans le contexte IMAP.
    class << IMAP
      def method_missing(method, *arguments)
        # Si la fonction appelée est "show_*" alors affiche
        # la commande "*" et ensuite exécute la dans le contexte IMAP
        if method.to_s =~ /^show_(\w+)$/
          imapcmd = $1
          puts ">> IMAP #{imapcmd}#{arguments.inspect}"
          self.send(imapcmd, *arguments)
        else
          super
        end
      end
    end
  end
  
  # Récupère la liste les dossiers Cyrus importables depuis old-srv
  task :get_mboxlist => :config do
    # On garde uniquement les dossiers préfixés par "user."
    # Le tableau a 2 colonnes :
    # - La 1ère contient les noms de dossieers source, contenant notamment le préfixe "customerfr_"
    # - La 2nde les noms de dossiers nettoyés pour le nouveau serveur
    MBOXLIST = %x{ssh old-srv "su -c '/usr/sbin/ctl_mboxlist -d' cyrus" | \
      sed -n -e '/^user\\./ p' }.split(/\n/).map do |line|
      folder = line.split(/\t/).first
      [ folder, folder.gsub(/customerfr_/, "") ]
    end
    # On en extrait les noms de comptes, en ne gardant que les dossiers
    # à la racine de "user.".
    USERLIST = MBOXLIST.map do |folder_src, folder_dst|
      if folder_src.count(".") == 1
        # On garde le terme qui suit "user.", que l'on met en minuscule
        # pour Cyrus Imap 2.2.x
        [ folder_src.split(".").last, folder_dst.split(".").last.downcase ]
      else
        nil
      end
    end.compact # Suppression des valeurs "nil"
  end

  desc "Liste les dossiers Cyrus importables (ancien et nouveau nom)"
  task :show_mboxlist => :get_mboxlist do
    puts "Liste des dossiers Cyrus Imap importables (ancien nom, nouveau nom)\n"
    MBOXLIST.each do |folder_src, folder_dst|
      puts "#{folder_src} => #{folder_dst}"
    end
    puts "\nListe théorique de tous les comptes IMAP\n"
    USERLIST.each do |user_src, user_dst|
      puts "#{user_src} => #{user_dst}"
    end
    
  end

  desc "Envoie des commandes de test à Cyrus Imap"
  task :test => :connect do
    puts "Test du serveur IMAP"
    puts "Capability after login: #{IMAP.capability.join(' ')}"
    puts "Création d'un compte/dossier IMAP"
    IMAP.show_create("user.ffarid")
    puts "Anciens droits du dossier :"
    IMAP.show_getacl("user.ffarid").each do |right|
      puts "  #{right.user} : #{right.rights}"
    end
    puts "Tentative de création d'un dossier qui existe déjà"
    begin
      IMAP.show_create("user.ffarid")
    rescue Net::IMAP::NoResponseError => e
      puts ">>>> Exception #{e}"
    end
    puts "Modification des ACL"
    IMAP.show_setacl("user.ffarid", "cyrus", "lrswipcda")
    puts "Nouveaux droits du dossier :"
    IMAP.show_getacl("user.ffarid").each do |right|
      puts "  #{right.user} : #{right.rights}"
    end
    IMAP.show_delete("user.ffarid")
  end

  desc "Création de tous les dossiers IMAP"
  task :create_folders => [ :connect, :get_mboxlist ] do
    puts "Création de tous les dossiers IMAP"
    MBOXLIST.each do |folder_src, folder_dst|
      puts "Création de #{folder_dst}"
      begin
        IMAP.show_create(folder_dst)
      rescue Net::IMAP::NoResponseError => e
        # Il y a normalement une exception (bénigne) si le dossier existe déjà
        puts ">>>> Exception #{e}"
      end
      IMAP.show_setacl(folder_dst, "cyrus", "lrswipcda")
    end
  end

  desc "Transfert de tous les dossiers IMAP (simulation par défaut, DOIT=1 pour le mode réel)"
  task :copy_folders => :get_mboxlist do
    dry_run = ENV["DOIT"].nil? ? "--dry" : ""
    USERLIST.each do |user_src, user_dst|
      puts ">> Copie des mails et dossiers de '#{user_src}' vers '#{user_dst}'\n"
      show_exec "imapsync --host1 old-srv --host2 new-srv --authuser1 #{MyConfig["imap"]["user"]} --password1 '#{MyConfig["imap"]["password"]}' --authuser2 #{MyConfig["imap"]["user"]} --password2 '#{MyConfig["imap"]["password"]}' --authmech2 PLAIN --subscribe --user1 #{user_src} --user2 #{user_dst} --delete2 --expunge --expunge2 --authmech1 PLAIN --ssl1 --ssl2 --syncinternaldates #{dry_run}"
      puts "\n"
    end
  end
end
  
namespace :smtp do
  desc "Copie le fichier /etc/aliases depuis l'ancien serveur, en le corrigeant"
  task :copy_aliases => :config do
    show_exec "scp old-srv:/etc/aliases /etc/aliases.new"
    show_exec "grep -v [email protected] /etc/aliases.new > /etc/aliases"
    show_exec "rm -f /etc/aliases.new"
    show_exec "newaliases"
  end
  desc "Envoie un mail de test au SMTP local (option [email protected],yy@customerfr,[email protected]')"
  task :test_local => :config do
    puts "Test d'envoi d'un mail en local à une adresse @customer.fr de test"
    show_exec SMTP_SIMULATOR
  end
end