8b1495451586136d9232a526743627a1bc076332
[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 = /(<a.+?href=".*?\/tags\/).*?(".+?class.*?=.*?"version".*?>).*?(<\/a>)/
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 + @version + $3})
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 lancerYaws()
127 maj('yaws_dev')
128 end
129
130 def copierFichiers
131 compiler_partie_serveuse()
132 creer_repertoire_bd()
133 copier_partie_statique()
134 pack_js()
135 copie_modules_serveurs()
136 set_droits_fichiers()
137 end
138
139 def lancerYaws
140 creer_rep("tools")
141 system("rsync tools/yaws.conf #{@uri}:#{@rep}/tools")
142 system("rsync tools/start_yaws.sh #{@uri}:#{@rep}/tools")
143 system("ssh #{@uri} \"cd #{@rep}/tools; screen -d -m -S yaws_dev ./start_yaws.sh\"")
144 end
145
146 def exec(commande)
147 system("ssh #{@uri} \"cd #{@rep} && #{commande}\"")
148 end
149
150 def creer_rep(rep)
151 begin
152 exec("test -d #{rep} || mkdir #{rep}")
153 rescue
154 end
155 end
156
157 def compiler_partie_serveuse
158 log "compilation des modules serveur"
159 Dir.chdir('modules')
160 system("make")
161 if $?.exitstatus != 0
162 puts "Echec de compilation de la partie serveuse"
163 exit 1
164 end
165 Dir.chdir('..')
166 end
167
168 def creer_repertoire_bd
169 log "création du répertoire de la base de données"
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 log "copie de la partie statique"
179 uri = "#{@uri}:#{@rep}"
180 system("awk '$0 !~ /prod=\"delete\"/' index.yaws | ssh #{@uri} \" cat > #{@rep}/index.yaws\"")
181 system("rsync favicon.ico #{uri}")
182 system("rsync --delete -r styles #{uri}")
183 system("rsync --delete -r pages #{uri}")
184 system("rsync --delete -r --exclude 'autres' img #{uri}")
185 end
186
187 # minification et package des fichiers js dans euphorik.js
188 def pack_js
189 log "minification, assemblage et copie du javascript"
190 rep_js = 'js'
191 creer_rep(rep_js)
192 # jquery.js et euphorik.js doivent se trouve en premier
193 fichiers = ['js/libs/jquery.js', 'js/euphorik.js'].concat(get_fichiers_js(rep_js))
194 commande_cat = "cat "
195 fichiers.each{|f|
196 commande_cat += f + " "
197 }
198 #copie des js concaténés avec minification
199 system("#{commande_cat} | tools/jsmin.rb | ssh #{@uri} \"cd #{@rep} && cat > #{rep_js}/euphorik.js\"")
200 end
201
202 #renvoie une liste des fichiers js
203 def get_fichiers_js(rep)
204 fichiers = []
205 Dir.entries(rep).each{|fichier|
206 if fichier[0..0] != '.' and fichier != 'euphorik.js' and fichier != 'jquery.js'
207 fichier = rep + "/" + fichier
208 if File.directory?(fichier)
209 fichiers.concat(get_fichiers_js(fichier))
210 else
211 fichiers << fichier
212 end
213 end
214 }
215 return fichiers
216 end
217
218 def copie_modules_serveurs
219 log "copie des modules du serveur"
220 # copie des modules erlang
221 creer_rep('modules')
222 system("rsync -r --exclude 'euphorik_test.beam' modules/ebin #{@uri}:#{@rep}/modules")
223 system("rsync -r modules/include #{@uri}:#{@rep}/modules")
224 end
225
226 def set_droits_fichiers
227 log "attribution des droits sur les fichiers"
228 # attribution des droits
229 exec("chmod -R g+rx .")
230 end
231
232 # noeud : le nom du noeud sur lequel le script de mise en prod est exécuté
233 # Execute le script 'mise_en_prod.erl' sur le serveur afin de :
234 # - Recharger les modules
235 # - Mettre à jour la base de données
236 def maj(noeud)
237 log "rechargement des modules serveur et mise à jour de la base de données"
238 # execution du script de mise à jour
239 system("cat tools/mise_en_prod.erl | ssh #{@uri} \"cat > /tmp/mise_en_prod.erl\"")
240 system("ssh #{@uri} \"chmod u+x /tmp/mise_en_prod.erl; /tmp/mise_en_prod.erl #{noeud}; rm /tmp/mise_en_prod.erl\"")
241 end
242
243 def log(message)
244 puts "----- #{message} -----"
245 end
246 end
247
248
249 # Traite la ligne de commande lorsque tools.rb est utilisé comme tel
250 class Commande
251 def initialize
252 Dir.chdir("..")
253 @miseEnProd = MiseEnProd.new(".")
254 @verifJS = VerifJS.new("js")
255 @version = Version.new(".")
256 end
257
258 def traiter
259 if ARGV.size == 0
260 afficherUsage
261 return
262 end
263
264 case ARGV[0]
265 when 'prod'
266 @version.maj()
267 @miseEnProd.uri = "gburri@euphorik.ch:/var/www/euphorik"
268 @miseEnProd.miseEnProd()
269 when 'pre'
270 @version.maj()
271 @miseEnProd.uri = "gburri@euphorik.ch:/var/www/euphorik_preprod"
272 @miseEnProd.miseEnPreProd()
273 when 'js'
274 @verifJS.verifier()
275 when 'version'
276 @version.maj()
277 end
278 end
279
280 def afficherUsage
281 puts "Usage : tools.rb (prod | pre | js | version)\n" +
282 " prod : Mise en production\n" +
283 " pre : Mise en préproduction, copie les données en production\n" +
284 " js : vérification des fichiers JavaScript\n" +
285 " version : met à jour la version à partir du fichier VERSION"
286 end
287 end
288
289 cl = Commande.new
290 cl.traiter()