REPORT de la branche 1.1 (459->476)
[euphorik.git] / 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 cheminComplet = "#{dossier}/#{fichier}"
53 if fichier[0,1] != '.' and File.directory?(cheminComplet) and fichier != 'libs'
54 if not verifierRecur(cheminComplet)
55 return false
56 end
57 elsif fichier[-3, 3] == '.js'
58 puts "== Vérification de #{cheminComplet} =="
59 # TODO : mettre un if pour la version windows si dessous
60 #system("java org.mozilla.javascript.tools.shell.Main jslint.js #{cheminComplet}")
61 system("rhino ./tools/jslint.js #{cheminComplet}")
62 # puts $?.exitstatus
63 if $?.exitstatus > 0
64 return false
65 end
66 end
67 }
68 return true
69 end
70 end
71
72 # Classe de gestion de la version
73 class Version
74 # @param dossier la racine du site (par exemple "/var/www/euphorik")
75 def initialize(dossier)
76 @dossier = dossier
77 File.open(@dossier + '/VERSION') {|file|
78 @version = file.readline()
79 }
80 # les fichiers HTML dans lesquels mettre à jour la version
81 @fichiers = ['/pages/about.html']
82 @balise = /(<span.+?class.*?=.*?"version".*?>).*?(<\/span>)/
83 end
84
85 # met à jour la version dans les fichiers @fichiers
86 def maj
87 @fichiers.each{|fichier|
88 fichier = @dossier + fichier
89 lines = IO.readlines(fichier)
90 File.open(fichier, 'w') {|io|
91 lines.each{|l|
92 io.write(l.sub(@balise){|m| $1 + @version + $2})
93 }
94 }
95 }
96 end
97 end
98
99 # Permet la mise en production et preproduction
100 class MiseEnProd
101 # obsolète !
102 @@rep_remote = '/var/www/euphorik'
103 @@host = 'euphorik.ch'
104
105 def initialize(racine)
106 Dir.chdir(racine)
107 end
108
109 # L'emplacement ou sont copié les fichiers
110 # A définir avant la mise en prod
111 def uri=(uri)
112 plop = uri.split(':')
113 @uri = plop[0]
114 @rep = plop[1]
115 end
116
117 # Effectue la mise en production.
118 def miseEnProd
119 copierFichiers()
120 maj('yaws')
121 end
122
123 # Effectue la mise en préproduction.
124 def miseEnPreProd
125 copierFichiers()
126 copierVAR()
127 lancerYaws()
128 maj('yaws_dev')
129 end
130
131 def copierFichiers
132 compiler_partie_serveuse()
133 creer_repertoire_bd()
134 copier_partie_statique()
135 pack_js()
136 copie_modules_serveurs()
137 set_droits_fichiers()
138 end
139
140 # TODO
141 def copierVar
142 #TODO
143 end
144
145 def lancerYaws
146 creer_rep("tools")
147 system("rsync tools/yaws.conf #{@uri}:#{@rep}/tools")
148 system("rsync tools/start_yaws.sh #{@uri}:#{@rep}/tools")
149 system("ssh #{@uri} \"cd #{@rep}/tools; screen -d -m -S yaws_dev ./start_yaws.sh\"")
150 end
151
152 def exec(commande)
153 system("ssh #{@uri} \"cd #{@rep} && #{commande}\"")
154 end
155
156 def creer_rep(rep)
157 begin
158 exec("test -d #{rep} || mkdir #{rep}")
159 rescue
160 end
161 end
162
163 def compiler_partie_serveuse
164 log "compilation des modules serveur"
165 Dir.chdir('modules')
166 system("make")
167 if $?.exitstatus != 0
168 puts "Echec de compilation de la partie serveuse"
169 exit 1
170 end
171 Dir.chdir('..')
172 end
173
174 def creer_repertoire_var
175 # création du repertoire BD
176 creer_rep('var')
177 creer_rep('var/images')
178 creer_rep('var/BD/backups')
179 exec("chmod -R g+w var")
180 end
181
182 # css, images, html, etc..
183 def copier_partie_statique
184 log "copie de la partie statique"
185 uri = "#{@uri}:#{@rep}"
186 system("awk '$0 !~ /prod=\"delete\"/' index.yaws | ssh #{@uri} \" cat > #{@rep}/index.yaws\"")
187 system("rsync favicon.ico #{uri}")
188 system("rsync --delete -r styles #{uri}")
189 system("rsync --delete -r pages #{uri}")
190 system("rsync --delete -r --exclude 'autres' img #{uri}")
191 end
192
193 # minification et package des fichiers js dans euphorik.js
194 def pack_js
195 log "minification, assemblage et copie du javascript"
196 rep_js = 'js'
197 creer_rep(rep_js)
198 # jquery.js et euphorik.js doivent se trouve en premier
199 fichiers = ['js/libs/jquery.js', 'js/euphorik.js'].concat(get_fichiers_js(rep_js))
200 commande_cat = "cat "
201 fichiers.each{|f|
202 commande_cat += f + " "
203 }
204 #copie des js concaténés avec minification
205 system("#{commande_cat} | tools/jsmin.rb | ssh #{@uri} \"cd #{@rep} && cat > #{rep_js}/euphorik.js\"")
206 end
207
208 #renvoie une liste des fichiers js
209 def get_fichiers_js(rep)
210 fichiers = []
211 Dir.entries(rep).each{|fichier|
212 if fichier[0..0] != '.' and fichier != 'euphorik.js' and fichier != 'jquery.js'
213 fichier = rep + "/" + fichier
214 if File.directory?(fichier)
215 fichiers.concat(get_fichiers_js(fichier))
216 else
217 fichiers << fichier
218 end
219 end
220 }
221 return fichiers
222 end
223
224 def copie_modules_serveurs
225 log "copie des modules du serveur"
226 # copie des modules erlang
227 creer_rep('modules')
228 system("rsync -r --exclude 'euphorik_test.beam' modules/ebin #{@uri}:#{@rep}/modules")
229 system("rsync -r modules/include #{@uri}:#{@rep}/modules")
230 end
231
232 def set_droits_fichiers
233 log "attribution des droits sur les fichiers"
234 # attribution des droits
235 exec("chmod -R g+rx .")
236 end
237
238 # noeud : le nom du noeud sur lequel le script de mise en prod est exécuté
239 # Execute le script 'mise_en_prod.erl' sur le serveur afin de :
240 # - Recharger les modules
241 # - Mettre à jour la base de données
242 def maj(noeud)
243 log "rechargement des modules serveur et mise à jour de la base de données"
244 # execution du script de mise à jour
245 system("cat tools/mise_en_prod.erl | ssh #{@uri} \"cat > /tmp/mise_en_prod.erl\"")
246 system("ssh #{@uri} \"chmod u+x /tmp/mise_en_prod.erl; /tmp/mise_en_prod.erl #{noeud}; rm /tmp/mise_en_prod.erl\"")
247 end
248
249 def log(message)
250 puts "----- #{message} -----"
251 end
252 end
253
254
255 # Traite la ligne de commande lorsque tools.rb est utilisé comme tel
256 class Commande
257 def initialize
258 Dir.chdir("..")
259 @miseEnProd = MiseEnProd.new(".")
260 @verifJS = VerifJS.new("js")
261 @version = Version.new(".")
262 end
263
264 def traiter
265 if ARGV.size == 0
266 afficherUsage
267 return
268 end
269
270 case ARGV[0]
271 when 'prod'
272 @version.maj()
273 @miseEnProd.uri = "gburri@euphorik.ch:/var/www/euphorik"
274 @miseEnProd.miseEnProd()
275 when 'pre'
276 @version.maj()
277 @miseEnProd.uri = "gburri@euphorik.ch:/var/www/euphorik_preprod"
278 @miseEnProd.miseEnPreProd()
279 when 'js'
280 @verifJS.verifier()
281 when 'version'
282 @version.maj()
283 end
284 end
285
286 def afficherUsage
287 puts "Usage : tools.rb (prod | pre | js | version)\n" +
288 " prod : Mise en production\n" +
289 " pre : Mise en préproduction, copie les données en production\n" +
290 " js : vérification des fichiers JavaScript\n" +
291 " version : met à jour la version à partir du fichier VERSION"
292 end
293 end
294
295 cl = Commande.new
296 cl.traiter()