Added unit tests

Author: HaaLeo

.travis.yml

@@ -18,6 +18,7 @@ jobs:
     - stage: test
       script:
         - python -m pylint ./*/*.py
+        - pytest --cov pylintfileheader pylintfileheadertest
     - stage: bundle
       script:
         - cp ThirdPartyNotices.txt ./pylintfileheader
@@ -36,3 +37,6 @@ jobs:
         skip_cleanup: true
         on:
           tags: true
+
+after_success:
+  - codecov

.vscode/settings.json

@@ -9,5 +9,16 @@
         "msgs",
         "rcfile"
     ],
-    "files.eol": "\n"
+    "cSpell.ignorePaths": [
+        "**/.git/**",
+        ".vscode",
+        ".pylintrc"
+    ],
+    "files.eol": "\n",
+    "python.unitTest.pyTestArgs": [
+        "pylintfileheadertest"
+    ],
+    "python.unitTest.unittestEnabled": false,
+    "python.unitTest.nosetestsEnabled": false,
+    "python.unitTest.pyTestEnabled": true
 }

pylintfileheadertest/__init__.py

@@ -0,0 +1,4 @@
+# ---------------------------------------------------------------------------------------------
+#  Copyright (c) Leo Hanisch. All rights reserved.
+#  Licensed under the MIT License. See LICENSE.txt in the project root for license information.
+# ---------------------------------------------------------------------------------------------

pylintfileheadertest/file_header_checker_test.py

@@ -0,0 +1,53 @@
+# ---------------------------------------------------------------------------------------------
+#  Copyright (c) Leo Hanisch. All rights reserved.
+#  Licensed under the MIT License. See LICENSE.txt in the project root for license information.
+# ---------------------------------------------------------------------------------------------
+
+# pylint: disable=invalid-name,unused-variable
+from unittest.mock import MagicMock
+import pylint.testutils
+from pylintfileheader.file_header_checker import FileHeaderChecker
+
+
+class TestFileHeaderChecker(pylint.testutils.CheckerTestCase):
+    CHECKER_CLASS = FileHeaderChecker
+    CONFIG = {'file_header': '# Valid\n# Header'}
+
+    def test_valid_header_no_message_added(self):
+        """Test whether no message is added, when the file header is valid."""
+
+        node_mock = MagicMock()
+        node_mock.stream.return_value.__enter__.return_value.read.return_value.decode.return_value = '# Valid\n# Header'
+        with self.assertNoMessages():
+            self.checker.process_module(node_mock)
+
+    def test_invalid_header_message_added(self):
+        """Test whether no message is added, when the file header is valid."""
+
+        node_mock = MagicMock()
+        node_mock.stream.return_value.__enter__.return_value.read.return_value.decode.return_value = '# Invalid\n# Header'
+        with self.assertAddsMessages(pylint.testutils.Message(
+                msg_id='invalid-file-header',
+                line=1,
+                args='# Valid\n# Header')):
+            self.checker.process_module(node_mock)
+
+    def test_valid_header_not_at_top_message_added(self):
+        """Test whether no message is added, when the file header is valid."""
+
+        node_mock = MagicMock()
+        node_mock.stream.return_value.__enter__.return_value.read.return_value.decode.return_value = 'print(\'hello\')\n# Valid\n# Header'
+        with self.assertAddsMessages(pylint.testutils.Message(
+                msg_id='invalid-file-header',
+                line=1,
+                args='# Valid\n# Header')):
+            self.checker.process_module(node_mock)
+
+    def test_config_empty_no_message_added(self):
+        """When the `file-header` option is not set, no message should be added."""
+
+        self.checker.config.file_header = None
+        node_mock = MagicMock()
+        node_mock.stream.return_value.__enter__.return_value.read.return_value.decode.return_value = '# Invalid\n# Header'
+        with self.assertNoMessages():
+            self.checker.process_module(node_mock)

requirements-dev.txt

@@ -1,8 +1,12 @@
 -r requirements.txt
 
+codecov
+mock
 pylint
 pylint-quotes
 pylintfileheader
+pytest
+pytest-cov
 # Requires those versions because of https://stackoverflow.com/a/26737258/6925187
 setuptools>=38.6.0
 twine>=1.11.0