Blame view

src/core/pyros_django/agent/AgentBasic.py 14.2 KB
b29985c6   Etienne Pallier   Implementation pr...
1
2
3
#!/usr/bin/env python3


b7c6e890   Etienne Pallier   Test de tous les ...
4
import time
b29985c6   Etienne Pallier   Implementation pr...
5
6
7
8
import sys
##import utils.Logger as L

##from .Agent import Agent
6fbe2e20   Etienne Pallier   last minute.com m...
9
10
11
##sys.path.append("..")
###from agent.Agent import Agent, build_agent
sys.path.append("../../../..")
d02249e6   Etienne Pallier   Added CMD_EXEC_ER...
12
from src.core.pyros_django.agent.Agent import Agent, CmdExceptionExecError, build_agent
b29985c6   Etienne Pallier   Implementation pr...
13

f526191c   Etienne Pallier   Command (non runn...
14
15
from typing import List, Tuple, Union, Any

b29985c6   Etienne Pallier   Implementation pr...
16
17
18
19
20
21
22
23
24
25
26
27
##log = L.setupLogger("AgentXTaskLogger", "AgentX")



class AgentBasic(Agent):

    # FOR TEST ONLY
    # Run this agent in simulator mode
    TEST_MODE = False
    # Run the assertion tests at the end
    TEST_WITH_FINAL_TEST = False
    #TEST_MAX_DURATION_SEC = None
0cc81973   Etienne Pallier   added sleep after...
28
    TEST_MAX_DURATION_SEC = 300
b29985c6   Etienne Pallier   Implementation pr...
29
30
31
32
33
    # Who should I send commands to ?
    TEST_COMMANDS_DEST = "myself"
    #TEST_COMMANDS_DEST = "AgentB"
    # Scenario to be executed

0bcd6dd5   Etienne Pallier   renamed Agent met...
34
    
f526191c   Etienne Pallier   Command (non runn...
35
    # @override
0bcd6dd5   Etienne Pallier   renamed Agent met...
36
    _AGENT_SPECIFIC_COMMANDS = [
f526191c   Etienne Pallier   Command (non runn...
37
        # Format : (“cmd_name”, timeout, exec_mode)
8decb416   Etienne Pallier   UTC par defaut da...
38
        ("do_specific10", 10, 0),
888d6d8e   Etienne Pallier   AgentBasic cleanu...
39
40
        ("do_cmd_unimplemented_and_declared", 3, 0),
        ("cmd_badly_named_and_declared", 3, 0),
fe47499e   Etienne Pallier   fixed AgentBasic
41
42
43
        #("set_specific2", 5, 0),
        ("do_specific30", 3, 0),
        ("do_cmd_raising_error_exec", 3, 0),
f526191c   Etienne Pallier   Command (non runn...
44
    ]
b29985c6   Etienne Pallier   Implementation pr...
45

d02249e6   Etienne Pallier   Added CMD_EXEC_ER...
46
47
48
49
    # Deactivate some tests, so that test scenario runs faster during DEV
    # on DEV
    #COMMIT_ONLY = False
    # on commit only
888d6d8e   Etienne Pallier   AgentBasic cleanu...
50
    COMMIT_ONLY = True
d02249e6   Etienne Pallier   Added CMD_EXEC_ER...
51

f526191c   Etienne Pallier   Command (non runn...
52
    # @override
0bcd6dd5   Etienne Pallier   renamed Agent met...
53
    _TEST_COMMANDS_LIST = [
7b4ee4fe   Etienne Pallier   cleanup, mark som...
54
55

        # Format : ("self cmd_name cmd_args", timeout, "expected_result", expected_status),
6fbe2e20   Etienne Pallier   last minute.com m...
56
        #("self do_stop now", 200, '', Agent.CMD_STATUS.CMD_EXECUTED),
340ca843   Etienne Pallier   fixed get_specifi...
57

340ca843   Etienne Pallier   fixed get_specifi...
58
        # do_stop
340ca843   Etienne Pallier   fixed get_specifi...
59
60
61
        #("self do_stop now", 200, 'STOPPING now', Agent.CMD_STATUS.CMD_EXECUTED),
        #("self do_stop", 200, 'STOPPING asap', Agent.CMD_STATUS.CMD_EXECUTED),
        #("self do_stop asap", 200, 'STOPPING asap', Agent.CMD_STATUS.CMD_EXECUTED),
795c826a   Etienne Pallier   Ajout de la gesti...
62

888d6d8e   Etienne Pallier   AgentBasic cleanu...
63
64
65
66
67
68
        # get_specific_cmds
        (True, "    self      get_specific_cmds    ", 200, 
            None,
            #'do_specific10(arg1:int,arg2:int,arg3:float,arg4:str,arg5:typing.Tuple[int, str, int],arg6:typing.List[int]);do_specific30();do_cmd_raising_error_exec();do_cmd_unimplemented(U)', 
            Agent.CMD_STATUS.CMD_EXECUTED
        ),
795c826a   Etienne Pallier   Ajout de la gesti...
69

b7c6e890   Etienne Pallier   Test de tous les ...
70
        # do_restart
9d235d12   Etienne Pallier   simplify get_spec...
71
        (COMMIT_ONLY, "self do_restart asap", 200, 'RESTARTING asap', Agent.CMD_STATUS.CMD_EXECUTED),
b7c6e890   Etienne Pallier   Test de tous les ...
72
        #("self do_stop", 200, 'STOPPING asap', Agent.CMD_STATUS.CMD_EXECUTED),
340ca843   Etienne Pallier   fixed get_specifi...
73

d02249e6   Etienne Pallier   Added CMD_EXEC_ER...
74
75
76
        # ----------------------------------------------------
        # ------ A - ERROR CASES - from PENDING status -------
        # ----------------------------------------------------
340ca843   Etienne Pallier   fixed get_specifi...
77

b7c6e890   Etienne Pallier   Test de tous les ...
78

888d6d8e   Etienne Pallier   AgentBasic cleanu...
79
80
81
82
83
84
85
86
        # - Error case 2 - Unimplemented command (in agent specific commands list)


        # - Error case 1 - CMD_INVALID
        # a) Badly named commands
        (True, "self cmd_badly_named_and_declared", 200, "Command badly named, must start with do_, get_, or set_", Agent.CMD_STATUS.CMD_INVALID),
        (COMMIT_ONLY, "self cmd_badly_named_and_undeclared", 200, None, Agent.CMD_STATUS.CMD_INVALID),
        # b) Unknwon command
f526191c   Etienne Pallier   Command (non runn...
87
        ##FIXME: ("self unexisting_cmd", 200, '', Agent.CMD_STATUS.CMD_UNKNOWN),
888d6d8e   Etienne Pallier   AgentBasic cleanu...
88
89
90
        (COMMIT_ONLY, "self do_cmd_unexisting", 200, 'EXCEPTION on command do_cmd_unexisting: Unknown command', Agent.CMD_STATUS.CMD_INVALID),
        # c) Bad parameters (missing or too many, or bad type)
        # - missing args
d02249e6   Etienne Pallier   Added CMD_EXEC_ER...
91
        (COMMIT_ONLY, "self do_specific10", 200, 'EXCEPTION on command do_specific10: Command has bad, missing, or too many argument(s)', Agent.CMD_STATUS.CMD_INVALID),
888d6d8e   Etienne Pallier   AgentBasic cleanu...
92
        # - missing args
d02249e6   Etienne Pallier   Added CMD_EXEC_ER...
93
        (COMMIT_ONLY, "self do_specific10 2       ", 200, None, Agent.CMD_STATUS.CMD_INVALID),
b7c6e890   Etienne Pallier   Test de tous les ...
94
        # - too many args
d02249e6   Etienne Pallier   Added CMD_EXEC_ER...
95
        (COMMIT_ONLY, "self do_specific10 2 2 3.5 titi (3,'titi',5) [1,3,5,7,9] 4", 200, None, Agent.CMD_STATUS.CMD_INVALID),
b7c6e890   Etienne Pallier   Test de tous les ...
96
        # - bad type
d02249e6   Etienne Pallier   Added CMD_EXEC_ER...
97
        (COMMIT_ONLY, "self do_specific10 'toto' 2 3.5 titi (3,'titi',5) [1,3,5,7,9]", 200, None, Agent.CMD_STATUS.CMD_INVALID),
b7c6e890   Etienne Pallier   Test de tous les ...
98
99
100
101
        # - OK
        #("self do_specific10 2 2 3.5 titi (3,'titi',5) [1,3,5,7,9]", 200, '16.5', Agent.CMD_STATUS.CMD_EXECUTED),

        # - Error case 3 - CMD_UNIMPLEMENTED
888d6d8e   Etienne Pallier   AgentBasic cleanu...
102
        (True, "self do_cmd_unimplemented_and_declared", 200, None, Agent.CMD_STATUS.CMD_UNIMPLEMENTED),
f526191c   Etienne Pallier   Command (non runn...
103
        
b7c6e890   Etienne Pallier   Test de tous les ...
104
105
        # - Error case 4 - CMD_EXPIRED
        # This command has a validity of 0s and thus should be tagged as "expired"
d02249e6   Etienne Pallier   Added CMD_EXEC_ER...
106
        (COMMIT_ONLY, "self set_mode ATTENTIVE", 0, "MODE is ATTENTIVE", Agent.CMD_STATUS.CMD_EXPIRED),
b7c6e890   Etienne Pallier   Test de tous les ...
107
108
109

        # - Error case 5 - CMD_SKIPPED
        # a) In mode ROUTINE, SPECIFIC commands should be skipped as the agent is not ATTENTIVE
d02249e6   Etienne Pallier   Added CMD_EXEC_ER...
110
111
        (COMMIT_ONLY, "self set_mode ROUTINE", 200, "MODE is ROUTINE", Agent.CMD_STATUS.CMD_EXECUTED),
        (COMMIT_ONLY, "self do_specific10 2 2 3.5 titi (3,'titi',5) [1,3,5,7,9]", 200, None, Agent.CMD_STATUS.CMD_SKIPPED),
b7c6e890   Etienne Pallier   Test de tous les ...
112
        # b) Back to mode ATTENTIVE, SPECIFIC commands should be executed
d02249e6   Etienne Pallier   Added CMD_EXEC_ER...
113
114
115
116
117
118
119
        (COMMIT_ONLY, "self set_mode ATTENTIVE", 200, "MODE is ATTENTIVE", Agent.CMD_STATUS.CMD_EXECUTED),
        (COMMIT_ONLY, "self do_specific10 2 2 3.5 titi (3,'titi',5) [1,3,5,7,9]", 200, '16.5', Agent.CMD_STATUS.CMD_EXECUTED),

        # ----------------------------------------------------
        # ------ B - ERROR CASES - from RUNNING status -------
        # ----------------------------------------------------

8decb416   Etienne Pallier   UTC par defaut da...
120
        (True, "self do_cmd_raising_error_exec", 200, "EXCEPTION on command do_cmd_raising_error_exec: Error during Execution", Agent.CMD_STATUS.CMD_EXEC_ERROR),
b7c6e890   Etienne Pallier   Test de tous les ...
121
122

        # ------------------------------
d02249e6   Etienne Pallier   Added CMD_EXEC_ER...
123
        # ------ C - NORMAL CASES -------
b7c6e890   Etienne Pallier   Test de tous les ...
124
125
126
127
128
129
130
        # ------------------------------
        
        # do_restart => #iteration should restart at 1 (so at least it should be <= 4)
        #("self do_restart now", 200, 'RESTARTING now', Agent.CMD_STATUS.CMD_EXECUTED),
        # FIXME: ajouter la possibilité d'utiliser des expressions pour tester le résultat :
        #("self get_iteration_number", 200, 'EXPR:<=4', Agent.CMD_STATUS.CMD_EXECUTED),

7b4ee4fe   Etienne Pallier   cleanup, mark som...
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
        # 1) First, 3 EXCEPTION CASES (uncomment to activate exception)
        # Each of these lines will stop execution with an exception
        # ------------------------------------------------------------

        # - Agent command, unknown => ko, UnknownCmdException
        #("self do_unknown", 10, None,None),

        # - Agent general command malformed (missing arg) => ko, AgentCmdBadArgsException
        #("Agent set_mode", 10, None,None),
        
        # - Agent specific command, known but not implemented => ko, AgentCmdUnimplementedException
        #("self set_specific2", 10, None,None),

        # - Agent specific command, implemented but missing args => ko, AgentCmdBadArgsException
        #("    self      do_specific1    1   ", 10, None,None),


        # 2) NORMAL CASES (test scenario)
        # All these commands should be executed without error, from the 1st to the last one
        # -------------------------------

7b4ee4fe   Etienne Pallier   cleanup, mark som...
152
        # Agent general command
d02249e6   Etienne Pallier   Added CMD_EXEC_ER...
153
154
155
156
        (COMMIT_ONLY, "self set_mode ROUTINE", 200, "MODE is ROUTINE", Agent.CMD_STATUS.CMD_EXECUTED),
        (COMMIT_ONLY, "self get_mode", 200, "MODE is ROUTINE", Agent.CMD_STATUS.CMD_EXECUTED),
        (COMMIT_ONLY, "self set_mode ATTENTIVE", 200, "MODE is ATTENTIVE", Agent.CMD_STATUS.CMD_EXECUTED),
        (COMMIT_ONLY, "self get_mode", 200, "MODE is ATTENTIVE", Agent.CMD_STATUS.CMD_EXECUTED),
6fbe2e20   Etienne Pallier   last minute.com m...
157
158
        
        # End test
d02249e6   Etienne Pallier   Added CMD_EXEC_ER...
159
        (True, "self do_stop", 200, 'STOPPING asap', Agent.CMD_STATUS.CMD_EXECUTED),
b7c6e890   Etienne Pallier   Test de tous les ...
160

7b4ee4fe   Etienne Pallier   cleanup, mark som...
161
    ]
b29985c6   Etienne Pallier   Implementation pr...
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186


    """
    =================================================================
        FUNCTIONS RUN INSIDE MAIN THREAD
    =================================================================
    """

    # @override
    '''
    #def __init__(self, name:str=None, config_filename=None, RUN_IN_THREAD=True):
    def __init__(self, config_filename=None):
        ##if name is None: name = self.__class__.__name__
        #super().__init__(name, config_filename, RUN_IN_THREAD)
        super().__init__(config_filename)
        #self._log.print(f"init done for {name}")
        self._log.print("init done")
    '''
    def __init__(self, name:str=None):
        if name is None:
            name = self.__class__.__name__
        super().__init__()
        #super().__init__(RUN_IN_THREAD)        

    # @override
0bcd6dd5   Etienne Pallier   renamed Agent met...
187
    def _init(self):
7b4ee4fe   Etienne Pallier   cleanup, mark som...
188
        #TODO: a faire
0bcd6dd5   Etienne Pallier   renamed Agent met...
189
        super()._init()
b29985c6   Etienne Pallier   Implementation pr...
190
191
192
        # --- Set the mode according the startmode value
        ##agent_alias = self.__class__.__name__
        ##self.set_mode_from_config(agent_alias)
6d5013fe   Etienne Pallier   Log agent state a...
193
        self.set_delay(3)
b29985c6   Etienne Pallier   Implementation pr...
194

6d5013fe   Etienne Pallier   Log agent state a...
195
    # @override
0bcd6dd5   Etienne Pallier   renamed Agent met...
196
    def _main_loop_start(self):
340ca843   Etienne Pallier   fixed get_specifi...
197
        print("AgentBasic LOOP START")
b29985c6   Etienne Pallier   Implementation pr...
198

6d5013fe   Etienne Pallier   Log agent state a...
199
    # @override
0bcd6dd5   Etienne Pallier   renamed Agent met...
200
201
    def _main_loop_end(self):
        if self.current_cmd and self.current_cmd.name != "get_specific_cmds":
927b033b   Etienne Pallier   update AgentBasic...
202
            self.sleep(3)
340ca843   Etienne Pallier   fixed get_specifi...
203
        print("AgentBasic LOOP END");
b29985c6   Etienne Pallier   Implementation pr...
204

6d5013fe   Etienne Pallier   Log agent state a...
205
    # @override
0bcd6dd5   Etienne Pallier   renamed Agent met...
206
207
    def _routine_process_before_body(self):
        if self.current_cmd and self.current_cmd.name != "get_specific_cmds":
927b033b   Etienne Pallier   update AgentBasic...
208
            self.sleep(2)
6d5013fe   Etienne Pallier   Log agent state a...
209
210

    # @override
0bcd6dd5   Etienne Pallier   renamed Agent met...
211
212
    def _routine_process_after_body(self):
        if self.current_cmd and self.current_cmd.name != "get_specific_cmds":
927b033b   Etienne Pallier   update AgentBasic...
213
            self.sleep(2)
6d5013fe   Etienne Pallier   Log agent state a...
214

b29985c6   Etienne Pallier   Implementation pr...
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
    '''
    # @override
    def load_config(self):
        super().load_config()
    '''

    '''
    # @override
    def update_survey(self):
        super().update_survey()
    '''

    '''
    # @override
    def get_next_command(self):
        return super().get_next_command()
    '''

    # @override
    def do_log(self):
        super().do_log()

0cc81973   Etienne Pallier   added sleep after...
237
238
239
240
241

    # @override
    def _sleep_as_soon_as_running(self):
        print("Make agent sleep as soon as a command has started running")
        print("so that we can see this command in the 'current command' column of agent web pages")
0bcd6dd5   Etienne Pallier   renamed Agent met...
242
        if self.current_cmd and self.current_cmd.name != "get_specific_cmds": 
927b033b   Etienne Pallier   update AgentBasic...
243
            self.sleep(5)
0cc81973   Etienne Pallier   added sleep after...
244

5fddfc70   Etienne Pallier   Implementation pr...
245
    # @override
0bcd6dd5   Etienne Pallier   renamed Agent met...
246
    def _do_things_before_exit(self, stopper_agent_name=None):
5fddfc70   Etienne Pallier   Implementation pr...
247
        print("AgentBasic fait quelques trucs à lui avant de stopper...")
b29985c6   Etienne Pallier   Implementation pr...
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337


    """
    =================================================================
        FUNCTIONS RUN INSIDE A SUB-THREAD (OR A PROCESS) (thread_*())
    =================================================================
    """

    # Define your own command step(s) here
    def cmd_step1(self, step:int):
        cmd = self._current_specific_cmd
        cmd.result = f"in step #{step}/{self._thread_total_steps_number}"
        cmd.save()
        """
        if self.RUN_IN_THREAD:
            print("(save from thread)")
            cmd.save()
        else:
            #@transaction.atomic
            print("(save from process)")
            with transaction.atomic():
                cmd.save()
                #Command.objects.select_for_update()
        """

    def cmd_step2(self, step:int):
        self.cmd_step1(step)
    def cmd_step3(self, step:int):
        self.cmd_step1(step)
    def cmd_step4(self, step:int):
        self.cmd_step1(step)

    """
    # @override
    def thread_exec_specific_cmd_step(self, step:int, sleep_time:float=1.0):
        self.thread_stop_if_asked()
        cmd = self._current_specific_cmd
        print(f">>>>> Thread (cmd {cmd.name}): step #{step}/5")
        self.sleep(sleep_time)
    """

    '''
    # @override
    def exec_specific_cmd_start(self, cmd:Command, from_thread=True):
        super().exec_specific_cmd_start(cmd, from_thread)
    '''



    # @override
    def simulator_test_results_main(self, commands):
        nb_asserted = 0
        for cmd in commands:
            if cmd.name == "flush_commands":
                assert cmd.is_executed()
                nb_asserted+=1
            # 2 times
            if cmd.name == "go_active":
                assert cmd.is_executed()
                nb_asserted+=1
            # 2 times
            if cmd.name == "go_idle":
                assert cmd.is_executed()
                nb_asserted+=1
            """
            if cmd.name == "specific0":
                assert cmd.is_skipped()
                assert cmd.result == "in step #5/5"
                nb_asserted+=1
            """
            if cmd.name == "specific1":
                assert cmd.is_killed()
                nb_asserted+=1
            if cmd.name == "specific2":
                assert cmd.is_executed()
                assert cmd.result == "in step #5/5"
                nb_asserted+=1
            if cmd.name == "eval 4+3":
                assert cmd.is_executed()
                assert cmd.get_result() == "7"
                nb_asserted+=1
            if cmd.name in ("abort"):
                assert cmd.is_executed()
                nb_asserted+=1
            if cmd.name in ("exit"):
                assert cmd.is_executed()
                nb_asserted+=1
        return nb_asserted


f526191c   Etienne Pallier   Command (non runn...
338
339
340
341
342
343
344
345
346
347
    ###
    # ================================================================================================
    #   AGENT SPECIFIC COMMANDS (functions)
    #   (here just to serve as examples)
    # ================================================================================================
    ###

    #def do_specific1(self, arg1:int, arg2:int=2, arg3:int=3) -> int:
    #def do_specific1(self, arg1:int, arg2:int=2, arg3:float=3.1, arg4:list=[1,2,3]) -> float:

8decb416   Etienne Pallier   UTC par defaut da...
348
    def do_cmd_raising_error_exec(self):
0bcd6dd5   Etienne Pallier   renamed Agent met...
349
        raise CmdExceptionExecError(self.current_cmd)
d02249e6   Etienne Pallier   Added CMD_EXEC_ER...
350

f526191c   Etienne Pallier   Command (non runn...
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
    def do_specific10(self, 
            arg1:int, 
            arg2:int, 
            arg3:float=3.1, 
            arg4:str='toto', 
            arg5:Tuple[int,str,int]=(1,'toto',3),
            #arg5:Tuple[int,int,int]=(1,2,3),
            arg6:List[int]=[]
        ) -> float:
        '''
        arg1 = int(arg1)
        arg2 = int(arg2)
        arg3 = float(arg3)
        arg5 = ast.literal_eval(arg5)
        print(arg5[1])
        arg6 = ast.literal_eval(arg6)
        '''
        #print(arg4)
        res = arg1 + arg2 + arg3 + arg5[0] + arg5[2]
        if arg6: res += arg6[0]
        return res

    # Undefined specific cmd
    #def set_specific2(self, arg1:str, arg2:int): pass

    def do_specific30(self):
        pass

f526191c   Etienne Pallier   Command (non runn...
379

b29985c6   Etienne Pallier   Implementation pr...
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
"""
=================================================================
    MAIN FUNCTION
=================================================================
"""
if __name__ == "__main__":

    agent = build_agent(AgentBasic)

    '''
    TEST_MODE, configfile = extract_parameters()
    #agent = AgentX()
    agent = AgentA("AgentA", configfile, RUN_IN_THREAD)
    agent.setSimulatorMode(TEST_MODE)
    print(agent)
    '''
795c826a   Etienne Pallier   Ajout de la gesti...
396
397
398
399
400

    # Run only 4 iterations
    #agent.run(nb_iter=4)

    # Run indefinitely
b29985c6   Etienne Pallier   Implementation pr...
401
    agent.run()