tools/tools.rb

   1 #!/usr/bin/ruby
   2 # coding: utf-8
   3 =begin
   4 Copyright 2008 Grégory Burri
   5
   6 This file is part of Euphorik.
   7
   8 Euphorik is free software: you can redistribute it and/or modify
   9 it under the terms of the GNU General Public License as published by
  10 the Free Software Foundation, either version 3 of the License, or
  11 (at your option) any later version.
  12
  13 Euphorik is distributed in the hope that it will be useful,
  14 but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 GNU General Public License for more details.
  17
  18 You should have received a copy of the GNU General Public License
  19 along with Euphorik.  If not, see <http://www.gnu.org/licenses/>.
  20 =end
  21
  22 # TODO :
  23 # - création de unit tests (voir eunit) et validation avant la mise en prod
  24
  25 # Met à disposition plusieurs outils (classes), tel que :
  26 #  - Vérification du code javascript
  27 #  - Mise à jour du numéro de version à partir du fichier VERSION
  28 #  - Mise en production et en preproduction
  29 # tools.rb peut s'utiliser à la ligne de commande, exemples :
  30 # * Mise en production :
  31 #  ./tools.rb prod gburri@euphorik.ch:/var/www/euphorik
  32 # * Mise en préproduction, l'emplacement de production peut être indiqué pour copier la base
  33 #  ./tools.rb pre gburri@euphorik.ch:/var/www/euphorik_preprod gburri@euphorik.ch:/var/www/euphorik
  34
  35 # voir : http://net-ssh.rubyforge.org/ssh/v2/api/index.html
  36 # require 'net/ssh'
  37
  38 # Classe permettant la vérification du code JS pas jslint.
  39 # Passe en revu chaque fichier js de manière récursive à partir d'un dossier de départ.s
  40 class VerifJS
  41
  42    def initialize(dossier)
  43       @dossier = dossier
  44    end
  45
  46    def verifier
  47       verifierRecur(@dossier)
  48    end
  49
  50    def verifierRecur(dossier)
  51       Dir.foreach(dossier){|fichier|
  52          if fichier != '.' and fichier != '..' and File.directory?(fichier) and fichier != 'dirs'
  53             if not verifierRecur(dossier + '/' + fichier)
  54                return false
  55             end
  56          elsif fichier[-3, 3] == '.js'
  57             puts "== Vérification de #{dossier}/#{fichier} =="
  58             # TODO : mettre un if pour la version windows si dessous
  59             #system("java org.mozilla.javascript.tools.shell.Main jslint.js #{dossier}/#{fichier}")
  60             system("rhino ./tools/jslint.js #{dossier}/#{fichier}")
  61             # puts $?.exitstatus
  62             if $?.exitstatus > 0
  63                return false
  64             end
  65          end
  66       }
  67       return true
  68    end
  69 end
  70
  71 # Classe de gestion de la version
  72 class Version
  73    # @param dossier la racine du site (par exemple "/var/www/euphorik")
  74    def initialize(dossier)
  75       @dossier = dossier
  76       File.open(@dossier + '/VERSION') {|file|
  77          @version = file.readline()
  78       }
  79       # les fichiers HTML dans lesquels mettre à jour la version
  80       @fichiers  = ['/pages/about.html']
  81       @balise = /(<span.+?class.*?=.*?"version".*?>).*?(<\/span>)/
  82    end
  83
  84    # met à jour la version dans les fichiers @fichiers
  85    def  maj
  86       @fichiers.each{|fichier|
  87          fichier = @dossier + fichier
  88          lines = IO.readlines(fichier)
  89          File.open(fichier, 'w') {|io|
  90             lines.each{|l|
  91                io.write(l.sub(@balise){|m| $1 + @version + $2})
  92             }
  93          }
  94       }
  95    end
  96 end
  97
  98 # Permet la mise en production et preproduction
  99 class MiseEnProd
 100    # obsolète !
 101    @@rep_remote = '/var/www/euphorik'
 102    @@host = 'euphorik.ch'
 103
 104    def initialize(racine)
 105       Dir.chdir(racine)
 106    end
 107
 108    # L'emplacement ou sont copié les fichiers
 109    # A définir avant la mise en prod
 110    def uri=(uri)
 111       plop = uri.split(':')
 112       @uri = plop[0]
 113       @rep = plop[1]
 114    end
 115
 116    # Effectue la mise en production.
 117    def miseEnProd
 118       copierFichiers()
 119       maj()
 120    end
 121
 122    # Effectue la mise en préproduction.
 123    def miseEnPreProd
 124       copierFichiers()
 125       copierBD()
 126       lancerYaws()
 127    end
 128
 129    def copierFichiers
 130       compiler_partie_serveuse()
 131       creer_repertoire_bd()
 132       copier_partie_statique()
 133       pack_js()
 134       copie_modules_serveurs()
 135       set_droits_fichiers()
 136    end
 137
 138    # TODO
 139    def copierBD
 140    end
 141
 142    def lancerYaws
 143       creer_rep("tools")
 144       system("rsync tools/yaws.conf #{@uri}:#{@rep}/tools")
 145       system("rsync tools/start_yaws.sh #{@uri}:#{@rep}/tools")
 146    end
 147
 148    def exec(commande)
 149       system("ssh #{@uri} \"cd #{@rep} && #{commande}\"")
 150    end
 151
 152    def creer_rep(rep)
 153       begin
 154          exec("test -d #{rep} || mkdir #{rep}")
 155       rescue
 156       end
 157    end
 158
 159    def compiler_partie_serveuse
 160       Dir.chdir('modules')
 161       system("make")
 162       if $?.exitstatus != 0
 163          puts "Echec de compilation de la partie serveuse"
 164          exit 1
 165       end
 166       Dir.chdir('..')
 167    end
 168
 169    def creer_repertoire_bd
 170       # création du repertoire BD
 171       creer_rep('BD')
 172       creer_rep('BD/backups')
 173       exec("chmod -R g+w BD")
 174    end
 175
 176    # css, images, html, etc..
 177    def copier_partie_statique
 178       uri = "#{@uri}:#{@rep}"
 179       system("awk '$0 !~ /prod=\"delete\"/' index.yaws | ssh #{@uri} \" cat > #{@rep}/index.yaws\"")
 180       system("rsync favicon.ico #{uri}")
 181       system("rsync --delete -r styles #{uri}")
 182       system("rsync --delete -r pages #{uri}")
 183       system("rsync --delete -r --exclude 'autres' img #{uri}")
 184    end
 185
 186    # minification et package des fichiers js dans euphorik.js
 187    def pack_js
 188       rep_js = 'js'
 189       creer_rep(rep_js)
 190       # jquery.js et euphorik.js doivent se trouve en premier
 191       fichiers = ['js/libs/jquery.js', 'js/euphorik.js'].concat(get_fichiers_js(rep_js))
 192       commande_cat = "cat "
 193       fichiers.each{|f|
 194          commande_cat += f + " "
 195       }
 196       #copie des js concaténés avec minification
 197       system("#{commande_cat} | tools/jsmin.rb | ssh #{@uri} \"cd #{@rep} && cat > #{rep_js}/euphorik.js\"")
 198    end
 199
 200    #renvoie une liste des fichiers js
 201    def get_fichiers_js(rep)
 202       fichiers = []
 203       Dir.entries(rep).each{|fichier|
 204          if fichier[0..0] != '.' and fichier != 'euphorik.js' and fichier != 'jquery.js'
 205             fichier = rep + "/" + fichier
 206             if File.directory?(fichier)
 207                fichiers.concat(get_fichiers_js(fichier))
 208             else
 209                fichiers <<  fichier
 210             end
 211          end
 212       }
 213       return fichiers
 214    end
 215
 216    def copie_modules_serveurs
 217       # copie des modules erlang
 218       creer_rep('modules')
 219       system("rsync -r --exclude 'euphorik_test.beam' modules/ebin #{@uri}:#{@rep}/modules")
 220       system("rsync -r modules/include #{@uri}:#{@rep}/modules")
 221    end
 222
 223    def set_droits_fichiers
 224       # attribution des droits
 225       exec("chmod -R g+rx .")
 226    end
 227
 228    def maj
 229       # execution du script de mise à jour
 230       system("cat tools/mise_en_prod.erl | ssh #{@uri} \"cat > /tmp/mise_en_prod.erl\"")
 231       system("ssh #{@uri} \"chmod u+x /tmp/mise_en_prod.erl; /tmp/mise_en_prod.erl; rm /tmp/mise_en_prod.erl\"")
 232    end
 233 end
 234
 235
 236 # Traite la ligne de commande lorsque tools.rb est utilisé comme tel
 237 class Commande
 238    def initialize
 239       Dir.chdir("..")
 240       @miseEnProd = MiseEnProd.new(".")
 241       @verifJS = VerifJS.new("js")
 242       @version = Version.new(".")
 243    end
 244
 245    def traiter
 246       if ARGV.size == 0
 247          afficherUsage
 248          return
 249       end
 250
 251       case ARGV[0]
 252          when 'prod'
 253             @version.maj()
 254             @miseEnProd.uri = "gburri@euphorik.ch:/var/www/euphorik"
 255             @miseEnProd.miseEnProd()
 256          when 'pre'
 257             @version.maj()
 258             @miseEnProd.uri = "gburri@euphorik.ch:/var/www/euphorik_preprod"
 259             @miseEnProd.miseEnPreProd()
 260          when 'js'
 261             @verifJS.verifier()
 262          when 'version'
 263             @version.maj()
 264       end
 265
 266 =begin
 267       Net::SSH.start('euphorik.ch', 'gburri') {|ssh|
 268          output = ssh.exec!("hostname")
 269          stdout = ""
 270          ssh.exec!("ls -l /tmp"){|channel, stream, data|
 271             stdout << data if stream == :stdout
 272          }
 273          puts stdout
 274       }
 275 =end
 276    end
 277
 278    def afficherUsage
 279       puts "Usage : tools.rb (prod | pre | js | version)\n" +
 280          "   prod : Mise en production\n" +
 281          "   pre : Mise en préproduction, copie les données en production\n" +
 282          "   js : vérification des fichiers JavaScript\n" +
 283          "   version : met à jour la version à partir du fichier VERSION"
 284    end
 285 end
 286
 287 cl = Commande.new
 288 cl.traiter()