Updating agent constructor and adding new-start for pyros.py (launching agentSST)

Alexis Koralewski
1 parent 564bc49b
Showing 9 changed files with 238 additions and 28 deletions Show diff stats
CHANGELOG
privatedev/plugin/agent/AgentSP.py
privatedev/plugin/agent/AgentScheduler.py
privatedev/plugin/agent_devices/AgentM.py
pyros.py
src/core/pyros_django/agent/AgentSST.py
src/core/pyros_django/monitoring/AgentM.py
src/core/pyros_django/obsconfig/obsconfig_class.py
src/core/pyros_django/scientific_program/AgentSP.py
+25-05-2022 (AKo): v0.4.10.0
+	- Updating Agent constructor (removing RUNNIN_IN_THREAD)
+	- Adding new start for pyros.py (launching agentSST)
+	
 18-05-2022 (AKo): v0.4.10.0
 	- Adding mandatory agents in obsconfig
 	- Adding MissingMandatoryAgentException class
@@ -29,12 +29,12 @@ class AgentSP(Agent):
     #     period = next_period
  
     # new init with obsconfig
-    def __init__(self, RUN_IN_THREAD=True,use_db_test=False):
+    def __init__(self,use_db_test=False):
         ##if name is None: name = self.__class__.__name__
         if use_db_test:
             print("USE DB TEST")
             setup_test_environment()
-        super().__init__(RUN_IN_THREAD)
+        super().__init__()
         next_period = Period.objects.next_period()
         period = next_period
  
@@ -228,7 +228,7 @@ if __name__ == &quot;__main__&quot;:
         agentSP.run()
         #agent = build_agent(agentSP, RUN_IN_THREAD=True)
     else:
-        agent = build_agent(AgentSP, RUN_IN_THREAD=RUN_IN_THREAD)
+        agent = build_agent(AgentSP)
     '''
     TEST_MODE, configfile = extract_parameters()
     agent = AgentM("AgentM", configfile, RUN_IN_THREAD)
@@ -68,10 +68,10 @@ class AgentScheduler(Agent):
     #     super().__init__(config_filename, RUN_IN_THREAD)
  
     # new config (obsconfig)
-    def __init__(self, name:str=None, RUN_IN_THREAD=True):
+    def __init__(self, name:str=None):
         if name is None:
             name = self.__class__.__name__
-        super().__init__(RUN_IN_THREAD)
+        super().__init__()
     # @override
     def init(self):
         super().init()
@@ -7,6 +7,7 @@ import sys
  
 #from django.db import transaction
 #from common.models import Command
+
 sys.path.append("..")
 sys.path.append("../../../..")
 from src.core.pyros_django.agent.Agent import Agent, build_agent, log
@@ -75,10 +76,10 @@ class AgentM(Agent):
     #     super().__init__(config_filename, RUN_IN_THREAD)
  
     # new config (obsconfig)
-    def __init__(self, name:str=None, RUN_IN_THREAD=True):
+    def __init__(self, name:str=None):
         if name is None:
             name = self.__class__.__name__
-        super().__init__(RUN_IN_THREAD)
+        super().__init__()
         PYROS_CONFIG_FILE = os.environ.get("pyros_config_file")
         if PYROS_CONFIG_FILE:
             CONFIG_PYROS =  ConfigPyros(PYROS_CONFIG_FILE).pyros_config
@@ -265,7 +266,7 @@ if __name__ == &quot;__main__&quot;:
     # with process
     #RUN_IN_THREAD=False
  
-    agent = build_agent(AgentM, RUN_IN_THREAD=RUN_IN_THREAD)
+    agent = build_agent(AgentM)
     '''
     TEST_MODE, configfile = extract_parameters()
     agent = AgentM("AgentM", configfile, RUN_IN_THREAD)
@@ -997,6 +997,161 @@ def start(agent: str, configfile: str, observatory: str, unit: str, computer_hos
     return True if p.returncode == 0 else False
  
  
+
+@pyros_launcher.command(help="Launch an agent")
+# @global_test_options
+@click.option('--configfile', '-c', help='the configuration file to be used')
+@click.option('--observatory', '-o', help='the observatory name to be used')
+@click.option('--unit', '-u', help='the unit name to be used')
+@click.option("--computer_hostname","-cp", help="The name of simulated computer hostname")
+def new_start(configfile: str, observatory: str, unit: str, computer_hostname: str):
+    log.debug("Running start command")
+    try:
+        from config.pyros.config_pyros import ConfigPyros
+    except:
+        # pip = "pip" if platform.system() == "Windows" else "pip3"
+        # TODO: "python -m pip" au lieu de "pip"
+        pip = "pip" if IS_WINDOWS else "pip3"
+        process = subprocess.Popen(
+            pip + " install --user --upgrade pykwalify", shell=True)
+        process.wait()
+        if process.returncode == 0:
+            # self.addExecuted(self.current_command, command)
+            from config.pyros.config_pyros import configpyros
+        else:
+            log.error(
+                "pykwalify package (required for obsconfig class) installation failed")
+    if configfile:
+        log.debug("With config file" + configfile)
+        os.environ["pyros_config_file"] = os.path.join(os.path.abspath(
+            PYROS_DJANGO_BASE_DIR), "../../../config/pyros/", configfile)
+    else:
+        configfile = 'config_pyros.yml'
+        os.environ["pyros_config_file"] = os.path.join(os.path.abspath(
+            PYROS_DJANGO_BASE_DIR), "../../../config/pyros/", configfile)
+
+    logo_name = ConfigPyros(
+        os.environ["pyros_config_file"]).pyros_config["general"]["logo"]
+    logo_path = os.path.join(os.path.abspath(
+        PYROS_DJANGO_BASE_DIR), "../../../config/pyros/", logo_name)
+    media_path = os.path.join(os.path.abspath(
+        PYROS_DJANGO_BASE_DIR), "misc/static/media", logo_name)
+    shutil.copy(logo_path, media_path)
+    # if test_mode(): print("in test mode")
+    # if verbose_mode(): print("in verbose mode")
+    if observatory == None or len(observatory) == 0:
+        observatory = "default"
+    observatories_configuration_folder = os.path.join(
+        os.path.abspath(PYROS_DJANGO_BASE_DIR), "../../../privatedev/config/")
+    if len(glob.glob(observatories_configuration_folder+observatory+"/")) != 1:
+        # Observatory configuration folder not found
+        print(
+            f"Observatory configuration folder for observatory '{observatory}' not found in {observatories_configuration_folder}")
+        print("Available observatories configuration :")
+        for obs_conf_folder in os.listdir(observatories_configuration_folder):
+            print(obs_conf_folder)
+        exit(1)
+
+    path_to_obs_config_folder = observatories_configuration_folder+observatory+"/"
+    obs_config_file_name = ""
+    # Search for observatory config file
+    obs_config_file_name = glob.glob(
+        path_to_obs_config_folder+"/observatory*.yml")[0]
+
+    obs_config_file_path = os.path.join(
+        path_to_obs_config_folder, obs_config_file_name)
+    os.environ["PATH_TO_OBSCONF_FILE"] = obs_config_file_path
+    os.environ["PATH_TO_OBSCONF_FOLDER"] = path_to_obs_config_folder
+    os.environ["unit_name"] = unit if unit else ''
+    '''
+    if unit:
+        os.environ["unit_name"] = unit
+    else:
+        os.environ["unit_name"] = ""
+    '''
+
+    # add path to pyros_django folder as the config class is supposed to work within this folder
+    # cmd_test_obs_config = f"-c \"from src.core.pyros_django.obsconfig.obsconfig_class import OBSConfig\nOBSConfig('{os.path.join(PYROS_DJANGO_BASE_DIR,os.environ.get('PATH_TO_OBSCONF_FILE'))}')\""
+    cmd_test_obs_config = f"-c \"from src.core.pyros_django.obsconfig.obsconfig_class import OBSConfig\nOBSConfig('{obs_config_file_path}')\""
+    if not execProcessFromVenv(cmd_test_obs_config):
+        # Observatory configuration has an issue
+        exit(1)
+
+    current_processes = []
+    # cmd = "manage.py runserver"
+    # if(WITH_DOCKER):
+    #     # If we're running pyros within docker, we need to specify a specific adress in order to access the website on our host machine
+    #     PYROS_WEBSITE_PORT = os.environ.get("PYROS_WEBSITE_PORT")
+    #     cmd = f"manage.py runserver 0.0.0.0:{PYROS_WEBSITE_PORT}"
+    # os.chdir(PYROS_DJANGO_BASE_DIR)
+    # current_processes.append(
+    #             [execProcessFromVenvAsync(cmd), "webserver", -1])
+    # Start AgentSST (process)
+    agent_name = "agentSST"
+    agent_folder = AGENTS.get(agent_name)
+    current_dir = os.getcwd()
+
+    os.chdir(PYROS_DJANGO_BASE_DIR + os.sep + agent_folder)
+    cmd = f"Agent{agent_name[5:]}.py"
+    if debug_mode():
+        cmd += " -d"
+    if sim_mode():
+        cmd += " -s"
+    if test_mode():
+        cmd += " -t"
+    if verbose_mode():
+        cmd += " -v"
+    if configfile:
+        cmd += " {configfile}"
+    if computer_hostname:
+        cmd += " -c {computer_hostname}"
+
+    # if not test_mode(): current_processes.append( [execProcessFromVenvAsync(cmd), agent_name, -1] )
+    # Append this process ( [process id, agent_name, result=failure] )
+    # ("result" will be updated at the end of execution)
+    current_processes.append(
+        [execProcessFromVenvAsync(cmd), agent_name, -1])
+    # self.change_dir("..")
+    os.chdir(current_dir)
+
+    # Go back to root folder (/)
+    # self.change_dir('..')
+    # os.chdir("..")
+    # Wait for end of each process execution
+    # for (p,agent) in current_processes:
+    for process in current_processes:
+        p, agent, _ = process
+        log.debug(
+            f"************ Waiting for end of execution of agent {agent} ************")
+        p.wait()
+        process[2] = p.returncode
+        print(f"************ END of execution of agent {agent} ************")
+        if p.returncode == 0:
+            printFullTerm(
+                Colors.GREEN, f"Process {agent} executed successfully")
+            # self.addExecuted(self.current_command, command)
+        else:
+            printFullTerm(Colors.WARNING, f"Process {agent} execution failed")
+            # self.addError(self.current_command, command)
+
+    print()
+    print()
+    print("Synthesis of the results:")
+    for process in current_processes:
+        p, agent, returncode = process
+        if returncode == 0:
+            printFullTerm(
+                Colors.GREEN, f"Process {agent} executed successfully")
+            # self.addExecuted(self.current_command, command)
+        else:
+            printFullTerm(Colors.WARNING, f"Process {agent} execution failed")
+            # self.addError(self.current_command, command)
+
+    # print("************ end of START() ************")
+    # Only according to the last process status:
+    # return True if p.returncode==0 else False
+    return True if p.returncode == 0 else False
+
 # TODO: implémenter le STOP !!!
 @pyros_launcher.command(help="Kill an agent")
 @click.argument('agent')
@@ -2,7 +2,7 @@
  
 from pathlib import Path
 import subprocess
-import sys, os
+import sys, os, datetime
 ##import utils.Logger as L
 #import threading #, multiprocessing, os
 import time
@@ -10,9 +10,11 @@ import time
 #from django.db import transaction
 #from common.models import Command
  
-from Agent import Agent, build_agent, log
+from Agent import Agent, build_agent, log, extract_parameters
 import socket
+from common.models import AgentCmd
  
+from src.core.pyros_django.obsconfig.obsconfig_class import OBSConfig
  
 class AgentSST(Agent):
     computer = "MainComputer"
@@ -21,10 +23,14 @@ class AgentSST(Agent):
     VENV_PYTHON = ""
     subprocess_dict = {}
  
+    AGENT_SPECIFIC_COMMANDS = [
+        "KILL_AGENT",
+        "RESTART_AGENT"
+    ]
  
-    def __init__(self, name:str=None, RUN_IN_THREAD=True,sim_computer=None):
+    def __init__(self, name:str=None,sim_computer=None):
  
-        super().__init__(RUN_IN_THREAD)
+        super().__init__()
         self.PROJECT_ROOT_PATH = os.environ["PROJECT_ROOT_PATH"]
         if name is None:
             name = self.__class__.__name__
@@ -49,7 +55,7 @@ class AgentSST(Agent):
                 + os.sep + "bin"
                 + os.sep
             )
-        VENV_PYTHON = VENV_BIN + "python3"
+        self.VENV_PYTHON = VENV_BIN + "python3"
         log.info(f"PC hostname is {self.computer}")
         self.start_agents()
  
@@ -77,7 +83,7 @@ class AgentSST(Agent):
  
                 protocol_script_name = protocol.split("/")[-1]
                 if os.path.exists(protocol_folder_abs_path + os.sep + protocol_script_name):
-                    cmd = self.VENV_PYTHON + protocol_folder_abs_path + os.sep + protocol_script_name
+                    cmd = self.VENV_PYTHON +" "+ protocol_folder_abs_path + os.sep + protocol_script_name
  
                     process = subprocess.Popen(f"{cmd}", shell=True, stdout=subprocess.DEVNULL,stderr=subprocess.STDOUT)
                     self.subprocess_dict[agent] = process
@@ -93,7 +99,7 @@ class AgentSST(Agent):
  
                     protocol_script_name = protocol.split("/")[-1]
                     if os.path.exists(protocol_folder_abs_path + os.sep + protocol_script_name):
-                        cmd = self.VENV_PYTHON + protocol_folder_abs_path + os.sep + protocol_script_name
+                        cmd = self.VENV_PYTHON +" "+ protocol_folder_abs_path + os.sep + protocol_script_name
  
                         process = subprocess.Popen(f"{cmd}", shell=True, stdout=subprocess.DEVNULL,stderr=subprocess.STDOUT)
                         self.subprocess_dict[agent] = process
@@ -108,13 +114,56 @@ class AgentSST(Agent):
         """
         self.start_agents(agent_name)
  
-    def routine_process_body(self):
-        for process in self.subprocess_dict.values():
+
+    def cmd_kill_agent(self, cmd:AgentCmd, agent:str)->None:
+        if agent in self.subprocess_dict.keys():
+            self.send_cmd_to(agent,"do_exit")
+
+    def cmd_restart_agent(self, cmd:AgentCmd ,agent:str)->None:
+        self.start_agent(agent)
+        if agent in self.subprocess_dict.keys():
+            cmd.set_result(f"Agent {agent} restarted")
+            cmd.set_as_processed()
+        else:
+            cmd.set_result(f"Agent {agent} failed to restart")
+            log.debug(f"Agent {agent} failed to restart")
+
+    def force_kill_agent(self, cmd:AgentCmd, agent:str)->None:
+        if agent in self.subprocess_dict.get(agent) is not None:
+            process = self.subprocess_dict.get(agent)
             process.terminate()
-            process.wait()
-        exit(0)
-        # needs to receive new commands to stop or start new agents
-        #start_agents(self)
+            if process.poll() is not None:
+                cmd.set_as_processed()
+        else:
+            return None
+            
+    def routine_process_before_body(self):
+        try:
+            now_time = datetime.datetime.utcnow()
+            last_running_commands = AgentCmd.get_commands_sent_by_agent("AgentSST").filter(state="CMD_RUNNING")
+
+            for cmd in last_running_commands:
+                last_running_cmd, agent = cmd.full_name.split(" ")[:1]
+                if last_running_cmd == "KILL_AGENT" and cmd.is_expired():
+                    self.force_killed_agent(agent)
+            next_cmd = self._get_next_valid_and_not_running_command()
+            if next_cmd is not None:
+                cmd, agent = next_cmd.full_name.split(" ")[:1]
+                if cmd == "KILL_AGENT":
+                    self.cmd_kill_agent(next_cmd,agent)
+                elif cmd == "RESTART_AGENT":
+                    self.cmd_restart_agent(next_cmd,agent)
+            log.info("Check status of process")
+            for agent in self.subprocess_dict:
+                proc = self.subprocess_dict.get(agent)
+            log.info(f"{agent} poll result is {proc.poll()}")
+        except KeyboardInterrupt:
+
+            for process in self.subprocess_dict.values():
+                print(process)
+                process.kill()
+            exit(0)
+
  
 if __name__ == "__main__":
  
@@ -76,10 +76,10 @@ class AgentM(Agent):
     #     super().__init__(config_filename, RUN_IN_THREAD)
  
     # new config (obsconfig)
-    def __init__(self, name:str=None, RUN_IN_THREAD=True):
+    def __init__(self, name:str=None):
         if name is None:
             name = self.__class__.__name__
-        super().__init__(RUN_IN_THREAD)
+        super().__init__()
         PYROS_CONFIG_FILE = os.environ.get("pyros_config_file")
         if PYROS_CONFIG_FILE:
             CONFIG_PYROS =  ConfigPyros(PYROS_CONFIG_FILE).pyros_config
@@ -266,7 +266,7 @@ if __name__ == &quot;__main__&quot;:
     # with process
     #RUN_IN_THREAD=False
  
-    agent = build_agent(AgentM, RUN_IN_THREAD=RUN_IN_THREAD)
+    agent = build_agent(AgentM)
     '''
     TEST_MODE, configfile = extract_parameters()
     agent = AgentM("AgentM", configfile, RUN_IN_THREAD)
@@ -28,7 +28,8 @@ class OBSConfig:
     MANDATORY_AGENTS = {
         "AgentSP":None,
         "AgentScheduler":None,
-        "AgentMajordome":None
+        "AgentMajordome":None,
+        "AgentM":None
  
     }
  
@@ -29,12 +29,12 @@ class AgentSP(Agent):
     #     period = next_period
  
     # new init with obsconfig
-    def __init__(self, RUN_IN_THREAD=True,use_db_test=False):
+    def __init__(self,use_db_test=False):
         ##if name is None: name = self.__class__.__name__
         if use_db_test:
             print("USE DB TEST")
             setup_test_environment()
-        super().__init__(RUN_IN_THREAD)
+        super().__init__()
         next_period = Period.objects.next_period()
         period = next_period
  
@@ -228,7 +228,7 @@ if __name__ == &quot;__main__&quot;:
         agentSP.run()
         #agent = build_agent(agentSP, RUN_IN_THREAD=True)
     else:
-        agent = build_agent(AgentSP, RUN_IN_THREAD=RUN_IN_THREAD)
+        agent = build_agent(AgentSP)
     '''
     TEST_MODE, configfile = extract_parameters()
     agent = AgentM("AgentM", configfile, RUN_IN_THREAD)