Modernize package for 2020 (#1)

- move the code to the new folder
- use black linter and check it in CI
- remove unused build scripts
- switch from gtest to googletest
- use pipenv for easy setup
- add github actions for checking this code

Author: niosus

.github/workflows/main.yml

@@ -0,0 +1,29 @@
+name: CI
+
+on: [push]
+
+jobs:
+  test:
+    runs-on: ubuntu-20.04
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: '3.8'
+        architecture: 'x64'
+    - name: Install prerequisites
+      run: |
+        sudo apt install -y libgtest-dev
+        python -m pip install --upgrade pip pipenv
+    - name: Initialize workspace
+      run: >
+        pipenv install
+    - name: Lint with Black linter
+      run: >
+        pipenv run black homework_checker --check --diff
+    - name: Run unit tests
+      run: >
+        pipenv run python3 -m unittest discover -v homework_checker/tests/
+

.gitignore

@@ -22,3 +22,5 @@ build/
 /.coverage
 
 /coverage.xml
+
+!Pipfile

.gitlab-ci.yml

@@ -0,0 +1,16 @@
+[[source]]
+url = "https://pypi.org/simple"
+verify_ssl = true
+name = "pypi"
+
+[packages]
+"ruamel.yaml" = "*"
+schema = "*"
+cpplint = "*"
+datetime = "*"
+black = "*"
+
+[dev-packages]
+
+[requires]
+python_version = "3.8"

.travis.yml

@@ -0,0 +1,12 @@
+"""Homework checker module."""
+
+name = "homework_checker"
+
+__all__ = (
+    "check_homework",
+    "checker",
+    "md_writer",
+    "schema_manager",
+    "schema_tags",
+    "tasks" "tools" "tests",
+)

Pipfile

@@ -16,21 +16,21 @@ def main():
     """Run this script."""
     parser = argparse.ArgumentParser()
     parser.add_argument(
-        '-v', '--verbose',
-        help='Make the output verbose.',
-        action='store_true')
+        "-v", "--verbose", help="Make the output verbose.", action="store_true"
+    )
     parser.add_argument(
-        '-i', '--input',
-        help='An input *.yml file with the job definition.',
-        required=True)
+        "-i",
+        "--input",
+        help="An input *.yml file with the job definition.",
+        required=True,
+    )
     parser.add_argument(
-        '-o', '--output',
-        help='An output *.md file with the results.',
-        required=True)
+        "-o", "--output", help="An output *.md file with the results.", required=True
+    )
     args = parser.parse_args()
     if args.verbose:
         log.setLevel(logging.DEBUG)
-        log.debug('Enable DEBUG logging.')
+        log.debug("Enable DEBUG logging.")
     # Read the job file.
     log.debug('Reading from file "%s"', args.input)
     checker = Checker(args.input)

Pipfile.lock

@@ -16,15 +16,17 @@
 
 class Checker:
     """Check homework."""
-    TESTS_TAG = 'tests'
+
+    TESTS_TAG = "tests"
 
     def __init__(self, job_file_path):
         """Initialize the checker from file."""
         self._job_file_path = tools.expand_if_needed(job_file_path)
         schema_manager = SchemaManager(self._job_file_path)
         self._base_node = schema_manager.validated_yaml
         self._checked_code_folder = tools.expand_if_needed(
-            self._base_node[Tags.FOLDER_TAG])
+            self._base_node[Tags.FOLDER_TAG]
+        )
         # The results of all tests will be kept here.
         self._results = {}
 
@@ -33,22 +35,23 @@ def check_homework(self):
         results = {}
         for homework_node in self._base_node[Tags.HOMEWORKS_TAG]:
             current_folder = path.join(
-                self._checked_code_folder, homework_node[Tags.FOLDER_TAG])
+                self._checked_code_folder, homework_node[Tags.FOLDER_TAG]
+            )
             if not path.exists(current_folder):
-                log.warning("Folder '%s' does not exist. Skiping.",
-                            current_folder)
+                log.warning("Folder '%s' does not exist. Skiping.", current_folder)
                 continue
             hw_name = homework_node[Tags.NAME_TAG]
             results[hw_name] = {}
             deadline_str = homework_node[Tags.DEADLINE_TAG]
-            deadline_datetime = datetime.strptime(deadline_str,
-                                                  tools.DATE_PATTERN)
+            deadline_datetime = datetime.strptime(deadline_str, tools.DATE_PATTERN)
             if datetime.now() > deadline_datetime:
                 results[hw_name][tools.EXPIRED_TAG] = True
             for task_node in homework_node[Tags.TASKS_TAG]:
-                task = Task.from_yaml_node(task_node=task_node,
-                                           student_hw_folder=current_folder,
-                                           job_file=self._job_file_path)
+                task = Task.from_yaml_node(
+                    task_node=task_node,
+                    student_hw_folder=current_folder,
+                    job_file=self._job_file_path,
+                )
                 if not task:
                     continue
                 results[hw_name][task.name] = task.check_all_tests()

homework_checker/__init__.py

@@ -36,12 +36,14 @@ class MdWriter:
 
     def __init__(self):
         """Initialize the writer."""
-        self._md_table = TABLE_TEMPLATE.format(hw_name='Homework Name',
-                                               task_name='Task Name',
-                                               test_name='Test Name',
-                                               result_sign='Result')
+        self._md_table = TABLE_TEMPLATE.format(
+            hw_name="Homework Name",
+            task_name="Task Name",
+            test_name="Test Name",
+            result_sign="Result",
+        )
         self._md_table += TABLE_SEPARATOR
-        self._errors = ''  # Markdown part with errors.
+        self._errors = ""  # Markdown part with errors.
 
     def update(self, hw_results):
         """Update the table of completion."""
@@ -58,34 +60,30 @@ def update(self, hw_results):
                     continue
                 need_task_name = True
                 for test_name, test_result in sorted(ex_dict.items()):
-                    result_sign = SUCCESS_TAG \
-                        if test_result.succeeded() \
-                        else FAILED_TAG
-                    extended_hw_name = hw_name + " `[PAST DEADLINE]`" \
-                        if expired else hw_name
+                    result_sign = SUCCESS_TAG if test_result.succeeded() else FAILED_TAG
+                    extended_hw_name = (
+                        hw_name + " `[PAST DEADLINE]`" if expired else hw_name
+                    )
                     self._md_table += TABLE_TEMPLATE.format(
-                        hw_name=extended_hw_name if need_hw_name else '',
-                        task_name=task_name if need_task_name else '',
+                        hw_name=extended_hw_name if need_hw_name else "",
+                        task_name=task_name if need_task_name else "",
                         test_name=test_name,
-                        result_sign=result_sign)
-                    self._add_error(hw_name,
-                                    task_name,
-                                    test_name,
-                                    test_result,
-                                    expired)
+                        result_sign=result_sign,
+                    )
+                    self._add_error(hw_name, task_name, test_name, test_result, expired)
                     need_hw_name = False  # We only print homework name once.
                     need_task_name = False  # We only print Task name once.
 
     def write_md_file(self, md_file_path):
         """Write all the added content to the md file."""
-        md_file_content = '# Test results\n'
+        md_file_content = "# Test results\n"
         md_file_content += self._md_table
         if self._errors:
-            md_file_content += '\n## Encountered errors\n'
+            md_file_content += "\n## Encountered errors\n"
             md_file_content += self._errors
         md_file_content += SEPARATOR
         md_file_content += FINISHING_NOTE
-        with open(md_file_path, 'w') as md_file:
+        with open(md_file_path, "w") as md_file:
             md_file.write(md_file_content)
 
     def _add_error(self, hw_name, task_name, test_name, test_result, expired):
@@ -95,8 +93,10 @@ def _add_error(self, hw_name, task_name, test_name, test_result, expired):
         if expired:
             self._errors += EXPIRED_TEMPLATE.format(hw_name=hw_name)
             return
-        self._errors += ERROR_TEMPLATE.format(hw_name=hw_name,
-                                              task_name=task_name,
-                                              test_name=test_name,
-                                              stderr=test_result.stderr,
-                                              stdout=test_result.stdout)
+        self._errors += ERROR_TEMPLATE.format(
+            hw_name=hw_name,
+            task_name=task_name,
+            test_name=test_name,
+            stderr=test_result.stderr,
+            stdout=test_result.stdout,
+        )