Tachi67 commited on
Commit
dc04a36
·
1 Parent(s): b28c869

Update TestCodeFlow.py

Browse files
Files changed (1) hide show
  1. TestCodeFlow.py +15 -0
TestCodeFlow.py CHANGED
@@ -8,6 +8,21 @@ logging.set_verbosity_debug()
8
  log = logging.get_logger(__name__)
9
 
10
  class TestCodeFlow(SequentialFlow):
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
11
  REQUIRED_KEYS_CONFIG = ["max_rounds", "early_exit_key", "topology", "memory_files"]
12
 
13
  def __init__(
 
8
  log = logging.get_logger(__name__)
9
 
10
  class TestCodeFlow(SequentialFlow):
11
+ """This class is used to test code. It is a sequential flow that runs the following steps:
12
+ 1. Prepares the code to be tested, it is composed of the code to be tested and necessary import statements manually added.
13
+ 2. Opens the code in VSCode and waits for the user to clode the vscode session. The user is able to add tests.
14
+ 3. The following will be tested:
15
+ a. (Default & Compulsory) Code syntax;
16
+ b. (Added by user) Any other tests.
17
+ 4. Runs the test and returns the output.
18
+ 5. Asks for user feedback.
19
+
20
+ *Input Interface*:
21
+ - `code` (str): The code to be tested.
22
+
23
+ *Output Interface*:
24
+ - `feedback` (str): The feedback from the user.
25
+ """
26
  REQUIRED_KEYS_CONFIG = ["max_rounds", "early_exit_key", "topology", "memory_files"]
27
 
28
  def __init__(