feat userver: check for *.sleep() in .py tests

commit_hash:6b46431b39e48616b9167d2c76ae583afded5d59

Author: segoon

.mapping.json

@@ -4619,6 +4619,9 @@
   "scripts/proto_structs/templates/types.inc.jinja":"taxi/uservices/userver/scripts/proto_structs/templates/types.inc.jinja",
   "scripts/proto_structs/templates/types_forward_declarations.inc.jinja":"taxi/uservices/userver/scripts/proto_structs/templates/types_forward_declarations.inc.jinja",
   "scripts/proto_structs/templates/utils.inc.jinja":"taxi/uservices/userver/scripts/proto_structs/templates/utils.inc.jinja",
+  "scripts/pylint/pylint_all.sh":"taxi/uservices/userver/scripts/pylint/pylint_all.sh",
+  "scripts/pylint/pylint_sleep_plugin.py":"taxi/uservices/userver/scripts/pylint/pylint_sleep_plugin.py",
+  "scripts/pylint/requirements.txt":"taxi/uservices/userver/scripts/pylint/requirements.txt",
   "scripts/rabbitmq/ubuntu_install_rabbitmq_dev.sh":"taxi/uservices/userver/scripts/rabbitmq/ubuntu_install_rabbitmq_dev.sh",
   "scripts/rabbitmq/ubuntu_install_rabbitmq_server.sh":"taxi/uservices/userver/scripts/rabbitmq/ubuntu_install_rabbitmq_server.sh",
   "scripts/sql/__init__.py":"taxi/uservices/userver/scripts/sql/__init__.py",

CMakeLists.txt

@@ -366,6 +366,18 @@ if(USERVER_BUILD_TESTS)
             "-DUSERVER_GOOGLE_COMMON_PROTOS=${USERVER_GOOGLE_COMMON_PROTOS} -DUSERVER_DOWNLOAD_PACKAGES=${USERVER_DOWNLOAD_PACKAGES}"
         )
     endif()
+
+    include(UserverVenv)
+    userver_venv_setup(
+        NAME sleep_in_tests
+        PYTHON_OUTPUT_VAR PYTHON_BINARY
+        REQUIREMENTS "${USERVER_ROOT_DIR}/scripts/pylint/requirements.txt"
+        UNIQUE
+    )
+    add_test(NAME sleep-in-tests
+        COMMAND
+	    env PYTHON_BINARY=${PYTHON_BINARY} PYTHONPATH="${USERVER_ROOT_DIR}" "${USERVER_ROOT_DIR}/scripts/pylint/pylint_all.sh"
+    )
 endif()
 
 _userver_add_target_gen_component_schemas_docs()

scripts/pylint/pylint_all.sh

@@ -0,0 +1,17 @@
+#!/bin/sh
+
+ROOT=$(dirname $0)/../..
+export PYTHONPATH="$ROOT/scripts/pylint" 
+# set -e
+
+find "$ROOT" -name '*.py' | \
+    grep -v '^./build*' | \
+    grep test | \
+xargs $PYTHON_BINARY -m pylint \
+    --load-plugins=pylint_sleep_plugin \
+    --disable all \
+    --enable sleep-in-test \
+    --ignore-paths ".*venv.*"
+    ${PY_FILES}
+
+echo >&2 "Note: forcing test success (the test is not yet ready)"

scripts/pylint/pylint_sleep_plugin.py

@@ -0,0 +1,42 @@
+from pylint.checkers import BaseRawFileChecker
+
+
+def read_from_node(node):
+    return [line.decode('utf-8') for line in node.stream().readlines()]
+
+
+class SleepChecker(BaseRawFileChecker):
+    name = 'sleep-in-test'
+    priority = -1
+    msgs = {
+        'E9901': (
+            (
+                'Do not use %s in tests for synchronization! '
+                'It only hides the problem and leads to flaky tests. '
+                'If you have to wait for an event, either use testpoints '
+                'or wait*() from pytest_userver.utils.sync module.'
+            ),
+            'sleep-in-test',
+            'Tests should not use *.sleep() functions for synchronization.',
+        ),
+    }
+
+    def process_module(self, node):
+        file_content = read_from_node(node)
+        for line_num, line in enumerate(file_content):
+            for func in ('time.sleep', 'asyncio.sleep'):
+                self.check_line(line_num, line, func)
+
+    def check_line(self, line_num: int, line: str, func: str):
+        if func not in line:
+            return
+
+        self.add_message(
+            'sleep-in-test',
+            line=line_num,
+            args=func,
+        )
+
+
+def register(linter):
+    linter.register_checker(SleepChecker(linter))

scripts/pylint/requirements.txt

@@ -0,0 +1 @@
+pylint