[test] Setup CI with GitHub Actions (#8)

Author: slarse

.flake8

@@ -0,0 +1,2 @@
+[flake8]
+ignore = W503,E203

.github/workflows/python-app.yml

@@ -0,0 +1,39 @@
+# This workflow will install Python dependencies, run tests and lint with a single version of Python
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
+
+name: repobee-sanitizer
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [3.6, 3.7, 3.8]
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install flake8 pytest
+        pip install -e .[TEST]
+    - name: Lint with flake8
+      run: |
+        # stop the build if there are Python syntax errors or undefined names
+        flake8 . --count --show-source --statistics
+        # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
+        flake8 . --count --exit-zero --max-complexity=10 --max-line-length=79 --statistics
+    - name: Test with pytest
+      run: |
+        pytest -vv tests/

repobee_sanitizer/__init__.py

@@ -1,3 +1 @@
-
-
-from .__version import __version__
+from .__version import __version__  # noqa: F401

repobee_sanitizer/sanitizer.py

@@ -1,15 +1,12 @@
 """The plugin module for repobee-sanitizer.
 
 .. module:: sanitizer
-    :synopsis: A plugin for RepoBee to sanitize master repositories before being pushed to students.
+    :synopsis: A plugin for RepoBee to sanitize master repositories before
+        being pushed to students.
 
 .. moduleauthor:: Simon Larsén
 """
 
-import pathlib
-import os
-
-
 import argparse
 import configparser
 from typing import List, Mapping, Optional
@@ -53,7 +50,9 @@ def _callback(
         # do whatever you want to do!
         return {
             PLUGIN_NAME: [
-                plug.Result(name=PLUGIN_NAME, status=plug.Status.SUCCESS, msg=str(args))
+                plug.Result(
+                    name=PLUGIN_NAME, status=plug.Status.SUCCESS, msg=str(args)
+                )
             ]
         }
 
@@ -66,7 +65,9 @@ def config_hook(self, config_parser: configparser.ConfigParser) -> None:
         if PLUGIN_NAME not in config_parser:
             return
 
-        self._name = config_parser.get(PLUGIN_NAME, "name", fallback=self._name)
+        self._name = config_parser.get(
+            PLUGIN_NAME, "name", fallback=self._name
+        )
         self._age = config_parser.get(PLUGIN_NAME, "age", fallback=self._age)
 
     def create_extension_command(self) -> plug.ExtensionCommand:
@@ -99,4 +100,3 @@ def create_extension_command(self) -> plug.ExtensionCommand:
                 plug.BaseParser.STUDENTS,
             ],
         )
-

setup.py

@@ -5,11 +5,7 @@
     readme = f.read()
 
 # parse the version instead of importing it to avoid dependency-related crashes
-with open(
-    "repobee_sanitizer/__version.py",
-    mode="r",
-    encoding="utf-8",
-) as f:
+with open("repobee_sanitizer/__version.py", mode="r", encoding="utf-8",) as f:
     line = f.readline()
     __version__ = line.split("=")[1].strip(" '\"\n")
     assert re.match(r"^\d+(\.\d+){2}(-(alpha|beta|rc)(\.\d+)?)?$", __version__)
@@ -20,14 +16,13 @@
 setup(
     name="repobee-sanitizer",
     version=__version__,
-    description="A plugin for RepoBee to sanitize master repositories before being pushed to students",
+    description="A plugin for RepoBee to sanitize master repositories before "
+    "being pushed to students",
     long_description=readme,
     long_description_content_type="text/markdown",
     author="Simon Larsén",
     author_email="[email protected]",
-    url="https://github.com/"
-    "repobee"
-    "/repobee-sanitizer",
+    url="https://github.com/" "repobee" "/repobee-sanitizer",
     download_url="https://github.com/"
     "repobee"
     "/repobee-sanitizer"

tests/test_file_sanitizer.py

@@ -66,8 +66,8 @@ def read_valid_test_case_files(test_case_dir: pathlib.Path) -> Tuple[str, str]:
     "inp", INVALID_TEST_CASE_ARGS, ids=INVALID_TEST_CASE_IDS
 )
 def test_sanitize_invalid(inp: str):
-    with pytest.Raises(plug.PlugError("Invalid marker syntax")):
-        assert _sanitize_file.sanitize(inp)
+    with pytest.raises(plug.PlugError):
+        _sanitize_file.sanitize(inp)
 
 
 @pytest.mark.parametrize(