test: enable copyright header checks in linting (#44)

Author: bessbd

.pylintrc

@@ -11,7 +11,8 @@ limit-inference-results=100
 
 # List of plugins (as comma separated values of python module names) to load,
 # usually to register additional checkers.
-#load-plugins=
+load-plugins=copyright-checker,
+             license-checker
 
 # Pickle collected data for later comparisons.
 persistent=yes

ibmcloudant/common.py

@@ -1,6 +1,6 @@
 # coding: utf-8
 
-# © Copyright IBM Corporation 2020.
+# © Copyright IBM Corporation 2020, 2021.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -23,25 +23,26 @@
 USER_AGENT_HEADER = 'User-Agent'
 SDK_NAME = 'cloudant-python-sdk'
 
-# pylint: disable=missing-function-docstring
-def get_system_info():
+
+def get_system_info():  # pylint: disable=missing-docstring
     return '{0} {1} {2}'.format(platform.system(),  # OS
                                 platform.release(),  # OS version
                                 platform.python_version())  # Python version
 
-# pylint: disable=missing-function-docstring
-def get_user_agent():
+
+def get_user_agent():  # pylint: disable=missing-docstring
     return user_agent
 
-# pylint: disable=missing-function-docstring
-def get_sdk_analytics(service_name, service_version, operation_id):
+
+def get_sdk_analytics(service_name, service_version, operation_id):  # pylint: disable=missing-docstring
     return 'service_name={0};service_version={1};operation_id={2}'.format(
         service_name, service_version, operation_id)
 
+
 user_agent = '{0}-{1} {2}'.format(SDK_NAME, __version__, get_system_info())
 
-# pylint: disable=missing-function-docstring
-def get_sdk_headers(service_name, service_version, operation_id):
+
+def get_sdk_headers(service_name, service_version, operation_id):  # pylint: disable=missing-docstring
     headers = {}
     headers[SDK_ANALYTICS_HEADER] = get_sdk_analytics(service_name, service_version, operation_id)
     headers[USER_AGENT_HEADER] = get_user_agent()

ibmcloudant/couchdb_session_base_service_patch.py

@@ -1,6 +1,6 @@
 # coding: utf-8
 
-# © Copyright IBM Corporation 2020.
+# © Copyright IBM Corporation 2020, 2021.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -27,8 +27,8 @@
 
 old_init = CloudantV1.__init__
 
-# pylint: disable=missing-function-docstring
-def new_init(self, authenticator: Authenticator = None):
+
+def new_init(self, authenticator: Authenticator = None):  # pylint: disable=missing-docstring
     old_init(self, authenticator)
     if isinstance(authenticator, CouchDbSessionAuthenticator):
         # Replacing BaseService's http.cookiejar.CookieJar as RequestsCookieJar supports update(CookieJar)
@@ -38,8 +38,8 @@ def new_init(self, authenticator: Authenticator = None):
 
 old_set_service_url = CloudantV1.set_service_url
 
-# pylint: disable=missing-function-docstring
-def new_set_service_url(self, service_url: str):
+
+def new_set_service_url(self, service_url: str):  # pylint: disable=missing-docstring
     old_set_service_url(self, service_url)
     try:
         if isinstance(self.authenticator, CouchDbSessionAuthenticator):
@@ -50,8 +50,8 @@ def new_set_service_url(self, service_url: str):
 
 old_set_default_headers = CloudantV1.set_default_headers
 
-# pylint: disable=missing-function-docstring
-def new_set_default_headers(self, headers: Dict[str, str]):
+
+def new_set_default_headers(self, headers: Dict[str, str]):  # pylint: disable=missing-docstring
     old_set_default_headers(self, headers)
     if isinstance(self.authenticator, CouchDbSessionAuthenticator):
         combined_headers = {}
@@ -66,8 +66,8 @@ def new_set_default_headers(self, headers: Dict[str, str]):
 
 old_set_disable_ssl_verification = CloudantV1.set_disable_ssl_verification
 
-# pylint: disable=missing-function-docstring
-def new_set_disable_ssl_verification(self, status: bool = False) -> None:
+
+def new_set_disable_ssl_verification(self, status: bool = False) -> None:  # pylint: disable=missing-docstring
     old_set_disable_ssl_verification(self, status)
     if isinstance(self.authenticator, CouchDbSessionAuthenticator):
         self.authenticator.token_manager.set_disable_ssl_verification(status)

ibmcloudant/couchdb_session_get_authenticator_patch.py

@@ -1,6 +1,6 @@
 # coding: utf-8
 
-# © Copyright IBM Corporation 2020.
+# © Copyright IBM Corporation 2020, 2021.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -21,8 +21,8 @@
 
 old_construct_authenticator = get_authenticator.__construct_authenticator
 
-# pylint: disable=missing-function-docstring
-def new_construct_authenticator(config):
+
+def new_construct_authenticator(config):  # pylint: disable=missing-docstring
     auth_type = config.get('AUTH_TYPE').upper() if config.get('AUTH_TYPE') else ''
     if auth_type == 'COUCHDB_SESSION':
         return CouchDbSessionAuthenticator(

pylint/checkers/copyright-checker.py

@@ -0,0 +1,54 @@
+#!/usr/bin/env python
+# coding: utf-8
+
+# © Copyright IBM Corporation 2021.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import re
+
+from pylint.interfaces import IRawChecker, HIGH
+from pylint.checkers import BaseChecker
+
+
+class CopyrightChecker(BaseChecker):
+    """
+    Check for copyright header
+    """
+
+    __implements__ = IRawChecker
+
+    name = 'copyright-checker'
+    msgs = {'E9902': ('Include or fix copyright in file',
+                      'file-no-copyright',
+                      'Your file has no copyright or it needs to be fixed'),
+            }
+    options = ()
+
+    def process_module(self, node):
+        ibm_copyright_regex = r'^# © Copyright IBM Corporation 20\d\d(?:, 20\d\d)?\.$'
+        ibm_generated_copyright_regex = r'^# \(C\) Copyright IBM Corp\. 20\d\d\.$'
+        with node.stream() as stream:
+            for (lineno, raw_actual_line) in enumerate(stream):
+                actual_line = raw_actual_line.decode("utf-8").strip()
+                if actual_line == '':
+                    continue
+                if actual_line[0] != '#':
+                    self.add_message('file-no-copyright', line=lineno, confidence=HIGH)
+                    break
+                if re.match(ibm_copyright_regex, actual_line) or re.match(ibm_generated_copyright_regex, actual_line):
+                    break
+
+
+def register(linter):
+    linter.register_checker(CopyrightChecker(linter))

pylint/checkers/license-checker.py

@@ -0,0 +1,66 @@
+#!/usr/bin/env python
+# coding: utf-8
+
+# © Copyright IBM Corporation 2021.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from pylint.interfaces import IRawChecker, HIGH
+from pylint.checkers import BaseChecker
+
+LICENSE_HEADER = """
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+""".strip().split("\n")
+
+
+class LicenseChecker(BaseChecker):
+    """
+    Check for license header
+    """
+
+    __implements__ = IRawChecker
+
+    name = 'license-checker'
+    msgs = {'E9903': ('Include or fix license header in file',
+                      'file-no-license',
+                      'Your file has no license or it needs to be fixed'),
+            }
+    options = ()
+
+    def process_module(self, node):
+        i = 0
+        with node.stream() as stream:
+            for (lineno, raw_actual_line) in enumerate(stream):
+                actual_line = raw_actual_line.decode("utf-8").strip()
+                if actual_line == '':
+                    continue
+                if actual_line[0] != '#' and i != len(LICENSE_HEADER):
+                    self.add_message('file-no-license', line=lineno, confidence=HIGH)
+                    break
+                if i < len(LICENSE_HEADER) and actual_line == LICENSE_HEADER[i]:
+                    i += 1
+                    continue
+
+
+def register(linter):
+    linter.register_checker(LicenseChecker(linter))

tox.ini

@@ -5,6 +5,7 @@ envlist = py37-lint, py35, py36, py37, py38
 basepython = python3.7
 deps = pylint
 commands = pylint --rcfile=.pylintrc ibmcloudant test
+setenv = PYTHONPATH = pylint/checkers
 
 [testenv]
 passenv = TOXENV CI TRAVIS*