Blame view

privatedev/plugin/agent/AgentBasic.py 13.9 KB
eb6649f7   Etienne Pallier   bugfix DEFAULT_VA...
1
2
#!/usr/bin/env python3

eb6649f7   Etienne Pallier   bugfix DEFAULT_VA...
3

b7c6e890   Etienne Pallier   Test de tous les ...
4
import time
1b2994b2   Alexis Koralewski   synchronise agent...
5
import sys
eb6649f7   Etienne Pallier   bugfix DEFAULT_VA...
6
7
8
##import utils.Logger as L

##from .Agent import Agent
6d5013fe   Etienne Pallier   Log agent state a...
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
1b2994b2   Alexis Koralewski   synchronise agent...
13

6d5013fe   Etienne Pallier   Log agent state a...
14
from typing import List, Tuple, Union, Any
1b2994b2   Alexis Koralewski   synchronise agent...
15

eb6649f7   Etienne Pallier   bugfix DEFAULT_VA...
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
eb6649f7   Etienne Pallier   bugfix DEFAULT_VA...
29
30
31
32
33
    # Who should I send commands to ?
    TEST_COMMANDS_DEST = "myself"
    #TEST_COMMANDS_DEST = "AgentB"
    # Scenario to be executed

6d5013fe   Etienne Pallier   Log agent state a...
34
35
36
37
38
39
    # @override
    AGENT_SPECIFIC_COMMANDS = [
        # Format : (“cmd_name”, timeout, exec_mode)
        ("do_specific10", 10, 0),
        #("set_specific2", 5, 0),
        ("do_specific30", 3, 0),
d02249e6   Etienne Pallier   Added CMD_EXEC_ER...
40
41
        ##("cmd_existing_but_unimplemented", 3, 0),
        ("cmd_raising_error_exec", 3, 0)
6d5013fe   Etienne Pallier   Log agent state a...
42
    ]
eb6649f7   Etienne Pallier   bugfix DEFAULT_VA...
43

d02249e6   Etienne Pallier   Added CMD_EXEC_ER...
44
45
46
47
48
49
    # Deactivate some tests, so that test scenario runs faster during DEV
    # on DEV
    #COMMIT_ONLY = False
    # on commit only
    COMMIT_ONLY = True

6d5013fe   Etienne Pallier   Log agent state a...
50
51
52
53
54
    # @override
    TEST_COMMANDS_LIST = [

        # Format : ("self cmd_name cmd_args", timeout, "expected_result", expected_status),
        #("self do_stop now", 200, '', Agent.CMD_STATUS.CMD_EXECUTED),
d6441fe9   Etienne Pallier   new methods is_xx...
55
56

        # do_stop
b7c6e890   Etienne Pallier   Test de tous les ...
57

d6441fe9   Etienne Pallier   new methods is_xx...
58
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),
        
b7c6e890   Etienne Pallier   Test de tous les ...
62
63
        # do_restart

d02249e6   Etienne Pallier   Added CMD_EXEC_ER...
64
        (COMMIT_ONLY, "self do_restart now", 200, 'RESTARTING now', Agent.CMD_STATUS.CMD_EXECUTED),
b7c6e890   Etienne Pallier   Test de tous les ...
65
        #("self do_stop", 200, 'STOPPING asap', Agent.CMD_STATUS.CMD_EXECUTED),
d6441fe9   Etienne Pallier   new methods is_xx...
66

d02249e6   Etienne Pallier   Added CMD_EXEC_ER...
67
68
69
        # ----------------------------------------------------
        # ------ A - ERROR CASES - from PENDING status -------
        # ----------------------------------------------------
d6441fe9   Etienne Pallier   new methods is_xx...
70

b7c6e890   Etienne Pallier   Test de tous les ...
71
        # - Error case 1 - unimplemented command in agent specific commands list
d02249e6   Etienne Pallier   Added CMD_EXEC_ER...
72
73
        # get_specific_cmds KO (with cmd_existing_but_unimplemented)
        ##("self get_specific_cmds", 200, 'EXCEPTION - One specific cmd is unimplemented: cmd_existing_but_unimplemented', Agent.CMD_STATUS.CMD_EXEC_ERROR),
b7c6e890   Etienne Pallier   Test de tous les ...
74
        # get_specific_cmds OK (all commands implemented)
0f0a8970   Etienne Pallier   bugfix test
75
        (COMMIT_ONLY, "    self      get_specific_cmds    ", 200, 'do_specific10(arg1:int,arg2:int,arg3:float,arg4:str,arg5:typing.Tuple[int, str, int],arg6:typing.List[int]);do_specific30();cmd_raising_error_exec()', Agent.CMD_STATUS.CMD_EXECUTED),
b7c6e890   Etienne Pallier   Test de tous les ...
76
77
78

        # - Error case 2 - CMD_INVALID
        # unknwon command
6d5013fe   Etienne Pallier   Log agent state a...
79
        ##FIXME: ("self unexisting_cmd", 200, '', Agent.CMD_STATUS.CMD_UNKNOWN),
d02249e6   Etienne Pallier   Added CMD_EXEC_ER...
80
        (COMMIT_ONLY, "self cmd_unexisting", 200, 'EXCEPTION on command cmd_unexisting: Unknown command', Agent.CMD_STATUS.CMD_INVALID),
b7c6e890   Etienne Pallier   Test de tous les ...
81
82
        # bad parameters (missing or too many, or bad type)
        # missing args
d02249e6   Etienne Pallier   Added CMD_EXEC_ER...
83
        (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),
b7c6e890   Etienne Pallier   Test de tous les ...
84
        # missing args
d02249e6   Etienne Pallier   Added CMD_EXEC_ER...
85
        (COMMIT_ONLY, "self do_specific10 2       ", 200, None, Agent.CMD_STATUS.CMD_INVALID),
b7c6e890   Etienne Pallier   Test de tous les ...
86
        # - too many args
d02249e6   Etienne Pallier   Added CMD_EXEC_ER...
87
        (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 ...
88
        # - bad type
d02249e6   Etienne Pallier   Added CMD_EXEC_ER...
89
        (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 ...
90
91
92
93
        # - 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
d02249e6   Etienne Pallier   Added CMD_EXEC_ER...
94
        ##("self cmd_existing_but_unimplemented", 200, None, Agent.CMD_STATUS.CMD_UNIMPLEMENTED),
6d5013fe   Etienne Pallier   Log agent state a...
95
        
b7c6e890   Etienne Pallier   Test de tous les ...
96
97
        # - 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...
98
        (COMMIT_ONLY, "self set_mode ATTENTIVE", 0, "MODE is ATTENTIVE", Agent.CMD_STATUS.CMD_EXPIRED),
b7c6e890   Etienne Pallier   Test de tous les ...
99
100
101

        # - 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...
102
103
        (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 ...
104
        # b) Back to mode ATTENTIVE, SPECIFIC commands should be executed
d02249e6   Etienne Pallier   Added CMD_EXEC_ER...
105
106
107
108
109
110
111
112
        (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 -------
        # ----------------------------------------------------

        (True, "self cmd_raising_error_exec", 200, "EXCEPTION on command cmd_raising_error_exec: Error during Execution", Agent.CMD_STATUS.CMD_EXEC_ERROR),
b7c6e890   Etienne Pallier   Test de tous les ...
113
114

        # ------------------------------
d02249e6   Etienne Pallier   Added CMD_EXEC_ER...
115
        # ------ C - NORMAL CASES -------
b7c6e890   Etienne Pallier   Test de tous les ...
116
117
118
119
120
121
122
        # ------------------------------
        
        # 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),

6d5013fe   Etienne Pallier   Log agent state a...
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
        # 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
        # -------------------------------

6d5013fe   Etienne Pallier   Log agent state a...
144
        # Agent general command
d02249e6   Etienne Pallier   Added CMD_EXEC_ER...
145
146
147
148
        (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),
6d5013fe   Etienne Pallier   Log agent state a...
149
150
        
        # End test
d02249e6   Etienne Pallier   Added CMD_EXEC_ER...
151
        (True, "self do_stop", 200, 'STOPPING asap', Agent.CMD_STATUS.CMD_EXECUTED),
b7c6e890   Etienne Pallier   Test de tous les ...
152

6d5013fe   Etienne Pallier   Log agent state a...
153
    ]
eb6649f7   Etienne Pallier   bugfix DEFAULT_VA...
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179


    """
    =================================================================
        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
    def init(self):
6d5013fe   Etienne Pallier   Log agent state a...
180
        #TODO: a faire
eb6649f7   Etienne Pallier   bugfix DEFAULT_VA...
181
182
183
184
        super().init()
        # --- 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...
185
        self.set_delay(3)
eb6649f7   Etienne Pallier   bugfix DEFAULT_VA...
186

6d5013fe   Etienne Pallier   Log agent state a...
187
    # @override
1b2994b2   Alexis Koralewski   synchronise agent...
188
    def main_loop_start(self):
d6441fe9   Etienne Pallier   new methods is_xx...
189
        print("AgentBasic LOOP START")
1b2994b2   Alexis Koralewski   synchronise agent...
190

6d5013fe   Etienne Pallier   Log agent state a...
191
    # @override
1b2994b2   Alexis Koralewski   synchronise agent...
192
    def main_loop_end(self):
927b033b   Etienne Pallier   update AgentBasic...
193
194
        if self.CURRENT_CMD and self.CURRENT_CMD.name != "get_specific_cmds":
            self.sleep(3)
d6441fe9   Etienne Pallier   new methods is_xx...
195
        print("AgentBasic LOOP END");
1b2994b2   Alexis Koralewski   synchronise agent...
196

6d5013fe   Etienne Pallier   Log agent state a...
197
198
    # @override
    def routine_process_before_body(self):
927b033b   Etienne Pallier   update AgentBasic...
199
200
        if self.CURRENT_CMD and self.CURRENT_CMD.name != "get_specific_cmds":
            self.sleep(2)
6d5013fe   Etienne Pallier   Log agent state a...
201
202
203

    # @override
    def routine_process_after_body(self):
927b033b   Etienne Pallier   update AgentBasic...
204
205
        if self.CURRENT_CMD and self.CURRENT_CMD.name != "get_specific_cmds":
            self.sleep(2)
6d5013fe   Etienne Pallier   Log agent state a...
206

eb6649f7   Etienne Pallier   bugfix DEFAULT_VA...
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
    '''
    # @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...
229
230
231
232
233

    # @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")
927b033b   Etienne Pallier   update AgentBasic...
234
235
        if self.CURRENT_CMD and self.CURRENT_CMD.name != "get_specific_cmds": 
            self.sleep(5)
0cc81973   Etienne Pallier   added sleep after...
236

1b2994b2   Alexis Koralewski   synchronise agent...
237
238
239
    # @override
    def do_things_before_exit(self, stopper_agent_name=None):
        print("AgentBasic fait quelques trucs à lui avant de stopper...")
eb6649f7   Etienne Pallier   bugfix DEFAULT_VA...
240
241
242
243
244
245
246
247
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


    """
    =================================================================
        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


6d5013fe   Etienne Pallier   Log agent state a...
330
331
332
333
334
335
336
337
338
339
    ###
    # ================================================================================================
    #   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:

d02249e6   Etienne Pallier   Added CMD_EXEC_ER...
340
341
342
    def cmd_raising_error_exec(self):
        raise CmdExceptionExecError(self.CURRENT_CMD)

6d5013fe   Etienne Pallier   Log agent state a...
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
    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


eb6649f7   Etienne Pallier   bugfix DEFAULT_VA...
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
"""
=================================================================
    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)
    '''
    agent.run()