3 # Copyright (C) 2010-2013 CEA/DEN
5 # This library is free software; you can redistribute it and/or
6 # modify it under the terms of the GNU Lesser General Public
7 # License as published by the Free Software Foundation; either
8 # version 2.1 of the License.
10 # This library is distributed in the hope that it will be useful,
11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 # Lesser General Public License for more details.
15 # You should have received a copy of the GNU Lesser General Public
16 # License along with this library; if not, write to the Free Software
17 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20 In this file : all functions that do a system call,
21 like open a browser or an editor, or call a git command
30 import utilsSat as UTS
33 from . import printcolors
35 def show_in_editor(editor, filePath, logger):
36 '''open filePath using editor.
38 :param editor str: The editor to use.
39 :param filePath str: The path to the file to open.
41 # default editor is vi
42 if editor is None or len(editor) == 0:
45 if '%s' not in editor:
49 # launch cmd using subprocess.Popen
50 cmd = editor % filePath
51 logger.write('Launched command:\n' + cmd + '\n', 5)
52 p = subprocess.Popen(cmd, shell=True)
55 logger.write(printcolors.printcError(_("Unable to edit file %s\n")
58 def git_describe(repo_path):
59 '''Use git describe --tags command to return tag description of the git repository"
60 :param repo_path str: The git repository to describe
62 git_cmd="cd %s;git describe --tags" % repo_path
63 p = subprocess.Popen(git_cmd, shell=True,
64 stdin=subprocess.PIPE,
65 stdout=subprocess.PIPE,
66 stderr=subprocess.PIPE)
71 tag_description=p.stdout.readlines()[0].strip()
72 # with python3 this utf8 bytes should be decoded
73 if isinstance(tag_description, bytes):
74 tag_description=tag_description.decode("utf-8", "ignore")
75 return tag_description
78 def git_extract(from_what, tag, where, logger, environment=None):
79 '''Extracts sources from a git repository.
81 :param from_what str: The remote git repository.
82 :param tag str: The tag.
83 :param where str: The path where to extract.
84 :param logger Logger: The logger instance to use.
85 :param environment src.environment.Environ: The environment to source when extracting.
86 :return: True if the extraction is successful
89 DBG.write("git_extract", [from_what, tag, str(where)])
90 if not where.exists():
92 where_git = os.path.join(str(where), ".git")
93 if tag == "master" or tag == "HEAD":
94 if src.architecture.is_windows():
95 cmd = "git clone %(remote)s %(where)s"
99 git clone %(remote)s %(where)s
100 touch -d "$(git --git-dir=%(where_git)s log -1 --format=date_format)" %(where)s
102 #git --git-dir=%(where_git)s log -1 --format=date_format > %(where)s/last_commit_date.txt
103 cmd = cmd % {'remote': from_what, 'tag': tag, 'where': str(where), 'where_git': where_git}
105 # NOTICE: this command only works with recent version of git
106 # because --work-tree does not work with an absolute path
107 if src.architecture.is_windows():
108 cmd = "rmdir %(where)s && git clone %(remote)s %(where)s && git --git-dir=%(where_git)s --work-tree=%(where)s checkout %(tag)s"
113 git clone %(remote)s %(where)s && \
114 git --git-dir=%(where_git)s --work-tree=%(where)s checkout %(tag)s
115 touch -d "$(git --git-dir=%(where_git)s log -1 --format=date_format)" %(where)s
117 cmd = cmd % {'remote': from_what,
120 'where_git': where_git}
123 cmd=cmd.replace('date_format','"%ai"')
124 logger.logTxtFile.write("\n" + cmd + "\n")
125 logger.logTxtFile.flush()
127 DBG.write("cmd", cmd)
129 # git commands may fail sometimes for various raisons
130 # (big module, network troubles, tuleap maintenance)
131 # therefore we give several tries
133 max_number_of_tries = 3
134 sleep_delay = 30 # seconds
137 rc = UTS.Popen(cmd, cwd=str(where.dir()), env=environment.environ.environ, logger=logger)
138 if rc.isOk() or (i_try>=max_number_of_tries):
140 logger.write('\ngit command failed! Wait %d seconds and give an other try (%d/%d)\n' % \
141 (sleep_delay, i_try + 1, max_number_of_tries), 3)
142 time.sleep(sleep_delay) # wait a little
147 def git_extract_sub_dir(from_what, tag, where, sub_dir, logger, environment=None):
148 '''Extracts sources from a subtree sub_dir of a git repository.
150 :param from_what str: The remote git repository.
151 :param tag str: The tag.
152 :param where str: The path where to extract.
153 :param sub_dir str: The relative path of subtree to extract.
154 :param logger Logger: The logger instance to use.
155 :param environment src.environment.Environ: The environment to source when extracting.
156 :return: True if the extraction is successful
159 strWhere = str(where)
160 tmpWhere = strWhere + '_tmp'
161 parentWhere = os.path.dirname(strWhere)
162 if not os.path.exists(parentWhere):
163 logger.error("not existing directory: %s" % parentWhere)
165 if os.path.isdir(strWhere):
166 logger.error("do not override existing directory: %s" % strWhere)
168 aDict = {'remote': from_what,
172 'parentWhere': parentWhere,
173 'tmpWhere': tmpWhere,
175 DBG.write("git_extract_sub_dir", aDict)
176 if not src.architecture.is_windows():
179 export tmpDir=%(tmpWhere)s && \
181 git clone %(remote)s $tmpDir && \
183 git checkout %(tag)s && \
184 mv %(sub_dir)s %(where)s && \
185 git log -1 > %(where)s/README_git_log.txt && \
191 set tmpDir=%(tmpWhere)s && \
193 git clone %(remote)s $tmpDir && \
195 git checkout %(tag)s && \
196 mv %(sub_dir)s %(where)s && \
197 git log -1 > %(where)s/README_git_log.txt && \
201 DBG.write("cmd", cmd)
203 for nbtry in range(0,3): # retries case of network problem
204 rc = UTS.Popen(cmd, cwd=parentWhere, env=environment.environ.environ, logger=logger)
206 time.sleep(30) # wait a little
210 def archive_extract(from_what, where, logger):
211 '''Extracts sources from an archive.
213 :param from_what str: The path to the archive.
214 :param where str: The path where to extract.
215 :param logger Logger: The logger instance to use.
216 :return: True if the extraction is successful
220 archive = tarfile.open(from_what)
221 for i in archive.getmembers():
222 archive.extract(i, path=str(where))
223 return True, os.path.commonprefix(archive.getnames())
224 except Exception as exc:
225 logger.write("archive_extract: %s\n" % exc)
228 def cvs_extract(protocol, user, server, base, tag, product, where,
229 logger, checkout=False, environment=None):
230 '''Extracts sources from a cvs repository.
232 :param protocol str: The cvs protocol.
233 :param user str: The user to be used.
234 :param server str: The remote cvs server.
236 :param tag str: The tag.
237 :param product str: The product.
238 :param where str: The path where to extract.
239 :param logger Logger: The logger instance to use.
240 :param checkout boolean: If true use checkout cvs.
241 :param environment src.environment.Environ: The environment to source when
243 :return: True if the extraction is successful
248 if tag is not None and len(tag) > 0:
254 elif len(opttag) == 0:
257 if len(protocol) > 0:
258 root = "%s@%s:%s" % (user, server, base)
259 command = "cvs -d :%(protocol)s:%(root)s %(command)s -d %(where)s %(tag)s %(product)s" % \
260 { 'protocol': protocol, 'root': root, 'where': str(where.base()),
261 'tag': opttag, 'product': product, 'command': cmd }
263 command = "cvs -d %(root)s %(command)s -d %(where)s %(tag)s %(base)s/%(product)s" % \
264 { 'root': server, 'base': base, 'where': str(where.base()),
265 'tag': opttag, 'product': product, 'command': cmd }
267 logger.write(command + "\n", 5)
269 if not where.dir().exists():
272 logger.logTxtFile.write("\n" + command + "\n")
273 logger.logTxtFile.flush()
274 res = subprocess.call(command,
275 cwd=str(where.dir()),
276 env=environment.environ.environ,
278 stdout=logger.logTxtFile,
279 stderr=subprocess.STDOUT)
282 def svn_extract(user,
289 '''Extracts sources from a svn repository.
291 :param user str: The user to be used.
292 :param from_what str: The remote git repository.
293 :param tag str: The tag.
294 :param where str: The path where to extract.
295 :param logger Logger: The logger instance to use.
296 :param checkout boolean: If true use checkout svn.
297 :param environment src.environment.Environ: The environment to source when
299 :return: True if the extraction is successful
302 if not where.exists():
306 command = "svn checkout --username %(user)s %(remote)s %(where)s" % \
307 { 'remote': from_what, 'user' : user, 'where': str(where) }
310 if os.path.exists(str(where)):
311 command = "/bin/rm -rf %(where)s && " % \
312 { 'remote': from_what, 'where': str(where) }
315 command += "svn export --username %(user)s %(remote)s %(where)s" % \
316 { 'remote': from_what, 'user' : user, 'where': str(where) }
318 command += "svn export -r %(tag)s --username %(user)s %(remote)s %(where)s" % \
319 { 'tag' : tag, 'remote': from_what, 'user' : user, 'where': str(where) }
321 logger.logTxtFile.write(command + "\n")
323 logger.write(command + "\n", 5)
324 logger.logTxtFile.write("\n" + command + "\n")
325 logger.logTxtFile.flush()
326 res = subprocess.call(command,
327 cwd=str(where.dir()),
328 env=environment.environ.environ,
330 stdout=logger.logTxtFile,
331 stderr=subprocess.STDOUT)
334 def get_pkg_check_cmd(dist_name):
335 '''Build the command to use for checking if a linux package is installed or not.'''
337 if dist_name in ["CO","FD","MG","MD","CO","OS"]: # linux using rpm
339 manager_msg_err="Error : command failed because sat was not able to find apt command"
342 manager_msg_err="Error : command failed because sat was not able to find rpm command"
344 # 1- search for an installed package manager (rpm on rh, apt on db)
345 cmd_which_rpm=["which", "rpm"]
346 cmd_which_apt=["which", "apt"]
347 with open(os.devnull, 'w') as devnull:
348 # 1) we search for apt (debian based systems)
349 completed=subprocess.call(cmd_which_apt,stdout=devnull, stderr=subprocess.STDOUT)
350 if completed==0 and linux=="DB":
351 cmd_is_package_installed=["apt", "list", "--installed"]
353 # 2) if apt not found search for rpm (redhat)
354 completed=subprocess.call(cmd_which_rpm,stdout=devnull, stderr=subprocess.STDOUT) # only 3.8! ,capture_output=True)
355 if completed==0 and linux=="RH":
356 cmd_is_package_installed=["rpm", "-q"]
358 # no package manager was found corresponding to dist_name
359 raise src.SatException(manager_msg_err)
360 return cmd_is_package_installed
362 def check_system_pkg(check_cmd,pkg):
363 '''Check if a package is installed
364 :param check_cmd list: the list of command to use system package manager
365 :param user str: the pkg name to check
367 :return: a string with package name with status un message
370 cmd_is_package_installed=[]
371 for cmd in check_cmd:
372 cmd_is_package_installed.append(cmd)
373 cmd_is_package_installed.append(pkg)
374 if check_cmd[0]=="apt":
375 # special treatment for apt
376 # (some debian packages have version numbers in their name, and also
377 # apt do not return status)
378 cmd_is_package_installed[-1]+="*" # we don't specify in pyconf the exact name because of version numbers
379 cmd_is_package_installed.append('|')
380 cmd_is_package_installed.append('grep') # add a grep to get an exit status
381 cmd_is_package_installed.append(cmd)
383 p=subprocess.Popen(cmd_is_package_installed,
384 stdout=subprocess.PIPE,
385 stderr=subprocess.PIPE)
386 output, err = p.communicate()
390 msg_status=src.printcolors.printcSuccess("OK")
391 if check_cmd[0]=="rpm": # apt output is too messy for being used
392 # in python3 output is a byte and should be decoded
393 if isinstance(output, bytes):
394 output = output.decode("utf-8", "ignore")
395 msg_status+=" (" + output.replace('\n',' ') + ")\n" # remove output trailing \n
397 msg_status=src.printcolors.printcError("KO")
398 msg_status+=" (package is not installed!)\n"