like open a browser or an editor, or call a git command
'''
-import subprocess
import os
+import subprocess as SP
+import time
import tarfile
+import time
+
+
+import debug as DBG
+import utilsSat as UTS
+import src
from . import printcolors
# launch cmd using subprocess.Popen
cmd = editor % filePath
logger.write('Launched command:\n' + cmd + '\n', 5)
- p = subprocess.Popen(cmd, shell=True)
+ p = SP.Popen(cmd, shell=True)
p.communicate()
except:
logger.write(printcolors.printcError(_("Unable to edit file %s\n")
% filePath), 1)
-##
-# Extracts sources from a git repository.
-def git_extract(from_what, tag, where, logger):
- if not where.exists():
- where.make()
- if tag == "master" or tag == "HEAD":
- command = "git clone %(remote)s %(where)s" % \
- { 'remote': from_what, 'tag': tag, 'where': str(where) }
+def show_in_webbrowser(editor, filePath, logger):
+ '''open filePath using web browser firefox, chromium etc...
+ if file is xml, previous http sever is done before to fix new security problems
+
+ :param editor str: The web browser to use.
+ :param filePath str: The path to the file to open.
+ '''
+ import psutil
+ # default editor is firefox
+ if editor is None or len(editor) == 0:
+ editor = 'firefox'
+
+ path, namefile = os.path.split(filePath)
+ basefile, ext = os.path.splitext(namefile)
+
+ # previouly http.server 8765/6/7... kill ... or not ? TODO wait and see REX
+ port = os.getenv('SAT_PORT_LOG', '8765')
+ for proc in psutil.process_iter():
+ # help(proc)
+ cmdline = " ".join(proc.cmdline())
+ if "python3 -m http.server %s" % port in cmdline:
+ print("kill previous process '%s'" % cmdline)
+ proc.kill() # TODO may be not owner ? -> change 8766/7/8... as SAT_PORT_LOG
+
+ cmd = """
+set -x
+cd %(path)s
+python3 -m http.server %(port)s &> /dev/null &
+%(editor)s http://localhost:%(port)s/%(namefile)s
+""" % {"path": path, "editor": editor, "namefile": namefile, 'port': port}
+
+ # print("show_in_webbrowser:\n%s" % cmd)
+
+ try:
+ # launch cmd using subprocess.Popen
+ logger.write('Launched command:\n%s\n' % cmd, 5)
+ p = SP.Popen(cmd, shell=True, stdout=SP.PIPE, stderr=SP.STDOUT)
+ res_out, _ = p.communicate() # _ = None as stderr=SP.STDOUT
+ # print("Launched command stdout:\n%s" % res_out)
+ except Exception as e:
+ logger.write(printcolors.printcError(_("Unable to display file %s\n%s\n")
+ % (filePath, e)), 1)
+
+
+def git_describe(repo_path):
+ '''Use git describe --tags command to return tag description of the git repository"
+ :param repo_path str: The git repository to describe
+ '''
+ git_cmd="cd %s;git describe --tags" % repo_path
+ p = SP.Popen(git_cmd, shell=True, stdin=SP.PIPE, stdout=SP.PIPE, stderr=SP.PIPE)
+ p.wait()
+ if p.returncode != 0:
+ return False
else:
- # NOTICE: this command only works with recent version of git
- # because --work-tree does not work with an absolute path
- where_git = os.path.join( str(where), ".git" )
- command = "rmdir %(where)s && git clone %(remote)s %(where)s && " + \
- "git --git-dir=%(where_git)s --work-tree=%(where)s checkout %(tag)s"
- command = command % { 'remote': from_what, 'tag': tag, 'where': str(where), 'where_git': where_git }
+ tag_description=p.stdout.readlines()[0].strip()
+ # with python3 this utf8 bytes should be decoded
+ if isinstance(tag_description, bytes):
+ tag_description=tag_description.decode("utf-8", "ignore")
+ return tag_description
- logger.write(command + "\n", 5)
- res = subprocess.call(command, cwd=str(where.dir()), shell=True,
- stdout=logger.logTxtFile, stderr=subprocess.STDOUT)
- return (res == 0)
+def git_extract(from_what, tag, git_options, where, logger, environment=None):
+ '''Extracts sources from a git repository.
+87
+ :param from_what str: The remote git repository.
+ :param tag str: The tag.
+ :param git_options str: git options
+ :param where str: The path where to extract.
+ :param logger Logger: The logger instance to use.
+ :param environment src.environment.Environ: The environment to source when extracting.
+ :return: True if the extraction is successful
+ :rtype: boolean
+ '''
+ DBG.write("git_extract", [from_what, tag, str(where)])
+ if not where.exists():
+ where.make()
+ where_git = os.path.join(str(where), ".git")
+ if tag == "master" or tag == "HEAD":
+ if src.architecture.is_windows():
+ cmd = "git clone %(git_options)s %(remote)s %(where)s"
+ else:
+ cmd = r"""
+set -x
+git clone %(git_options)s %(remote)s %(where)s
+res=$?
+if [ $res -eq 0 ]; then
+ touch -d "$(git --git-dir=%(where_git)s log -1 --format=date_format)" %(where)s
+fi
+exit $res
+"""
+ cmd = cmd % {'git_options': git_options, 'remote': from_what, 'tag': tag, 'where': str(where), 'where_git': where_git}
+ else:
+ # NOTICE: this command only works with recent version of git
+ # because --work-tree does not work with an absolute path
+ if src.architecture.is_windows():
+ cmd = "rm -rf %(where)s && git clone %(git_options)s %(remote)s %(where)s && git --git-dir=%(where_git)s --work-tree=%(where)s checkout %(tag)s"
+ else:
+# for sat compile --update : changes the date of directory, only for branches, not tag
+ cmd = r"""
+set -x
+rm -rf %(where)s
+git clone %(git_options)s %(remote)s %(where)s && \
+git --git-dir=%(where_git)s --work-tree=%(where)s checkout %(tag)s
+res=$?
+git --git-dir=%(where_git)s status | grep HEAD
+if [ $res -eq 0 -a $? -ne 0 ]; then
+ touch -d "$(git --git-dir=%(where_git)s log -1 --format=date_format)" %(where)s
+fi
+exit $res
+"""
+ cmd = cmd % {'git_options': git_options,
+ 'remote': from_what,
+ 'tag': tag,
+ 'where': str(where),
+ 'where_git': where_git}
+
+
+ cmd=cmd.replace('date_format', '"%ai"')
+ logger.logTxtFile.write("\n" + cmd + "\n")
+ logger.logTxtFile.flush()
+
+ DBG.write("cmd", cmd)
+ # git commands may fail sometimes for various raisons
+ # (big module, network troubles, tuleap maintenance)
+ # therefore we give several tries
+ i_try = 0
+ max_number_of_tries = 3
+ sleep_delay = 30 # seconds
+ while (True):
+ i_try += 1
+ rc = UTS.Popen(cmd, cwd=str(where.dir()), env=environment.environ.environ, logger=logger)
+ if rc.isOk() or (i_try>=max_number_of_tries):
+ break
+ logger.write('\ngit command failed! Wait %d seconds and give an other try (%d/%d)\n' % \
+ (sleep_delay, i_try + 1, max_number_of_tries), 3)
+ time.sleep(sleep_delay) # wait a little
+
+ return rc.isOk()
+
+
+def git_extract_sub_dir(from_what, tag, git_options, where, sub_dir, logger, environment=None):
+ '''Extracts sources from a subtree sub_dir of a git repository.
+
+ :param from_what str: The remote git repository.
+ :param tag str: The tag.
+ :param git_options str: git options
+ :param where str: The path where to extract.
+ :param sub_dir str: The relative path of subtree to extract.
+ :param logger Logger: The logger instance to use.
+ :param environment src.environment.Environ: The environment to source when extracting.
+ :return: True if the extraction is successful
+ :rtype: boolean
+ '''
+ strWhere = str(where)
+ tmpWhere = strWhere + '_tmp'
+ parentWhere = os.path.dirname(strWhere)
+ if not os.path.exists(parentWhere):
+ logger.error("not existing directory: %s" % parentWhere)
+ return False
+ if os.path.isdir(strWhere):
+ logger.error("do not override existing directory: %s" % strWhere)
+ return False
+ aDict = {'git_options': git_options,
+ 'remote': from_what,
+ 'tag': tag,
+ 'sub_dir': sub_dir,
+ 'where': strWhere,
+ 'parentWhere': parentWhere,
+ 'tmpWhere': tmpWhere,
+ }
+ DBG.write("git_extract_sub_dir", aDict)
+ if not src.architecture.is_windows():
+ cmd = r"""
+set -x
+export tmpDir=%(tmpWhere)s && \
+rm -rf $tmpDir
+git clone %(git_options)s %(remote)s $tmpDir && \
+cd $tmpDir && \
+git checkout %(tag)s && \
+mv %(sub_dir)s %(where)s && \
+git log -1 > %(where)s/README_git_log.txt && \
+rm -rf $tmpDir
+""" % aDict
+ else:
+ cmd = r"""
+
+set tmpDir=%(tmpWhere)s && \
+rm -rf $tmpDir
+git clone %(git_options)s %(remote)s $tmpDir && \
+cd $tmpDir && \
+git checkout %(tag)s && \
+mv %(sub_dir)s %(where)s && \
+git log -1 > %(where)s/README_git_log.txt && \
+rm -rf $tmpDir
+""" % aDict
+
+ DBG.write("cmd", cmd)
+
+ for nbtry in range(0,3): # retries case of network problem
+ rc = UTS.Popen(cmd, cwd=parentWhere, env=environment.environ.environ, logger=logger)
+ if rc.isOk(): break
+ time.sleep(30) # wait a little
+
+ return rc.isOk()
def archive_extract(from_what, where, logger):
+ '''Extracts sources from an archive.
+
+ :param from_what str: The path to the archive.
+ :param where str: The path where to extract.
+ :param logger Logger: The logger instance to use.
+ :return: True if the extraction is successful
+ :rtype: boolean
+ '''
try:
archive = tarfile.open(from_what)
for i in archive.getmembers():
logger.write("archive_extract: %s\n" % exc)
return False, None
-def cvs_extract(protocol, user, server, base, tag, module, where,
- logger, checkout=False):
+def cvs_extract(protocol, user, server, base, tag, product, where,
+ logger, checkout=False, environment=None):
+ '''Extracts sources from a cvs repository.
+
+ :param protocol str: The cvs protocol.
+ :param user str: The user to be used.
+ :param server str: The remote cvs server.
+ :param base str: .
+ :param tag str: The tag.
+ :param product str: The product.
+ :param where str: The path where to extract.
+ :param logger Logger: The logger instance to use.
+ :param checkout boolean: If true use checkout cvs.
+ :param environment src.environment.Environ: The environment to source when
+ extracting.
+ :return: True if the extraction is successful
+ :rtype: boolean
+ '''
opttag = ''
if tag is not None and len(tag) > 0:
if len(protocol) > 0:
root = "%s@%s:%s" % (user, server, base)
- command = "cvs -d :%(protocol)s:%(root)s %(command)s -d %(where)s %(tag)s %(module)s" % \
+ command = "cvs -d :%(protocol)s:%(root)s %(command)s -d %(where)s %(tag)s %(product)s" % \
{ 'protocol': protocol, 'root': root, 'where': str(where.base()),
- 'tag': opttag, 'module': module, 'command': cmd }
+ 'tag': opttag, 'product': product, 'command': cmd }
else:
- command = "cvs -d %(root)s %(command)s -d %(where)s %(tag)s %(base)s/%(module)s" % \
+ command = "cvs -d %(root)s %(command)s -d %(where)s %(tag)s %(base)s/%(product)s" % \
{ 'root': server, 'base': base, 'where': str(where.base()),
- 'tag': opttag, 'module': module, 'command': cmd }
+ 'tag': opttag, 'product': product, 'command': cmd }
- logger.logTxtFile.write(command + "\n")
logger.write(command + "\n", 5)
if not where.dir().exists():
where.dir().make()
-
- res = subprocess.call(command, cwd=str(where.dir()), shell=True,
- stdout=logger.logTxtFile, stderr=subprocess.STDOUT)
+
+ logger.logTxtFile.write("\n" + command + "\n")
+ logger.logTxtFile.flush()
+ res = SP.call(command, cwd=str(where.dir()),
+ env=environment.environ.environ,
+ shell=True,
+ stdout=logger.logTxtFile,
+ stderr=SP.STDOUT)
return (res == 0)
-def svn_extract(user, from_what, tag, where, logger, checkout=False):
+def svn_extract(user,
+ from_what,
+ tag,
+ where,
+ logger,
+ checkout=False,
+ environment=None):
+ '''Extracts sources from a svn repository.
+
+ :param user str: The user to be used.
+ :param from_what str: The remote git repository.
+ :param tag str: The tag.
+ :param where str: The path where to extract.
+ :param logger Logger: The logger instance to use.
+ :param checkout boolean: If true use checkout svn.
+ :param environment src.environment.Environ: The environment to source when
+ extracting.
+ :return: True if the extraction is successful
+ :rtype: boolean
+ '''
if not where.exists():
where.make()
logger.logTxtFile.write(command + "\n")
logger.write(command + "\n", 5)
- res = subprocess.call(command, cwd=str(where.dir()), shell=True,
- stdout=logger.logTxtFile, stderr=subprocess.STDOUT)
- return (res == 0)
\ No newline at end of file
+ logger.logTxtFile.write("\n" + command + "\n")
+ logger.logTxtFile.flush()
+ res = SP.call(command, cwd=str(where.dir()),
+ env=environment.environ.environ,
+ shell=True,
+ stdout=logger.logTxtFile,
+ stderr=SP.STDOUT)
+ return (res == 0)
+
+def get_pkg_check_cmd(dist_name):
+ '''Build the command to use for checking if a linux package is installed or not.'''
+
+ if dist_name in ["CO","FD","MG","MD","CO","OS"]: # linux using rpm
+ linux="RH"
+ manager_msg_err="Error : command failed because sat was not able to find apt command"
+ else:
+ linux="DB"
+ manager_msg_err="Error : command failed because sat was not able to find rpm command"
+
+ # 1- search for an installed package manager (rpm on rh, apt on db)
+ cmd_which_rpm=["which", "rpm"]
+ cmd_which_apt=["which", "apt"]
+ with open(os.devnull, 'w') as devnull:
+ # 1) we search for apt (debian based systems)
+ completed=SP.call(cmd_which_apt,stdout=devnull, stderr=SP.STDOUT)
+ if completed==0 and linux=="DB":
+ cmd_is_package_installed=["apt", "list", "--installed"]
+ else:
+ # 2) if apt not found search for rpm (redhat)
+ completed=SP.call(cmd_which_rpm,stdout=devnull, stderr=SP.STDOUT) # only 3.8! ,capture_output=True)
+ if completed==0 and linux=="RH":
+ cmd_is_package_installed=["rpm", "-q"]
+ else:
+ # no package manager was found corresponding to dist_name
+ raise src.SatException(manager_msg_err)
+ return cmd_is_package_installed
+
+def check_system_pkg(check_cmd,pkg):
+ '''Check if a package is installed
+ :param check_cmd list: the list of command to use system package manager
+ :param user str: the pkg name to check
+ :rtype: str
+ :return: a string with package name with status un message
+ '''
+ # build command
+ FNULL = open(os.devnull, 'w')
+ cmd_is_package_installed=[]
+ for cmd in check_cmd:
+ cmd_is_package_installed.append(cmd)
+ cmd_is_package_installed.append(pkg)
+
+
+ if check_cmd[0]=="apt":
+ # special treatment for apt
+ # apt output is too messy for being used
+ # some debian packages have version numbers in their name, we need to add a *
+ # also apt do not return status, we need to use grep
+ # and apt output is too messy for being used
+ cmd_is_package_installed[-1]+="*" # we don't specify in pyconf the exact name because of version numbers
+ p=SP.Popen(cmd_is_package_installed, stdout=SP.PIPE, stderr=FNULL)
+ try:
+ output = SP.check_output(['grep', pkg], stdin=p.stdout)
+ msg_status=src.printcolors.printcSuccess("OK")
+ except:
+ msg_status=src.printcolors.printcError("KO")
+ msg_status+=" (package is not installed!)\n"
+ else:
+ p=SP.Popen(cmd_is_package_installed, stdout=SP.PIPE, stderr=FNULL)
+ output, err = p.communicate()
+ rc = p.returncode
+ if rc==0:
+ msg_status=src.printcolors.printcSuccess("OK")
+ # in python3 output is a byte and should be decoded
+ if isinstance(output, bytes):
+ output = output.decode("utf-8", "ignore")
+ msg_status+=" (" + output.replace('\n',' ') + ")\n" # remove output trailing \n
+ else:
+ msg_status=src.printcolors.printcError("KO")
+ msg_status+=" (package is not installed!)\n"
+
+ return msg_status
