409 lines
14 KiB
Python
409 lines
14 KiB
Python
import json
|
|
import os
|
|
import subprocess
|
|
import sys
|
|
import importlib
|
|
import threading
|
|
import time
|
|
from collections import deque
|
|
from datetime import datetime
|
|
|
|
from modules.internal_io import global_status # , test_status, return_code_dict
|
|
|
|
"""
|
|
All modules that can be tested
|
|
Associate the arguments passed to the command line with the modules to be loaded
|
|
argparse argument : [module_name, class_name]
|
|
"""
|
|
from termcolor import colored, cprint
|
|
os.system('color')
|
|
# red, green, yellow, blue, magenta, cyan, white.
|
|
|
|
_TEST_MODULES = {
|
|
"spidey": ["spidey_test", "SpideyTest"],
|
|
# "test_walk": ["test_template", "TestWalkTemplate"],
|
|
}
|
|
|
|
PROGRAM_VERSION = "1.0.0"
|
|
POST_RUN_ALLOWED = False # TODO : Remove this line, only use is_infected
|
|
RUN_OVER = False
|
|
|
|
queue_lock = threading.Lock()
|
|
processes_lock = threading.Lock()
|
|
|
|
CLEAR_CODE = colored(r"""
|
|
_______ _
|
|
(_______) |
|
|
_ | | _____ _____ ____
|
|
| | | || ___ (____ |/ ___)
|
|
| |_____| || ____/ ___ | |
|
|
\______)\_)_____)_____|_|
|
|
""", 'green')
|
|
|
|
INFECTED_CODE = colored(r"""
|
|
_ ___ _
|
|
| | / __) _ | |
|
|
| |____ _| |__ _____ ____ _| |_ _____ __| |
|
|
| | _ (_ __) ___ |/ ___|_ _) ___ |/ _ |
|
|
| | | | || | | ____( (___ | |_| ____( (_| |
|
|
|_|_| |_||_| |_____)\____) \__)_____)\____|
|
|
""", 'red')
|
|
|
|
LOGO = colored(r"""
|
|
__ \ _) | | | |
|
|
| | | __| __| _ \ __| _` | | | _ \ | __ \ _ \ __|
|
|
| | | \__ \ ( ( | | ( | ___ | __/ | | | __/ |
|
|
____/ _| ____/ \___| \___/ _| \__,_| _| _| \___| _| .__/ \___| _|
|
|
_|
|
|
""", "cyan")
|
|
|
|
|
|
class TestRunner:
|
|
def __init__(self, args, agnpath, start_time):
|
|
"""
|
|
Main spidey runner
|
|
:param args: List of arguments
|
|
:type args: argparse.Namespace
|
|
:param agnpath: The path to the discord folder
|
|
:type agnpath: agnostic_path.AgnosticPath
|
|
:param start_time: The time the test started
|
|
:type start_time: float
|
|
"""
|
|
self.ptb = args.ptb
|
|
self.args = args
|
|
self.agnostic_path = agnpath
|
|
self.os_name = agnpath.os
|
|
self.main_path = agnpath.main_path
|
|
self.version = agnpath.version
|
|
self.start_time = start_time
|
|
|
|
self.is_infected = 0
|
|
self.detections = 0
|
|
self.test_run = {}
|
|
|
|
self.loaded_test_modules = {}
|
|
self.loaded_test_classes = {}
|
|
self.list_of_tests = []
|
|
self.dict_of_processes = {} # To get a more granular view of the processes
|
|
self.update_module_list()
|
|
|
|
self.finished_tests = deque()
|
|
|
|
self.exec_all_tests()
|
|
|
|
def update_module_list(self):
|
|
"""
|
|
Gets the list of modules to be loaded (in accordance to the config)
|
|
:return: List of modules
|
|
:rtype: list
|
|
"""
|
|
modules = {}
|
|
classes = {}
|
|
module_name = None
|
|
try:
|
|
for module_name, values in _TEST_MODULES.items():
|
|
if self.args.all or self.args.__getattribute__(module_name):
|
|
modules[values[0]] = importlib.import_module(f"modules.{values[0]}")
|
|
classes[values[0]] = getattr(modules[values[0]], values[1])
|
|
|
|
except AttributeError as e:
|
|
print(f"The module {module_name} was not loaded because it was not specified in the config.")
|
|
print(e)
|
|
|
|
self.loaded_test_modules.update(modules)
|
|
self.loaded_test_classes.update(classes)
|
|
|
|
def exec_all_tests(self):
|
|
"""
|
|
Executes all the tests, get their result as they finishes
|
|
:return: The number of test ran, success, failures, skipped (with ran = success+failures+skip)
|
|
:rtype: (int,int,int,int) # TODO: Change this to a nametuple
|
|
"""
|
|
self.list_of_tests = []
|
|
for module_name, test_class in self.loaded_test_classes.items():
|
|
print(colored(f" > Starting test {module_name}...", "blue"))
|
|
tc = test_class(
|
|
self.args,
|
|
self.agnostic_path,
|
|
None,
|
|
self.finished_tests,
|
|
queue_lock,
|
|
self.dict_of_processes,
|
|
processes_lock
|
|
)
|
|
tc = threading.Thread(target=tc.run_test, args=())
|
|
tc.name = str(module_name)
|
|
tc.daemon = True
|
|
self.list_of_tests.append(tc)
|
|
tc.start()
|
|
|
|
# Launch a controller to allow the user to stop all tests
|
|
# controller = threading.Thread(target=self.test_launcher)
|
|
# Allow the user to stop the tests
|
|
tc = threading.Thread(target=self.controller_test, args=())
|
|
tc.daemon = True
|
|
tc.start()
|
|
|
|
# Await the end of the tests or the user interruption
|
|
tc = threading.Thread(target=self.post_test_runner, args=())
|
|
tc.start()
|
|
|
|
# Wait for the end of the tests
|
|
tc = threading.Thread(target=self.test_waiter, args=())
|
|
tc.daemon = True
|
|
tc.start()
|
|
|
|
return self.is_infected, self.detections, self.test_run
|
|
|
|
def controller_test(self):
|
|
"""
|
|
Kills the tests if the user press enter
|
|
"""
|
|
print(colored("\n > All test started, press ENTER to abort...\n", "blue"))
|
|
while True:
|
|
#print("Controller still up")
|
|
try:
|
|
if input() == "":
|
|
global POST_RUN_ALLOWED, RUN_OVER
|
|
print(colored("\n > Aborting tests...\n", "red"))
|
|
if not self.is_infected:
|
|
POST_RUN_ALLOWED = True
|
|
RUN_OVER = True
|
|
return
|
|
except KeyboardInterrupt:
|
|
RUN_OVER = True
|
|
return
|
|
except:
|
|
sys.exit()
|
|
|
|
def post_test_runner(self):
|
|
"""
|
|
Runs the post test runner if all tests are finished
|
|
"""
|
|
global POST_RUN_ALLOWED, RUN_OVER
|
|
if self.args.launch:
|
|
while True:
|
|
if RUN_OVER:
|
|
if POST_RUN_ALLOWED and self.is_infected == 0: # Second part is redundant
|
|
print(colored("\n > Running post test runner...", "green"))
|
|
subprocess.Popen([self.agnostic_path.main_path + f"\\Discord{self.agnostic_path.ptb}.exe"])
|
|
return 0
|
|
return 1
|
|
time.sleep(0.1)
|
|
return 0
|
|
|
|
def test_waiter(self):
|
|
"""
|
|
Waits for the end of the tests
|
|
:return:
|
|
"""
|
|
for t in self.list_of_tests: # Can only proceed if all tests are finished
|
|
t.join()
|
|
self.get_status()
|
|
# time.sleep(0.5)
|
|
# When all tests are finished or the user stopped the tests, we can proceed
|
|
if self.is_infected == 0:
|
|
global POST_RUN_ALLOWED
|
|
POST_RUN_ALLOWED = True
|
|
|
|
def get_exit_code(self):
|
|
"""
|
|
Gets the exit code of the tests
|
|
:return: The exit code
|
|
:rtype: int
|
|
"""
|
|
status = self.get_status()
|
|
if status.tests_finished == status.tests_total:
|
|
if status.tests_failed != 0:
|
|
exit_code = 1 # There is one failure, so the test failed
|
|
elif status.tests_success == status.tests_total:
|
|
exit_code = 0 # All tests passed
|
|
else:
|
|
# print("Something went wrong, please report this bug.")
|
|
# print(status)
|
|
exit_code = 2 # Something went wrong
|
|
else:
|
|
global RUN_OVER
|
|
if RUN_OVER:
|
|
print(colored("\n > Tests aborted, please check the logs.", "red"))
|
|
exit_code = 3
|
|
else:
|
|
exit_code = -1 # The tests are not finished
|
|
return exit_code
|
|
|
|
def get_status(self):
|
|
"""
|
|
Gets the status of the tests
|
|
:return: The status
|
|
:rtype: internal_io.global_status
|
|
"""
|
|
queue_lock.acquire(timeout=0.5)
|
|
nb_tests = len(self.list_of_tests)
|
|
nb_tests_success = 0
|
|
nb_tests_failure = 0
|
|
nb_tests_skipped = 0
|
|
progress = 0
|
|
for test in self.finished_tests:
|
|
if test.status == "success":
|
|
nb_tests_success += 1
|
|
elif test.status == "failure":
|
|
nb_tests_failure += 1
|
|
self.is_infected += 1
|
|
elif test.status == "skipped":
|
|
nb_tests_skipped += 1
|
|
elif test.status == "problem":
|
|
nb_tests_failure += 1
|
|
# progress += test.progress
|
|
queue_lock.release()
|
|
|
|
for test_name, test in self.dict_of_processes.items():
|
|
progress += test.progress
|
|
progress = int(progress / nb_tests)
|
|
|
|
nb_tests_ran = nb_tests_success + nb_tests_failure + nb_tests_skipped
|
|
nb_test_running = nb_tests - nb_tests_ran
|
|
return global_status(
|
|
tests_total=nb_tests,
|
|
tests_finished=nb_tests_ran,
|
|
tests_success=nb_tests_success,
|
|
tests_failed=nb_tests_failure,
|
|
tests_running=nb_test_running,
|
|
tests_skipped=nb_tests_skipped,
|
|
tests_error=nb_tests_failure,
|
|
progress=progress
|
|
)
|
|
|
|
def get_test_data(self):
|
|
"""
|
|
Gets the test data
|
|
:return: The test data
|
|
:rtype: dict
|
|
"""
|
|
data = {}
|
|
queue_lock.acquire()
|
|
for test in self.finished_tests:
|
|
for key, value in test.data.items():
|
|
if key not in data:
|
|
data[key] = value
|
|
else:
|
|
data[key].update(value)
|
|
queue_lock.release()
|
|
return data
|
|
|
|
|
|
def export_data(test_runner, data):
|
|
"""
|
|
Exports the test data
|
|
:param test_runner: The test runner
|
|
:type test_runner: TestRunner
|
|
:param data: The test data
|
|
:type data: dict
|
|
"""
|
|
main_data = {
|
|
"global":
|
|
{
|
|
"os": test_runner.os_name,
|
|
"ptb": test_runner.ptb,
|
|
"discord_version": test_runner.version,
|
|
"program_version": PROGRAM_VERSION,
|
|
},
|
|
"tests": data,
|
|
}
|
|
return main_data
|
|
|
|
|
|
def print_status(status, timer_start):
|
|
"""
|
|
Prints the status
|
|
:param status: The status
|
|
:type status: internal_io.global_status
|
|
:param timer_start: The start time of the tests
|
|
:type timer_start: float
|
|
"""
|
|
if status.tests_failed != 0:
|
|
color = "red"
|
|
else:
|
|
color = "green"
|
|
|
|
print(colored("\n > Status:", color))
|
|
if status.tests_total == 0:
|
|
print(colored(" > No test found", "red"))
|
|
return
|
|
|
|
print(colored(
|
|
f" > Test finished {status.tests_finished}/{status.tests_total}"
|
|
f": {status.tests_success} success, "
|
|
f"{status.tests_failed} failed, "
|
|
f"{status.tests_error} problem", color
|
|
))
|
|
if status.tests_running != 0:
|
|
ellapsed_time = time.time() - timer_start
|
|
if status.progress == 0:
|
|
estimated_time = "∞"
|
|
else:
|
|
mon, sec = divmod(ellapsed_time * 100 / status.progress, 60)
|
|
hr, mon = divmod(mon, 60)
|
|
estimated_time = "%d:%02d:%02d" % (hr, mon, sec)
|
|
print(colored(
|
|
f" > Overall progress: {status.progress}%"
|
|
f" in {time.time() - timer_start:.2f} seconds"
|
|
f" estimaded time ({estimated_time})", color
|
|
))
|
|
|
|
|
|
def run_check(args, agnpath):
|
|
"""
|
|
Runs all operations selected in the config
|
|
:param args: List of arguments
|
|
:param agnpath: Annostic path to the discord folder
|
|
:return: None
|
|
"""
|
|
print(LOGO)
|
|
start = time.time()
|
|
tr = TestRunner(args, agnpath, start_time=start) # All operation are executed in parallel and the user can stop them
|
|
|
|
POLLRATE, PRINT_RATE, COUNTER = args.pollrate, args.printrate, 0
|
|
COUNTER_MAX = int(PRINT_RATE / POLLRATE)
|
|
|
|
while tr.get_exit_code() == -1:
|
|
# print("Waiting for the end of the tests")
|
|
if (COUNTER % COUNTER_MAX) == 0:
|
|
print_status(tr.get_status(), start) # TODO : Print status in a more readable way
|
|
time.sleep(POLLRATE)
|
|
COUNTER += 1
|
|
|
|
global RUN_OVER
|
|
RUN_OVER = True
|
|
|
|
status = tr.get_status()
|
|
if status.tests_failed > 0:
|
|
print(INFECTED_CODE)
|
|
# tr.is_infected += 1
|
|
color = "red"
|
|
else:
|
|
print(CLEAR_CODE)
|
|
color = "green"
|
|
# tr.is_infected = False
|
|
|
|
print(colored(f"\nThe test sequence is now finished, the program ran for {round(time.time() - start,2)} seconds", color))
|
|
print_status(status, start) # TODO: Print the final status, test still running are actually skipped
|
|
|
|
if args.gen_data:
|
|
print(colored("\n > Generating data...", "blue"))
|
|
data = tr.get_test_data()
|
|
file_path = os.path.join(os.path.join("databases", args.gen_data[0]))
|
|
folder = os.path.dirname(file_path)
|
|
if not os.path.exists(folder):
|
|
print(colored(" > Making folder...", "blue"))
|
|
os.makedirs(folder)
|
|
print(colored(f" > Exporting the test data to {file_path}", "blue")) # TODO : Advertize where the data is exported
|
|
main_data = export_data(tr, data)
|
|
# print(main_data)
|
|
with open(file_path, "w") as f:
|
|
json.dump(main_data, f, indent=4)
|
|
|
|
msg_error = "sucessfully" if status.tests_failed == 0 else f"with {status.tests_error} errors"
|
|
print(colored(f"\nThe program executed {msg_error}, exiting in {args.timeout} seconds...", color))
|
|
time.sleep(args.timeout)
|
|
sys.exit(tr.get_exit_code())
|