Add tests folder to dpnp conda package (#2116)

* Move tests to dpnp folder

* Update import paths for dpnp tests

* Update paths in skipped_tests files

* Update import paths in tests_perf

* Update import paths in cupy/testing

* Update import paths in all cupy tests

* Update tests path in pyproject.toml

* Remove MANIFEST.in

* Add tests folder to conda package

* Simplify meta.yaml: move test logic to run_test.sh

* Move pytest config from setup.cfg to conftest.py

* Update call pytest in gen_coverage.py

* Update path to cupy.testing in some tests

* Update test paths for github action test_linux

* Optimize test skipping and path normalization in conftest.py

* Add norecursedirs config for tests_perf in conftest.py

* Use relative imports for dpnp tests

* Update docs for _loops.py

* Add empty __init__.py files to cupy tests

* Update import path in test_add_remove.py

* Update tests-path for GH Actions

* Show extra test summary info in internal CI

* Fix normalize_test_name() to support subdirectories

* Update normalize_test_name to run pytest from diff paths

* Add run_test.bat to conda-recipe

* Update pre-commit settings to move tests folder

* Use absolute import paths in cupy tests

* Update tests path in pyproject.toml

* Use package_data instead of data_files in setup.py to pack tests

* Update args for generate coverage

* Update import path in test_arraypad.py

* Rename TEST_SCOPE files to use pytest --pyargs

* Remove unused imports in test files

* Align import for test_arraypad.py

* Use absolute import path in cupy/testing

* Print dpnp version while testing conda package

* Disable verbose and disable-warnings pytest mode for public CI

* Disable quiet, verbose, disable-warnings pytest mode for testing conda package

* Remove dublicate env variable MODULE_NAME in conda-package.yaml

* Remove working-directory usage for Run tests in conda-package.yml

Author: vlad-perevezentsev

.flake8

@@ -56,7 +56,7 @@ exclude =
     build,
     dpnp/to_numba/*.py,
     conda.recipe,
-    tests/*.py,
+    dpnp/tests/*.py,
     tests_external/*.py,
     versioneer.py,
 

.github/workflows/conda-package.yml

@@ -10,7 +10,6 @@ permissions: read-all
 
 env:
   PACKAGE_NAME: dpnp
-  MODULE_NAME: dpnp
   # Follow oneAPI installation instruction for conda, since intel channel is not longer available
   # CHANNELS: '-c dppy/label/dev -c intel -c conda-forge --override-channels'
   CHANNELS: '-c dppy/label/dev -c https://software.repos.intel.com/python/conda/ -c conda-forge --override-channels'
@@ -116,7 +115,6 @@ jobs:
       channel-path: '${{ github.workspace }}/channel/'
       pkg-path-in-channel: '${{ github.workspace }}/channel/linux-64/'
       extracted-pkg-path: '${{ github.workspace }}/pkg/'
-      tests-path: '${{ github.workspace }}/pkg/info/test/tests/'
       ver-json-path: '${{ github.workspace }}/version.json'
 
     steps:
@@ -177,8 +175,7 @@ jobs:
       - name: Run tests
         if: env.RERUN_TESTS_ON_FAILURE != 'true'
         run: |
-          python -m pytest -q -ra --disable-warnings -vv .
-        working-directory: ${{ env.tests-path }}
+          python -m pytest -ra --pyargs ${{ env.PACKAGE_NAME }}.tests
 
       - name: Run tests
         if: env.RERUN_TESTS_ON_FAILURE == 'true'
@@ -192,8 +189,7 @@ jobs:
           command: |
             . $CONDA/etc/profile.d/conda.sh
             conda activate ${{ env.TEST_ENV_NAME }}
-            cd ${{ env.tests-path }}
-            python -m pytest -q -ra --disable-warnings -vv .
+            pytest -ra --pyargs ${{ env.PACKAGE_NAME }}.tests
 
   test_windows:
     name: Test ['windows-2019', python='${{ matrix.python }}']
@@ -216,8 +212,8 @@ jobs:
       channel-path: '${{ github.workspace }}\channel\'
       pkg-path-in-channel: '${{ github.workspace }}\channel\win-64\'
       extracted-pkg-path: '${{ github.workspace }}\pkg'
-      tests-path: '${{ github.workspace }}\pkg\info\test\tests\'
       ver-json-path: '${{ github.workspace }}\version.json'
+      workdir: '${{ github.workspace }}'
 
     steps:
       - name: Download artifact
@@ -314,8 +310,7 @@ jobs:
       - name: Run tests
         if: env.RERUN_TESTS_ON_FAILURE != 'true'
         run: |
-          python -m pytest -q -ra --disable-warnings -vv .
-        working-directory: ${{ env.tests-path }}
+          pytest -ra --pyargs ${{ env.PACKAGE_NAME }}.tests
 
       - name: Run tests
         if: env.RERUN_TESTS_ON_FAILURE == 'true'
@@ -328,8 +323,7 @@ jobs:
           retry_on: any
           command: >-
             mamba activate ${{ env.TEST_ENV_NAME }}
-            & cd ${{ env.tests-path }}
-            & python -m pytest -q -ra --disable-warnings -vv .
+            & pytest -ra --pyargs ${{ env.PACKAGE_NAME }}.tests
 
   upload:
     name: Upload ['${{ matrix.os }}', python='${{ matrix.python }}']

.pre-commit-config.yaml

@@ -32,9 +32,9 @@ repos:
     -   id: python-no-eval
         exclude: |
             (?x)^(
-                tests/test_arraycreation.py|
-                tests/test_sycl_queue.py|
-                tests/test_usm_type.py
+                dpnp/tests/test_arraycreation.py|
+                dpnp/tests/test_sycl_queue.py|
+                dpnp/tests/test_usm_type.py
             )$
     -   id: python-no-log-warn
     -   id: python-use-type-annotations

MANIFEST.in

@@ -51,14 +51,6 @@ test:
     requires:
       - pytest
       - setuptools
-    source_files:
-      - examples
-      - tests
-      - setup.cfg
-    commands:
-      - python -c "import dpnp; print(dpnp.__version__)"
-      - python -m dpctl -f
-      - pytest -s
 
 about:
     home: https://github.com/IntelPython/dpnp

conda-recipe/meta.yaml

@@ -0,0 +1,41 @@
+@echo on
+
+REM if ONEAPI_ROOT is specified (use all from it)
+if defined ONEAPI_ROOT (
+    set "DPCPPROOT=%ONEAPI_ROOT%\compiler\latest"
+    set "MKLROOT=%ONEAPI_ROOT%\mkl\latest"
+    set "TBBROOT=%ONEAPI_ROOT%\tbb\latest"
+    set "DPLROOT=%ONEAPI_ROOT%\dpl\latest"
+)
+
+REM if DPCPPROOT is specified (work with custom DPCPP)
+if defined DPCPPROOT (
+    call "%DPCPPROOT%\env\vars.bat"
+)
+
+REM if MKLROOT is specified (work with custom math library)
+if defined MKLROOT (
+    call "%MKLROOT%\env\vars.bat"
+)
+
+REM have to activate while SYCL CPU device/driver needs paths
+REM if TBBROOT is specified
+if defined TBBROOT (
+    call "%TBBROOT%\env\vars.bat"
+)
+
+REM If PYTHON is not set
+REM assign it to the Python interpreter from the testing environment
+if not defined PYTHON (
+    for %%I in (python.exe) do set PYTHON=%%~$PATH:I
+)
+
+
+"%PYTHON%" -c "import dpnp; print(dpnp.__version__)"
+if errorlevel 1 exit 1
+
+"%PYTHON%" -m dpctl -f
+if errorlevel 1 exit 1
+
+"%PYTHON%" -m pytest -ra --pyargs dpnp
+if errorlevel 1 exit 1

conda-recipe/run_test.bat

@@ -26,3 +26,15 @@ if [ -n "${TBBROOT}" ]; then
     # shellcheck source=/dev/null
     . "${TBBROOT}"/env/vars.sh
 fi
+
+# If PYTHON is not set
+# assign it to the Python interpreter from the testing environment
+if [ -z "${PYTHON}" ]; then
+    PYTHON=$PREFIX/bin/python
+fi
+
+set -e
+
+$PYTHON -c "import dpnp; print(dpnp.__version__)"
+$PYTHON -m dpctl -f
+$PYTHON -m pytest -ra --pyargs dpnp

conda-recipe/run_test.sh

@@ -1,6 +1,6 @@
 import numpy
 
-from tests import testing
+from . import testing
 
 numpy.testing.assert_allclose = testing.assert_allclose
 numpy.testing.assert_array_equal = testing.assert_array_equal

tests/__init__.py renamed to dpnp/tests/__init__.py

@@ -47,7 +47,66 @@ def get_excluded_tests(test_exclude_file):
     if os.path.exists(test_exclude_file):
         with open(test_exclude_file) as skip_names_file:
             excluded_tests = skip_names_file.readlines()
-    return excluded_tests
+    # Remove whitespace and filter out empty lines
+    return [line.strip() for line in excluded_tests if line.strip()]
+
+
+# Normalize the nodeid to a relative path starting
+# from the "tests/" directory
+def normalize_test_name(nodeid):
+    nodeid = nodeid.replace("\n", "").strip()
+
+    # case if run pytest from dpnp folder
+    if nodeid.startswith("tests/"):
+        return nodeid
+
+    # case if run pytest --pyargs
+    if "/tests/" in nodeid:
+        nodeid = nodeid.split("tests/", 1)[-1]
+        # Add the "tests/" prefix to ensure the nodeid matches
+        # the paths in the skipped tests files.
+        normalized_nodeid = "tests/" + nodeid
+    # case if run pytest from tests folder
+    else:
+        normalized_nodeid = "tests/" + nodeid
+
+    return normalized_nodeid
+
+
+def pytest_configure(config):
+    # By default, tests marked as slow will be deselected.
+    # To run all tests, use -m "slow or not slow".
+    # To run only slow tests, use -m "slow".
+    # Equivalent to addopts = -m "not slow"
+    if not config.getoption("markexpr"):
+        config.option.markexpr = "not slow"
+    # Equivalent to addopts = --tb=short
+    if not config.getoption("tbstyle"):
+        config.option.tbstyle = "short"
+    # Equivalent to addopts = --strict-markers
+    if not config.getoption("strict_markers"):
+        config.option.strict_markers = True
+
+    # Equivalent to norecursedirs = tests_perf
+    config.addinivalue_line("norecursedirs", "tests_perf")
+
+    # Register pytest markers
+    config.addinivalue_line(
+        "markers", "slow: marks tests as slow (deselect with '-m \"not slow\"')"
+    )
+    config.addinivalue_line(
+        "markers",
+        "multi_gpu: marks tests that require a specified number of GPUs",
+    )
+
+    # NumPy arccosh
+    # Undefined behavior depends on the backend:
+    # NumPy with OpenBLAS for np.array[1.0] does not raise a warning
+    # while numpy with OneMKL raises RuntimeWarning
+    config.addinivalue_line(
+        "filterwarnings",
+        "ignore:invalid value encountered in arccosh:RuntimeWarning",
+    )
 
 
 def pytest_collection_modifyitems(config, items):
@@ -85,16 +144,21 @@ def pytest_collection_modifyitems(config, items):
         excluded_tests.extend(get_excluded_tests(test_exclude_file))
 
     for item in items:
-        # some test name contains '\n' in the parameters
-        test_name = item.nodeid.replace("\n", "").strip()
+        test_name = normalize_test_name(item.nodeid)
 
         for item_tbl in excluded_tests:
-            # remove end-of-line character
-            item_tbl_str = item_tbl.strip()
             # exact match of the test name with items from excluded_list
-            if test_name == item_tbl_str:
+            if test_name == item_tbl:
                 item.add_marker(skip_mark)
 
+    # Handle the exclusion of tests marked as "slow"
+    selected_marker = config.getoption("markexpr")
+    if "not slow" in selected_marker:
+        skip_slow = pytest.mark.skip(reason="Skipping slow tests")
+        for item in items:
+            if "slow" in item.keywords:
+                item.add_marker(skip_slow)
+
 
 @pytest.fixture
 def allow_fall_back_on_numpy(monkeypatch):

tests/conftest.py renamed to dpnp/tests/conftest.py

@@ -1,9 +1,6 @@
 import unittest
 
-import numpy
-
-from tests.helper import has_support_aspect64
-from tests.third_party.cupy import testing
+from .third_party.cupy import testing
 
 
 class TestArithmetic(unittest.TestCase):

tests/helper.py renamed to dpnp/tests/helper.py

@@ -13,13 +13,12 @@
 )
 
 import dpnp
-from tests.third_party.cupy import testing
 
 from .helper import (
     assert_dtype_allclose,
     get_all_dtypes,
-    has_support_aspect64,
 )
+from .third_party.cupy import testing
 
 
 class TestArray:

tests/skipped_tests.tbl renamed to dpnp/tests/skipped_tests.tbl

@@ -10,9 +10,9 @@
 )
 
 import dpnp
-from tests.third_party.cupy import testing
 
 from .helper import get_all_dtypes, get_float_complex_dtypes
+from .third_party.cupy import testing
 
 
 class TestAtleast1d:

tests/skipped_tests_gpu.tbl renamed to dpnp/tests/skipped_tests_gpu.tbl

@@ -10,9 +10,9 @@
 
 import dpnp
 from dpnp.dpnp_utils.dpnp_utils_pad import _as_pairs as dpnp_as_pairs
-from tests.third_party.cupy import testing
 
 from .helper import assert_dtype_allclose, get_all_dtypes
+from .third_party.cupy import testing
 
 
 class TestPad:

tests/skipped_tests_gpu_no_fp64.tbl renamed to dpnp/tests/skipped_tests_gpu_no_fp64.tbl

@@ -12,7 +12,6 @@
     assert_dtype_allclose,
     get_all_dtypes,
     get_complex_dtypes,
-    get_float_complex_dtypes,
     get_float_dtypes,
 )
 

tests/test_absolute.py renamed to dpnp/tests/test_absolute.py

@@ -1,6 +1,6 @@
 import numpy
 import pytest
-from numpy.testing import assert_array_equal, assert_equal, assert_raises
+from numpy.testing import assert_array_equal
 
 import dpnp
 

tests/test_amin_amax.py renamed to dpnp/tests/test_amin_amax.py

@@ -14,9 +14,9 @@
 
 import dpnp
 from dpnp.dpnp_array import dpnp_array
-from tests.third_party.cupy import testing
 
 from .helper import get_all_dtypes, get_integer_dtypes, has_support_aspect64
+from .third_party.cupy import testing
 
 
 def _add_keepdims(func):

tests/test_arithmetic.py renamed to dpnp/tests/test_arithmetic.py

@@ -14,7 +14,6 @@
 )
 
 import dpnp as inp
-from tests.third_party.cupy import testing
 
 from .helper import (
     assert_dtype_allclose,
@@ -25,6 +24,7 @@
     has_support_aspect64,
     is_cpu_device,
 )
+from .third_party.cupy import testing
 
 
 def vvsort(val, vec, size, xp):

tests/test_array_utils.py renamed to dpnp/tests/test_array_utils.py

@@ -7,7 +7,6 @@
 from numpy.testing import assert_array_equal, assert_equal, assert_raises
 
 import dpnp
-from tests.third_party.cupy import testing
 
 from .helper import (
     assert_dtype_allclose,
@@ -18,6 +17,7 @@
     get_integer_dtypes,
     has_support_aspect64,
 )
+from .third_party.cupy import testing
 
 testdata = []
 testdata += [

tests/test_arraycreation.py renamed to dpnp/tests/test_arraycreation.py

@@ -19,7 +19,6 @@
 
 import dpnp
 from dpnp.dpnp_array import dpnp_array
-from tests.third_party.cupy import testing
 
 from .helper import (
     assert_dtype_allclose,
@@ -36,6 +35,7 @@
     _get_numpy_arrays_2in_1out,
     _get_output_data_type,
 )
+from .third_party.cupy import testing
 
 
 class TestAngle:

tests/test_arraymanipulation.py renamed to dpnp/tests/test_arraymanipulation.py

@@ -1,6 +1,6 @@
 import unittest
 
-from tests.third_party.cupy import testing
+from .third_party.cupy import testing
 
 
 class TestMatMul(unittest.TestCase):