pyros.py script improvements

- config relative ou absolue - all private methods with "_" prefix - die on any error - added commands : - pyros update (= git pull + update db) - pyros initdb - cleanup - bugfix start_agent.py

pyros.py script improvements
- config relative ou absolue - all private methods with "_" prefix - die on any error - added commands : - pyros update (= git pull + update db) - pyros initdb - cleanup - bugfix start_agent.py
Etienne Pallier
1 parent 01348735
Showing 6 changed files with 124 additions and 63 deletions Show diff stats
README.md
install/install.py
pyros.py
src/agent/Agent.py
src/pyros/settings.py
start_agent.py
@@ -67,14 +67,23 @@ This software has been tested and validated with the following configurations :
 --------------------------------------------------------------------------------------------
 ## LAST VERSION
  
-Date: 05/02/2019
+Date: 27/02/2019
  
 Author: E. Pallier
  
-VERSION: 20190205.0.000.0 (0.20)
-
-Comment:
-	Update README and REDMINE
+VERSION: 20190227.0.000.0 (0.20)
+
+Comment: 
+	pyros.py script improvements
+	- config relative ou absolue
+	- all private methods with "_" prefix
+	- die on any error
+	- added commands : 
+		- pyros update (= git pull + update db)
+		- pyros initdb
+	- cleanup
+	- bugfix start_agent.py
+	
  
 --------------------------------------------------------------------------------------------
 - TECHNICAL DOC: tinyurl.com/pyros-doc
@@ -95,6 +104,8 @@ Comment:
  
 Full list of commits: https://gitlab.irap.omp.eu/epallier/pyros/commits/master
  
+The list below is obsolete. The new official changes history is here :  https://tinyurl.com/pyros-dev#heading=h.2r55bflctpt5
+
 **17/01/19 : Version 20190117.0.000.0 (EP)**
 - NO MORE CELERY (removed from everywhere)
  
@@ -332,14 +332,14 @@ def install_database(venv):
     #TODO: from venv !!!
     try:
         #os.system(GLOBAL_PYTHON+" pyros.py init_database")
-        os.system(GLOBAL_PYTHON+" pyros.py initdatabase")
+        os.system(GLOBAL_PYTHON+" pyros.py initdb")
         '''
         process = subprocess.Popen(GLOBAL_PYTHON + " pyros.py init_database"  , shell=True)
         process.wait()
         '''
     except Exception as e:
         print("Exception ", e)
-        print(Colors.ERROR + "Error while initialising database :" + Colors.END)
+        print(Colors.ERROR + "Error while initializing database :" + Colors.END)
         return -1
  
     print(Colors.LOG_BLUE + "\r\n\r\n-----------------------------Install successfull !-----------------------------" + Colors.END)
@@ -123,10 +123,11 @@ def execProcess(command, from_venv=False, is_async=False):
     else:
         printFullTerm(Colors.WARNING, "Process execution failed")
         # self.addError(self.current_command, command)
-    return process.returncode
+    #return process.returncode
+    return True if process.returncode==0 else False
  
 def execProcessFromVenv(command:str):
-    execProcess(command, from_venv=True)
+    return execProcess(command, from_venv=True)
  
 #TODO: fusionner dans execProcess avec param is_async
 def execProcessFromVenvAsync(command:str):
@@ -169,6 +170,13 @@ def printFullTerm(color: Colors, string: str):
     return 0
  
  
+def die():
+    print()
+    print("...ERROR...")
+    print()
+    exit(1)
+
+
  
 """
 ********************************************************************************
@@ -244,63 +252,48 @@ def install():
     # return 0
     return True
  
+
+
+    
 '''
 TODO:
 '''
 @pyros_launcher.command(help="Update the pyros software (git pull + update DB if necessary)")
 def update():
     print("Running update command")
-    print("git pull")
-    print("update db (make migrations + migrate)")
+    #res = _gitpull()
+    _gitpull() or die()
+    #if not res: return False
+    _updatedb() or die()
     return True
  
-@pyros_launcher.command(help="Init the database with initial fixture data")
-def initdatabase():
-    makemigrations()
-    migrate()
-    loaddata()
-    return 0
-
-def migrate():
-    changeDirectory("src")
-    execProcessFromVenv("manage.py migrate")
-    changeDirectory("..")
-    return 0
-
-def makemigrations():
-    changeDirectory("src")
-    #execProcessFromVenv(self.venv_bin + " manage.py makemigrations")
-    execProcessFromVenv("manage.py makemigrations")
-    changeDirectory("..")
-    return 0
-
-#TODO: mettre la fixture en date naive (sans time zone)
-def loaddata():
-    changeDirectory("src")
-    #execProcessFromVenv(self.venv_bin + " manage.py loaddata misc" + os.sep + "fixtures" + os.sep + self.init_fixture)
-    execProcessFromVenv("manage.py loaddata misc" + os.sep + "fixtures" + os.sep + init_fixture)
-    changeDirectory("..")
-    return 0
  
-def changeDirectory(path):
-    if DEBUG: print("Moving to : " + path)
-    os.chdir(path)
-    if DEBUG: print("Current directory : " + str(os.getcwd()))
-    return 0
+def _gitpull():
+    print("-- running git pull")
+    GIT = "git.exe" if IS_WINDOWS else "git"
+    if not test_mode(): return execProcess(f"{GIT} pull")
+    return True
  
+#@pyros_launcher.command(help="Update the pyros database")
+def _updatedb():
+    print("-- update db (make migrations + migrate)")
+    if not test_mode() :
+        _makemigrations() or die()
+        _migrate() or die()
+    return True
  
  
-def check_agent(agent):
-    # Check that agent exists
-    if agent not in AGENTS.keys() and agent != "all": 
-        print("This agent does not exist")
-        print("Here is the allowed list of agents:")
-        print("- all => will launch ALL agents")
-        for agent_name in AGENTS.keys(): print('-',agent_name)
-        return False
+@pyros_launcher.command(help="Update the pyros database and fill it with initial fixture data")
+def initdb():
+    if not test_mode():
+        #updatedb()
+        _makemigrations()
+        _migrate()
+        _loaddata()
     return True
  
  
+
 @pyros_launcher.command(help="Launch an agent")
 #@global_test_options
 @click.argument('agent')
@@ -316,7 +309,7 @@ def start(agent:str, configfile:str):
         configfile = '' 
     #if test_mode(): print("in test mode")
     #if verbose_mode(): print("in verbose mode")
-    if not check_agent(agent): return
+    if not _check_agent(agent): return
     # VENV_BIN = 'private/venv_py3_pyros' +  os.sep + self.bin_dir + os.sep + self.bin_name
  
  
@@ -347,13 +340,13 @@ def start(agent:str, configfile:str):
                 os.chdir("src")
             #if not test_mode(): execProcessFromVenv("start_agent.py " + agent_name + " " + configfile)
             if not test_mode(): execProcessFromVenv(cmd)
-            # self.changeDirectory("..")
+            # self._change_dir("..")
  
             '''
             # Any other agent
             else:
                 # Go into src/
-                # self.changeDirectory("src")
+                # self._change_dir("src")
                 os.chdir("src")
                 # print("Current directory : " + str(os.getcwd()))
                 if agent_name != "webserver": os.chdir(agent_folder)
@@ -369,12 +362,12 @@ def start(agent:str, configfile:str):
                 if agent_name == "webserver": cmd = "manage.py runserver"
                 if not test_mode(): execProcessFromVenv(cmd)
                 # Go back to src/
-                # self.changeDirectory('..')
+                # self._change_dir('..')
                 os.chdir("..")
             '''
  
     # Go back to root folder (/)
-    # self.changeDirectory('..')
+    # self._change_dir('..')
     os.chdir("..")
     return True
  
@@ -385,10 +378,62 @@ def start(agent:str, configfile:str):
 @click.argument('agent')
 def stop(agent):
     print("Running stop command")
-    if not check_agent(agent): return
+    if not _check_agent(agent): return
  
  
  
+"""
+********************************************************************************
+******************** PRIVATE FUNCTIONS DEFINITION ******************************
+********************************************************************************
+"""
+
+def _migrate():
+    _change_dir("src")
+    res = execProcessFromVenv("manage.py migrate")
+    _change_dir("..")
+    return res
+
+def _makemigrations():
+    _change_dir("src")
+    #execProcessFromVenv(self.venv_bin + " manage.py makemigrations")
+    res = execProcessFromVenv("manage.py makemigrations")
+    print("res is", res)
+    _change_dir("..")
+    return res
+
+#TODO: mettre la fixture en date naive (sans time zone)
+def _loaddata():
+    _change_dir("src")
+    #execProcessFromVenv(self.venv_bin + " manage.py loaddata misc" + os.sep + "fixtures" + os.sep + self.init_fixture)
+    res = execProcessFromVenv("manage.py loaddata misc" + os.sep + "fixtures" + os.sep + init_fixture)
+    _change_dir("..")
+    return res
+
+def _change_dir(path):
+    if DEBUG: print("Moving to : " + path)
+    os.chdir(path)
+    if DEBUG: print("Current directory : " + str(os.getcwd()))
+
+
+
+def _check_agent(agent):
+    # Check that agent exists
+    if agent not in AGENTS.keys() and agent != "all": 
+        print("This agent does not exist")
+        print("Here is the allowed list of agents:")
+        print("- all => will launch ALL agents")
+        for agent_name in AGENTS.keys(): print('-',agent_name)
+        return False
+    return True
+
+
+
+"""
+********************************************************************************
+********************************* main() FUNCTION ******************************
+********************************************************************************
+"""
 def main():
     pyros_launcher()
  
@@ -105,15 +105,18 @@ class Agent:
         if not config_filename:
             #config_filename = '/PROJECTS/GFT/SOFT/PYROS_SOFT/CURRENT/config/config_unit_simulunit1.xml'
             config_filename = self.DEFAULT_CONFIG_FILE_NAME
-        config_abs_filename = os.path.abspath(self.CONFIG_DIR + os.sep + config_filename)
+        #config_file_path, _ = os.path.split(config_filename)
+        if config_filename == os.path.basename(config_filename):
+            config_filename = os.path.abspath(self.CONFIG_DIR + os.sep + config_filename)
+        print("Config file used is", config_filename)
         #print("current path", os.getcwd())
         #print("this file path :", __file__)
         #print("config file path is", config_filename)
         # Instantiate an object for configuration
         #print("config file path is ", config_abs_filename)
-        self.config = ConfigPyros(config_abs_filename)
+        self.config = ConfigPyros(config_filename)
         if self.config.get_last_errno() != self.config.NO_ERROR:
-            raise Exception(f"Bad config file name '{config_abs_filename}', error {str(self.config.get_last_errno())}: {str(self.config.get_last_errmsg())}")
+            raise Exception(f"Bad config file name '{config_filename}', error {str(self.config.get_last_errno())}: {str(self.config.get_last_errmsg())}")
         tmp = AgentsSurvey.objects.filter(name=self.name)
         if len(tmp) == 0:
             self._agents_survey = AgentsSurvey(name=self.name, mode=self.mode, status=self.status)
@@ -73,7 +73,7 @@ INSTALLED_APPS = [
     'django.contrib.sessions',
     'django.contrib.messages',
  
-    # For debug_toolbar
+    # (EP) For debug_toolbar
     'django.contrib.staticfiles',
     'debug_toolbar',
  
@@ -82,6 +82,8 @@ INSTALLED_APPS = [
     'django_extensions',
     'test_without_migrations',
     'bootstrap3',
+
+    # PYROS APPS
     'dashboard',
     'scheduler',
     'common',
@@ -25,8 +25,8 @@ agent_name = sys.argv[1]
  
 # arg 2 : config file
 if len(sys.argv) == 3:
-    configfile = sys.argv[1]
-
+    configfile = sys.argv[2]
+    
 # Conseil sur le net:
 #https://stackoverflow.com/questions/16853649/how-to-execute-a-python-script-from-the-django-shell
 """