[FEATURE] Added stdout output when script ran in --no-gui. Fixes #64

Signed-off-by: Jules Lasne (seluj78) <jlasne@student.42.fr>

Author: Seluj78

42PyChecker.py

@@ -33,6 +33,7 @@ def main():
     parser.add_argument("--no-makefile", help="Disables Makefile check", action="store_true")
     parser.add_argument("--no-norm", help="Disables norm check", action="store_true")
     parser.add_argument("--no-static", help="Disables static functions check", action="store_true")
+    parser.add_argument("--no-extra", help="Disables stats and checks on your extra functions", action="store_true")
     parser.add_argument("-p", "--path", help="The path of the project you want to test.", default="", type=str)
     parser.add_argument("--show-w", help="Displays the warranty warning from the license.", action="store_true")
     parser.add_argument("--show-c", help="Displays the conditions warning from the license.", action="store_true")

PyChecker/projects/libft.py

@@ -2,11 +2,9 @@
     Copyright (C) 2018 Jules Lasne <jules.lasne@gmail.com>
     See full notice in `LICENSE'
 """
-
 import os
 import glob
-import subprocess
-from PyChecker.utils import author, forbidden_functions, makefile, norme
+from PyChecker.utils import author, forbidden_functions, makefile, norme, static
 from PyChecker.testing_suite import maintest, moulitest, libftest
 
 
@@ -33,6 +31,12 @@ def count_extras(project_path: str, required_functions, bonus_functions):
     for file in glob.glob(project_path + '/*.c'):
         file_list.append(file.replace(project_path + '/', ''))
     extra_functions = [item for item in file_list if item not in required_functions and item not in bonus_functions]
+    print("*---------------------------------------------------------------*")
+    print("*------------------------Extra functions:-----------------------*")
+    print("*---------------------------------------------------------------*")
+    print("You have {} extra functions.".format(len(extra_functions)))
+    for function in extra_functions:
+        print(function)
     return extra_functions
 
 
@@ -58,18 +62,15 @@ def check(root_path: str, args):
     bonus_functions = ['ft_lstnew.c', 'ft_lstdelone.c', 'ft_lstdel.c',
                        'ft_lstiter.c', 'ft_lstadd.c', 'ft_lstmap.c']
     authorized_functions = ['free', 'malloc', 'write', 'main']
-    extra_functions = count_extras(args.path, required_functions, bonus_functions)
-    print("You have {} extra functions.".format(len(extra_functions)))
-
+    if not args.no_extra:
+        # @todo Stats on all c/h files of project, like with `cloc' ?
+        count_extras(args.path, required_functions, bonus_functions)
     if not args.no_author:
         author.check(args.path)
     if not args.no_norm:
         norme.check(args.path, root_path)
     if not args.no_static:
-        with open(root_path + "/.mystatic", 'w+') as file:
-            result = subprocess.run(['sh', 'scripts/check_static.sh', args.path],
-                                    stdout=subprocess.PIPE).stdout.decode('utf-8')
-            file.write(result)
+        static.check(root_path, args)
     if not args.no_makefile:
         makefile.check(args.path, "libft.a", root_path)
     if not args.no_forbidden_functions:

PyChecker/testing_suite/libftest.py

@@ -13,6 +13,9 @@ def run(project_path: str, root_path: str):
 
     :param project_path: The path of the project you want to test.
     """
+    print("*---------------------------------------------------------------*")
+    print("*----------------------------Libftest---------------------------*")
+    print("*---------------------------------------------------------------*")
     try:
         open("testing_suites/libftest/my_config.sh", 'r')
     except FileNotFoundError:
@@ -28,12 +31,14 @@ def run(project_path: str, root_path: str):
     result = subprocess.run(['bash', "testing_suites/libftest/grademe.sh",
                              "-l -s -f -n -u"], stdout=subprocess.PIPE,
                             stderr=subprocess.STDOUT).stdout.decode('utf-8')
-    os.rename("deepthought", ".mylibftest")
-    with open(root_path + "/.mylibftest", 'a') as file:
+    os.rename("deepthought", ".mylibftest-deepthought")
+    print("Deepthought file too big. Not printed. See `.mylibftest-deepthought'.")
+    with open(root_path + "/.mylibftest", 'w+') as file:
         file.write("*------------------------------------------------------*\n")
         file.write("LIBFTEST\n")
         file.write("Warning: This file contains escape sequences. Please use "
                    "`cat' to view it properly.\n")
         file.write("*------------------------------------------------------*\n")
         file.write(result)
-    return 0
+    print(result)
+    return 0

PyChecker/testing_suite/maintest.py

@@ -14,6 +14,9 @@ def run_libft(project_path: str, root_path: str):
 
     :param project_path: The path of the project you want to test.
     """
+    print("*---------------------------------------------------------------*")
+    print("*----------------------------Maintest---------------------------*")
+    print("*---------------------------------------------------------------*")
     # These are the functions that the maintest tests for the libft.
     maintest_functions = ['memset', 'bzero', 'memcpy', 'memccpy', 'memmove',
                           'memchr', 'memcmp', 'strlen', 'strdup', 'strcpy',
@@ -55,9 +58,11 @@ def run_libft(project_path: str, root_path: str):
                                 stdout=subprocess.PIPE,
                                 stderr=subprocess.STDOUT).stdout.decode('utf-8')
         file.write(result + '\n')
+        print(result)
         result = subprocess.run(['./libft_main.out'], stdout=subprocess.PIPE,
                                 stderr=subprocess.STDOUT).stdout.decode('utf-8')
         # @todo: Count number of OK and FAILs and yellow tests to get score for maintest
         file.write(result + '\n')
+        print(result)
     os.remove("libft_main.c")
     os.remove("libft_main.out")

PyChecker/testing_suite/moulitest.py

@@ -10,7 +10,7 @@ def include_libft_bonuses():
     """
     This method removes the `.exclude` extention to the libft bonuses files.
     """
-    moulitest_libft_tests_path = "testing_suites/moulitest/libft_tests/testing_suite"
+    moulitest_libft_tests_path = "testing_suites/moulitest/libft_tests/tests"
     files = os.listdir(moulitest_libft_tests_path)
     for file in files:
         if file[:2] == "02":
@@ -23,7 +23,7 @@ def exclude_libft_bonuses():
     """
     This method Adds the `.exclude` extention to the libft bonuses files.
     """
-    moulitest_libft_tests_path = "testing_suites/moulitest/libft_tests/testing_suite"
+    moulitest_libft_tests_path = "testing_suites/moulitest/libft_tests/tests"
     files = os.listdir(moulitest_libft_tests_path)
     for file in files:
         if file[:2] == "02":
@@ -45,9 +45,13 @@ def execute_test(test_name: str, root_path: str):
                                 stdout=subprocess.PIPE,
                                 stderr=subprocess.STDOUT).stdout.decode('utf-8')
         file.write(result + '\n')
+    print(result)
 
 
 def run(project_path: str, has_libft_bonuses: bool, project: str, root_path: str):
+    print("*---------------------------------------------------------------*")
+    print("*--------------------------Moulitest----------------------------*")
+    print("*---------------------------------------------------------------*")
     available_projects = ['ft_ls', 'ft_printf', 'gnl', 'libft', 'libftasm']
     #  Available projects checks if the given project corresponds to one the moulitest tests.
     if project not in available_projects:
@@ -63,4 +67,4 @@ def run(project_path: str, has_libft_bonuses: bool, project: str, root_path: str
             include_libft_bonuses()
         else:
             execute_test("libft_bonus", root_path)
-    return 0
+    return 0

PyChecker/utils/author.py

@@ -18,6 +18,9 @@ def check(project_path: str):
      3 if the newline char is missing in the end of line
     """
     # @todo message and handle multiple authors
+    print("*---------------------------------------------------------------*")
+    print("*--------------------------Author file--------------------------*")
+    print("*---------------------------------------------------------------*")
     author_fr = project_path + "/auteur"
     author_us = project_path + "/author"
     if os.path.exists(author_fr):
@@ -27,21 +30,22 @@ def check(project_path: str):
         count = len(open(author_us).readlines())
         author = "us"
     else:
-        print("Author file not found")
+        print("--> Error: Author file not found")
         return 1
     if count != 1:
-        print("Too many lines in author file (Or the file is empty)")
+        print("--> Error: Too many lines in author file (Or the file is empty)")
         return 2
     if author == "fr":
         with open(author_fr, 'r') as file:
             content = file.read()
             if "\n" not in content:
-                print("Missing <newline> character at the end of line")
+                print("--> Error: Missing <newline> character at the end of line")
                 return 3
     elif author == "us":
         with open(author_us, 'r') as file:
             content = file.read()
             if "\n" not in content:
-                print("Missing <newline> character at the end of line")
+                print("--> Error: Missing <newline> character at the end of line")
                 return 3
+    print("-- NTR (Nothing to Report)")
     return 0

PyChecker/utils/forbidden_functions.py

@@ -16,6 +16,9 @@ def check(project_path: str, binary: str, authorized_func, root_path: str):
     :param binary_name: The binary that you want to analyze
     :param authorized_func: The functions authorized by the project.
     """
+    print("*---------------------------------------------------------------*")
+    print("*----------------------Forbidden functions:---------------------*")
+    print("*---------------------------------------------------------------*")
     functions_called = []
     # @todo Check difference between Darwin and Linux `nm'
     result = subprocess.run(['nm', project_path + '/' + binary],
@@ -32,4 +35,5 @@ def check(project_path: str, binary: str, authorized_func, root_path: str):
             # This is to ignore functions like `__stack_chk_fail'
             if not item.startswith("__"):
                 file.write("You should justify the use of this function: `{}'\n".format(item))
+                print("You should justify the use of this function: `{}'".format(item))
     return 0