[Typing] 在 Paddle/test 中增加 Paddle/tools 的单测 (#65905)

megemini · SigureMo · web-flow · commit d2d4e8300b1e · 2024-07-22T12:10:47.000+08:00
* [Add] test for Paddle/tools

* [Fix] CMakeLists.txt ENVS

* [Change] remove test no multiprocessing

* [Change] skip gpu test if need

* [Fix] example on win

* [Fix] example on win/mac with __main__

* [Fix] skip multiprocessing checking on win/mac and opt timeout test time

* [Fix] use while instead of time.sleep

* [Fix] close queue

* [tmp] skip time_out

* [Change] timeout more

* [Change] cmake timeout more

* [Change] test without coverage

* [Change] test without coverage

* [Change] test timeout

* [Change] only on linux

---------

Co-authored-by: SigureMo &lt;sigure.qaq@gmail.com&gt;
diff --git a/test/CMakeLists.txt b/test/CMakeLists.txt
@@ -190,6 +190,10 @@ if(WITH_TESTING)
   if(WITH_XPU)
     add_subdirectory(xpu)
   endif()
+
+  # add tests for scripts from `Paddle/tools`
+  add_subdirectory(tools)
+
 endif()
 
 if(WITH_CPP_DIST)
diff --git a/test/tools/CMakeLists.txt b/test/tools/CMakeLists.txt
@@ -0,0 +1,15 @@
+file(
+  GLOB TEST_OPS
+  RELATIVE "${CMAKE_CURRENT_SOURCE_DIR}"
+  "test_*.py")
+string(REPLACE ".py" "" TEST_OPS "${TEST_OPS}")
+
+if((NOT WITH_COVERAGE) AND (LINUX))
+  foreach(TEST_OP ${TEST_OPS})
+    py_test_modules(${TEST_OP} MODULES ${TEST_OP} ENVS
+                    PYTHONPATH=${PADDLE_SOURCE_DIR}/tools)
+  endforeach()
+
+  set_tests_properties(test_sampcd_processor PROPERTIES TIMEOUT 300)
+  set_tests_properties(test_type_checking PROPERTIES TIMEOUT 200)
+endif()
diff --git a/test/tools/test_sampcd_processor.py b/test/tools/test_sampcd_processor.py
@@ -16,6 +16,8 @@
 
 import importlib
 import os
+import sys
+import tempfile
 import unittest
 
 import xdoctest
@@ -27,14 +29,16 @@
     get_test_results,
 )
 
+from paddle.base import core
+
 
 def _clear_environ():
     for k in {'CPU', 'GPU', 'XPU', 'DISTRIBUTED'}:
         if k in os.environ:
             del os.environ[k]
 
 
-class Test_TestResult(unittest.TestCase):
+class TestTestResult(unittest.TestCase):
     def test_good_result(self):
         r = _TestResult(name='good', passed=True)
         self.assertTrue(r.passed)
@@ -79,11 +83,29 @@ def test_bad_result(self):
             r = _TestResult(name='good', passed=True, bad=True)
 
 
-class Test_get_api_md5(unittest.TestCase):
+class TestSpecFile(unittest.TestCase):
     def setUp(self):
-        self.api_pr_spec_filename = os.path.abspath(
-            os.path.join(os.getcwd(), "..", 'paddle/fluid/API_PR.spec')
+        self.temp_dir = tempfile.TemporaryDirectory()
+        self.api_dev_spec_filename = os.path.join(
+            self.temp_dir.name, 'API_DEV.spec'
+        )
+        self.api_pr_spec_filename = os.path.join(
+            self.temp_dir.name, 'API_PR.spec'
+        )
+        self.api_diff_spec_filename = os.path.join(
+            self.temp_dir.name, 'dev_pr_diff_api.spec'
         )
+        self.init_file()
+
+    def tearDown(self):
+        self.temp_dir.cleanup()
+
+    def init_file(self):
+        raise NotImplementedError
+
+
+class TestGetApiMd5(TestSpecFile):
+    def init_file(self):
         with open(self.api_pr_spec_filename, 'w') as f:
             f.write(
                 "\n".join(
@@ -97,11 +119,8 @@ def setUp(self):
                 )
             )
 
-    def tearDown(self):
-        os.remove(self.api_pr_spec_filename)
-
     def test_get_api_md5(self):
-        res = get_api_md5('paddle/fluid/API_PR.spec')
+        res = get_api_md5(self.api_pr_spec_filename)
         self.assertEqual(
             "ArgSpec(args=[], varargs=None, keywords=None, defaults=(,)), ff0f188c95030158cc6398d2a6c55one",
             res['paddle.one_plus_one'],
@@ -123,11 +142,8 @@ def test_get_api_md5(self):
         )
 
 
-class Test_get_incrementapi(unittest.TestCase):
-    def setUp(self):
-        self.api_pr_spec_filename = os.path.abspath(
-            os.path.join(os.getcwd(), "..", 'paddle/fluid/API_PR.spec')
-        )
+class TestGetIncrementApi(TestSpecFile):
+    def init_file(self):
         with open(self.api_pr_spec_filename, 'w') as f:
             f.write(
                 "\n".join(
@@ -139,9 +155,7 @@ def setUp(self):
                     ]
                 )
             )
-        self.api_dev_spec_filename = os.path.abspath(
-            os.path.join(os.getcwd(), "..", 'paddle/fluid/API_DEV.spec')
-        )
+
         with open(self.api_dev_spec_filename, 'w') as f:
             f.write(
                 "\n".join(
@@ -150,17 +164,13 @@ def setUp(self):
                     ]
                 )
             )
-        self.api_diff_spec_filename = os.path.abspath(
-            os.path.join(os.getcwd(), "dev_pr_diff_api.spec")
-        )
-
-    def tearDown(self):
-        os.remove(self.api_pr_spec_filename)
-        os.remove(self.api_dev_spec_filename)
-        os.remove(self.api_diff_spec_filename)
 
-    def test_it(self):
-        get_incrementapi()
+    def test_get_incrementapi(self):
+        get_incrementapi(
+            api_dev_spec_fn=self.api_dev_spec_filename,
+            api_pr_spec_fn=self.api_pr_spec_filename,
+            api_diff_spec_fn=self.api_diff_spec_filename,
+        )
         with open(self.api_diff_spec_filename, 'r') as f:
             lines = f.readlines()
             self.assertCountEqual(
@@ -280,8 +290,6 @@ def test_prepare(self):
         doctester.prepare(test_capacity)
         self.assertTrue(os.environ['CPU'])
         self.assertTrue(os.environ['GPU'])
-        self.assertFalse(os.environ.get('cpu'))
-        self.assertFalse(os.environ.get('gpu'))
         self.assertFalse(os.environ.get('XPU'))
 
         _clear_environ()
@@ -491,7 +499,11 @@ def test_global_exec(self):
         self.assertIn('after_enable_static', tr_2.name)
         self.assertTrue(tr_2.passed)
 
-    def test_patch_xdoctest(self):
+    @unittest.skipIf(
+        not core.is_compiled_with_cuda() or core.is_compiled_with_rocm(),
+        "core is not compiled with CUDA",
+    )
+    def test_patch_xdoctest_place(self):
         # test patch tensor place
         _clear_environ()
 
@@ -680,6 +692,11 @@ def test_patch_xdoctest(self):
         self.assertIn('cpu_to_gpu_array', tr_5.name)
         self.assertFalse(tr_5.passed)
 
+    @unittest.skipIf(
+        not core.is_compiled_with_cuda() or core.is_compiled_with_rocm(),
+        "core is not compiled with CUDA",
+    )
+    def test_patch_xdoctest_float(self):
         # test patch float precision
         # reload xdoctest.checker
         importlib.reload(xdoctest.checker)
@@ -1844,24 +1861,6 @@ def test_multiprocessing_xdoctester(self):
         self.assertIn('static_1', tr_1.name)
         self.assertTrue(tr_1.passed)
 
-        _clear_environ()
-
-        test_capacity = {'cpu'}
-        doctester = Xdoctester(use_multiprocessing=False)
-        doctester.prepare(test_capacity)
-
-        test_results = get_test_results(doctester, docstrings_to_test)
-        self.assertEqual(len(test_results), 2)
-
-        tr_0, tr_1 = test_results
-
-        self.assertIn('static_0', tr_0.name)
-        self.assertTrue(tr_0.passed)
-
-        self.assertIn('static_1', tr_1.name)
-        self.assertFalse(tr_1.passed)
-        self.assertTrue(tr_1.failed)
-
     def test_timeout(self):
         docstrings_to_test = {
             'timeout_false': """
@@ -1871,7 +1870,7 @@ def test_timeout(self):
 
                 .. code-block:: python
 
-                    >>> # doctest: +TIMEOUT(2)
+                    >>> # doctest: +TIMEOUT(10)
                     >>> import time
                     >>> time.sleep(0.1)
             """,
@@ -1882,9 +1881,9 @@ def test_timeout(self):
 
                 .. code-block:: python
 
-                    >>> # doctest: +TIMEOUT(2)
+                    >>> # doctest: +TIMEOUT(10)
                     >>> import time
-                    >>> time.sleep(3)
+                    >>> time.sleep(15)
             """,
             'timeout_false_with_skip_0': """
             this is docstring...
@@ -1893,7 +1892,7 @@ def test_timeout(self):
 
                 .. code-block:: python
 
-                    >>> # doctest: +TIMEOUT(2)
+                    >>> # doctest: +TIMEOUT(10)
                     >>> # doctest: +SKIP('skip')
                     >>> import time
                     >>> time.sleep(0.1)
@@ -1906,7 +1905,7 @@ def test_timeout(self):
                 .. code-block:: python
 
                     >>> # doctest: +SKIP('skip')
-                    >>> # doctest: +TIMEOUT(2)
+                    >>> # doctest: +TIMEOUT(10)
                     >>> import time
                     >>> time.sleep(0.1)
             """,
@@ -1917,10 +1916,10 @@ def test_timeout(self):
 
                 .. code-block:: python
 
-                    >>> # doctest: +TIMEOUT(2)
+                    >>> # doctest: +TIMEOUT(10)
                     >>> # doctest: +SKIP('skip')
                     >>> import time
-                    >>> time.sleep(3)
+                    >>> time.sleep(15)
             """,
             'timeout_true_with_skip_1': """
             this is docstring...
@@ -1930,9 +1929,9 @@ def test_timeout(self):
                 .. code-block:: python
 
                     >>> # doctest: +SKIP('skip')
-                    >>> # doctest: +TIMEOUT(2)
+                    >>> # doctest: +TIMEOUT(10)
                     >>> import time
-                    >>> time.sleep(3)
+                    >>> time.sleep(15)
             """,
             'timeout_more_codes': """
             this is docstring...
@@ -1941,15 +1940,15 @@ def test_timeout(self):
 
                 .. code-block:: python
 
-                    >>> # doctest: +TIMEOUT(2)
+                    >>> # doctest: +TIMEOUT(10)
                     >>> import time
                     >>> time.sleep(0.1)
 
                 .. code-block:: python
 
-                    >>> # doctest: +TIMEOUT(2)
+                    >>> # doctest: +TIMEOUT(10)
                     >>> import time
-                    >>> time.sleep(3)
+                    >>> time.sleep(15)
 
             """,
         }
@@ -2370,6 +2369,11 @@ def test_bad_statements_req(self):
         self.assertTrue(tr_6.badstatement)
         self.assertFalse(tr_6.passed)
 
+    @unittest.skipIf(
+        not sys.platform.startswith('linux'),
+        "CI checks on linux, we only care this situation about multiprocessing!"
+        "Or pickle may fail.",
+    )
     def test_single_process_directive(self):
         _clear_environ()
 
diff --git a/test/tools/test_type_checking.py b/test/tools/test_type_checking.py
@@ -12,9 +12,32 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+import pathlib
 import unittest
 
-from tools.type_checking import MypyChecker, get_test_results
+# set `PYTHONPATH=<Paddle/tools>` from `CMakeLists.txt`
+from type_checking import MypyChecker, get_test_results
+
+FILE_PATH = pathlib.Path(__file__).resolve().parent
+
+# test from `Paddle/test`
+BASE_PATH_IN_TEST = FILE_PATH.parent.parent
+CONFIG_FILE_IN_TEST = BASE_PATH_IN_TEST / 'pyproject.toml'
+CACHE_DIR_IN_TEST = BASE_PATH_IN_TEST / '.mypy_cache'
+
+# test from `Paddle/build/test`
+BASE_PATH_IN_BUILD = FILE_PATH.parent.parent.parent
+CONFIG_FILE_IN_BUILD = BASE_PATH_IN_BUILD / 'pyproject.toml'
+CACHE_DIR_IN_BUILD = BASE_PATH_IN_BUILD / '.mypy_cache'
+
+if CONFIG_FILE_IN_TEST.exists():
+    CONFIG_FILE = CONFIG_FILE_IN_TEST
+    CACHE_DIR = CACHE_DIR_IN_TEST
+elif CONFIG_FILE_IN_BUILD.exists():
+    CONFIG_FILE = CONFIG_FILE_IN_BUILD
+    CACHE_DIR = CACHE_DIR_IN_BUILD
+else:
+    raise FileNotFoundError('Can NOT found mypy config file `pyproject.toml`')
 
 
 class TestMypyChecker(unittest.TestCase):
@@ -347,7 +370,7 @@ def test_mypy_pass(self):
 
             """,
         }
-        doctester = MypyChecker('../pyproject.toml')
+        doctester = MypyChecker(CONFIG_FILE, CACHE_DIR)
 
         test_results = get_test_results(doctester, docstrings_pass)
         self.assertEqual(len(test_results), 3)
@@ -412,7 +435,7 @@ def test_mypy_fail(self):
             """,
         }
 
-        doctester = MypyChecker('../pyproject.toml')
+        doctester = MypyChecker(CONFIG_FILE, CACHE_DIR)
 
         test_results = get_test_results(doctester, docstrings_fail)
         self.assertEqual(len(test_results), 3)
@@ -457,7 +480,7 @@ def test_mypy_partial_fail(self):
             """
         }
 
-        doctester = MypyChecker('../pyproject.toml')
+        doctester = MypyChecker(CONFIG_FILE, CACHE_DIR)
 
         test_results = get_test_results(doctester, docstrings_fail)
         self.assertEqual(len(test_results), 2)
@@ -519,7 +542,7 @@ def test_mypy_ignore(self):
             """,
         }
 
-        doctester = MypyChecker('../pyproject.toml')
+        doctester = MypyChecker(CONFIG_FILE, CACHE_DIR)
 
         test_results = get_test_results(doctester, docstrings_ignore)
         self.assertEqual(len(test_results), 3)
@@ -569,7 +592,7 @@ def test_mypy_ignore(self):
             """,
         }
 
-        doctester = MypyChecker('../pyproject.toml')
+        doctester = MypyChecker(CONFIG_FILE, CACHE_DIR)
 
         test_results = get_test_results(doctester, docstrings_pass)
         self.assertEqual(len(test_results), 2)
@@ -620,11 +643,15 @@ def test_mypy_ignore(self):
             """,
         }
 
-        doctester = MypyChecker('../pyproject.toml')
+        doctester = MypyChecker(CONFIG_FILE, CACHE_DIR)
 
         test_results = get_test_results(doctester, docstrings_fail)
         self.assertEqual(len(test_results), 2)
 
         for tr in test_results:
             print(tr.msg)
             self.assertTrue(tr.fail)
+
+
+if __name__ == '__main__':
+    unittest.main()
diff --git a/tools/sampcd_processor_utils.py b/tools/sampcd_processor_utils.py
